Options
All
  • Public
  • Public/Protected
  • All
Menu

Module HubitatCapabilities

Index

Type aliases

EActiveStatus

EActiveStatus: "active" | "inactive"

Active/inactive status.

EAlarmSetting

EAlarmSetting: "both" | "off" | "siren" | "strobe"

All possible settings of the alarm.

EDoorStatus

EDoorStatus: "closed" | "closing" | "open" | "opening" | "unknown"

All possible statuses of a door.

ELevelChangeDirection

ELevelChangeDirection: "down" | "up"

Possible directions of the level change.

EOpenClosedPosition

EOpenClosedPosition: "closed" | "open"

Positions: open and closed.

ESwitchStatus

ESwitchStatus: "off" | "on"

Switch status.

EThermostatFanModes

EThermostatFanModes: "on" | "circulate" | "auto"

Possible thermostat fan modes.

EThermostatModes

EThermostatModes: "auto" | "off" | "heat" | "emergency heat" | "cool"

Possible thermostat modes.

EThermostatOperatingState

EThermostatOperatingState: "heating" | "pending cool" | "pending heat" | "vent economizer" | "idle" | "cooling" | "fan only"

Possible thermostat operating modes.

EWindowShadePosition

EWindowShadePosition: "closed" | "closing" | "open" | "opening" | "partially open" | "unknown"

All possible positions of the window shade.

Functions

close

  • close(device: HubitatDevice): Promise<void>
  • close(deviceId: number): Promise<void>
  • close(deviceOrId: HubitatDevice | number): Promise<void>

enumListToStringList

  • enumListToStringList(enumList: string): string[]

getAlarmSetting

getBatteryStatus

  • getBatteryStatus(device: HubitatDevice): number
  • getBatteryStatus(deviceId: number): number

getCarbonDioxide

  • getCarbonDioxide(device: HubitatDevice): number
  • getCarbonDioxide(deviceId: number): number

getCarbonMonoxide

  • getCarbonMonoxide(device: HubitatDevice): number
  • getCarbonMonoxide(deviceId: number): number

getContactSensorStatus

getCoolingSetpoint

  • getCoolingSetpoint(device: HubitatDevice): number
  • getCoolingSetpoint(deviceId: number): number

getDevice

getDoorPosition

getHeatingSetpoint

  • getHeatingSetpoint(device: HubitatDevice): number
  • getHeatingSetpoint(deviceId: number): number

getIlluminance

  • getIlluminance(device: HubitatDevice): number
  • getIlluminance(deviceId: number): number

getLevel

  • getLevel(device: HubitatDevice): number
  • getLevel(deviceId: number): number

getLocationMode

  • getLocationMode(device: HubitatDevice): string | undefined
  • getLocationMode(deviceId: number): string | undefined

getNumberOfButtons

  • getNumberOfButtons(device: HubitatDevice): number
  • getNumberOfButtons(deviceId: number): number

getSupportedThermostatFanModes

getSupportedThermostatModes

getTemperature

  • getTemperature(device: HubitatDevice): number
  • getTemperature(deviceId: number): number

getThermostatFanMode

getThermostatMode

getThermostatOperatingState

getThermostatSchedule

  • getThermostatSchedule(device: HubitatDevice): Record<string, any>
  • getThermostatSchedule(deviceId: number): Record<string, any>

getThermostatSetpoint

  • getThermostatSetpoint(device: HubitatDevice): number
  • getThermostatSetpoint(deviceId: number): number

getValvePosition

getWindowShadeCoverage

  • getWindowShadeCoverage(device: HubitatDevice): number
  • getWindowShadeCoverage(deviceId: number): number

getWindowShadePosition

isAccelerating

  • isAccelerating(device: HubitatDevice): boolean
  • isAccelerating(deviceId: number): boolean

isAnySwitchOn

isClosed

  • isClosed(device: HubitatDevice): boolean
  • isClosed(device: HubitatDevice, defaultValue: boolean): boolean
  • isClosed(deviceId: number): boolean
  • isClosed(deviceId: number, defaultValue: boolean): boolean

isMotionDetected

  • isMotionDetected(device: HubitatDevice, defaultValue: boolean): boolean
  • isMotionDetected(deviceId: number, defaultValue: boolean): boolean
  • Returns a value indicating whether the motion was detected.

    Capabilities:

    • MotionSensor

    Parameters

    • device: HubitatDevice

      A target device.

    • defaultValue: boolean

      A value returned in case getting the device status has failed.

    Returns boolean

    true if the motion was detected; false if the motion wasn't detected.

  • Returns a value indicating whether the motion was detected.

    Capabilities:

    • MotionSensor

    Parameters

    • deviceId: number

      An ID of the target device.

    • defaultValue: boolean

      A value returned in case getting the device status has failed.

    Returns boolean

    true if the motion was detected; false if the motion wasn't detected.

