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
- 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 = 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.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5e2b0fa607ef52e61039bb21f968998e0c25d8d261a09d051314430dc85d6cda |
|
MD5 | 170785d718f033ca26038ce9ff39b29a |
|
BLAKE2b-256 | 3a9370d6d282e78d157d8df1e06dd78ddb3b1a586d7d02e126d117e242a48896 |
Close
Hashes for yalesmartalarmclient-0.3.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22d06d4f2391a5d150879b357786b7733490cc0c4c72a634539ac6752480e669 |
|
MD5 | 0ad550cb6ed061d91acb7612cc68b552 |
|
BLAKE2b-256 | 7d90dd5735dacb0b725e9d18a36ebf154b196bb6d355f8adaabc1bc1c5f72319 |