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
- 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(<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.9.tar.gz
(13.0 kB
view hashes)
Built Distribution
Close
Hashes for yalesmartalarmclient-0.3.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f0a07c16465291657143f35e4b5915d33b3f9b15c846f208b71bc05b3e8b06bf |
|
MD5 | 50f0e60302ceae99a6e980b004bd0ab4 |
|
BLAKE2b-256 | 74da9b5f9eba3a58a0812663485aa312c79371e18249ff8dceeeb0e0b922ef66 |
Close
Hashes for yalesmartalarmclient-0.3.9-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 81db89424914de6691ce2f064480ce0d85f3a1bbc82e174c39c79c82dd97847a |
|
MD5 | 60b6f8b550e81a437cfd3012297ee61e |
|
BLAKE2b-256 | 1fc91e1100c98c1c816f9568db88651b510dc10695ab9fd9629918c73fae8774 |