Alarm Panel Standardization - Revision history

Henk: Alarm Panel Sandardization moved to Alarm Panel Standardization: character omission

2011-05-24T13:46:15Z

Alarm Panel Sandardization moved to Alarm Panel Standardization: character omission

Henk at 13:45, 24 May 2011

2011-05-24T13:45:26Z

Mcvflorin: /* S_AlarmPartition2.xml */

2011-05-24T13:16:08Z

‎S_AlarmPartition2.xml

Mcvflorin: /* S_AlarmPartition2.xml */

2011-05-24T13:10:31Z

‎S_AlarmPartition2.xml

Mcvflorin at 10:44, 24 May 2011

2011-05-24T10:44:18Z

Mcvflorin at 10:42, 24 May 2011

2011-05-24T10:42:05Z

Mcvflorin at 10:37, 24 May 2011

2011-05-24T10:37:42Z

Show changes

Mcvflorin at 10:23, 24 May 2011

2011-05-24T10:23:57Z

Mcvflorin at 10:20, 24 May 2011

2011-05-24T10:20:44Z

Mcvflorin at 10:11, 24 May 2011

2011-05-24T10:11:55Z

@@ Line 1: / Line 1: @@
-Forum thread: http://forum.micasaverde.com/index.php?topic=3713.0
+[[Category:Development]]
+[[Category:Plugins]]
 == S_AlarmPartition2.xml ==
@@ Line 338: / Line 338: @@
 ''Medical'' - The Medical Panic mode

@@ Line 4: / Line 4: @@
 == S_AlarmPartition2.xml ==
