Update cli.rst to include aioesphomeapi docs #4991
Conversation
WalkthroughThe ESPHome CLI documentation was updated with a new section detailing the logging tools provided by ESPHome. This addition explains the differences between API-based and serial logging, introduces relevant CLI commands for log viewing and device discovery, and provides usage examples and references. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant CLI
participant ESPHome Device
User->>CLI: Run aioesphomeapi-logs with device IP
CLI->>ESPHome Device: Connect via API
ESPHome Device-->>CLI: Stream logs
CLI-->>User: Display logs
User->>CLI: Press CTRL+C to exit
CLI-->>ESPHome Device: Disconnect
User->>CLI: Run aioesphomeapi-discover
CLI->>ESPHome Device: Broadcast discovery request
ESPHome Device-->>CLI: Respond with device info
CLI-->>User: Display device summary table
Suggested reviewers
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (5)
guides/cli.rst (5)
288-292: Fix heading formatting and grammar for logging section
- Change "logging interface" to plural "logging interfaces" and introduce a colon before enumeration.
- Ensure the underline length matches the heading text length in reStructuredText.
Suggested diff:
- Using logging tools supplied with ESPHome - ----------------------------------- + Using logging tools supplied with ESPHome + ======================================== - There are two types of logging interface supplied with ESPHome. API and Serial AKA UART logging. + There are two types of logging interfaces supplied with ESPHome: API and Serial (UART) logging.
291-296: Improve wording and capitalization in serial and API logging descriptions
- Lowercase "There" after comma in the serial logging sentence.
- Replace "crude API based logging uses" with "basic API-based logging use" for clarity.
- Combine sentences for better flow.
- For serial logging, There are many options including web.esphome.io and ESPHome CLI's ``run`` - command. + For serial logging, there are many options including web.esphome.io and the ESPHome CLI ``run`` command. - For crude API based logging uses, one can use the `aioesphomeapi-logs` command bundled with ESPHome. - Very useful when an ESP device is located in a remote/inaccessible location. + For basic API-based logging use, you can use the ``aioesphomeapi-logs`` command bundled with ESPHome, + which is especially useful when an ESP device is located in a remote or inaccessible location.
298-304: Clarify logging command syntax examples
- Specify “IPv4 or IPv6” in full and note when quoting may be required in some shells.
- aioesphomeapi-logs <IPv4/v6 address> + aioesphomeapi-logs <IPv4 or IPv6 address> + +.. note:: + On some shells, you may need to quote IPv6 addresses, e.g.: + ``aioesphomeapi-logs "[fe80::1]"``.
312-314: Format keypress instructions with inline literals
Use code formatting for key combinations for consistency:- Press CTRL+C to exit from the logging view. + Press ``CTRL+C`` to exit the logging view.
321-324: Fix apostrophe and suggest using a table for discovery output
- Remove the stray apostrophe after "devices".
- Present the fields in a proper reStructuredText table for clarity.
- The response lists info about currently available ESPHome devices' - ``Status |Name |Address |MAC |Version |Platform |Board`` + The response lists info about currently available ESPHome devices: + +.. list-table:: + :header-rows: 1 + + * - Status + - Name + - Address + - MAC + - Version + - Platform + - Board
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
guides/cli.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**: - Do not generate or add any sequence diagrams
guides/cli.rst
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
✅ Deploy Preview for esphome ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
guides/cli.rst (5)
289-290: Underline length mismatch for new section
The underline below “Using logging tools supplied with ESPHome” must match its character count exactly to render properly in RST.
291-293: Grammar and capitalization in introduction
Use “interfaces” (plural) instead of “interface” and lowercase “there” in “For serial logging, there are many options…”.
295-297: Inline literal and phrasing for API logging
Replace “For crude API based logging uses, one can use theaioesphomeapi-logscommand…” with “For API-based logging, use theaioesphomeapi-logscommand…”. Also, use double backticks for inline code.
329-331: Incorrect apostrophe and formatting for device info
Change the apostrophe after “devices” to a colon and consider using an RST list or table directive instead of inline code for theStatus | Name | Address | MAC | Version | Platform | Boardoutput.
332-336: Verify “See Also” section styling
Ensure the “See Also” links match the rest of the documentation’s formatting (indentation, link style, hyphen usage).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
guides/cli.rst(1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**`: - Do not generate or add any sequence diagrams
**: - Do not generate or add any sequence diagrams
guides/cli.rst
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: build
Description:
include aioesphomeapi docs related to API based logging and device discovery
Related issue (if applicable): fixes
Pull request in esphome with YAML changes (if applicable):
Checklist:
I am merging into
nextbecause this is new documentation that has a matching pull-request in esphome as linked above.or
I am merging into
currentbecause this is a fix, change and/or adjustment in the current documentation and is not for a new component or feature.Link added in
/components/index.rstwhen creating new documents for new components or cookbook.