Paradox API

Paradox API Software Development Kit V2.6 (Control Panel Integration) Revision Date: February 5, 2016

Table of Contents

1.

DOCUMENT HISTORY LOG ............................................................................................ 4

2.

PROJECT OVERVIEW ....................................................................................................... 5 2.1.

FEATURE OVERVIEW...........................................................................................................................5

2.1.1.

Paradox API - Driver .......................................................................................................................................................................... 5 Paradox API – Installation .................................................................................................................................................................. 5 2.1.3. Paradox API - Demo Application ....................................................................................................................................................... 5 2.1.4. Paradox API – Paradox Video Player ................................................................................................................................................. 6 2.1.2.

2.2. 2.2.1.

API DEFINITION ..................................................................................................................................7

1. 2. 3. 4. 5. 6. 7. 8. 9. 10. 11. 12. 13. 14. 15. 16. 17.

Paradox API - Command List ............................................................................................................................................................. 7 Get Driver Version ............................................................................................................................................................................ 7 Discover Module (Command) ......................................................................................................................................................... 7 Connect Panel (Command) ............................................................................................................................................................ 9 Disconnect Panel (Command) .....................................................................................................................................................10 Retrieve Panel Info (Command) ................................................................................................................................................... 11 Start IPDOX “Receiver” (Command) ........................................................................................................................................... 12 Delete IPDOX Account (Command) ............................................................................................................................................ 13 Start Monitoring (Command) ........................................................................................................................................................ 14 Read Monitoring (Command) ....................................................................................................................................................... 14 Register Panel (Command) .......................................................................................................................................................... 14 Control Area (Command) .............................................................................................................................................................. 15 Area Status (Command) ................................................................................................................................................................ 15 Control Zone (Command) ............................................................................................................................................................. 17 Zone Status (Command) ............................................................................................................................................................... 17 Control PGM (Command) ............................................................................................................................................................. 18 PGM Status (Command) ............................................................................................................................................................... 19 Control Door (Command) .............................................................................................................................................................. 19

18. 19. 20. 21. 22. 23. 24. 25. 26. 27. 28. 29. 30. 31. 32. 33. 34. 35. 36. 37. 38. 39. 40. 41. 42. 43. 44. 45. 46.

............................................................................................................................................................... Door Status (Command) IP Reporting Status (Command) ..................................................................................................................................................20 21 System Troubles (Command) ....................................................................................................................................................... 22 Read Panel Time Stamp (Command) ......................................................................................................................................... 25 Read Panel Date and Time (Command)..................................................................................................................................... 26 Write Panel Date and Time (Command) ..................................................................................................................................... 26 Read All Areas (Command) .......................................................................................................................................................... 26 Read Area (Command) ................................................................................................................................................................. 26 Read All Zones (Command) ......................................................................................................................................................... 29 Read Zone (Command) ................................................................................................................................................................. 29 Read All PGMs (Command) ......................................................................................................................................................... 31 Read PGM (Command) ................................................................................................................................................................. 31 Read All Doors (Command) .......................................................................................................................................................... 32 Read Door (Command) ................................................................................................................................................................. 32 Write Door (Command) ................................................................................................................................................................. 34 Read All Schedules (Command) .................................................................................................................................................. 35 Read Schedule (Command) ......................................................................................................................................................... 35 Write Schedule (Command) ......................................................................................................................................................... 35 Read All Access Level (Command) ............................................................................................................................................. 36 Read Access Level (Command) .................................................................................................................................................. 36 Write Access Level (Command) ................................................................................................................................................... 37 Read Holidays (Command) .......................................................................................................................................................... 38 Write Holidays (Command) ........................................................................................................................................................... 38 Read All Users (Command) .......................................................................................................................................................... 38 Read User (Command) ................................................................................................................................................................. 39 Write Multiple Users (Command) ................................................................................................................................................. 40 Write User (Command).................................................................................................................................................................. 40 Read IP Reporting (Command) .................................................................................................................................................... 42 Write IP Reporting (Command) .................................................................................................................................................... 43 Page 2 of 64

47. 48. 49. 50. 51. 52. 53. 54. 55. 56. 57. 58. 59. 60. 61. 62. 63. 64. 65. 66. 67. 68. 69. 70. 2.2.2.

Read Buffer Events (Command) .................................................................................................................................................. 44 Read Buffer Events EX (Command) ............................................................................................................................................ 44 Get Site from PMH (Command) ................................................................................................................................................... 44 Configure Video Server (Command) ........................................................................................................................................... 45 Get Video Alarm Files (Command) .............................................................................................................................................. 46 Start Video on Demand (Command) ........................................................................................................................................... 47 Start Video on Demand EX (Command) ..................................................................................................................................... 48 Stop Video on Demand (Command) ........................................................................................................................................... 49 Connection Status Changed (Event) ........................................................................................................................................... 49 Progress Changed (Event) ........................................................................................................................................................... 50 Progress Error (Event) ................................................................................................................................................................... 50 SMS Request (Event) .................................................................................................................................................................... 52 Receive Reporting Event (Event) ................................................................................................................................................. 53 Account Registration (Event) ........................................................................................................................................................ 54 Account Update (Event) ................................................................................................................................................................ 55 Account Link (Event) ...................................................................................................................................................................... 55 Receive Buffer Event (Event) ....................................................................................................................................................... 56 Receive Live Event (Event) .......................................................................................................................................................... 57 Monitoring Status Changed (Event) ............................................................................................................................................ 58 RX Status Changed (Event) ......................................................................................................................................................... 58 TX Status Changed (Event) .......................................................................................................................................................... 59 IP Module Detected (Event) .......................................................................................................................................................... 59 IPDOX Socket Changed (Event) .................................................................................................................................................. 60 Unregister All (Command) ............................................................................................................................................................ 60 Paradox API - 2.2.2 Result Code List ............................................................................................................................................... 60

