feat(monitor): reduce motor.monitor() to send every MONITOR_WAIT_MS

[hcd-bdltd]

Summary by CodeRabbit

• New Features
  • Implemented time-based monitoring for motor variables to enhance performance.
• Chores
  • Updated .gitignore to exclude specific system-generated files, ensuring cleaner project management.

[coderabbitai]

Walkthrough

The recent updates involve enhancing the project's configuration and improving the functionality related to monitoring motor variables. A new file exclusion has been added to the .gitignore to keep the repository clean from build artifacts. In the source code, enhancements include the introduction of a constant and a global variable to better manage motor monitoring intervals, alongside a logic update in the main loop to efficiently check and act based on the elapsed time.

Changes

File	Summary
.gitignore	Added compile_commands.json to the list of ignored files.
src/main.cpp	Added MONITOR_WAIT_MS constant and last_monitor_ms variable, updated monitoring logic in loop().

🐰✨
In the burrow of code, where the digital rabbits play,
A new rule was written, to keep clutter at bay.
With constants and checks, so timely and wise,
Ensuring the motors, under watchful eyes.
So here's to the changes, both big and small,
May our code run smoothly, bugs conquered and all!
🌟🐾

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

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

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 0330043 and 690f798.

Files selected for processing (2)

• .gitignore (1 hunks)
• src/main.cpp (5 hunks)

Additional comments: 3

.gitignore (1)

• 83-83: LGTM!

src/main.cpp (2)

• 10-12: LGTM!
• 105-105: Correct initialization of last_monitor_ms in setup().

[coderabbitai]

The conditional check and update of last_monitor_ms in the loop() function are correctly implemented to ensure monitoring data is sent at intervals defined by MONITOR_WAIT_MS. However, consider extracting the monitoring logic into a separate function for better modularity and readability.

void monitorMotor() {
    if (millis() - last_monitor_ms > MONITOR_WAIT_MS) {
        last_monitor_ms = millis();
        motor.monitor();
    }
}

void loop() {
    motor.loopFOC();
    motor.move(target_angle);
+   monitorMotor();
    command.run();
}

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	if (millis() - last_monitor_ms > MONITOR_WAIT_MS) {
	last_monitor_ms = millis();
	// function intended to be used with serial plotter to monitor motor variables
	// significantly slowing the execution down!!!!
	motor.monitor();
	}
	void monitorMotor() {
	if (millis() - last_monitor_ms > MONITOR_WAIT_MS) {
	last_monitor_ms = millis();
	motor.monitor();
	}
	}
	void loop() {
	motor.loopFOC();
	motor.move(target_angle);
	monitorMotor();
	command.run();
	}