@apocaliss92/scrypted-advanced-notifier 3.3.7 → 3.4.0

package/CHANGELOG.md

@@ -1,9 +1,15 @@
 <details>
 <summary>Changelog</summary>
 
+### 3.4.0
+
+- Latest snapshots webhook changed, add a Webhook section to the README with all the possible snapshots available
+- Added POST webhook for detections, set multiple URL and preferred cameras to send images to external services
+
 ### 3.3.7
 
 - Add setting to disable notifications for a specific camera, on MQTT as well
+- Implement snooze actions on Homeassistant notifiers
 
 ### 3.3.6
 

package/README.md

@@ -3,23 +3,27 @@
 https://github.com/apocaliss92/scrypted-advanced-notifier - For requests and bugs
 
 # Getting started
+
 ## MQTT
+
 To enable MQTT exporting:
+
 - enable `MQTT enabled` in the general -> general tab
 - setup the authentication parameters in the tab general -> MQTT, check the `Use MQTT plugin credentials` to use the credentials set on the MQTT plugin
-- Check `Use NVR detections` if you want the images stored on MQTT to be the clipped ones from NVR. 
+- Check `Use NVR detections` if you want the images stored on MQTT to be the clipped ones from NVR.
 - Check `Audio pressure (dB) detection` if you want a continuous reporting of the audio kept by the camera (dBs)
 - Set a positive number to `Check objects occupancy in seconds` to regularly check the static objects on the frame
 - Cameras enabled to the plugin will be automatically enabled to MQTT. Can be disabled in the camera's section Advanced notifier -> Report to MQTT
 
 The plugin will export to MQTT the following entities:
+
 - PTZ controls
 - Restart control
 - Basic detection information (motion, animal, person, vehicle, face, plate, generic object). Same information will be available for every rule associated to a camera
-    - Latest image
-    - Triggered
-    - Last trigger time (disabled by default)
-    - Amount of objects (if enabled)
+  - Latest image
+  - Triggered
+  - Last trigger time (disabled by default)
+  - Amount of objects (if enabled)
 - Online status
 - Sleeping status
 - Battery status
@@ -27,28 +31,33 @@ The plugin will export to MQTT the following entities:
 - Current dBs (if enabled)
 
 ## Notifications
+
 The plugin provides customized way to deliver notifications. It is based on rules. Each rule can be activated based on several factors, i.e. active sensors, time ranges, security system status. Any notifier can be used but the only fully supported currently are (can be extended for any other):
+
 - Homeassistant push notifications
 - Pushover
-It's useful to use both notifiers, homeassistant as push rich notification and pushover as low priority just to store all the events
-Set the following parameters to allow rich notifications
- - `Scrypted token`: Token stored on the scrypted entity on homeassistant
- - `NVR url`: Url pointing to the NVR instance, should be accessible from outside
+  It's useful to use both notifiers, homeassistant as push rich notification and pushover as low priority just to store all the events
+  Set the following parameters to allow rich notifications
+- `Scrypted token`: Token stored on the scrypted entity on homeassistant
+- `NVR url`: Url pointing to the NVR instance, should be accessible from outside
 
 Rules can be of following types: Detection, Occupancy, Audio, Timelapse. These properties are in common with all, some are hidden until the `Show more configurations` gets activated
+
 - `Activation type`: when the rule shoul be active
-    - Always
-    - Schedule, defined in a time range during the day
-    - OnActive, will be active only if the camera will be listed in the `"OnActive" devices` selector (plugin => rules => general). This selector can be driven by MQTT with a topic specified in `Active entities topic` under General => MQTT. The message to this topic can contain either a list of device IDs, names or homeassistant entityId (check homeassistant section)
+  - Always
+  - Schedule, defined in a time range during the day
+  - OnActive, will be active only if the camera will be listed in the `"OnActive" devices` selector (plugin => rules => general). This selector can be driven by MQTT with a topic specified in `Active entities topic` under General => MQTT. The message to this topic can contain either a list of device IDs, names or homeassistant entityId (check homeassistant section)
 - `Notifiers`: notifiers to notify, additional properties will be applied depending on the selected ones
-    - `Pushover priority` priority to use on pushover
-    - `Homeassistant Actions` actions to show on the homessistant push notifications, of type `{"action":"open_door","title":"Open door","icon":"sfsymbols:door"}`, check homeassistant documentation for further info
+  - `Pushover priority` priority to use on pushover
+  - `Homeassistant Actions` actions to show on the homessistant push notifications, of type `{"action":"open_door","title":"Open door","icon":"sfsymbols:door"}`, check homeassistant documentation for further info
 - `Open sensors` which sensors should be open to enable the rule
 - `Closed sensors` which sensors should be closed to enable the rule
-- `Alarm modes` which alarm states should enable the rule. The alarm system device can be defined in the plugin page under Rules => `Security system` 
+- `Alarm modes` which alarm states should enable the rule. The alarm system device can be defined in the plugin page under Rules => `Security system`
 
 ### Detection
+
 These rules can be created for multiple cameras (on the plugin page) or per single camera. They allow to specify which object detections should trigger a notification:
+
 - Create a new rule adding a new text in the `Detection rules` selector and hit save. A new tab will appear
 - Set the activation type
 - Set the notifiers to notify on the detection
@@ -63,7 +72,9 @@ These rules can be created for multiple cameras (on the plugin page) or per sing
 - Check `Enable AI to generate descriptions` if you want to let AI generate a description text out of the image. AI settings are available on the plugin page under the AI, currently supported: GoogleAi, OpenAi, Claude, Groq
 
 ### Occupancy (only on camera)
+
 These rules will monitor a specific area to mark it as occupied or not
