1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
|
"""Controls Control4 security panel and contact sensor (door, window, motion) devices."""
import json
from pyControl4 import C4Entity
class C4SecurityPanel(C4Entity):
async def getArmState(self):
"""Returns the arm state of the security panel as "DISARMED", "ARMED_HOME", or "ARMED_AWAY"."""
disarmed = await self.director.getItemVariableValue(
self.item_id, "DISARMED_STATE"
)
armed_home = await self.director.getItemVariableValue(
self.item_id, "HOME_STATE"
)
armed_away = await self.director.getItemVariableValue(
self.item_id, "AWAY_STATE"
)
if disarmed == 1:
return "DISARMED"
elif armed_home == 1:
return "ARMED_HOME"
elif armed_away == 1:
return "ARMED_AWAY"
async def getAlarmState(self):
"""Returns `True` if alarm is triggered, otherwise returns `False`."""
alarm_state = await self.director.getItemVariableValue(
self.item_id, "ALARM_STATE"
)
return bool(alarm_state)
async def getDisplayText(self):
"""Returns the display text of the security panel."""
display_text = await self.director.getItemVariableValue(
self.item_id, "DISPLAY_TEXT"
)
return display_text
async def getTroubleText(self):
"""Returns the trouble display text of the security panel."""
trouble_text = await self.director.getItemVariableValue(
self.item_id, "TROUBLE_TEXT"
)
return trouble_text
async def getPartitionState(self):
"""Returns the partition state of the security panel.
Possible values include "DISARMED_NOT_READY", "DISARMED_READY", "ARMED_HOME", "ARMED_AWAY", "EXIT_DELAY", "ENTRY_DELAY"
"""
partition_state = await self.director.getItemVariableValue(
self.item_id, "PARTITION_STATE"
)
return partition_state
async def getDelayTimeTotal(self):
"""Returns the total exit delay time. Returns 0 if an exit delay is not currently running."""
delay_time_total = await self.director.getItemVariableValue(
self.item_id, "DELAY_TIME_TOTAL"
)
return delay_time_total
async def getDelayTimeRemaining(self):
"""Returns the remaining exit delay time. Returns 0 if an exit delay is not currently running."""
delay_time_remaining = await self.director.getItemVariableValue(
self.item_id, "DELAY_TIME_REMAINING"
)
return delay_time_remaining
async def getOpenZoneCount(self):
"""Returns the number of open/unsecured zones."""
open_zone_count = await self.director.getItemVariableValue(
self.item_id, "OPEN_ZONE_COUNT"
)
return open_zone_count
async def getAlarmType(self):
"""Returns details about the current alarm type."""
alarm_type = await self.director.getItemVariableValue(
self.item_id, "ALARM_TYPE"
)
return alarm_type
async def getArmedType(self):
"""Returns details about the current arm type."""
armed_type = await self.director.getItemVariableValue(
self.item_id, "ARMED_TYPE"
)
return armed_type
async def getLastEmergency(self):
"""Returns details about the last emergency trigger."""
last_emergency = await self.director.getItemVariableValue(
self.item_id, "LAST_EMERGENCY"
)
return last_emergency
async def getLastArmFailure(self):
"""Returns details about the last arm failure."""
last_arm_failed = await self.director.getItemVariableValue(
self.item_id, "LAST_ARM_FAILED"
)
return last_arm_failed
async def setArm(self, usercode, mode: str):
"""Arms the security panel with the specified mode.
Parameters:
`usercode` - PIN/code for arming the system.
`mode` - Arm mode to use. This depends on what is supported by the security panel itself.
"""
usercode = str(usercode)
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"PARTITION_ARM",
{"ArmType": mode, "UserCode": usercode},
)
async def setDisarm(self, usercode):
"""Disarms the security panel.
Parameters:
`usercode` - PIN/code for disarming the system.
"""
usercode = str(usercode)
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"PARTITION_DISARM",
{"UserCode": usercode},
)
async def getEmergencyTypes(self):
"""Returns the available emergency types as a list.
Possible types are "Fire", "Medical", "Panic", and "Police".
"""
types_list = []
data = await self.director.getItemInfo(self.item_id)
jsonDictionary = json.loads(data)
if jsonDictionary[0]["capabilities"]["has_fire"]:
types_list.append("Fire")
if jsonDictionary[0]["capabilities"]["has_medical"]:
types_list.append("Medical")
if jsonDictionary[0]["capabilities"]["has_panic"]:
types_list.append("Panic")
if jsonDictionary[0]["capabilities"]["has_police"]:
types_list.append("Police")
return types_list
async def triggerEmergency(self, usercode, type):
"""Triggers an emergency of the specified type.
Parameters:
`usercode` - PIN/code for disarming the system.
`type` - Type of emergency: "Fire", "Medical", "Panic", or "Police"
"""
usercode = str(usercode)
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"PARTITION_DISARM",
{"UserCode": usercode},
)
async def sendKeyPress(self, key):
"""Sends a single keypress to the security panel's virtual keypad (if supported).
Parameters:
`key` - Keypress to send. Only one key at a time.
"""
key = str(key)
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"KEY_PRESS",
{"KeyName": key},
)
class C4ContactSensor:
def __init__(self, C4Director, item_id):
"""Creates a Control4 Contact Sensor object.
Parameters:
`C4Director` - A `pyControl4.director.C4Director` object that corresponds to the Control4 Director that the security panel is connected to.
`item_id` - The Control4 item ID of the contact sensor.
"""
self.director = C4Director
self.item_id = item_id
async def getContactState(self):
"""Returns `True` if contact is triggered (door/window is closed, motion is detected), otherwise returns `False`."""
contact_state = await self.director.getItemVariableValue(
self.item_id, "ContactState"
)
return bool(contact_state)
|
