File: alarm.html

package info (click to toggle)
pycontrol4 2.0.2-1
links: PTS, VCS
area: main
in suites: forky
size: 656 kB
sloc: python: 1,438; makefile: 3
file content (802 lines) | stat: -rw-r--r-- 39,178 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.alarm API documentation</title>
<meta name="description" content="Controls Control4 security panel and contact sensor (door, window, motion)
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.alarm</code></h1>
</header>
<section id="section-intro">
<p>Controls Control4 security panel and contact sensor (door, window, motion)
devices.</p>
</section>
<section>
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-classes">Classes</h2>
<dl>
<dt id="pyControl4.alarm.C4ContactSensor"><code class="flex name class">
<span>class <span class="ident">C4ContactSensor</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 C4ContactSensor:
    def __init__(self, director: C4Director, item_id: int) -&gt; None:
        &#34;&#34;&#34;Creates a Control4 Contact Sensor object.

        Parameters:
            `director` - A `pyControl4.director.C4Director` object that corresponds
                to the Control4 Director that the contact sensor is connected to.

            `item_id` - The Control4 item ID of the contact sensor.
        &#34;&#34;&#34;
        self.director = director
        self.item_id = item_id

    async def get_contact_state(self) -&gt; bool | None:
        &#34;&#34;&#34;Returns `True` if contact is triggered (door/window is closed, motion is
        detected), otherwise returns `False`.
        &#34;&#34;&#34;
        contact_state = await self.director.get_item_variable_value(
            self.item_id, &#34;ContactState&#34;
        )
        if contact_state is None:
            return None
        return bool(contact_state)</code></pre>
</details>
<div class="desc"><p>Creates a Control4 Contact Sensor 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 contact sensor is connected to.</p>
<p><code>item_id</code> - The Control4 item ID of the contact sensor.</p></div>
<h3>Methods</h3>
<dl>
<dt id="pyControl4.alarm.C4ContactSensor.get_contact_state"><code class="name flex">
<span>async def <span class="ident">get_contact_state</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_contact_state(self) -&gt; bool | None:
    &#34;&#34;&#34;Returns `True` if contact is triggered (door/window is closed, motion is
    detected), otherwise returns `False`.
    &#34;&#34;&#34;
    contact_state = await self.director.get_item_variable_value(
        self.item_id, &#34;ContactState&#34;
    )
    if contact_state is None:
        return None
    return bool(contact_state)</code></pre>
