User manual. Misterhouse

Transcription

1 DSC Alarm PC5401 Serial Module User manual Misterhouse DSC Alarm PC5401 Serial Module Version

2 DSC Alarm PC5401 Serial Module AUTHOR Gaétan Lord Jocelyn Brouillard

3 TABLE OF CONTENTS Page 1 INTRODUCTION HARDWARE INSTALLATION PC5401 SERIAL MODULE Baud Rate Selection Module connection LEDs Indicator SERIAL CABLE MISTERHOUSE INTEGRATION MH.PRIVATE.INI CONFIGURATION MH.PRIVATE.INI Configuration File Example DSC SERIAL MODULE PERL LIBRARY Command List and Data Format PERL PROGRAMMING EXAMPLE Basic WEB INTERFACE LOGS DSC MESSAGES ERROR MESSAGES RESTRICTIONS...14 /3

4 TABLES Table 1 - Baud Rate Selection...2 Table 2 - LEDs Indicator...3 Table 3 - MH DSC functions...7 Table 4 - Command List and Format...8 Table 5 - DSC Messages Description and Format...12 Table 6 - Errors Messages Description...13 FIGURES Figure 1 - PC5401 Board Component...3 Figure 2 - Serial Cable...3 /4

5 CHANGE HISTORY Change Description Date Version By Manual creation Jocelyn B. First general review and adding comments Gaetan L. Formatting Gaetan comments and complete first release Jocelyn B. /5

6 1 INTRODUCTION That document present the integration between Misterhouse and DSC Alarm System via its PC5401 serial module. This information and Perl code replace old code (code/public/dsc_pc5401.pl) included in the MH release 2.97 posted on 01/23/2005. Warnings: This document is our first release and some mistake can exist. DSC Alarm PC5401 Serial Module /1

7 2 HARDWARE INSTALLATION Warnings: Before installation of PC5401 Serial Module Remove existing PC5400 Printer Module (With panel powered down) Enable DSC Alarm Supervision (function 902) Now install PC5401 Serial Module (With panel powered down) Enable DSC Alarm Supervision (function 902) 2.1 PC5401 Serial Module For all official specification read carefully DSC documentation. Remember by adding new composite in your Alarm Panel require to calculate the Current Draw to calibrate de power requirement with panel power supply. This board require: 35mA Notes: Its recommended, that all DSC Alarm equipments installation must be done by an authorize representative (Service Persons Only) Warnings: Disconnect the AC power supply module and panel batteries before to install the new card Baud Rate Selection BAUD selection can only be changed by cycling power to the module (Default: 9600 BAUD) BAUD JP3 JP2 JP ON ON Off 9600 Off Off Off ON Off ON ON Off Off Table 1 - Baud Rate Selection DSC Alarm PC5401 Serial Module /2

8 2.1.2 Module connection DSC PC5401 JP1 JP2 JP3 RED BLK YEL GRN DSC Key Bus KEY RX TX PWR Serial DB9 Connect module to the KEYBUS With panel powered down Select desired BAUD using JP1-3 Default is 9600 Baud Connect an RS-232 cable to the application Power up the system Figure 1 - PC5401 Board Component LEDs Indicator LED Description Normal Operation Notes KEY KEYBUS Link Active GREEN Solid PWR Module Status RED Flashing (2 seconds) Solid RED: The module is NOT operating properly RX TX Serial Communication Activity Table 2 - LEDs Indicator Flashing when Receive and transmit data 2.2 Serial Cable DSC PC5401 Side 2 Red (TX) 3 Black (RX) 5 Yellow (SG) NC PC (x86) Side Jump (DCD, DSR et DTR) 7-8 Jump ensemble (CTS et RTS) 9 NC (RI) 2 Red (RX) 3 Black (TX) 5 Yellow (SG) PC5401 DB9 - Male SG - PIN DCD - 1 RX - 2 TX - 3 DTR - 4 SG - 5 DSR - 6 RTS - 7 CTS - 8 RI - 9 PC (x86) DB9 - Male PIN - SG 1 - DCD 2 - RX 3 - TX 4 - DTR 5 - SG 6 - DSR 7 - RTS 8 - CTS 9 - RI (NC = No Connect) Figure 2 - Serial Cable DSC Alarm PC5401 Serial Module /3

