docs: note on firmware update refs #307

[geertmeersman]

Summary by CodeRabbit

• Documentation
  • Added a troubleshooting tip in the FAQ section recommending users check their Robonect firmware version if expected sensors are missing.

[coderabbitai]

Walkthrough

A new troubleshooting tip was added to the FAQ section of the README, advising users to check that their Robonect firmware is up to date if expected sensors are missing. This supplements the existing guidance on verifying MQTT topic configuration.

Changes

File(s)	Change Summary
README.md	Added a troubleshooting tip in the FAQ about updating Robonect firmware

Suggested labels

docs

Poem

In README fields where questions grow,
A new tip hops in, wisdom to show.
If sensors vanish, don’t despair—
Update your firmware, check with care!
The rabbit reads, the answers bloom,
Troubles fade, solutions zoom. 🐇✨

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

Support

Need 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)

• @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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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 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]

Actionable comments posted: 0

🧹 Nitpick comments (1)

README.md (1)

131-131: Refine wording & punctuation for clarity

The new sentence is clear, but the phrasing is a bit clunky and misses the hyphenation in “up-to-date”. A tighter wording also keeps the style consistent with the previous bullet.

- - If you would be expecting specific sensors and you don't see them, make sure your Robonect firmware is up to date.
+ - If you expect specific sensors but don't see them, make sure your Robonect firmware is up-to-date.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 32e0a69 and 0a5a640.

📒 Files selected for processing (1)

• README.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

README.md

[uncategorized] ~131-~131: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... you would be expecting specific sensors and you don't see them, make sure your Robo...

(COMMA_COMPOUND_SENTENCE)

---

[uncategorized] ~131-~131: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...em, make sure your Robonect firmware is up to date. ### Enable debug logging To enable d...

(UP_TO_DATE_HYPHEN)