Fire Alarm

This example connects an existing in-game fire alarm resource to CAD. Dispatchers can see normal, active, and faulted controllers without entering the game. When an alarm activates in-game, the resource publishes the new state so the CAD card pulses red and plays an alert sound. A dispatcher can also use the panel toggle to change the alarm state in-game. Fire Alarm custom integration panel

How It Connects

Install or update the panel definition when the resource is configured.
On resource start, read every alarm controller and publish the complete panel state.
When an alarm changes in-game, publish the new state. Connected CAD clients update immediately.
Receive pushes for alarm.set-active actions. Apply each action through the alarm resource, acknowledge it, then publish the authoritative state again.

Game-Side Outline

Push is the primary delivery path. The scheduling and processPanelActionOnce functions below are pseudocode supplied by your integration; they are not SDK helpers. processPanelActionOnce records the completed result, acknowledges it, retries failed acknowledgements without repeating the effect, and returns true only after acknowledgement succeeds. Use one serial queue for both paths and keep the backup polling cursor separate from pushed actions. See Action Push Events for routing, deduplication, acknowledgement, and recovery rules. The following is server-side pseudocode. Adapt the events and function names to your alarm resource and preferred API library.

-- Install the definition once, then publish the current in-game state.
onResourceStart(function()
  setIntegrationPanel("example.fire-alarms", definition)
  publishPanelState(readAllAlarmControllers())
end)

-- In-game changes are pushed to every connected CAD user.
onAlarmStateChanged(function()
  publishPanelState(readAllAlarmControllers())
end)

-- Shared serialized processing; the helper deduplicates in-flight/completed IDs,
-- retries acknowledgements without repeating effects, and rejects expired actions.
local function processAction(event)
  return processPanelActionOnce(event, function()
    local success = fireAlarmResource.setActive(
      event.values.alarmId,
      event.values.active
    )

    if success then publishPanelState(readAllAlarmControllers()) end
    return success
  end)
end

AddEventHandler("SonoranCAD::pushevents:OtherEvent", function(eventType, event)
  if eventType == "EVENT_PANEL_EXAMPLE.FIRE-ALARMS" then
    processAction(event)
  end
end)

-- Backup only. Share three requests/minute across all panels and servers.
every20Seconds(function()
  local response = pollPanelActions({ after = cursor })
  for _, event in ipairs(response.events) do
    if not processAction(event) then return end
  end
  cursor = response.nextCursor -- Only after every polled action is acknowledged.
end)

See Set State, Poll Actions, and Acknowledge Action for copyable calls in every supported library.

Actions

Action ID	Purpose
`alarm.set-active`	Toggle one alarm on or off.

Definition JSON

Open the raw definition

Copy the complete definition

{
  "schemaVersion": 1,
  "key": "example.fire-alarms",
  "name": "Fire Alarm",
  "icon": "fas fa-bell",
  "surfaces": ["dispatch", "fire", "ems", "police"],
  "sounds": [
    {
      "id": "alarm-active",
      "url": "https://s3.sonorancad.com/default/examples/demos/fire-alarm-demo.mp3",
      "volume": 0.7,
      "maxDurationMs": 8000,
      "trigger": {
        "event": "state",
        "path": "summary.active",
        "operator": "increased"
      }
    }
  ],
  "body": [
    {
      "type": "row",
      "gap": "sm",
      "children": [
        { "type": "badge", "label": "Active: {{state.summary.active}}", "appearance": "primary" },
        { "type": "badge", "label": "Normal: {{state.summary.normal}}", "appearance": "positive" },
        { "type": "badge", "label": "Fault: {{state.summary.fault}}", "appearance": "warning" }
      ]
    },
    {
      "type": "repeat",
      "source": "$state.alarms",
      "emptyText": "No alarms reported",
      "layout": "grid",
      "minItemWidth": 260,
      "gap": "sm",
      "search": {
        "placeholder": "Search alarms",
        "fields": ["name", "location", "status"]
      },
      "sort": {
        "label": "Order",
        "default": "active",
        "options": [
          {
            "label": "Active first",
            "value": "active",
            "rules": [
              { "path": "active", "direction": "desc" },
              { "path": "name", "direction": "asc" }
            ]
          },
          {
            "label": "Name A-Z",
            "value": "name",
            "rules": [{ "path": "name", "direction": "asc" }]
          },
          {
            "label": "Status",
            "value": "status",
            "rules": [
              { "path": "status", "order": ["ACTIVE", "FAULT", "NORMAL"] },
              { "path": "name", "direction": "asc" }
            ]
          }
        ]
      },
      "children": [
        {
          "type": "section",
          "animation": "$item.animation",
          "style": {
            "borderColor": "$item.color",
            "borderStyle": "solid",
            "borderWidth": "1px",
            "borderRadius": "6px",
            "minHeight": "132px"
          },
          "children": [
            {
              "type": "row",
              "align": "center",
              "children": [
                { "type": "icon", "icon": "fas fa-fire", "color": "$item.color" },
                { "type": "text", "text": "$item.name", "variant": "title", "grow": true },
                { "type": "badge", "label": "$item.status", "appearance": "$item.appearance" }
              ]
            },
            { "type": "text", "text": "$item.location", "appearance": "muted" },
            {
              "type": "toggle",
              "id": "alarm-active",
              "label": "Alarm active",
              "value": "$item.active",
              "color": "$item.color",
              "action": {
                "id": "alarm.set-active",
                "values": { "alarmId": "$item.id", "active": "$value" }
              }
            }
          ]
        }
      ]
    }
  ]
}

Example State

Open the raw state

Copy the example state

{
  "summary": { "active": 1, "normal": 1, "fault": 1 },
  "alarms": [
    {
      "id": "mrpd-lobby",
      "name": "MRPD Lobby",
      "location": "Mission Row",
      "status": "ACTIVE",
      "appearance": "primary",
      "color": "primary",
      "animation": "pulse-negative",
      "active": true
    },
    {
      "id": "sandy-24",
      "name": "Station 24",
      "location": "Sandy Shores",
      "status": "NORMAL",
      "appearance": "positive",
      "color": "positive",
      "active": false
    },
    {
      "id": "pillbox",
      "name": "Pillbox Medical",
      "location": "Los Santos",
      "status": "FAULT",
      "appearance": "warning",
      "color": "amber",
      "active": false
    }
  ]
}

Start here

Tutorials

Integration Capabilities

Pricing

Roadmap

Other

How It Connects

Game-Side Outline

Actions

Definition JSON

Example State

​How It Connects

​Game-Side Outline

​Actions

​Definition JSON

​Example State

How It Connects

Game-Side Outline

Actions

Definition JSON

Example State