Go to Body Go to Navigation

Capabilities Reference

Capabilities are core to the SmartThings architecture. They allow us to abstract specific devices into their underlying capabilities.

An application interacts with devices based on their capabilities, so once we understand the capabilities that are needed by a SmartApp, and the capabilities that are provided by a device, we can understand which devices (based on the Device’s declared capabilities) are eligible for use within a specific SmartApp.

Capabilities themselves are decomposed into both Commands and Attributes. Commands represent ways in which you can control or actuate the device, whereas Attributes represent state information or properties of the device.

Capabilities are created and maintained by the SmartThings development team.

This page serves as a reference for the supported capabilities.

Data types

Before we present the Capabilities, it’s worth covering the various data types associated with Attributes and Commands. Note that these data types are guidelines as to how actual values can be represented. In most cases, the SmartThings platform contains the implementation logic and defines the actual objects for these data types. Below is a table outlining the possible data types and what they mean.

Data type Example Description
STRING “this is a string” Represents character strings
NUMBER 5, 10.6 The Number data type is a guideline indicating that a number should be expected, and not a specific type. Device Handlers contain the implementation of what kind of number object is actually returned.
VECTOR3 (x, y, z) This data type is a representation of x,y,z coordinates in space. Device Handlers contain the implementation of the actual data structure, but it is usually as a Map: [x: 0, y: 0, z: 0].
ENUM “one”, “two”, “three” The Enum data type is a static set of predefined String values that an Attribute can have, or that a Command can accept as an argument.
DYNAMIC_ENUM “any”, “value” Much like the Enum data type, Dynamic Enum is a set of String values. However, the set is not static or predefined.
COLOR_MAP [hue: 50, saturation: 60] The Color Map is a Map specifically for the use of color control. As such, the Map should contain a Hue and a Saturation value.
JSON_OBJECT A standard JSON object. Device Handlers contain the implementation and thus should be consulted when looking for the JSON object structure.
DATE A Date, usually represented as a java.util.Date object.

Key Definitions

Key Description Example
name Name of the Capability Acceleration Sensor
status Whether the Capability is ready or still in beta live or proposed
attributes A list of Attributes and their key-value pairs supported for the Capability acceleration
commands A list of Commands and their key-value pairs supported for the Capability setAirConditionerMode
id The ID of the Capability. airConditionerMode
ocfResourceType The corresponding OCF Resource Type for a Capability x.com.st.alarm

Capabilities

Acceleration Sensor

The Acceleration Sensor capability allows for acceleration detection. Some use cases for SmartApps using this capability would be detecting if a washing machine is vibrating, or if a case has moved (particularly useful for knowing if a weapon case has been moved).

Definition

# reviewed 2018-01-03
name: Acceleration Sensor
status: live
attributes:
  acceleration:
    schema:
      type: object
      properties:
        value:
          $ref: ActivityState
      required: ["value"]
    type: ENUM
    values:
      - active
      - inactive
commands: {
  }
public: true
id: accelerationSensor
ocfResourceType: x.com.st.acceleration
version: 1

Attributes

acceleration

A string representation of whether the sensor is active or not

Type: ENUM Required: Yes

Possible values:

  • active - if acceleration is detected
  • inactive - if no acceleration is detected

Commands

None.

Air Conditioner Mode

Allows for the control of the air conditioner.

Definition

# reviewed 2018-01-03
name: Air Conditioner Mode
status: proposed
attributes:
  airConditionerMode:
    schema:
      type: object
      properties:
        value:
          $ref: HvacMode
      required: ["value"]
    type: ENUM
    values:
      - auto
      - cool
      - dry
      - coolClean
      - dryClean
      - fanOnly
      - heat
      - heatClean
      - notSupported
    setter: setAirConditionerMode
commands:
  setAirConditionerMode:
    arguments:
    - name: mode
      schema:
        $ref: HvacMode
      type: ENUM
      values:
        - auto
        - cool
        - dry
        - coolClean
        - dryClean
        - fanOnly
        - heat
        - heatClean
        - notSupported
public: true
id: airConditionerMode
ocfResourceType: x.com.st.mode.airconditioner
version: 1

Attributes

airConditionerMode

Current mode of the air conditioner

Type: ENUM Required: Yes

Possible values:

  • auto - The air conditioner is in “auto” mode
  • cool - The air conditioner is in “cool” mode
  • dry - The air conditioner is in “dry” mode
  • coolClean - The air conditioner is in “coolClean” mode
  • dryClean - The air conditioner is in “dryClean” mode
  • fanOnly - The air conditioner is in “fanOnly” mode
  • heat - The air conditioner is in “heat” mode
  • heatClean - The air conditioner is in “heatClean” mode
  • notSupported - The air conditioner is in “notSupported” mode

Commands

setAirConditionerMode(mode)

Set the air conditioner mode

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: Set the air conditioner mode, to auto, cool, dry, dryClean, fanOnly, heat, heatClean or notSupported states

Air Quality Sensor

Gets the air quality number.

Definition

# reviewed 2018-01-11
name: Air Quality Sensor
status: proposed
attributes:
  airQuality:
    schema:
      type: object
      properties:
        value:
          $ref: PositiveInteger
      required: ["value"]
    type: NUMBER
commands: {
  }
public: true
id: airQualitySensor
ocfResourceType: x.com.st.airqualitylevel
version: 1

Attributes

airQuality

Current air quality number

Type: NUMBER Required: Yes

Commands

None.

Alarm

The Alarm capability allows for interacting with devices that serve as alarms

Definition

# reviewed 2018-01-03
name: Alarm
status: live
attributes:
  alarm:
    schema:
      type: object
      properties:
        value:
          $ref: AlertState
      required: ["value"]
    type: ENUM
    values:
      - both
      - 'off'
      - siren
      - strobe
    enumCommands:
      - command: both
        value: both
      - command: 'off'
        value: 'off'
      - command: siren
        value: siren
      - command: strobe
        value: strobe
commands:
  both:
    arguments: [
      ]
  'off':
    arguments: [
      ]
  siren:
    arguments: [
      ]
  strobe:
    arguments: [
      ]
public: true
id: alarm
ocfResourceType: x.com.st.alarm
version: 1

Attributes

alarm

