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
|
"""Controls Control4 blind devices."""
from pyControl4 import C4Entity
class C4Blind(C4Entity):
async def getBatteryLevel(self):
"""Returns the battery of a blind. We currently don't know the range or meaning."""
value = await self.director.getItemVariableValue(self.item_id, "Battery Level")
return int(value)
async def getClosing(self):
"""Returns an indication of whether the blind is moving in the closed direction as a boolean
(True=closing, False=opening). If the blind is stopped, reports the direction it last moved.
"""
value = await self.director.getItemVariableValue(self.item_id, "Closing")
return bool(value)
async def getFullyClosed(self):
"""Returns an indication of whether the blind is fully closed as a boolean
(True=fully closed, False=at least partially open)."""
value = await self.director.getItemVariableValue(self.item_id, "Fully Closed")
return bool(value)
async def getFullyOpen(self):
"""Returns an indication of whether the blind is fully open as a boolean
(True=fully open, False=at least partially closed)."""
value = await self.director.getItemVariableValue(self.item_id, "Fully Open")
return bool(value)
async def getLevel(self):
"""Returns the level (current position) of a blind as an int 0-100.
0 is fully closed and 100 is fully open.
"""
value = await self.director.getItemVariableValue(self.item_id, "Level")
return int(value)
async def getOpen(self):
"""Returns an indication of whether the blind is open as a boolean (True=open, False=closed).
This is true even if the blind is only partially open."""
value = await self.director.getItemVariableValue(self.item_id, "Open")
return bool(value)
async def getOpening(self):
"""Returns an indication of whether the blind is moving in the open direction as a boolean
(True=opening, False=closing). If the blind is stopped, reports the direction it last moved.
"""
value = await self.director.getItemVariableValue(self.item_id, "Opening")
return bool(value)
async def getStopped(self):
"""Returns an indication of whether the blind is stopped as a boolean
(True=stopped, False=moving)."""
value = await self.director.getItemVariableValue(self.item_id, "Stopped")
return bool(value)
async def getTargetLevel(self):
"""Returns the target level (desired position) of a blind as an int 0-100.
The blind will move if this is different from the current level.
0 is fully closed and 100 is fully open.
"""
value = await self.director.getItemVariableValue(self.item_id, "Target Level")
return int(value)
async def open(self):
"""Opens the blind completely."""
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"SET_LEVEL_TARGET:LEVEL_TARGET_OPEN",
{},
)
async def close(self):
"""Closes the blind completely."""
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"SET_LEVEL_TARGET:LEVEL_TARGET_CLOSED",
{},
)
async def setLevelTarget(self, level):
"""Sets the desired level of a blind; it will start moving towards that level.
Level 0 is fully closed and level 100 is fully open.
Parameters:
`level` - (int) 0-100
"""
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"SET_LEVEL_TARGET",
{"LEVEL_TARGET": level},
)
async def stop(self):
"""Stops the blind if it is moving. Shortly after stopping, the target level will be
set to the level the blind had actually reached when it stopped."""
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"STOP",
{},
)
async def toggle(self):
"""Toggles the blind between open and closed. Has no effect if the blind is partially open."""
await self.director.sendPostRequest(
"/api/v1/items/{}/commands".format(self.item_id),
"TOGGLE",
{},
)
|
