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
|
"""Controls Control4 Relay devices. These can include locks, and potentially other types of devices."""
from pyControl4 import C4Entity
class C4Relay(C4Entity):
async def getRelayState(self):
"""Returns the current state of the relay.
For locks, `0` means locked and `1` means unlocked.
For relays in general, `0` probably means open and `1` probably means closed.
"""
return await self.director.getItemVariableValue(self.item_id, "RelayState")
async def getRelayStateVerified(self):
"""Returns True if Relay is functional.
Notes:
I think this is just used to verify that the relay is functional,
not 100% sure though.
"""
return bool(
await self.director.getItemVariableValue(self.item_id, "StateVerified")
)
async def open(self):
"""Set the relay to its open state.
Example description JSON for this command from the director:
```
{
"display": "Lock the Front › Door Lock",
"command": "OPEN",
"deviceId": 307
}
```
"""
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"OPEN",
{},
)
async def close(self):
"""Set the relay to its closed state.
Example description JSON for this command from the director:
```
{
"display": "Unlock the Front › Door Lock",
"command": "CLOSE",
"deviceId": 307
}
```
"""
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"CLOSE",
{},
)
async def toggle(self):
"""Toggles the relay state.
Example description JSON for this command from the director:
```
{
"display": "Toggle the Front › Door Lock",
"command": "TOGGLE",
"deviceId": 307
}
```
"""
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"TOGGLE",
{},
)
|
