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.4.tar.gz
(12.1 kB
view hashes)
Built Distribution
Close
Hashes for yalesmartalarmclient-0.3.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4945cf1161f4a369f9f2924c6473295b86397ad61e68498639f5c2dfa72c32d6 |
|
MD5 | 7a06e8c02e4ba0c330843143bf5f79c6 |
|
BLAKE2b-256 | 15bb520d9774d7bb41b380f48666eb3919de8f2f3d714771c52e11a5904eede2 |
Close
Hashes for yalesmartalarmclient-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 987e6e2885ad908a05b876715790dae3930e774891cddcee4fdf896009f9c48e |
|
MD5 | d8dc12fcfc28bf5448d3e46c3ebe434d |
|
BLAKE2b-256 | 0cbdfd82556c542b036228d7590745a5c19a6a43ad8b0307d3995375e1481c7a |