3 WebRTC Intercom

SAFR WebRTC implementation supports making a call from SCAN to SAFR Mobile Android App or calling the device from SAFR Mobile Android application to SAFR SCAN. An AWS account is required in order to broker connections between the SCAN device and SAFR Android Mobile client. SAFR support 1-way video (SCAN->Phone) and 2-way audio. When Intercom is enabled, you will see a call button on SAFR SCAN screen. If Intercom is offline, the call button will appear with a line through it. When active, the button can be pressed to initiate a call.

This section describes how to set up SAFR for WebRTC Intercom.

3.1 System requirements

• SAFR SCAN SC100, SC200 or SC50 models
• SAFR SCAN Firmware version 1.16 or later
• SAFR Recognition App for Android version 3.16 or later
• AWS Account with Amazon Kinesis enabled

SAFR Recognition App for Android must be connected to SAFR Server to initiate intercom session with SAFR SCAN.

SAFR Intercom requires that both SAFR SCAN and the Android phone running the SAFR Operator App can establish a connection out to AWS and require an AWS Account set up by the administrator. This document provides some guidance on setting up SAFR Intercom.

3.1.1 Not Supported

• SAFR iOS App or SAFR Desktop cannot make or receive SAFR Intercom calls
• SAFR Android app alerting is only via SMS message. Alert will not appear as an inbound phone call.

3.2 Setup AWS Account

Kinesis video streaming is required to enable SAFR SCAN WebRTC Intercom. SMS Notifications enable you to send a notification to an operator to initiate the intercom call.

See Article Create AWS Account at http://docs.real.com or http://support.real.com for information on setting up AWS Account.

3.3 Configure WebRTC Intercom

You can configure Intercom settings on SCAN either in SAFR SCAN Web Console (if running SCAN in standalone mode) or Video Feeds window of SAFR Desktop (If SAFR SCAN is connected to SAFR Server).

3.3.1 Enable WebRTC Intercom on SAFR SCAN

On SAFR SCAN Web Console or SAFR Desktop

1. Go to Operation Settings
   1. Web Console: Operation > Intercom
   2. SAFR Desktop: Video Feeds > “…” menu for desired SCAN > Operation Settings > Intercom

2. Select WebRTC via AWS KVC from the Protocol dropdown list. The dialog will show the following options.
   
