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

Uploaded Source

Built Distribution

yalesmartalarmclient-0.1.2-py3-none-any.whl (3.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: yalesmartalarmclient-0.1.2.tar.gz
  • Upload date:
  • Size: 2.8 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.2.tar.gz
Algorithm Hash digest
SHA256 1753ddebaf22aedefa3d7f02ceb6977d27ab1e8fab9b5dca64b6859788ed3691
MD5 a335b84d48b1e4337dea72f42528e875
BLAKE2b-256 f2f02f09c64e9a90584ccce930db52b67955afe86d17d847905a96a6e8737528

See more details on using hashes here.

File details

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

File metadata

  • Download URL: yalesmartalarmclient-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 3.3 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 79adc0f3dac57c1fb7d203c51d8b06bca0d827ac49f590c59905916cf2b57e7e
MD5 c9c61d8760a5c5e00dcda3b9ebc651b8
BLAKE2b-256 11f340e13be9250702cd29f082589393c5ff6e6b5669e980cd1bcd744066e856

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