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.
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.3.tar.gz
(11.7 kB
view hashes)
Built Distribution
Close
Hashes for yalesmartalarmclient-0.3.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 426ba81b6efde3d45cce940fd8ba5b971ec5d1ae5b723194809b8259b2f71ecf |
|
MD5 | 15e8ecaf27f12e010ccdc95992d13ea8 |
|
BLAKE2b-256 | 6021ad8af21ab59969d7c3f3e7161f807e2807b40282538e318be9ffc1447be0 |
Close
Hashes for yalesmartalarmclient-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33b286d4517132a9e5461afa9185b500776c3bc4c7f5de6e6032a5f3fe684dea |
|
MD5 | 066e2bca59898c176b2c5547713aff50 |
|
BLAKE2b-256 | 91b0b3cac0983dbb3e6a467ddc91e007f6bbcf990f75c41f8a8e1923c66e0f2a |