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
- Get locks and operate
- Door sensor 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.
For full listing of function see functions.md
Locks
Iterate the connected locks
client = YaleSmartAlarmClient(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(YALE_STATE_ARM_FULL)
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.4.0.tar.gz
(18.7 kB
view hashes)
Built Distribution
Close
Hashes for yalesmartalarmclient-0.4.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | ccf148af7315eb29959f508663064972379859c6b5aae6ccbcacb54b0ba5b3e2 |
|
MD5 | 949a4e7dc0cefb660dfdc39e46e29e16 |
|
BLAKE2b-256 | c91e9bea062d5cc2e0aa4a60ea51b102d1b54aa0a4bbcfa563ce788613994d3d |
Close
Hashes for yalesmartalarmclient-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a00b2dc775b3b15136a25ab051722a709b76e7967fb91cf022384bae50734499 |
|
MD5 | 23c1c21d60246319a2ff753565e30e8b |
|
BLAKE2b-256 | 762dc1e802b7c56529354f9662de1ff086ebf42ab5d7c2fc6d4d9a9e3b05ed49 |