Water Softener Device¶
Tip: Use this navigation sections and page links to navigate easier.
Description¶
Water Softener appliance.
| Label | Value |
|---|---|
| Device Type | cloud.smarthq.device.watersoftener |
| Connection Type | cloud.smarthq.connection.wifi |
| Icon Type | cloud.smarthq.icon.watersoftener |
Alerts¶
AlertType |
Description | Interval |
|---|---|---|
cloud.smarthq.alert.fault.boardmalfunction |
Main control board malfunction. | |
cloud.smarthq.alert.fault.communication |
UI and Power board communication error. | |
cloud.smarthq.alert.fault.motorshutoff |
Switch or motor malfunction. | |
cloud.smarthq.alert.fault.saltlevelerror |
Salt Level Sensor error | |
cloud.smarthq.alert.saltlow |
The water softener salt level is low. | |
cloud.smarthq.alert.fault.serviceposition |
Switch or motor malfunction. | |
cloud.smarthq.alert.fault.switchtimeout |
Switch or motor malfunction. | |
cloud.smarthq.alert.fault.valvelow |
Shutoff Valve closed and open switches both low. | |
cloud.smarthq.alert.fault.valveopen |
Water valve not closing. | |
cloud.smarthq.alert.fault.valveclosed |
Water valve not opening. | |
| 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 |
|---|---|
| Water Softener Filter Flow Rate Double Service | Water flow rate of a water softener |
| Water Softener Auto Water Valve Shut Off Toggle Service | Appliance Auto Water Valve Shut Off service |
| Water Softener Continuous Flow Alert Mode Service | Continuous Flow Alert Status |
| Water Softener Continuous Water Flow High Integer Service | Continuous water flow high limit in minutes for a home water softener. |
| Water Softener Continuous Water Flow Low Integer Service | Continuous water flow low limit in minutes for a home water softener. |
| Water Softener Continuous Water Flow Medium Integer Service | Continuous water flow medium limit in minutes for a home water softener. |
| Water Softener Daily Water Usage Integer Service | Water filter daily usage in gallons for a water softener |
| Water Softener Days Of Salt Remaining Integer Service | Days of salt remaining for a water softener |
| Water Softener Error Mode Service | Water softener error mode. |
| Water Softener Manual Override Toggle Service | Manual override for water softener |
| Water Softener Mode Service | Water softener mode. |
| Water Softener Salt Low Toggle Service | Water softener low salt toggle service |
| Water Softener Vacation Mode Toggle Set Service | Vacation Mode for water softener |
| Common Services List | A list of services common across all SmartHQ devices that this device might support. |
Water Softener Filter Flow Rate Double Service¶
Description: Water flow rate of a water softener
Tuple: The water flow rate for Water Softener devices
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.double | Service to model a 64-bit double value with associated units. |
| DomainType | cloud.smarthq.domain.flowrate |
The flow rate |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Water Softener Auto Water Valve Shut Off Toggle Service¶
Description: Appliance Auto Water Valve Shut Off service
Tuple: Toggles Auto Water Valve Shut Off of a water softener 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.auto.shutoff |
Automatically Shut Off |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Toggles the auto water valve shut off |
Water Softener Continuous Flow Alert Mode Service¶
Description: Continuous Flow Alert Status
Tuple: Water softener mode for continuous flow alert
| 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.alert.continuousflow |
Continuous flow alert |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Water Softener Continuous Water Flow High Integer Service¶
Description: Continuous water flow high limit in minutes for a home water softener.
Tuple: Water softener continuous flow high
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.continuouswaterflow.high |
The continuous water flow high |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.integer.set | Command to set the continuous flow limit |
Water Softener Continuous Water Flow Low Integer Service¶
Description: Continuous water flow low limit in minutes for a home water softener.
Tuple: Water softener continuous flow low
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.continuouswaterflow.low |
The continuous water flow low |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.integer.set | Command to set the continuous flow limit |
Water Softener Continuous Water Flow Medium Integer Service¶
Description: Continuous water flow medium limit in minutes for a home water softener.
Tuple: Water softener continuous flow medium
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.continuouswaterflow.medium |
The continuous water flow medium |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.integer.set | Command to set the continuous flow limit |
Water Softener Daily Water Usage Integer Service¶
Description: Water filter daily usage in gallons for a water softener
Tuple: Water softener daily usage
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.water.daily |
Water filter daily usage |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Water Softener Days Of Salt Remaining Integer Service¶
Description: Days of salt remaining for a water softener
Tuple: The salt remaining for Water Softener devices
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.salt.remaining |
Salt remaining |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Water Softener Error Mode Service¶
Description: Water softener error mode.
Tuple: Water softener error mode
| 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.error |
Appliance error state |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Water Softener Manual Override Toggle Service¶
Description: Manual override for water softener
Tuple: The manual override status of a water softener
| 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.manualoverride |
The manual override status |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Toggle the Manual Override of the home water filter. |
Water Softener Mode Service¶
Description: Water softener mode.
Tuple: The state of a dedicated water softener device
| 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.state |
The state |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.mode.set | Set the water softener mode. |
Water Softener Salt Low Toggle Service¶
Description: Water softener low salt toggle service
Tuple: Toggle for the salt low in the water softener.
| 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.salt.low |
Salt low |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Water Softener Vacation Mode Toggle Set Service¶
Description: Vacation Mode for water softener
Tuple: Toggle for vacation mode in the water softener
| 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.vacation.mode |
The vacation mode |
| ServiceDeviceType | cloud.smarthq.device.watersoftener |
A water softener device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Toggles the vacation mode. |