unifiprotect-fingerprint-and-nfc-event-support #35892
Conversation
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 Walkthrough📝 WalkthroughWalkthroughThe changes introduce a new section titled "Event Entities Support" in the UniFi Protect integration documentation. This section outlines support for three specific event types: Doorbell Ring Event, NFC Card Scanned Event, and Fingerprint Identified Event. Each event type is described with relevant attributes, including Changes
Warning Rate limit exceeded@RaHehl has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 7 minutes and 46 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the 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. 📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (4)
source/_integrations/unifiprotect.markdown (4)
97-100: Add device compatibility information to the introduction.Consider adding information about which UniFi Protect devices support these events (e.g., G4 Doorbell Pro) to help users understand hardware requirements upfront.
The UniFi Protect integration provides support for various event types triggered by connected devices. Below are the descriptions for each supported event type: + +These events are supported by the following devices: +- G4 Doorbell Pro (Doorbell Ring, NFC Card, Fingerprint events) +- [List other compatible devices...]
101-107: Clarify the entity naming pattern in the example.The example
event.g4_doorbell_pro_doorbellneeds more context about how the entity name is constructed.- For instance, you can use `event.g4_doorbell_pro_doorbell` to get the thumbnail image when a ring occurs. + For instance, you can use the event entity (e.g., `event.g4_doorbell_pro_doorbell` where the entity name is based on your device's name) to get the thumbnail image when a ring occurs.
109-116: Add information about unregistered NFC cards and use cases.Consider adding details about:
- Whether the event triggers for unregistered NFC cards
- How to use the
nfc_idin automations (e.g., for access control)- **Description**: This event is triggered when an NFC card is scanned at a compatible device (e.g., a smart doorbell). It contains information such as the `nfc_id` of the scanned card. + +The event is triggered for both registered and unregistered NFC cards. You can use the `nfc_id` in your automations to: +- Track access attempts +- Trigger actions based on specific NFC cards +- Log unauthorized access attempts
97-126: Add a practical automation example.Consider adding a complete automation example that demonstrates how to use these events in practice. This would help users understand how to integrate these events into their home automation setup.
- **Description**: This event is triggered when a fingerprint is scanned by a compatible device. If the fingerprint is recognized, it provides a `ulp_id`, which represents the fingerprint ID. If the fingerprint is not recognized, the `event_type` will be set to `fingerprint_not_identified`, and no `ulp_id` will be provided. +## Example Automation + +Here's an example of how to use these events in an automation: + +```yaml +automation: + - alias: "Notify on Unauthorized Fingerprint" + trigger: + platform: event + event_type: unifiprotect_event + event_data: + event_type: fingerprint_not_identified + action: + - service: notify.mobile_app + data: + message: "Unauthorized fingerprint scan detected!" + data: + image: "/api/unifiprotect/thumbnail/{{ trigger.event.data.nvr_id }}/{{ trigger.event.data.event_id }}" +```
| ### Fingerprint Identified Event | ||
|
|
||
| - **Event Name**: Fingerprint | ||
| - **Event Attributes**: | ||
| - **event_type**: Either `fingerprint_identified` or `fingerprint_not_identified` | ||
| - **event_id**: A unique ID that identifies the fingerprint event. | ||
| - **ulp_id**: The fingerprint ID used to identify the person. If no fingerprint match is found, the `ulp_id` will be empty and the `event_type` will be `fingerprint_not_identified`. | ||
| - **Description**: This event is triggered when a fingerprint is scanned by a compatible device. If the fingerprint is recognized, it provides a `ulp_id`, which represents the fingerprint ID. If the fingerprint is not recognized, the `event_type` will be set to `fingerprint_not_identified`, and no `ulp_id` will be provided. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add security considerations for fingerprint events.
Consider adding a note about security best practices when handling fingerprint-related data in automations.
- **Description**: This event is triggered when a fingerprint is scanned by a compatible device. If the fingerprint is recognized, it provides a `ulp_id`, which represents the fingerprint ID. If the fingerprint is not recognized, the `event_type` will be set to `fingerprint_not_identified`, and no `ulp_id` will be provided.
+
+{% note %}
+**Security Note**: When using fingerprint events in automations, follow security best practices:
+- Avoid logging or storing the `ulp_id` in external systems
+- Use secure methods to handle access control decisions
+- Consider implementing rate limiting for failed attempts
+{% endnote %}📝 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. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ### Fingerprint Identified Event | |
| - **Event Name**: Fingerprint | |
| - **Event Attributes**: | |
| - **event_type**: Either `fingerprint_identified` or `fingerprint_not_identified` | |
| - **event_id**: A unique ID that identifies the fingerprint event. | |
| - **ulp_id**: The fingerprint ID used to identify the person. If no fingerprint match is found, the `ulp_id` will be empty and the `event_type` will be `fingerprint_not_identified`. | |
| - **Description**: This event is triggered when a fingerprint is scanned by a compatible device. If the fingerprint is recognized, it provides a `ulp_id`, which represents the fingerprint ID. If the fingerprint is not recognized, the `event_type` will be set to `fingerprint_not_identified`, and no `ulp_id` will be provided. | |
| ### Fingerprint Identified Event | |
| - **Event Name**: Fingerprint | |
| - **Event Attributes**: | |
| - **event_type**: Either `fingerprint_identified` or `fingerprint_not_identified` | |
| - **event_id**: A unique ID that identifies the fingerprint event. | |
| - **ulp_id**: The fingerprint ID used to identify the person. If no fingerprint match is found, the `ulp_id` will be empty and the `event_type` will be `fingerprint_not_identified`. | |
| - **Description**: This event is triggered when a fingerprint is scanned by a compatible device. If the fingerprint is recognized, it provides a `ulp_id`, which represents the fingerprint ID. If the fingerprint is not recognized, the `event_type` will be set to `fingerprint_not_identified`, and no `ulp_id` will be provided. | |
| {% note %} | |
| **Security Note**: When using fingerprint events in automations, follow security best practices: | |
| - Avoid logging or storing the `ulp_id` in external systems | |
| - Use secure methods to handle access control decisions | |
| - Consider implementing rate limiting for failed attempts | |
| {% endnote %} |
Proposed change
SSIA
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit