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 NFC tag MQTT ignore option #147

Merged
merged 2 commits into from
Nov 17, 2024
Merged

Add NFC tag MQTT ignore option #147

merged 2 commits into from
Nov 17, 2024

Conversation

rednblkx
Copy link
Owner

@rednblkx rednblkx commented Nov 6, 2024

TL;DR

Added a new option to ignore NFC tag MQTT publishing

What changed?

  • Added a new toggle in the MQTT configuration page to enable/disable NFC tag MQTT publishing
  • Introduced nfcTagNoPublish boolean flag in the ESP configuration
  • Added corresponding HTML processing and form handling for the new setting

How to test?

  1. Navigate to the MQTT configuration page
  2. Locate the new "Ignore NFC Tags" dropdown under Core Topics
  3. Toggle between Enabled/Disabled states
  4. Save the configuration
  5. Verify that NFC tag events are published or suppressed based on the selected setting

Why make this change?

This change provides users with the ability to control whether NFC tag events are published via MQTT, offering more granular control over MQTT traffic and potentially reducing unnecessary network communication when NFC tag publishing isn't needed.

Summary by CodeRabbit

  • New Features

    • Introduced a dropdown option in the MQTT configuration form to enable or disable the publishing of NFC tag data.
    • Users can now dynamically control NFC tag publishing behavior through the new configuration option.
  • Bug Fixes

    • Adjusted the form to ensure consistent layout and spacing for improved user experience.
  • Documentation

    • Updated relevant documentation to reflect the new configuration capabilities.

Copy link

coderabbitai bot commented Nov 6, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduced in this pull request enhance the MQTT configuration by adding a new dropdown option for ignoring NFC tags in the mqtt.html file. This dropdown allows users to enable or disable NFC tag publishing. Correspondingly, the main.cpp file has been updated to include a new boolean variable in the MQTT configuration structure, which controls the publishing behavior of NFC tag data based on the user's selection. The integration of these features ensures that the form and backend logic work together to reflect the user's preferences.

Changes

File Change Summary
data/mqtt.html Added a dropdown for "Ignore NFC Tags" with options "Disabled" and "Enabled"; updated JavaScript to set selected index based on %NFCTAGSNOPUBLISH%. Minor HTML structure adjustments made.
src/main.cpp Introduced a new boolean variable nfcTagNoPublish in mqttConfig_t; updated serialization macro; added logic to prevent NFC data publishing based on this variable; added handling for new POST parameter nfc-tags-ignore-mqtt.

Poem

🐇 In the land of MQTT, a change so bright,
A dropdown appears, oh what a delight!
NFC tags now can be ignored,
With just a click, the data's stored.
Hopping with joy, we celebrate this feat,
Configurations made simple, oh what a treat! 🎉


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

@rednblkx rednblkx marked this pull request as ready for review November 6, 2024 23:51
@rednblkx rednblkx changed the title flag to not publish nfc tags on mqtt Flag to not publish nfc tags on mqtt Nov 9, 2024
@rednblkx rednblkx changed the title Flag to not publish nfc tags on mqtt Flag to ignore NFC tag MQTT publishing Nov 9, 2024
@rednblkx rednblkx changed the title Flag to ignore NFC tag MQTT publishing Add NFC tag MQTT ignore option Nov 9, 2024
Copy link
Owner Author

rednblkx commented Nov 17, 2024

Merge activity

  • Nov 17, 12:30 PM EST: A user started a stack merge that includes this pull request via Graphite.
  • Nov 17, 12:32 PM EST: Graphite rebased this pull request as part of a merge.
  • Nov 17, 12:32 PM EST: A user merged this pull request with Graphite.

@rednblkx rednblkx changed the base branch from feature/momentary to graphite-base/147 November 17, 2024 17:30
@rednblkx rednblkx changed the base branch from graphite-base/147 to main November 17, 2024 17:31
@rednblkx rednblkx merged commit b2007fc into main Nov 17, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant