Washer Device¶
Tip: Use this navigation sections and page links to navigate easier.
Description¶
Clothes Washer appliance.
| Label | Value |
|---|---|
| Device Type | cloud.smarthq.device.washer |
| Connection Type | cloud.smarthq.connection.wifi |
| Icon Type | cloud.smarthq.icon.washer |
Alerts¶
AlertType |
Description |
|---|---|
cloud.smarthq.alert.endofcycle |
Cycle complete - your laundry is ready! |
cloud.smarthq.alert.washeroutofbalance |
The washer was unable to fully spin due to an unbalanced load. Please evenly redistribute the laundry and press START to resume the cycle within 5 minutes or your laundry session will time out. |
cloud.smarthq.alert.startofcycle |
Notifies you when cycle starts while using delay feature. |
cloud.smarthq.alert.laundrysession.paused |
Your laundry cycle has been paused. Press START to resume the cycle within 5 minutes or your laundry session will time out. |
cloud.smarthq.alert.laundrysession.cancelled |
Your laundry cycle has been canceled. Scan the QR code to begin a new laundry session. |
cloud.smarthq.alert.laundrysession.cyclerequested |
Your laundry cycle has been requested. |
cloud.smarthq.alert.laundrysession.timedout |
Your laundry session has timed out. Please scan the QR code to begin a new cycle. |
cloud.smarthq.alert.endofcycle.minutesafter.30 |
Damp Laundry has remained in WASHER for 30 minutes. |
cloud.smarthq.alert.endofcycle.minutesleft.10 |
10 minutes left end of cycle alert. |
cloud.smarthq.alert.endofcycle.minutesleft.15 |
15 minutes left end of cycle alert. |
cloud.smarthq.alert.endofcycle.minutesleft.5 |
5 minutes left end of cycle alert. |
cloud.smarthq.alert.endofcycle |
WASHER cycle completed - Laundry Ready. |
cloud.smarthq.alert.washeroutofbalance |
The washer was unable to fully spin due to an unbalanced load. Please evenly redistribute the laundry and press START to resume the cycle within 5 minutes or your laundry session will time out. |
cloud.smarthq.alert.selfclean |
Cycle ended. SELF CLEAN cycle is suggested every 40 cycles to deep clean your washer. |
cloud.smarthq.alert.tank.detergent.empty |
Your SmartDispense™ tank is EMPTY. Please refill. |
cloud.smarthq.alert.tank.detergent.low |
Your SmartDispense™ tank is LOW. Please refill. |
| Common Alerts List | A list of alerts common across all SmartHQ devices that this device might support. |
Service Alerts¶
AlertType |
Description |
|---|---|
cloud.smarthq.alert.coinbox.capacity.50 |
The coinbox capacity reaches 50 percent. |
cloud.smarthq.alert.coinbox.capacity.75 |
The coinbox capacity reaches 75 percent. |
cloud.smarthq.alert.coinbox.capacity.90 |
The coinbox capacity reaches 90 percent. |
cloud.smarthq.alert.coinbox.capacity.100 |
The coinbox is full |
cloud.smarthq.alert.coinbox.capacity.reset |
The coinbox is empty. |
cloud.smarthq.alert.fault.doorlock |
When control tries to lock/unlock door, this is no door unlock/lock signal. |
cloud.smarthq.alert.fault.doorlock.waterabove |
The washing machine water is above the doorlock |
cloud.smarthq.alert.fault.doorunlock |
When control tries to lock/unlock door, this is no door unlock/lock signal. |
cloud.smarthq.alert.fault.drainpump |
When adaptive drain cycle step timeout occurs, drain pump clearing algorithm begins. After drain pump clearing algorithm finishes. The fault is set if tub is not empty. This is actually an “event” rather than a traditional “fault”. We merely increment a counter that indicates how many times this issue has occurred. |
cloud.smarthq.alert.fault.draintimeout |
In Drain Step, after 6 minutes still not reach empty level. |
cloud.smarthq.alert.fault.lidlock.lock |
This fault is set when the software has tried multiple times to Lock the lid without success. Here are the specifics: Try to lock 4 times with a 1.5 second delay between each try. After first 4 tries, delay for 30 seconds (cool down) Try to lock 4 more times with a 1.5 second delay between each try. If still not successful, set fault. |
cloud.smarthq.alert.fault.lidlock.unlock |
This fault is set when the software has tried multiple times to unlock the lid without success. Here are the specifics: Try to unlock 4 times with a 1.5 second delay between each try. After first 4 tries, delay for 30 seconds (cool down). Try to unlock 4 more times with a 1.5 second delay between each try. If still not successful, set fault. |
cloud.smarthq.alert.fault.lidlogic |
This fault is set if the system perceives the lid to be both OPEN and LOCKED for 5 consecutive seconds. |
cloud.smarthq.alert.fault.lidswitch |
3 cycles have been completed without any lid opening. |
cloud.smarthq.alert.linesreversed |
The washing machine hot and cold water lines are reversed. |
cloud.smarthq.alert.fault.modeshift |
If the mode shifter fails to complete a shift, it will retry two more times. If it still doesn’t complete a shift, it will set this fault. |
cloud.smarthq.alert.fault.pressure.sensor.loss |
Alert when a pressure sensor fault is detected on a device. |
cloud.smarthq.alert.fault.keystuck |
If button is depressed for 1 minute, it will be logged as a stuck button. |
cloud.smarthq.alert.fault.sudslock |
The washing machine has a suds lock error |
Services¶
This device may not support each service listed. What is listed is all the possible services for this device. Learn more
Services |
Description |
|---|---|
| Commercial Laundry Coin Count Integer Service | The number of coins collected since the last time the coinbox was opened |
| Commercial Laundry Coinbox Pricemenu V1 Service | Commercial Laundry Coinbox Price Menu service |
| Commercial Laundry V1 Service | Commercial Laundry Device Service |
| Laundry Control Lock Toggle Service | Service representing the control lock on a laundry device. |
| Laundry State V1 Service | Service to represent the overall state of a laundry machine. |
| Washer Cycle Timer V2 Service | Washer cycle time remaining. |
| Washer Door Closed Toggle Service | Washer door status. |
| Washer R J45 Toggle Service | Washer RJ45 Mode. (Note: For Property Management Accounts Only) |
| Washer Start Cycle Trigger Service | Washer start cycle service. |
| Washer Stop Cycle Trigger Service | Washer stop cycle service. |
| Common Services List | A list of services common across all SmartHQ devices that this device might support. |
Commercial Laundry Coin Count Integer Service¶
Description: The number of coins collected since the last time the coinbox was opened
Tuple: The number of coins collected since the last time the coinbox was opened
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.integer | Service to model a signed 32-bit integer value with associated units. |
| DomainType | cloud.smarthq.domain.coinbox |
Coinbox |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.integer.set | Laundry Reset Coinbox Count |
Commercial Laundry Coinbox Pricemenu V1 Service¶
Description: Commercial Laundry Coinbox Price Menu service
Tuple: The commercial laundry coinbox price menu service for a washing machine
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.laundry.pricemenu.v1 | Service for a commercial washer or dryer coinbox price menu. This service represents the current state of a commercial laundry device coinbox price menu. |
| DomainType | cloud.smarthq.domain.coinbox |
Coinbox |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.laundry.pricemenu.v1.set | Sets the commercial laundry coinbox price menu |
Commercial Laundry V1 Service¶
Description: Commercial Laundry Device Service
Tuple: The commercial laundry service for a washing machine
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.laundry.commercial.v1 | Service for a commercial washer or dryer. This service represents the current state of a commercial laundry device. |
| DomainType | cloud.smarthq.domain.laundry.commercial |
Commercial laundry |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.laundry.commercial.v1.authorize | Sets the commercial laundry phase to authorized |
| cloud.smarthq.command.laundry.commercial.v1.clear | Sets the commercial laundry phase to idle |
| cloud.smarthq.command.laundry.commercial.v1.deny | Sets the commercial laundry phase to denied |
| cloud.smarthq.command.laundry.commercial.v1.fault | Sets the commercial laundry phase to fault |
| cloud.smarthq.command.laundry.commercial.v1.reserve | Sets the commercial laundry phase to reserved |
Laundry Control Lock Toggle Service¶
Description: Service representing the control lock on a laundry device.
Tuple: Service representing the control lock on a washer
| 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.uilock |
The UI lock |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Command to turn on/off laundry UI lock |
Laundry State V1 Service¶
Description: Service to represent the overall state of a laundry machine.
Tuple: The overall state of laundry options for a washer
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.laundry.state.v1 | Service to model the laundry state is used in conjunction with the laundry mode service. This service represents the top level state of a laundry device such as a washer or dryer. |
| DomainType | cloud.smarthq.domain.laundry |
The laundry |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Washer Cycle Timer V2 Service¶
Description: Washer cycle time remaining.
Tuple: Washer cycle time remaining
| Attribute | Value | Description |
|---|---|---|
| ServiceType | cloud.smarthq.service.cycletimer | Service to model a cycle timer that indicate the amount of time remaining. |
| DomainType | cloud.smarthq.domain.cycle |
The cycle |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Washer Door Closed Toggle Service¶
Description: Washer door status.
Tuple: Washer door 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.door |
The door |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Washer R J45 Toggle Service¶
Note: For Property Management Accounts Only
Description: Washer RJ45 Mode.
Tuple: Enable the GEA port (rj45) on an appliance for appliances with service ports that are disabled by default
| 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.external |
The external |
| ServiceDeviceType | cloud.smarthq.device.serial.gea |
The serial GEA port sub-device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.toggle.set | Toggle RJ45 on the washer |
Washer Start Cycle Trigger Service¶
Description: Washer start cycle service.
Tuple: Start an armed cycle on a washing machine
| 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.start |
The start |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.trigger.do | Start the washing machine cycle. |
Washer Stop Cycle Trigger Service¶
Description: Washer stop cycle service.
Tuple: Stop a running washing machine
| 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.stop |
The stop |
| ServiceDeviceType | cloud.smarthq.device.washer |
A clothes washing machine device |
Commands¶
| Command | Description |
|---|---|
| cloud.smarthq.command.trigger.do | Stop the washing machine cycle. |