9 3 MISTERHOUSE INTEGRATION To integrate PC5401 into Misterhouse, first configure properly MH.PRIVATE.INI and begin your personal code with the following example files. Copy both in your personal MH code directory (ex.: /mh/code/mycode). DSC5401.pm: This example file include basic functions between the DSC Alarm panel and Misterhouse (Generic Function and communications) DSC5401_example.pl: This is the one you need to get access to the panel; this example file has 2 sections. The 1 st section present example code. The second example section is web-based event. Some of them are needed to trigger specific event, like thermostat broadcast etc. The card allow mainly passive event (no user intervention), so it listen to the serial port for information provided by the card. The module will change state regarding the information receive 3.1 MH.PRIVATE.INI Configuration There is much information in the mh.private.ini file. These allow getting a better way to display events information, every zone and user partition. The mh.private.ini configuration specifications are: User number need 4 digit to define them "9999" Zone number need 3 digit "999" Partition number need 1 digit "9" 3 parameters are required to tell interface specification configuration and module start-up name And 5 parameters to tell which information you want to put in the log file. Description Syntax Option Module start-up name DSC_5401_module=DSC5401 None Define which serial port for interfacing PC5401 in MH. DSC_5401_serial_port=/dev/ttyM5 Specify the communication speed. DSC_5401_baudrate=XXXX If you enable it, DSC alarm broadcast his time every 4 minutes, see command table (056) and message table for (550) events. Note: this Option must be activate, by default is Off DSC_5401_time_log=X On/Off (1,0) If you have the escort module, it will write in the log when a phone ring is detected, see message table for (560) event. DSC_5401_ring_log=X On/Off (1,0) DSC Alarm PC5401 Serial Module /4

10 If you enable it, DSC Thermostat broadcast his temperature every 1 minutes Note: this Option must be activate, by default is Off DSC_5401_temp_log=X On/Off (1,0) DSC_5401_part_log=1 If you want to see partition status (even when alarm is no on) DSC_5401_part_log=X On/Off (1,0) DSC_5401_zone_log=1 if you want to see zone status DSC_5401_zone_log=X On/Off (1,0) MH.PRIVATE.INI Configuration File Example Section Setup Options Partitions Dfiiti Users Definition Zones Definition MH.PRIVATE.INI Parameters DSC_5401_module=DSC5401 DSC_5401_serial_port=/dev/ttyM5 DSC_5401_baudrate=9600 DSC_5401_time_log=1 DSC_5401_ring_log=1 DSC_5401_temp_log=1 DSC_5401_part_log=1 DSC_5401_zone_log=1 DSC_5401_part_1=Home DSC_5401_part_2=Garage DSC_5401_user_0001=Mary DSC_5401_user_0003=Tom DSC_5401_user_0040=MisterHouse DSC_5401_zone_001=Front Door Contact DSC_5401_zone_002=Side Door Contact DSC_5401_zone_003=Upstair Motion Detector DSC_5401_zone_004= Basement Motion Detector DSC_5401_zone_005=First Floor Motion Detector DSC Alarm PC5401 Serial Module /5

