node-red-contrib-alarm-ultimate 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2019 Supergiovane
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

package/README.md

@@ -0,0 +1,73 @@
+# node-red-contrib-alarm-ultimate
+
+Alarm System Ultimate node for Node-RED.
+
+This package provides:
+
+- `AlarmSystemUltimate`: a full alarm control panel node (zones, entry/exit delays, bypass, chime, 24h/fire/tamper, siren, event log).
+- Output-only helper nodes to mirror alarm state into your flows (`AlarmUltimateState`, `AlarmUltimateZone`, `AlarmUltimateSiren`).
+- Web tools: a Zones JSON mapper and a web Alarm Panel (also embeddable in Node-RED Dashboard).
+
+Note: this repository currently ships `AlarmSystemUltimate` as **BETA**.
+
+
+## Nodes
+
+### Alarm System Ultimate (BETA)
+
+Main node that:
+
+- Receives **control commands** on `msg.topic === controlTopic`
+- Receives **sensor messages** on any other topic and matches them to a configured zone
+
+It emits events and state updates on multiple outputs (see the node help in the editor for full details).
+
+### Output-only helper nodes
+
+These nodes have no input and emit the current Alarm state (and changes) for one configured `AlarmSystemUltimate`:
+
+- `Alarm State` (`AlarmUltimateState`): `msg.payload = "armed"|"disarmed"`
+- `Alarm Zone` (`AlarmUltimateZone`): `msg.payload = true|false` for a selected zone
+- `Alarm Siren` (`AlarmUltimateSiren`): `msg.payload = true|false` when the siren is on/off
+
+## Web tools
+
+These pages are served via the Node-RED admin HTTP endpoint:
+
+- Zones JSON Mapper: `/alarm-ultimate/alarm-json-mapper`
+- Alarm Panel: `/alarm-ultimate/alarm-panel`
+
+The Alarm Panel supports:
+
+- Preselect node: `/alarm-ultimate/alarm-panel?id=<alarmNodeId>`
+- Embed mode (for Dashboard iframes): `/alarm-ultimate/alarm-panel?embed=1&id=<alarmNodeId>`
+
+## Examples
+
+- `examples/alarm-ultimate-basic.json`: ready-to-import flow with `AlarmSystemUltimate`, injects and debug nodes.
+- `examples/alarm-ultimate-dashboard.json`: Node-RED Dashboard example embedding the Alarm Panel in a `ui_template` iframe.
+
+See `examples/README.md`.
+
+## Permissions and endpoints
+
+When Node-RED authentication is enabled, the admin endpoints use these permissions (if available):
+
+- `AlarmSystemUltimate.read`
+- `AlarmSystemUltimate.write`
+
+HTTP admin endpoints:
+
+- `GET /alarm-ultimate/alarm/nodes`
+- `GET /alarm-ultimate/alarm/:id/state`
+- `POST /alarm-ultimate/alarm/:id/command`
+- `GET /alarm-ultimate/alarm-json-mapper`
+- `GET /alarm-ultimate/alarm-panel`
+
+## Development
+
+Run tests:
+
+```bash
+npm test
+```

package/examples/README.md

@@ -0,0 +1,21 @@
+## Esempi
+
+Importa il flow da `examples/alarm-ultimate-basic.json` in Node-RED:
+
+1. Menu → **Import**
+2. Incolla il contenuto del file JSON
+3. Deploy
+
+Il flow include:
+
+- 1 nodo `AlarmSystemUltimate` con 2 zone di esempio
+- Inject per arm/disarm, bypass, sensori open/close
+- I nodi output-only (`Alarm State`, `Alarm Zone`, `Alarm Siren`) collegati a debug
+
+## Dashboard (node-red-dashboard)
+
+Importa `examples/alarm-ultimate-dashboard.json`.
+
+- Richiede `node-red-dashboard` installato (nodi `ui_*`).
+- Il widget usa un iframe verso `"/alarm-ultimate/alarm-panel?embed=1&id=<alarmNodeId>"`.
+- Se hai cambiato `httpAdminRoot`, aggiorna l'URL dell'iframe di conseguenza (es: `"/red/alarm-ultimate/alarm-panel?...`).