Repository navigation
Expand file tree
/
Copy pathdriver.xml
More file actions
337 lines (313 loc) · 13.5 KB
/
Copy pathdriver.xml
File metadata and controls
337 lines (313 loc) · 13.5 KB
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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
<devicedata>
<!--
================================================================================
AirGradient Air Quality Monitor - Control4 Driver Manifest
================================================================================
This schema was reconstructed from several published, working Control4
DriverWorks driver.xml files (Skreens AVx, bphillips09's HA Thermostat, and
RJBoucher's tcp_event_server) since Control4's own XML Reference Guide is
behind a dealer login. Validated against Control4's own DriverValidator tool.
Uses the confirmed-working "thermostatV2" proxy type (seen in a published,
working driver) for the Navigator temperature/humidity tile. The Air Quality
Alert is exposed as Programming events only (PM25_ALERT etc.) rather than a
second guessed proxy type - that's all the fan-control use case needs anyway.
================================================================================
-->
<copyright>AirGradient Local API Driver</copyright>
<creator>Community</creator>
<manufacturer>AirGradient</manufacturer>
<name>AirGradient Air Quality Monitor (Local API)</name>
<model>ONE / Open Air</model>
<created>07/24/2026 12:00</created>
<modified>07/24/2026 12:00</modified>
<version>1</version>
<control>lua_gen</control>
<controlmethod>IP</controlmethod>
<driver>DriverWorks</driver>
<config>
<script file="driver.lua" />
<documentation file="www/documentation/index.html" />
<properties>
<!-- Connection settings -->
<property>
<name>Host or IP Address</name>
<type>STRING</type>
<default>airgradient_XXXXXXXXXXXX.local</default>
<readonly>false</readonly>
</property>
<property>
<name>Polling Interval (seconds)</name>
<type>STRING</type>
<default>10</default>
<readonly>false</readonly>
</property>
<property>
<name>Use Compensated Values</name>
<type>LIST</type>
<items>
<item>Yes</item>
<item>No</item>
</items>
<default>Yes</default>
<readonly>false</readonly>
</property>
<property>
<name>Temperature Display Unit</name>
<type>LIST</type>
<items>
<item>Fahrenheit</item>
<item>Celsius</item>
</items>
<default>Fahrenheit</default>
<readonly>false</readonly>
</property>
<property>
<name>Debug Logging</name>
<type>LIST</type>
<items>
<item>On</item>
<item>Off</item>
</items>
<default>Off</default>
<readonly>false</readonly>
</property>
<!-- Alert thresholds used to fire Programming events -->
<property><name>PM2.5 Alert Threshold (ug/m3)</name><type>STRING</type><default>35</default><readonly>false</readonly></property>
<property><name>PM2.5 Clear Threshold (ug/m3)</name><type>STRING</type><default>25</default><readonly>false</readonly></property>
<property><name>CO2 Alert Threshold (ppm)</name><type>STRING</type><default>1000</default><readonly>false</readonly></property>
<property><name>CO2 Clear Threshold (ppm)</name><type>STRING</type><default>800</default><readonly>false</readonly></property>
<property><name>TVOC Alert Threshold</name><type>STRING</type><default>300</default><readonly>false</readonly></property>
<property><name>TVOC Clear Threshold</name><type>STRING</type><default>200</default><readonly>false</readonly></property>
<property><name>NOx Alert Threshold</name><type>STRING</type><default>5</default><readonly>false</readonly></property>
<property><name>NOx Clear Threshold</name><type>STRING</type><default>2</default><readonly>false</readonly></property>
<!-- Read-only live sensor values -->
<property><name>PM1.0 (ug/m3)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>PM2.5 (ug/m3)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>PM2.5 Compensated (ug/m3)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>PM10 (ug/m3)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>CO2 (ppm)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Temperature (C)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Temperature (Display)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Temperature Compensated (C)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Humidity (%)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Humidity Compensated (%)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>TVOC Index</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>TVOC Raw</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>NOx Index</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>NOx Raw</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>WiFi Signal (dBm)</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Firmware Version</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Model</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Serial Number</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Boot Count</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>LED Mode</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Config: Country</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Config: PM Standard</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Config: LED Bar Mode</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Config: Display Brightness</name><type>STRING</type><default></default><readonly>true</readonly></property>
<property><name>Config: LED Bar Brightness</name><type>STRING</type><default></default><readonly>true</readonly></property>
</properties>
<actions />
<!-- COMMANDS (Programming actions). Dispatched in driver.lua via both
ExecuteCommand(strCommand, tParams) and a LUA_ACTION[...] table
entry with the same key, for compatibility across DriverWorks
versions. -->
<commands>
<command>
<name>REFRESH_NOW</name>
<description>Refresh sensor data immediately</description>
</command>
<command>
<name>CALIBRATE_CO2</name>
<description>Calibrate CO2 sensor to 400ppm reference</description>
</command>
<command>
<name>TEST_LED_BAR</name>
<description>Run LED bar test sequence</description>
</command>
<command>
<name>SET_LED_BAR_MODE</name>
<description>Set LED bar mode</description>
<params>
<param>
<name>MODE</name>
<type>LIST</type>
<items>
<item>co2</item>
<item>pm</item>
<item>iaqs</item>
<item>off</item>
</items>
</param>
</params>
</command>
<command>
<name>SET_DISPLAY_BRIGHTNESS</name>
<description>Set display brightness (0-100)</description>
<params>
<param>
<name>LEVEL</name>
<type>STRING</type>
</param>
</params>
</command>
<command>
<name>SET_LED_BAR_BRIGHTNESS</name>
<description>Set LED bar brightness (0-100)</description>
<params>
<param>
<name>LEVEL</name>
<type>STRING</type>
</param>
</params>
</command>
<command>
<name>SET_TEMPERATURE_UNIT</name>
<description>Set the device's own display temperature unit</description>
<params>
<param>
<name>UNIT</name>
<type>LIST</type>
<items>
<item>c</item>
<item>f</item>
</items>
</param>
</params>
</command>
</commands>
</config>
<!-- Confirmed against a real, currently-working thermostatV2 driver
(Finite Labs' ESPHome Climate driver). The primary="True" attribute
was missing before - likely required for Comfort-menu recognition. -->
<proxies>
<proxy proxybindingid="5001" primary="True" name="AirGradient">thermostatV2</proxy>
</proxies>
<capabilities>
<can_heat>False</can_heat>
<can_cool>False</can_cool>
<can_auto>False</can_auto>
<has_humidity>True</has_humidity>
<has_single_setpoint>False</has_single_setpoint>
<can_preset>False</can_preset>
<can_preset_schedule>False</can_preset_schedule>
<has_temperature>True</has_temperature>
<current_temperature_min_c>-40</current_temperature_min_c>
<current_temperature_max_c>85</current_temperature_max_c>
<current_temperature_min_f>-40</current_temperature_min_f>
<current_temperature_max_f>185</current_temperature_max_f>
<current_temperature_resolution_c>0.1</current_temperature_resolution_c>
<current_temperature_resolution_f>1</current_temperature_resolution_f>
<setpoint_resolution_c>0.5</setpoint_resolution_c>
<setpoint_resolution_f>1</setpoint_resolution_f>
<setpoint_heat_min_c>0</setpoint_heat_min_c>
<setpoint_heat_max_c>120</setpoint_heat_max_c>
<setpoint_heat_min_f>32</setpoint_heat_min_f>
<setpoint_heat_max_f>248</setpoint_heat_max_f>
<setpoint_cool_min_c>0</setpoint_cool_min_c>
<setpoint_cool_max_c>120</setpoint_cool_max_c>
<setpoint_cool_min_f>32</setpoint_cool_min_f>
<setpoint_cool_max_f>248</setpoint_cool_max_f>
<setpoint_single_min_c>0</setpoint_single_min_c>
<setpoint_single_max_c>120</setpoint_single_max_c>
<setpoint_single_min_f>32</setpoint_single_min_f>
<setpoint_single_max_f>248</setpoint_single_max_f>
<setpoint_single_resolution_c>0.5</setpoint_single_resolution_c>
<setpoint_single_resolution_f>1</setpoint_single_resolution_f>
<can_inc_dec_setpoints>False</can_inc_dec_setpoints>
<can_change_scale>False</can_change_scale>
<has_extras>True</has_extras>
<has_vacation_mode>False</has_vacation_mode>
<has_remote_sensor>True</has_remote_sensor>
<fan_modes/>
<hvac_modes>Off</hvac_modes>
<hold_modes/>
</capabilities>
<!-- EVENTS (Programming "When..." triggers) -->
<events>
<event><id>1</id><name>DATA_REFRESHED</name><description>Sensor Data Refreshed</description></event>
<event><id>2</id><name>PM25_ALERT</name><description>PM2.5 Above Threshold</description></event>
<event><id>3</id><name>PM25_NORMAL</name><description>PM2.5 Back to Normal</description></event>
<event><id>4</id><name>CO2_ALERT</name><description>CO2 Above Threshold</description></event>
<event><id>5</id><name>CO2_NORMAL</name><description>CO2 Back to Normal</description></event>
<event><id>6</id><name>TVOC_ALERT</name><description>TVOC Index Above Threshold</description></event>
<event><id>7</id><name>TVOC_NORMAL</name><description>TVOC Index Back to Normal</description></event>
<event><id>8</id><name>NOX_ALERT</name><description>NOx Index Above Threshold</description></event>
<event><id>9</id><name>NOX_NORMAL</name><description>NOx Index Back to Normal</description></event>
<event><id>10</id><name>SENSOR_ONLINE</name><description>Monitor Came Online</description></event>
<event><id>11</id><name>SENSOR_OFFLINE</name><description>Monitor Went Offline</description></event>
</events>
<!-- Confirmed against a real, currently-working thermostatV2 driver.
Key corrections from before: type is 6 (not 1) for value-output
connections, the proxy-linked connection's class is "THERMOSTAT"
(not "THERMOSTATV2"), and HUMIDITY_VALUE is in fact correct -
confirmed here rather than guessed. -->
<connections>
<connection>
<id>5010</id>
<facing>6</facing>
<connectionname>Temperature</connectionname>
<type>6</type>
<consumer>False</consumer>
<classes>
<class>
<classname>TEMPERATURE_VALUE</classname>
</class>
</classes>
<hidden>False</hidden>
</connection>
<connection>
<id>5012</id>
<facing>6</facing>
<connectionname>Humidity</connectionname>
<type>6</type>
<consumer>False</consumer>
<classes>
<class>
<classname>HUMIDITY_VALUE</classname>
</class>
</classes>
<hidden>False</hidden>
</connection>
<!-- Links this connection to the proxy declared with proxybindingid="5001". -->
<connection proxybindingid="5001">
<id>5001</id>
<facing>6</facing>
<connectionname>Thermostat</connectionname>
<type>2</type>
<consumer>False</consumer>
<classes>
<class>
<classname>THERMOSTAT</classname>
</class>
</classes>
<hidden>True</hidden>
</connection>
<!-- Room Connection (7000 series) - required for thermostat drivers,
and what associates the device with a Room's climate system. -->
<connection>
<id>7000</id>
<facing>6</facing>
<connectionname>Selection</connectionname>
<type>7</type>
<consumer>False</consumer>
<classes>
<class>
<autobind>True</autobind>
<classname>TEMPERATURE</classname>
</class>
<class>
<autobind>True</autobind>
<classname>TEMPERATURE_CONTROL</classname>
</class>
</classes>
<hidden>True</hidden>
</connection>
</connections>
<!-- Places the device under the "Comfort" experience menu in Navigator.
The confirmed working reference uses composer_categories only - no
navigator_categories - so that's been dropped here to match. -->
<composer_categories>
<category>Comfort</category>
</composer_categories>
</devicedata>