A string representation of whether the switch is on or off

Type: ENUM Required: Yes

Possible values:

  • both - if the alarm is strobing and sounding the alarm
  • off - if the alarm is turned off
  • siren - if the alarm is sounding the siren
  • strobe - if the alarm is strobing

Commands

both()

Strobe and sound the alarm

off()

Turn the alarm (siren and strobe) off

siren()

Sound the siren on the alarm

strobe()

Strobe the alarm

Audio Volume

Allows for the control of audio volume.

Definition

# reviewed 2018-01-03
name: Audio Volume
status: proposed
attributes:
  volume:
    schema:
      $ref: IntegerPercent
    type: NUMBER
    setter: setVolume
    actedOnBy:
      - volumeUp
      - volumeDown
commands:
  setVolume:
    arguments:
    - name: volume
      schema:
        type: integer
        minimum: 0
        maximum: 100
      type: NUMBER
  volumeUp:
    arguments: [
      ]
  volumeDown:
    arguments: [
      ]
public: true
id: audioVolume
ocfResourceType: x.com.st.audiovolume
version: 1

Attributes

volume

The current volume setting of the audio

Type: NUMBER Required: Yes

Commands

setVolume(volume)

Set the audio volume level

Arguments:

  • volume
    • Type: NUMBER
    • Required: Yes
    • Description: A value to which the audio volume level should be set

volumeUp()

Turn the audio volume up

volumeDown()

Turn the audio volume down

Battery

Defines that the device has a battery

Definition

# reviewed 2018-01-03
name: Battery
status: live
attributes:
  battery:
    schema:
      $ref: IntegerPercent
    type: NUMBER
    unit: '%'
commands: {
  }
public: true
id: battery
ocfResourceType: oic.r.energy.battery
version: 1

Attributes

battery

An indication of the status of the battery

Type: NUMBER Required: Yes

Commands

None.

Carbon Monoxide Detector

Measure carbon monoxide levels

Definition

# reviewed 2018-01-09
name: Carbon Monoxide Detector
status: live
attributes:
  carbonMonoxide:
    schema:
      type: object
      properties:
        value:
          $ref: CarbonMonoxideState
      required: ["value"]
    type: ENUM
    values:
      - clear
      - detected
      - tested
commands: {
  }
public: true
id: carbonMonoxideDetector
ocfResourceType: x.com.st.carbonmonoxidedetector
version: 1

Attributes

carbonMonoxide

The state of the carbon monoxide device

Type: ENUM Required: Yes

Possible values:

  • clear - No carbon monoxide detected
  • detected - Carbon monoxide detected
  • tested - Carbon monoxide device test button was activated

Commands

None.

Color Control

Allows for control of a color changing device by setting its hue, saturation, and color values

Definition

# reviewed 2018-01-16
name: Color Control
status: live
attributes:
  color:
    schema:
      type: object
      properties:
        value:
          $ref: String
    type: STRING
    setter: setColor
    actedOnBy:
      - setHue
      - setSaturation
  hue:
    schema:
      type: object
      properties:
        value:
          $ref: PositiveInteger
    type: NUMBER
    setter: setHue
  saturation:
    schema:
      type: object
      properties:
        value:
          $ref: PositiveInteger
    type: NUMBER
    setter: setSaturation
commands:
  setColor:
    arguments:
    - name: color
      type: COLOR_MAP
      schema:
        type: object
        properties:
          value:
            $ref: color-map
  setHue:
    arguments:
    - name: hue
      schema:
        $ref: PositiveInteger
      type: NUMBER
  setSaturation:
    arguments:
    - name: saturation
      schema:
        $ref: PositiveInteger
      type: NUMBER
public: true
id: colorControl
ocfResourceType: oic.r.colour.chroma
version: 1

Attributes

color

{"hue":"0-100 (percent)", "saturation":"0-100 (percent)"}

Type: STRING Required: Yes

hue

0-100 (percent)

Type: NUMBER Required: Yes

saturation

0-100 (percent)

Type: NUMBER Required: Yes

Commands

setColor(color)

Sets the color based on the values passed in with the given map

Arguments:

  • color
    • Type: COLOR_MAP
    • Required: Yes
    • Description: The color map supports the following key/value pairs:

setHue(hue)

Set the hue value of the color

Arguments:

  • hue
    • Type: NUMBER
    • Required: Yes
    • Description: A number in the range 0-100 representing the hue as a value of percent

setSaturation(saturation)

Set the saturation value of the color

Arguments:

  • saturation
    • Type: NUMBER
    • Required: Yes
    • Description: A number in the range 0-100 representing the saturation as a value of percent

Color Temperature

Set the color temperature attribute of a color changing device

Definition

# reviewed 2018-01-16
name: Color Temperature
status: live
attributes:
  colorTemperature:
    schema:
      type: object
      properties:
        value:
          type: integer
          minimum: 1
          maximum: 30000
        unit:
          type: string
          enum:
           - K
          default: K
      required:
        - value
    type: NUMBER
    setter: setColorTemperature
commands:
  setColorTemperature:
    arguments:
    - name: temperature
      schema:
        type: integer
        minimum: 1
        maximum: 30000
      type: NUMBER
public: true
id: colorTemperature
ocfResourceType: x.com.st.color.temperature
version: 1

Attributes

colorTemperature

A number that represents the color temperature, measured in degrees Kelvin

Type: NUMBER Required: Yes

Commands

setColorTemperature(temperature)

Set the color temperature to the specified value

Arguments:

  • temperature
    • Type: NUMBER
    • Required: Yes
    • Description: The value to set the color temperature attribute to, in Kelvin

Contact Sensor

Allows reading the value of a contact sensor device

Definition

# reviewed 2018-01-09
name: Contact Sensor
status: live
attributes:
  contact:
    schema:
      type: object
      properties:
        value:
          $ref: ContactState
      required: ["value"]
    type: ENUM
    values:
      - closed
      - open
commands: {
  }
public: true
id: contactSensor
ocfResourceType: oic.r.sensor.contact
version: 1

Attributes

contact

The current state of the contact sensor

Type: ENUM Required: Yes

Possible values:

  • closed - The value if closed
  • open - The value if open

Commands

None.

Dishwasher Mode

Allows for the control of the dishwasher.

