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
|
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.6">
<title>pyControl4.fan API documentation</title>
<meta name="description" content="Controls Control4 Fan devices.">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>pyControl4.fan</code></h1>
</header>
<section id="section-intro">
<p>Controls Control4 Fan devices.</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pyControl4.fan.C4Fan"><code class="flex name class">
<span>class <span class="ident">C4Fan</span></span>
<span>(</span><span>C4Director, item_id)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class C4Fan(C4Entity):
# ------------------------
# Fan State Getters
# ------------------------
async def getState(self):
"""
Returns the current power state of the fan.
Returns:
bool: True if the fan is on, False otherwise.
"""
value = await self.director.getItemVariableValue(self.item_id, "IS_ON")
return bool(value)
async def getSpeed(self):
"""
Returns the current speed of the fan controller.
Valid speed values:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High
Note:
Only valid for fan controllers. On non-dimmer switches,
use `getState()` instead.
Returns:
int: Current fan speed (0–4).
"""
value = await self.director.getItemVariableValue(self.item_id, "CURRENT_SPEED")
return int(value)
# ------------------------
# Fan Control Setters
# ------------------------
async def setSpeed(self, speed: int):
"""
Sets the fan speed or turns it off.
Parameters:
speed (int): Fan speed level:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High
"""
await self.director.sendPostRequest(
f"/api/v1/items/{self.item_id}/commands",
"SET_SPEED",
{"SPEED": speed},
)
async def setPreset(self, preset: int):
"""
Sets the fan's preset speed — the speed used when the fan is
turned on without specifying speed.
Parameters:
preset (int): Preset fan speed level:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High
"""
await self.director.sendPostRequest(
f"/api/v1/items/{self.item_id}/commands",
"DESIGNATE_PRESET",
{"PRESET": preset},
)</code></pre>
</details>
<div class="desc"><p>Creates a Control4 object.</p>
<h2 id="parameters">Parameters</h2>
<p><code>C4Director</code> - A <code><a title="pyControl4.director.C4Director" href="director.html#pyControl4.director.C4Director">C4Director</a></code> object that corresponds to the Control4 Director that the device is connected to.</p>
<p><code>item_id</code> - The Control4 item ID.</p></div>
<h3>Ancestors</h3>
<ul class="hlist">
<li><a title="pyControl4.C4Entity" href="index.html#pyControl4.C4Entity">C4Entity</a></li>
</ul>
<h3>Methods</h3>
<dl>
<dt id="pyControl4.fan.C4Fan.getSpeed"><code class="name flex">
<span>async def <span class="ident">getSpeed</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def getSpeed(self):
"""
Returns the current speed of the fan controller.
Valid speed values:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High
Note:
Only valid for fan controllers. On non-dimmer switches,
use `getState()` instead.
Returns:
int: Current fan speed (0–4).
"""
value = await self.director.getItemVariableValue(self.item_id, "CURRENT_SPEED")
return int(value)</code></pre>
</details>
<div class="desc"><p>Returns the current speed of the fan controller.</p>
<p>Valid speed values:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High</p>
<h2 id="note">Note</h2>
<p>Only valid for fan controllers. On non-dimmer switches,
use <code>getState()</code> instead.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>int</code></dt>
<dd>Current fan speed (0–4).</dd>
</dl></div>
</dd>
<dt id="pyControl4.fan.C4Fan.getState"><code class="name flex">
<span>async def <span class="ident">getState</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def getState(self):
"""
Returns the current power state of the fan.
Returns:
bool: True if the fan is on, False otherwise.
"""
value = await self.director.getItemVariableValue(self.item_id, "IS_ON")
return bool(value)</code></pre>
</details>
<div class="desc"><p>Returns the current power state of the fan.</p>
<h2 id="returns">Returns</h2>
<dl>
<dt><code>bool</code></dt>
<dd>True if the fan is on, False otherwise.</dd>
</dl></div>
</dd>
<dt id="pyControl4.fan.C4Fan.setPreset"><code class="name flex">
<span>async def <span class="ident">setPreset</span></span>(<span>self, preset: int)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setPreset(self, preset: int):
"""
Sets the fan's preset speed — the speed used when the fan is
turned on without specifying speed.
Parameters:
preset (int): Preset fan speed level:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High
"""
await self.director.sendPostRequest(
f"/api/v1/items/{self.item_id}/commands",
"DESIGNATE_PRESET",
{"PRESET": preset},
)</code></pre>
</details>
<div class="desc"><p>Sets the fan's preset speed — the speed used when the fan is
turned on without specifying speed.</p>
<h2 id="parameters">Parameters</h2>
<p>preset (int): Preset fan speed level:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High</p></div>
</dd>
<dt id="pyControl4.fan.C4Fan.setSpeed"><code class="name flex">
<span>async def <span class="ident">setSpeed</span></span>(<span>self, speed: int)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def setSpeed(self, speed: int):
"""
Sets the fan speed or turns it off.
Parameters:
speed (int): Fan speed level:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High
"""
await self.director.sendPostRequest(
f"/api/v1/items/{self.item_id}/commands",
"SET_SPEED",
{"SPEED": speed},
)</code></pre>
</details>
<div class="desc"><p>Sets the fan speed or turns it off.</p>
<h2 id="parameters">Parameters</h2>
<p>speed (int): Fan speed level:
0 - Off
1 - Low
2 - Medium
3 - Medium High
4 - High</p></div>
</dd>
</dl>
</dd>
</dl>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="pyControl4" href="index.html">pyControl4</a></code></li>
</ul>
</li>
<li><h3><a href="#header-classes">Classes</a></h3>
<ul>
<li>
<h4><code><a title="pyControl4.fan.C4Fan" href="#pyControl4.fan.C4Fan">C4Fan</a></code></h4>
<ul class="">
<li><code><a title="pyControl4.fan.C4Fan.getSpeed" href="#pyControl4.fan.C4Fan.getSpeed">getSpeed</a></code></li>
<li><code><a title="pyControl4.fan.C4Fan.getState" href="#pyControl4.fan.C4Fan.getState">getState</a></code></li>
<li><code><a title="pyControl4.fan.C4Fan.setPreset" href="#pyControl4.fan.C4Fan.setPreset">setPreset</a></code></li>
<li><code><a title="pyControl4.fan.C4Fan.setSpeed" href="#pyControl4.fan.C4Fan.setSpeed">setSpeed</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.6</a>.</p>
</footer>
</body>
</html>
|
