| 47 | | After setting these variables, close the dialog and hit the 'Save' icon. Luup will restart and the plugin will create one subdevice for each parition and zone. |
| | 33 | |
| | 34 | == Terminology == |
| | 35 | Zone:: |
| | 36 | a specific sensor in the Alarm Panel, such as a Window, Door or Motion Sensor. These may either be hardwired, or wireless, depending upon the type of sensor. |
| | 37 | Area / Partition:: |
| | 38 | a collection of Zones. Typically there is a single Area in a house. Larger houses are often split into separate Areas (Upstairs vs Downstairs). External buildings such as Garages and Guest houses are also candidates for additional Areas. |
| | 39 | Keybus:: |
| | 40 | DSC Security proprietary protocol. This protocol is used for communications between DSC System components, such as the IT100, T-Link IP modules, Zone Expanders, and the System Keypads. |
| | 41 | Remote control:: |
| | 42 | a Key chain remote control device, used to Arm (Lock), Disarm (Unlock) or set a Panic Alarm |
| | 43 | Entry Door:: |
| | 44 | a Zone (door) with a grace period delay attached to it. The Alarm will not go off during the grace period. |
| | 45 | Breach:: |
| | 46 | the Alarm is currently going off, either with a Bell, or a Silent Alarm. |
| | 47 | Arm:: |
| | 48 | the act of setting the Alarm Panel into the "I'm leaving" state. |
| | 49 | Stay Arm:: |
| | 50 | the act of setting the Alarm Panel into the "I'm staying" state. In this state the Motion Sensors don't trip Alarm Breach. |
| | 51 | Force Arm:: |
| | 52 | same as ''Arm'' except that some Zones may be left Open |
| | 53 | Instant Arm:: |
| | 54 | same as ''Stay Arm'' except there is no grace period on opening an Entry Door. |
| | 55 | Virtual PGM:: |
| | 56 | a special type of Zone defined within the Alarm Panel. The Alarm Panel can be configured to establish the conditions under which a Virtual PGM [Zone] is triggered and/or reset. Virtual PGMs events are supported in the code, but are disabled by default to make the UI simpler. |
| | 57 | One Touch or Quick Arming:: |
| | 58 | a variant on the Arming modes that typically doesn't require a PIN Code to be entered to initiate the Arming request. |
| | 59 | |
| | 60 | == Messages == |
| | 61 | Depending upon the specific model of Alarm Panel, there will be support for different numbers of Zones, and Areas. However at startup of the DSC Alarm plug-in, upon successful connection to the Alarm Panel itself, the plug-in will default to creating 6 zones (1,2,3,4,5,6) regardless of how many Zones are configured, and how they may be numbered. The Plug-in by default will also create only one partition despite how many are configured. Once basic communication has been established, it will be necessary to configure the plug-in with the respective zones and partitions. |
| | 62 | |
| | 63 | These low-level messages are varied, but include: |
| | 64 | |
| | 65 | * Retrieve a Zone Label |
| | 66 | * Retrieve a Partition Label |
| | 67 | * Read the status of a Zone (open/closed) |
| | 68 | * Read the status of an Area (armed/force-armed, stay-armed/instant-armed, alerting/breach) |
| | 69 | * Zone status change events |
| | 70 | * Zone status change events |
| | 71 | * Request Arming / Force-Arming |
| | 72 | * Request Stay-Arming / Instant-Arming |
| | 73 | * Trigger Alerting / Breach |
| | 74 | * Remote control. |
| | 75 | |
| | 76 | == The DSC Alarm Plug-in processing == |
| | 77 | |
| | 78 | === Startup processing === |
| | 79 | The Startup processing for the Alarm Panel plugin looks roughly like: |
| | 80 | * Establish Communication with the Panel |
| | 81 | * Create 1 partition and attempt to read the partition label. |
| | 82 | * Create 6 Zones as child devices in the System, and attempt to read the zone labels. |
| | 83 | * retrieve the current state of each Zone, and "set" it into Vera |
| | 84 | |
| | 85 | |
| | 86 | === Event processing === |
| | 87 | |
| | 88 | After startup, the system is set running. It receives events and, for those of interest, it translates them into !MotionSensor values to set upon it's Child Devices, in addition to setting Variables directly on the Alarm Area device |
| | 89 | |
| | 90 | |
| | 91 | During Scene creation, the following ''Events'' are exposed by each partition: |
| | 92 | * ''Partition is Armed'' |
| | 93 | * ''Partition is Stay Armed'' |
| | 94 | * ''Partition is Breached'' |
| | 95 | * ''Partition is Disarmed'' |
| | 96 | |
| | 97 | During Advanced Scene creation, the following ''Actions'' are exposed by each "Area" device: |
| | 98 | * ''Arm Partition'' - Submit a request to Arm the Alarm Partition (with PINCode) |
| | 99 | * ''Quick Arm Partition'' - Submit a request to Quick, or "!OneTouch", Arm the Alarm Partition (no PINCode required) |
| | 100 | * ''Stay Arm Partition'' - Submit a request to Stay-Arm the Alarm Partition (with PINCode) |
| | 101 | * ''Quick Stay Arm Partition'' - Submit a request to Quick, or "!OneTouch", Stay-Arm the Alarm Partition (no PINCode required) |
| | 102 | * ''Disarm Partition'' - Submit a request to Disarm the Alarm Partition (PINCode required) |
| | 103 | * ''Medical Panic'' - Submit a request to trigger the Alarm Partition's Medical Panic - UI4 and above only |
| | 104 | * ''Fire Panic'' - Submit a request to trigger the Alarm Partition's Fire Panic - UI4 and above only |
| | 105 | * ''Police Panic'' - Submit a request to trigger the Alarm Partition's Police Panic - UI4 and above only |
| | 106 | |
| | 107 | NOTE: The Alarm plugin code disables these Actions by default. They must be enabled prior to using them in a Scene definition. Since MiOS stores these scene definitions, including any Parameters supplied (eg PINCode) use of these features may constitute a security risk - use at your own risk. |
| | 108 | |
| | 109 | ==== Alarm Area Variables ==== |
| | 110 | This Alarm Panel implements a !DeviceType that gives it the following Variables (through it's !ServiceStateTable). These can be used for Luup scripting: |
| | 111 | |
| | 112 | * ''Disarmed'' - Set whenever the Alarm Area is Disarmed (not Armed and not !StayArmed) |
| | 113 | * ''Armed'' - Set when the user requests the Alarm Area to Arm, Force Arm, Stay Arm or Instant Arm the Area |
| | 114 | * ''!StayArmed'' - Set when the user request the Alarm Area to Stay Arm or Instant Arm the Area |
| | 115 | * ''Breach'' - set when the Alarm Area is in Breach (Siren, Silent etc) |
| | 116 | |
| | 117 | |
| | 118 | = Installation = |
| | 119 | |
| | 120 | |
| | 121 | * If the previous DSC plug-in was installed, then it is recommended to uninstall it first, and then remove the plug-in files from the via SSH |
| | 122 | * Before attempting to install the plug-in, its recommended to connect the respective RS232 adapter, and set this up first in order to establish connectivity. |
| | 123 | |
| | 124 | * Download the .zip file from [http://code.mios.com/trac/mios_dscalarmpanel/changeset/41/tags/0.21?old_path=%2F&format=zip this ]location |
| | 125 | * Extract the 7 files to a location on your PC. |
| | 126 | * Click the MiOS developers icon. |
| | 127 | * Click the Luup files tab |
| | 128 | * Scroll to the bottom of the window and click on the first browse button |
| | 129 | * Navigate to the location of the previously saved files and select the first file |
| | 130 | * Repeat this using additional browse buttons for the remaining 6 files. |
| | 131 | * Check the "Restart Luup after upload" box and click Go |
| | 132 | * After the Engine restarts, click on the create device tab of the MiOS developers icon. |
| | 133 | * In the "Description" field, enter a name for the plug-in, similarly in the "UpnpDevFilename" field enter "D_DSCAlarmPanel1.xml" and in the "UpnpImplFilename" field enter "I_DSCAlarmPanel1.xml" |
| | 134 | |
| | 135 | NOTE: It is critical to enter the file names exactly as above, this includes the case sensitivity! |
| | 136 | |
| | 137 | * If this is being used with a WIZnet or Roving Networks IP to Serial adapter that’s already been configured, then at this stage the IP and port number of the device can also be entered in the IpAddress field |
| | 138 | * Click Create device and then exit |
| | 139 | |
| | 140 | [[Image(createdevice.png, align=center,50%)]] |
| | 141 | |
| | 142 | NOTE: when the engine finishes loading, and an IP address was entered, then hopefully if everything is working correctly, there should now be 8 new devices created which will be the Panel (parent) 1 partition and 6 Zones. |
| | 143 | |
| | 144 | If the IT100 has been connected to a USB to RS232 converter then this will now need to be set up as follows: |
| | 145 | |
| | 146 | * Presuming the Adapter has already been plugged in and recognized as a device and port in the MiOS developers / Serial tab. |
| | 147 | * Select the correct Serial device, and enter the following settings which represents the default IT100 baud rate. |
| | 148 | |
| | 149 | [[Image(232.png, align=center)]] |
| | 150 | |
| | 151 | * In the "Used by Device" dropdown, select the name of the devices that was created earlier. |
| | 152 | * Exit this screen and then Save. |
| | 153 | * Again if everything is working, the 8 devices should have been created. |
| | 154 | |
| | 155 | = Additional setup = |
| | 156 | |
| | 157 | * To configure the correct Partitions and Zones, select the parent device (as named during the creation process). |
| | 158 | * Click the advanced tab |
| | 159 | * Under Partitions by default there will be "1" present, if additional partitions are to be set up then enter them in sequential manner separated by a comma as follows: |
| | 160 | For two partitions enter "1,2" |
| | 161 | For three partitions enter "1,2,3) etc etc... |
| | 162 | |
| | 163 | Under the different Zone fields, enter the zone numbers in the same type of sequence. By default it will display "1,2,3,4,5,6" in "DoorZones" |
| | 164 | Note you will need to know which Zones are set up which on your panel. They may not be in sequence (per the above), and can be entered depending on their type in any of the three Zone variables. |
| | 165 | |
| | 166 | If remote Arming and Disarming is not required from Vera, then exit and save; however if this is required then stay in this screen and enter one of the following into the "EnableRemoteArm" variable: |
| | 167 | |
| | 168 | * disarm (Least secure as all functions are available including disarm) |
| | 169 | * stay (This will enable stay arming and away arming, but not disarm) |
| | 170 | * arm (Will only enable away mode arming) |
| | 171 | |
| | 172 | |
| | 173 | NOTE: "disarm" is the least secure and enables all remote arming features. |
| | 174 | |
| | 175 | After entering any of the above, exit and save. |
| | 176 | |
| | 177 | To set the time on the panel, in the main tab of the device, enter your PIN and click "Set Time" |
| | 178 | |
| | 179 | |
| | 180 | = Discussion = |
| | 181 | |
| | 182 | |
| | 183 | * [http://forum.micasaverde.com/index.php?topic=5154.0 Main thread] |
| | 184 | * [http://forum.micasaverde.com/index.php?topic=5794.0 Serial adapter discussion] |
| | 185 | * [http://forum.micasaverde.com/index.php?topic=3713.0 Standardization effort) |
| | 186 | |
| | 187 | |
| | 188 | = References = |
| | 189 | * [http://cms.dsc.com/download.php?t=1&id=10910 IT100 developer guide] |
| | 190 | * [http://www.lua.org/manual/5.1 Lua 5.1 Reference Manual] |
| | 191 | * [http://lua-users.org/wiki/LuaTutorial Lua-users Lua Tutorial] |
| | 192 | |
| | 193 | [[Image(room.png, align=Center,100%)]] |
