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 HomeKit dumb switch mode #154

Merged
merged 1 commit into from
Nov 17, 2024
Merged

Add HomeKit dumb switch mode #154

merged 1 commit into from
Nov 17, 2024

Conversation

rednblkx
Copy link
Owner

@rednblkx rednblkx commented Nov 17, 2024

TL;DR

Added a "Dumb Switch Mode" option for HomeKit integration that allows the lock state to update without the external interaction

What changed?

  • Added a new configuration option "Dumb Switch Mode" in the misc settings page
  • Introduced hkDumbSwitchMode boolean flag in the misc configuration
  • Modified the LockMechanism service to update the lock state immediately when in dumb switch mode

How to test?

  1. Navigate to the misc settings page
  2. Enable "Dumb Switch Mode"
  3. Try controlling the lock through HomeKit
  4. Verify the lock state updates in HomeKit without requiring the external feedback

Why make this change?

This change supports scenarios where users want to use the HomeKit interface without a MQTT or GPIO interaction, essentially turning the device into a virtual switch. This change does the same thing as when using the Simple GPIO HomeKit Trigger.

Summary by CodeRabbit

  • New Features

    • Introduced a dropdown for "Dumb Switch Mode" in the General settings, allowing users to enable or disable this feature.
    • The state of the "Dumb Switch Mode" is preserved upon form loading.
  • Bug Fixes

    • Enhanced handling of the lock's behavior based on the new "Dumb Switch Mode" setting.

Copy link

coderabbitai bot commented Nov 17, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduce a new dropdown selection for "Dumb Switch Mode" in the HTML form, allowing users to set this option to "Enabled" or "Disabled." Corresponding JavaScript updates ensure the dropdown reflects the current state when the form loads. Additionally, a new boolean variable hkDumbSwitchMode is added to the misc_config_t structure in the C++ code, affecting the lock mechanism's behavior based on this setting. The web server's response is modified to include this new configuration option, enabling user interaction with the setting through the web interface.

Changes

File Change Summary
data/routes/misc.html Added a dropdown for "Dumb Switch Mode" with options "Disabled" and "Enabled"; updated JavaScript to set the selected index based on %DUMBSWITCHMODE%.
src/main.cpp Introduced a new boolean variable hkDumbSwitchMode in misc_config_t; updated related functions to incorporate this variable into the lock mechanism and web server responses.

Possibly related PRs

  • Momentary state improvement #146: The changes in this PR involve modifications to HTML forms and JavaScript related to HomeKit configurations, which may relate to the new dropdown for "Dumb Switch Mode" in the main PR, as both involve user interface elements for configuring settings.

Poem

In the land of code where bunnies play,
A dropdown appeared to brighten the day.
"Enabled" or "Disabled," a choice so neat,
With hkDumbSwitchMode, our settings are sweet!
Hopping through logic, we dance with delight,
Configuring locks, everything feels right! 🐇✨

Warning

Rate limit exceeded

@rednblkx has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 51 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

Reviewing files that changed from the base of the PR and between df3bc49 and f7cb016.


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 process lock/unlock requests without state validation (useful for homekit automations) Add HomeKit dumb switch mode Nov 17, 2024
@rednblkx rednblkx marked this pull request as ready for review November 17, 2024 17:26
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:43 PM EST: Graphite rebased this pull request as part of a merge.
  • Nov 17, 12:44 PM EST: A user merged this pull request with Graphite.

@rednblkx rednblkx changed the base branch from lock-battery-reporting to graphite-base/154 November 17, 2024 17:39
@rednblkx rednblkx changed the base branch from graphite-base/154 to main November 17, 2024 17:41
@rednblkx rednblkx merged commit c53931a 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