-Download file (latest version): [http://code.mios.com/svn/mios_common-alarm-plugin-files/S_AlarmPartition2.xml S_AlarmPartition2.xml]
+Download file (latest version): [http://code.mios.com/svn_public/mios_common-alarm-plugin-files/S_AlarmPartition2.xml S_AlarmPartition2.xml]
 === UPnP Variables ===

@@ Line 4: / Line 4: @@
 == S_AlarmPartition2.xml ==
-Download file (latest version): [[Media:S_AlarmPartition2.zip|S_AlarmPartition2.zip]]
+Download file (latest version): [http://code.mios.com/svn/mios_common-alarm-plugin-files/S_AlarmPartition2.xml S_AlarmPartition2.xml]
 === UPnP Variables ===

← Older revision		Revision as of 10:44, 24 May 2011
Line 1:		Line 1:
		+	Forum thread: http://forum.micasaverde.com/index.php?topic=3713.0
		+
		+
	== S_AlarmPartition2.xml ==		== S_AlarmPartition2.xml ==

@@ Line 1: / Line 1: @@
 == S_AlarmPartition2.xml ==
-Download file (latest version): [[Media:S_AlarmPartition2.xml|S_AlarmPartition2.xml]]
+Download file (latest version): [[Media:S_AlarmPartition2.zip|S_AlarmPartition2.zip]]
 === UPnP Variables ===

@@ Line 157: / Line 157: @@
 it's "AlarmMemory" state.
-true - A prior Alarm state occurred, but it has since cleared
+''true'' - A prior Alarm state occurred, but it has since cleared
-false - No prior Alarm state is known, or the Prior Alarm condition has been cleared.
+''false'' - No prior Alarm state is known, or the Prior Alarm condition has been cleared.
 ==== LastAlarmActive ====
@@ Line 177: / Line 177: @@
 value for this StateVariable.
-- Default value if "Memory" is not supported, or if no prior record of Alarm.
+''0'' - Default value if "Memory" is not supported, or if no prior record of Alarm.
 ==== LastUser ====
@@ Line 217: / Line 217: @@
 a UPnP client's native display.
-    <stateVariable sendEvents="yes" allowRepeats="yes">
+==== VendorStatusCode ====
-      <name>VendorStatus</name>
-      <dataType>string</dataType>
-      <shortCode>vendorstatus</shortCode>
-      <defaultValue></defaultValue>
-    </stateVariable>
-    <!-- The Vendor Status Code indicated by the Partition.
+'''Description''':
-      An Alarm/Vendor-specific string representing the internal Status "code" last
+The Vendor Status Code indicated by the Partition.
-      indicated by the Partition.
-      This string may also show the Last status (label) of the Alarm Panel, and can be used
+An Alarm/Vendor-specific string representing the internal Status "code" last
-      by UPnP Clients to display "progress" or current state.
+indicated by the Partition.
-      These can also be used by "events" to provide Partition-specific mechanisms to
+This string may also show the Last status (label) of the Alarm Panel, and can be used
-      trigger things like "Fail to Arm" events and the like.
+by UPnP Clients to display "progress" or current state.
-      eg. "1378" (Elk) - "Rule Triggered Voice Telephone Dial"
+These can also be used by "events" to provide Partition-specific mechanisms to
-      eg. "658" (DSC) - "Keypad Lock-out"
+trigger things like "Fail to Arm" events and the like.
-      eg. "040" (Paradox) - "Fail to Communicate on telephone Number"
-      A Partition implementation may choose to blank-out the value of this stateVariable,
+eg. "1378" (Elk) - "Rule Triggered Voice Telephone Dial"
-      after any time period that seems reasonable, to meet local security requirements.
-      The string value is intended to be used for Vendor specific scripting purposes.  Consult
+The Vendor Status Data for the Vendor Status Code.
-      your specific Vendor for the set of Valid Vendor Status codes.
-    -->
-    <stateVariable sendEvents="yes" allowRepeats="yes">
-      <name>VendorStatusCode</name>
-      <dataType>string</dataType>
-      <shortCode>vendorstatuscode</shortCode>
-    </stateVariable>
-    <!-- The Vendor Status Data for the Vendor Status Code.
+The string value is intended to be used for Vendor specific scripting purposes.  Consult
-      An Alarm/Vendor-specific string representing the internal state "data", associated with
+=== Actions ===
-      the Vendor Status Code above.
   <actionList>
      <!-- Request the Partition move into a named Arming mode, using a specific PIN Code..

@@ Line 12: / Line 12: @@
 * Disarmed
 * Armed
 '''Description''':
@@ Line 43: / Line 45: @@
 * EntryDelay
 * ExitDelay
 '''Description''':
@@ Line 100: / Line 104: @@
 * None
 * Active
 '''Description''':
@@ Line 119: / Line 125: @@
 '''Type''': boolean
 '''Default value''': false
@@ Line 144: / Line 146: @@
 ''false'' - Chimes are disabled.  No chime/sound will occur when a Zone is opened.
-    <!-- An indicator of whether the Partition has previously been in an Alarm state.
+An indicator of whether the Partition has previously been in an Alarm state.
-      Each Panel, has a Panel-specific mechanism through which it will transition/clear
+Each Panel, has a Panel-specific mechanism through which it will transition/clear
-      it's "AlarmMemory" state.
+it's "AlarmMemory" state.
-      true - A prior Alarm state occurred, but it has since cleared
+true - A prior Alarm state occurred, but it has since cleared
-      false - No prior Alarm state is known, or the Prior Alarm condition has been cleared.
-    -->
-    <stateVariable sendEvents="yes" allowRepeats="yes">
-      <name>AlarmMemory</name>
-      <dataType>boolean</dataType>
-      <shortCode>alarmmemory</shortCode>
-    </stateVariable>
-    <!-- An indicator of when the Partition last entered "Active" state.
+==== LastAlarmActive ====
-      Not all Alarm systems support the information necessary to know that a Alarm has been
+'''Type''': ui4
-      "reset" distinctly from it being "cleared" by some automated means.
-      If any implementation returns "Memory", for Alarm, then it must supply a non-Zero
+'''Default value''': 0
-      value for this StateVariable.
-- Default value if "Memory" is not supported, or if no prior record of Alarm.
+'''Description''':
-      TODO: represented as seconds past epoch???
-    -->
-    <stateVariable sendEvents="yes">
-      <name>LastAlarmActive</name>
-      <dataType>ui4</dataType>
-      <shortCode>lastalarmactive</shortCode>
-      <defaultValue>0</defaultValue>
-    </stateVariable>
-    <!-- The Last User to initiate an event against the Partition.
+Not all Alarm systems support the information necessary to know that a Alarm has been
-      An Alarm-specific string representing the "User" who last initiated a command against
+If any implementation returns "Memory", for Alarm, then it must supply a non-Zero
-      the Partition (typically, but not necessarily) via a Keypad input to the Panel.
+value for this StateVariable.
-      Partitions that don't support the notion of "Users" should leave this blank.
+- Default value if "Memory" is not supported, or if no prior record of Alarm.
-      A Partition implementation may choose to blank-out the value of this stateVariable,
+==== LastUser ====
-      after any time period that seems reasonable, to meet local security requirements.
-    -->
+'''Type''': string
-    <stateVariable sendEvents="yes" allowRepeats="yes">
-      <name>LastUser</name>
+'''Description''':
-      <dataType>string</dataType>
-      <shortCode>lastuser</shortCode>
+The Last User to initiate an event against the Partition.
-      <defaultValue></defaultValue>
-    </stateVariable>
+An Alarm-specific string representing the "User" who last initiated a command against
-    <!-- The Vendor Status (label) indicated by the Partition.
+An Alarm/Vendor-specific string representing the Human readable "Status" last indicated
-      An Alarm/Vendor-specific string representing the Human readable "Status" last indicated
+This string may also show the Last status (label) of the Alarm Panel, and can be used
-      by the Partition.
+by UPnP Clients to display "progress" or current state.
-      This string may also show the Last status (label) of the Alarm Panel, and can be used
+eg. "Password not valid", "George's home is Arming", "Zones in Bypass 003, 004"
-      by UPnP Clients to display "progress" or current state.
-      eg. "Password not valid", "George's home is Arming", "Zones in Bypass 003, 004"
+A Partition implementation may choose to blank-out the value of this stateVariable,
-      A Partition implementation may choose to blank-out the value of this stateVariable,
+The string value is intended to be Human readable, as it may be presented within
-      after any time period that seems reasonable, to meet local security requirements.
+a UPnP client's native display.
      <stateVariable sendEvents="yes" allowRepeats="yes">
        <name>VendorStatus</name>

@@ Line 67: / Line 67: @@
 Translated Text and so-on)
-Disarmed - The Partition is disarmed.
+''Disarmed'' - The Partition is disarmed.
-Armed - The Partition is currently armed, or in an "away" state.
+''Armed'' - The Partition is currently armed, or in an "away" state.
-Stay - The Partition is in an "at-home" state, delays are permitted on Entry doors.
+''Stay'' - The Partition is in an "at-home" state, delays are permitted on Entry doors.
-StayInstant - The Partition is in an "at-home" state, Entry doors trigger Alarm immediately.
+''StayInstant'' - The Partition is in an "at-home" state, Entry doors trigger Alarm immediately.
-Night - The Partition is in an "at-home, at-night" state, delays are permitted on Entry doors.
+''Night'' - The Partition is in an "at-home, at-night" state, delays are permitted on Entry doors.
-NightInstant - The Partition is in an "at-home, at-night" state, Entry doors trigger Alarm immediately.
+''NightInstant'' - The Partition is in an "at-home, at-night" state, Entry doors trigger Alarm immediately.
-Force - The Partition is in an "away" state, but one or more Zones are open.
+''Force'' - The Partition is in an "away" state, but one or more Zones are open.
-Ready - The Partition is in an un-armed state, and ready to be Armed.
+''Ready'' - The Partition is in an un-armed state, and ready to be Armed.
-Vacation - The Partition is currently armed, or in an "away" state.
+''Vacation'' - The Partition is currently armed, or in an "away" state.
-NotReady - The Partition is in an un-armed state, but one or more Zones are open.
+''NotReady'' - The Partition is in an un-armed state, but one or more Zones are open.
-FailedToArm - The Partition is in an un-armed state, and an arming attempt just failed.
+''FailedToArm'' - The Partition is in an un-armed state, and an arming attempt just failed.
-EntryDelay - The Partition is currently moving towards the Disarmed state.
+''EntryDelay'' - The Partition is currently moving towards the Disarmed state.
-ExitDelay - The Partition is currently moving towards the Armed state.
+''ExitDelay'' - The Partition is currently moving towards the Armed state.
 ==== Alarm ====
@@ Line 112: / Line 112: @@
 state, but also has the option of setting the "AlarmMemory" state.
-None - The Partition is not currently in Alarm, and no prior record of Alarm.
+''None'' - The Partition is not currently in Alarm, and no prior record of Alarm.
-Active - The Partition is currently showing as an Alarm actively going off.
+''Active'' - The Partition is currently showing as an Alarm actively going off.
-    <!-- An indicator of whether the Partition has Chime mode enabled.
+==== ChimeEnabled ====
-      Some Alarm Systems (DSC, Paradox, GE Caddx) can run in a mode where each Zone
+'''Type''': boolean
-      that's opened will trigger a Chime, or Bell, to ring for a short period of
-      time.  This setting is independant of any Armed or Disarmed state of the
+'''Allowed values''':
-      Partition.
+* None