Skip to content

Commit ee696e5

Browse files
actions-useractions-user
committed
Update documentation
1 parent fa7b301 commit ee696e5

File tree

2 files changed

+22
-44
lines changed

2 files changed

+22
-44
lines changed

‎docs/climate.html‎

Lines changed: 20 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -63,65 +63,55 @@ <h2 class="section-title" id="header-classes">Classes</h2>
6363

6464
async def getHVACState(self):
6565
&#34;&#34;&#34;Returns the current HVAC state (e.g., on/off or active mode).&#34;&#34;&#34;
66-
return await self.director.getItemVariableValue(self.item_id,
67-
&#34;HVAC_STATE&#34;)
66+
return await self.director.getItemVariableValue(self.item_id, &#34;HVAC_STATE&#34;)
6867

6968
async def getFANState(self):
7069
&#34;&#34;&#34;Returns the current power state of the fan (True=on, False=off).&#34;&#34;&#34;
71-
return await self.director.getItemVariableValue(self.item_id,
72-
&#34;FAN_STATE&#34;)
70+
return await self.director.getItemVariableValue(self.item_id, &#34;FAN_STATE&#34;)
7371

7472
# ------------------------
7573
# Mode Getters
7674
# ------------------------
7775

7876
async def getHVACMode(self):
7977
&#34;&#34;&#34;Returns the currently active HVAC mode.&#34;&#34;&#34;
80-
return await self.director.getItemVariableValue(self.item_id,
81-
&#34;HVAC_MODE&#34;)
78+
return await self.director.getItemVariableValue(self.item_id, &#34;HVAC_MODE&#34;)
8279

8380
async def getHVACModes(self):
8481
&#34;&#34;&#34;Returns a list of supported HVAC modes.&#34;&#34;&#34;
85-
return await self.director.getItemVariableValue(self.item_id,
86-
&#34;HVAC_MODES_LIST&#34;)
82+
return await self.director.getItemVariableValue(self.item_id, &#34;HVAC_MODES_LIST&#34;)
8783

8884
async def getFANMode(self):
8985
&#34;&#34;&#34;Returns the currently active fan mode.&#34;&#34;&#34;
90-
return await self.director.getItemVariableValue(self.item_id,
91-
&#34;FAN_MODE&#34;)
86+
return await self.director.getItemVariableValue(self.item_id, &#34;FAN_MODE&#34;)
9287

9388
async def getFANModes(self):
9489
&#34;&#34;&#34;Returns a list of supported fan modes.&#34;&#34;&#34;
95-
return await self.director.getItemVariableValue(self.item_id,
96-
&#34;FAN_MODES_LIST&#34;)
90+
return await self.director.getItemVariableValue(self.item_id, &#34;FAN_MODES_LIST&#34;)
9791

9892
# ------------------------
9993
# Setpoint Getters
10094
# ------------------------
10195

10296
async def getCoolSetpointF(self):
10397
&#34;&#34;&#34;Returns the cooling setpoint temperature in Fahrenheit.&#34;&#34;&#34;
104-
return await self.director.getItemVariableValue(self.item_id,
105-
&#34;COOL_SETPOINT_F&#34;)
98+
return await self.director.getItemVariableValue(self.item_id, &#34;COOL_SETPOINT_F&#34;)
10699

107100
async def getHeatSetpointF(self):
108101
&#34;&#34;&#34;Returns the heating setpoint temperature in Fahrenheit.&#34;&#34;&#34;
109-
return await self.director.getItemVariableValue(self.item_id,
110-
&#34;HEAT_SETPOINT_F&#34;)
102+
return await self.director.getItemVariableValue(self.item_id, &#34;HEAT_SETPOINT_F&#34;)
111103

112104
# ------------------------
113105
# Sensor Readings
114106
# ------------------------
115107

116108
async def getHumidity(self):
117109
&#34;&#34;&#34;Returns the current humidity percentage.&#34;&#34;&#34;
118-
return await self.director.getItemVariableValue(self.item_id,
119-
&#34;HUMIDITY&#34;)
110+
return await self.director.getItemVariableValue(self.item_id, &#34;HUMIDITY&#34;)
120111

121112
async def getCurrentTemperature(self):
122113
&#34;&#34;&#34;Returns the current ambient temperature in Fahrenheit.&#34;&#34;&#34;
123-
return await self.director.getItemVariableValue(self.item_id,
124-
&#34;TEMPERATURE_F&#34;)
114+
return await self.director.getItemVariableValue(self.item_id, &#34;TEMPERATURE_F&#34;)
125115

126116
# ------------------------
127117
# Setters / Commands
@@ -191,8 +181,7 @@ <h3>Methods</h3>
191181
</summary>
192182
<pre><code class="python">async def getCoolSetpointF(self):
193183
&#34;&#34;&#34;Returns the cooling setpoint temperature in Fahrenheit.&#34;&#34;&#34;
194-
return await self.director.getItemVariableValue(self.item_id,
195-
&#34;COOL_SETPOINT_F&#34;)</code></pre>
184+
return await self.director.getItemVariableValue(self.item_id, &#34;COOL_SETPOINT_F&#34;)</code></pre>
196185
</details>
197186
<div class="desc"><p>Returns the cooling setpoint temperature in Fahrenheit.</p></div>
198187
</dd>
@@ -206,8 +195,7 @@ <h3>Methods</h3>
206195
</summary>
207196
<pre><code class="python">async def getCurrentTemperature(self):
208197
&#34;&#34;&#34;Returns the current ambient temperature in Fahrenheit.&#34;&#34;&#34;
209-
return await self.director.getItemVariableValue(self.item_id,
210-
&#34;TEMPERATURE_F&#34;)</code></pre>
198+
return await self.director.getItemVariableValue(self.item_id, &#34;TEMPERATURE_F&#34;)</code></pre>
211199
</details>
212200
<div class="desc"><p>Returns the current ambient temperature in Fahrenheit.</p></div>
213201
</dd>
@@ -221,8 +209,7 @@ <h3>Methods</h3>
221209
</summary>
222210
<pre><code class="python">async def getFANMode(self):
223211
&#34;&#34;&#34;Returns the currently active fan mode.&#34;&#34;&#34;
224-
return await self.director.getItemVariableValue(self.item_id,
225-
&#34;FAN_MODE&#34;)</code></pre>
212+
return await self.director.getItemVariableValue(self.item_id, &#34;FAN_MODE&#34;)</code></pre>
226213
</details>
227214
<div class="desc"><p>Returns the currently active fan mode.</p></div>
228215
</dd>
@@ -236,8 +223,7 @@ <h3>Methods</h3>
236223
</summary>
237224
<pre><code class="python">async def getFANModes(self):
238225
&#34;&#34;&#34;Returns a list of supported fan modes.&#34;&#34;&#34;
239-
return await self.director.getItemVariableValue(self.item_id,
240-
&#34;FAN_MODES_LIST&#34;)</code></pre>
226+
return await self.director.getItemVariableValue(self.item_id, &#34;FAN_MODES_LIST&#34;)</code></pre>
241227
</details>
242228
<div class="desc"><p>Returns a list of supported fan modes.</p></div>
243229
</dd>
@@ -251,8 +237,7 @@ <h3>Methods</h3>
251237
</summary>
252238
<pre><code class="python">async def getFANState(self):
253239
&#34;&#34;&#34;Returns the current power state of the fan (True=on, False=off).&#34;&#34;&#34;
254-
return await self.director.getItemVariableValue(self.item_id,
255-
&#34;FAN_STATE&#34;)</code></pre>
240+
return await self.director.getItemVariableValue(self.item_id, &#34;FAN_STATE&#34;)</code></pre>
256241
</details>
257242
<div class="desc"><p>Returns the current power state of the fan (True=on, False=off).</p></div>
258243
</dd>
@@ -266,8 +251,7 @@ <h3>Methods</h3>
266251
</summary>
267252
<pre><code class="python">async def getHVACMode(self):
268253
&#34;&#34;&#34;Returns the currently active HVAC mode.&#34;&#34;&#34;
269-
return await self.director.getItemVariableValue(self.item_id,
270-
&#34;HVAC_MODE&#34;)</code></pre>
254+
return await self.director.getItemVariableValue(self.item_id, &#34;HVAC_MODE&#34;)</code></pre>
271255
</details>
272256
<div class="desc"><p>Returns the currently active HVAC mode.</p></div>
273257
</dd>
@@ -281,8 +265,7 @@ <h3>Methods</h3>
281265
</summary>
282266
<pre><code class="python">async def getHVACModes(self):
283267
&#34;&#34;&#34;Returns a list of supported HVAC modes.&#34;&#34;&#34;
284-
return await self.director.getItemVariableValue(self.item_id,
285-
&#34;HVAC_MODES_LIST&#34;)</code></pre>
268+
return await self.director.getItemVariableValue(self.item_id, &#34;HVAC_MODES_LIST&#34;)</code></pre>
286269
</details>
287270
<div class="desc"><p>Returns a list of supported HVAC modes.</p></div>
288271
</dd>
@@ -296,8 +279,7 @@ <h3>Methods</h3>
296279
</summary>
297280
<pre><code class="python">async def getHVACState(self):
298281
&#34;&#34;&#34;Returns the current HVAC state (e.g., on/off or active mode).&#34;&#34;&#34;
299-
return await self.director.getItemVariableValue(self.item_id,
300-
&#34;HVAC_STATE&#34;)</code></pre>
282+
return await self.director.getItemVariableValue(self.item_id, &#34;HVAC_STATE&#34;)</code></pre>
301283
</details>
302284
<div class="desc"><p>Returns the current HVAC state (e.g., on/off or active mode).</p></div>
303285
</dd>
@@ -311,8 +293,7 @@ <h3>Methods</h3>
311293
</summary>
312294
<pre><code class="python">async def getHeatSetpointF(self):
313295
&#34;&#34;&#34;Returns the heating setpoint temperature in Fahrenheit.&#34;&#34;&#34;
314-
return await self.director.getItemVariableValue(self.item_id,
315-
&#34;HEAT_SETPOINT_F&#34;)</code></pre>
296+
return await self.director.getItemVariableValue(self.item_id, &#34;HEAT_SETPOINT_F&#34;)</code></pre>
316297
</details>
317298
<div class="desc"><p>Returns the heating setpoint temperature in Fahrenheit.</p></div>
318299
</dd>
@@ -326,8 +307,7 @@ <h3>Methods</h3>
326307
</summary>
327308
<pre><code class="python">async def getHumidity(self):
328309
&#34;&#34;&#34;Returns the current humidity percentage.&#34;&#34;&#34;
329-
return await self.director.getItemVariableValue(self.item_id,
330-
&#34;HUMIDITY&#34;)</code></pre>
310+
return await self.director.getItemVariableValue(self.item_id, &#34;HUMIDITY&#34;)</code></pre>
331311
</details>
332312
<div class="desc"><p>Returns the current humidity percentage.</p></div>
333313
</dd>

‎docs/fan.html‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,8 +89,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
8989
Returns:
9090
int: Current fan speed (0–4).
9191
&#34;&#34;&#34;
92-
value = await self.director.getItemVariableValue(self.item_id,
93-
&#34;CURRENT_SPEED&#34;)
92+
value = await self.director.getItemVariableValue(self.item_id, &#34;CURRENT_SPEED&#34;)
9493
return int(value)
9594

9695
# ------------------------
@@ -170,8 +169,7 @@ <h3>Methods</h3>
170169
Returns:
171170
int: Current fan speed (0–4).
172171
&#34;&#34;&#34;
173-
value = await self.director.getItemVariableValue(self.item_id,
174-
&#34;CURRENT_SPEED&#34;)
172+
value = await self.director.getItemVariableValue(self.item_id, &#34;CURRENT_SPEED&#34;)
175173
return int(value)</code></pre>
176174
</details>
177175
<div class="desc"><p>Returns the current speed of the fan controller.</p>

0 commit comments

Comments
 (0)