The AFA driver is a custom driver that is designed to talk to the Australian Fire Authority CAD system. This is a TCP binary protocol.
Driver file
The AFA dispatch driver's file is AfaDispatchProvider.dll.
Configuration file settings
appsettings.json has an object section called "AFA" that contains all configuration for this driver. Note that this has changed to be an array of routes, where each route is a complete configuration. This allows multiple connections to different authorities and routing is done by authority ID. The reverse command AUTHID supplies this routing information. The default configuration is shown below, and is fully documented in the file:
"AFA": {
// Routes must be an array (even if an array of one). Each authority that needs alarms dispatched
// represents a route.
"routes": [
{
// This is the Alarm-system ID of the authority for which this route will be used
"AuthorityId": "AUTH1",
// This is the primary address and port of the AFA/CAD system
"PrimaryRemoteAddress": "127.0.0.1:6000",
// This is the backup address and port of the AFA/CAD system
"BackupRemoteAddress": "127.0.0.1:6001",
// A routine poll message will be sent if no messages are exchanged for this number of minutes
"RoutinePollMinutes": 1,
// Specifies the state and brigade identifer for the station
"RegionId": 22, // 22 New South Wales Bush Fire Services
// Specifies that station's unique ID
"StationId": 1,
// This specifies which event code should be sent to the alarm system when AFA requests an
// alarm query. Default value is *AQ. The alarm ID will be the AFA Address ID.
"AlarmQueryEventCode": "*AQ",
// This maps incoming event codes, areas, and zones to alarm types and alarm states in AFA/CAD
// Each entry in the list represents a unique combination of event code, area, and zone
// Area and zone may each be set to indicate a wildcard (match any area or match any zone)
// If a signal from the alarm software doesn't match any entry in this list, an Alarm
// Type of 6900 will be used and an Alarm State of 0 will be used.
"EventCodeMap": [
{
"EventCode": "FA",
"Area": "*",
"Zone": "1",
"AlarmType": 6900,
"AlarmState": 0
},
{
"EventCode": "WA",
"Area": "*",
"Zone": "1",
"AlarmType": 8200,
"AlarmState": 0
},
{
"EventCode": "$N1",
"Area": "*",
"Zone": "11",
"AlarmType": 1100,
"AlarmState": 1
}
]
},
{
// This is the Alarm-system ID of the authority for which this route will be used
"AuthorityId": "AUTH2",
// This is the primary address and port of the AFA/CAD system
"PrimaryRemoteAddress": "127.0.0.1:6002",
// This is the backup address and port of the AFA/CAD system
"BackupRemoteAddress": "127.0.0.1:6003",
// A routine poll message will be sent if no messages are exchanged for this number of minutes
"RoutinePollMinutes": 1,
// Specifies the state and brigade identifer for the station
"RegionId": 22, // 22 New South Wales Bush Fire Services
// Specifies that station's unique ID
"StationId": 1,
// This specifies which event code should be sent to the alarm system when AFA requests an
// alarm query. Default value is *AQ. The alarm ID will be the AFA Address ID.
"AlarmQueryEventCode": "*AQ",
// This maps incoming event codes, areas, and zones to alarm types and alarm states in AFA/CAD
// Each entry in the list represents a unique combination of event code, area, and zone
// Area and zone may each be set to indicate a wildcard (match any area or match any zone)
// If a signal from the alarm software doesn't match any entry in this list, an Alarm
// Type of 6900 will be used and an Alarm State of 0 will be used.
"EventCodeMap": [
{
"EventCode": "FA",
"Area": "*",
"Zone": "1",
"AlarmType": 6900,
"AlarmState": 0
},
{
"EventCode": "WA",
"Area": "*",
"Zone": "1",
"AlarmType": 8200,
"AlarmState": 0
},
{
"EventCode": "$N1",
"Area": "*",
"Zone": "11",
"AlarmType": 1100,
"AlarmState": 1
}
]
}
]
}
Reverse commands
The AFA driver only supports the new alarm (ALRM) reverse command. The parameters for this command are listed below:
ALRM
| Field Type | Data Type | Label | DB Value | Default |
|---|---|---|---|---|
| Database | Text | AREA | Original Area | |
| Database | Text | ZONE | Original Zone | |
| Database | Text | TXID | Transmitter ID | |
| Database | Text | EVCODE | Event Code | |
| Database | Text | TIME | Event Time | |
| Database | Text | CUST | Customer Name | |
| Database | Text | ADDR | Full Address | |
| Database | Text | CITY | City Name | |
| Database | Text | POST | Post Code | |
| Database | Text | AUTHID | Contact Point | |
| User Provided | Text | PROVIDERID | AFA |
