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
- Get locks and operate
- 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(YALE_STATE_ARM_FULL)
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()
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
File details
Details for the file yalesmartalarmclient-0.4.3.tar.gz.
File metadata
- Download URL: yalesmartalarmclient-0.4.3.tar.gz
- Upload date:
- Size: 19.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.2 Linux/6.6.12-linuxkit
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 7d86c5b106c30b623211f83cdfd2dc928a668ba062c9c93eadeab00eeb7f34ba |
|
| MD5 | c3887c03ecc05ecdd25479b50bcf40e3 |
|
| BLAKE2b-256 | d5596bd7c1ff27af812fe7c914988b6e875f9d8b71b462c456ad9859cac7fac8 |
File details
Details for the file yalesmartalarmclient-0.4.3-py3-none-any.whl.
File metadata
- Download URL: yalesmartalarmclient-0.4.3-py3-none-any.whl
- Upload date:
- Size: 15.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.3 CPython/3.12.2 Linux/6.6.12-linuxkit
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 87de0f2f74659cb7dee2c14fe73ebbaa5883dd1b2fe8ca3d57aa1174169b2330 |
|
| MD5 | a7566600bddae85ed34b68509d5484d7 |
|
| BLAKE2b-256 | 7ef706bdfe389a7fd1339d7230a1a1f9ec5aafcc6b64a545ee7566a173c6eec5 |