Page 3 of 64

1. Document History Log Document Version

Date

Change By

Description

1.0

2015-06-30

Jerome Lepage

Initial Document

1.0.1

2015-08-10

Jerome Lepage

Added all commands

1.0.2

2015-08-20

Jerome Lepage

Added all parameters definition

2.0.1

2015-09-08

Jerome Lepage

Added EVO control panel

2.0.2

2015-09-21

Jerome Lepage

Added Read All Zones, User, Doors

2.0.3

2015-09-27

Jerome Lepage

Added Read All Schedules, Access Levels

2.0.5

2015-09-28

Jerome Lepage

Added “Write Multiple Users”

2.0.6

2015-09-29

David Watherhouse

Added status column description

2.1.1

2015-10-06

Jerome Lepage

Added Configure Video Server, Get Video Alarm Image, Video Live Streaming

2.1.2

2015-10-15

Jerome Lepage

Added Start VOD EX

2.1.3

2015-10-21

Jerome Lepage

Revised doc

2.2.2

2015-10-28

Jerome Lepage

Fixed timeout command and index

command

out of bound issues in ParadoxAPI.dll 2.3.1

2016-01-05

Jerome Lepage

Disable monitoring polling to reduce CPU usage (via the MonitoringPollingEnabled property)

2.4.1

2016-01-14

Jerome Lepage

Added connected UserNo and UserPartitionAccess to RetrievePanelInfo command

2.5.1

2016-01-18

Jerome Lepage

Fixed read buffer events from SP4000

2.6.1

2016-02-05

Jerome Lepage

Added ReadBufferEventsEx API. Use to retrieve new events only. Compatible with SP4000 and EVO panels

Page 4 of 64

2. Project Overview 2.1.

Feature Overview

2.1.1.

Paradox API - Driver

Features: 1. Windows “flat” DLL that implements stdcall functions 2. Compatible with all MG and SP Series panels 3. Auto-detect panel via serial, IP or PCS (GPRS) connection 4. Connect to panel via serial, IP or PCS (GPRS) connection 5. Control panel status (Area, Zone and PGM) 6. Monitor panel status (Area, Zone, PGM and Troubles) 7. Read panel programming (Labels, Areas, Zones, PGMs, Schedules, Users and IP Reporting) 8. Write panel programming (Labels, Schedules, Users and IP Reporting programming) 9. Read panel buffer and live events 10. Register panel to IP receiver 11. Receive account registration and event reporting via IP 2.1.2.

Paradox API – Installation

The Paradox API SDK package contains three DLL files, which must be copied to the same directory. Features: 1. ParadoxNetwork.dll handles panel communication 2. IPDOX.dll handles panel registration and reporting 3. ParadoxAPI.dll provides the API interface for integration

2.1.3.

Paradox API - Demo Application Page 5 of 64

