File: websocket.html

package info (click to toggle)
pycontrol4 1.5.0-1
links: PTS, VCS
area: main
in suites: forky, sid
size: 548 kB
sloc: python: 914; makefile: 2
file content (366 lines) | stat: -rw-r--r-- 20,690 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.websocket API documentation</title>
<meta name="description" content="Handles Websocket connections to a Control4 Director, allowing for real-time updates using callbacks.">
<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.websocket</code></h1>
</header>
<section id="section-intro">
<p>Handles Websocket connections to a Control4 Director, allowing for real-time updates using callbacks.</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pyControl4.websocket.C4Websocket"><code class="flex name class">
<span>class <span class="ident">C4Websocket</span></span>
<span>(</span><span>ip,<br>session_no_verify_ssl: aiohttp.client.ClientSession = None,<br>connect_callback=None,<br>disconnect_callback=None)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">class C4Websocket:
    def __init__(
        self,
        ip,
        session_no_verify_ssl: aiohttp.ClientSession = None,
        connect_callback=None,
        disconnect_callback=None,
    ):
        &#34;&#34;&#34;Creates a Control4 Websocket object.

        Parameters:
            `ip` - The IP address of the Control4 Director/Controller.

            `session` - (Optional) Allows the use of an
                        `aiohttp.ClientSession` object
                        for all network requests. This
                        session will not be closed by the library.
                        If not provided, the library will open and
                        close its own `ClientSession`s as needed.

            `connect_callback` - (Optional) A callback to be called when the Websocket connection is opened or reconnected after a network error.

            `disconnect_callback` - (Optional) A callback to be called when the Websocket connection is lost due to a network error.
        &#34;&#34;&#34;
        self.base_url = &#34;https://{}&#34;.format(ip)
        self.wss_url = &#34;wss://{}&#34;.format(ip)
        self.session = session_no_verify_ssl
        self.connect_callback = connect_callback
        self.disconnect_callback = disconnect_callback

        # Keep track of the callbacks registered for each item id
        self._item_callbacks = dict()
        # Initialize self._sio to None
        self._sio = None

    @property
    def item_callbacks(self):
        &#34;&#34;&#34;Returns a dictionary of registered item ids (key) and their callbacks (value).

        item_callbacks cannot be modified directly. Use add_item_callback() and remove_item_callback() instead.
        &#34;&#34;&#34;
        return self._item_callbacks

    def add_item_callback(self, item_id, callback):
        &#34;&#34;&#34;Register a callback to receive updates about an item.
        If a callback is already registered for the item, it will be overwritten with the provided callback.

        Parameters:
            `item_id` - The Control4 item ID.

            `callback` - The callback to be called when an update is received for the provided item id.
        &#34;&#34;&#34;

        _LOGGER.debug(&#34;Subscribing to updates for item id: %s&#34;, item_id)

        self._item_callbacks[item_id] = callback

    def remove_item_callback(self, item_id):
        &#34;&#34;&#34;Unregister callback for an item.

        Parameters:
            `item_id` - The Control4 item ID.
        &#34;&#34;&#34;
        self._item_callbacks.pop(item_id)

    async def sio_connect(self, director_bearer_token):
        &#34;&#34;&#34;Start WebSockets connection and listen, using the provided director_bearer_token to authenticate with the Control4 Director.
        If a connection already exists, it will be disconnected and a new connection will be created.

        This function should be called using a new token every 86400 seconds (the expiry time of the director tokens), otherwise the Control4 Director will stop sending WebSocket messages.

        Parameters:
            `director_bearer_token` - The bearer token used to authenticate with the Director. See `pyControl4.account.C4Account.getDirectorBearerToken` for how to get this.
        &#34;&#34;&#34;
        # Disconnect previous sio object
        await self.sio_disconnect()

        self._sio = socketio.AsyncClient(ssl_verify=False)
        self._sio.register_namespace(
            _C4DirectorNamespace(
                token=director_bearer_token,
                url=self.base_url,
                callback=self._callback,
                session=self.session,
                connect_callback=self.connect_callback,
                disconnect_callback=self.disconnect_callback,
            )
        )
        await self._sio.connect(
            self.wss_url,
            transports=[&#34;websocket&#34;],
            headers={&#34;JWT&#34;: director_bearer_token},
        )

    async def sio_disconnect(self):
        &#34;&#34;&#34;Disconnects the WebSockets connection, if it has been created.&#34;&#34;&#34;
        if isinstance(self._sio, socketio.AsyncClient):
            await self._sio.disconnect()

    async def _callback(self, message):
        if &#34;status&#34; in message:
            _LOGGER.debug(f&#39;Subscription {message[&#34;status&#34;]}&#39;)
            return True
        if isinstance(message, list):
            for m in message:
                await self._process_message(m)
        else:
            await self._process_message(message)

    async def _process_message(self, message):
        &#34;&#34;&#34;Process an incoming event message.&#34;&#34;&#34;
        _LOGGER.debug(message)
        try:
            c = self._item_callbacks[message[&#34;iddevice&#34;]]
        except KeyError:
            _LOGGER.debug(&#34;No Callback for device id {}&#34;.format(message[&#34;iddevice&#34;]))
            return True

        if isinstance(message, list):
            for m in message:
                await c(message[&#34;iddevice&#34;], m)
        else:
            await c(message[&#34;iddevice&#34;], message)

    async def _execute_callback(self, callback, *args, **kwargs):
        &#34;&#34;&#34;Callback with some data capturing any excpetions.&#34;&#34;&#34;
        try:
            self.sio.emit(&#34;ping&#34;)
            await callback(*args, **kwargs)
        except Exception as exc:
            _LOGGER.warning(&#34;Captured exception during callback: {}&#34;.format(str(exc)))</code></pre>
</details>
<div class="desc"><p>Creates a Control4 Websocket object.</p>
<h2 id="parameters">Parameters</h2>
<p><code>ip</code> - The IP address of the Control4 Director/Controller.</p>
<p><code>session</code> - (Optional) Allows the use of an
<code>aiohttp.ClientSession</code> object
for all network requests. This
session will not be closed by the library.
If not provided, the library will open and
close its own <code>ClientSession</code>s as needed.</p>
<p><code>connect_callback</code> - (Optional) A callback to be called when the Websocket connection is opened or reconnected after a network error.</p>
<p><code>disconnect_callback</code> - (Optional) A callback to be called when the Websocket connection is lost due to a network error.</p></div>
<h3>Instance variables</h3>
<dl>
<dt id="pyControl4.websocket.C4Websocket.item_callbacks"><code class="name">prop <span class="ident">item_callbacks</span></code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">@property
def item_callbacks(self):
    &#34;&#34;&#34;Returns a dictionary of registered item ids (key) and their callbacks (value).

    item_callbacks cannot be modified directly. Use add_item_callback() and remove_item_callback() instead.
    &#34;&#34;&#34;
    return self._item_callbacks</code></pre>
</details>
<div class="desc"><p>Returns a dictionary of registered item ids (key) and their callbacks (value).</p>
<p>item_callbacks cannot be modified directly. Use add_item_callback() and remove_item_callback() instead.</p></div>
</dd>
</dl>
<h3>Methods</h3>
<dl>
<dt id="pyControl4.websocket.C4Websocket.add_item_callback"><code class="name flex">
<span>def <span class="ident">add_item_callback</span></span>(<span>self, item_id, callback)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def add_item_callback(self, item_id, callback):
    &#34;&#34;&#34;Register a callback to receive updates about an item.
    If a callback is already registered for the item, it will be overwritten with the provided callback.

    Parameters:
        `item_id` - The Control4 item ID.

        `callback` - The callback to be called when an update is received for the provided item id.
    &#34;&#34;&#34;

    _LOGGER.debug(&#34;Subscribing to updates for item id: %s&#34;, item_id)

    self._item_callbacks[item_id] = callback</code></pre>
</details>
<div class="desc"><p>Register a callback to receive updates about an item.
If a callback is already registered for the item, it will be overwritten with the provided callback.</p>
<h2 id="parameters">Parameters</h2>
<p><code>item_id</code> - The Control4 item ID.</p>
<p><code>callback</code> - The callback to be called when an update is received for the provided item id.</p></div>
</dd>
<dt id="pyControl4.websocket.C4Websocket.remove_item_callback"><code class="name flex">
<span>def <span class="ident">remove_item_callback</span></span>(<span>self, item_id)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def remove_item_callback(self, item_id):
    &#34;&#34;&#34;Unregister callback for an item.

    Parameters:
        `item_id` - The Control4 item ID.
    &#34;&#34;&#34;
    self._item_callbacks.pop(item_id)</code></pre>
</details>
<div class="desc"><p>Unregister callback for an item.</p>
<h2 id="parameters">Parameters</h2>
<p><code>item_id</code> - The Control4 item ID.</p></div>
</dd>
<dt id="pyControl4.websocket.C4Websocket.sio_connect"><code class="name flex">
<span>async def <span class="ident">sio_connect</span></span>(<span>self, director_bearer_token)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def sio_connect(self, director_bearer_token):
    &#34;&#34;&#34;Start WebSockets connection and listen, using the provided director_bearer_token to authenticate with the Control4 Director.
    If a connection already exists, it will be disconnected and a new connection will be created.

    This function should be called using a new token every 86400 seconds (the expiry time of the director tokens), otherwise the Control4 Director will stop sending WebSocket messages.

    Parameters:
        `director_bearer_token` - The bearer token used to authenticate with the Director. See `pyControl4.account.C4Account.getDirectorBearerToken` for how to get this.
    &#34;&#34;&#34;
    # Disconnect previous sio object
    await self.sio_disconnect()

    self._sio = socketio.AsyncClient(ssl_verify=False)
    self._sio.register_namespace(
        _C4DirectorNamespace(
            token=director_bearer_token,
            url=self.base_url,
            callback=self._callback,
            session=self.session,
            connect_callback=self.connect_callback,
            disconnect_callback=self.disconnect_callback,
        )
    )
    await self._sio.connect(
        self.wss_url,
        transports=[&#34;websocket&#34;],
        headers={&#34;JWT&#34;: director_bearer_token},
    )</code></pre>
</details>
<div class="desc"><p>Start WebSockets connection and listen, using the provided director_bearer_token to authenticate with the Control4 Director.
If a connection already exists, it will be disconnected and a new connection will be created.</p>
<p>This function should be called using a new token every 86400 seconds (the expiry time of the director tokens), otherwise the Control4 Director will stop sending WebSocket messages.</p>
<h2 id="parameters">Parameters</h2>
<p><code>director_bearer_token</code> - The bearer token used to authenticate with the Director. See <code><a title="pyControl4.account.C4Account.getDirectorBearerToken" href="account.html#pyControl4.account.C4Account.getDirectorBearerToken">C4Account.getDirectorBearerToken()</a></code> for how to get this.</p></div>
</dd>
<dt id="pyControl4.websocket.C4Websocket.sio_disconnect"><code class="name flex">
<span>async def <span class="ident">sio_disconnect</span></span>(<span>self)</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def sio_disconnect(self):
    &#34;&#34;&#34;Disconnects the WebSockets connection, if it has been created.&#34;&#34;&#34;
    if isinstance(self._sio, socketio.AsyncClient):
        await self._sio.disconnect()</code></pre>
</details>
<div class="desc"><p>Disconnects the WebSockets connection, if it has been created.</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.websocket.C4Websocket" href="#pyControl4.websocket.C4Websocket">C4Websocket</a></code></h4>
<ul class="">
<li><code><a title="pyControl4.websocket.C4Websocket.add_item_callback" href="#pyControl4.websocket.C4Websocket.add_item_callback">add_item_callback</a></code></li>
<li><code><a title="pyControl4.websocket.C4Websocket.item_callbacks" href="#pyControl4.websocket.C4Websocket.item_callbacks">item_callbacks</a></code></li>
<li><code><a title="pyControl4.websocket.C4Websocket.remove_item_callback" href="#pyControl4.websocket.C4Websocket.remove_item_callback">remove_item_callback</a></code></li>
<li><code><a title="pyControl4.websocket.C4Websocket.sio_connect" href="#pyControl4.websocket.C4Websocket.sio_connect">sio_connect</a></code></li>
<li><code><a title="pyControl4.websocket.C4Websocket.sio_disconnect" href="#pyControl4.websocket.C4Websocket.sio_disconnect">sio_disconnect</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>