SIA Agent

SIA Agent

ID: uniflow.plugin.siaagent Category: Security Integration & Communication Protocols Version: v1.3.0 Min Uniflow Version: Uniflow ≥ v1.4.0

SIA Agent Plugin Reference Manual

1. Overview

Plugin Name: SIA Agent

Type: Security Integration

Identifier: uniflow.plugin.siaagent

Description

Transmit events to SIA DC-09 receivers.


2. Technical Architecture

The SIA Agent plugin acts as a SIA DC-09 Digital Communication Standard transmitter over UDP or TCP socket transport. It formats security events (Account Number, SIA Event Code, Area/Zone, Qualifier, Text), handles optional AES-128/192/256 payload encryption, manages a deduplicated transmission retry queue, and waits for receiver ACK/NACK responses.

System Interaction & Exposed Catalog Routes

The SIA Agent plugin transmits security alarm events to Central Monitoring Stations (CMS) using SIA DC-09 protocol over TCP/UDP. It formats SIA tokens (e.g. BA Burglary Alarm, FA Fire Alarm), encrypts payloads with AES-128/256, and handles CMS acknowledgment signals.

Catalog Routes & Node Integration

Input Event Triggers (Input Nodes):

  • sia.ack_received - Emitted when CMS acknowledges alarm transmission.
  • sia.transmission_failed - Emitted on transmission timeout or NACK.
  • sia.heartbeat_sent - Periodic supervision heartbeat event.
  • Executable Actions (Action Nodes):

  • sia.send_alarm_event - Formats and transmits a SIA DC-09 alarm packet.
  • sia.send_restoration_code - Sends a SIA event restoration signal.
  • sia.send_heartbeat - Manually dispatches a supervision heartbeat.
  • Architecture Diagram

    VISUAL ARCHITECTURE FLOW DIAGRAM
    Rendering Flow Architecture Diagram...

    3. Configuration Parameters

    The following configuration fields are available in the User Interface for this plugin:

    Configuration SettingDescription
    Receiver Host / IPSpecifies the receiver host / ip.
    Receiver PortNumeric value specifying the receiver port.
    Transport ProtocolNumeric value specifying the transport protocol.
    Connection ModeSpecifies the connection mode.
    AlgorithmSpecifies the algorithm.
    Encryption Key (AES)Specifies the encryption key (aes).
    Queue LimitSpecifies the queue limit.
    Retry Delay (ms)Specifies the retry delay (ms).
    Timeout (ms)Numeric value specifying the timeout (ms).

    4. Exposed Routes & Data Types

    This plugin exposes catalog fields across the following rule graph nodes:

    Input Source

    The Input Source node reads transmission queue telemetry metrics exposed by this plugin.

    Human-Readable Field NameData TypeDescription
    Queue Count  Int32
    Current number of SIA DC-09 alarm event messages awaiting transmission or retry ACK response.

    Data Source

    The Data Source node queries standard SIA event code definitions.

    Human-Readable Collection NameData TypeExposed Fields & Data TypesDescription
    SIA Event Codes  Json` (`collection`)
    Code (String)
    Description (String)
    Standardized SIA DC-09 event code reference list (e.g. BA Burglar Alarm, FA Fire Alarm, PA Panic Alarm).

    Output Target

    The Output Target node acts as an action sink node to construct and dispatch SIA DC-09 alarm messages to remote receivers.

    Target NameData TypeAssociated ParametersParameter Data TypeRequiredDescription
    SIA Message  Json
    Account (ItemAccount)StringFalseSubscriber account identifier for receiver verification.
    Event Code (ItemEventCode)StringFalseTwo-character SIA standard event code (e.g. BA, FA, OP, CL).
    Qualifier (ItemQualifier)Int32FalseEvent qualifier index (1 New Alarm, 3 Restore).
    Zone (ItemZone)Int32FalseAlarm zone or sensor loop number.
    Text (ItemText)StringFalseDescriptive text string appended to event block payload.

    5. Usage Examples

    Scenario A: Modbus Enclosure Tamper Input Transmits SIA Code TA to Central Station

    Workflow Overview:

    When an outdoor security enclosure tamper switch trips a Modbus digital input (DiscreteInput[103] == True), Uniflow constructs an encrypted SIA DC-09 alarm transmission (sia.send_alarm_event) with event code TA (Tamper Alarm) for account ACC-5001 and sends it via TCP to the Central Monitoring Station (CMS).

    Rule Node Configuration:

    1. Input Source Node: Modbus TCP Field I/O

  • Point / Field: DiscreteInput_103 (Boolean)
  • 2. Logic Condition Node: IsTrue

  • Evaluation: DiscreteInput_103 == True
  • 3. Output Target Node: SIA Agent Transmitter

  • Action Target: SIA Message (sia.send_alarm_event)
  • Account: ACC-5001
  • Event Code: TA
  • Qualifier: 1 (New Event)
  • Zone: 103
  • Text: Enclosure Tamper Switch Tripped
  • Logic Flow Diagram:

    VISUAL ARCHITECTURE FLOW DIAGRAM
    Rendering Flow Architecture Diagram...

    Scenario B: OPC UA Overtemperature Threshold Transmits SIA Fire Trouble Code (FT)

    Workflow Overview:

    When an OPC UA industrial server reports a server room temperature exceeding 45°C (Temperature > 45.0), Uniflow formats a SIA Trouble Code FT (Fire Trouble) and transmits it to the monitoring center while logging queue transmission status.

    Rule Node Configuration:

    1. Input Source Node: OPC UA Client

  • Node Identifier: ns=2;s=ServerRoom.Temperature (Double)
  • 2. Logic Filter Node: GreaterThan

  • Expression: Temperature > 45.0
  • 3. Output Target Node: SIA Agent Transmitter

  • Action Target: SIA Message (sia.send_alarm_event)
  • Account: ACC-5001
  • Event Code: FT
  • Qualifier: 1
  • Zone: 5
  • Text: Server Room High Temp Alert > 45C
  • Logic Flow Diagram:

    VISUAL ARCHITECTURE FLOW DIAGRAM
    Rendering Flow Architecture Diagram...
    Architecture Flow Diagram — Full Preview