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

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

Uploaded Source

Built Distribution

yalesmartalarmclient-0.1.3-py3-none-any.whl (3.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yalesmartalarmclient-0.1.3.tar.gz
  • Upload date:
  • Size: 2.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.5

File hashes

Hashes for yalesmartalarmclient-0.1.3.tar.gz
Algorithm Hash digest
SHA256 8e8288a4e681f54b0b0005cad8a88f7df19955b1d91a45566179d85c6d89c52f
MD5 be6cdf8cd9407874ee0edd7327da5364
BLAKE2b-256 0e091b8f70b0f78fca9bf4b1055f733d89df6357cd4c90299f8b67b130f60af2

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yalesmartalarmclient-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 3.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.2.0 requests-toolbelt/0.8.0 tqdm/4.25.0 CPython/3.6.5

File hashes

Hashes for yalesmartalarmclient-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 f5117a6e5260617c17dd55a53c553902c93d07491a6e572d4bfc3b0ecaf1d012
MD5 70c118901358fc319ac031dbaf216a94
BLAKE2b-256 8271ebe9ccbfb0d90aba5094c18b1a6d5f8c9f441b123080a47febcd82375671

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