All possible settings of the alarm.
All possible statuses of a door.
Possible directions of the level change.
Positions: open
and closed
.
Switch status.
Possible thermostat fan modes.
Possible thermostat modes.
Possible thermostat operating modes.
All possible positions of the window shade.
Closes the device.
Capabilities:
A target device.
Closes the device.
Capabilities:
An ID of the target device.
Closes the device.
Capabilities:
An ID of the target device or the device itself.
Convert the enum list received from Hubitat into the JS-friendly string list.
An enum list from Hubitat in format: [valueA, valueB, value C]
.
Returns a list of values as strings: ["valueA", "valueB", "value C"]
.
Returns a value of the alarm setting.
Capabilities:
A target device.
A value returned in case getting the device status has failed.
Returns current alarm setting value.
Returns a value of the alarm setting.`
Capabilities:
An ID of the target device.
A value returned in case getting the device status has failed.
Returns current alarm setting value.
Returns current battery status (percentage).
Capabilities:
A target device.
Returns current battery status.
Returns current battery status (percentage).
Capabilities:
An ID of the target device.
Returns current battery status.
Returns the last carbon dioxide measurement.
Capabilities:
A target device.
Returns the last carbon dioxide measurement.
Returns the last carbon dioxide measurement.
Capabilities:
An ID of the target device.
Returns the last carbon dioxide measurement.
Returns the last carbon monoxide measurement.
Capabilities:
A target device.
Returns the last carbon monoxide measurement.
Returns the last carbon monoxide measurement.
Capabilities:
An ID of the target device.
Returns the last carbon monoxide measurement.
A target device.
A value returned in case getting the device status has failed.
A status of the contact sensor or the default value.
An ID of the target device.
A value returned in case getting the device status has failed.
A status of the contact sensor or the default value.
Returns current thermostat cooling setpoint.
Capabilities:
A target device.
Returns current thermostat cooling setpoint.
Returns current thermostat cooling setpoint.
Capabilities:
An ID of the target device.
Returns current thermostat cooling setpoint.
Returns a provided device back. This method exists to make device capabilities functions more usable.
A target device.
Returns the provided device back.
Returns a device with the provided ID.
An ID of the target device.
Returns a device with the provided ID.
Returns a provided device or a device with the provided ID.
A target device or an ID of the target device.
Returns a provided device or a device with the provided ID.
A target device.
Returns current door position.
An ID of the target device.
Returns current door position.
Returns current thermostat heating setpoint.
Capabilities:
A target device.
Returns current thermostat heating setpoint.
Returns current thermostat heating setpoint.
Capabilities:
An ID of the target device.
Returns current thermostat heating setpoint.
Returns the last illuminance measurement.
Capabilities:
A target device.
Returns the last illuminance measurement.
Returns the last illuminance measurement.
Capabilities:
An ID of the target device.
Returns the last illuminance measurement.
Returns current switch level.
Capabilities:
A target device.
Returns current switch level.
Returns current switch level.
Capabilities:
An ID of the target device.
Returns current switch level.
Returns current location mode name.
Capabilities:
A target device.
Returns a name of the the current location mode.
Returns current location mode name.
Capabilities:
An ID of the target device.
Returns a name of the the current location mode.
Returns a number of available buttons.
Capabilities:
A target device.
A number of the available buttons.
Returns a number of available buttons.
Capabilities:
An ID of the target device.
A number of the available buttons.
Returns a list of fan modes supported by specified thermostat.
Capabilities:
A target device.
Returns a list of fan modes supported by specified thermostat.
Returns a list of fan modes supported by specified thermostat.
Capabilities:
An ID of the target device.
Returns a list of fan modes supported by specified thermostat.
Returns a list of modes supported by specified thermostat.
Capabilities:
A target device.
Returns a list of modes supported by specified thermostat.
Returns a list of modes supported by specified thermostat.
Capabilities:
An ID of the target device.
Returns a list of modes supported by specified thermostat.
Returns the last temperature measurement.
Capabilities:
A target device.
Returns the last temperature measurement.
Returns the last temperature measurement.
Capabilities:
An ID of the target device.
Returns the last temperature measurement.
Returns current thermostat fan mode.
Capabilities:
A target device.
A value returned in case of invalid value returned by Hubitat.
Returns current thermostat fan mode.
Returns current thermostat fan mode.
Capabilities:
An ID of the target device.
A value returned in case of invalid value returned by Hubitat.
Returns current thermostat fan mode.
Returns current thermostat mode.
Capabilities:
A target device.
A value returned in case of invalid value returned by Hubitat.
Returns current thermostat mode.
Returns current thermostat mode.
Capabilities:
An ID of the target device.
A value returned in case of invalid value returned by Hubitat.
Returns current thermostat mode.
Returns current operating state of the thermostat.
Capabilities:
A target device.
A value returned in case of invalid value returned by Hubitat.
Returns current operating state of the thermostat.
Returns current operating state of the thermostat.
Capabilities:
An ID of the target device.
A value returned in case of invalid value returned by Hubitat.
Returns current operating state of the thermostat.
Returns current thermostat schedule.
Capabilities:
A target device.
Returns current thermostat schedule.
Returns current thermostat schedule.
Capabilities:
An ID of the target device.
Returns current thermostat schedule.
Returns current thermostat setpoint.
Capabilities:
A target device.
Returns current thermostat setpoint.
Returns current thermostat setpoint.
Capabilities:
An ID of the target device.
Returns current thermostat setpoint.
A target device.
Returns current valve position.
An ID of the target device.
Returns current valve position.
A target device.
Returns current window shade position. 0 is closed, 100 is open.
An ID of the target device.
Returns current window shade position. 0 is closed, 100 is open.
A target device.
Returns current valve position.
An ID of the target device.
Returns current valve position.
Returns a value indicating whether the acceleration is detected.
Capabilities:
A target device.
true
if acceleration was detected; false
when not.
Returns a value indicating whether the acceleration is detected.
Capabilities:
An ID of the target device.
true
if acceleration was detected; false
when not.
Returns a value indicating whether any of specified switches are on.
Capabilities:
A list of target devices.
true
if any switch is on; false
if the no switch is on.
Returns a value whether the device is closed.
Capabilities:
A target device.
true
if the device is closed; false
if sensor is open or
encountered an error.
Returns a value whether the device is closed.
Capabilities:
A target device.
A value returned in case getting the device status has failed.
true
if the device is closed; false
if sensor is open.
Returns a value whether the device is closed.
Capabilities:
An ID of the target device.
true
if the device is closed; false
if sensor is open.
Returns a value whether the device is closed.
Capabilities:
An ID of the target device.
A value returned in case getting the device status has failed.
true
if the device is closed; false
if sensor is open or
encountered an error.
Returns a value indicating whether the motion was detected.
Capabilities:
A target device.
A value returned in case getting the device status has failed.
true
if the motion was detected; false
if the motion wasn't
detected.
Returns a value indicating whether the motion was detected.
Capabilities:
An ID of the target device.
A value returned in case getting the device status has failed.
true
if the motion was detected; false
if the motion wasn't
detected.
Returns current switch status.
Capabilities:
A target device.
true
if the switch is on; false
if the switch is off.
Returns current switch status.
Capabilities:
An ID of the target device.
true
if the switch is on; false
if the switch is off.
Returns current switch status.
Capabilities:
A target device or an ID of the target device.
true
if the switch is on; false
if the switch is off.
Returns a value whether the device is open.
Capabilities:
A target device.
true
if the device is open; false
if sensor is closed or
encountered an error.
Returns a value whether the device is open.
Capabilities:
A target device.
A value returned in case getting the device status has failed.
true
if the device is open; false
if sensor is closed.
Returns a value whether the device is open.
Capabilities:
An ID of the target device.
true
if the device is open; false
if sensor is closed.
Returns a value whether the device is open.
Capabilities:
An ID of the target device.
A value returned in case getting the device status has failed.
true
if the device is open; false
if sensor is closed or
encountered an error.
Returns a value indicating whether the presence was detected.
Capabilities:
A target device.
A value returned in case getting the device status has failed.
true
if the presence was detected; false
if no presence was
detected.
Returns a value indicating whether the presence was detected.
Capabilities:
An ID of the target device.
A value returned in case getting the device status has failed.
true
if the presence was detected; false
if no presence was
detected.
Opens the device.
Capabilities:
A target device.
Opens the device.
Capabilities:
An ID of the target device.
Opens the device.
Capabilities:
An ID of the target device or the device itself.
Refreshes the device.
Capabilities:
A target device.
Refreshes the device.
Capabilities:
An ID of the target device.
Sets the acceleration status of the virtual acceleration sensor.
Capabilities:
A target device.
Acceleration status to set.
Sets the acceleration status of the virtual acceleration sensor.
Capabilities:
An ID of the target device.
Acceleration status to set.
Sets the alarm to a specified setting.
Capabilities:
A target device.
A setting to set the alarm to.
Sets the alarm to a specified setting.
Capabilities:
An ID of the target device.
A setting to set the alarm to.
Sets the thermostat cooling setpoint to a specified temperature.
Capabilities:
A target device.
A temperature to set the cooling setpoint to.
Sets the thermostat cooling setpoint to a specified temperature.
Capabilities:
An ID of the target device.
A temperature to set the cooling setpoint to.
Sets the thermostat heating setpoint to a specified temperature.
Capabilities:
A target device.
A temperature to set the heating setpoint to.
Sets the thermostat heating setpoint to a specified temperature.
Capabilities:
An ID of the target device.
A temperature to set the heating setpoint to.
Sets the switch to a specified level. Can't specify level change duration due to Maker API limitations.
Capabilities:
A target device.
A level to set the switch to.
Sets the switch to a specified level. Can't specify level change duration due to Maker API limitations.
Capabilities:
An ID of the target device.
A level to set the switch to.
Moves the device to provided position.
Capabilities:
A target device.
The position to initialize.
Moves the device to provided position.
Capabilities:
An ID of the target device.
The position to initialize.
Sets the supported fan modes of a virtual thermostat device.
Capabilities:
A target device.
A list of supported fan modes to set.
Sets the supported fan modes of a virtual thermostat device.
Capabilities:
An ID of the target device.
A list of supported fan modes to set.
Sets the supported modes of a virtual thermostat device.
Capabilities:
A target device.
A list of supported modes to set.
Sets the supported modes of a virtual thermostat device.
Capabilities:
An ID of the target device.
A list of supported modes to set.
Sets the switch to a specified value.
Capabilities:
A target device.
A setting to set the switch to. true
is on; false
is off.
Sets the switch to a specified value.
Capabilities:
An ID of the target device.
A setting to set the switch to. true
is on; false
is off.
Sets the switch to a specified value.
Capabilities:
An ID of the target device or the device itself.
A setting to set the switch to. true
is on; false
is off.
Sets the temperature measurement of a virtual temperature measurement device.
Capabilities:
A target device.
A temperature to set.
Sets the temperature measurement of a virtual temperature measurement device.
Capabilities:
An ID of the target device.
A temperature to set.
Sets the thermostat fan mode.
Capabilities:
A target device.
A fan mode to set.
Sets the thermostat fan mode.
Capabilities:
An ID of the target device.
A fan mode to set.
Sets the thermostat mode.
Capabilities:
A target device.
A mode to set.
Sets the thermostat mode.
Capabilities:
An ID of the target device.
A mode to set.
Sets the operating mode of a virtual thermostat device.
Capabilities:
A target device.
An operating mode to set.
Sets the operating mode of a virtual thermostat device.
Capabilities:
An ID of the target device.
An operating mode to set.
Sets the thermostat schedule.
Capabilities:
A target device.
A schedule data.
Sets the thermostat schedule.
Capabilities:
An ID of the target device.
A schedule data.
Sets the setpoint of a virtual thermostat device.
Capabilities:
A target device.
A temperature to set the setpoint to.
Sets the setpoint of a virtual thermostat device.
Capabilities:
An ID of the target device.
A temperature to set the setpoint to.
A target device.
A coverage percentage to set.
An ID of the target device.
A coverage percentage to set.
Starts the level change in a specified direction.
Capabilities:
A target device.
A direction of the level change
Starts the level change in a specified direction.
Capabilities:
An ID of the target device.
A direction of the level change.
Stop the level change.
Capabilities:
A target device.
Stop the level change.
Capabilities:
An ID of the target device.
Sets the switch to off
position.
Capabilities:
A target device.
Sets the switch to off
position.
Capabilities:
An ID of the target device.
Sets the switch to off
position.
Capabilities:
An ID of the target device or the device itself.
Sets the switch to on
position.
Capabilities:
A target device.
Sets the switch to on
position.
Capabilities:
An ID of the target device.
Sets the switch to on
position.
Capabilities:
An ID of the target device or the device itself.
Toggles the switch.
Capabilities:
A target device.
Toggles the switch.
Capabilities:
An ID of the target device.
Returns a number of the button that was double-pressed.
Capabilities:
A target device.
A number of the button that was double-pressed.
Returns a number of the button that was double-pressed.
Capabilities:
An ID of the target device.
A number of the button that was double-pressed.
Returns a number of the button that was held.
Capabilities:
A target device.
A number of the button that was held.
Returns a number of the button that was held.
Capabilities:
An ID of the target device.
A number of the button that was held.
Returns a number of the button that was pushed.
Capabilities:
A target device.
A number of the button that was pushed.
Returns a number of the button that was pushed.
Capabilities:
An ID of the target device.
A number of the button that was pushed.
Returns a number of the button that was released.
Capabilities:
A target device.
A number of the button that was released.
Returns a number of the button that was released.
Capabilities:
An ID of the target device.
A number of the button that was released.
Generated using TypeDoc
Active/inactive status.