Skip to content

Commit 38f1a4f

Browse files
actions-useractions-user
committed
Update documentation
1 parent 1181827 commit 38f1a4f

File tree

1 file changed

+126
-34
lines changed

1 file changed

+126
-34
lines changed

‎docs/climate.html‎

Lines changed: 126 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
9696
async def getCoolSetpointF(self):
9797
&#34;&#34;&#34;Returns the cooling setpoint temperature in Fahrenheit.&#34;&#34;&#34;
9898
return await self.director.getItemVariableValue(self.item_id, &#34;COOL_SETPOINT_F&#34;)
99+
100+
async def getCoolSetpointC(self):
101+
&#34;&#34;&#34;Returns the cooling setpoint temperature in Celsius.&#34;&#34;&#34;
102+
return await self.director.getItemVariableValue(self.item_id, &#34;COOL_SETPOINT_C&#34;)
99103

100104
async def getHeatSetpointF(self):
101105
&#34;&#34;&#34;Returns the heating setpoint temperature in Fahrenheit.&#34;&#34;&#34;
102106
return await self.director.getItemVariableValue(self.item_id, &#34;HEAT_SETPOINT_F&#34;)
107+
108+
async def getHeatSetpointC(self):
109+
&#34;&#34;&#34;Returns the heating setpoint temperature in Celsius.&#34;&#34;&#34;
110+
return await self.director.getItemVariableValue(self.item_id, &#34;HEAT_SETPOINT_C&#34;)
103111

104112
# ------------------------
105113
# Sensor Readings
@@ -109,33 +117,49 @@ <h2 class="section-title" id="header-classes">Classes</h2>
109117
&#34;&#34;&#34;Returns the current humidity percentage.&#34;&#34;&#34;
110118
return await self.director.getItemVariableValue(self.item_id, &#34;HUMIDITY&#34;)
111119

112-
async def getCurrentTemperature(self):
120+
async def getCurrentTemperatureF(self):
113121
&#34;&#34;&#34;Returns the current ambient temperature in Fahrenheit.&#34;&#34;&#34;
114122
return await self.director.getItemVariableValue(self.item_id, &#34;TEMPERATURE_F&#34;)
123+
124+
async def getCurrentTemperatureC(self):
125+
&#34;&#34;&#34;Returns the current ambient temperature in Celsius.&#34;&#34;&#34;
126+
return await self.director.getItemVariableValue(self.item_id, &#34;TEMPERATURE_C&#34;)
115127

116128
# ------------------------
117129
# Setters / Commands
118130
# ------------------------
119131

120-
async def setTemperature(self, temp):
121-
&#34;&#34;&#34;Sets the cooling setpoint temperature in Fahrenheit.&#34;&#34;&#34;
122-
await self.setCoolSetpoint(temp) # Delegates to the proper method
123-
124-
async def setCoolSetpoint(self, temp):
132+
async def setCoolSetpointF(self, temp):
125133
&#34;&#34;&#34;Sets the cooling setpoint temperature in Fahrenheit.&#34;&#34;&#34;
126134
await self.director.sendPostRequest(
127135
f&#34;/api/v1/items/{self.item_id}/commands&#34;,
128136
&#34;SET_SETPOINT_COOL&#34;,
129137
{&#34;FAHRENHEIT&#34;: temp},
130138
)
131139

132-
async def setHeatSetpoint(self, temp):
140+
async def setCoolSetpointC(self, temp):
141+
&#34;&#34;&#34;Sets the cooling setpoint temperature in Celsius.&#34;&#34;&#34;
142+
await self.director.sendPostRequest(
143+
f&#34;/api/v1/items/{self.item_id}/commands&#34;,
144+
&#34;SET_SETPOINT_COOL&#34;,
145+
{&#34;CELSIUS&#34;: temp},
146+
)
147+
148+
async def setHeatSetpointF(self, temp):
133149
&#34;&#34;&#34;Sets the heating setpoint temperature in Fahrenheit.&#34;&#34;&#34;
134150
await self.director.sendPostRequest(
135151
f&#34;/api/v1/items/{self.item_id}/commands&#34;,
136152
&#34;SET_SETPOINT_HEAT&#34;,
137153
{&#34;FAHRENHEIT&#34;: temp},
138154
)
155+
156+
async def setHeatSetpointC(self, temp):
157+
&#34;&#34;&#34;Sets the heating setpoint temperature in Celsius.&#34;&#34;&#34;
158+
await self.director.sendPostRequest(
159+
f&#34;/api/v1/items/{self.item_id}/commands&#34;,
160+
&#34;SET_SETPOINT_HEAT&#34;,
161+
{&#34;CELSIUS&#34;: temp},
162+
)
139163

140164
async def setHvacMode(self, mode):
141165
&#34;&#34;&#34;Sets the HVAC operating mode (e.g., heat, cool, auto).&#34;&#34;&#34;
@@ -171,6 +195,20 @@ <h3>Ancestors</h3>
171195
</ul>
172196
<h3>Methods</h3>
173197
<dl>
198+
<dt id="pyControl4.climate.C4Climate.getCoolSetpointC"><code class="name flex">
199+
<span>async def <span class="ident">getCoolSetpointC</span></span>(<span>self)</span>
200+
</code></dt>
201+
<dd>
202+
<details class="source">
203+
<summary>
204+
<span>Expand source code</span>
205+
</summary>
206+
<pre><code class="python">async def getCoolSetpointC(self):
207+
&#34;&#34;&#34;Returns the cooling setpoint temperature in Celsius.&#34;&#34;&#34;
208+
return await self.director.getItemVariableValue(self.item_id, &#34;COOL_SETPOINT_C&#34;)</code></pre>
209+
</details>
210+
<div class="desc"><p>Returns the cooling setpoint temperature in Celsius.</p></div>
211+
</dd>
174212
<dt id="pyControl4.climate.C4Climate.getCoolSetpointF"><code class="name flex">
175213
<span>async def <span class="ident">getCoolSetpointF</span></span>(<span>self)</span>
176214
</code></dt>
@@ -185,15 +223,29 @@ <h3>Methods</h3>
185223
</details>
186224
<div class="desc"><p>Returns the cooling setpoint temperature in Fahrenheit.</p></div>
187225
</dd>
188-
<dt id="pyControl4.climate.C4Climate.getCurrentTemperature"><code class="name flex">
189-
<span>async def <span class="ident">getCurrentTemperature</span></span>(<span>self)</span>
226+
<dt id="pyControl4.climate.C4Climate.getCurrentTemperatureC"><code class="name flex">
227+
<span>async def <span class="ident">getCurrentTemperatureC</span></span>(<span>self)</span>
228+
</code></dt>
229+
<dd>
230+
<details class="source">
231+
<summary>
232+
<span>Expand source code</span>
233+
</summary>
234+
<pre><code class="python">async def getCurrentTemperatureC(self):
235+
&#34;&#34;&#34;Returns the current ambient temperature in Celsius.&#34;&#34;&#34;
236+
return await self.director.getItemVariableValue(self.item_id, &#34;TEMPERATURE_C&#34;)</code></pre>
237+
</details>
238+
<div class="desc"><p>Returns the current ambient temperature in Celsius.</p></div>
239+
</dd>
240+
<dt id="pyControl4.climate.C4Climate.getCurrentTemperatureF"><code class="name flex">
241+
<span>async def <span class="ident">getCurrentTemperatureF</span></span>(<span>self)</span>
190242
</code></dt>
191243
<dd>
192244
<details class="source">
193245
<summary>
194246
<span>Expand source code</span>
195247
</summary>
196-
<pre><code class="python">async def getCurrentTemperature(self):
248+
<pre><code class="python">async def getCurrentTemperatureF(self):
197249
&#34;&#34;&#34;Returns the current ambient temperature in Fahrenheit.&#34;&#34;&#34;
198250
return await self.director.getItemVariableValue(self.item_id, &#34;TEMPERATURE_F&#34;)</code></pre>
199251
</details>
@@ -283,6 +335,20 @@ <h3>Methods</h3>
283335
</details>
284336
<div class="desc"><p>Returns the current HVAC state (e.g., on/off or active mode).</p></div>
285337
</dd>
338+
<dt id="pyControl4.climate.C4Climate.getHeatSetpointC"><code class="name flex">
339+
<span>async def <span class="ident">getHeatSetpointC</span></span>(<span>self)</span>
340+
</code></dt>
341+
<dd>
342+
<details class="source">
343+
<summary>
344+
<span>Expand source code</span>
345+
</summary>
346+
<pre><code class="python">async def getHeatSetpointC(self):
347+
&#34;&#34;&#34;Returns the heating setpoint temperature in Celsius.&#34;&#34;&#34;
348+
return await self.director.getItemVariableValue(self.item_id, &#34;HEAT_SETPOINT_C&#34;)</code></pre>
349+
</details>
350+
<div class="desc"><p>Returns the heating setpoint temperature in Celsius.</p></div>
351+
</dd>
286352
<dt id="pyControl4.climate.C4Climate.getHeatSetpointF"><code class="name flex">
287353
<span>async def <span class="ident">getHeatSetpointF</span></span>(<span>self)</span>
288354
</code></dt>
@@ -311,15 +377,33 @@ <h3>Methods</h3>
311377
</details>
312378
<div class="desc"><p>Returns the current humidity percentage.</p></div>
313379
</dd>
314-
<dt id="pyControl4.climate.C4Climate.setCoolSetpoint"><code class="name flex">
315-
<span>async def <span class="ident">setCoolSetpoint</span></span>(<span>self, temp)</span>
380+
<dt id="pyControl4.climate.C4Climate.setCoolSetpointC"><code class="name flex">
381+
<span>async def <span class="ident">setCoolSetpointC</span></span>(<span>self, temp)</span>
316382
</code></dt>
317383
<dd>
318384
<details class="source">
319385
<summary>
320386
<span>Expand source code</span>
321387
</summary>
322-
<pre><code class="python">async def setCoolSetpoint(self, temp):
388+
<pre><code class="python">async def setCoolSetpointC(self, temp):
389+
&#34;&#34;&#34;Sets the cooling setpoint temperature in Celsius.&#34;&#34;&#34;
390+
await self.director.sendPostRequest(
391+
f&#34;/api/v1/items/{self.item_id}/commands&#34;,
392+
&#34;SET_SETPOINT_COOL&#34;,
393+
{&#34;CELSIUS&#34;: temp},
394+
)</code></pre>
395+
</details>
396+
<div class="desc"><p>Sets the cooling setpoint temperature in Celsius.</p></div>
397+
</dd>
398+
<dt id="pyControl4.climate.C4Climate.setCoolSetpointF"><code class="name flex">
399+
<span>async def <span class="ident">setCoolSetpointF</span></span>(<span>self, temp)</span>
400+
</code></dt>
401+
<dd>
402+
<details class="source">
403+
<summary>
404+
<span>Expand source code</span>
405+
</summary>
406+
<pre><code class="python">async def setCoolSetpointF(self, temp):
323407
&#34;&#34;&#34;Sets the cooling setpoint temperature in Fahrenheit.&#34;&#34;&#34;
324408
await self.director.sendPostRequest(
325409
f&#34;/api/v1/items/{self.item_id}/commands&#34;,
@@ -347,15 +431,33 @@ <h3>Methods</h3>
347431
</details>
348432
<div class="desc"><p>Sets the fan operating mode (e.g., auto, on, circulate).</p></div>
349433
</dd>
350-
<dt id="pyControl4.climate.C4Climate.setHeatSetpoint"><code class="name flex">
351-
<span>async def <span class="ident">setHeatSetpoint</span></span>(<span>self, temp)</span>
434+
<dt id="pyControl4.climate.C4Climate.setHeatSetpointC"><code class="name flex">
435+
<span>async def <span class="ident">setHeatSetpointC</span></span>(<span>self, temp)</span>
436+
</code></dt>
437+
<dd>
438+
<details class="source">
439+
<summary>
440+
<span>Expand source code</span>
441+
</summary>
442+
<pre><code class="python">async def setHeatSetpointC(self, temp):
443+
&#34;&#34;&#34;Sets the heating setpoint temperature in Celsius.&#34;&#34;&#34;
444+
await self.director.sendPostRequest(
445+
f&#34;/api/v1/items/{self.item_id}/commands&#34;,
446+
&#34;SET_SETPOINT_HEAT&#34;,
447+
{&#34;CELSIUS&#34;: temp},
448+
)</code></pre>
449+
</details>
450+
<div class="desc"><p>Sets the heating setpoint temperature in Celsius.</p></div>
451+
</dd>
452+
<dt id="pyControl4.climate.C4Climate.setHeatSetpointF"><code class="name flex">
453+
<span>async def <span class="ident">setHeatSetpointF</span></span>(<span>self, temp)</span>
352454
</code></dt>
353455
<dd>
354456
<details class="source">
355457
<summary>
356458
<span>Expand source code</span>
357459
</summary>
358-
<pre><code class="python">async def setHeatSetpoint(self, temp):
460+
<pre><code class="python">async def setHeatSetpointF(self, temp):
359461
&#34;&#34;&#34;Sets the heating setpoint temperature in Fahrenheit.&#34;&#34;&#34;
360462
await self.director.sendPostRequest(
361463
f&#34;/api/v1/items/{self.item_id}/commands&#34;,
@@ -401,20 +503,6 @@ <h3>Methods</h3>
401503
</details>
402504
<div class="desc"><p>Applies a predefined climate preset by name.</p></div>
403505
</dd>
404-
<dt id="pyControl4.climate.C4Climate.setTemperature"><code class="name flex">
405-
<span>async def <span class="ident">setTemperature</span></span>(<span>self, temp)</span>
406-
</code></dt>
407-
<dd>
408-
<details class="source">
409-
<summary>
410-
<span>Expand source code</span>
411-
</summary>
412-
<pre><code class="python">async def setTemperature(self, temp):
413-
&#34;&#34;&#34;Sets the cooling setpoint temperature in Fahrenheit.&#34;&#34;&#34;
414-
await self.setCoolSetpoint(temp) # Delegates to the proper method</code></pre>
415-
</details>
416-
<div class="desc"><p>Sets the cooling setpoint temperature in Fahrenheit.</p></div>
417-
</dd>
418506
</dl>
419507
</dd>
420508
</dl>
@@ -435,22 +523,26 @@ <h3>Methods</h3>
435523
<li>
436524
<h4><code><a title="pyControl4.climate.C4Climate" href="#pyControl4.climate.C4Climate">C4Climate</a></code></h4>
437525
<ul class="">
526+
<li><code><a title="pyControl4.climate.C4Climate.getCoolSetpointC" href="#pyControl4.climate.C4Climate.getCoolSetpointC">getCoolSetpointC</a></code></li>
438527
<li><code><a title="pyControl4.climate.C4Climate.getCoolSetpointF" href="#pyControl4.climate.C4Climate.getCoolSetpointF">getCoolSetpointF</a></code></li>
439-
<li><code><a title="pyControl4.climate.C4Climate.getCurrentTemperature" href="#pyControl4.climate.C4Climate.getCurrentTemperature">getCurrentTemperature</a></code></li>
528+
<li><code><a title="pyControl4.climate.C4Climate.getCurrentTemperatureC" href="#pyControl4.climate.C4Climate.getCurrentTemperatureC">getCurrentTemperatureC</a></code></li>
529+
<li><code><a title="pyControl4.climate.C4Climate.getCurrentTemperatureF" href="#pyControl4.climate.C4Climate.getCurrentTemperatureF">getCurrentTemperatureF</a></code></li>
440530
<li><code><a title="pyControl4.climate.C4Climate.getFANMode" href="#pyControl4.climate.C4Climate.getFANMode">getFANMode</a></code></li>
441531
<li><code><a title="pyControl4.climate.C4Climate.getFANModes" href="#pyControl4.climate.C4Climate.getFANModes">getFANModes</a></code></li>
442532
<li><code><a title="pyControl4.climate.C4Climate.getFANState" href="#pyControl4.climate.C4Climate.getFANState">getFANState</a></code></li>
443533
<li><code><a title="pyControl4.climate.C4Climate.getHVACMode" href="#pyControl4.climate.C4Climate.getHVACMode">getHVACMode</a></code></li>
444534
<li><code><a title="pyControl4.climate.C4Climate.getHVACModes" href="#pyControl4.climate.C4Climate.getHVACModes">getHVACModes</a></code></li>
445535
<li><code><a title="pyControl4.climate.C4Climate.getHVACState" href="#pyControl4.climate.C4Climate.getHVACState">getHVACState</a></code></li>
536+
<li><code><a title="pyControl4.climate.C4Climate.getHeatSetpointC" href="#pyControl4.climate.C4Climate.getHeatSetpointC">getHeatSetpointC</a></code></li>
446537
<li><code><a title="pyControl4.climate.C4Climate.getHeatSetpointF" href="#pyControl4.climate.C4Climate.getHeatSetpointF">getHeatSetpointF</a></code></li>
447538
<li><code><a title="pyControl4.climate.C4Climate.getHumidity" href="#pyControl4.climate.C4Climate.getHumidity">getHumidity</a></code></li>
448-
<li><code><a title="pyControl4.climate.C4Climate.setCoolSetpoint" href="#pyControl4.climate.C4Climate.setCoolSetpoint">setCoolSetpoint</a></code></li>
539+
<li><code><a title="pyControl4.climate.C4Climate.setCoolSetpointC" href="#pyControl4.climate.C4Climate.setCoolSetpointC">setCoolSetpointC</a></code></li>
540+
<li><code><a title="pyControl4.climate.C4Climate.setCoolSetpointF" href="#pyControl4.climate.C4Climate.setCoolSetpointF">setCoolSetpointF</a></code></li>
449541
<li><code><a title="pyControl4.climate.C4Climate.setFanMode" href="#pyControl4.climate.C4Climate.setFanMode">setFanMode</a></code></li>
450-
<li><code><a title="pyControl4.climate.C4Climate.setHeatSetpoint" href="#pyControl4.climate.C4Climate.setHeatSetpoint">setHeatSetpoint</a></code></li>
542+
<li><code><a title="pyControl4.climate.C4Climate.setHeatSetpointC" href="#pyControl4.climate.C4Climate.setHeatSetpointC">setHeatSetpointC</a></code></li>
543+
<li><code><a title="pyControl4.climate.C4Climate.setHeatSetpointF" href="#pyControl4.climate.C4Climate.setHeatSetpointF">setHeatSetpointF</a></code></li>
451544
<li><code><a title="pyControl4.climate.C4Climate.setHvacMode" href="#pyControl4.climate.C4Climate.setHvacMode">setHvacMode</a></code></li>
452545
<li><code><a title="pyControl4.climate.C4Climate.setPreset" href="#pyControl4.climate.C4Climate.setPreset">setPreset</a></code></li>
453-
<li><code><a title="pyControl4.climate.C4Climate.setTemperature" href="#pyControl4.climate.C4Climate.setTemperature">setTemperature</a></code></li>
454546
</ul>
455547
</li>
456548
</ul>

0 commit comments

Comments
 (0)