Definition

name: Dishwasher Mode
status: proposed
attributes:
  dishwasherMode:
    schema:
      type: object
      properties:
        value:
          $ref: DishwasherMode
      required: ["value"]
    type: ENUM
    values:
      - auto
      - quick
      - rinse
      - dry
    setter: setDishwasherMode
commands:
  setDishwasherMode:
    arguments:
    - name: mode
      schema:
        $ref: DishwasherMode
      type: ENUM
      values:
        - auto
        - quick
        - rinse
        - dry
public: true
id: dishwasherMode
ocfResourceType: x.com.st.mode.dishwasher
version: 1

Attributes

dishwasherMode

Current mode of the dishwasher

Type: ENUM Required: Yes

Possible values:

  • auto - The dishwasher is in “auto” mode
  • quick - The dishwasher is in “quick” mode
  • rinse - The dishwasher is in “rinse” mode
  • dry - The dishwasher is in “dry” mode

Commands

setDishwasherMode(mode)

Set the dishwasher mode

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: Set the dishwasher mode to “auto”, “quick”, “rinse”, or “dry” mode

Door Control

Allow for the control of a door

Definition

# reviewed 2018-02-20
name: Door Control
status: live
attributes:
  door:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - closed
            - closing
            - open
            - opening
            - unknown
        constraints:
          type: object
          properties:
            values:
              type: array
              items:
                type: string
                enum:
                  - closed
                  - closing
                  - open
                  - opening
                  - unknown
      required:
        - value
    type: ENUM
    values:
      - closed
      - closing
      - open
      - opening
      - unknown
    enumCommands:
      - command: close
        value: closed
      - command: open
        value: open
commands:
  close:
    arguments: [
      ]
  open:
    arguments: [
      ]
public: true
id: doorControl
ocfResourceType: x.com.st.doorcontrol
version: 1

Attributes

door

The current state of the door

Type: ENUM Required: Yes

Possible values:

  • closed - The door is closed
  • closing - The door is closing
  • open - The door is open
  • opening - The door is opening
  • unknown - The current state of the door is unknown

Commands

close()

Close the door

open()

Open the door

Dryer Mode

Allows for the control of the dryer.

Definition

name: Dryer Mode
status: proposed
attributes:
  dryerMode:
    schema:
      type: object
      properties:
        value:
          $ref: DryerMode
        constraints:
          type: object
          properties:
            values:
              type: array
              items:
                $ref: DryerMode
      required: ["value"]
    type: ENUM
    values:
      - regular
      - lowHeat
      - highHeat
    setter: setDryerMode
commands:
  setDryerMode:
    arguments:
    - name: mode
      schema:
        $ref: DryerMode
      type: ENUM
      values:
        - regular
        - lowHeat
        - highHeat
public: true
id: dryerMode
ocfResourceType: x.com.st.mode.dryer
version: 1

Attributes

dryerMode

The operational mode that the dryer is in

Type: ENUM Required: Yes

Possible values:

  • regular -
  • lowHeat -
  • highHeat -

Commands

setDryerMode(mode)

Set the operational mode of the dryer

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: The mode to which the dryer should be set to

Dust Sensor

Gets the reading of the dust sensor.

Definition

name: Dust Sensor
status: proposed
attributes:
  fineDustLevel:
    schema:
      type: object
      properties:
        value:
          $ref: PositiveInteger
      required: ["value"]
    type: NUMBER
  dustLevel:
    schema:
      type: object
      properties:
        value:
          $ref: PositiveInteger
      required: ["value"]
    type: NUMBER
commands: {
  }
public: true
id: dustSensor
ocfResourceType: x.com.st.dustlevel
version: 1

Attributes

fineDustLevel

Current level of the fine dust

Type: NUMBER Required: Yes

dustLevel

Current dust level

Type: NUMBER Required: Yes

Commands

None.

Energy Meter

Read the energy consumption of an energy metering device

Definition

# reviewed 2018-02-20
name: Energy Meter
status: live
attributes:
  energy:
    schema:
      type: object
      properties:
        value:
          type: number
        unit:
          type: string
          enum:
            - kWh
          default: kWh
      required:
        - value
    type: NUMBER
commands: {
  }
public: true
id: energyMeter
ocfResourceType: x.com.st.energymeter
version: 1

Attributes

energy

Numeric value representing energy consumption

Type: NUMBER Required: Yes

Commands

None.

Fan Speed

Allows for the control of the fan speed.

Definition

name: Fan Speed
status: proposed
attributes:
  fanSpeed:
    schema:
      type: object
      properties:
        value:
          $ref: PositiveInteger
      required: ["value"]
    type: NUMBER
    setter: setFanSpeed
commands:
  setFanSpeed:
    arguments:
    - name: speed
      schema:
        $ref: PositiveInteger
      type: NUMBER
public: true
id: fanSpeed
ocfResourceType: x.com.st.fanspeed
version: 1

Attributes

fanSpeed

Type: NUMBER Required: Yes

Commands

setFanSpeed(speed)

Set the fan speed

Arguments:

  • speed
    • Type: NUMBER
    • Required: Yes
    • Description: Set the fan to this speed

Filter Status

Gets the status of the filter.

Definition

name: Filter Status
status: proposed
attributes:
  filterStatus:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - normal
            - replace
      required: ["value"]
    type: ENUM
    values:
      - normal
      - replace
commands: {
  }
public: true
id: filterStatus
ocfResourceType: x.com.st.filter
version: 1

Attributes

filterStatus

Status of the filter

Type: ENUM Required: Yes

Possible values:

  • normal - The filter status is normal
  • replace - The filter status is replace

Commands

None.

Illuminance Measurement

Gives the illuminance reading from devices that support it

Definition

# reviewed 2018-01-09
name: Illuminance Measurement
status: live
attributes:
  illuminance:
    schema:
      type: object
      properties:
        value:
          type: number
          minimum: 0
          maximum: 100000
        unit:
          type: string
          enum:
            - lux
          default: lux
      required: ["value"]
    type: NUMBER
    unit: lux
commands: {
  }
public: true
id: illuminanceMeasurement
ocfResourceType: oic.r.sensor.illuminance
version: 1

Attributes

illuminance

The illuminance measurement in LUX

