Coffee Brewer Device¶
Tip: Use this navigation sections and page links to navigate easier.
Description¶
Coffee Brewer appliance.
| Label | Value |
|---|---|
| Device Type | cloud.smarthq.device.coffeebrewer |
| Connection Type | cloud.smarthq.connection.wifi |
| Icon Type | cloud.smarthq.icon.coffeebrewer |
Alerts¶
AlertType |
Description | Interval |
|---|---|---|
cloud.smarthq.alert.beanhopper.refill |
Please add more coffee beans. | |
cloud.smarthq.alert.brewbasket.align |
Please check to ensure the brew basket is properly locked and closed. | |
cloud.smarthq.alert.brewbasket.clean |
Please check to ensure the brew basket has been properly cleaned since last use. | |
cloud.smarthq.alert.burrgrinder.align |
Please check to ensure the burr grinder is properly locked and closed. | |
cloud.smarthq.alert.carafe.missing |
Please check to ensure the carafe is properly in-place. | |
cloud.smarthq.alert.descale |
Descale is needed for the Drip Coffee Brewer | |
cloud.smarthq.alert.endofcycle |
Your coffee is done. | |
cloud.smarthq.alert.filter.replace |
Drip Coffee Brewer Water Filter replace alert | |
cloud.smarthq.alert.startofcycle |
Your coffee has started brewing. | |
cloud.smarthq.alert.tank.water.empty |
Please add more water to your coffee maker | |
cloud.smarthq.alert.endofcycle |
Your coffee is done. | |
cloud.smarthq.alert.filter.replace.charcoal |
Grind and Brew Water Filter replace alert | |
cloud.smarthq.alert.startofcycle |
Your coffee has started brewing. | |
cloud.smarthq.alert.tank.water.empty |
Please add more water to your coffee maker | |
| Common Alerts List | A list of alerts common across all SmartHQ devices that this device might support. |
Services¶
This device may not support each service listed. What is listed is all the possible services for this device. Learn more
Services |
Description |
|---|---|
| Coffee Brewer Delay Start Service | Set the time for the delay start feature. |
| Coffee Brewer Grinder Toggle Service | Grinder mode service |
| Coffee Brewer Model Name String Service | Coffee Brewer Model Name |
| Coffee Brewer V1 Api Coffee Brewer V1 Service | Service to represent the overall state of a coffee brewer. |
| Coffee Brewer V1 Descale V1 Service | Descale Coffee Brewer service |
| Coffee Brewer V2 Api Coffee Brewer V2 Service | Service to represent the overall state of a coffee brewer. |
| Coffee Brewer V2 Descale V1 Service | Descale Coffee Brewer service |
| Coffee Brewer V2 Favorite1 Service | Service to represent the overall state of a coffee brewer favorite 1. |
| Coffee Brewer V2 Favorite2 Service | Service to represent the overall state of a coffee brewer favorite 2. |
| Coffee Brewer V2 Favorite3 Service | Service to represent the overall state of a coffee brewer favorite 3. |
| Coffee Brewer V2 Grind Hopper Present Service | Coffee Brewer Grind Hopper presence service |
| Coffee Brewer V2 Grinder Integer Service | Grinder settings service for Coffee Brewer V2 appliances. |
| Coffee Brewer Water Filter Service | Water filter service state. |
| Espresso Maker Standby Timeout Service | Brew Standby Timeout service |
| Opal Water Filter Reset Trigger Service | Reset the water filter. |
| Common Services List | A list of services common across all SmartHQ devices that this device might support. |
Coffee Brewer Delay Start Service¶
Description: Set the time for the delay start feature.
Tuple: Service to set the time of day delay start for a coffee brewer
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.timeofday.v1 | Service to set a time of the day. |
| DomainType | cloud.smarthq.domain.delay |
The delay |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.timeofday.v1.set | Set the time of day for the delay start of the coffee brewer. |
Coffee Brewer Grinder Toggle Service¶
Description: Grinder mode service
Tuple: coffee brewer toggle grinder.
| 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.grinder |
Grinder |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Set grinder on or off |
Coffee Brewer Model Name String Service¶
Description: Coffee Brewer Model Name
Tuple: String Coffee Brewer Model Name
| 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.coffeebrewer |
A coffee brewer device |
Coffee Brewer V1 Api Coffee Brewer V1 Service¶
Description: Service to represent the overall state of a coffee brewer.
Tuple: The coffee brewer service for a coffee brewer
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.coffeebrewer.v1 | Service for a coffee brewer. This service represents the current state of a coffee brewer device. |
| DomainType | cloud.smarthq.domain.coffeebrewer |
Coffee Brewer |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.coffeebrewer.v1.start | Command to start a brew for Appliance API v1 based coffee brewers. |
| cloud.smarthq.command.coffeebrewer.v1.stop | Command to stop a brew for Appliance API v1 based coffee brewers. |
Coffee Brewer V1 Descale V1 Service¶
Description: Descale Coffee Brewer service
Tuple: Descale service for drip coffee brewer device
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.descale.v1 | Service for the descale state for a espresso maker. |
| DomainType | cloud.smarthq.domain.coffeebrewer |
Coffee Brewer |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.descale.v1.cancel | Cancel the descale |
| cloud.smarthq.command.descale.v1.start | Start the descale |
Coffee Brewer V2 Api Coffee Brewer V2 Service¶
Description: Service to represent the overall state of a coffee brewer.
Tuple: The coffee brewer service for a coffee brewer v2 units
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.coffeebrewer.v2 | Service for a coffee brewer v2 units. This service represents the current state of a coffee brewer device. |
| DomainType | cloud.smarthq.domain.coffeebrewer |
Coffee Brewer |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.coffeebrewer.v2.start | Command to start a brew for Appliance API v2 based coffee brewers. |
| cloud.smarthq.command.coffeebrewer.v2.stop | Command to stop a brew for Appliance API v2 based coffee brewers. |
Coffee Brewer V2 Descale V1 Service¶
Description: Descale Coffee Brewer service
Tuple: Descale service for drip coffee brewer device
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.descale.v1 | Service for the descale state for a espresso maker. |
| DomainType | cloud.smarthq.domain.coffeebrewer |
Coffee Brewer |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Coffee Brewer V2 Favorite1 Service¶
Description: Service to represent the overall state of a coffee brewer favorite 1.
Tuple: The coffee brewer v2 service for favorite 1
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.coffeebrewer.v2 | Service for a coffee brewer v2 units. This service represents the current state of a coffee brewer device. |
| DomainType | cloud.smarthq.domain.favorite.1 |
The favorite 1 for appliance |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.coffeebrewer.v2.set | Coffee Brewer V2 Favorite Set Command |
Coffee Brewer V2 Favorite2 Service¶
Description: Service to represent the overall state of a coffee brewer favorite 2.
Tuple: The coffee brewer v2 service for favorite 2
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.coffeebrewer.v2 | Service for a coffee brewer v2 units. This service represents the current state of a coffee brewer device. |
| DomainType | cloud.smarthq.domain.favorite.2 |
The favorite 2 for appliance |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.coffeebrewer.v2.set | Coffee Brewer V2 Favorite Set Command |
Coffee Brewer V2 Favorite3 Service¶
Description: Service to represent the overall state of a coffee brewer favorite 3.
Tuple: The coffee brewer v2 service for favorite 3
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.coffeebrewer.v2 | Service for a coffee brewer v2 units. This service represents the current state of a coffee brewer device. |
| DomainType | cloud.smarthq.domain.favorite.3 |
The favorite 3 for appliance |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.coffeebrewer.v2.set | Coffee Brewer V2 Favorite Set Command |
Coffee Brewer V2 Grind Hopper Present Service¶
Description: Coffee Brewer Grind Hopper presence service
Tuple: The coffee brewer grind hopper presence status
| 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.present.grindhopper |
Grind hopper is present |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Coffee Brewer V2 Grinder Integer Service¶
Description: Grinder settings service for Coffee Brewer V2 appliances.
Tuple: The Grinder Setting Service for Coffee Brewer
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.grinder |
Grinder |
| ServiceDeviceType | cloud.smarthq.device.coffeebrewer |
A coffee brewer device |
Coffee Brewer Water Filter Service¶
Description: Water filter service state.
Tuple: The waterfilter details and state.
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.filter.v1 | Service for filter details and state. |
| DomainType | cloud.smarthq.domain.state |
The state |
| ServiceDeviceType | cloud.smarthq.device.waterfilter |
A water filter device |
Espresso Maker Standby Timeout Service¶
Description: Brew Standby Timeout service
Tuple: The standby timeout for the espresso maker
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.standby.timeout |
Standby Timeout |
| ServiceDeviceType | cloud.smarthq.device.espressomaker |
An espresso maker device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.integer.set | Command to set the espresso maker standby timeout |
Opal Water Filter Reset Trigger Service¶
Description: Reset the water filter.
Tuple: Command to reset the water filter
| 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.waterfilter |
A water filter device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.trigger.do | Reset the Opal filter. |