Package: Home Mode for external assistants

Author: Mark Stayton
Version: 2
Added to Library: 11-Nov-23
HCAVersion needed: 16
Keywords: Utility

Requirements: BEFORE INSTALLING THIS PACKAGE, YOU MUST DO THE FOLLOWING:

1. Install the "Virtual OnOff Device Class" package.


Package Description:
This package allows the HCA Home Mode to be visible and controlled from external assistants.

There are three Virtual On/Off Device class instances, one for each Home Mode.

When HCA starts, the Mode devices are synchronized to the current Home Mode.

When one of the Mode devices is set ON, the Home Mode is changed accordingly

When the Home Mode is changed within HCA, the Mode devices are set accordingly.

Program: Change Home Mode

Program Description:
This program allows the HCA Home Mode to be visible and controlled from external assistants.

There are three Virtual NonDimmable Device class instances, one for each Home Mode.

WHAT YOU NEED TO DO:

1. Configure the "Mode Away", "Mode Home and Asleep", and "Mode Home and Awake" devices with Friendly Names, to be used with your external assistant.

PROGRAM EXECUTION:

1. When HCA starts, the Mode devices are synchronized to the current Home Mode.

2. When one of the Mode devices is set ON, the Home Mode is changed accordingly.

3. When the Home Mode is changed within HCA, the Mode devices are set accordingly.

Written by Mark Stayton (mark@thestaytons.net) | Version 2 | 27-Jun-2018

Return value: This program does not return a result.

Parameters:

Name Type Description Default
Mode Value Home Mode value (0=Home and Awake, 1=Home and Asleep, 2=Away, 4=Optional) -1