Common Services¶
The following services are not specific to any particular device type and are common across all device types. However, support for these services may vary depending on the device. Learn more
Services |
Description |
|---|---|
| Appliance Air Quality Color Scheme Mode Service | Appliance air quality color scheme |
| Appliance Contractor Mode Toggle Service | Appliance contractor mode status. (Note: For Property Management Accounts Only) |
| Appliance Cost Comfort Integer Service | Service representing the cost comfort of appliance time of use |
| Appliance Enhanced Feature V1 Appl Service | Enhanced Feature V1 Service |
| Appliance Env Temperature Sensor Service | Service representing the functionality of the environmental temperature sensor |
| Appliance Fine Air Particles Sensor Service | Service representing the functionality of the fine air particles environmental sensor |
| Appliance Firmware V1 Service | Appliance update firmware |
| Appliance Humidity Sensor Service | Service representing the functionality of the relative humidity environmental sensor |
| Appliance Linux Firmware V1 Service | Appliance update linux |
| Appliance Override Toggle Service | Appliance override service |
| Appliance PM10 Sensor Service | Service representing the functionality of the PM10 environmental sensor |
| Appliance PM1 Sensor Service | Service representing the functionality of the PM1 environmental sensor |
| Appliance PM4 Sensor Service | Service representing the functionality of the PM4 environmental sensor |
| Appliance Pricingstructure Service | Appliance temperature units setting. |
| Appliance Relative Fine Air Particles Sensor Service | Service representing the functionality of the relative fine air particles environmental sensor |
| Appliance Relative PM10 Sensor Service | Service representing the functionality of the relative PM10 environmental sensor |
| Appliance Relative PM1 Sensor Service | Service representing the functionality of the relative PM1 environmental sensor |
| Appliance Relative PM4 Sensor Service | Service representing the functionality of the relative PM4 environmental sensor |
| Appliance Reset Wifi Trigger Service | Appliance reset wifi service (Note: For Property Management Accounts Only) |
| Appliance Resource Management kWh Service | Resource management implementation for measuring cumulative KWh of various appliances |
| Appliance Set Control Lock Toggle Service | Lock and unlock the control display for an Appliance |
| Appliance Set Model Number Service | Brillion Adapter set model number service (Note: For Property Management Accounts Only) |
| Appliance Temperature Units Mode Service | Appliance temperature units setting. |
| Appliance Timeof Use Set Season1 Service | Time of Use Season 1 Set Service |
| Appliance Timeof Use Set Season2 Service | Time of Use Season 2 Set Service |
| Appliance Timeof Use Set Season3 Service | Time of Use Season 3 Set Service |
| Appliance Timeof Use Set Season4 Service | Time of Use season 4 Set Service |
| Appliance Voc Sensor Service | Service representing the functionality of the VOC environmental sensor |
| Appliance Wi Fi Firmware V1 Service | Appliance update wifi |
| Appliance Wifi Signal Strength Integer Service | Wifi signal strength |
Appliance Air Quality Color Scheme Mode Service¶
Description: Appliance air quality color scheme
Tuple: The air quality color scheme for appliances with air quality sensors
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.mode | Service to model a mode that represents a selection from a pre-defined list of options. The available options are defined by an enumeration and then the service config selects which of those are available. |
| DomainType | cloud.smarthq.domain.airquality.colorscheme |
Air Quality Color Scheme |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.mode.set | Set the color scheme mode for air quality in the appliance |
Appliance Contractor Mode Toggle Service¶
Note: For Property Management Accounts Only
Description: Appliance contractor mode status.
Tuple: Controls contractor mode on an appliance
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.toggle | Service to model a binary state that can be read only or remotely controlled |
| DomainType | cloud.smarthq.domain.lock |
The lock |
| ServiceDeviceType | cloud.smarthq.device.wifi |
A Wi-Fi sub-device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Enable or disable contractor mode. |
Appliance Cost Comfort Integer Service¶
Description: Service representing the cost comfort of appliance time of use
Tuple: Cost comfort setting for water heater TOU
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.savings.strategy |
The saving strategy |
| ServiceDeviceType | cloud.smarthq.device.energy |
Energy |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.integer.set | Set Cost Comfort for Appliance |
Appliance Enhanced Feature V1 Appl Service¶
Description: Enhanced Feature V1 Service
Tuple: Enhanced Feature V1 Service
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.enhancedfeature.v1 | Service for controlling the digital enhanced features on an appliance.Features are presented as set of opaque ids. |
| DomainType | cloud.smarthq.domain.enhanced.feature |
Enhanced Digital Features |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.enhancedfeature.v1.sync | Enhanced Features Sync Command |
Appliance Env Temperature Sensor Service¶
Description: Service representing the functionality of the environmental temperature sensor
Tuple: Environmental Sensor Temperature information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.temperature.environmental |
Environment Air Quality Sensing Environmental Temperature Sensor |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed environmental temperature index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed environmental temperature index, while idle. |
Appliance Fine Air Particles Sensor Service¶
Description: Service representing the functionality of the fine air particles environmental sensor
Tuple: Environmental Sensor Particles Fine Air information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.particles.fine.air |
Environment Air Quality Sensing Fine Air Particles Sensor |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed fine air particles index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed fine air particles index, while idle. |
Appliance Firmware V1 Service¶
Description: Appliance update firmware
Tuple: The firmware on an appliance
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.firmware.v1 | Service to indicate pending firmware updates and allows accepting the update for it to be installed. |
| DomainType | cloud.smarthq.domain.firmware |
The firmware |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.firmware.v1.upgrade | Update a Firmware |
Appliance Humidity Sensor Service¶
Description: Service representing the functionality of the relative humidity environmental sensor
Tuple: Environmental Sensor Humidity information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.humidity |
Environment Air Quality Sensing Relative Humidity Sensor |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed relative humidity index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed relative humidity index, while idle. |
Appliance Linux Firmware V1 Service¶
Description: Appliance update linux
Tuple: The firmware on a linux system
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.firmware.v1 | Service to indicate pending firmware updates and allows accepting the update for it to be installed. |
| DomainType | cloud.smarthq.domain.firmware |
The firmware |
| ServiceDeviceType | cloud.smarthq.device.linux |
A linux device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.firmware.v1.upgrade | Update a Linux |
Appliance Override Toggle Service¶
Description: Appliance override service
Tuple: Energy override
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.toggle | Service to model a binary state that can be read only or remotely controlled |
| DomainType | cloud.smarthq.domain.override |
The override |
| ServiceDeviceType | cloud.smarthq.device.energy |
Energy |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Override an appliance |
Appliance PM10 Sensor Service¶
Description: Service representing the functionality of the PM10 environmental sensor
Tuple: Environmental Sensor Particles 10UM information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.particles.10um |
Environment Air Quality Sensing 10 UM Particle Sensor |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed PM10 index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed PM10 index, while idle. |
Appliance PM1 Sensor Service¶
Description: Service representing the functionality of the PM1 environmental sensor
Tuple: Environmental Sensor Particles 1UM information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.particles.1um |
Environment Air Quality Sensing 1 UM Particle Sensor |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed PM1 index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed PM1 index, while idle. |
Appliance PM4 Sensor Service¶
Description: Service representing the functionality of the PM4 environmental sensor
Tuple: Environmental Sensor Particles 4UM information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.particles.4um |
Environment Air Quality Sensing 4 UM Particle Sensor |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed PM4 index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed PM4 index, while idle. |
Appliance Pricingstructure Service¶
Description: Appliance temperature units setting.
Tuple: appliance pricing structure
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.pricingstructure | Service for pricing structure. |
| DomainType | cloud.smarthq.domain.pricingstructure.electrical |
Electrical Pricing Structure |
| ServiceDeviceType | cloud.smarthq.device.energy |
Energy |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.pricingstructure.set | Set the appliance pricing structure. |
Appliance Relative Fine Air Particles Sensor Service¶
Description: Service representing the functionality of the relative fine air particles environmental sensor
Tuple: Environmental Sensor Particles Fine Air Index information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.particles.fine.air.index |
Environment Air Quality Sensing Fine Air Particles Sensor Index |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed relative fine air particles index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed relative fine air particles index, while idle. |
Appliance Relative PM10 Sensor Service¶
Description: Service representing the functionality of the relative PM10 environmental sensor
Tuple: Environmental Sensor Particles 10UM Index information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.particles.10um.index |
Environment Air Quality Sensing 10 UM Particle Sensor Index |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed relative PM10 index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed relative PM10 index, while idle. |
Appliance Relative PM1 Sensor Service¶
Description: Service representing the functionality of the relative PM1 environmental sensor
Tuple: Environmental Sensor Particles 1UM Index information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.particles.1um.index |
Environment Air Quality Sensing 1 UM Particle Sensor Index |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed relative PM1 index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed relative PM1 index, while idle. |
Appliance Relative PM4 Sensor Service¶
Description: Service representing the functionality of the relative PM4 environmental sensor
Tuple: Environmental Sensor Particles 4UM Index information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.particles.4um.index |
Environment Air Quality Sensing 4 UM Particle Sensor Index |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed relative PM4 index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed relative PM4 index, while idle. |
Appliance Reset Wifi Trigger Service¶
Note: For Property Management Accounts Only
Description: Appliance reset wifi service
Tuple: Command to restart a wifi module
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.trigger | Service to trigger an action on a device. As opposed to the toggle service that has a binary state, the trigger service has no state and can only trigger a do command. |
| DomainType | cloud.smarthq.domain.reset |
The reset |
| ServiceDeviceType | cloud.smarthq.device.wifi |
A Wi-Fi sub-device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.trigger.do | Reset the wifi module of an appliance |
Appliance Resource Management kWh Service¶
Description: Resource management implementation for measuring cumulative KWh of various appliances
Tuple: energy meter
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.meter | Service that represents the state of a meter within an appliance. |
| DomainType | cloud.smarthq.domain.energy |
The energy |
| ServiceDeviceType | cloud.smarthq.device.meter |
A meter device |
Appliance Set Control Lock Toggle Service¶
Description: Lock and unlock the control display for an Appliance
Tuple: Locks the UI for an appliance preventing the controls from being used on the device
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.toggle | Service to model a binary state that can be read only or remotely controlled |
| DomainType | cloud.smarthq.domain.controls.lock |
The controls lock |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Command to turn on/off UI control lock |
Appliance Set Model Number Service¶
Note: For Property Management Accounts Only
Description: Brillion Adapter set model number service
Tuple: String Model Appliance
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.string | Service to model a string that represents a value from the device. |
| DomainType | cloud.smarthq.domain.model |
The model |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.string.set | Brillion Adapter Command to set model number |
Appliance Temperature Units Mode Service¶
Description: Appliance temperature units setting.
Tuple: The temperature units the water heater uses
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.mode | Service to model a mode that represents a selection from a pre-defined list of options. The available options are defined by an enumeration and then the service config selects which of those are available. |
| DomainType | cloud.smarthq.domain.temperatureunits |
The temperature units |
| ServiceDeviceType | cloud.smarthq.device.waterheater |
A water heater device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.mode.set | Set the appliance temperature units to fahrenheit or celsius. |
Appliance Timeof Use Set Season1 Service¶
Description: Time of Use Season 1 Set Service
Tuple: appliance time of use season 1
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.timeofuse.v1 | Service for appliance Time of use. This service is used for the representation of time of use of an appliance. |
| DomainType | cloud.smarthq.domain.season.1 |
Time of use season 1 |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.timeofuse.v1.clear | Time of use Clear command |
| cloud.smarthq.command.timeofuse.v1.set | Set Time of Use command |
Appliance Timeof Use Set Season2 Service¶
Description: Time of Use Season 2 Set Service
Tuple: appliance time of use season 2
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.timeofuse.v1 | Service for appliance Time of use. This service is used for the representation of time of use of an appliance. |
| DomainType | cloud.smarthq.domain.season.2 |
Time of use season 2 |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.timeofuse.v1.clear | Time of use Clear command |
| cloud.smarthq.command.timeofuse.v1.set | Set Time of Use command |
Appliance Timeof Use Set Season3 Service¶
Description: Time of Use Season 3 Set Service
Tuple: appliance time of use season 3
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.timeofuse.v1 | Service for appliance Time of use. This service is used for the representation of time of use of an appliance. |
| DomainType | cloud.smarthq.domain.season.3 |
Time of use season 3 |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.timeofuse.v1.clear | Time of use Clear command |
| cloud.smarthq.command.timeofuse.v1.set | Set Time of Use command |
Appliance Timeof Use Set Season4 Service¶
Description: Time of Use season 4 Set Service
Tuple: appliance time of use season 4
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.timeofuse.v1 | Service for appliance Time of use. This service is used for the representation of time of use of an appliance. |
| DomainType | cloud.smarthq.domain.season.4 |
Time of use season 4 |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.timeofuse.v1.clear | Time of use Clear command |
| cloud.smarthq.command.timeofuse.v1.set | Set Time of Use command |
Appliance Voc Sensor Service¶
Description: Service representing the functionality of the VOC environmental sensor
Tuple: Environmental Sensor VOC information
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.environmental.sensor | Service that represents the functionality of the environmental sensors |
| DomainType | cloud.smarthq.domain.sensor.voc |
Environment Air Quality Sensing VOC Sensor |
| ServiceDeviceType | cloud.smarthq.device.appliance |
An appliance |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.environmental.sensor.index.set | Request for the update of the sensed VOC index. |
| cloud.smarthq.command.environmental.sensor.updateperiod.set | Sets the update period of the sensed VOC index, while idle. |
Appliance Wi Fi Firmware V1 Service¶
Description: Appliance update wifi
Tuple: The firmware on a wifi module
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.firmware.v1 | Service to indicate pending firmware updates and allows accepting the update for it to be installed. |
| DomainType | cloud.smarthq.domain.firmware |
The firmware |
| ServiceDeviceType | cloud.smarthq.device.wifi |
A Wi-Fi sub-device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.firmware.v1.upgrade | Update a WiFi |
Appliance Wifi Signal Strength Integer Service¶
Description: Wifi signal strength
Tuple: Wifi Signal strength
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.rssi |
The rssi |
| ServiceDeviceType | cloud.smarthq.device.wifi |
A Wi-Fi sub-device |