Alarm Panel Standardization

Revision as of 10:11, 24 May 2011

S_AlarmPartition2.xml

Download file (latest version): S_AlarmPartition2.xml

Required UPnP variables

ArmMode

Type: string

Allowed values:

• Disarmed
• Armed

Description:

The High Level State of the Partition, representing whether it's Armed or Disarmed.

Partition implementations are only required to implement the "Armed" and "Disarmed" states since not every Panel provides the ability to "see" the other statuses and reflect them to the UPnP consumer.

Disarmed - The Partition is in an un-armed state, and ready to be Armed.

Armed - The Partition is currently armed, or in an "away" state.

DetailedArmMode

Type: string

Allowed values:

• Disarmed
• Armed
• Stay
• StayInstant
• Night
• NightInstant
• Force
• Ready
• Vacation
• NotReady
• FailedToArm
• EntryDelay
• ExitDelay

Description:

The Detailed state of the Partition, representing whether it's Armed, Disarmed or one of the common intermediary states.

Partition implementations are required to implement the "Armed" and "Disarmed" states, corresponding to the State variable above. Not every Panel provides the required API to "see" the other statuses and reflect them to the UPnP consumer.

Note that some implementations may consider the "ExitDelay" state to be "Armed" whilst others may consider them to be "Disarmed". No association between DetailedArmMode and State variables should be assumed by UPnP clients, due to this potential difference.

Some of the states may be transitional, and no guarantees are provided that the Panel will complete any subsequent transition to a corresponding permanent state. UPnP clients should make no assumptions about the "next state" from what is immediately presented, since this may be Vendor and/or Implementation specific.

Some of the states, like Night/NightInstant and Vacation, are included for specific Panel vendors like the Elk and may not be present on other Panels. Control Point authors should be prepared to display these DetailedArmMode using an CP-specific visualization (an Icon, Translated Text and so-on)

Disarmed - The Partition is disarmed.

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.

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.

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.

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.

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.

EntryDelay - The Partition is currently moving towards the Disarmed state.

ExitDelay - The Partition is currently moving towards the Armed state.

Alarm

Type: string

Allowed values:

• None
• Active

Description:

An indicator of whether the Partition is in Alarm state or not.

Partition implementations are only required to implement the "None" and "Active" states.

Many alarm systems will "automatically" clear a Alarm state after some, often legally mandated, period of time. If this happens, the Partition should move to the "None" 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.

Active - The Partition is currently showing as an Alarm actively going off.

ChimeEnabled

Type: boolean

Allowed values:

• None
• Active

Default value: false

Description:

An indicator of whether the Partition has Chime mode enabled.

Some Alarm Systems (DSC, Paradox, GE Caddx) can run in a mode where each Zone 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 Partition.

If the Panel supports intraspection of this property, then the value should be brought forward. Some panels (Paradox) support the setting, but don't support the intraspection of the setting. In these cases, the Partition implementation must return "false" for this attribute.

true - The Partition is in Chime mode, and will ring a Bell when Zones are opened.

false - Chimes are disabled. No chime/sound will occur when a Zone is opened.

   <stateVariable sendEvents="yes" allowRepeats="yes">
     <name>AlarmMemory</name>
     <dataType>boolean</dataType>
     <shortCode>alarmmemory</shortCode>
   </stateVariable>

   <stateVariable sendEvents="yes">
     <name>LastAlarmActive</name>
     <dataType>ui4</dataType>
     <shortCode>lastalarmactive</shortCode>
     <defaultValue>0</defaultValue>
   </stateVariable>

   <stateVariable sendEvents="yes" allowRepeats="yes">
     <name>LastUser</name>
     <dataType>string</dataType>
     <shortCode>lastuser</shortCode>
     <defaultValue></defaultValue> 
   </stateVariable>

   <stateVariable sendEvents="yes" allowRepeats="yes">
     <name>VendorStatus</name>
     <dataType>string</dataType>
     <shortCode>vendorstatus</shortCode>
     <defaultValue></defaultValue>
   </stateVariable>

   <stateVariable sendEvents="yes" allowRepeats="yes">
     <name>VendorStatusCode</name>
     <dataType>string</dataType>
     <shortCode>vendorstatuscode</shortCode>
   </stateVariable>

   <stateVariable sendEvents="yes" allowRepeats="yes">
     <name>VendorStatusData</name>
     <dataType>string</dataType>
     <shortCode>vendorstatusdata</shortCode>
   </stateVariable>
 </serviceStateTable>
<actionList>
   <action>
     <name>RequestArmMode</name>
     <argumentList>
       <argument>
         <name>State</name>
         <direction>in</direction>
         <relatedStateVariable>DetailedArmMode</relatedStateVariable>
       </argument>
       <argument>
         <name>PINCode</name>
         <direction>in</direction>
         <relatedStateVariable>ui4</relatedStateVariable>
       </argument>
     </argumentList>
   </action>

   <action>
     <name>RequestQuickArmMode</name>
     <argumentList>
       <argument>
         <name>State</name>
         <direction>in</direction>
         <relatedStateVariable>DetailedArmMode</relatedStateVariable>
       </argument>
     </argumentList>
   </action>

   <action>
     <name>RequestPanicMode</name>
     <argumentList>
       <argument>
         <name>State</name>
         <direction>in</direction>
         <relatedStateVariable>string</relatedStateVariable>
       </argument>
     </argumentList>
   </action>
 </actionList>

</scpd>