3. Set the following settings
   1. AWS Region Code (In desktop app click “i’ to select a region near you. In Web Console see Amazon Kinesis Data Streams endpoints and quotas <https://docs.aws.amazon.com/general/latest/gr/ak.html> for a list of regions.)
   2. AWS Account Access Key and Secret Key you recorded during AWS IAM User setup above.
   3. AWS Channel Name (must be unique within your AWS Account)

To enable the operator to receive a notification when the call button is pressed, a notification must be set up. See Notifications below for details.

Below table describes the settings.

Setting name	Default value	Description
AWS Region Code	None (req’d)	AWS hosting region where connections are made. Pick a region close to your location. In desktop app click “i’ to select a region near you. In Web Console see Amazon Kinesis Data Streams endpoints and quotas <https://docs.aws.amazon.com/general/latest/gr/ak.html> for a list of regions.
AWS Account	Req’d	The AWS Account Access Key and AWS Account Secret Key for the IAM User you gave permissions for above. Be careful to avoid pasting spaces onto the beginning or end of the strings.
AWS Channel Name	Req’d	A unique string associated with the SCAN device. SCAN will create a channel in AWS using this name. It must be unique within the AWS Account SCAN is connected to. SAFR SCAN will create an AWS Signaling Channel configuration using this value as the channel name. You will see this Signaling Channel on your AWS Account. This channel name should not be used by any other devices, and you should not use the AWS Webcam demo to test this signaling channel as this will “steal” the signaling channel from the SCAN device. If this occurs, disable, and re-enable the SAFR SCAN Intercom setting in order to re-acquire the AWS Signaling Channel for this SCAN device.
Video	Enabled	Option to disable video. Video takes about 1 Mbps from SCAN to operator. With WebRTC, video is routed directly between SCAN and the SAFR Mobile app on Android if possible. Otherwise, the AWS Kinesis account will be used to proxy the video. AWS Vide data transfer and video charges may apply – see AWS Costs above.
Call button action	Disabled	Options: Disabled, Call Operator, Call Mobile Phone. Call Operator: Generates Call Requested event which can be used to initiate the call from SAFR Events Window. You can also use SAFR’s SMS Alarms dashboard to configure notifications to multiple operators. See Notifications section below Call Mobile Phone: Specify a mobile phone number (including country code with “+” prefix) in the Mobile phone number field. When provided, SCAN will send an SMS message to the indicated number when the call button is enabled. Requires that SMS be configured for your SAFR Server.

3.3.2 Configure Intercom on SAFR Android Client

1. Open SAFR Mobile App for Android
2. Click hamburger menu in upper left (three horizontal lines)
3. Click App Settings
4. Click Intercom
5. Complete the following dialog:

Required fields:

• Access Id and Access Key – the AWS IAM User credentials. See above.
• Region – AWS Region. Use the same AWS Region you used above.

Signaling Channel field is only required to test Intercom. Enter the AWS Channel Name from the SAFR SCAN device you wish to test with. Under normal operation, Android client will get the signaling channel during session initiation and thus can operate with any SCAN device.

Press back button to save settings.

3.3.3 Connecting SAFR Mobile for Android to SAFR Server

SAFR SCAN WebRTC Intercom requires SAFR Mobile App for Android be connected to SAFR Server to make or receive calls.

See SAFR Documentation for how to connect SAFR Mobile App for Android to SAFR Server. A quick summary is:

• Log out of android client if you are already logged in.
• Use the “Gear” button to choose “SAFR Custom” connection option.
• Complete the URLs for server. Use following ports:
  • COVI:https://IPADDRESS:8081
  • Event:https://IPADDRESS:8083
  • Object:https://IPADDRESS:8085
  • Virga: https://IPADDRESS:8087

3.3.4 Verify WebRTC Intercom

Use Event Sources page to see if Intercom is enabled and working. Each SCAN device is listed as an event source. SCAN devices that have Intercom enabled appear with a phone icon. The status of the phone icon will indicate the state of the device (active, in-call, ringing or error state).

Following shows view from Event sources on Android and iOS. iOS Intercom sources are view only – intercom sessions cannot be established from SAFR Mobile for iOS at this time.

Android	iOS

Following shows a single Event source for Android and iOS. iOS only allows viewing of the video – 2-way audio is not supported.

Android	iOS

3.4 Initiating WebRTC connection

You can initiate a SAFR WebRTC Intercom session in 2 ways:

• Event Sources: Initiate a call to SCAN from Event Sources
• SMS Notification: Accept calls from SCAN from SMS Notification

Both options require SAFR Mobile App for Android be connected to SAFR Server. See instructions below.

3.5 Initiating calls through SAFR Mobile App for Android

You can make calls from the Android phone to SAFR SCAN. This is done through SAFR Mobile App Event Sources. This requires that SAFR Mobile App for Android be connected to SAFR Server and configured with the AWS Kinesis account as described above.

3.5.1 Making calls from SAFR Mobile App for Android

1. Go to Event Sources from the upper left menu in SAFR Mobile App for Android.
2. Find the SAFR SCAN device you wish to connect to. Ensure that it has a green phone icon indicating Intercom is enabled.
   
   If intercom is not working, you will see an error status like the following:
   
3. Click on the entry in the Video Feeds list.
4. Click on the “Open Intercom” button.
5. SAFR SCAN will run 4 times and then disconnect. The call can be initiated to the device even after ringing stops.

When in the call, you can take the following actions:

• End Call – Closes connection to SAFR SCAN
• Issue Temporary Unlock – SCAN will show Access Granted and if configured, send Temporary Unlock Credentials to the panel.
• Mute Audio – Mutes audio from Android client.

3.6 Accepting calls through SMS Notifications

SMS messages are used to notify one or more operators of an inbound call from SAFR SCAN. The process works as. Follows:

1. SAFR SCAN will generate a “Intercom Call Requested” Event
2. SAFR will generate an SMS Message to one or more phone numbers (configurable routing)
3. Operator clicks the SMS message to launch SAFR Mobile App for Android
4. Operator is presented with an “Intercom call requested” page showing photo from SAFR SCAN camera.
5. Operator can click a button to initiate the call.
6. SAFR SCAN will run 4 times and then disconnect. The call can be initiated to the device even after ringing stops.

3.6.1 Configuring SMS Notifications

Following steps describe how to set up SMS Notifications in SAFR to notify one or more operators to initiate a SAFR WebRTC Intercom session.

3.6.1.1 Enable SMS Notifications Service

To initiate intercom via SMS you will first need to enable SMS for SAFR Server. With SAFR Cloud accounts, you can do this by simply choosing “SARF Cloud” as the SMS provider. To set up SMS on SAFR On-premises server, you must setup an AWS Account and enable SMS as described above in “Setup AWS Account”. Once the AWS Account is created, use the IAM User credentials to configure SMS for SAFR Server as follows:

1. Open System Configuration page as. Follows:
   1. SAFR Desktop: Tools Menu > System Configuration
   2. SAFR Server Web Console: Go to Status page
2. Scroll down to “Enable Notifications Services”
3. Click on “Set up SMS”
4. Complete the following dialog using AWS IAM Credentials.

• Amazon SNS Sender ID is any random string you choose
• You can find a list of SNS Regions here: SMS Supported Regions and Countries < https://docs.aws.amazon.com/sns/latest/dg/sns-supported-regions-countries.html>
  • Pick on that is closes to your server.
• Enter a phone number for testing. Be sure to add “+” in front and the country code.

3.6.1.2 Create one or more SMS Alarms

Once SMS is enabled, you can create one or more SMS Alarms in SAFR as follows:

1. Go to SAFR Reports page
   1. SAFR Server Web Console: Click on “Reports” Tab
   2. In SAFR Desktop: Go to Tools menu > “Create New Report…”
2. Click “Add New Alarm”
3. Chose “Intercom” as the type
4. Complete other settings for the Alarm.
5. For phone number, make sure to include the “+” prefix and country code.

You can send the SMS to up to 10 phones which all may connect to the intercom session in parallel.

3.6.1.3 SAFR Notifications Call Notification Flow

Once set up, clicking on the Call Button on SAFR SCAN will initiate an SMS message to the configured phones. The SMS will include a link. That link will launch the SAFR Android App and display the Intercom event that triggered the alarm. User can launch the intercom session from that event by launching the SAFR Android App. The SAFR App must be installed to initiate the Intercom call.

1. An “Intercom Call Requested” event is generated.
   
2. The SMS is triggered from an Intercom event.
3. Operator opens the SMS message as shown below.
   
4. Operator clicks the link.
5. Clicking the link launches SAFR App and opens the Recent Events view as shown below.
   
6. Click on the “Intercom Call Requests” button to launch the intercom session.