File: blind.html

package info (click to toggle)
pycontrol4 2.0.2-1
links: PTS, VCS
area: main
in suites: forky, sid
size: 656 kB
sloc: python: 1,438; makefile: 3
file content (545 lines) | stat: -rw-r--r-- 27,338 bytes
<!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.blind API documentation</title>
<meta name="description" content="Controls Control4 blind 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.blind</code></h1>
</header>
<section id="section-intro">
<p>Controls Control4 blind devices.</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pyControl4.blind.C4Blind"><code class="flex name class">
<span>class <span class="ident">C4Blind</span></span>
<span>(</span><span>director: C4Director, item_id: int)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class C4Blind(C4Entity):
    async def get_battery_level(self) -&gt; int | None:
        &#34;&#34;&#34;Returns the battery of a blind. We currently don&#39;t know the range or
        meaning.
        &#34;&#34;&#34;
        value = await self.director.get_item_variable_value(
            self.item_id, &#34;Battery Level&#34;
        )
        if value is None:
            return None
        return int(value)

    async def get_closing(self) -&gt; bool | None:
        &#34;&#34;&#34;Returns an indication of whether the blind is moving in the closed direction
        as a boolean (True=closing, False=opening). If the blind is stopped, reports
        the direction it last moved.
        &#34;&#34;&#34;
        value = await self.director.get_item_variable_value(self.item_id, &#34;Closing&#34;)
        if value is None:
            return None
        return bool(value)

    async def get_fully_closed(self) -&gt; bool | None:
        &#34;&#34;&#34;Returns an indication of whether the blind is fully closed as a boolean
        (True=fully closed, False=at least partially open).&#34;&#34;&#34;
        value = await self.director.get_item_variable_value(
            self.item_id, &#34;Fully Closed&#34;
        )
        if value is None:
            return None
        return bool(value)

    async def get_fully_open(self) -&gt; bool | None:
        &#34;&#34;&#34;Returns an indication of whether the blind is fully open as a boolean
        (True=fully open, False=at least partially closed).&#34;&#34;&#34;
        value = await self.director.get_item_variable_value(self.item_id, &#34;Fully Open&#34;)
        if value is None:
            return None
        return bool(value)

    async def get_level(self) -&gt; int | None:
        &#34;&#34;&#34;Returns the level (current position) of a blind as an int 0-100.
        0 is fully closed and 100 is fully open.
        &#34;&#34;&#34;
        value = await self.director.get_item_variable_value(self.item_id, &#34;Level&#34;)
        if value is None:
            return None
        return int(value)

    async def get_open(self) -&gt; bool | None:
        &#34;&#34;&#34;Returns an indication of whether the blind is open as a boolean (True=open,
        False=closed). This is true even if the blind is only partially open.
        &#34;&#34;&#34;
        value = await self.director.get_item_variable_value(self.item_id, &#34;Open&#34;)
        if value is None:
            return None
        return bool(value)

    async def get_opening(self) -&gt; bool | None:
        &#34;&#34;&#34;Returns an indication of whether the blind is moving in the open direction
        as a boolean (True=opening, False=closing). If the blind is stopped, reports
        the direction it last moved.
        &#34;&#34;&#34;
        value = await self.director.get_item_variable_value(self.item_id, &#34;Opening&#34;)
        if value is None:
            return None
        return bool(value)

    async def get_stopped(self) -&gt; bool | None:
        &#34;&#34;&#34;Returns an indication of whether the blind is stopped as a boolean
        (True=stopped, False=moving).&#34;&#34;&#34;
        value = await self.director.get_item_variable_value(self.item_id, &#34;Stopped&#34;)
        if value is None:
            return None
        return bool(value)

    async def get_target_level(self) -&gt; int | None:
        &#34;&#34;&#34;Returns the target level (desired position) of a blind as an int 0-100.
         The blind will move if this is different from the current level.
        0 is fully closed and 100 is fully open.
        &#34;&#34;&#34;
        value = await self.director.get_item_variable_value(
            self.item_id, &#34;Target Level&#34;
        )
        if value is None:
            return None
        return int(value)

    async def open(self) -&gt; None:
        &#34;&#34;&#34;Opens the blind completely.&#34;&#34;&#34;
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;SET_LEVEL_TARGET:LEVEL_TARGET_OPEN&#34;,
            {},
        )

    async def close(self) -&gt; None:
        &#34;&#34;&#34;Closes the blind completely.&#34;&#34;&#34;
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;SET_LEVEL_TARGET:LEVEL_TARGET_CLOSED&#34;,
            {},
        )

    async def set_level_target(self, level: int) -&gt; None:
        &#34;&#34;&#34;Sets the desired level of a blind; it will start moving towards that level.
        Level 0 is fully closed and level 100 is fully open.

        Parameters:
            `level` - (int) 0-100
        &#34;&#34;&#34;
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;SET_LEVEL_TARGET&#34;,
            {&#34;LEVEL_TARGET&#34;: level},
        )

    async def stop(self) -&gt; None:
        &#34;&#34;&#34;Stops the blind if it is moving. Shortly after stopping, the target level
        will be set to the level the blind had actually reached when it stopped.
        &#34;&#34;&#34;
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;STOP&#34;,
            {},
        )

    async def toggle(self) -&gt; None:
        &#34;&#34;&#34;Toggles the blind between open and closed. Has no effect if the blind is
        partially open.
        &#34;&#34;&#34;
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;TOGGLE&#34;,
            {},
        )</code></pre>
</details>
<div class="desc"><p>Creates a Control4 object.</p>
<h2 id="parameters">Parameters</h2>
<p><code>director</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.blind.C4Blind.close"><code class="name flex">
<span>async def <span class="ident">close</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def close(self) -&gt; None:
    &#34;&#34;&#34;Closes the blind completely.&#34;&#34;&#34;
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;SET_LEVEL_TARGET:LEVEL_TARGET_CLOSED&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Closes the blind completely.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_battery_level"><code class="name flex">
<span>async def <span class="ident">get_battery_level</span></span>(<span>self) ‑> int | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_battery_level(self) -&gt; int | None:
    &#34;&#34;&#34;Returns the battery of a blind. We currently don&#39;t know the range or
    meaning.
    &#34;&#34;&#34;
    value = await self.director.get_item_variable_value(
        self.item_id, &#34;Battery Level&#34;
    )
    if value is None:
        return None
    return int(value)</code></pre>
</details>
<div class="desc"><p>Returns the battery of a blind. We currently don't know the range or
meaning.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_closing"><code class="name flex">
<span>async def <span class="ident">get_closing</span></span>(<span>self) ‑> bool | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_closing(self) -&gt; bool | None:
    &#34;&#34;&#34;Returns an indication of whether the blind is moving in the closed direction
    as a boolean (True=closing, False=opening). If the blind is stopped, reports
    the direction it last moved.
    &#34;&#34;&#34;
    value = await self.director.get_item_variable_value(self.item_id, &#34;Closing&#34;)
    if value is None:
        return None
    return bool(value)</code></pre>
</details>
<div class="desc"><p>Returns an indication of whether the blind is moving in the closed direction
as a boolean (True=closing, False=opening). If the blind is stopped, reports
the direction it last moved.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_fully_closed"><code class="name flex">
<span>async def <span class="ident">get_fully_closed</span></span>(<span>self) ‑> bool | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_fully_closed(self) -&gt; bool | None:
    &#34;&#34;&#34;Returns an indication of whether the blind is fully closed as a boolean
    (True=fully closed, False=at least partially open).&#34;&#34;&#34;
    value = await self.director.get_item_variable_value(
        self.item_id, &#34;Fully Closed&#34;
    )
    if value is None:
        return None
    return bool(value)</code></pre>
</details>
<div class="desc"><p>Returns an indication of whether the blind is fully closed as a boolean
(True=fully closed, False=at least partially open).</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_fully_open"><code class="name flex">
<span>async def <span class="ident">get_fully_open</span></span>(<span>self) ‑> bool | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_fully_open(self) -&gt; bool | None:
    &#34;&#34;&#34;Returns an indication of whether the blind is fully open as a boolean
    (True=fully open, False=at least partially closed).&#34;&#34;&#34;
    value = await self.director.get_item_variable_value(self.item_id, &#34;Fully Open&#34;)
    if value is None:
        return None
    return bool(value)</code></pre>
</details>
<div class="desc"><p>Returns an indication of whether the blind is fully open as a boolean
(True=fully open, False=at least partially closed).</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_level"><code class="name flex">
<span>async def <span class="ident">get_level</span></span>(<span>self) ‑> int | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_level(self) -&gt; int | None:
    &#34;&#34;&#34;Returns the level (current position) of a blind as an int 0-100.
    0 is fully closed and 100 is fully open.
    &#34;&#34;&#34;
    value = await self.director.get_item_variable_value(self.item_id, &#34;Level&#34;)
    if value is None:
        return None
    return int(value)</code></pre>
</details>
<div class="desc"><p>Returns the level (current position) of a blind as an int 0-100.
0 is fully closed and 100 is fully open.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_open"><code class="name flex">
<span>async def <span class="ident">get_open</span></span>(<span>self) ‑> bool | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_open(self) -&gt; bool | None:
    &#34;&#34;&#34;Returns an indication of whether the blind is open as a boolean (True=open,
    False=closed). This is true even if the blind is only partially open.
    &#34;&#34;&#34;
    value = await self.director.get_item_variable_value(self.item_id, &#34;Open&#34;)
    if value is None:
        return None
    return bool(value)</code></pre>
</details>
<div class="desc"><p>Returns an indication of whether the blind is open as a boolean (True=open,
False=closed). This is true even if the blind is only partially open.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_opening"><code class="name flex">
<span>async def <span class="ident">get_opening</span></span>(<span>self) ‑> bool | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_opening(self) -&gt; bool | None:
    &#34;&#34;&#34;Returns an indication of whether the blind is moving in the open direction
    as a boolean (True=opening, False=closing). If the blind is stopped, reports
    the direction it last moved.
    &#34;&#34;&#34;
    value = await self.director.get_item_variable_value(self.item_id, &#34;Opening&#34;)
    if value is None:
        return None
    return bool(value)</code></pre>
</details>
<div class="desc"><p>Returns an indication of whether the blind is moving in the open direction
as a boolean (True=opening, False=closing). If the blind is stopped, reports
the direction it last moved.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_stopped"><code class="name flex">
<span>async def <span class="ident">get_stopped</span></span>(<span>self) ‑> bool | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_stopped(self) -&gt; bool | None:
    &#34;&#34;&#34;Returns an indication of whether the blind is stopped as a boolean
    (True=stopped, False=moving).&#34;&#34;&#34;
    value = await self.director.get_item_variable_value(self.item_id, &#34;Stopped&#34;)
    if value is None:
        return None
    return bool(value)</code></pre>
</details>
<div class="desc"><p>Returns an indication of whether the blind is stopped as a boolean
(True=stopped, False=moving).</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.get_target_level"><code class="name flex">
<span>async def <span class="ident">get_target_level</span></span>(<span>self) ‑> int | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_target_level(self) -&gt; int | None:
    &#34;&#34;&#34;Returns the target level (desired position) of a blind as an int 0-100.
     The blind will move if this is different from the current level.
    0 is fully closed and 100 is fully open.
    &#34;&#34;&#34;
    value = await self.director.get_item_variable_value(
        self.item_id, &#34;Target Level&#34;
    )
    if value is None:
        return None
    return int(value)</code></pre>
</details>
<div class="desc"><p>Returns the target level (desired position) of a blind as an int 0-100.
The blind will move if this is different from the current level.
0 is fully closed and 100 is fully open.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.open"><code class="name flex">
<span>async def <span class="ident">open</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def open(self) -&gt; None:
    &#34;&#34;&#34;Opens the blind completely.&#34;&#34;&#34;
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;SET_LEVEL_TARGET:LEVEL_TARGET_OPEN&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Opens the blind completely.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.set_level_target"><code class="name flex">
<span>async def <span class="ident">set_level_target</span></span>(<span>self, level: int) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def set_level_target(self, level: int) -&gt; None:
    &#34;&#34;&#34;Sets the desired level of a blind; it will start moving towards that level.
    Level 0 is fully closed and level 100 is fully open.

    Parameters:
        `level` - (int) 0-100
    &#34;&#34;&#34;
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;SET_LEVEL_TARGET&#34;,
        {&#34;LEVEL_TARGET&#34;: level},
    )</code></pre>
</details>
<div class="desc"><p>Sets the desired level of a blind; it will start moving towards that level.
Level 0 is fully closed and level 100 is fully open.</p>
<h2 id="parameters">Parameters</h2>
<p><code>level</code> - (int) 0-100</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.stop"><code class="name flex">
<span>async def <span class="ident">stop</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def stop(self) -&gt; None:
    &#34;&#34;&#34;Stops the blind if it is moving. Shortly after stopping, the target level
    will be set to the level the blind had actually reached when it stopped.
    &#34;&#34;&#34;
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;STOP&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Stops the blind if it is moving. Shortly after stopping, the target level
will be set to the level the blind had actually reached when it stopped.</p></div>
</dd>
<dt id="pyControl4.blind.C4Blind.toggle"><code class="name flex">
<span>async def <span class="ident">toggle</span></span>(<span>self) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def toggle(self) -&gt; None:
    &#34;&#34;&#34;Toggles the blind between open and closed. Has no effect if the blind is
    partially open.
    &#34;&#34;&#34;
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;TOGGLE&#34;,
        {},
    )</code></pre>
</details>
<div class="desc"><p>Toggles the blind between open and closed. Has no effect if the blind is
partially open.</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.blind.C4Blind" href="#pyControl4.blind.C4Blind">C4Blind</a></code></h4>
<ul class="two-column">
<li><code><a title="pyControl4.blind.C4Blind.close" href="#pyControl4.blind.C4Blind.close">close</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_battery_level" href="#pyControl4.blind.C4Blind.get_battery_level">get_battery_level</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_closing" href="#pyControl4.blind.C4Blind.get_closing">get_closing</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_fully_closed" href="#pyControl4.blind.C4Blind.get_fully_closed">get_fully_closed</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_fully_open" href="#pyControl4.blind.C4Blind.get_fully_open">get_fully_open</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_level" href="#pyControl4.blind.C4Blind.get_level">get_level</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_open" href="#pyControl4.blind.C4Blind.get_open">get_open</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_opening" href="#pyControl4.blind.C4Blind.get_opening">get_opening</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_stopped" href="#pyControl4.blind.C4Blind.get_stopped">get_stopped</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.get_target_level" href="#pyControl4.blind.C4Blind.get_target_level">get_target_level</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.open" href="#pyControl4.blind.C4Blind.open">open</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.set_level_target" href="#pyControl4.blind.C4Blind.set_level_target">set_level_target</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.stop" href="#pyControl4.blind.C4Blind.stop">stop</a></code></li>
<li><code><a title="pyControl4.blind.C4Blind.toggle" href="#pyControl4.blind.C4Blind.toggle">toggle</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>