Interact with Yale Smart Alarm systems
Project description
Yale Smart Alarm Client
Yale Smart Alarm client is a python client for interacting with the Yale Smart Alarm System API.
Supported functions:
- Arm full (away)
- Arm partial (away/night)
- Disarm
- Get alarm status
- Trigger alarm panic button
Usage
Create a client with:
from yalesmartalarmclient.client import YaleSmartAlarmClient
client = YaleSmartAlarmClient(username, password)
where username and password are your Yale Smart Alarm credentials.
Locks
Iterate the connected locks
client = YaleClient(username, password)
for lock in client.lock_api.locks():
print(lock)
lock a single lock
lock = client.lock_api.get(name="myfrontdoor"):
lock.close()
unlock:
lock = client.lock_api.get(name="myfrontdoor"):
lock.open(pin_code="1234566")
DEPRECATED! Get connected locks states:
client.get_locks_status() # Returns an array of locks and status
Alarms
Change the alarm state with:
client.arm_full()
client.arm_partial()
client.disarm()
or
client.set_alarm_state(<mode>)
where 'mode' is one of:
from yalesmartalarmclient.client import (YALE_STATE_ARM_PARTIAL,
YALE_STATE_DISARM,
YALE_STATE_ARM_FULL)
Is the alarm armed fully or partially:
client.is_armed() # == True
or return alarm status. eg.
client.get_armed_status() is YALE_STATE_ARM_FULL
Trigger panic button
client.trigger_panic_button()
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
yalesmartalarmclient-0.3.2.tar.gz
(10.8 kB
view hashes)
Built Distribution
Close
Hashes for yalesmartalarmclient-0.3.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 519a1b102241917c4253172c085368ffc6873f08173f140b573ba0ff99baf2c1 |
|
MD5 | be82fcb5919005809478961f30c08320 |
|
BLAKE2b-256 | 19a8cd4f8c734eef144d1f3be515045d8dfb3124cfc721631d4623ddb5695dbc |
Close
Hashes for yalesmartalarmclient-0.3.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f7f17135f78158ebc51aef09f963b8c576d81d594ec91585191bef3c0f0ce58 |
|
MD5 | 7f4119c6aff676e1357cf190cad49613 |
|
BLAKE2b-256 | 3ab70683d8cf97a481c668d56fa1ef62bfc01edaf956d0ee927ab87ee7b73a96 |