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
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
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
Built Distribution
Close
Hashes for yalesmartalarmclient-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4dfca696528f47bfd3f1f27ec7d0af8d820e8faf4447c2290743c9556c072b96 |
|
MD5 | 8c92745e0742e56cc3dbad5cc6b3d121 |
|
BLAKE2b-256 | f20239e9573da6229925a30360ec2206d87db8740a2b9d6e1438b3082b78b1f0 |
Close
Hashes for yalesmartalarmclient-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a4a94e54b0f781b0411ec35e3df74145dfa8cba96786be29f532a7f79d210aa3 |
|
MD5 | c0244a5496b957ca88a1887c8fa88007 |
|
BLAKE2b-256 | 29b770cfe6f3052098ec565e8bf291afe35a634de9da7b4d2b4a709ae0f093f0 |