Include full firmware version in test mode welcome message

[jonathanperret]

Test mode will likely the easiest way for a user to determine which firmware version their machine is running; as we head into wider testing rounds, it seems quite valuable to make this information easily available.

The current firmware's output (assuming a desktop app that includes AllYarnsAreBeautiful/ayab-desktop#693), as displayed in the hardware test dialog, starts with:

AYAB Hardware Test, Firmware v0.99 API v6

With this PR, the firmware gives a more detailed version designator:

AYAB Hardware Test, Firmware v0.99.0rc3-8-ge9770c8 API v6

Summary by CodeRabbit

• New Features
  • Enhanced firmware version reporting with detailed format: "Firmware vX.Y.Z".
  • Introduced a new message for the global communication system that includes FW_VERSION_SUFFIX for improved clarity.

[coderabbitai]

Walkthrough

The recent modifications to the Tester::setUp method enhance the reporting of firmware version information. The firmware version format has been updated to include a patch version, changing from "Firmware vX.Y" to "Firmware vX.Y.Z". Additionally, the new implementation incorporates the FW_VERSION_SUFFIX in the messages sent to the global communication system, thereby improving the clarity and completeness of version reporting during the testing setup.

Changes

Files	Change Summary
src/ayab/tester.cpp	Updated firmware version format to include patch version and added FW_VERSION_SUFFIX to output.

Sequence Diagram(s)

sequenceDiagram
    participant Tester
    participant Firmware
    participant CommunicationSystem

    Tester->>Firmware: Request Firmware Version
    Firmware-->>Tester: Return "Firmware vX.Y.Z"
    Tester->>CommunicationSystem: Send Setup Message with FW_VERSION_SUFFIX

Loading

---

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

• 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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f69d0e7 and 51027ea.

Files selected for processing (1)

• src/ayab/tester.cpp (1 hunks)

Additional comments not posted (2)

src/ayab/tester.cpp (2)

206-206: Verify buffer size for snprintf.

Ensure that the buffer size BUFFER_LEN is sufficient to hold the formatted string, including the firmware version and the suffix.

---

208-208: Ensure correctness of format specifiers.

The format specifiers %hhu are used for unsigned char. Verify that the firmware version components (FW_VERSION_MAJ, FW_VERSION_MIN, FW_VERSION_PATCH) are of the correct type.

[jonathanperret]

Thanks @dl1com ❤️