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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
|
"""Handles communication with a Control4 Director, and provides functions for
getting details about items on the Director.
"""
import aiohttp
import async_timeout
import json
from .error_handling import checkResponseForError
class C4Director:
def __init__(
self,
ip,
director_bearer_token,
session_no_verify_ssl: aiohttp.ClientSession = None,
):
"""Creates a Control4 Director object.
Parameters:
`ip` - The IP address of the Control4 Director/Controller.
`director_bearer_token` - The bearer token used to authenticate
with the Director.
See `pyControl4.account.C4Account.getDirectorBearerToken`
for how to get this.
`session` - (Optional) Allows the use of an
`aiohttp.ClientSession` object
for all network requests. This
session will not be closed by the library.
If not provided, the library will open and
close its own `ClientSession`s as needed.
"""
self.base_url = "https://{}".format(ip)
self.headers = {"Authorization": "Bearer {}".format(director_bearer_token)}
self.director_bearer_token = director_bearer_token
self.session = session_no_verify_ssl
async def sendGetRequest(self, uri):
"""Sends a GET request to the specified API URI.
Returns the Director's JSON response as a string.
Parameters:
`uri` - The API URI to send the request to. Do not include the IP
address of the Director.
"""
if self.session is None:
async with aiohttp.ClientSession(
connector=aiohttp.TCPConnector(verify_ssl=False)
) as session:
with async_timeout.timeout(10):
async with session.get(
self.base_url + uri, headers=self.headers
) as resp:
await checkResponseForError(await resp.text())
return await resp.text()
else:
with async_timeout.timeout(10):
async with self.session.get(
self.base_url + uri, headers=self.headers
) as resp:
await checkResponseForError(await resp.text())
return await resp.text()
async def sendPostRequest(self, uri, command, params, async_variable=True):
"""Sends a POST request to the specified API URI. Used to send commands
to the Director.
Returns the Director's JSON response as a string.
Parameters:
`uri` - The API URI to send the request to. Do not include the IP
address of the Director.
`command` - The Control4 command to send.
`params` - The parameters of the command, provided as a dictionary.
"""
dataDictionary = {
"async": async_variable,
"command": command,
"tParams": params,
}
if self.session is None:
async with aiohttp.ClientSession(
connector=aiohttp.TCPConnector(verify_ssl=False)
) as session:
with async_timeout.timeout(10):
async with session.post(
self.base_url + uri, headers=self.headers, json=dataDictionary
) as resp:
await checkResponseForError(await resp.text())
return await resp.text()
else:
with async_timeout.timeout(10):
async with self.session.post(
self.base_url + uri, headers=self.headers, json=dataDictionary
) as resp:
await checkResponseForError(await resp.text())
return await resp.text()
async def getAllItemsByCategory(self, category):
"""Returns a JSON list of items related to a particular category.
Parameters:
`category` - Control4 Category Name: controllers, comfort, lights,
cameras, sensors, audio_video,
motorization, thermostats, motors,
control4_remote_hub,
outlet_wireless_dimmer, voice-scene
"""
return_list = await self.sendGetRequest(
"/api/v1/categories/{}".format(category)
)
return return_list
async def getAllItemInfo(self):
"""Returns a JSON list of all the items on the Director."""
return await self.sendGetRequest("/api/v1/items")
async def getItemInfo(self, item_id):
"""Returns a JSON list of the details of the specified item.
Parameters:
`item_id` - The Control4 item ID.
"""
return await self.sendGetRequest("/api/v1/items/{}".format(item_id))
async def getItemSetup(self, item_id):
"""Returns a JSON list of the setup info of the specified item.
Parameters:
`item_id` - The Control4 item ID.
"""
return await self.sendPostRequest(
"/api/v1/items/{}/commands".format(item_id), "GET_SETUP", {}, False
)
async def getItemVariables(self, item_id):
"""Returns a JSON list of the variables available for the specified item.
Parameters:
`item_id` - The Control4 item ID.
"""
return await self.sendGetRequest("/api/v1/items/{}/variables".format(item_id))
async def getItemVariableValue(self, item_id, var_name):
"""Returns the value of the specified variable for the
specified item as a string.
Parameters:
`item_id` - The Control4 item ID.
`var_name` - The Control4 variable name or names.
"""
if isinstance(var_name, (tuple, list, set)):
var_name = ",".join(var_name)
data = await self.sendGetRequest(
"/api/v1/items/{}/variables?varnames={}".format(item_id, var_name)
)
if data == "[]":
raise ValueError(
"Empty response recieved from Director! The variable {} \
doesn't seem to exist for item {}.".format(
var_name, item_id
)
)
jsonDictionary = json.loads(data)
return jsonDictionary[0]["value"]
async def getAllItemVariableValue(self, var_name):
"""Returns a dictionary with the values of the specified variable
for all items that have it.
Parameters:
`var_name` - The Control4 variable name or names.
"""
if isinstance(var_name, (tuple, list, set)):
var_name = ",".join(var_name)
data = await self.sendGetRequest(
"/api/v1/items/variables?varnames={}".format(var_name)
)
if data == "[]":
raise ValueError(
"Empty response recieved from Director! The variable {} \
doesn't seem to exist for any items.".format(
var_name
)
)
jsonDictionary = json.loads(data)
return jsonDictionary
async def getItemCommands(self, item_id):
"""Returns a JSON list of the commands available for the specified item.
Parameters:
`item_id` - The Control4 item ID.
"""
return await self.sendGetRequest("/api/v1/items/{}/commands".format(item_id))
async def getItemNetwork(self, item_id):
"""Returns a JSON list of the network information for the specified item.
Parameters:
`item_id` - The Control4 item ID.
"""
return await self.sendGetRequest("/api/v1/items/{}/network".format(item_id))
async def getItemBindings(self, item_id):
"""Returns a JSON list of the bindings information for the specified item.
Parameters:
`item_id` - The Control4 item ID.
"""
return await self.sendGetRequest("/api/v1/items/{}/bindings".format(item_id))
async def getUiConfiguration(self):
"""Returns a dictionary of the JSON Control4 App UI Configuration enumerating rooms and capabilities
Returns:
{
"experiences": [
{
"type": "watch",
"sources": {
"source": [
{
"id": 59,
"type": "HDMI"
},
{
"id": 946,
"type": "HDMI"
},
{
"id": 950,
"type": "HDMI"
},
{
"id": 33,
"type": "VIDEO_SELECTION"
}
]
},
"active": false,
"room_id": 9,
"username": "primaryuser"
},
{
"type": "listen",
"sources": {
"source": [
{
"id": 298,
"type": "DIGITAL_AUDIO_SERVER",
"name": "My Music"
},
{
"id": 302,
"type": "AUDIO_SELECTION",
"name": "Stations"
},
{
"id": 306,
"type": "DIGITAL_AUDIO_SERVER",
"name": "ShairBridge"
},
{
"id": 937,
"type": "DIGITAL_AUDIO_SERVER",
"name": "Spotify Connect"
},
{
"id": 100002,
"type": "DIGITAL_AUDIO_CLIENT",
"name": "Digital Media"
}
]
},
"active": false,
"room_id": 9,
"username": "primaryuser"
},
{
"type": "cameras",
"sources": {
"source": [
{
"id": 877,
"type": "Camera"
},
...
}
...
}
"""
return await self.sendGetRequest("/api/v1/agents/ui_configuration")
|