11 3.2 DSC Serial Module Perl Library To enable PC5401.pm file (Generic Function and communication setup) you have to put the following 2 lines in a "MyPersonalNewCode.pl" file. use DSC5401 $DSC= new DSC5401; All most information we can get from your example code are: Zone status Partition status Triger some information brodcast like Time and Tempurature (required Escort module and thermostat) Arm, Disarm, Alarm and which user The majority of specific request can be made by a call {}. The function $DSC->{zone_now}, call a subroutine zone_now in PC5401.pm file. This will return the element content of the present hash. On the other hand, a call such with specify the zone number must be this way $DSC->status_zone(1) cannot be done with { and } character. When Misterhouse finished its MH pass, the actual value will be transfer in specific state by: $DSC->{zone_now} ==> $DSC->zone(3) $DSC->{zone_now_msg} ==> $DSC->zone_msg(3) $DSC->{zone_now_status} ==> $DSC->zone_status(3) All this information is available via a function call like $DSC->{FunctionName}. Syntax: $DSC->FunctionName(Zone#) Example: $DSC->status_zone(12) This will be return the zone 12 status DSC Alarm PC5401 Serial Module /6

12 The FunctionName value is the status command requested. There is a lot of state you could query: Function Name zone_now(zone #) zone_now_msg(zone #) zone_now_status(zone #) zone_msg(zone #) zone_status( Zone #) zone_time( Zone #) zone_epoch(zone #) partition_now User cmd_list Description Return the present status, before the pass is finish (see notes bellow) Return message about zone (see notes bellow) Return the current zone state open, close, etc..., (see notes bellow) Last message about zone number, ex.: $DSC->zone_msg(3) The current zone state (open, close, etc), ex.: $DSC->zone_status(3) The time this state occurs (human form), ex.: $DSC->zone_time(3) The time in second since Jan 1970, ex.: $DSC->zone_epoch(3) Table 3 - MH DSC functions All call with "Now Function Name" are single pass. After the information is kept in the other zone variable the functions are reset to his default value (see ResetDscState function for more details). Example; let say zone 3 is now open and then in your "pl" file: $DSC->{zone_now) will return 3 $DSC->{zone_now_msg} will return a message about what happens on the zone $DSC->{zone_now_status} will return the status of the zone (open, close, etc.) Command List and Data Format For more description about all commands refer to DSC PC5401 Developer s Guide. Name Number Data Length Data Format Poll StatusReport SetDateTime hhmmmmddyy CommandOutputControl 020 2? PartitionArmControl Partition (1-8) PartitionArmControlStayArm Partition (1-8) PartitionArmControlZeroEntryDelay Partition (1-8) PartitionArmControlWithCode Partition (1-8)+Code(6 digit) PartitionDisarmControl Partition (1-8)+Code(6 digit) DSC Alarm PC5401 Serial Module /7

13 VerboseArmingControl On/Off (1,0) TimeStampControl On/Off (1,0) TimeBroadcastControl On/Off (1,0) TemperatureBroadcastControl On/Off (1,0) TriggerPanicAlarm Fire (1) Ambulance (2) Police (3) CodeSend Access Code(6 digit) Table 4 - Command List and Format 3.3 Perl Programming Example Basic Code Example If ( my $ZoneEvent = $DSC->zone_now ) { print_log "DSC->zone_now $ZoneEvent"; } if ( $DSC->zone_now =~ /FrontDoor/ && $DSC- >status_zone('012') eq "open" ) { Speak("Front Door is open"); } if ( my $PartState = $DSC->partition_now ) { print_log "DSC->partition_now $PartState"; } If ( my $AlarmState = $DSC->state_now ) { print_log "DSC->state_now Alarm system is now $AlarmState"; } if ( $DSC->state_now =~ /^disarmed/ && $DSC->user eq "Mary") { Speak("Hello Mary"); } Descriptions This will be trigger the zone status This will monitor zone 12 for open state and calling an external voice function. This will be trigger the Partition status This will be trigger the Alarm state This will monitor User Mary when she disarm the panel and calling an external voice function. 3.4 WEB Interface Because we don't have web page, so far, the only way to get to the code written in DSC5401_Example.pl file is by going the following path. By using the ia5 interface: Go under MrHouse Home icon DSC Alarm PC5401 Serial Module /8

14 Pick Browser Categories icon Pick Alarm icon There you should be able to correlate whit what you have in DSC5401_example file. $v_alarm_cmd_list = new Voice_Cmd "List all DSC panel command"; $DSC->cmd_list if said $v_alarm_cmd_list; $v_alarm_poll = new Voice_Cmd "Poll PC5401 card"; $DSC->cmd("000") if said $v_alarm_poll; $v_alarm_partition_arm = new Voice_Cmd "Arm partition 1 without access code"; $DSC->cmd("PartitionArmControl",1) if said $v_alarm_partition_arm; # here you have to give the user access code, replace #### with the access code # note this is not secure # 033 $v_alarm_partition_arm_code = new Voice_Cmd "Arm partition 1 with code"; $DSC->cmd("PartitionArmControlWithCode","1","####") if said $v_alarm_partition_arm_code; # here you have to give the user access code, replace #### with the access code # note this is not secure # 040 $v_alarm_partition_disarm = new Voice_Cmd "Disarm partition 1 with code"; $DSC->cmd("PartitionDisarmControl","1","####") if said $v_alarm_partition_disarm; # 050 $v_alarm_verbose_arming = new Voice_Cmd "Verbose arming message [0,1]"; $DSC->cmd("VerboseArmingControl",$state) if $state = said $v_alarm_verbose_arming; # 056 $v_alarm_time_broadcast = new Voice_Cmd "Periodical Time Message [0,1]"; $DSC->cmd("TimeBroadcastControl",$state) if $state = said $v_alarm_time_broadcast; # 057 $v_alarm_temp_broadcast_on = new Voice_Cmd "Periodical Temp Message ON"; $DSC->cmd("TemperatureBroadcastControl",1) if said $v_alarm_temp_broadcast_on; $v_alarm_temp_broadcast_off = new Voice_Cmd "Periodical Temp Message OFF"; $DSC->cmd("TemperatureBroadcastControl",0) if said $v_alarm_temp_broadcast_off; DSC Alarm PC5401 Serial Module /9

15 # 010 $v_alarm_set_time_date = new Voice_Cmd "Set Alarm system to the current computer time"; if (said $v_alarm_set_time_date) { my ($sec,$m,$h,$mday,$mon,$year,$wday,$yday,$isdst) = localtime(time); $year = sprintf("%02d", $year % 100); $mon+=1; $m=($m<10)?"0".$m:$m; $h=($h<10)?"0".$h:$h; $mday=($mday<10)?"0".$mday:$mday; $mon=($mon<10)?"0".$mon:$mon; my $TimeStamp="$h$m$mon$mday$year"; &::print_log("setting time on DSC panel to $TimeStamp"); &::logit( "$main::config_parms{data_dir}/logs/dsc5401.$main::year_month_now.log", "Setting time on DSC panel to $TimeStamp" ); $DSC->cmd("SetDateTime",$TimeStamp); } 3.5 Logs There is a log file created for every month, which will contains all DSC events. DSC Alarm PC5401 Serial Module /10

16 4 DSC MESSAGES For more description about all messages refer to DSC PC5401 Developer s Guide. Title Number Data Length Data Format Command Acknowledge Last Command Number (999) Command Error System Error Error code ( ) Time/Date Broadcast hhmmmmddyy Ring Detected Indoor Temperature Broadcast Thermostat (1-4)+Temps(999) Outdoor Temperature Broadcast Thermostat (1-4)+Temps(999) Zone Alarm Partition(1-8)+Zone( ) Zone Alarm Restore Partition(1-8)+Zone( ) Zone Tamper Partition(1-8)+Zone( ) Zone Tamper Restore Partition(1-8)+Zone( ) Zone Fault Zone( ) Zone Fault Restore Zone( ) Zone Open Zone( ) Zone Restored Zone( ) Duress Alarm 620 4? Fire Key Alarm Fire Key Restore Auxiliairy Key Alarm Auxiliairy Key Restore Panic Key Alarm Panic Key Restore Wire Smoke Alarm Wire Smoke Restore Partition Ready Partition(1-8) Partition Not Ready Partition(1-8) Partition Armed Partition(1-8)+Mode(0-3) Partition in Alarm Partition(1-8) Partition Disarmed Partition(1-8) Exit Delay in Progress Partition(1-8) Entry Delay in Progress Partition(1-8) Keypad Lock-Out Partition(1-8) Invalid Code Access Partition(1-8) DSC Alarm PC5401 Serial Module /11

17 Function Not Available Partition(1-8) User Closing Partition(1-8)+User( ) Special Closing Partition(1-8) Partial Closing Partition(1-8) User Opening Partition(1-8)+User( ) Special Opening Partition(1-8) Panel Battery Trouble Panel Battery Trouble Restore Panel AC Trouble Panel AC Restore System Bell Trouble System Bell Trouble Restoral TLM Trouble TLM Trouble Restore TLM Trouble Line TLM Trouble Restore Line FTC Trouble Buffer Near Full Device Low Battery Zone( ) Device Low Battery Restore Zone( ) Wireless Key Low Battery Trouble Key( ) Wireless Key Low Battery Trouble Restore Key( ) Handheld Keypad Low Battery Alarm HHK( ) Handheld Keypad Low Battery Alarm Restore HHK( ) General System Tamper General System Tamper Restore Home Automation Trouble Home Automation Trouble Restore Trouble Status Partition(1-8) Trouble Status Restore Partition(1-8) Fire Trouble Alarm Fire Trouble Alarm Restore Code Required Table 5 - DSC Messages Description and Format DSC Alarm PC5401 Serial Module /12

18 4.1 Error Messages Number Description 000 No Error 001 RS-232 Receive Buffer Overrun 002 RS-232 Receive Buffer Overflow 003 Keybus Transmit Buffer Overrun 010 Keybus Transmit Buffer Overrun 011 Keybus Transmit Time Timeout 012 Keybus Transmit Mode Timeout 013 Keybus TRansmit Keystring Timeout 014 Keybus Not Fonctionning 015 Keybus Busy (attempting arm or disarm) 016 Keybus Busy - Lockout ( too many disarm) 017 Keybus Busy - Insntallers Mode 020 API Command Syntax Error 021 API Command Partition Error (partition out of bound) 022 API Command Not Supported 023 API System Not Armed 024 API System Not Ready To Arm 025 API Command Invalid Length 026 API User Code not Required 027 API Invalid Characters in Command Table 6 - Errors Messages Description DSC Alarm PC5401 Serial Module /13

19 5 RESTRICTIONS There is no way to manage the X10 or thermostat via Escort Module. I will explain why: The 5401 sends and reads information from the keybus. Since the X10 and thermostat are processed through the Escort, we cannot send a command directly. DSC Alarm PC5401 Serial Module /14