Skip to content

Use google-maps-routing in google_travel_time #38018

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 30, 2025
Merged

Use google-maps-routing in google_travel_time #38018

merged 2 commits into from
Apr 30, 2025

Conversation

eifinger
Copy link
Contributor

@eifinger eifinger commented Mar 16, 2025 •
edited
Loading

Proposed change

Update the docs with information on and links to the new Routes API.

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

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
    • Updated integration instructions to reference the Google Maps Routes API.
    • Revised API key registration guidance to direct users to the new registration page.
    • Adjusted billing details to reflect a free request tier of 5,000 requests and updated daily quota recommendations to 161 or less.
    • Removed outdated information regarding pricing scheme changes effective March 2025.
    • Clarified sensor update frequency changes from every 5 minutes to every 10 minutes.

@home-assistant home-assistant bot added has-parent This PR has a parent PR in a other repo next This PR goes into the next branch labels Mar 16, 2025
@netlify Netlify
Copy link

netlify bot commented Mar 16, 2025 •
edited
Loading

✅ Deploy Preview for home-assistant-docs ready!

Name Link
🔨 Latest commit b52420a
🔍 Latest deploy log https://app.netlify.com/sites/home-assistant-docs/deploys/67ebc66cd048d90008f8b3d6
😎 Deploy Preview https://deploy-preview-38018--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.

@eifinger eifinger mentioned this pull request Mar 16, 2025
Merged
19 tasks
@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 16, 2025 •
edited
Loading

📝 Walkthrough

Walkthrough

The documentation for the google_travel_time sensor has been updated to transition from the Google Distance Matrix API to the Google Maps Routes API. Changes include revised instructions for obtaining an API key, updated billing information reflecting 5,000 free requests, and adjustments to the sensor's update frequency and quota management details. Outdated notes regarding previous pricing schemes have been removed.

Changes

File(s) Change Summary
source/_integrations/google_travel_time.markdown Updated API reference from Google Distance Matrix API to Google Maps Routes API; revised API key registration instructions; updated billing info to reflect 5,000 free requests and a recommended quota of 161 elements per day; removed outdated pricing note.

Assessment against linked issues

Objective Addressed Explanation
Update sensor documentation to use the new Google Maps Routes API instead of the legacy API (#37977) ✅
Resolve discrepancies between documentation and UI configuration instructions (#36688) ❌ The documentation update does not address the UI inconsistency issue.
📜 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 1be5c62 and b52420a.

📒 Files selected for processing (1)
  • source/_integrations/google_travel_time.markdown (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • source/_integrations/google_travel_time.markdown
🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

coderabbitai[bot]
coderabbitai bot reviewed Mar 16, 2025
View reviewed changes
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/google_travel_time.markdown (1)

23-23: Refine Billing and Frequency Update Details
Consider rephrasing this section for improved clarity and consistency. Replace “can not” with “cannot” and refine the on-demand update suggestion, for example:

-Note that at this rate, more than 2 sensors will likely exceed the free credit amount. While this call frequency can not be decreased, you may have a use case which requires the data to be updated more often, to do this you may update on-demand (see automation example below).
+Note that at this rate, using more than 2 sensors may exceed the free credit limit. As the update frequency cannot be decreased, if you require more frequent data updates, consider triggering on-demand updates (see the automation example below).

This adjustment improves readability and aligns with common language usage.

🧰 Tools
🪛 LanguageTool

[style] ~23-~23: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...redit amount. While this call frequency can not be decreased, you may have a use case w...

(CAN_NOT_PREMIUM)

[style] ~23-~23: Consider a more expressive alternative.
Context: ...s the data to be updated more often, to do this you may update on-demand (see auto...

(DO_ACHIEVE)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 138da6d and f024278.

📒 Files selected for processing (1)
  • source/_integrations/google_travel_time.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/google_travel_time.markdown

[style] ~23-~23: Unless you want to emphasize “not”, use “cannot” which is more common.
Context: ...redit amount. While this call frequency can not be decreased, you may have a use case w...

(CAN_NOT_PREMIUM)

[style] ~23-~23: Consider a more expressive alternative.
Context: ...s the data to be updated more often, to do this you may update on-demand (see auto...

(DO_ACHIEVE)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: Redirect rules - home-assistant-docs
  • GitHub Check: Header rules - home-assistant-docs
  • GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (3)
source/_integrations/google_travel_time.markdown (3)

17-17: Update API Reference to Google Maps Routes API
The added reference to the Google Maps Routes API correctly directs users to the new API and is essential for aligning the documentation with current integration requirements.

21-21: Clarify API Key Registration Process
The updated instructions now clearly point users to the Routes API key registration page. This change is precise and easy to follow.

25-25: Confirm Quota Configuration Instructions
The explanation regarding setting the daily quota (limit of 322 or less) is accurate and well-aligned with the new Routes API guidelines.

@eifinger eifinger force-pushed the google_travel_time_routing_api branch from f024278 to 993fe2a Compare March 16, 2025 19:45
c0ffeeca7
c0ffeeca7 previously approved these changes Mar 18, 2025
View reviewed changes
Copy link
Contributor

@c0ffeeca7 c0ffeeca7 left a comment

Choose a reason for hiding this comment

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

Nice! Thank you for the fix, @eifinger 👍

@github-project-automation github-project-automation bot moved this from Todo to Approved in Documentation PRs Mar 18, 2025
@c0ffeeca7 c0ffeeca7 added the awaits-parent Awaits the merge of an parent PR label Mar 18, 2025
eifinger added 2 commits April 1, 2025 12:56
@eifinger
Use google-maps-routing
c5965d1
@eifinger
Set free requests to 5k when traffic is enabled
b52420a 
With the new routing API only 5k free requests are included if traffic aware routing is enabled. The current implementation enables this mode if travel mode car is chosen.
@eifinger eifinger force-pushed the google_travel_time_routing_api branch from 1be5c62 to b52420a Compare April 1, 2025 10:56
@eifinger eifinger requested a review from c0ffeeca7 April 1, 2025 10:56
@eifinger
Copy link
Contributor Author

eifinger commented Apr 1, 2025

Changed the info on free requests based on new findings: home-assistant/core#132894 (comment)

@eifinger
Copy link
Contributor Author

@c0ffeeca7 can you add the google_travel_time label to make this easier to find?

@eifinger
Copy link
Contributor Author

@c0ffeeca7 can you add the google_travel_time label to make this easier to find?

New issues do get opened and the PR review in core probably won't be finished before the beta

@home-assistant home-assistant bot added by-code-owner parent-merged The parent PR has been merged already labels Apr 28, 2025
@frenck frenck merged commit 657569e into home-assistant:next Apr 30, 2025
7 checks passed
@home-assistant home-assistant bot removed parent-merged The parent PR has been merged already awaits-parent Awaits the merge of an parent PR labels Apr 30, 2025
@github-actions github-actions bot locked and limited conversation to collaborators May 1, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@c0ffeeca7 c0ffeeca7 c0ffeeca7 approved these changes

Assignees
No one assigned
Labels
by-code-owner has-parent This PR has a parent PR in a other repo integration: google_travel_time next This PR goes into the next branch
Projects
No open projects
Documentation PRs
Status: Approved
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@eifinger @c0ffeeca7 @frenck