@apocaliss92/scrypted-advanced-notifier
Advanced tools
Advanced notifier rule based with connections to MQTT and Homeassistant. Allows customized detections, occupancy and timelapses
☕️ If this extension works well for you, consider buying me a coffee. Thanks! Buy me a coffee!
To enable MQTT exporting:
MQTT enabled in the general -> general tabUse MQTT plugin credentials to use the credentials set on the MQTT pluginUse NVR detections if you want the images stored on MQTT to be the clipped ones from NVR.Audio pressure (dB) detection if you want a continuous reporting of the audio kept by the camera (dBs)Check objects occupancy regularly if you want regular occupancy data checks on the cameraThe plugin will export to MQTT the following entities:
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):
Native Scrypted notifiers (i.e. Scrypted iPhone app...)
Ntfy
Homeassistant push notifications
Pushover
Telegram
It's useful to use Pushover or NTFY as notifiers storage, in combination with a homeassistant or NVR one, setting its priority to the lowest. This will allow to have a rich notification and also to store it on another notifier. This because notifiers such as pushover, ntfy or telegram do not have a nice support to actions. Following parameters are required to successfully send notifications
Scrypted token: Token stored on the scrypted entity on homeassistant
NVR url: Url pointing to the NVR instance, should be accessible from outside
Each notifier will be fully configurable on every rule, with possibility to set: actions, addSnoozeActions or priority. Default actions can be set on every camera, will be added to each notification
All notifiers currently support critical notifications.
Notifications can be disabled for a specific camera on the camera page, Advanced notifier => Notifier => Notifications enabled (available on MQTT as well)
Notifications can be disabled globally on the general tab of the plugin
Plugins supports scripting of the NVR buitin notifiers, following features are available:
Texts section (enabled by default)NVR notifiers can be used both as plugin notifiers, then with rules and everything, or just to enhance the NVR notifications.
Scrypted iPhone App (user))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
"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 pushoverHomeassistant 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 infoOpen sensors which sensors should be open to enable the ruleClosed sensors which sensors should be closed to enable the ruleAlarm modes which alarm states should enable the rule. The alarm system device can be defined in the plugin page under Rules => Security systemNotify with a clip available only for detection and occupancy rules, the plugin will activate a decoder to save the last frames of the camera. On the trigger of a rule, a short clip will be generated and sent instead of a simple snapshot. It supports 2 types:
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:
Detection rules selector and hit save. A new tab will appearUse NVR detections to trigger the rule only as effect of detections from NVR plugin. This will include cropped images stored on MQTT and will be in sync with the NVR app events reelMinimum notification delay to debounce further notifications (overrides the camera settings)Minimum MQTT publish delay to debounce the image update on MQTT for this ruleWhitelisted zones to use only detections on these zonesBlacklisted zones to ignore detections coming from these zonesDisable recording in seconds to enable NVR recording for some seconds and disable it afterwordsCustom text if a specific text should be applied. By default detection rules will use the texts defined in the plugin tab Texts, many placeholder are available to enrich the contentEnable 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, GroqCLIP Description to use semantic search and filter out even more detections. It will be applied at the very end of the chain, when all the filters already had effect. Set CLIP confidence level to finetune the confidence level of the searchAI filter to send the image to the choosen AI tool to confirm the input promptImage post processing to process notification images:
These rules will monitor a specific area to mark it as occupied or not
Object DetectorOccupancy rules selector and hit save. A new tab will appearObserve type zone defined in the Object detection section of the cameraZone type
Intersect if the objects can be considered detected if falling in any portion of the zoneContain if the objects should be completely included in the detection zoneScore threshold, in case of static detections should be pretty low (default 0.3)Occupancy confirmation, it's a confirmation period in seconds to avoid false results. Set it depending on your specific caseForce update in seconds to force an occupancy check if no detection happens. Any detection running on the camera will anyways check all the occupancy rulesMax objects the zone can contain. The zone will be marked as occupied if the detected objects are >= of the number set hereZone occupied text and Zone not occupied text for the notification textsConfirm occupancy with AI to confirm occupancy results to reduce even more false positives. Under the plugin AI section is possible to customize the prompt. Results may vary depending on the model usedDefine 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.
Timelapse rules selector and hit save. A new tab will appearNotification text for the notification messageFrames acquisition delay, a frame will be generated according to this. Each non-motion detection will always add a frame
Timelapse framerate, this will depend on the timespan you will chose and how long you want the final clip to beGenerate now button to reuse the frames collected the previous session. They will be stored until the following session startsAudio rules will activate only if a source of audio measurement is active. These are currently probided by Basic object detector (Audio detector mixin) and Frigate Bridge (Frigate audio detector). Audio rules will monitor the audio received by the camera
Audio rules selector and hit save. A new tab will appearNotification text for the notification messageDecibel threshold for the audio level to alertDuration in seconds if the audio should last at least these seconds to trigger a notification. Leave blank to notify right awayThe 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 pathMinimum 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 hardwareOff motion duration, amount of seconds to consider motion as ended for rules/detections affecting the camera. It will override the motion off eventsSnapshot from Decoder, take snapshots from the camera decoded stream. If set to Always it will be active only if any detection rule with videoclips, timelapse or occupancy rule is running. If set OnMotion it will run only during motion sessions, usefull if your camera gives many snapshot timeout errors. Auto will be the default and regulate it when requiredMinimum notification delay to debounce further notificationsMinimum MQTT publish delay to debounce the image update on MQTT for this basic detectionsSome basic webhooks are available
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 }object-detection-{ motion | any_object | animal | person | vehicle }-{ Crop | MarkBoundaries}object-detection-{ motion | any_object | animal | person | vehicle }-{ NVR | Frigate }object-detection-face-{ known person label }object-detection-face-{ known person label }-{ NVR | Frigate }rule-{ ruleName }rule-{ ruleName }-{ motion | any_object | animal | person | vehicle }rule-{ ruleName }-{ Crop | MarkBoundaries}rule-{ ruleName }-{ Crop | MarkBoundaries}-{ motion | any_object | animal | person | vehicle }Provide multiple urls, for each detection, POST a b64 image with some additional metadata. Filter on some classes and define a minimum delay.
The plugin provides a security system hooked into the plugin detection rules. To use it this will be required:
AdvancedSecuritySystem and set 1 or more modes to activate the ruleAdvanced security system device with preferred preferences, such as texts or devices that can be bypassed during the activationThe device is discovered on MQTT and completely compatible with Homekit.
FAQs
Advanced notifier rule based with connections to MQTT and Homeassistant. Allows customized detections, occupancy and timelapses
We found that @apocaliss92/scrypted-advanced-notifier demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket’s new Pull Request Stories give security teams clear visibility into dependency risks and outcomes across scanned pull requests.
Research
/Security News
npm author Qix’s account was compromised, with malicious versions of popular packages like chalk-template, color-convert, and strip-ansi published.
Research
Four npm packages disguised as cryptographic tools steal developer credentials and send them to attacker-controlled Telegram infrastructure.