</details>
<div class="desc"><p>Returns <code>True</code> if contact is triggered (door/window is closed, motion is
detected), otherwise returns <code>False</code>.</p></div>
</dd>
</dl>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel"><code class="flex name class">
<span>class <span class="ident">C4SecurityPanel</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 C4SecurityPanel(C4Entity):
    async def get_arm_state(self) -&gt; str | None:
        &#34;&#34;&#34;
        NOTE: Prefer using `get_partition_state()`
        and `get_armed_type()` over this method.
        Returns the arm state of the security panel as &#34;DISARMED&#34;, &#34;ARMED_HOME&#34;,
        or &#34;ARMED_AWAY&#34;.
        &#34;&#34;&#34;
        disarmed = await self.director.get_item_variable_value(
            self.item_id, &#34;DISARMED_STATE&#34;
        )
        armed_home = await self.director.get_item_variable_value(
            self.item_id, &#34;HOME_STATE&#34;
        )
        armed_away = await self.director.get_item_variable_value(
            self.item_id, &#34;AWAY_STATE&#34;
        )
        try:
            if disarmed is not None and int(disarmed) == 1:
                return &#34;DISARMED&#34;
            elif armed_home is not None and int(armed_home) == 1:
                return &#34;ARMED_HOME&#34;
            elif armed_away is not None and int(armed_away) == 1:
                return &#34;ARMED_AWAY&#34;
        except (ValueError, TypeError):
            pass
        return None

    async def get_alarm_state(self) -&gt; bool | None:
        &#34;&#34;&#34;Returns `True` if alarm is triggered, otherwise returns `False`.&#34;&#34;&#34;
        alarm_state = await self.director.get_item_variable_value(
            self.item_id, &#34;ALARM_STATE&#34;
        )
        if alarm_state is None:
            return None
        return bool(alarm_state)

    async def get_display_text(self) -&gt; str | None:
        &#34;&#34;&#34;Returns the display text of the security panel.&#34;&#34;&#34;
        display_text = await self.director.get_item_variable_value(
            self.item_id, &#34;DISPLAY_TEXT&#34;
        )
        return display_text

    async def get_trouble_text(self) -&gt; str | None:
        &#34;&#34;&#34;Returns the trouble display text of the security panel.&#34;&#34;&#34;
        trouble_text = await self.director.get_item_variable_value(
            self.item_id, &#34;TROUBLE_TEXT&#34;
        )
        return trouble_text

    async def get_partition_state(self) -&gt; str | None:
        &#34;&#34;&#34;Returns the partition state of the security panel.

        Possible values include &#34;DISARMED_NOT_READY&#34;, &#34;DISARMED_READY&#34;, &#34;ARMED_HOME&#34;,
        &#34;ARMED_AWAY&#34;, &#34;EXIT_DELAY&#34;, &#34;ENTRY_DELAY&#34;
        &#34;&#34;&#34;
        partition_state = await self.director.get_item_variable_value(
            self.item_id, &#34;PARTITION_STATE&#34;
        )
        return partition_state

    async def get_delay_time_total(self) -&gt; int | None:
        &#34;&#34;&#34;Returns the total exit delay time. Returns 0 if an exit delay is not
        currently running.
        &#34;&#34;&#34;
        delay_time_total = await self.director.get_item_variable_value(
            self.item_id, &#34;DELAY_TIME_TOTAL&#34;
        )
        return int(delay_time_total) if delay_time_total is not None else None

    async def get_delay_time_remaining(self) -&gt; int | None:
        &#34;&#34;&#34;Returns the remaining exit delay time. Returns 0 if an exit delay is
        not currently running.
        &#34;&#34;&#34;
        delay_time_remaining = await self.director.get_item_variable_value(
            self.item_id, &#34;DELAY_TIME_REMAINING&#34;
        )
        return int(delay_time_remaining) if delay_time_remaining is not None else None

    async def get_open_zone_count(self) -&gt; int | None:
        &#34;&#34;&#34;Returns the number of open/unsecured zones.&#34;&#34;&#34;
        open_zone_count = await self.director.get_item_variable_value(
            self.item_id, &#34;OPEN_ZONE_COUNT&#34;
        )
        return int(open_zone_count) if open_zone_count is not None else None

    async def get_alarm_type(self) -&gt; str | None:
        &#34;&#34;&#34;Returns details about the current alarm type.&#34;&#34;&#34;
        alarm_type = await self.director.get_item_variable_value(
            self.item_id, &#34;ALARM_TYPE&#34;
        )
        return alarm_type

    async def get_armed_type(self) -&gt; str | None:
        &#34;&#34;&#34;Returns details about the current arm type.&#34;&#34;&#34;
        armed_type = await self.director.get_item_variable_value(
            self.item_id, &#34;ARMED_TYPE&#34;
        )
        return armed_type

    async def get_last_emergency(self) -&gt; str | None:
        &#34;&#34;&#34;Returns details about the last emergency trigger.&#34;&#34;&#34;
        last_emergency = await self.director.get_item_variable_value(
            self.item_id, &#34;LAST_EMERGENCY&#34;
        )
        return last_emergency

    async def get_last_arm_failure(self) -&gt; str | None:
        &#34;&#34;&#34;Returns details about the last arm failure.&#34;&#34;&#34;
        last_arm_failed = await self.director.get_item_variable_value(
            self.item_id, &#34;LAST_ARM_FAILED&#34;
        )
        return last_arm_failed

    async def set_arm(self, usercode: str, mode: str) -&gt; None:
        &#34;&#34;&#34;Arms the security panel with the specified mode.

        Parameters:
            `usercode` - PIN/code for arming the system.

            `mode` - Arm mode to use. This depends on what is supported by the
                security panel itself.
        &#34;&#34;&#34;
        usercode = str(usercode)
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;PARTITION_ARM&#34;,
            {&#34;ArmType&#34;: mode, &#34;UserCode&#34;: usercode},
        )

    async def set_disarm(self, usercode: str) -&gt; None:
        &#34;&#34;&#34;Disarms the security panel.

        Parameters:
            `usercode` - PIN/code for disarming the system.
        &#34;&#34;&#34;
        usercode = str(usercode)
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;PARTITION_DISARM&#34;,
            {&#34;UserCode&#34;: usercode},
        )

    async def get_emergency_types(self) -&gt; list[str]:
        &#34;&#34;&#34;Returns the available emergency types as a list.

        Possible types are &#34;Fire&#34;, &#34;Medical&#34;, &#34;Panic&#34;, and &#34;Police&#34;.
        &#34;&#34;&#34;
        types_list: list[str] = []

        data = await self.director.get_item_info(self.item_id)
        if not data or not isinstance(data, list) or len(data) == 0:
            return types_list

        capabilities = data[0].get(&#34;capabilities&#34;, {})
        if capabilities.get(&#34;has_fire&#34;):
            types_list.append(&#34;Fire&#34;)
        if capabilities.get(&#34;has_medical&#34;):
            types_list.append(&#34;Medical&#34;)
        if capabilities.get(&#34;has_panic&#34;):
            types_list.append(&#34;Panic&#34;)
        if capabilities.get(&#34;has_police&#34;):
            types_list.append(&#34;Police&#34;)

        return types_list

    async def get_arm_types(self) -&gt; list[str]:
        &#34;&#34;&#34;Returns the available arm types as a list.&#34;&#34;&#34;
        data = await self.director.get_item_info(self.item_id)
        if not data or not isinstance(data, list) or len(data) == 0:
            return []

        capabilities = data[0].get(&#34;capabilities&#34;, {})
        arm_types_str = capabilities.get(&#34;arm_types&#34;, &#34;&#34;)
        if not arm_types_str:
            return []
        return [t.strip() for t in arm_types_str.split(&#34;,&#34;) if t.strip()]

    async def trigger_emergency(self, emergency_type: str) -&gt; None:
        &#34;&#34;&#34;Triggers an emergency of the specified type.

        Parameters:
            `emergency_type` - Type of emergency:
            &#34;Fire&#34;, &#34;Medical&#34;, &#34;Panic&#34;, or &#34;Police&#34;
        &#34;&#34;&#34;
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;EXECUTE_EMERGENCY&#34;,
            {&#34;EmergencyType&#34;: emergency_type},
        )

    async def send_key_press(self, key: str) -&gt; None:
        &#34;&#34;&#34;Sends a single keypress to the security panel&#39;s virtual keypad (if
        supported).

        Parameters:
            `key` - Keypress to send. Only one key at a time.
        &#34;&#34;&#34;
        key = str(key)
        await self.director.send_post_request(
            f&#34;/api/v1/items/{self.item_id}/commands&#34;,
            &#34;KEY_PRESS&#34;,
            {&#34;KeyName&#34;: key},
        )</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.alarm.C4SecurityPanel.get_alarm_state"><code class="name flex">
<span>async def <span class="ident">get_alarm_state</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_alarm_state(self) -&gt; bool | None:
    &#34;&#34;&#34;Returns `True` if alarm is triggered, otherwise returns `False`.&#34;&#34;&#34;
    alarm_state = await self.director.get_item_variable_value(
        self.item_id, &#34;ALARM_STATE&#34;
    )
    if alarm_state is None:
        return None
    return bool(alarm_state)</code></pre>
</details>
<div class="desc"><p>Returns <code>True</code> if alarm is triggered, otherwise returns <code>False</code>.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_alarm_type"><code class="name flex">
<span>async def <span class="ident">get_alarm_type</span></span>(<span>self) ‑> str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_alarm_type(self) -&gt; str | None:
    &#34;&#34;&#34;Returns details about the current alarm type.&#34;&#34;&#34;
    alarm_type = await self.director.get_item_variable_value(
        self.item_id, &#34;ALARM_TYPE&#34;
    )
    return alarm_type</code></pre>
</details>
<div class="desc"><p>Returns details about the current alarm type.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_arm_state"><code class="name flex">
<span>async def <span class="ident">get_arm_state</span></span>(<span>self) ‑> str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_arm_state(self) -&gt; str | None:
    &#34;&#34;&#34;
    NOTE: Prefer using `get_partition_state()`
    and `get_armed_type()` over this method.
    Returns the arm state of the security panel as &#34;DISARMED&#34;, &#34;ARMED_HOME&#34;,
    or &#34;ARMED_AWAY&#34;.
    &#34;&#34;&#34;
    disarmed = await self.director.get_item_variable_value(
        self.item_id, &#34;DISARMED_STATE&#34;
    )
    armed_home = await self.director.get_item_variable_value(
        self.item_id, &#34;HOME_STATE&#34;
    )
    armed_away = await self.director.get_item_variable_value(
        self.item_id, &#34;AWAY_STATE&#34;
    )
    try:
        if disarmed is not None and int(disarmed) == 1:
            return &#34;DISARMED&#34;
        elif armed_home is not None and int(armed_home) == 1:
            return &#34;ARMED_HOME&#34;
        elif armed_away is not None and int(armed_away) == 1:
            return &#34;ARMED_AWAY&#34;
    except (ValueError, TypeError):
        pass
    return None</code></pre>
</details>
<div class="desc"><p>NOTE: Prefer using <code>get_partition_state()</code>
and <code>get_armed_type()</code> over this method.
Returns the arm state of the security panel as "DISARMED", "ARMED_HOME",
or "ARMED_AWAY".</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_arm_types"><code class="name flex">
<span>async def <span class="ident">get_arm_types</span></span>(<span>self) ‑> list[str]</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_arm_types(self) -&gt; list[str]:
    &#34;&#34;&#34;Returns the available arm types as a list.&#34;&#34;&#34;
    data = await self.director.get_item_info(self.item_id)
    if not data or not isinstance(data, list) or len(data) == 0:
        return []

    capabilities = data[0].get(&#34;capabilities&#34;, {})
    arm_types_str = capabilities.get(&#34;arm_types&#34;, &#34;&#34;)
    if not arm_types_str:
        return []
    return [t.strip() for t in arm_types_str.split(&#34;,&#34;) if t.strip()]</code></pre>
</details>
<div class="desc"><p>Returns the available arm types as a list.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_armed_type"><code class="name flex">
<span>async def <span class="ident">get_armed_type</span></span>(<span>self) ‑> str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_armed_type(self) -&gt; str | None:
    &#34;&#34;&#34;Returns details about the current arm type.&#34;&#34;&#34;
    armed_type = await self.director.get_item_variable_value(
        self.item_id, &#34;ARMED_TYPE&#34;
    )
    return armed_type</code></pre>
</details>
<div class="desc"><p>Returns details about the current arm type.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_delay_time_remaining"><code class="name flex">
<span>async def <span class="ident">get_delay_time_remaining</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_delay_time_remaining(self) -&gt; int | None:
    &#34;&#34;&#34;Returns the remaining exit delay time. Returns 0 if an exit delay is
    not currently running.
    &#34;&#34;&#34;
    delay_time_remaining = await self.director.get_item_variable_value(
        self.item_id, &#34;DELAY_TIME_REMAINING&#34;
    )
    return int(delay_time_remaining) if delay_time_remaining is not None else None</code></pre>
</details>
<div class="desc"><p>Returns the remaining exit delay time. Returns 0 if an exit delay is
not currently running.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_delay_time_total"><code class="name flex">
<span>async def <span class="ident">get_delay_time_total</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_delay_time_total(self) -&gt; int | None:
    &#34;&#34;&#34;Returns the total exit delay time. Returns 0 if an exit delay is not
    currently running.
    &#34;&#34;&#34;
    delay_time_total = await self.director.get_item_variable_value(
        self.item_id, &#34;DELAY_TIME_TOTAL&#34;
    )
    return int(delay_time_total) if delay_time_total is not None else None</code></pre>
</details>
<div class="desc"><p>Returns the total exit delay time. Returns 0 if an exit delay is not
currently running.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_display_text"><code class="name flex">
<span>async def <span class="ident">get_display_text</span></span>(<span>self) ‑> str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_display_text(self) -&gt; str | None:
    &#34;&#34;&#34;Returns the display text of the security panel.&#34;&#34;&#34;
    display_text = await self.director.get_item_variable_value(
        self.item_id, &#34;DISPLAY_TEXT&#34;
    )
    return display_text</code></pre>
</details>
<div class="desc"><p>Returns the display text of the security panel.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_emergency_types"><code class="name flex">
<span>async def <span class="ident">get_emergency_types</span></span>(<span>self) ‑> list[str]</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_emergency_types(self) -&gt; list[str]:
    &#34;&#34;&#34;Returns the available emergency types as a list.

    Possible types are &#34;Fire&#34;, &#34;Medical&#34;, &#34;Panic&#34;, and &#34;Police&#34;.
    &#34;&#34;&#34;
    types_list: list[str] = []

    data = await self.director.get_item_info(self.item_id)
    if not data or not isinstance(data, list) or len(data) == 0:
        return types_list

    capabilities = data[0].get(&#34;capabilities&#34;, {})
    if capabilities.get(&#34;has_fire&#34;):
        types_list.append(&#34;Fire&#34;)
    if capabilities.get(&#34;has_medical&#34;):
        types_list.append(&#34;Medical&#34;)
    if capabilities.get(&#34;has_panic&#34;):
        types_list.append(&#34;Panic&#34;)
    if capabilities.get(&#34;has_police&#34;):
        types_list.append(&#34;Police&#34;)

    return types_list</code></pre>
</details>
<div class="desc"><p>Returns the available emergency types as a list.</p>
<p>Possible types are "Fire", "Medical", "Panic", and "Police".</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_last_arm_failure"><code class="name flex">
<span>async def <span class="ident">get_last_arm_failure</span></span>(<span>self) ‑> str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_last_arm_failure(self) -&gt; str | None:
    &#34;&#34;&#34;Returns details about the last arm failure.&#34;&#34;&#34;
    last_arm_failed = await self.director.get_item_variable_value(
        self.item_id, &#34;LAST_ARM_FAILED&#34;
    )
    return last_arm_failed</code></pre>
</details>
<div class="desc"><p>Returns details about the last arm failure.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_last_emergency"><code class="name flex">
<span>async def <span class="ident">get_last_emergency</span></span>(<span>self) ‑> str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_last_emergency(self) -&gt; str | None:
    &#34;&#34;&#34;Returns details about the last emergency trigger.&#34;&#34;&#34;
    last_emergency = await self.director.get_item_variable_value(
        self.item_id, &#34;LAST_EMERGENCY&#34;
    )
    return last_emergency</code></pre>
</details>
<div class="desc"><p>Returns details about the last emergency trigger.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_open_zone_count"><code class="name flex">
<span>async def <span class="ident">get_open_zone_count</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_open_zone_count(self) -&gt; int | None:
    &#34;&#34;&#34;Returns the number of open/unsecured zones.&#34;&#34;&#34;
    open_zone_count = await self.director.get_item_variable_value(
        self.item_id, &#34;OPEN_ZONE_COUNT&#34;
    )
    return int(open_zone_count) if open_zone_count is not None else None</code></pre>
</details>
<div class="desc"><p>Returns the number of open/unsecured zones.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_partition_state"><code class="name flex">
<span>async def <span class="ident">get_partition_state</span></span>(<span>self) ‑> str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_partition_state(self) -&gt; str | None:
    &#34;&#34;&#34;Returns the partition state of the security panel.

    Possible values include &#34;DISARMED_NOT_READY&#34;, &#34;DISARMED_READY&#34;, &#34;ARMED_HOME&#34;,
    &#34;ARMED_AWAY&#34;, &#34;EXIT_DELAY&#34;, &#34;ENTRY_DELAY&#34;
    &#34;&#34;&#34;
    partition_state = await self.director.get_item_variable_value(
        self.item_id, &#34;PARTITION_STATE&#34;
    )
    return partition_state</code></pre>
</details>
<div class="desc"><p>Returns the partition state of the security panel.</p>
<p>Possible values include "DISARMED_NOT_READY", "DISARMED_READY", "ARMED_HOME",
"ARMED_AWAY", "EXIT_DELAY", "ENTRY_DELAY"</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.get_trouble_text"><code class="name flex">
<span>async def <span class="ident">get_trouble_text</span></span>(<span>self) ‑> str | None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def get_trouble_text(self) -&gt; str | None:
    &#34;&#34;&#34;Returns the trouble display text of the security panel.&#34;&#34;&#34;
    trouble_text = await self.director.get_item_variable_value(
        self.item_id, &#34;TROUBLE_TEXT&#34;
    )
    return trouble_text</code></pre>
</details>
<div class="desc"><p>Returns the trouble display text of the security panel.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.send_key_press"><code class="name flex">
<span>async def <span class="ident">send_key_press</span></span>(<span>self, key: str) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def send_key_press(self, key: str) -&gt; None:
    &#34;&#34;&#34;Sends a single keypress to the security panel&#39;s virtual keypad (if
    supported).

    Parameters:
        `key` - Keypress to send. Only one key at a time.
    &#34;&#34;&#34;
    key = str(key)
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;KEY_PRESS&#34;,
        {&#34;KeyName&#34;: key},
    )</code></pre>
</details>
<div class="desc"><p>Sends a single keypress to the security panel's virtual keypad (if
supported).</p>
<h2 id="parameters">Parameters</h2>
<p><code>key</code> - Keypress to send. Only one key at a time.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.set_arm"><code class="name flex">
<span>async def <span class="ident">set_arm</span></span>(<span>self, usercode: str, mode: str) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def set_arm(self, usercode: str, mode: str) -&gt; None:
    &#34;&#34;&#34;Arms the security panel with the specified mode.

    Parameters:
        `usercode` - PIN/code for arming the system.

        `mode` - Arm mode to use. This depends on what is supported by the
            security panel itself.
    &#34;&#34;&#34;
    usercode = str(usercode)
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;PARTITION_ARM&#34;,
        {&#34;ArmType&#34;: mode, &#34;UserCode&#34;: usercode},
    )</code></pre>
</details>
<div class="desc"><p>Arms the security panel with the specified mode.</p>
<h2 id="parameters">Parameters</h2>
<p><code>usercode</code> - PIN/code for arming the system.</p>
<p><code>mode</code> - Arm mode to use. This depends on what is supported by the
security panel itself.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.set_disarm"><code class="name flex">
<span>async def <span class="ident">set_disarm</span></span>(<span>self, usercode: str) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def set_disarm(self, usercode: str) -&gt; None:
    &#34;&#34;&#34;Disarms the security panel.

    Parameters:
        `usercode` - PIN/code for disarming the system.
    &#34;&#34;&#34;
    usercode = str(usercode)
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;PARTITION_DISARM&#34;,
        {&#34;UserCode&#34;: usercode},
    )</code></pre>
</details>
<div class="desc"><p>Disarms the security panel.</p>
<h2 id="parameters">Parameters</h2>
<p><code>usercode</code> - PIN/code for disarming the system.</p></div>
</dd>
<dt id="pyControl4.alarm.C4SecurityPanel.trigger_emergency"><code class="name flex">
<span>async def <span class="ident">trigger_emergency</span></span>(<span>self, emergency_type: str) ‑> None</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">async def trigger_emergency(self, emergency_type: str) -&gt; None:
    &#34;&#34;&#34;Triggers an emergency of the specified type.

    Parameters:
        `emergency_type` - Type of emergency:
        &#34;Fire&#34;, &#34;Medical&#34;, &#34;Panic&#34;, or &#34;Police&#34;
    &#34;&#34;&#34;
    await self.director.send_post_request(
        f&#34;/api/v1/items/{self.item_id}/commands&#34;,
        &#34;EXECUTE_EMERGENCY&#34;,
        {&#34;EmergencyType&#34;: emergency_type},
    )</code></pre>
</details>
<div class="desc"><p>Triggers an emergency of the specified type.</p>
<h2 id="parameters">Parameters</h2>
<p><code>emergency_type</code> - Type of emergency:
"Fire", "Medical", "Panic", or "Police"</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.alarm.C4ContactSensor" href="#pyControl4.alarm.C4ContactSensor">C4ContactSensor</a></code></h4>
<ul class="">
<li><code><a title="pyControl4.alarm.C4ContactSensor.get_contact_state" href="#pyControl4.alarm.C4ContactSensor.get_contact_state">get_contact_state</a></code></li>
</ul>
</li>
<li>
<h4><code><a title="pyControl4.alarm.C4SecurityPanel" href="#pyControl4.alarm.C4SecurityPanel">C4SecurityPanel</a></code></h4>
<ul class="">
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_alarm_state" href="#pyControl4.alarm.C4SecurityPanel.get_alarm_state">get_alarm_state</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_alarm_type" href="#pyControl4.alarm.C4SecurityPanel.get_alarm_type">get_alarm_type</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_arm_state" href="#pyControl4.alarm.C4SecurityPanel.get_arm_state">get_arm_state</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_arm_types" href="#pyControl4.alarm.C4SecurityPanel.get_arm_types">get_arm_types</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_armed_type" href="#pyControl4.alarm.C4SecurityPanel.get_armed_type">get_armed_type</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_delay_time_remaining" href="#pyControl4.alarm.C4SecurityPanel.get_delay_time_remaining">get_delay_time_remaining</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_delay_time_total" href="#pyControl4.alarm.C4SecurityPanel.get_delay_time_total">get_delay_time_total</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_display_text" href="#pyControl4.alarm.C4SecurityPanel.get_display_text">get_display_text</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_emergency_types" href="#pyControl4.alarm.C4SecurityPanel.get_emergency_types">get_emergency_types</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_last_arm_failure" href="#pyControl4.alarm.C4SecurityPanel.get_last_arm_failure">get_last_arm_failure</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_last_emergency" href="#pyControl4.alarm.C4SecurityPanel.get_last_emergency">get_last_emergency</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_open_zone_count" href="#pyControl4.alarm.C4SecurityPanel.get_open_zone_count">get_open_zone_count</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_partition_state" href="#pyControl4.alarm.C4SecurityPanel.get_partition_state">get_partition_state</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.get_trouble_text" href="#pyControl4.alarm.C4SecurityPanel.get_trouble_text">get_trouble_text</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.send_key_press" href="#pyControl4.alarm.C4SecurityPanel.send_key_press">send_key_press</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.set_arm" href="#pyControl4.alarm.C4SecurityPanel.set_arm">set_arm</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.set_disarm" href="#pyControl4.alarm.C4SecurityPanel.set_disarm">set_disarm</a></code></li>
<li><code><a title="pyControl4.alarm.C4SecurityPanel.trigger_emergency" href="#pyControl4.alarm.C4SecurityPanel.trigger_emergency">trigger_emergency</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>