module.yaml
doors version 2.5 · 2 KB
| 1 | # LocalEye custom module: door access from an ICT Protege WX controller. |
| 2 | # Install: copy this "doors" folder into the NVR's custom-modules/ folder, then Settings -> Modules -> Trust & load. |
| 3 | id: doors |
| 4 | name: Door access (ICT Protege WX) |
| 5 | icon: "🚪" |
| 6 | version: "2.5" |
| 7 | author: JP |
| 8 | summary: >- |
| 9 | Shows door events from an ICT Protege WX controller next to your cameras: each event is bookmarked on the camera |
| 10 | covering that door, with a jump to the footage, and denied / granted access can send an alert (the NVR's alert channels |
| 11 | and phones). Closed, forced-open and held-open events are not recorded. Old history and its bookmarks are removed with the |
| 12 | NVR's own cleanup. |
| 13 | adds: |
| 14 | - Doors page in the menu |
| 15 | - Settings → Door access |
| 16 | page: Doors # menu label; the page is /x/doors/ |
| 17 | admin_only: true # only admins see the page and its API |
| 18 | remote: true # usable through localeye.cam remote access too (still admin + signed in) |
| 19 | tables: |
| 20 | door_events: Door controller events (badge swipes, doors opened) and the camera they matched |
| 21 | settings_intro: >- |
| 22 | Polls an ICT Protege WX controller and links its door events to cameras. Set which camera covers which door on the |
| 23 | Doors page. |
| 24 | settings: |
| 25 | - {key: protege_host, label: Protege WX address, type: text, hint: "e.g. http://10.0.0.5"} |
| 26 | - {key: protege_username, label: Protege operator username, type: text, hint: a dedicated read-only operator is best} |
| 27 | - {key: protege_password, label: Protege operator password, type: password, hint: leave the dots to keep the saved password} |
| 28 | - {key: protege_poll_seconds, label: Check for new events every (s), type: number, min: 5, max: 3600, default: 10} |
| 29 | - {key: protege_verify_tls, label: Verify HTTPS certificate, type: bool, default: false} |
| 30 | - {key: alert_denied, label: "Alert: access denied", type: bool, default: false} |
| 31 | - {key: alert_granted, label: "Alert: every access granted", type: bool, default: false} |
| 32 | - {key: retention_days, label: Keep door history (days), type: number, min: 1, max: 3650, default: 365} |
| 33 | settings_buttons: |
| 34 | - {label: Test connection, action: test} |