Update command signing instructions in Tesla Fleet #36775
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Caution Review failedThe pull request is closed. 📝 WalkthroughWalkthroughThe documentation for the Tesla Fleet integration in Home Assistant has been updated to clarify the key configuration process and installation requirements. The changes focus on simplifying the key setup instructions, specifying the exact location for the private key, and providing more precise guidance for vehicle command authentication. The documentation now directs users to add their public key through a specific URL and includes updated troubleshooting information related to API pricing changes. Changes
Sequence DiagramsequenceDiagram
participant User
participant "Tesla Fleet Integration"
participant "Tesla API"
User->>User: Generate key pair
User->>User: Save private key to config/tesla_fleet.key
User->>Tesla API: Add public key to vehicle via specified URL
Tesla API-->>User: Confirm key setup
User->>Tesla Fleet Integration: Configure integration
Tesla Fleet Integration->>Tesla API: Authenticate and access vehicle commands
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/tesla_fleet.markdown (4)
180-180: Fix grammar: "setup" should be "set up"The word "setup" is incorrectly used as a verb. When used as a verb, it should be "set up".
-Certain vehicles, including all vehicles manufactured since late 2023, require vehicle commands to be signed with a private key. All actions on vehicle entities will fail with an error if this is required and the key has not been setup correctly. +Certain vehicles, including all vehicles manufactured since late 2023, require vehicle commands to be signed with a private key. All actions on vehicle entities will fail with an error if this is required and the key has not been set up correctly.🧰 Tools
🪛 LanguageTool
[grammar] ~180-~180: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...is is required and the key has not been setup correctly. The integration expects you...(BE_VB_OR_NN)
182-182: Add details about private key format and permissionsThe instructions should specify the required format and permissions for the private key file.
-The integration expects your private key to be located at `config/tesla_fleet.key`. +The integration expects your private key to be located at `config/tesla_fleet.key`. The file should be in PEM format and have appropriate read permissions (e.g., `600`).
184-184: Format URL as a proper markdown linkThe bare URL should be formatted as a proper markdown link for better readability and to follow markdown best practices.
-Your public key must be added to each of your vehicles by visiting https://tesla.com/_ak/YOUR.DOMAIN and following the instructions in the Tesla app. you can read more about this process [here](https://developer.tesla.com/docs/fleet-api/endpoints/vehicle-commands#key-pairing). +Your public key must be added to each of your vehicles by visiting [https://tesla.com/_ak/YOUR.DOMAIN](https://tesla.com/_ak/YOUR.DOMAIN) and following the instructions in the Tesla app. You can read more about this process [here](https://developer.tesla.com/docs/fleet-api/endpoints/vehicle-commands#key-pairing).Also note the capitalization of "you" at the start of the second sentence.
🧰 Tools
🪛 Markdownlint (0.37.0)
184-184: null
Bare URL used(MD034, no-bare-urls)
348-348: Remove trailing whitespaceRemove the trailing whitespace on this line to maintain clean documentation.
- +
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/tesla_fleet.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/tesla_fleet.markdown
[grammar] ~180-~180: Make sure that the noun ‘setup’ is correct. Did you mean the past participle “set up”?
Context: ...is is required and the key has not been setup correctly. The integration expects you...
(BE_VB_OR_NN)
🪛 Markdownlint (0.37.0)
source/_integrations/tesla_fleet.markdown
184-184: null
Bare URL used
(MD034, no-bare-urls)
⏰ 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
|
|
||
| This is necessary because the tool cannot establish a connection while another Bluetooth device is connected to the car. | ||
| {% endnote %} | ||
| Your public key must be added to each of your vehicles by visiting https://tesla.com/_ak/YOUR.DOMAIN and following the instructions in the Tesla app. you can read more about this process [here](https://developer.tesla.com/docs/fleet-api/endpoints/vehicle-commands#key-pairing). |
There was a problem hiding this comment.
| Your public key must be added to each of your vehicles by visiting https://tesla.com/_ak/YOUR.DOMAIN and following the instructions in the Tesla app. you can read more about this process [here](https://developer.tesla.com/docs/fleet-api/endpoints/vehicle-commands#key-pairing). | |
| Your public key must be added to each of your vehicles by visiting https://tesla.com/_ak/YOUR.DOMAIN and following the instructions in the Tesla app. You can read more about this process in the [Tesla developer documentation on vehicle commands](https://developer.tesla.com/docs/fleet-api/endpoints/vehicle-commands#key-pairing). |
instead of "here", I would describe where the link leads to. Please improve the title if you feel I got it wrong.
Proposed change
The command signing instructions previously provided were primarily relevant for the built in client ID which has now been removed. This changes the process to the much simpler web/QR code based approach.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
config/tesla_fleet.key