IR WIKI

Integriti Comms Tasks Automation

3 min read

Integriti Comms Tasks Automation

Overview

Communications Tasks (Comms Tasks) in Integriti are automated actions triggered by specific conditions or schedules within the system. They are the primary mechanism for the controller to communicate with the outside world, sending notifications or integrating with third-party systems like a Building Management System (BMS).

Technical Details

While Integriti supports various Comms Task types (such as Email, SMS, and HTTP/XML for notifications and web services), the Automation Communications Task provides a specialized, structured protocol over Serial UART or Ethernet (TCP) used specifically for control and interrogation by third-party systems (e.g., HVAC or lighting control).

Trigger Conditions

Comms Tasks can generally be initiated by:

  • Alarm Conditions: e.g., a zone going into alarm, an area being breached.
  • Access Events: e.g., a specific user badging at a door.
  • Schedules: e.g., a time period becoming active to send a daily report or trigger a routine action.

Automation Licensing

  • No License: Allows streaming and acknowledging review events only.
  • Automation Communications License (996022): Enables multiple task instances, entity control (e.g., locking doors, turning on auxiliaries), and querying entity states.
  • Advanced Automation Communications License (996026): Allows virtual module auxiliaries to send state changes and allows 3rd-party systems to send log messages to the controller.

Configuration / Programming

To program an Automation Comms Task for BMS integration:

  1. Navigate to the System tab, then Comms Tasks.
  2. Click Add New and select the type Automation.
  3. Configure the Connectivity:
    • UART: Select the serial port, baud rate, data bits, parity, etc.
    • Ethernet: Enter the Server IP Address or hostname, TCP port, and set TCP Mode to Slave (3rd party connects to Integriti) or Master (Integriti connects to 3rd party).
  4. Configure Output Options: Set Header Format (e.g., Tstamp, DateTime) and Body Format (e.g., Raw, Full Text).
  5. Set Review Filtering: Filter events sent to the BMS by Comms Task Groups, Level, or specific Entities (e.g., only send Door events).
  6. Start the task.

Automation Protocol Commands

Commands are case-sensitive and ignored until a {STart} packet is received.

  • Set State: Control entities.
    • {AX[C01:X01]=N} (Turn Auxiliary On - useful for lighting)
    • {DR[001]=U} (Unlock Door)
    • {AR[001]=N} (Turn Area On)
  • Get State: Query entities.
    • {AX[C01:X01]?} (Get Auxiliary State)
    • {IN[C01:Z14]?} (Get Input State)

Troubleshooting

  • Error Codes: The controller will respond with error codes if a command fails, such as {!01} (Error performing action), {!02} (Error with syntax), or {!04} (Permission denied).
  • Connection Issues: Use heartbeat commands like {HB=012} (set poll time to 12s) and {HB} (send heartbeat) to test and maintain TCP connectivity. If the poll time expires, the configured Online Input is put into alarm.

Graph View

Backlinks