Type: NUMBER Required: Yes

Commands

None.

Lock

Allow for the control of a lock device

Definition

# reviewed 2018-02-22
name: Lock
status: proposed
attributes:
  lock:
    schema:
      type: object
      properties:
        value:
          $ref: LockState
        data:
          type: object
          properties:
            method:
              type: string
              enum:
                - manual
                - keypad
                - auto
                - command
            codeId:
              type: string
            timeout:
              $ref: Iso8601Date
      required:
        - value
    type: ENUM
    values:
      - locked
      - unknown
      - unlocked
      - unlocked with timeout
    enumCommands:
      - command: lock
        value: locked
      - command: unlock
        value: unlocked
commands:
  lock:
    arguments: [
      ]
  unlock:
    arguments: [
      ]
public: true
id: lock
ocfResourceType: oic.r.lock.status
version: 1

Attributes

lock

The state of the lock device

Type: ENUM Required: Yes

Possible values:

  • locked - The device is locked
  • unknown - The state of the device is unknown
  • unlocked - The device is unlocked
  • unlocked with timeout -

Commands

lock()

Lock the device

unlock()

Unlock the device

Media Input Source

Allows for the control of the media input source.

Definition

name: Media Input Source
status: proposed
attributes:
  inputSource:
    schema:
      type: object
      properties:
        value:
          $ref: MediaSource
      required: ["value"]
    type: ENUM
    values:
      - AM
      - CD
      - FM
      - HDMI
      - HDMI2
      - USB
      - YouTube
      - aux
      - bluetooth
      - digital
      - melon
      - wifi
    setter: setInputSource
  supportedInputSources:
    schema:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: MediaSource
      required: ["value"]

    type: JSON_OBJECT
commands:
  setInputSource:
    arguments:
    - name: mode
      schema:
        $ref: MediaSource
      type: ENUM
      values:
        - AM
        - CD
        - FM
        - HDMI
        - HDMI2
        - USB
        - YouTube
        - aux
        - bluetooth
        - digital
        - melon
        - wifi
public: true
id: mediaInputSource
ocfResourceType: x.com.st.mediainputsource
version: 1

Attributes

inputSource

Current input source

Type: ENUM Required: Yes

Possible values:

  • AM - Input source is AM
  • CD - Input source is CD
  • FM - Input source is FM
  • HDMI - Input source is HDMI
  • HDMI2 - Input source is HDMI2
  • USB - Input source is USB
  • YouTube - Input source is YouTube
  • aux - Input source is aux
  • bluetooth - Input source is bluetooth
  • digital - Input source is digital
  • melon - Input source is melon
  • wifi - Input source is wifi

supportedInputSources

Supported input sources

Type: JSON_OBJECT Required: Yes

Commands

setInputSource(mode)

Set the input source for the media

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: Set the input source, to AM, CD, FM, HDMI, HDMI2, USB, YouTube, aux, bluetooth, digital, melon, or wifi

Media Playback Repeat

Allows for the control of the media playback repeat.

Definition

name: Media Playback Repeat
status: proposed
attributes:
  playbackRepeatMode:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - all
            - 'off'
            - one
      required: ["value"]
    type: ENUM
    values:
      - all
      - 'off'
      - one
    setter: setPlaybackRepeatMode
commands:
  setPlaybackRepeatMode:
    arguments:
    - name: mode
      schema:
        type: string
        enum:
          - all
          - 'off'
          - one
      type: ENUM
      values:
        - all
        - 'off'
        - one
public: true
id: mediaPlaybackRepeat
ocfResourceType: x.com.st.mediarepeat
version: 1

Attributes

playbackRepeatMode

The current mode of the playback repeat mode, “all”, “off” or “one”

Type: ENUM Required: Yes

Possible values:

  • all -
  • off -
  • one -

Commands

setPlaybackRepeatMode(mode)

Set the playback repeat mode

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: Mode to which to the playback repeat mode should be set, “all”, “off” or “one”

Media Playback Shuffle

Allows for the control of media playback shuffle.

Definition

name: Media Playback Shuffle
status: proposed
attributes:
  playbackShuffle:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - disabled
            - enabled
      required: ["value"]
    type: ENUM
    values:
      - disabled
      - enabled
    setter: setPlaybackShuffle
commands:
  setPlaybackShuffle:
    arguments:
    - name: shuffle
      schema:
        type: string
        enum:
          - disabled
          - enabled
      type: ENUM
      values:
        - disabled
        - enabled
public: true
id: mediaPlaybackShuffle
ocfResourceType: x.com.st.mediashuffle
version: 1

Attributes

playbackShuffle

The current state of the playback shuffle

Type: ENUM Required: Yes

Possible values:

  • disabled -
  • enabled -

Commands

setPlaybackShuffle(shuffle)

Set the shuffle playback mode

Arguments:

  • shuffle
    • Type: ENUM
    • Required: Yes
    • Description: Set the shuffle playback to enabled or disabled

Media Playback

Allows for the control of the media playback.

Definition

name: Media Playback
status: proposed
attributes:
  level:
    schema:
      type: object
      properties:
        value:
          $ref: PositiveInteger
    type: NUMBER
  playbackStatus:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - pause
            - play
            - stop
    type: ENUM
    values:
      - pause
      - play
      - stop
    setter: setPlaybackStatus
    enumCommands:
      - command: play
        value: play
      - command: pause
        value: pause
      - command: stop
        value: stop
commands:
  setPlaybackStatus:
    arguments:
    - name: status
      schema:
        type: string
        enum:
          - pause
          - play
          - stop
      type: ENUM
      values:
        - pause
        - play
        - stop
  play:
    arguments: [
      ]
  pause:
    arguments: [
      ]
  stop:
    arguments: [
      ]
public: true
id: mediaPlayback
ocfResourceType: x.com.st.mediaplayer
version: 1

Attributes

level

Playback level

Type: NUMBER Required: Yes

playbackStatus

Status of the media playback

Type: ENUM Required: Yes

Possible values:

  • pause - Media playback is in “pause” state
  • play - Media playback is in “play” state
  • stop - Media playback is in “stop” state

Commands

setPlaybackStatus(status)

Set the playback status

Arguments:

  • status
    • Type: ENUM
    • Required: Yes
    • Description: Set the playback status to “pause”, “play”, or “stop” state.