Allows the software integrator to review and test the Paradox API integration. Features: 1. Demo application and source code are included (written in C#) ParadoxApiDemo.exe.

2.1.4.

Paradox API – Paradox Video Player

Allows the software integrator to execute Apple HTTP live streaming from a m3u8 file *see ParadoxVideoPlayer.exe Features: 1. Application uses ffmpeg library (decoder only) http://www.DelphiFFmpeg.com 2. Select m3u8 filename (from toolbar/open) 3. Play (start) live streaming 4. Stop live streaming 5. Auto select and start live streaming from shellexecute command 6. *ShellExecute(0, 'open', PChar('ParadoxVideoPlayer.exe'), PChar(Format(''file=%s proxy=%s'', [m3u8FileName, proxyURL])), '', SW_SHOWNORMAL);

Page 6 of 64

2.2.

API Definition

2.2.1.

  

Paradox API - Command List

All commands are accessible from the exported ParadoxAPI.dll API All commands are synchronized methods, they return when the action is completed For maximum performance, we recommend creating thread or thread pool to communicate with each control panel

1. Get Driver Version  



Use to retrieve Paradox API driver version Request (Pascal STDCALL) function GetDriverVersion(out Version: WideString): HResult; stdcall; Answer 1. Function call returns HResult (see 2.2.2 Result Code List) 2. Function parameter (Version) returns version # (x.x.x.x)

2. Discover Module (Command) Page 7 of 64

   



Use to discover all Paradox ’s IP modules connected to a selected network Command broadcasts a UDP packet over the Ethernet Each Paradox IP module answers command with its definition Request (Pascal STDCALL) function DiscoverModule(out XMLInfo: WideString): HResult; stdcall; Answer 1. Function call returns HResult (see 2.2.2 Result Code List) 2. Function parameter (XMLInfo) returns XMLData; see below: False False



Parameter definition

method name "MacString" "NetMaskString" "DHCPString" "TypeString"

"IPString" "SiteNameString" "SiteIDString" "VersionString" "IPPortString"

Definition The MAC address of the detected IP module The NETMASK of the detected IP module If the detected IP module uses DHCP mode (DHCP enable) Possible Values "IP100" "IP150" "PCS250" "PCS250G" "IPR512" "HD77" The IP address of the detected IP module The Site Identification (Name) of the detected IP module The Site ID (used to access the module via ParadoxMyHome) of the detected IP module The version (version.revision.build) of the detected IP module The IP port # (used to connect to the module via end-user/installer software) of the detected IP

"WebPortString" "LanguageString" "SerialNoString" "HTTPSPortString" "DiscoverOnLAN"

module The WEB port # (use to connect to the module via the web page) of the detected IP module The current language of the detected IP module The serial # of the control panel connected to the detected IP module The HTTPS port # of the detected IP module Future use Page 8 of 64

"UseHTTPSString" "RegisteredToPMH" "NetworkInterfaceIp Address"

If the detected IP module use HTTPS If the detected IP module is registered to ParadoxMyHome The network interface (IP address) where the IP module has been detected

3. Connect Panel (Command)  





Use to connect to a control panel via serial, IP or PCS (GPRS) connection PCS (GPRS) connection can be established on a private network using the SMS callback mechanism Command auto-detect panel type and version *specify panel type to speed up the connection process Request (Pascal STDCALL) function ConnectPanel(const PanelID: Cardinal; XMLSettings: WideString; WaitTimeOut: Cardinal): HResult; stdcall; 1. PanelID parameter identifies the control panel connection. This parameter must be defined by the client and must be unique to the entire system. 2. WaitTimeOut parameter identifies command timeout in second (0=infinite) 3. XMLSettings parameter must contain XML data; see below: 0 0 0 False True



method name "PanelType"

"ComType"

Parameter definition Definition Possible Values "" or "Auto Detect" "SP4000" "SP5500" "SP6000" "SP7000" "SP65" "MG5000" "MG5050" "EVO192" "EVOHD" Possible Values "SERIAL" "IP"

Description Auto detect panel type SP4000 control panel SP5500 control panel SP6000 control panel SP7000 control panel SP65 control panel MG5000 control control panel panel MG5050 EVO192 control panel EVOHD control panel Description Connect to control panel via serial cable Connect to control panel via IP module (IP socket) Page 9 of 64

"DNS"

"SiteID" "SerialNo" "IPAddress" "IPPort" "ComPort" "BaudRate"

"SMSCallback"

"IPPassword" "UserCode" "SystemAlarmLanguage"

"MonitoringPollingEnabled"

Connect to control panel via IP module (IP socket) using ParadoxMyHome "GPRSSTATIC" Connect to control panel via PCS module (GPRS) "GPRSPRIVATE" Connect to control panel via PCS module (GPRS), enable SMSCallback property to use SMS callback mechanism The SiteID in ParadoxMyHome to use for "DNS" connection Future use The static IP address to use for "IP" or "GPRSSTATIC" or "GPRSPRIVATE" connection The IP port to use for "IP" or "GPRSSTATIC" or "GPRSPRIVATE" connection The COM port to use for "SERIAL" connection Possible Values Description 0 Auto detect baud rate 9600 9600bps 38400 38400bps 57600 57600bps Use SMS callback mechanism for "GPRSPRIVATE" connection. With that feature enabled, the ParadoxAPI.dll opens a socket server and waits for the callback PCS module connection. The connection is established via a SMS message that has to be sent by the client to the PCS module. The SMS message to send is returned by ParadoxAPI.DLL via the SMS Request callback event. The IP password to use for "IP" or "GPRSSTATIC" or "GPRSPRIVATE" connection. The IP password must exist in the IP or GPRS module. The user code to use for connection to the control panel. The user code must exist and have sufficient rights in the control panel. The labels such as (Area, Zone labels) will be formatted into the following language Possible Values Possible Values "ENGLISH" "SLOVAK" "FRENCH" "CHINESE" "SPANISH" "SERBIAN" "ITALIAN" "MALAY" "SWEDIS" "SLOVENIAN" "POLISH" "LITHUANIAN" "PORTUGUESE" "FINNISH" "GERMAN" "ESTONIAN" "TURKISH" "BELGIAN" "HUNGARIAN" "LATVIAN" "CZECH" "MACEDONIA" "DUTCH" "ALBANIAN" "CROATIAN" "NORWEGIAN" "GREEK" "ARABICPERSAIN" "HEBREW" "ARABICWESTERN" "RUSSIAN" "ARABICEASTERN" "BULGARIAN" "ROMANIAN" If enabled, the monitoring statuses (such as Area, Zone, PGM and Trouble) are read automatically (every x seconds) from the control panel, and stored within the driver. This operation could be CPU intensive if several control panels are connected to the driver. You can disable the feature to reduce the CPU usage. If disabled, the CMS will have to call the Read Monitoring command every time it needs to update the monitoring status.



Answer 1. Function call returns HResult (see 2.2.2 Result Code List)

4. Disconnect Panel (Command) 

Use to disconnect the client from the control panel Page 10 of 64





Request (Pascal STDCALL) function DisconnectPanel(const PanelID: Cardinal): HResult; stdcall; 1. PanelID parameter identifies the connected control panel to disconnect Answer 1. Function call returns HResult (see 2.2.2 Result Code List)

5. Retrieve Panel Info (Command)  



Use to retrieve the control panel definition such as version, area count, zone count Request (Pascal STDCALL) function RetrievePanelInfo(const PanelID: Cardinal; out XMLInfo: WideString): HResult; stdcall; 1. PanelID parameter identifies the connected control panel to retrieve information Answer 1. Function call returns HResult (see 2.2.2 Result Code List) 2. Function parameter (XMLInfo) returns XMLData; see below: 0 0 0 0 0 0 0 0 0 0 0 0 0



method name "Description" "ProductID"

"SerialNo" "Version" "Revision" "AreaCount" "ZoneCount"

Parameter definition Definition The product name of the control panel Possible values 0xAE53 0xA41E 0xA41F 0xA420 0xAE54 0xA524 0xA526

Description SP4000 SP5500 SP6000 SP7000 SP65 MG5000 MG5050

0xA123 EVO192 0xA16D EVOHD The serial # of the connected control panel The version # of the connected control panel The revision # of the connected control panel The quantity of Area in the connected control panel The quantity of Zone in the connected control panel Page 11 of 64

"PGMCount" "UserCount" "DoorCount" "ReceiverCount" "ScheduleCount" "AccessLevelCount" "UserNo" "UserPartitionAccess"

The quantity of PGM in the connected control panel The quantity of User in the connected control panel The quantity of Door in the connected control panel The quantity of IP receiver in the connected control panel The quantity of schedule in the connected control panel The quantity of access level in the connected control panel The connected user # The connected user area access (comma-delimited, for example “1,2”)

6. Start IPDOX “Receiver” (Command)   

  

Use to configure and activate the build in IP receiver Receive account registration and Ademco CID or SIA reporting event Forward reporting event to an automation software in ADEMCO685, RADIONIX6500 or SURGARDMLR2DG format via IP or serial link Account registration is received via the Account Registration callback function Reporting event is received via the Receive Reporting Event callback function Request (Pascal STDCALL) function ConfigureIPDOX(XMLSettings: WideString): HResult; stdcall; 1. Function parameter (XMLSettings) must contain XMLData; see below:

False 0 0 0 0 False 0 0 False 0 0 0 0 0 False 0 False 0 False 0 False 0 False 0 Page 12 of 64



Parameter definition

method name

Definition

Mandatory

"IPPassword" "ACCFilePath"

The receiver IP password The directory to store the .ACC file. The ACC file contains all keys required to communicate with the registered accounts. This file is used by the ParadoxAPI driver for internal storage.

"WANId" "WANEnabled" "WANPort"

ALWAYS PUT 1 (only 1 WAN is supported)

"WANAddress" "MonitoringAccountNo"

Set the network interface adapter to use to receive IP reporting Set the account # to use for internal reporting event to send to the automation software

Enable receiver WAN interface Set the port # to use to receive IP reporting

Optional

"OutputEnabled" "OutputType"

"OutputCOMPort" "OutputBaudRate" "OutputUDP" "OutputIPPort" "OutputIPAddress" "OutputProtocolID"

"OutputReceiverNo" "OutputLineNo" "OutputHeaderID" "OutputTrailerID" "OutputAckNack" "OutputWaitForAck" "OutputTestMessage" "OutputTestMsgDelay" "OutputForcePartition" "OutputPartitionNo" "OutputUseMACAddress"



Convert and send the reporting event to an external automation software Select the media type to use to send reporting event to the external automation software Possible values "SERIAL" "IP" Select the port # to use to send reporting event via "Serial" Select the baud rate to use to send reporting event via "Serial" Use UDP instead of TCP for packet transmission to the automation software Select the port # to use to send reporting event via "IP" Select the IP address where to send the reporting event via "IP" Select the reporting event format to send to the external automation software Possible values "ADEMCO685" "RADIONIX6500" "SURGARDMLR2DG" Set the receiver # to send to the automation software Set # toID send to the software Set the the line header to send toautomation the automation software Set the trailer ID to send to the automation software Enable ACK mechanism between the ParadoxAPI and the automation software Set the ACK wait time out in seconds Enable test message to automation software Set test message interval in seconds Enable transmit custom partition # (always) to automation software Set the custom partition # to transmit Append account’s MAC address to every reporting event to send to the automation software

Answer 1. Function call returns HResult (see 2.2.2 Result Code List)

7. Delete IPDOX Account (Command)  

Use to delete a registered account in the receiver storage file (.ACC file) Request (Pascal STDCALL) Page 13 of 64



function DeleteIPDOXAccount(MACAddress: WideString): HResult; stdcall; 1. MACAddress parameter identifies the account # to delete Answer 1. Function call returns HResult (see 2.2.2 Result Code List)

8. Start Monitoring (Command)  

 



Use to initialize and retrieve (read) all system status Command retrieves all system status such as area, zone, pgm and trouble status from the connected control panel Client will be notified on status change via the Monitoring Status Changed event callback Request (Pascal STDCALL) function StartMonitoring(const PanelID: Cardinal): HResult; stdcall; 1. PanelID parameter identifies the connected control panel to start monitoring Answer 1. Function call returns HResult (see 2.2.2 Result Code List)

9. Read Monitoring (Command)    



Use to refresh (read) all system status Command retrieves all system status changes from the connected control panel Client will also be notified on status change via the Monitoring Status Changed event callback Request (Pascal STDCALL) function ReadMonitoring(const PanelID: Cardinal; out XMLMonitoring: WideString): HResult; stdcall; 1. PanelID parameter identifies the connected control panel to retrieve system status Answer 1. Function call returns HResult (see 2.2.2 Result Code List) 2. Function parameter (XMLMonitoring) returns XMLData; see below: 0



Parameter definition TOnLiveEventReceivedCallback = procedure(const PanelID: Cardinal; XMLEvents: WideString); stdcall; 1. Use the same parameter definition as Receive Buffer Event

65. Monitoring Status Changed (Event)   



Register to receive monitoring status change Notification is done via the registered callback function Request (Pascal STDCALL) procedure RegisterMonitoringStatusChangedCallback(Callback: TOnMonitoringStatusChangedCallback); stdcall; 1. Callback function; see Parameter definition below Answer 1. Function call returns HResult (see 2.2.2 Result Code List) 2. Callback parameter returns XML; see below:



Parameter definition TOnMonitoringStatusChangedCallback = procedure(const PanelID: Cardinal; XMLStatus: WideString); stdcall; 1. See Area Status, Zone Status and PGM Status functions

66. RX Status Changed (Event) 

Register to be notified on received bytes Page 58 of 64

 





Notification is done via the registered callback function Request (Pascal STDCALL) procedure RegisterRxStatusChangedCallback(Callback: TOnDataExchangedCallback); stdcall; 1. Callback function; see Parameter definition below Answer 1. Function call returns HResult (see 2.2.2 Result Code List) Parameter definition TOnDataExchangedCallback = procedure(const PanelID: Cardinal; ByteCount: Integer); stdcall;

Parameter PanelID

Definition Identifies the connected control panel

ByteCount

Quantity of bytes received from the control panel

67. TX Status Changed (Event)   





Parameter PanelID ByteCount

Register to be notified on send bytes Notification is done via the registered callback function Request (Pascal STDCALL) procedure RegisterTxStatusChangedCallback(Callback: TOnDataExchangedCallback); stdcall; 1. Callback function; see Parameter definition below Answer 1. Function call returns HResult (see 2.2.2 Result Code List)

Parameter definition TOnDataExchangedCallback = procedure(const PanelID: Cardinal; ByteCount: Integer); stdcall; Definition Identifies the connected control panel Quantity of bytes sent to the control panel

68. IP Module Detected (Event)   



Register to be notified on IP module detected Notification is done via the registered callback function Request (Pascal STDCALL) procedure RegisterIPModuleDetectedCallback(Callback: TOnIPModuleDetectedCallback); stdcall; 1. Callback function; see Parameter definition below Answer 1. Function call returns HResult (see 2.2.2 Result Code List) 2. Callback parameter returns XML; see below: Page 59 of 64

False False 

Parameter XMLModule

Parameter definition TOnIPModuleDetectedCallback = procedure(XMLModule: WideString); stdcall; Definition See Discover Module command

69. IPDOX Socket Changed (Event)   





Parameter Port Status

Description

Register to be notified on IPDOX status changed Notification is done via the registered callback function Request (Pascal STDCALL) procedure RegisterIPDOXSocketChangedCallback(Callback: TOnIPDOXSocketChangedCallback); stdcall; 1. Callback function; see Parameter definition below Answer 1. Function call returns HResult (see 2.2.2 Result Code List) Parameter definition TOnIPDOXSocketChangedCallback = procedure(const Port: Cardinal; Status: Cardinal; Description: WideString); stdcall; Definition The IP port # that changed Possible Values 0x00 0x01 0x02 The error description in English

Description Socket Close Socket Open Socket Error

70. Unregister All (Command)  

Unregister all event notification Request (Pascal STDCALL) procedure UnregisterAllCallback; stdcall;



Answer 1. Function call returns HResult (see 2.2.2 Result Code List)

2.2.2.

Paradox API - 2.2.2 Result Code List

Page 60 of 64

S_PN_RESULT_PID_BASE

0x02000000

Stack Successful

E_PN_RESULT_CODE_BASE

0x81000000

Successful

E_PN_RESULT_PID_BASE

0x82000000

Stack Error

S_PID002A_RESULT_SUCCESS

S_PN_RESULT_PID_BASE + 0x00002A00

Command Successful

E_PID002A_RESULT_FAILURE

E_PN_RESULT_PID_BASE + 0x00002A00

Command Error

E_PID002A_INVALID_COMMAND

E_PID002A_RESULT_FAILURE + 0x01

E_PID002A_ALREADY_CONNECTED

E_PID002A_RESULT_FAILURE + 0x08

E_PID002A_INVALID_PANEL_ID

E_PID002A_RESULT_FAILURE + 0x0C

Command not supported by driver Selected account is already connected Selected panel ID does not exists

E_PID002A_SESSION_TIMEOUT

E_PID002A_RESULT_FAILURE + 0x10

E_PID002A_INVALID_DATETIME_FOR MAT

E_PID002A_INVALID_DATETIME_FORMA T + 0x11

Cannot execute the selected command. (Please connect the account or wait connection completes, see: RegisterConnectionStatusChan gedCallback) Command not supported by the connected control panel Session expires due to inactivity timeout Unable to update the control panel date and time (invalid date time format

E_PID002A_SMS_CALLBACK_CONNE CTION_SUCCESS

S_PID002A_RESULT_SUCCESS +0x03

Paradox driver has accepted the PCS incoming connection

E_PID002A_INVALID_XML_FORMAT

E_PID002A_RESULT_FAILURE + 0x28

The XML format is invalid

E_PID002A_INVALID_COM_PORT

E_PID002A_RESULT_FAILURE + 0x29

The COM port is invalid

E_PID002A_INVALID_BAUD_RATE

E_PID002A_RESULT_FAILURE + 0x2A

The baud rate is invalid

E_PID002A_INVALID_IP_ADDRESS

E_PID002A_RESULT_FAILURE + 0x2B

The IP address is invalid

E_PID002A_INVALID_IP_PORT

E_PID002A_RESULT_FAILURE + 0x2C

The IP port is invalid

E_PID002A_INVALID_SITE_ID

E_PID002A_RESULT_FAILURE + 0x2D

E_PID002A_INVALID_IP_PASSWORD

E_PID002A_RESULT_FAILURE + 0x2E

The SiteID does not exist in ParadoxMyHome The IP password is invalid

E_PID002A_INVALID_COM_TYPE

E_PID002A_RESULT_FAILURE + 0x2F

E_PID002A_INVALID_USERCODE

E_PID002A_RESULT_FAILURE + 0x30

E_PID002A_INVALID_USER_RIGHTS

E_PID002A_RESULT_FAILURE + 0x31

E_PID002A_COMMAND_TIMEOUT

E_PID002A_RESULT_FAILURE + 0x32

E_PID002A_PANEL_NOT_FOUND

E_PID002A_RESULT_FAILURE + 0x33

E_PID002A_TASK_CANCELLED

E_PID002A_RESULT_FAILURE + 0x34

E_PID002A_NO_SYSTEM_TROUBLES

E_PID002A_RESULT_FAILURE + 0x35

E_PID002A_INVALID_ACCOUNT_NOT _CONNECTED E_PID002A_INVALID_COMMAND_NOT _SUPPORTED

E_PID002A_RESULT_FAILURE + 0x0E E_PID002A_RESULT_FAILURE + 0x0F

The communication type is invalid The user code does not exist in the control panel You do not have sufficient rights to perform this action; contact your system master The command timed out, no valid answer received Panel does not exist or is disconnected The current task has been cancelled No trouble found in control panel Page 61 of 64

E_PID002A_INVALID_RECEIVER_NO

E_PID002A_RESULT_FAILURE + 0x36

The receiver # does not exist

E_PID002A_INVALID_AREA_NO

E_PID002A_RESULT_FAILURE + 0x37

The area # does not exist

E_PID002A_INVALID_ZONE_NO

E_PID002A_RESULT_FAILURE + 0x38

The zone # does not exist

E_PID002A_INVALID_PGM_NO

E_PID002A_RESULT_FAILURE + 0x39

The pgm # does not exist

E_PID002A_INVALID_DOOR_NO

E_PID002A_RESULT_FAILURE + 0x3A

The door # does not exist

E_PID002A_INVALID_USER_NO

E_PID002A_RESULT_FAILURE + 0x3B

The user # does not exist

E_PID002A_INVALID_ACCOUNT_NO

E_PID002A_RESULT_FAILURE + 0x3C

The account # does not exist

E_PID002A_INVALID_SCHEDULE_NO E_PID002A_INVALID_ACCESS_LEVEL _NO E_PID002A_PMH_ERROR_PANEL_NO T_FOUND

E_PID002A_RESULT_FAILURE + 0x3D

The schedule # does not exist The access level # does not exist

E_PID002A_RESULT_FAILURE + 0x3E

E_PID002A_PMH_ERROR_NO_MODU LE

E_PID002A_RESULT_FAILURE + 0x40

E_PID002A_PMH_ERROR_NO_ANSW ER_TIMEOUT

E_PID002A_RESULT_FAILURE + 0x41

E_PID002A_NO_VIDEO_FILE

E_PID002A_RESULT_FAILURE + 0x42

E_PID002A_INVALID_VIDEO_FOLDER

E_PID002A_RESULT_FAILURE + 0x43

The panel serial # is not registered to ParadoxMyHome The selected panel serial # does not include any module registered to ParadoxMyHome The command timed out, no valid answer received from ParadoxMyHome No video file found for selected event The selected video folder is invalid

S_IP100_RESULT_SUCCESS

0x03000000

IP Module Successful

E_IP100_RESULT_FAILURE

0x83000000

IP Module Error

E_PID002A_RESULT_FAILURE + 0x3F

Failed to connect; IP Module web page currently in used (please try E_IP100_WEB_PAGE_IN_USE

E_IP100_RESULT_FAILURE + 0x02

E_IP100_BAD_USERNAME

E_IP100_RESULT_FAILURE + 0x03

E_IP100_BAD_PASSWORD

E_IP100_RESULT_FAILURE + 0x04

E_IP100_NEWARE_IN_USE

E_IP100_RESULT_FAILURE + 0x05

later) Failed to connect; IP Module user name entered is invalid Failed to connect; IP Module password entered is invalid Failed to connect; NEware/Winload is currently connected (please try later)

S_PID0004_RESULT

S_PN_RESULT_PID_BASE + 0x00000400

Winload Protocol Successful

E_PID0004_ERROR

E_PN_RESULT_PID_BASE + 0x00000400

Winload Protocol Error

E_PID0004_ERROR_AUTHFAIL_PCPS WD

E_PID0004_ERROR + 0x03

E_PID0004_ERROR_AUTHFAIL_PNLID

E_PID0004_ERROR + 0x04

E_PID0004_ERROR_AUTHFAIL_USRID

E_PID0004_ERROR + 0x05

E_PID0004_ERROR_AUTHFAIL_PNLR EPORTING

E_PID0004_ERROR + 0x06

E_PID0004_ERROR_PARTITIONINLOC KOUT

E_PID0004_ERROR + 0x0A

Failed to connect; User Code/Password entered is invalid Failed to connect; Panel ID entered is invalid Failed to connect; User Code entered is invalid Failed to connect; Control is currently reporting to thepanel central station (please try later) Failed to connect; Control panel is in partition lockout (please try later) Page 62 of 64

E_PID0004_ERROR_SOFTWAREOVER MODEM

E_PID0004_ERROR + 0x0E

Failed to connect; Control panel cannot connect for the moment (please try later) Unable to execute command; Control panel is not connected Failed to connect; Control panel is already connected Failed to connect; Another software is currently connected over the phone (please try later)

S_PN_RESULT_CHANNEL_BASE

0x05000000

Channel Successful

E_PN_RESULT_CHANNEL_BASE

Channel Error Socket Successful

E_PN_RESULT_CHANNEL_SOCKET E_PN_CHNL_SOCKET_INVALID_ADD RESS

0x85000000 S_PN_RESULT_CHANNEL_BASE + 0x00000200 E_PN_RESULT_CHANNEL_BASE + 0x00000200 E_PN_RESULT_CHANNEL_SOCKET + 0x01

E_PN_CHNL_SOCKET_HOST_UNREA CHABLE

E_PN_RESULT_CHANNEL_SOCKET + 0x02

E_PN_CHNL_CONNECT_FAILED

E_PN_RESULT_CHANNEL_BASE + 0x01

E_PID0004_ERROR_PANELWILLDISC ONNECT E_PID0004_ERROR_PANELNOTCONN ECTED E_PID0004_ERROR_PANELALREADY CONNECTED

S_PN_RESULT_CHANNEL_SOCKET

E_PID0004_ERROR + 0x0B E_PID0004_ERROR + 0x0C E_PID0004_ERROR + 0x0D

Socket Error Failed to connect; Invalid control panel IP Address Failed to connect; Unable to connect to destination IP address (Host is unreachable, please verify control panel network settings) Failed to connect; Unable to connect socket

Video on demand

E_VIDEO_ RESULT_SUCCESS

S_PID002A_RESULT_SUCCESS

Video Successful

E_VIDEO_ RESULT_FAILURE

0x80000000

Video Error

E_VIDEO_ RESULT_FAILURE + 0x00 E_VIDEO_ RESULT_FAILURE + 0x01

Login refused, unknown error

E_VIDEO_ ERROR_LOGIN_REFUSED E_VIDEO_ ERROR_LOGIN_INVALID_DEVELOPER_KEY E_VIDEO_ ERROR_LOGIN_INVALID_SERVER_PASSWOR D E_VIDEO_ ERROR_LOGIN_CONTROLPANEL_DOWN E_VIDEO_ ERROR_LOGIN_INVALID_USERCODE E_VIDEO_ ERROR_ LOGIN_ALREADY_IN E_VIDEO_ ERROR_ LOGIN_TOO_MANY_ATTEMPTS E_VIDEO_ ERROR_ LOGIN_PRIVACY_MODE_ACTIVE E_VIDEO_ ERROR_REQUEST_MALFORMED E_VIDEO_ ERROR_INVALID_SESSION_KEY

E_VIDEO_ RESULT_FAILURE + 0x02 E_VIDEO_ RESULT_FAILURE + 0x03 E_VIDEO_ RESULT_FAILURE + 0x04 E_VIDEO_ RESULT_FAILURE + 0x05 E_VIDEO_ RESULT_FAILURE + 0x07 E_VIDEO_ RESULT_FAILURE + 0x08 E_VIDEO_ RESULT_FAILURE + 0x40000 E_VIDEO_ RESULT_FAILURE +

E_VIDEO_ ERROR_INVALID_ACTION E_VIDEO_ ERROR_INSUFFICIENT_USER_RIGHTS

0x40001 E_VIDEO_ RESULT_FAILURE + 0x40002 E_VIDEO_ RESULT_FAILURE + 0x40003

E_VIDEO_ ERROR_INVALID_FORMAT

E_VIDEO_ RESULT_FAILURE +

Login refused, invalid developer key Login refused, invalid server password Login refused, control panel link is down Login refused, invalid user code Login refused, user already logged in Login refused, too many connections for this user code Login refused, privacy mode active Request failed, request malformed Request failed, invalid session key Request failed, invalid action id Request failed, insufficient user rights Request failed, invalid resolution Page 63 of 64

0x40004 E_VIDEO_ ERROR_DOWNLOAD_REQUEST_MALFORMED E_VIDEO_ ERROR_DOWNLOAD_INVALID_SESSION_KEY E_VIDEO_ ERROR_DOWNLOAD_ INSUFFICIENT_USER_RIGHTS E_VIDEO_ ERROR_DOWNLOAD_INVALID_ITEM_ID E_VIDEO_ ERROR_DOWNLOAD_UNAVAILABLE E_VIDEO_ ERROR_PLAY_

E_VIDEO_ RESULT_FAILURE + 0x60000 E_VIDEO_ RESULT_FAILURE + 0x60001 E_VIDEO_ RESULT_FAILURE + 0x60002 E_VIDEO_ RESULT_FAILURE + 0x60003 E_VIDEO_ RESULT_FAILURE + 0x60004 E_VIDEO_ RESULT_FAILURE +

Item download failed, request malformed Item download failed,invalid session key Item download failed, insufficient user rights Item download failed, invalid item id Item download failed, item is not downloadable Item play failed, request

REQUEST_MALFORMED E_VIDEO_ ERROR_PLAY_INVALID_SESSION_KEY E_VIDEO_ ERROR_PLAY_ INSUFFICIENT_USER_RIGHTS

0x70000 E_VIDEO_ RESULT_FAILURE + 0x70001 E_VIDEO_ RESULT_FAILURE + 0x70002 E_VIDEO_ RESULT_FAILURE + 0x70003 E_VIDEO_ RESULT_FAILURE + 0x70004 E_VIDEO_ RESULT_FAILURE + 0x70008 E_VIDEO_ RESULT_FAILURE + 0x70009 E_VIDEO_ RESULT_FAILURE + 0x120000 E_VIDEO_ RESULT_FAILURE + 0x120001 E_VIDEO_ RESULT_FAILURE + 0x120002 E_VIDEO_ RESULT_FAILURE +

malformed Item play failed,invalid session key Item play failed, insufficient user rights Item play failed, invalid item id

0xFF001

module is invalid Login timeout, no valid answer received from module

E_VIDEO_ ERROR_PLAY_INVALID_ITEM_ID E_VIDEO_ ERROR_PLAY_INVALID_ACTION_ID E_VIDEO_ ERROR_PLAY_AUTHENTIFICATION_FAILED E_VIDEO_ ERROR_PLAY_FILE_NOT_FOUND E_VIDEO_ ERROR_LOGOUT_REQUEST_MALFORMED E_VIDEO_ ERROR_LOGOUT_INVALID_SESSION_KEY E_VIDEO_ ERROR_LOGOUT_ CONTROLPANEL_DOWN E_VIDEO_ E_VIDEO_ ERROR_INVALID_IP_ADDRESS ERROR_LOGIN_TIMEOUT_NO_ANSWER_FRO M_MODULE E_VIDEO_ ERROR_LOGIN_INVALID_DATA_FROM_MODU LE E_VIDEO_ ERROR_LOGOUT_TIMEOUT_NO_ANSWER_FR OM_MODULE E_VIDEO_ ERROR_LOGOUT_INVALID_DATA_FROM_MOD ULE

E_VIDEO_ RESULT_FAILURE + 0xFF006 E_VIDEO_ RESULT_FAILURE + 0xFF007 E_VIDEO_ RESULT_FAILURE + 0xFF008 E_VIDEO_ RESULT_FAILURE + 0xFF009

Item play failed, invalid action id Item play failed, authentication failed Item play failed, file not found Logout failed, request malformed Logout failed, invalid session key System logout failed, CP link is down, Server logout succeeded The IP address of the selected

Login error, data received from module is invalid Logout timeout, no valid answer received from module Logout error, data received from module is invalid

Page 64 of 64