Contact Sales User Login
Plugin Reference Manuals

Plugins Documentation

Browse configuration schemas, route definitions, and integration guides for all official Uniflow dynamic plugins.

SIA Receiver

SIA Receiver

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

SIA Receiver Plugin Reference Manual

1. Overview

Plugin Name: SIA Receiver

Type: Security Integration

Identifier: uniflow.plugin.siareceiver

Description

Receive events from SIA DC-09 alarm panels.

2. Technical Architecture

The SIA Receiver plugin acts as an active SIA DC-09 receiver server listening on TCP or UDP socket ports. It listens for incoming alarm panel transmission frames, performs optional AES-128/192/256 decryption, validates account block headers, parses standard SIA event codes (e.g. Burglar Alarm, Fire Alarm, Panic, Open/Close), responds with protocol ACK frames, and emits real-time event objects into the catalog.

System Interaction & Exposed Catalog Routes

The SIA Receiver plugin acts as a TCP/UDP socket listener for SIA DC-09 security alarm signals. It decodes incoming SIA frames, decrypts AES payloads, returns ACK/NACK responses, and exposes account event codes into Uniflow.

Catalog Routes & Node Integration

Input Event Triggers (Input Nodes):

  • sia.alarm_signal_received - Emitted when a valid SIA alarm code is received.
  • sia.supervision_received - Supervision heartbeat from remote panel.
  • sia.decoding_error - Payload decryption or syntax error event.

    • Executable Actions (Action Nodes):

  • sia.send_nack - Manually issues NACK response.
  • sia.update_account_status - Configures account supervision state.
  • sia.reset_listener - Restarts TCP/UDP listener socket.

    • 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
    Listening PortNumeric value specifying the listening port.
    ProtocolSpecifies the protocol.
    Encryption AlgorithmSpecifies the encryption algorithm.
    Encryption KeySpecifies the encryption key.

    4. Exposed Routes & Data Types

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

    Event Input

    The Event Input node listens for real-time SIA DC-09 alarm panel transmission events.

    Human-Readable Field NameData TypeExposed Event Fields & Data TypesDescription
    SIA Alarm Event  Event Object
    ↳
    Account (String)
    EventCode (String)
    Qualifier (Int32)
    Zone (Int32)
    Text (String)
    Timestamp (DateTime)
    		Real-time event triggered whenever a SIA DC-09 alarm transmission is received from an authorized panel.

    5. Usage Examples

    Scenario A: SIA DC-09 Burglar Alarm Code (BA) Triggers Avigilon Alarm & Camera Move

    Workflow Overview:

    When an intruding security alarm panel transmits a SIA DC-09 alarm packet containing event code BA (Burglar Alarm) for account ACC-8812 (Account == "ACC-8812" & EventCode == "BA"), Uniflow validates the payload decryption and triggers a high-priority alarm (AlarmId: 401-SIA-BURGLAR) in Avigilon Control Center while moving the ONVIF PTZ camera to focus on Zone 3.

    Rule Node Configuration:

    1. Event Input Node: SIA Receiver Listener

  • Filter Event: SIA Alarm Event (sia.alarm_signal_received)
  • Exposed Schema Fields: Account (String), EventCode (String), Zone (Int32), Text (String), Timestamp (DateTime)

    • 2. Logic Filter Node: And Condition

  • Expression: Account == "ACC-8812" AND EventCode == "BA"

    • 3. Output Target Node: Avigilon ACC Action

  • Action Target: Alarms (avigilon:alarm)
  • AlarmId: 401-SIA-BURGLAR
  • Action: TRIGGER
  • Notes: SIA DC-09 Burglar Alarm Code BA received for Zone 3

    • Logic Flow Diagram:

    VISUAL ARCHITECTURE FLOW DIAGRAM
    Rendering Flow Architecture Diagram...

    Scenario B: SIA Fire Alarm Code (FA) Triggers Emergency Email Dispatch & Evacuation Siren Relay

    Workflow Overview:

    When a SIA panel sends a Fire Alarm transmission (EventCode == "FA"), Uniflow immediately fires two parallel emergency actions:

    1. Dispatches an emergency HTML alert email with zone details to facility managers.

    2. Writes a Modbus TCP coil output (Coil_12 = True) to activate physical evacuation sirens and strobe lights.

    Rule Node Configuration:

    1. Event Input Node: SIA Receiver Listener

  • Filter Event: SIA Alarm Event (sia.alarm_signal_received)
  • Exposed Schema Fields: Account (String), EventCode (String), Zone (Int32), Text (String), Timestamp (DateTime)

    • 2. Logic Filter Node: Equal Condition

  • Expression: EventCode == "FA"

    • 3. Output Target Node A: Email Client Action

  • Action Target: Send Email
  • To: safety-team@facility.com
  • Subject: CRITICAL FIRE ALARM - SIA Code FA

    • 4. Output Target Node B: Modbus TCP Action

  • Action Target: Write Single Coil
  • Coil: 12
  • Value: True

    • Logic Flow Diagram:

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