play()

Set the playback status to “play”

pause()

Set the playback status to “pause”

stop()

Set the playback status to “stop”

Motion Sensor

Allows for the ability to read motion sensor device states

Definition

# reviewed 2018-01-09
name: Motion Sensor
status: live
attributes:
  motion:
    schema:
      type: object
      properties:
        value:
          $ref: ActivityState
      required: ["value"]
    type: ENUM
    values:
      - active
      - inactive
commands: {
  }
public: true
id: motionSensor
ocfResourceType: oic.r.sensor.motion
version: 1

Attributes

motion

The current state of the motion sensor

Type: ENUM Required: Yes

Possible values:

  • active - The value when motion is detected
  • inactive - The value when no motion is detected

Commands

None.

Odor Sensor

Gets the odor sensor reading.

Definition

name: Odor Sensor
status: proposed
attributes:
  odorLevel:
    schema:
      type: object
      properties:
        value:
          $ref: PositiveInteger
      required: ["value"]
    type: NUMBER
commands: {
  }
public: true
id: odorSensor
ocfResourceType: x.com.st.gaslevel
version: 1

Attributes

odorLevel

The current oder sensor level reading

Type: NUMBER Required: Yes

Commands

None.

Oven Mode

Allows for the control of the oven mode.

Definition

name: Oven Mode
status: proposed
attributes:
  ovenMode:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - heating
            - grill
            - warming
            - defrosting
        constraints:
          constraints:
            type: object
            properties:
              values:
                type: array
                items:
                  type: string
                  enum:
                    - heating
                    - grill
                    - warming
                    - defrosting
      required: ["value"]
    type: ENUM
    values:
      - heating
      - grill
      - warming
      - defrosting
    setter: setOvenMode
commands:
  setOvenMode:
    arguments:
    - name: mode
      schema:
        type: string
        enum:
          - heating
          - grill
          - warming
          - defrosting
      type: ENUM
      values:
        - heating
        - grill
        - warming
        - defrosting
public: true
id: ovenMode
ocfResourceType: x.com.st.mode.oven
version: 1

Attributes

ovenMode

The mode of operation that the oven is set to

Type: ENUM Required: Yes

Possible values:

  • heating -
  • grill -
  • warming -
  • defrosting -

Commands

setOvenMode(mode)

Set the operation mode of the oven

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: The mode to which oven operation should be set to

Power Meter

Allows for reading the power consumption from devices that report it

Definition

# reviewed 2018-02-20
name: Power Meter
status: live
attributes:
  power:
    schema:
      type: object
      properties:
        value:
          type: number
        unit:
          type: string
          enum:
            - W
          default: W
      required:
        - value
    type: NUMBER
commands: {
  }
public: true
id: powerMeter
ocfResourceType: x.com.st.powermeter
version: 1

Attributes

power

A number representing the current power consumption. Check the device documentation for how this value is reported

Type: NUMBER Required: Yes

Commands

None.

Presence Sensor

The ability to see the current status of a presence sensor device

Definition

# reviewed 2018-01-09
name: Presence Sensor
status: live
attributes:
  presence:
    schema:
      type: object
      properties:
        value:
          $ref: PresenceState
      required: ["value"]
    type: ENUM
    values:
      - not present
      - present
commands: {
  }
public: true
id: presenceSensor
ocfResourceType: oic.r.sensor.presence
version: 1

Attributes

presence

The current state of the presence sensor

Type: ENUM Required: Yes

Possible values:

  • not present -
  • present - The device is present

Commands

None.

Rapid Cooling

Allows for the control of rapid cooling.

Definition

name: Rapid Cooling
status: proposed
attributes:
  rapidCooling:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - 'off'
            - 'on'
      required: ["value"]
    type: ENUM
    values:
      - 'off'
      - 'on'
    setter: setRapidCooling
commands:
  setRapidCooling:
    arguments:
    - name: rapidCooling
      schema:
        type: string
        enum:
          - 'off'
          - 'on'
      type: ENUM
      values:
        - 'off'
        - 'on'
public: true
id: rapidCooling
ocfResourceType: x.com.st.rapidcooling
version: 1

Attributes

rapidCooling

Current status of the rapid cooling

Type: ENUM Required: Yes

Possible values:

  • off - The rapid cooling is in “off” state
  • on - The rapid cooling is in “on” state

Commands

setRapidCooling(rapidCooling)

Set the rapid cooling

Arguments:

  • rapidCooling
    • Type: ENUM
    • Required: Yes
    • Description: Set the rapid cooling to “off” or “on” state

Refrigeration Setpoint

Allows for the control of the refrigeration set point.

Definition

name: Refrigeration Setpoint
status: proposed
attributes:
  refrigerationSetpoint:
    schema:
      $ref: Temperature
    type: NUMBER
    setter: setRefrigerationSetpoint
commands:
  setRefrigerationSetpoint:
    arguments:
    - name: setpoint
      schema:
        $ref: TemperatureValue
      type: NUMBER
public: true
id: refrigerationSetpoint
ocfResourceType: x.com.st.temperature.refrigeration
version: 1

Attributes

refrigerationSetpoint

The temperature at which refrigeration should trigger

Type: NUMBER Required: Yes

Commands

setRefrigerationSetpoint(setpoint)

Set the refrigeration setpoint.

Arguments:

  • setpoint
    • Type: NUMBER
    • Required: Yes
    • Description: A temperature value to which the refrigeration setpoint should be set to

Relative Humidity Measurement

Allow reading the relative humidity from devices that support it

Definition

# reviewed 2018-2-13
name: Relative Humidity Measurement
status: live
attributes:
  humidity:
    schema:
      $ref: Percent
    type: NUMBER
commands: {
  }
public: true
id: relativeHumidityMeasurement
ocfResourceType: oic.r.humidity
version: 1

Attributes

humidity

A numerical representation of the relative humidity measurement taken by the device

Type: NUMBER Required: Yes

Commands

None.

Robot Cleaner Cleaning Mode

Allows for the control of the robot cleaner cleaning mode.

Definition

