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
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
Built Distribution
Close
Hashes for yalesmartalarmclient-0.3.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | fce2b2b348b6e355739a1f3bbfb465dcd166e1c6b82ca735172638f4d68d42bf |
|
MD5 | b315d1aaa24034bd1ed9dde39d9ffcad |
|
BLAKE2b-256 | 96fa80b34e94433f3d495354b33f08b1db907f5d5797a7cd0731c20e914c44d7 |
Close
Hashes for yalesmartalarmclient-0.3.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b74a94c9dc8c238051fd9e6888890d6a59bc0b29091b2930451892e54d395cdd |
|
MD5 | 011005aae0aeb92f460e749ec2e354b4 |
|
BLAKE2b-256 | bf62cdba55f37fbf5a6ee24750c8cd5dec915914dc99f93562924ad0ab332e57 |