docs: native alarm ingestion across component docs + CLAUDE.md
This commit is contained in:
@@ -73,6 +73,9 @@ scadabridge template script update --id <id> [--name <name>] [--code <code>] [--
|
||||
scadabridge template script delete --id <id>
|
||||
scadabridge template composition add --template-id <id> --instance-name <name> --composed-template-id <id>
|
||||
scadabridge template composition delete --template-id <id> --instance-name <name>
|
||||
scadabridge template native-alarm-source add --template-id <id> --name <name> --connection <name> --source-ref <ref> [--filter <expr>] [--description <desc>] [--locked]
|
||||
scadabridge template native-alarm-source list --template-id <id>
|
||||
scadabridge template native-alarm-source remove --id <id>
|
||||
```
|
||||
|
||||
### Instance Commands
|
||||
@@ -85,6 +88,8 @@ scadabridge instance set-overrides --id <id> --overrides <json>
|
||||
scadabridge instance alarm-override set --instance-id <id> --alarm <name> [--trigger-config <json>] [--priority <n>]
|
||||
scadabridge instance alarm-override delete --instance-id <id> --alarm <name>
|
||||
scadabridge instance alarm-override list --instance-id <id>
|
||||
scadabridge instance native-alarm-source set --instance-id <id> --source <name> [--connection <name>] [--source-ref <ref>] [--filter <expr>]
|
||||
scadabridge instance native-alarm-source clear --instance-id <id> --source <name>
|
||||
scadabridge instance set-area --id <id> [--area-id <id>]
|
||||
scadabridge instance diff --id <id>
|
||||
scadabridge instance deploy --id <id>
|
||||
@@ -97,6 +102,44 @@ scadabridge instance delete --id <id>
|
||||
`[["Speed", 5], ["Mode", 7]]`. `--overrides` is a JSON object of attribute name to
|
||||
value, e.g. `{"Speed": "100", "Mode": null}`.
|
||||
|
||||
### Native Alarm Source Commands
|
||||
|
||||
The `native-alarm-source` subcommands manage the **read-only native alarm mirror** —
|
||||
alarms surfaced from an alarm-capable data connection rather than evaluated by the
|
||||
ScadaBridge alarm engine. Native alarm sources are declared on a template and may be
|
||||
overridden per instance. The subcommands map to management commands that resolve via
|
||||
`ManagementCommandRegistry`:
|
||||
|
||||
- `--connection` names an alarm-capable data connection (**OPC UA** or **MxGateway**).
|
||||
- `--source-ref` is the connection-specific reference: an **OPC UA `SourceNode` nodeId**
|
||||
or an **MxAccess object/area**.
|
||||
- `--filter` is an optional connection-specific filter expression that narrows the
|
||||
mirrored alarm set.
|
||||
|
||||
**Template-level** (defines the inherited native alarm sources):
|
||||
|
||||
| CLI command | Management command | Required role |
|
||||
|-------------|--------------------|---------------|
|
||||
| `template native-alarm-source add` | `AddTemplateNativeAlarmSourceCommand` | Design |
|
||||
| `template native-alarm-source list` | `ListTemplateNativeAlarmSourcesCommand` | — |
|
||||
| `template native-alarm-source remove` | `DeleteTemplateNativeAlarmSourceCommand` | Design |
|
||||
|
||||
`add` takes `--name`, `--connection`, and `--source-ref` (required), plus optional
|
||||
`--filter`, `--description`, and `--locked` (a flag that prevents instance-level
|
||||
override). `remove` targets a single native alarm source by its own `--id`.
|
||||
|
||||
**Instance-level** (per-instance overrides of an inherited source; upsert semantics):
|
||||
|
||||
| CLI command | Management command | Required role |
|
||||
|-------------|--------------------|---------------|
|
||||
| `instance native-alarm-source set` | `SetInstanceNativeAlarmSourceOverrideCommand` | Deployment |
|
||||
| `instance native-alarm-source clear` | `DeleteInstanceNativeAlarmSourceOverrideCommand` | Deployment |
|
||||
|
||||
`set` is an **upsert** keyed by `--instance-id` and `--source` (the inherited source
|
||||
name): a blank/omitted `--connection`, `--source-ref`, or `--filter` keeps the
|
||||
inherited value, so only the supplied options are overridden. `clear` removes the
|
||||
override and **reverts the instance to the inherited template value**.
|
||||
|
||||
### Site Commands
|
||||
```
|
||||
scadabridge site list
|
||||
|
||||
Reference in New Issue
Block a user