name: Robot Cleaner Cleaning Mode
status: proposed
attributes:
  robotCleanerCleaningMode:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - auto
            - part
            - repeat
            - manual
            - stop
            - map
      required: ["value"]
    type: ENUM
    values:
      - auto
      - part
      - repeat
      - manual
      - stop
      - map
    setter: setRobotCleanerCleaningMode
commands:
  setRobotCleanerCleaningMode:
    arguments:
    - name: mode
      schema:
        type: string
        enum:
          - auto
          - part
          - repeat
          - manual
          - stop
      type: ENUM
      values:
        - auto
        - part
        - repeat
        - manual
        - stop
public: true
id: robotCleanerCleaningMode
ocfResourceType: x.com.st.robot.cleaner.cleaning
version: 1

Attributes

robotCleanerCleaningMode

Current status of the robot cleaner cleaning mode

Type: ENUM Required: Yes

Possible values:

  • auto - The robot cleaner cleaning mode is in “auto” mode
  • part - The robot cleaner cleaning mode is in “part” mode
  • repeat - The robot cleaner cleaning mode is in “repeat” mode
  • manual - The robot cleaner cleaning mode is in “manual” mode
  • stop - The robot cleaner cleaning mode is in “stop” mode
  • map - The robot cleaner cleaning mode is in “map” mode

Commands

setRobotCleanerCleaningMode(mode)

Set the robot cleaner cleaning mode

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: Set the robot cleaner cleaning mode, to “auto”, “part”, “repeat”, “manual” or “stop” modes

Robot Cleaner Movement

Allows for the control of the robot cleaner movement.

Definition

name: Robot Cleaner Movement
status: proposed
attributes:
  robotCleanerMovement:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - homing
            - idle
            - charging
            - alarm
            - powerOff
            - reserve
            - point
            - after
            - cleaning
      required: ["value"]
    type: ENUM
    values:
      - homing
      - idle
      - charging
      - alarm
      - powerOff
      - reserve
      - point
      - after
      - cleaning
    setter: setRobotCleanerMovement
commands:
  setRobotCleanerMovement:
    arguments:
    - name: mode
      schema:
        type: string
        enum:
          - homing
      type: ENUM
      values:
        - homing
public: true
id: robotCleanerMovement
ocfResourceType: x.com.st.robot.cleaner.movement
version: 1

Attributes

robotCleanerMovement

Current status of the robot cleaner movement

Type: ENUM Required: Yes

Possible values:

  • homing - The robot cleaner movement is in “homing” mode
  • idle - The robot cleaner movement is in “idle” mode
  • charging - The robot cleaner movement is in “charging” mode
  • alarm - The robot cleaner movement is in “alarm” mode
  • powerOff - The robot cleaner movement is in “power off” mode
  • reserve - The robot cleaner movement is in “reserve” mode
  • point - The robot cleaner movement is in “point” mode
  • after - The robot cleaner movement is in “after” mode
  • cleaning - The robot cleaner movement is in “cleaning” mode

Commands

setRobotCleanerMovement(mode)

Set the robot cleaner movement

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: Set the robot cleaner movement mode, to “homing”

Robot Cleaner Turbo Mode

Allows for the control of the robot cleaner turbo mode.

Definition

name: Robot Cleaner Turbo Mode
status: proposed
attributes:
  robotCleanerTurboMode:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - 'on'
            - 'off'
            - 'silence'
      required: ["value"]
    type: ENUM
    values:
      - 'on'
      - 'off'
      - 'silence'
    setter: setRobotCleanerTurboMode
commands:
  setRobotCleanerTurboMode:
    arguments:
    - name: mode
      schema:
        type: string
        enum:
          - 'on'
          - 'off'
          - 'silence'
      type: ENUM
      values:
        - 'on'
        - 'off'
        - 'silence'
public: true
id: robotCleanerTurboMode
ocfResourceType: x.com.st.robot.cleaner.turbo
version: 1

Attributes

robotCleanerTurboMode

Current status of the robot cleaner turbo mode

Type: ENUM Required: Yes

Possible values:

  • on - The robot cleaner turbo is in ‘on’ mode
  • off - The robot cleaner turbo is in ‘off’ mode
  • silence - The robot cleaner turbo is in ‘silence’ mode

Commands

setRobotCleanerTurboMode(mode)

Set the robot cleaner turbo mode

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: Set the robot cleaner movement mode to ‘on’, ‘off’ or ‘silence’ mode

Signal Strength

Gives the ability to read the signal strength of Devices that support it

Definition

# reviewed 2018-2-13
name: Signal Strength
status: live
attributes:
  lqi:
    schema:
      type: object
      properties:
        value:
          type: integer
          minimum: 0
          maximum: 255
      required:
        - value
    type: NUMBER
  rssi:
    schema:
      type: object
      properties:
        value:
          type: number
          minimum: -200
          maximum: 0
        unit:
          type: string
          enum:
            - dBm
          default: dBm
      required:
        - value
    type: NUMBER
commands: {
  }
public: true
id: signalStrength
ocfResourceType: x.com.st.signalstrength
version: 1

Attributes

lqi

A number representing the Link Quality Indication

Type: NUMBER Required: Yes

rssi

A number representing the Received Signal Strength Indication

Type: NUMBER Required: Yes

Commands

None.

Smoke Detector

A device that detects the presence or absence of smoke.

Definition

# reviewed 2018-01-09
name: Smoke Detector
status: live
attributes:
  smoke:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - clear
            - detected
            - tested
      required: ["value"]
    type: ENUM
    values:
      - clear
      - detected
      - tested
commands: {
  }
public: true
id: smokeDetector
ocfResourceType: x.com.st.smokedetector
version: 1

Attributes

smoke

The state of the smoke detection device

Type: ENUM Required: Yes

Possible values:

  • clear - No smoke detected
  • detected - Smoke detected
  • tested - Smoke detector test button was activated

Commands

None.

Sound Sensor

A Device that senses sound

Definition

# reviewed 2018-01-11
name: Sound Sensor
status: live
attributes:
  sound:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - detected
            - not detected
      required: ["value"]
    type: ENUM
    values:
      - detected
      - not detected
commands: {
  }
public: true
id: soundSensor
ocfResourceType: x.com.st.soundsensor
version: 1

Attributes

sound

Whether or not sound was detected by the Device

Type: ENUM Required: Yes

