Skip to content

Latest commit

 

History

History
99 lines (78 loc) · 1.62 KB

functions.md

File metadata and controls

99 lines (78 loc) · 1.62 KB

Yale Smart Alarm Client

Listing of all functions available

Usage

Create a client with:

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

where username and password are your Yale Smart Alarm credentials.

Client functions

Debug output for command line (returns long string):

client.get_all()

Return full json all devices (does not include the alarm itself):

client.get_all_devices()

Returns full json all devices, status of alarm and reports/alarms:

client.get_cycle()

Returns full json health status of system:

client.get_status()

Returns full json system available/online:

client.get_online()

Returns full json panel (alarm) information:

client.get_panel_info()

Returns full json first page of history (log):

client.get_history()

Returns full json for authentication info:

client.get_auth_check()

Returns reduced json lock status:

client.get_locks_status()

Returns reduced json door contacts status:

client.get_doors_status()

Returns api status of alarm:

client.get_armed_status()

Set status of alarm:

client.set_armed_status(mode)

Trigger panic button:

client.trigger_panic_button()

Arm away:

client.arm_full()

Arm home:

client.arm_partial()

Disarm:

client.disarm()

Return true/false on alarm on/off:

client.is_armed()