isOn

isOpen

  • isOpen(device: HubitatDevice): boolean
  • isOpen(device: HubitatDevice, defaultValue: boolean): boolean
  • isOpen(deviceId: number): boolean
  • isOpen(deviceId: number, defaultValue: boolean): boolean

isPresent

  • isPresent(device: HubitatDevice, defaultValue: boolean): boolean
  • isPresent(deviceId: number, defaultValue: boolean): boolean
  • Returns a value indicating whether the presence was detected.

    Capabilities:

    • Beacon
    • PresenceSensor

    Parameters

    • device: HubitatDevice

      A target device.

    • defaultValue: boolean

      A value returned in case getting the device status has failed.

    Returns boolean

    true if the presence was detected; false if no presence was detected.

  • Returns a value indicating whether the presence was detected.

    Capabilities:

    • Beacon
    • PresenceSensor

    Parameters

    • deviceId: number

      An ID of the target device.

    • defaultValue: boolean

      A value returned in case getting the device status has failed.

    Returns boolean

    true if the presence was detected; false if no presence was detected.

open

  • open(device: HubitatDevice): Promise<void>
  • open(deviceId: number): Promise<void>
  • open(deviceOrId: HubitatDevice | number): Promise<void>

refresh

  • refresh(device: HubitatDevice): Promise<void>
  • refresh(deviceId: number): Promise<void>

setAcceleration

setAlarmSetting

setCoolingSetpoint

  • setCoolingSetpoint(device: HubitatDevice, temperature: number): Promise<void>
  • setCoolingSetpoint(deviceId: number, temperature: number): Promise<void>

setHeatingSetpoint

  • setHeatingSetpoint(device: HubitatDevice, temperature: number): Promise<void>
  • setHeatingSetpoint(deviceId: number, temperature: number): Promise<void>

setLevel

  • setLevel(device: HubitatDevice, level: number): Promise<void>
  • setLevel(deviceId: number, level: number): Promise<void>

setPosition

setSupportedThermostatFanModes

setSupportedThermostatModes

setSwitch

setTemperature

  • setTemperature(device: HubitatDevice, temperature: number): Promise<void>
  • setTemperature(deviceId: number, temperature: number): Promise<void>

setThermostatFanMode

setThermostatMode

setThermostatOperatingState

setThermostatSchedule

  • setThermostatSchedule(device: HubitatDevice, schedule: Record<string, any>): Promise<void>
  • setThermostatSchedule(deviceId: number, schedule: Record<string, any>): Promise<void>

setThermostatSetpoint

  • setThermostatSetpoint(device: HubitatDevice, temperature: number): Promise<void>
  • setThermostatSetpoint(deviceId: number, temperature: number): Promise<void>

setWindowShadeCoverage

  • setWindowShadeCoverage(device: HubitatDevice, coverage: number): Promise<void>
  • setWindowShadeCoverage(deviceId: number, coverage: number): Promise<void>

startLevelChange

stopLevelChange

  • stopLevelChange(device: HubitatDevice): Promise<void>
  • stopLevelChange(deviceId: number): Promise<void>

switchOff

  • switchOff(device: HubitatDevice): Promise<void>
  • switchOff(deviceId: number): Promise<void>
  • switchOff(deviceOrId: HubitatDevice | number): Promise<void>

switchOn

  • switchOn(device: HubitatDevice): Promise<void>
  • switchOn(deviceId: number): Promise<void>
  • switchOn(deviceOrId: HubitatDevice | number): Promise<void>

toggle

  • toggle(device: HubitatDevice): Promise<void>
  • toggle(deviceId: number): Promise<void>

whichButtonDoubleTapped

  • whichButtonDoubleTapped(device: HubitatDevice): number
  • whichButtonDoubleTapped(deviceId: number): number

whichButtonHeld

  • whichButtonHeld(device: HubitatDevice): number
  • whichButtonHeld(deviceId: number): number

whichButtonPushed

  • whichButtonPushed(device: HubitatDevice): number
  • whichButtonPushed(deviceId: number): number

whichButtonReleased

  • whichButtonReleased(device: HubitatDevice): number
  • whichButtonReleased(deviceId: number): number

Generated using TypeDoc