Possible values:

  • detected - Sound is detected
  • not detected -

Commands

None.

Switch Level

Allows for the control of the level attribute of a light

Definition

# reviewed 2018-01-09 pending decision on rate
name: Switch Level
status: live
attributes:
  level:
    schema:
      $ref: IntegerPercent
    type: NUMBER
    setter: setLevel
commands:
  setLevel:
    arguments:
    - name: level
      schema:
        type: integer
        minimum: 0
        maximum: 100
      type: NUMBER
    - name: rate
      schema:
        $ref: PositiveInteger
      type: NUMBER
      required: false
public: true
id: switchLevel
ocfResourceType: oic.r.light.dimming
version: 1

Attributes

level

A number that represents the current light level, usually 0-100 in percent

Type: NUMBER Required: Yes

Commands

setLevel(level, rate)

Set the level to the given values

Arguments:

  • level
    • Type: NUMBER
    • Required: Yes
    • Description: The level value, usually 0-100 in percent
  • rate
    • Type: NUMBER
    • Required: No
    • Description: The rate at which to dim or illuminate the light

Switch

Allows for the control of a switch device

Definition

# reviewed 2018-01-09
name: Switch
status: live
attributes:
  switch:
    schema:
      type: object
      properties:
        value:
          $ref: SwitchState
      required: ["value"]
    type: ENUM
    values:
      - 'off'
      - 'on'
    enumCommands:
      - command: 'on'
        value: 'on'
      - command: 'off'
        value: 'off'
commands:
  'off':
    arguments: [
      ]
  'on':
    arguments: [
      ]
public: true
id: switch
ocfResourceType: x.com.st.powerswitch
version: 1

Attributes

switch

A string representation of whether the switch is on or off

Type: ENUM Required: Yes

Possible values:

  • off - The value of the switch attribute if the switch is off
  • on - The value of the switch attribute if the switch is on

Commands

off()

Turn a switch off

on()

Turn a switch on

Temperature Measurement

Get the temperature from a Device that reports current temperature

Definition

# reviewed 2018-01-30
name: Temperature Measurement
status: live
attributes:
  temperature:
    schema:
      type: object
      properties:
        value:
          $ref: TemperatureValue
        unit:
          $ref: TemperatureUnit
      required: ["value", "unit"]
    type: NUMBER
commands: {
  }
public: true
id: temperatureMeasurement
ocfResourceType: x.com.st.temperature.measured
version: 1

Attributes

temperature

A number that usually represents the current temperature

Type: NUMBER Required: Yes

Commands

None.

Thermostat Cooling Setpoint

Allows for setting the cooling setpoint on a thermostat

Definition

# reviewed 2018-01-30
name: Thermostat Cooling Setpoint
status: live
attributes:
  coolingSetpoint:
    schema:
      $ref: Temperature
    type: NUMBER
    setter: setCoolingSetpoint
commands:
  setCoolingSetpoint:
    arguments:
    - name: setpoint
      schema:
        $ref: TemperatureValue
      type: NUMBER
public: true
id: thermostatCoolingSetpoint
ocfResourceType: x.com.st.temperature.cooling
version: 1

Attributes

coolingSetpoint

The current cooling setpoint

Type: NUMBER Required: Yes

Commands

setCoolingSetpoint(setpoint)

Set the cooling setpoint

Arguments:

  • setpoint
    • Type: NUMBER
    • Required: Yes
    • Description: A value that the cooling setpoint should be set to

Thermostat Fan Mode

Definition

# reviewed 2018-01-30
name: Thermostat Fan Mode
status: live
attributes:
  thermostatFanMode:
    schema:
      type: object
      properties:
        value:
          $ref: ThermostatFanMode
      required:
        - value
    type: ENUM
    values:
      - auto
      - circulate
      - followschedule
      - 'on'
    setter: setThermostatFanMode
    enumCommands:
      - command: fanAuto
        value: auto
      - command: fanCirculate
        value: circulate
      - command: fanOn
        value: 'on'
  supportedThermostatFanModes:
    schema:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: ThermostatFanMode

    type: JSON_OBJECT
commands:
  fanAuto:
    arguments: [
      ]
  fanCirculate:
    arguments: [
      ]
  fanOn:
    arguments: [
      ]
  setThermostatFanMode:
    arguments:
    - name: mode
      schema:
        $ref: ThermostatFanMode
      type: ENUM
      values:
        - auto
        - circulate
        - followschedule
        - 'on'
public: true
id: thermostatFanMode
ocfResourceType: x.com.st.mode.fan.thermostat
version: 1

Attributes

thermostatFanMode

The current mode of the fan on a thermostat

Type: ENUM Required: Yes

Possible values:

  • auto - The fan is on auto
  • circulate - The fan is circulating
  • followschedule - The fan is set to follow predefined schedule
  • on - The fan is on

supportedThermostatFanModes

Modes supported by the thermostat

Type: JSON_OBJECT Required: Yes

Commands

fanAuto()

Set the fan mode to auto

fanCirculate()

Set the fan mode to circulate

fanOn()

Set the fan mode to on

setThermostatFanMode(mode)

Set the thermostat fan mode

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: The mode may be one of the following values:

Thermostat Heating Setpoint

Allows for setting the heating setpoint on a thermostat

Definition

# reviewed 2018-01-30
name: Thermostat Heating Setpoint
status: live
attributes:
  heatingSetpoint:
    schema:
      $ref: Temperature
    type: NUMBER
    setter: setHeatingSetpoint
commands:
  setHeatingSetpoint:
    arguments:
    - name: setpoint
      schema:
        $ref: TemperatureValue
      type: NUMBER
public: true
id: thermostatHeatingSetpoint
ocfResourceType: x.com.st.temperature.heating
version: 1

Attributes

heatingSetpoint

The current heating setpoint

Type: NUMBER Required: Yes

Commands

setHeatingSetpoint(setpoint)

Set the heating setpoint

Arguments:

  • setpoint
    • Type: NUMBER
    • Required: Yes
    • Description: A value that the heating setpoint should be set to

Thermostat Mode

Definition

