Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancements for Security System Support (DSC) and "Tripped" State Bug Fix #135

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Enhancements for Security System Support (DSC) and "Tripped" State Bug Fix #135

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
792aa45
Add support for security system target states for DSC panels
joshsnelling Apr 21, 2020
bc64189
Fix security system state handling when reporting the triggered state…
joshsnelling Apr 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
101 changes: 81 additions & 20 deletions EPS HomeKit Bridge.indigoPlugin/Contents/Server Plugin/lib/homekit.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2361,40 +2361,101 @@ def special_SenseMeLightToggle (self, classes, sourceDict, getter, characteristi
#
# DSC Alarm Plugin Keypad
#
def special_dscKeypadState (self, classes, sourceDict, getter, characteristic, isOptional = False):
def special_dscKeypadCurrentState (self, classes, sourceDict, getter, characteristic, isOptional = False):

# HMCharacteristicValueCurrentSecuritySystemState enum values:
# stayArm = 0
# awayArm = 1
# nightArm = 2 <-- Not used since the DSC panel doesn't have "night mode"
# disarmed = 3
# triggered = 4
try:
if self.serverId == 0: return

obj = indigo.devices[self.objId]
if "ArmedState" in obj.states:
if obj.states["ArmedState.disarmed"]:
self.setAttributeValue (characteristic, 3)
if obj.states["state.tripped"]:
self.setAttributeValue (characteristic, 4) # triggered
self.characterDict[characteristic] = getattr (self, characteristic).value

elif obj.states["ArmedState.disarmed"]:
self.setAttributeValue (characteristic, 3) # disarmed
self.characterDict[characteristic] = getattr (self, characteristic).value

if obj.states["ArmedState.stay"]:
self.setAttributeValue (characteristic, 0)
self.characterDict[characteristic] = getattr (self, characteristic).value

if obj.states["ArmedState.away"]:
self.setAttributeValue (characteristic, 1)
elif obj.states["ArmedState.stay"]:
self.setAttributeValue (characteristic, 0) # stayArm
self.characterDict[characteristic] = getattr (self, characteristic).value

if obj.states["state.tripped"]:
self.setAttributeValue (characteristic, 4)
self.characterDict[characteristic] = getattr (self, characteristic).value
elif obj.states["ArmedState.away"]:
self.setAttributeValue (characteristic, 1) # awayArm
self.characterDict[characteristic] = getattr (self, characteristic).value

else:
self.setAttributeValue (characteristic, 3)
self.setAttributeValue (characteristic, 3) # disarmed
self.characterDict[characteristic] = getattr (self, characteristic).value

self.actions.append (HomeKitAction(characteristic, "equal", 0, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmStay", self.objId]], 100, {self.objId: "state_ArmedState.stay"}))
self.actions.append (HomeKitAction(characteristic, "equal", 1, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmAway", self.objId]], 100, {self.objId: "state_ArmedState.away"}))
self.actions.append (HomeKitAction(characteristic, "equal", 2, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmStay", self.objId]], 100, {self.objId: "state_ArmedState.stay"}))
self.actions.append (HomeKitAction(characteristic, "equal", 3, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionDisarm", self.objId]], 100, {self.objId: "state_ArmedState.disarmed"}))
self.actions.append (HomeKitAction(characteristic, "equal", 0, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmStay", self.objId]], 100, {self.objId: "state_ArmedState.stay"}))
self.actions.append (HomeKitAction(characteristic, "equal", 1, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmAway", self.objId]], 100, {self.objId: "state_ArmedState.away"}))
self.actions.append (HomeKitAction(characteristic, "equal", 2, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmStay", self.objId]], 100, {self.objId: "state_ArmedState.stay"}))
self.actions.append (HomeKitAction(characteristic, "equal", 3, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionDisarm", self.objId]], 100, {self.objId: "state_ArmedState.disarmed"}))

self.actions.append (HomeKitAction(characteristic, "equal", 99, "STUB", [indigo.devices[self.objId].pluginId, None, ["actionDisarm", self.objId]], 100, {self.objId: "state_state.tripped"}))

except Exception as e:
self.logger.error (ext.getException(e) + "\nFor object id {} alias '{}'".format(str(self.objId), self.alias.value))
self.logger.error (ext.getException(e) + "\nFor object id {} alias '{}'".format(str(self.objId), self.alias.value))


def special_dscKeypadTargetState (self, classes, sourceDict, getter, characteristic, isOptional = False):

# HMCharacteristicValueTargetSecuritySystemState enum values:
# stayArm = 0
# awayArm = 1
# nightArm = 2 <-- Not used since the DSC panel doesn't have "night mode"
# disarm = 3
try:
if self.serverId == 0: return

obj = indigo.devices[self.objId]
if "state" in obj.states and "ArmedState" in obj.states and "LEDBypass" in obj.states:

# If the DSC panel is disarmed, but it's reporting that exitDelay is true, assume that its
# target system state is an armed state (stay or away).

# If LEDBypass is 'on', assume the target state is "stayArm".
if obj.states["ArmedState.disarmed"] and obj.states["state.exitDelay"] and obj.states["LEDBypass"] == 'on':
self.setAttributeValue (characteristic, 0) # stayArm
self.characterDict[characteristic] = getattr (self, characteristic).value

# If LEDBypass is 'off', assume the target state is "awayArm".
elif obj.states["ArmedState.disarmed"] and obj.states["state.exitDelay"] and obj.states["LEDBypass"] == 'off':
self.setAttributeValue (characteristic, 1) # awayArm
self.characterDict[characteristic] = getattr (self, characteristic).value

# If the DSC panel is not disarmed, check for each explicit armed state individually.

elif obj.states["ArmedState.stay"]:
self.setAttributeValue (characteristic, 0) # stayArm
self.characterDict[characteristic] = getattr (self, characteristic).value

elif obj.states["ArmedState.away"]:
self.setAttributeValue (characteristic, 1) # awayArm
self.characterDict[characteristic] = getattr (self, characteristic).value

else:
self.setAttributeValue (characteristic, 3) # disarm
self.characterDict[characteristic] = getattr (self, characteristic).value

else:
self.setAttributeValue (characteristic, 3) # disarm
self.characterDict[characteristic] = getattr (self, characteristic).value

self.actions.append (HomeKitAction(characteristic, "equal", 0, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmStay", self.objId]], 100, {self.objId: "state_state.exitDelay"}))
self.actions.append (HomeKitAction(characteristic, "equal", 1, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmAway", self.objId]], 100, {self.objId: "state_state.exitDelay"}))
self.actions.append (HomeKitAction(characteristic, "equal", 2, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionArmStay", self.objId]], 100, {self.objId: "state_state.exitDelay"}))
self.actions.append (HomeKitAction(characteristic, "equal", 3, "homekit.runPluginAction", [indigo.devices[self.objId].pluginId, None, ["actionDisarm", self.objId]], 100, {self.objId: "state_ArmedState.disarmed"}))

except Exception as e:
self.logger.error (ext.getException(e) + "\nFor object id {} alias '{}'".format(str(self.objId), self.alias.value))


#
Expand Down Expand Up @@ -3869,8 +3930,8 @@ def __init__ (self, factory, objId, serverId = 0, characterDict = {}, deviceActi
super(service_SecuritySystem, self).__init__ (factory, type, desc, objId, serverId, characterDict, deviceActions, loadOptional)

self.required = {}
self.required["SecuritySystemCurrentState"] = {"*": "attr_onState", "indigo.Device.com.frightideas.indigoplugin.dscAlarm.alarmKeypad": "special_dscKeypadState"}
self.required["SecuritySystemTargetState"] = {"*": "attr_onState", "indigo.Device.com.frightideas.indigoplugin.dscAlarm.alarmKeypad": "special_dscKeypadState"}
self.required["SecuritySystemCurrentState"] = {"*": "attr_onState", "indigo.Device.com.frightideas.indigoplugin.dscAlarm.alarmKeypad": "special_dscKeypadCurrentState"}
self.required["SecuritySystemTargetState"] = {"*": "attr_onState", "indigo.Device.com.frightideas.indigoplugin.dscAlarm.alarmKeypad": "special_dscKeypadTargetState"}

self.optional = {}
self.optional["StatusFault"] = {}
Expand Down