Add Battery reporting from a Smart Lock

[rednblkx]

TL;DR

Added SmartLock battery level reporting functionality via MQTT and HomeKit integration.

What changed?

• Added battery level reporting configuration options in the web UI
• Implemented battery level threshold settings (0-100%)
• Created new MQTT topic for battery level commands
• Added HomeKit battery service with low status and level characteristics
• Introduced new CLI commands for debugging purposes ('N' and 'B')

How to test?

1. Enable SmartLock battery reporting in the Misc settings
2. Set desired battery low threshold percentage
3. Configure MQTT battery level command topic
4. Send battery level updates via MQTT or CLI commands:
   • Use 'N 0/1' to toggle battery low status
   • Use 'B [level]' to set battery percentage
5. Verify battery status appears in HomeKit
6. Confirm low battery warnings trigger when level drops below threshold

Why make this change?

Enables monitoring of physical lock battery levels through HomeKit and MQTT, allowing users to receive notifications when batteries need replacement and maintain better awareness of their lock's power status.

Summary by CodeRabbit

• New Features

  • Added new input fields for battery reporting configuration in the General settings and MQTT configuration forms.
  • Introduced a new MQTT topic for battery level updates, enhancing integration with HomeKit.
  • Enhanced battery management functionality with new commands and monitoring options.

• Bug Fixes

  • Improved error handling and logging for MQTT client operations.

• Documentation

  • Updated configuration options to include new battery-related settings.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The pull request introduces modifications across several files to enhance battery management and MQTT configuration functionalities. Key updates include new input fields in HTML files for SmartLock battery reporting, the addition of a new MQTT topic for battery level commands, and enhancements in the main C++ source file to manage battery characteristics and MQTT communication. The changes aim to improve user interaction with battery settings and expand the device's capabilities in reporting battery status.

Changes

File	Change Summary
data/routes/misc.html	- Added new input fields for SmartLock battery reporting: <select> for enabling and <input> for low threshold. - Updated layout for better spacing between elements.
data/routes/mqtt.html	- Introduced a new input field for MQTT configuration: <input> for "SmartLock battery level Cmd Topic".
src/config.h	- Defined new MQTT topic for battery level updates: #define MQTT_PROX_BAT_TOPIC "homekit/set_battery_lvl".
src/main.cpp	- Added new variables and structures for battery management and MQTT configuration. - Introduced PhysicalLockBattery class and updated mqtt_data_handler for handling battery level commands. - Enhanced error handling and logging throughout the code.

Possibly related PRs

• Momentary state improvement #146: The changes in this PR involve modifications to HTML forms and JavaScript functionality, similar to the updates made in the main PR to the misc.html file, indicating a focus on enhancing user interface elements and form handling.

Poem

In the burrow, we hop with glee,
New fields for batteries, oh what a spree!
MQTT topics now take flight,
Reporting levels, day and night.
With every change, our hearts do sing,
SmartLock’s magic, a wondrous thing! 🐇✨

Warning

Rate limit exceeded

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

---

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

• Add HomeKit dumb switch mode #154
• Add Battery reporting from a Smart Lock #153 👈 (View in Graphite)
• Web Interface reorganization #150
• Configurable GPIO Pins for the PN532 #149
• Add NFC tag MQTT ignore option #147
• Momentary state improvement #146
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[rednblkx]

Merge activity

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