# reviewed 2018-01-30
name: Thermostat Mode
status: live
attributes:
  thermostatMode:
    schema:
      type: object
      properties:
        value:
          $ref: ThermostatMode
      required:
        - value
    type: ENUM
    values:
      - auto
      - eco
      - rush hour
      - cool
      - emergency heat
      - heat
      - 'off'
    setter: setThermostatMode
    enumCommands:
      - command: auto
        value: auto
      - command: cool
        value: cool
      - command: emergencyHeat
        value: emergency heat
      - command: heat
        value: heat
      - command: 'off'
        value: 'off'
  supportedThermostatModes:
    schema:
      type: object
      properties:
        value:
          type: array
          items:
            $ref: ThermostatMode
    type: JSON_OBJECT
commands:
  auto:
    arguments: [
      ]
  cool:
    arguments: [
      ]
  emergencyHeat:
    arguments: [
      ]
  heat:
    arguments: [
      ]
  'off':
    arguments: [
      ]
  setThermostatMode:
    arguments:
    - name: mode
      schema:
        $ref: ThermostatMode
      type: ENUM
      values:
        - auto
        - eco
        - rush hour
        - cool
        - emergency heat
        - heat
        - 'off'
public: true
id: thermostatMode
ocfResourceType: x.com.st.mode.thermostat
version: 1

Attributes

thermostatMode

The current mode of a thermostat

Type: ENUM Required: Yes

Possible values:

  • auto - The automatic mode of the thermostat
  • eco - The eco mode of the thermostat
  • rush hour -
  • cool - The cool mode of the thermostat
  • emergency heat -
  • heat - The heat mode of the thermostat
  • off - Off mode for the thermostat

supportedThermostatModes

Modes supported by the thermostat

Type: JSON_OBJECT Required: Yes

Commands

auto()

Set the mode to auto

cool()

Set the mode to cool

emergencyHeat()

Set the mode to emergency heat

heat()

Set the mode to heat

off()

Set the mode to off

setThermostatMode(mode)

Set the thermostat mode

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: heat.value=Put the thermostat in emergency heat mode

Thermostat Operating State

Gives the ability to see the current state that the thermostat is operating in

Definition

# reviewed 2018-01-30
name: Thermostat Operating State
status: live
attributes:
  thermostatOperatingState:
    schema:
      type: object
      properties:
        value:
          $ref: ThermostatOperatingState
      required:
        - value
    type: ENUM
    values:
      - cooling
      - fan only
      - heating
      - idle
      - pending cool
      - pending heat
      - vent economizer
commands: {
  }
public: true
id: thermostatOperatingState
ocfResourceType: x.com.st.operationalstate.thermostat
version: 1

Attributes

thermostatOperatingState

The current state that the thermostat is operating in

Type: ENUM Required: Yes

Possible values:

  • cooling - The thermostat is cooling
  • fan only -
  • heating - The thermostat is heating
  • idle - The thermostat is idle
  • pending cool -
  • pending heat -
  • vent economizer -

Commands

None.

Thermostat Setpoint

Gives the ability to read the current setpoint on a thermostat

Definition

# reviewed 2018-01-30
name: Thermostat Setpoint
status: deprecated
attributes:
  thermostatSetpoint:
    schema:
      $ref: Temperature
    type: NUMBER
commands: {
  }
public: true
id: thermostatSetpoint
ocfResourceType: x.com.st.temperature.setpoint
version: 1

Attributes

thermostatSetpoint

The current setpoint value

Type: NUMBER Required: Yes

Commands

None.

Tone

Allows for the control of a device that can make an audible tone

Definition

# reviewed 2018-02-15
name: Tone
status: live
attributes: {
  }
commands:
  beep:
    arguments: [
      ]
public: true
id: tone
ocfResourceType: x.com.st.tone
version: 1

Attributes

None

Commands

beep()

Beep the device

Valve

Allows for the control of a valve device

Definition

# reviewed 2018-02-15
name: Valve
status: live
attributes:
  valve:
    schema:
      type: object
      properties:
        value:
          type: string
          enum:
            - closed
            - open
      required: ["value"]
    type: ENUM
    values:
      - closed
      - open
    enumCommands:
      - command: close
        value: closed
      - command: open
        value: open
commands:
  close:
    arguments: [
      ]
  open:
    arguments: [
      ]
public: true
id: valve
ocfResourceType: x.com.st.valve
version: 1

Attributes

valve

A string representation of whether the valve is open or closed

Type: ENUM Required: Yes

Possible values:

  • closed - The value of the valve attribute if the valve is closed
  • open - The value of the valve attribute if the valve is open

Commands

close()

Close the valve

open()

Open the valve

Washer Mode

Allows for the control of the washer mode.

Definition

name: Washer Mode
status: proposed
attributes:
  washerMode:
    schema:
      type: object
      properties:
        value:
          $ref: WasherMode
      required: ["value"]
    type: ENUM
    values:
      - regular
      - heavy
      - rinse
      - spinDry
    setter: setWasherMode
commands:
  setWasherMode:
    arguments:
    - name: mode
      schema:
        $ref: WasherMode
      type: ENUM
      values:
        - regular
        - heavy
        - rinse
        - spinDry
public: true
id: washerMode
ocfResourceType: x.com.st.mode.washer
version: 1

Attributes

washerMode

The current mode of the washer

Type: ENUM Required: Yes

Possible values:

  • regular - The washer is in “regular” mode
  • heavy - The washer is in “heavy” mode
  • rinse - The washer is in “rinse” mode
  • spinDry - The washer is in “spin dry” mode

Commands

setWasherMode(mode)

Set the washer mode

Arguments:

  • mode
    • Type: ENUM
    • Required: Yes
    • Description: The mode to which washer should be set, either “regular” or “heavy” or “rinse” or “spinDry”

Water Sensor

Get the status off of a water sensor device

Definition

# reviewed 2018-01-09
name: Water Sensor
status: live
attributes:
  water:
    schema:
      type: object
      properties:
        value:
          $ref: MoistureState
      required: ["value"]
    type: ENUM
    values:
      - dry
      - wet
commands: {
  }
public: true
id: waterSensor
ocfResourceType: oic.r.sensor.water
version: 1

Attributes

water

A string representation of whether the water sensor detected water

Type: ENUM Required: Yes

Possible values:

  • dry - Currently, water is undetected
  • wet - Water is detected

Commands

None.