Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add MQTT support #98

Merged
merged 9 commits into from
Apr 5, 2024
Merged

Add MQTT support #98

merged 9 commits into from
Apr 5, 2024

Conversation

janvrska
Copy link
Contributor

@janvrska janvrska commented Apr 3, 2024

In response to feature request #83, I'm creating this PR to add MQTT detection publishing support.

I tested that it works, please give me a review @tphakala. Thanks

Summary by CodeRabbit

  • New Features
    • Added MQTT integration for real-time communication, enabling the app to send notes to an MQTT broker.
    • Introduced configuration options for MQTT settings, allowing users to enable MQTT, and specify broker, topic, username, and password.

Copy link
Contributor

coderabbitai bot commented Apr 3, 2024

Warning

Rate Limit Exceeded

@tphakala has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 57 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 6140be3 and 0551f70.

Walkthrough

The recent update introduces MQTT integration, enabling MQTT communication within the application. This enhancement includes adding MQTT settings in the configuration, creating an MQTT client for connecting and publishing messages, and integrating MQTT actions into the processing workflow. These changes expand the application's communication capabilities by allowing interaction with MQTT brokers for real-time message handling.

Changes

Files Change Summary
.../processor/actions.go, .../processor.go Added MQTT action handling and integrated MQTT client in the Processor for MQTT communication.
.../processor/workers.go Included MQTT action in default actions when MQTT is enabled.
internal/conf/config.go Added MQTT configuration settings.
internal/mqtt/mqtt.go Introduced functionality for MQTT client creation, message publishing, and connection handling.

🐇✨
In the land of code, where the bits align,
A rabbit hopped in, with an idea so fine.
"Let's talk with MQTT, in real-time chatter,
Sending notes far and wide, on matters that matter."
With a flick and a hop, the code was spun,
Now the apps can talk, and oh, what fun!
🌟📡🐰

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

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.

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.
  • 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/coderabbit-overrides.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.

@janvrska janvrska marked this pull request as ready for review April 5, 2024 09:31
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 8

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7dd43f6 and 3a8454c.
Files ignored due to path filters (2)
  • go.mod is excluded by !**/*.mod
  • go.sum is excluded by !**/*.sum
Files selected for processing (5)
  • internal/analysis/processor/actions.go (4 hunks)
  • internal/analysis/processor/processor.go (3 hunks)
  • internal/analysis/processor/workers.go (1 hunks)
  • internal/conf/config.go (2 hunks)
  • internal/mqtt/mqtt.go (1 hunks)

internal/mqtt/mqtt.go Outdated Show resolved Hide resolved
internal/mqtt/mqtt.go Outdated Show resolved Hide resolved
Comment on lines +48 to +59
func (c *Client) Publish(topic string, payload string) error {
if c.internalClient == nil {
return errors.New("MQTT client is not initialized")
}

if c.internalClient.IsConnected() == false {
return errors.New("MQTT client is not connected")
}

token := c.internalClient.Publish(topic, 0, false, payload)
token.Wait()
return token.Error()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add QoS (Quality of Service) and retain flag as configurable options for the Publish method to enhance flexibility.

- func (c *Client) Publish(topic string, payload string) error {
+ func (c *Client) Publish(topic string, payload string, qos byte, retain bool) error {
-   token := c.internalClient.Publish(topic, 0, false, payload)
+   token := c.internalClient.Publish(topic, qos, retain, payload)

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
func (c *Client) Publish(topic string, payload string) error {
if c.internalClient == nil {
return errors.New("MQTT client is not initialized")
}
if c.internalClient.IsConnected() == false {
return errors.New("MQTT client is not connected")
}
token := c.internalClient.Publish(topic, 0, false, payload)
token.Wait()
return token.Error()
func (c *Client) Publish(topic string, payload string, qos byte, retain bool) error {
if c.internalClient == nil {
return errors.New("MQTT client is not initialized")
}
if c.internalClient.IsConnected() == false {
return errors.New("MQTT client is not connected")
}
token := c.internalClient.Publish(topic, qos, retain, payload)
token.Wait()
return token.Error()

internal/mqtt/mqtt.go Outdated Show resolved Hide resolved
internal/analysis/processor/workers.go Outdated Show resolved Hide resolved
internal/analysis/processor/actions.go Outdated Show resolved Hide resolved
internal/conf/config.go Show resolved Hide resolved
internal/analysis/processor/processor.go Outdated Show resolved Hide resolved
tphakala and others added 5 commits April 5, 2024 13:07
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3a8454c and b673b95.
Files selected for processing (1)
  • internal/analysis/processor/processor.go (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • internal/analysis/processor/processor.go

tphakala and others added 2 commits April 5, 2024 13:11
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between b673b95 and 6140be3.
Files selected for processing (1)
  • internal/analysis/processor/actions.go (4 hunks)
Additional Context Used
GitHub Check Runs (1)
lint failure (10)

internal/analysis/processor/actions.go: [failure] 155-155:
undefined: errors (typecheck)

Additional comments not posted (1)
internal/analysis/processor/actions.go (1)

56-61: The MqttAction struct is well-defined and appropriately structured for MQTT functionality.

internal/analysis/processor/actions.go Show resolved Hide resolved
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
@tphakala tphakala added the enhancement New feature or request label Apr 5, 2024
@tphakala tphakala merged commit 117c9c1 into tphakala:main Apr 5, 2024
2 of 3 checks passed
@janvrska janvrska deleted the mqtt-support branch April 5, 2024 11:34
@tphakala
Copy link
Owner

tphakala commented Apr 5, 2024

Thank you! Merged and new release created containing this new feature.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants