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.5.tar.gz
(12.6 kB
view hashes)
Built Distribution
Close
Hashes for yalesmartalarmclient-0.3.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | be02205b61880394904dab0258a4459949b962dcde6b24210183f015af0dda9f |
|
MD5 | c62ecb24642e646e60f9d686b5a384cc |
|
BLAKE2b-256 | e446c061a3f5535d21fd33ef033c27dd144d71d12421cecc88534884597ee507 |
Close
Hashes for yalesmartalarmclient-0.3.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ad62f344ecf65d1a17589124a8303f0cae755ac04460468b99b68a388312dda5 |
|
MD5 | 400e3ed3e2579e8546af2752dbdda666 |
|
BLAKE2b-256 | 2138e33349ef9a065cbdd107bab7186c30aa36130d95847413931489cb910cd0 |