Report an unknown carriage in simulation mode

[jonathanperret]

Fixes #692 as suggested, by reporting an unknown carriage type so that the UI does not show any carriage type.

Test release: https://github.com/jonathanperret/ayab-desktop/releases/tag/1.0.0-sim-carriage-1

Summary by CodeRabbit

• New Features

  • Enhanced initialization request now includes detailed machine state information such as sensor values, carriage type, position, and direction.

• Bug Fixes

  • Updated test assertions to align with the new expected byte sequence for machine state validation.

[coderabbitai]

Walkthrough

The pull request modifies the req_init_API6 method in the CommunicationMock class to enhance the byte sequence sent during initialization. The method's docstring was updated to reflect these changes, which now include additional parameters that provide a more comprehensive state of the machine. Correspondingly, the test_req_init_API6 method in the test suite was updated to align with the new expected byte sequence. The overall structure and functionality of the class and methods remain unchanged.

Changes

File Path	Change Summary
src/main/python/main/ayab/engine/communication_mock.py	Updated docstring and modified indState byte sequence in req_init_API6 method to include more parameters.
src/main/python/main/ayab/tests/test_communication_mock.py	Altered expected result in test_req_init_API6 to match updated byte sequence.

Assessment against linked issues

Objective	Addressed	Explanation
Remove carriage type from simulation output (#692)	❌	The changes do not address the carriage type issue.

Possibly related PRs

• Fix left/right aligned pattern output #736: The changes in the __calc_pat_start_end_needles method may relate to the overall handling of machine states and configurations, similar to the updates in the req_init_API6 method, as both involve adjustments to how machine parameters are processed and communicated.

Suggested reviewers

• dl1com

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 4bc241c and f9e55fd.

📒 Files selected for processing (2)

• src/main/python/main/ayab/engine/communication_mock.py (1 hunks)
• src/main/python/main/ayab/tests/test_communication_mock.py (1 hunks)

🔇 Additional comments (3)

src/main/python/main/ayab/engine/communication_mock.py (2)

76-76: LGTM!

The updated docstring accurately describes the method's functionality.

---

80-91: Fix implemented: Setting carriage type to unknown (0xFF)

This change directly addresses issue #692 by setting the carriage type to 0xFF (unknown) in simulation mode, preventing the incorrect display of a lace carriage.

src/main/python/main/ayab/tests/test_communication_mock.py (1)

76-76: LGTM: Test updated to match implementation

The test's expected result correctly matches the new implementation where carriage type is set to unknown (0xFF).

---

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>, 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 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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud