Information
- Manufacturer: AIPhone ((800) 692-0200)
- Product: <AIPhone IX>
- Type: Alarm Receiver / Audio
Supported Features
- Event Receipt
- With attached video
- Video
- Live
- Quality Control
- Audio
- Transmit
- Receive
- Output Control
Note: AIPhone click to dial is not supported in the SureView Enterprise "V2" interface. If you are interested in making use of this functionality in 'V2' please contact your SureView Account Manager to discuss the options.
Components and Communication
From | To | Port | Use |
AiPhone Server | Sureview Server | 8195 TCP | For AiPhone to send alarms to Sureview |
Sureview Server | AiPhone Server | 80 HTTP | For Sureview to send HTTP CGI commands to AiPhone |
Sureview Server | AiPhone Server | 443 HTTPS | For Sureview to send HTTPS CGI commands to AiPhone |
AiPhone Server | Sureview Server | 554 RTSP | For AiPhone to stream video feeds to Sureview |
Master station | Sureview Server | 15000 | Allow UDP audio to be pushed to server |
Door station | Sureview Server | 15002 | Allow UDP audio to be pushed to server |
Sureview Configuration
There's two types of setup for an AiPhone integration, a Master station and Video Door station, 'Click To Dial' phone calls are made between these two stations and live video is streamed from Video Door Stations.
Standard Sureview Setup
Master station
Host | Master station IP, this can be found within the AI Phone SupportTools. |
Port | The port to send web requests over (default to 80 for HTTP and 443 for HTTPS) |
User | Master station username, this can be found at the point of installation. |
Password | Master station password, this can be found at the point of installation. |
Master Station ID | The terminal Id of the device being added, found within the AI Phone SupportTools. |
Use HTTPS | Tick to send the requests over HTTPS not HTTP |
Host | Door station IP, this can be found within the AI Phone SupportTool |
Port | The port to send web requests over (default to 80 for HTTP and 443 for HTTPS) |
User | Master station username, this can be found at the point of installation |
Password | Master station password, this can be found at the point of installation |
Master Station ID | The terminal Id of the device being added, found within the AI Phone SupportTools. |
RTSP Username | The pre-configured by AiPhone RTSP stream username |
RTSP Password | The pre-configured by AiPhone RTSP stream password |
RTSP Port (optional) | The pre-configured by AiPhone RTSP Port (defaults to 554) |
User HTTPS | Tick to send the requests over HTTPS not HTTP |
Alarm Configuration
Alarm Properties
Property | Description |
Input1 | The Camera channel that triggered the alarm |
EventType | The alarm type triggering |
Extra Text | Freeform text that you wish to include |
DateTime | The date and time of the event |
Full list of supported event types (Default)
Event Type | Description |
Begin Call | Call is made to master station, this is often the first point of contact. |
Begin Communication | The master station operator answers the incoming call. |
Door Release Indication | |
End Communication | The master station operator ends the call. |
Change Contact | Change contact communicates a state if change to each contact: contact input and contact output |
Unit Error | Unit error occurs after 'Begin Transfer' event, when either the OFF button is pressed on the destination master station and the transfer is ended, or when the TRANSFER is pressed on the source transfer Master Station and transfer is cancelled. |
Begin Broadcast | |
End Broadcast | |
Begin Transfer | Begin Transfer, is generated when the transfer button is pushed on the Master Station during communication and transfer connection is established. |
End Transfer | End Transfer occurs after a 'Begin Transfer' event, when either the OFF button is pressed on the destination master station and the transfer is ended, when the OFF button is pressed on the source transfer master station and transfer is ended, or when the TRANSDER is pressed n the source transfer master station transfer is cancelled |
Periodical Transmission | |
Initialization Notice |
AiPhone Configuration
Create a new .ini file, alternatively you can download the template (sif.ini) attached to the page. The .ini file should follow the following format:
{Sureview Program ID},{Sureview Host},{Alarm Port},{Enable Encryption}
Sureview Program ID | 0100 |
Sureview Host | Sureview host address |
Alarm Port | Port alarms/events will be sent on (Default 8195) |
Enable Encryption | Enable encrypted communication. (Default false) |
Example | 0100,192.168.1.1,8195,0 |
Alarm Properties
Firstly login to IX Support Tools, using the username and password configured during the install.
Once logged in, navigate to 'SIF Integration'. This can be found under the 'Function Settings' navigation tree as outlined below. Here, under 'SIF Communication Setting(sif.ini)'. Browse for your sif.ini file and upload. You will want to do this with each device listed.
Note: For any changes made to the system, the user will need to click 'Update'. This is located at the top right side of the screen.
AiPhone Service Configuration
Configuration File
If you want to further configure the AiPhone integration, you can do so by editing the configuration file 'SVAIPhoneAlarmReceiver.exe.config'.
AlarmPort | Alarm port number. |
SyncDatabase | The times in minutes the alarms receiver syncs with the database. |
Enable Encryption | Enable the handling of encryption. This should only be set true if the device .ini files has encryption enabled. |
Local Ip | The local IP of the server |
Note: Any changes made the the alarm receiver config file will require the service to be restarted.
Connection details found in the 'Control Configuration' Section.
AiPhone Usage in Sureview
Click to Dial
The AiPhone uses the terminal id to make phone calls. First off, set the operators phone number. This will set the device the operator will use to make a phone call with.
Providing the correct license is in use and an AiPhone has been added correctly, a greyed out phone will appear in the top right corner of the screen. Once hovered over, a drop down will appear with an option 'Provide Telephone Number'.
Selecting this will open the following popup box. Enter the following details:
Operator telephone Number | Device terminal ID |
Operator Server | Device to call from. |
To create a receiver number, add or edit a user. In user details, enter the terminal ID the operator wants to make a call to in the text box 'Cell/Mobile Telephone Number'.
After assigning a number to the user, navigate to the call lists. Here fill out the details where relevant.
Providing the previous steps were followed and completed successfully, an operator can now make a call using the number provided in the call list. There are two ways in which, an operator can make a call to a number, Site Details and Scripts.
Enter a 'Manual Patrol' or 'Site Check', select 'Details' from the top right. This will open a new dialog box. Here you can select any of the tabs, proving there is a user present, you can select the phone number. This will trigger the 'Click To Dial'. Setting a call between the operator number and the number displayed.
Create a script with a 'Call Contact' step.
An operator is now able to make call though the script steps while processing an alarm.
Relays
AiPhone relays require an 'Relay Extra Value', this will set the relay contact type. There are two contact types supported in AiPhone relays, 'Make' and 'Break'. Both of these are represented with a numeric value.
Setting the extra value to '0' will set the relay contact type to 'Make'.
Setting the extra value to '1' will set the relay contact type to 'Break'.
AiPhone does NOT support 'On/Off'. AiPhone devices uses 'Pulse'. When adding a relay to a device, be sure you un-tick 'On/Off' and tick 'Pulse'.
Note: Relays target the following units. Master station, Video door station and audio-only door station.
Video
As well as the normal setup information, video requires the username and password configured for the RTSP stream from a video station, these values are added when adding a device into Sureview.
Note. The connection limit to devices is one connection, therefore issues may be experienced when attempting to connect multiple times to the same device simultaneously.
Ensure in the support tool that Video Encoder 2 is enabled
Audio
Audio from telephone calls are saved to the filestore in .flv file format. Once a 'Begin Communication' alarm enters Sureview a request is sent to both devices involved in the communication to send audio to the Local IP configured in configuration file.
Troubleshooting
No alarms received to the Sureview server
Ensure the default alarm port is open - may require a firewall rule to allow TCP connections to this port.
Note be sure the .ini file is correct, you can check this by clicking the download button. This can be found in the following screenshot.
If the details match, you maybe required to upload your settings to the devices.
No live video
Ensure all settings are accurate (see Control Configuration section), as well as ports (if not configured) are correct as per the 'Use HTTPS' setting (HTTPS = 443, HTTP = 80, RTSP = 554). The device only allows one connection at a time therefore issues may be encountered when attempting to open up a second stream with a connection already open.
Missing start / no audio saved in filestore
After the phone is answered a request is sent to both devices to send audio to the server, this whole process takes a few seconds to start so the first few seconds of the call may be missed. Also if the phone call is ended before the first request is complete, an empty audio file will be added to the filestore.
Comments
0 comments
Please sign in to leave a comment.