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

Configurable GPIO Pins for the PN532 #149

Merged
merged 1 commit into from
Nov 17, 2024
Merged

Configurable GPIO Pins for the PN532 #149

merged 1 commit into from
Nov 17, 2024

Conversation

rednblkx
Copy link
Owner

@rednblkx rednblkx commented Nov 9, 2024

TL;DR

Added configurable GPIO pins for PN532 NFC reader and improved HomeKit settings UI

What changed?

  • Added input fields for PN532 NFC reader GPIO pins (SS, SCK, MISO, MOSI)
  • Converted HomeKit lock/unlock checkboxes to dropdown selects
  • Reorganized the UI by creating a "Personalization" section
  • Made PN532 initialization dynamic based on configured GPIO pins
  • Added proper cleanup of NFC task on deletion

How to test?

  1. Navigate to the web interface
  2. Configure custom GPIO pins for the PN532 NFC reader
  3. Verify the NFC reader functions with the new pin configuration
  4. Test HomeKit lock/unlock settings using the new dropdown selects
  5. Verify all settings are persisted after reboot

Why make this change?

This change provides flexibility for different hardware configurations by allowing custom GPIO pin assignments for the PN532 NFC reader. It also improves the user interface for HomeKit settings and adds proper resource cleanup for the NFC task.

Summary by CodeRabbit

  • New Features

    • Introduced a "Personalization" section with a new "PN532" subsection for NFC GPIO pin configuration.
    • Added input fields for NFC GPIO pins (SS, SCK, MISO, MOSI).
    • Updated input methods for "Always Lock on HomeKey" and "Always Unlock on HomeKey" to dropdowns for better user interaction.
  • Style

    • Enhanced layout consistency with flexbox properties and cohesive styling for the new section.
  • Bug Fixes

    • Improved handling of NFC component initialization and configuration for better performance.

Copy link

coderabbitai bot commented Nov 9, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve structural and functional updates to the data/misc.html and src/main.cpp files. In misc.html, the main section header was changed to "Personalization," and a new subsection for "PN532" was added, including input fields for NFC GPIO pins. Dropdowns replaced checkboxes for two settings, and styling updates were made. In main.cpp, NFC component management was improved through dynamic allocation, and the configuration structure was updated to include an NFC GPIO pins array. Overall, these changes enhance the form's functionality and the NFC setup's modularity.

Changes

File Change Summary
data/misc.html - Changed section header from "HomeKit" to "Personalization"
- Added "PN532" subsection with input fields for NFC GPIO pins (SS, SCK, MISO, MOSI)
- Updated input method for "Always Lock on HomeKey" and "Always Unlock on HomeKey" from checkbox to dropdown select
- Added flexbox styling for layout consistency
src/main.cpp - Changed PN532_SPI and PN532 objects to dynamic allocation using pointers
- Updated nfc_thread_entry and setup methods to use pointer dereferencing
- Added std::array<uint8_t, 4> nfcGpioPins{SS, SCK, MISO, MOSI} for organized GPIO management
- Ensured integration of new NFC configurations with MQTT and web server setups

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant WebServer
    participant NFC
    participant Config

    User->>WebServer: Submit NFC Configuration
    WebServer->>Config: Update NFC GPIO Pins
    Config->>NFC: Initialize with GPIO Pins
    NFC->>NFC: Begin Communication
    NFC-->>WebServer: Status Update
    WebServer-->>User: Confirmation Response
Loading

🐇 "In fields of code, where changes bloom,
New sections sprout, dispelling gloom.
With dropdowns bright and inputs clear,
Our NFC dance brings us cheer!
So hop along, let's celebrate,
The joy of code, oh, isn't it great?" 🌼


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 changed the title configurable pins for nfc module Configurable GPIO Pins for the PN532 Nov 9, 2024
@rednblkx rednblkx marked this pull request as ready for review November 9, 2024 20:00
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:34 PM EST: Graphite rebased this pull request as part of a merge.
  • Nov 17, 12:35 PM EST: A user merged this pull request with Graphite.

@rednblkx rednblkx changed the base branch from nfc-ignore to graphite-base/149 November 17, 2024 17:31
@rednblkx rednblkx changed the base branch from graphite-base/149 to main November 17, 2024 17:33
@rednblkx rednblkx merged commit 691ddd3 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