search

AllYarnsAreBeautiful / ayab-firmware

Contains the Arduino Firmware for the AYAB Shield
GNU General Public License v3.0
23 stars 19 forks source link

com: shrink send/receive buffers from 256 to 64 bytes #193

Closed jonathanperret closed 2 months ago

jonathanperret commented 2 months ago

Issue

As shown in #191 the memory usage of the firmware needs to be brought under control. A significant contributor to the allocated RAM is the set of message buffers used by the serial communication layer.

Proposed solution

The largest message that is generated by the current protocol is a cnfLine containing 25 bytes of pattern, plus 5 bytes of other data. Even assuming a worst case of having to SLIP-escape all the bytes, this fits in a 64-byte buffer.

This PR therefore reduces both the outgoing message buffer (Com::msgBuffer) and the incoming message buffer in the PacketSerial instance to 64 bytes each.

If the objects are statically alllocated as proposed in #191 , it can be seen that the memory used goes from 91.3% (used 1869 bytes from 2048 bytes) to 72.5% (used 1485 bytes from 2048 bytes) with this change.

Summary by CodeRabbit

These changes aim to optimize communication within the application.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes mainly reduce the maximum message buffer length in the Com class from 255 to 64, aiming to enhance performance and memory management. The member variable for packet serial communication is also updated to a templated class, incorporating this new buffer size, indicating a more efficient handling mechanism for packet communications within the application.

Changes

File Change Summary
src/ayab/com.h Updated MAX_MSG_BUFFER_LEN from 255 to 64. Changed m_packetSerial from SLIPPacketSerial to PacketSerial_<SLIP, SLIP::END, MAX_MSG_BUFFER_LEN>.

Sequence Diagram(s)

sequenceDiagram
    participant App
    participant Com
    participant PacketSerial

    App->>Com: Send Message
    Com->>PacketSerial: Process Packet (Using MAX_MSG_BUFFER_LEN)
    PacketSerial-->>Com: Acknowledge
    Com-->>App: Message Sent Confirmation

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
jonathanperret commented 2 months ago

This should help quite a bit with #190 as well.

jonathanperret commented 2 months ago

I'm all for this as long as we also update the api docs to clarify the message limit :)

Will do!

jonathanperret commented 2 months ago

@X-sam here's a manual PR to document the message size limit: https://github.com/AllYarnsAreBeautiful/ayab-manual/pull/39 , please let me know what you think!