Scrypted advanced notifier

https://github.com/apocaliss92/scrypted-advanced-notifier - For requests and bugs

This plugin is feature rich notifier to handle detection notifications.

Homeassistant

It's possbile to configure an homeassistant connection (or utilize the one configured in the Homeassistant plugin) to fetch configured Rooms and Entities which are identified by one of the Entity regex patterns, these can be then assigned to a camera or sensor to add metadata used to render the notification. The fetched data will be visible in the METADATA group, and edited

MQTT

It's possible to use MQTT to report data to homeassistant, can be configured standalone or use the configuration from the main MQTT plugin.

• Active entities topic: topic the plugin will subscribe to activate the rules OnActive. Useful to sync the plugin with an alarm system connected to homeassistant (i.e. Alarmo)
• Active devices for MQTT reporting: devices selected will be periodically reported to MQTT with several information, i.e. last detections happened, images, status and so on

Notifier

Mainly supported notifiers are from Homeassistant and Pushover plugins

• Active notifiers: master controller of active notifiers. Each rule will specify it's own set of notifiers

Texts

List of strings that will be shown on the notifications based on the detection type. Useful to have localized text, many placeholders are available and specified in each text

Detection rules

Fine grained rules can be defined to filter out detections and dispatch to specific notiries at specific conditions, called Detection rules. These rules can be added on Plugin level or on Camera level. Each rule has the following settings:

• Enabled: Enable or disable the rule
• Activation: One of Always, OnActive, Schedule
  • Always - the rule will always be active (besides enabled flag being off)
  • OnActive - the rule will be active only for the devices selected in the "OnActive" devices selector (in Detection Rules -> General). This target is automatically synced with the MQTT topic defined in the setting "Active entities topic" under MQTT. MQTT Must be enabled
  • Schedule - the rule will be active based on a schedule defined in the rule
• Priority: Priority of the notification, will have effect only for pushover
• Custom text: override text to show on each notification. Will override the defaults
• Detection classes: detection classes to trigger the notification
• Score threshold: minimum score to trigger a notification
• Notifiers: notifiers to notify
• Open sensors: sensors that must be open to trigger a notification
• Closed sensors: sensors that must be closed to trigger a notification
• Actions: actions that will be shown on the notification. Rendering will vary depending on the notifier. For HA will be an actionable notification, for pushover will be additional links in the text. Both of them require homeassistant to work, the same event will be triggered with the specified action type
• Devices: Only available for Always and Schedule activations. Devices for which notification is active
• Day - Start time - End time: properties required for the Schedule activation

The same detection rules can be defined on each camera level with some additional properties

• Whitelisted zones: Only detections on these zones will trigger a notification
• Blacklisted zones: Detections on these zones will be ignored

Test

A test notification can be send with the specified settings

Device mixin

On each camera/sensor can be set some metadata to enhance the notifications

General

• Room: room where the camera is located
• EntityID: alias of the camera (i.e. on homeassistant). Only used to identify the camera when syncing the OnActive devices from Homeassistant
• Device class: homeassistant device class to specify the type of the sensor created on MQTT. Defaults will be fine

Notifier

• Actions: actionable notifications added to the notification
• Minimum notification delay: minimum amount of seconds to wait between notification for the same combination of room-detectionClass
• Snapshot width/height: dimensions of the snapshot (only for cameras)
• Ignore camera detections: ignore detections from the camera. Should always be disabled if the camera is not active on the NVR, otherwise no detections would ever happen (only for cameras)
• Linked camera: camera linked to this sensor. Any event happening on the sensor will use the provided camera for the snapshot

Webhook (only for cameras)

Simple webooks to retrieve information, only the last snapshot is for now available, could be extended with something else in the future

Notifier mixin

• Snapshot scale: scale up/down the snapshot of a camera. If 1 will use the originated on camera and will improve performances
• Texts: override of the plugin level texts

What's next

• Add boundary box on detected object (really struggling :D)
• Notification snoozing
• Add more test suits to emulate a detection on specific conditions
• Setup a timeframe where all the notifications are kept and release as a GIF at the end (I saw a comment from an user on discord and I found it a great idea!)
• ...