Skip to main content

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

Usage

Create a client with:

from yalesmartalarmclient.client import YaleSmartAlarmClient
client = YaleSmartAlarmClient(username, password)

where username and password are your Yale Smart Alarm credentials.

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

Get connected locks states:

client.get_locks_status() # Returns an array of locks and status

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

Uploaded Source

Built Distribution

yalesmartalarmclient-0.1.7-py3-none-any.whl (8.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yalesmartalarmclient-0.1.7.tar.gz
  • Upload date:
  • Size: 4.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for yalesmartalarmclient-0.1.7.tar.gz
Algorithm Hash digest
SHA256 776fc951d95220831653df40d8bbcbb8b252b71121f2992303577b6677e4ca2b
MD5 6148023700e7be7e0077d98e8ad441a4
BLAKE2b-256 105e2b626e0bf42a4964ccceb7c7c5c651588a7a7e57537612459c3421e1931c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yalesmartalarmclient-0.1.7-py3-none-any.whl
  • Upload date:
  • Size: 8.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/47.1.1 requests-toolbelt/0.9.1 tqdm/4.46.0 CPython/3.8.2

File hashes

Hashes for yalesmartalarmclient-0.1.7-py3-none-any.whl
Algorithm Hash digest
SHA256 2be15bdefda13353822a6b41a620a60d6eeabe71e0de521ac9997e6486e77b5a
MD5 adf10e5cdd016c2a77f2019540a17ed4
BLAKE2b-256 d88b3413fbb74742d77411399a9e11341f46974195680c5912b607bdde53fa39

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