Skip to main content

Interact with Yale Smart Alarm systems

Project description

Yale Smart Alarm Client

PyPI version Supported Python versions PyPI downloads GitHub

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()

Project details


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.4.1.tar.gz (18.9 kB view details)

Uploaded Source

Built Distribution

yalesmartalarmclient-0.4.1-py3-none-any.whl (15.6 kB view details)

Uploaded Python 3

File details

Details for the file yalesmartalarmclient-0.4.1.tar.gz.

File metadata

  • Download URL: yalesmartalarmclient-0.4.1.tar.gz
  • Upload date:
  • Size: 18.9 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

Hashes for yalesmartalarmclient-0.4.1.tar.gz
Algorithm Hash digest
SHA256 dd8f960903f145c9676b56df3fc6eae7fa6bc7328dee4943df21ce6c5c4232c6
MD5 8901829731fcb0b5a1dd129f4a44632a
BLAKE2b-256 07b348bdc0a4271aa83a7df8cd1eb8104fa3ce43e43bce40c9f21fbb0154e352

See more details on using hashes here.

File details

Details for the file yalesmartalarmclient-0.4.1-py3-none-any.whl.

File metadata

File hashes

Hashes for yalesmartalarmclient-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bd814085e8b34ef5ca9ff1708791e3bf92c7bd2b448dd6444b8b55d24fb76ca8
MD5 bf07d4c77b35f5233a4b208ccce9a192
BLAKE2b-256 d029a63f4a2ea6f5beebbb0a2b4ed02b0e3030ef60d284620341d36695dbd072

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page