Mixin: kumostat

lib/kumostat~kumostat

Objects and functions as a mix-in for WirelessTag objects that represent a thermostat. (Wireless Sensor Tags calls such a tag a Kumostat, from kumo, which is Japanese for 'cloud'. Currently they support Honeywell and Nest thermostats.)

Source:

Members

thermostat

Property of Kumostat tags for querying fan and AC/Heat status, and for getting/setting temperature thresholds and temperature sensing tag.

Properties:
Name Type Description
isFanOn boolean

note that false typically means "auto" not strictly "off". (The fan can't be off when AC/Heat is on.)
isACHeatOn boolean

whether the AC or Heat is on
thresholdLow number

the lower end of the temperature comfort zone (unit as configured)
thresholdHigh number

the higher end of the temperature comfort zone (unit as configured)
useHomeAway boolean

whether to use the Nest Home/Away setting
tempTagUUID string

the uuid property of the tag that is to control (= measure) the temperature
Source:

Methods

turnACHeatOff(callbackopt) → {Promise}

Method of Kumostat tags. Turns AC/Heat off.

Parameters:
Name Type Attributes Description
callback module:wirelesstags~apiCallback <optional>
Source:
Returns:

Resolves to the Kumostat tag upon completion.

Type
Promise

turnACHeatOn(callbackopt) → {Promise}

Method of Kumostat tags. Turns AC/Heat on.

Parameters:
Name Type Attributes Description
callback module:wirelesstags~apiCallback <optional>
Source:
Returns:

Resolves to the Kumostat tag upon completion.

Type
Promise

turnFanOff(callbackopt) → {Promise}

Method of Kumostat tags. Turns the fan "off." In practice this will usually mean 'auto' rather than strictly 'off' (for example, the fan can't be off if AC/Heat is on).

Parameters:
Name Type Attributes Description
callback module:wirelesstags~apiCallback <optional>
Source:
Returns:

Resolves to the Kumostat tag upon completion.

Type
Promise

turnFanOn(callbackopt) → {Promise}

Method of Kumostat tags. Turns the fan on.

Parameters:
Name Type Attributes Description
callback module:wirelesstags~apiCallback <optional>
Source:
Returns:

Resolves to the Kumostat tag upon completion.

Type
Promise