+
 - Make sure to set an object detector on the plugin page under Rules => `Object Detector`
 - Create a new rule adding a new text in the `Occupancy rules` selector and hit save. A new tab will appear
 - Set the activation type
@@ -72,8 +83,8 @@ These rules will monitor a specific area to mark it as occupied or not
 - Set the camera zone to monitor, must be an `Observe` type zone defined in the `Object detection` section of the camera
 - (Optional) set a capture zone to reduce the frame used for the detection, may increase success rate
 - Set `Zone type`
-    - `Intersect` if the objects can be considered detected if falling in any portion of the zone
-    - `Contain` if the objects should be completely included in the detection zone
+  - `Intersect` if the objects can be considered detected if falling in any portion of the zone
+  - `Contain` if the objects should be completely included in the detection zone
 - Set a `Score threshold`, in case of static detections should be pretty low (default 0.3)
 - Set `Occupancy confirmation`, it's a confirmation period in seconds to avoid false results. Set it depending on your specific case
 - Set `Force update in seconds` to force an occupancy check if no detection happens. Any detection running on the camera will anyways check all the occupancy rules
@@ -81,19 +92,23 @@ These rules will monitor a specific area to mark it as occupied or not
 - Set a text in both `Zone occupied text` and `Zone not occupied text` for the notification texts
 
 ### Timelapse (only on camera)
+
 Define a timeframe, the plugin will collect frames from the camera and generate a clip out of it at the end of the defined range. All the generated timelapses will be available as videoclip on the NVR app, only if the `Enable Camera` on the plugin page will be enabled.
+
 - Create a new rule adding a new text in the `Timelapse rules` selector and hit save. A new tab will appear
 - Define the week days and the start/end times. i.e. start at 11pm and end at 8am
 - Set the notifiers to notify the generated clip
-    - If an homeassistant notifier is used and the final clip will be <50bm, the clip will be shown as preview of the push notification!
+  - If an homeassistant notifier is used and the final clip will be <50bm, the clip will be shown as preview of the push notification!
 - Set a `Notification text` for the notification message
 - Set a `Frames acquisition delay`, a frame will be generated according to this. Each non-motion detection will always add a frame
-    - In future will be possible to add frames based on specific detection classes and even small clips
+  - In future will be possible to add frames based on specific detection classes and even small clips
 - Set a `Timelapse framerate`, this will depend on the timespan you will chose and how long you want the final clip to be
 - Use the `Generate now` button to reuse the frames collected the previous session. They will be stored until the following session starts
 
 ### Audio (only on camera)
+
 Audio rules will monitor the audio received by the camera
+
 - Create a new rule adding a new text in the `Audio rules` selector and hit save. A new tab will appear
 - Set the notifiers to notify the event
 - Set a `Notification text` for the notification message
@@ -101,11 +116,14 @@ Audio rules will monitor the audio received by the camera
 - Set `Duration in seconds` if the audio should last at least these seconds to trigger a notification. Leave blank to notify right away
 
 ## Stored images
+
 The plugin will store on filesystem, if configured, images for every basic detection and rule. Set the following configurations on the plugin page under the Storage tab
- - `Storage path`: If set, the images used to populate MQTT topic will be also stored on the drive path
- - `Images name`: The name pattern to use to generate image files. The placeholders ${name} and ${timestamp} will be available. Using only ${name} will ensure the image to be overriden on every detection instead of saving one additional copy
+
+- `Storage path`: If set, the images used to populate MQTT topic will be also stored on the drive path
+- `Images name`: The name pattern to use to generate image files. The placeholders ${name} and ${timestamp} will be available. Using only ${name} will ensure the image to be overriden on every detection instead of saving one additional copy
 
 ## Additional camera settings
+
 - `Minimum snapshot acquisition delay`, minimum seconds to wait until a new snapshot can be taken from a camera, keep it around 5 seconds for cameras with weak hardware
 - `Off motion duration`, amount of seconds to consider motion as ended for rules/detections affecting the camera. It will override the motion off events
 - `Snapshot from Decoder`, take snapshots from the camera decoded stream, use it only if you have many timeout errors and cannot rely on updated images on MQTT, this is CPU intensive
@@ -113,4 +131,24 @@ The plugin will store on filesystem, if configured, images for every basic detec
 - Set `Minimum MQTT publish delay` to debounce the image update on MQTT for this basic detections
 
 ## Homeassistant
+
 It's possbile to configure an homeassistant connection (or utilize the one configured in the `Homeassistant` plugin) to fetch configured entity IDs which are identified by one of the `Entity regex patterns`. The entities fetched will be available as selection on each camera/sensor to alias them with an homeassistant entity. This helps the `OnActive` rules to send entityIds instead of Scrypted identifiers.
+
+## Webhooks
+
+Some basic webhooks are available
+
+# Latest snapshot
+
+Will provide the latest registered image for each type, on the camera settings will be provided the basic url, {IMAGE_NAME} should be replaced with one of the following:
+
+- `object-detection-{ motion | any_object | animal | person | vehicle }` (full frame images)
+- `object-detection-{ motion | any_object | animal | person | vehicle }-NVR` (cropped images from NVR)
+- `object-detection-face-{ known person label }` (full frame images)
+- `object-detection-face-{ known person label }-NVR` (cropped images from NVR)
+- `rule-{ rule name }`
+
+# POST detection images
+
+Provide multiple urls, for each detection, POST a b64 image with some additional metadata. Filter
+on some classes and define a minimum delay.

package/package.json

@@ -5,7 +5,7 @@
     "type": "git",
     "url": "https://github.com/apocaliss92/scrypted-advanced-notifier"
   },
-  "version": "3.3.7",
+  "version": "3.4.0",
   "scripts": {
     "scrypted-setup-project": "scrypted-setup-project",
     "prescrypted-setup-project": "scrypted-package-json",