SCAIP
The SCAIP service - receives care and social alarms over SIP and can open a two-way voice call back to the alarm unit.
SCAIP
SCAIP is a protocol for care and social alarms - the kind raised by a personal alarm or a care or lift unit. The SCAIP service receives these alarms over SIP, turns them into signals for SBN, and for the alarm types you choose can open a two-way voice call back to the unit so an operator can speak with the person.
Overview
SCAIP alarms arrive over SIP, as SIP messages, through the SIP Server. The SCAIP service decodes each one, delivers it to SBN as a signal through the SBN Frontend, and replies to the sender.
For certain alarm types - the ones you list as needing media - SBN can open a voice channel and call back to a configured address, so the operator can talk to and listen to the person at the unit. This is the care-alarm "open the microphone and call back" behaviour. The service is two-way: it receives the alarms and sends the responses and the call-back to the unit.
- Runs: When configured. Required to receive SCAIP care alarms.
- Required: Only if you receive SCAIP alarms.
- Depends on: NATS, the SIP Server (SCAIP arrives over SIP), the SBN Frontend (to deliver the signal to SBN), and - for the two-way voice - a SIP or GSM trunk to call the unit back on.
Configuration
SCAIP is configured under alarmreceiver.scaip - the SCAIP settings live with the alarm receiver configuration, not in a separate section. View the defaults with ./sbn-media config eject and set overrides in sbn-media.local.yaml.
Setting | Default | Description |
|---|---|---|
| (none) | The SBN dealer account the alarms belong to. Required. Also used as the account a sender's alarms go to when the sender has none of its own. |
| (none) | A prefix added to the unit's ID to form the account number (for example |
|
| The SCAIP status codes that should open a voice call. Only alarms with these codes get two-way voice. |
| 1 | How the voice channel opens: |
| 62 | How the call back is placed: |
| (none) | Where to place the call back, as a list - for example |
| 20 | How long to wait before resending if the unit asks to hold. |
| (none) | Per-sender overrides, keyed by the sender's address (see Handling several senders below). |
After changing these settings in sbn-media.local.yaml, apply them with ./sbn-media config reload.
Two-way voice
When an alarm whose status is listed in statusWithMedia arrives, SBN opens a voice channel of the type set by mediaReply (two-way by default) and calls back according to callbackResponse - either the unit's programmed number (61) or the addresses in callbackAddresses (62, the default). The operator can then speak with the person who raised the alarm. If you use the default (62) and leave callbackAddresses empty, the call back cannot be placed - set callbackAddresses.
Handling several senders
sourceOverride lets you treat alarms from different senders differently, keyed by the sender's SIP address. For each sender you can set its own tenant, callbackAddresses, callbackResponse, and mediaReply. The tenant decides which SBN account the alarms belong to; if a sender has no tenant set, the dealer is used, and failing that the system default.
Security
SCAIP messages are not authenticated by the protocol itself, so restrict which senders can reach the SIP Server with your network firewall, and use encrypted SIP (the sips or wss ports, with a certificate) for sensitive traffic.
FAQ
How do I make an alarm open a two-way voice call?
List its SCAIP status code in statusWithMedia, set mediaReply to the voice type you want (1 for two-way), and set callbackAddresses - or use callbackResponse: 61 to call the unit's programmed number instead.
The call back is not happening.
Check that the alarm's status is in statusWithMedia, that callbackResponse and callbackAddresses are set (with the default 62, callbackAddresses must not be empty), and that the SIP or GSM trunk used for the call back is working.
How do I keep alarms from different customers separate?
Use sourceOverride to give each sender its own tenant, so its alarms go to the right SBN account.
Where is SCAIP configured?
Under alarmreceiver.scaip, together with the alarm receiver settings - there is no separate scaip section.
Related pages
- SBN Media Overview (
SBN-Media/overview) - Installing and Configuring SBN Media (
SBN-Media/installation) - SIP Server (
SBN-Media/Telephony/sip-server) - Alarm Receiver (
SBN-Media/Alarms/alarm-receiver) - Alarm Protocols (
SBN-Media/Configuration/protocols) - SBN Frontend (
SBN-Media/Platform/sbn-frontend)