Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update nest.markdown - troubleshooting entry #36716

Closed
wants to merge 3 commits into from

Conversation

ShadowAya
Copy link

@ShadowAya ShadowAya commented Jan 4, 2025

Proposed change

Add a Troubleshooting entry to the Google Nest integration page regarding a Device Access Console bug which prevents Pub/Sub topic from being enabled

Type of change

  • Spelling, grammar or other readability improvements (current branch).
  • Adjusted missing or incorrect information in the current documentation (current branch).
  • Added documentation for a new integration I'm adding to Home Assistant (next branch).
  • Added documentation for a new feature I'm adding to Home Assistant (next branch).
  • Removed stale or deprecated documentation.

Additional information

n/a

Checklist

  • This PR uses the correct branch, based on one of the following:
    • I made a change to the existing documentation and used the current branch.
    • I made a change that is related to an upcoming version of Home Assistant and used the next branch.
  • The documentation follows the Home Assistant documentation standards.

Summary by CodeRabbit

  • Documentation
    • Added troubleshooting note regarding issues with enabling Pub/Sub in the Device Access Console for the Google Nest integration.
    • Highlighted known issues with creating a project and enabling Pub/Sub.
    • Referenced Google IssueTracker for further information and support.

@ShadowAya ShadowAya requested a review from allenporter as a code owner January 4, 2025 19:21
@home-assistant home-assistant bot added the current This PR goes into the current branch label Jan 4, 2025
Copy link

netlify bot commented Jan 4, 2025

Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit a1bd446
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/6779988845c8510008376549
😎 Deploy Preview https://deploy-preview-36716--home-assistant-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

frenck
frenck previously approved these changes Jan 4, 2025
Copy link
Member

@frenck frenck left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, @ShadowAya 👍

../Frenck

Copy link
Contributor

coderabbitai bot commented Jan 4, 2025

📝 Walkthrough

Walkthrough

The pull request introduces a troubleshooting note in the Google Nest integration documentation, focusing on issues related to enabling Pub/Sub in the Device Access Console. It highlights a known problem where users may struggle to create a project with Pub/Sub or enable it, and advises users to consult a specific comment on the Google IssueTracker page for additional information.

Changes

File Change Summary
source/_integrations/nest.markdown Added a troubleshooting note about Pub/Sub enabling issues in the Device Access Console, referencing a known issue on the Google IssueTracker page.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 989c2cc and a1bd446.

📒 Files selected for processing (1)
  • source/_integrations/nest.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/nest.markdown

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai or @coderabbitai title anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (1)
source/_integrations/nest.markdown (1)

605-606: LGTM! Consider adding a brief description of the manual topic creation process.

The new troubleshooting entry is well-placed and provides valuable information about the Pub/Sub enabling issue. The links to the issue tracker and specific comment with the workaround are helpful.

To make it even more user-friendly, consider adding a brief description of the manual topic creation process or linking to relevant Google Cloud documentation about creating Pub/Sub topics manually.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 218ee90 and 989c2cc.

📒 Files selected for processing (1)
  • source/_integrations/nest.markdown (1 hunks)

@allenporter
Copy link
Contributor

That advice does not work. That just creates a random topic unrelated to SDM right? The SDM Topic needs to match "Pub/Sub topic" in the device access console.

The nest team is going to roll out a feature to allow the SDM console to use other pub/sub topics but it has not launched yet.

If you do this, you are going to later realize your devices are not receiving any updates/events.

@ShadowAya
Copy link
Author

That advice does not work. That just creates a random topic unrelated to SDM right? The SDM Topic needs to match "Pub/Sub topic" in the device access console.

The nest team is going to roll out a feature to allow the SDM console to use other pub/sub topics but it has not launched yet.

If you do this, you are going to later realize your devices are not receiving any updates/events.

You're right it doesn't match, but it enabled me to turn the option on (for some reason), which then created the correct topic. It might be appropriate to mention the issue without suggesting a solution, I can update that.

I am now testing an automation on my camera, and even when I selected the correct topic everywhere, I don't seem to be receiving any events. This whole thing is broken, classic Google.

@allenporter
Copy link
Contributor

They are basically having an outage right now, and just need to fix the issue.

@ShadowAya
Copy link
Author

Okay, sorry about that!
Finding the issue on IssueTracker without a solution alarmed me to propose a change.

Feel free to dismiss this pull request; still, I think it would be helpful to mention this issue in Home Assistant's docs, might throw some people off.

@allenporter
Copy link
Contributor

Let me reach out to my contacts on the nest team about the current outage and see if it will be prolonged or not.

(My impression was that known issue was temporarily resolved until we change how subscribers work, which they are going to rollout this year some time, but i'll see if that is still the case).

Thanks, hold tight and i'll report back.

@c0ffeeca7
Copy link
Contributor

I'm drafting this PR, as there is a discussion ongoing. Please undraft it, once the changes have been implemented and the PR is ready for review again.

@c0ffeeca7 c0ffeeca7 marked this pull request as draft January 7, 2025 14:00
@allenporter
Copy link
Contributor

Let me reach out to my contacts on the nest team about the current outage and see if it will be prolonged or not.

(My impression was that known issue was temporarily resolved until we change how subscribers work, which they are going to rollout this year some time, but i'll see if that is still the case).

Thanks, hold tight and i'll report back.

The nest team is aware of the issue and working to resolve it. I don't think we should do anything here.

@ShadowAya
Copy link
Author

ShadowAya commented Jan 7, 2025

The nest team is aware of the issue and working to resolve it. I don't think we should do anything here.

Okay, that's good to hear. I started receiving events yesterday, so the outage may be resolved soon. Thanks for the info! I'm closing the PR.

@ShadowAya ShadowAya closed this Jan 7, 2025
@allenporter
Copy link
Contributor

The outage is only for creating a new topic through right? I don't think it's related to receiving events.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
current This PR goes into the current branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants