cloud.smarthq.service.laundry.washer.userprofile.state.v1¶
Description¶
Service for Washer Profile State V1
Example Device Response (Digital Twin API)¶
Service for Washer Profile State V1 with up to 14 cycle slots per profile.
{
"adapterId": "0000000000000000000000000000000000000000",
"alertTypes": [],
"createdDateTime": "2022-03-04T12:12:12.123Z",
"deviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"deviceType": "cloud.smarthq.device.washer",
"gatewayId": "0000000000000000000000000000000000000000000000000000000000000000",
"kind": "device#item",
"lastPresenceTime": "2022-03-04T12:12:12.123Z",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"presence": "OFFLINE",
"removable": true,
"services": [
{
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1",
"lastSyncTime": "2022-03-04T12:12:12.123Z",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"supportedCommands": [
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot0.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot1.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot2.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot3.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot4.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot5.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot6.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot7.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot8.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot9.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot10.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot11.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot12.set",
"cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot13.set"
],
"state": {
"userProfileCycles": [
{
"spinLevel": 2.0,
"myMode": 1.0,
"stainGuideRemoval": 2.0,
"deepRinseAndExtraRinse": 0.0,
"quickSpin": 0.0,
"waterTemperature": 4.0,
"tumbleCare": 0.0,
"soakingRinse": 0.0,
"flexDispenseMethod": 3.0,
"cycle": "cloud.smarthq.type.laundry.cycle.cottons",
"fabricSoftener": 1.0,
"extraRinse": 1.0,
"smartWashAndRinse": 1.0,
"autoSoak": 1.0,
"isSaved": 1.0,
"preWash": 0.0,
"steam": 0.0,
"tangleControl": 1.0,
"soilLevel": 3.0,
"flexDispenseStage": 2.0,
"deepFill": 1.0
},
{
"spinLevel": 1.0,
"myMode": 0.0,
"stainGuideRemoval": 0.0,
"deepRinseAndExtraRinse": 0.0,
"quickSpin": 0.0,
"waterTemperature": 2.0,
"tumbleCare": 0.0,
"soakingRinse": 0.0,
"flexDispenseMethod": 2.0,
"cycle": "cloud.smarthq.type.laundry.cycle.delicates",
"fabricSoftener": 1.0,
"extraRinse": 0.0,
"smartWashAndRinse": 0.0,
"autoSoak": 0.0,
"isSaved": 0.0,
"preWash": 0.0,
"steam": 0.0,
"tangleControl": 0.0,
"soilLevel": 1.0,
"flexDispenseStage": 1.0,
"deepFill": 0.0
},
{
"spinLevel": 3.0,
"myMode": 1.0,
"stainGuideRemoval": 1.0,
"deepRinseAndExtraRinse": 1.0,
"quickSpin": 1.0,
"waterTemperature": 3.0,
"tumbleCare": 1.0,
"soakingRinse": 1.0,
"flexDispenseMethod": 3.0,
"cycle": "cloud.smarthq.type.laundry.cycle.bulkyitems",
"fabricSoftener": 1.0,
"extraRinse": 0.0,
"smartWashAndRinse": 1.0,
"autoSoak": 0.0,
"isSaved": 1.0,
"preWash": 0.0,
"steam": 1.0,
"tangleControl": 1.0,
"soilLevel": 2.0,
"flexDispenseStage": 2.0,
"deepFill": 0.0
}
]
},
"serviceId": "0000000000000000000000000000000000000000000000000000000000000000",
"serviceDeviceType": "cloud.smarthq.device.washer",
"config": {
"userProfileVersion": 2.0,
"userProfileSupportedProfiles": 2.0
},
"lastStateTime": "2022-03-04T12:12:12.123Z"
}
],
"userId": "000000000000000"
}
Configuration¶
The following are properties for the gateway/device sync as part of the "config" object for each individual service.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| userProfileSupportedProfiles | INTEGER | No | -2147483648 | 2147483647 |
| userProfileVersion | INTEGER | No | -2147483648 | 2147483647 |
State¶
The following are properties for the device state report as part of the "state" object for each individual service.
| Field Name | Property Type | Required |
|---|---|---|
| userProfileCycles | WASHER_MYCYCLES | No |
Commands¶
The following are properties for both the Digital Twin API to send a command to the device as well as the properties passed as part of a command to the gateway to be processed by the device itself.
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot0.set¶
Command to set washer user profile state slot 0.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot0.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot1.set¶
Command to set washer user profile state slot 1.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot1.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot2.set¶
Command to set washer user profile state slot 2.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot2.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot3.set¶
Command to set washer user profile state slot 3.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot3.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot4.set¶
Command to set washer user profile state slot 4.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot4.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot5.set¶
Command to set washer user profile state slot 5.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot5.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot6.set¶
Command to set washer user profile state slot 6.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot6.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot7.set¶
Command to set washer user profile state slot 7.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot7.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot8.set¶
Command to set washer user profile state slot 8.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot8.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot9.set¶
Command to set washer user profile state slot 9.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot9.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot10.set¶
Command to set washer user profile state slot 10.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot10.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot11.set¶
Command to set washer user profile state slot 11.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot11.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot12.set¶
Command to set washer user profile state slot 12.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot12.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot13.set¶
Command to set washer user profile state slot 13.
Additional Payload Properties¶
Additional properties may be returned by the device to the client when a command is successful.
| Field Name | Property Type | Required | Minimum | Maximum |
|---|---|---|---|---|
| autoSoak | INTEGER | Yes | -2147483648 | 2147483647 |
| cycle | INTEGER | Yes | -2147483648 | 2147483647 |
| deepFill | INTEGER | Yes | -2147483648 | 2147483647 |
| deepRinseAndExtraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| extraRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| fabricSoftener | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseMethod | INTEGER | Yes | -2147483648 | 2147483647 |
| flexDispenseStage | INTEGER | Yes | -2147483648 | 2147483647 |
| isSaved | INTEGER | Yes | -2147483648 | 2147483647 |
| myMode | INTEGER | Yes | -2147483648 | 2147483647 |
| preWash | INTEGER | Yes | -2147483648 | 2147483647 |
| quickSpin | INTEGER | Yes | -2147483648 | 2147483647 |
| smartWashAndRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soakingRinse | INTEGER | Yes | -2147483648 | 2147483647 |
| soilLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| spinLevel | INTEGER | Yes | -2147483648 | 2147483647 |
| stainGuideRemoval | INTEGER | Yes | -2147483648 | 2147483647 |
| steam | INTEGER | Yes | -2147483648 | 2147483647 |
| tangleControl | INTEGER | Yes | -2147483648 | 2147483647 |
| tumbleCare | INTEGER | Yes | -2147483648 | 2147483647 |
| waterTemperature | INTEGER | Yes | -2147483648 | 2147483647 |
Example Commands¶
Command to set a washer user profile state slot.
{
"command": {
"commandType": "cloud.smarthq.command.laundry.washer.userprofile.state.v1.slot13.set"
},
"deviceId": "00000000000000000000000000000000000000000000000000000000000000",
"domainType": "cloud.smarthq.domain.washer.profile.two",
"kind": "service#command",
"serviceDeviceType": "cloud.smarthq.device.washer",
"serviceType": "cloud.smarthq.service.laundry.washer.userprofile.state.v1"
}
Supported Outcomes¶
Each service has an allow listed set of outcomes that the device may return when asked to execute a command.
| Outcome | Documentation |
|---|---|
| cloud.smarthq.outcome.developererror | Only used when there is a server side bug |
| cloud.smarthq.outcome.deviceoffline | The device is offline. |
| cloud.smarthq.outcome.forbidden | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.internalerror | The server had an issue processing the request |
| cloud.smarthq.outcome.missingconfig | The service config is missing |
| cloud.smarthq.outcome.missingstate | The service state is missing |
| cloud.smarthq.outcome.notallowed | The command is not allowed. |
| cloud.smarthq.outcome.notfound | The request is forbidden due to permissions. |
| cloud.smarthq.outcome.notsupported | The command is not supported. |
| cloud.smarthq.outcome.servicedisabled | Feature is currently disabled |
| cloud.smarthq.outcome.success | Successful request |
| cloud.smarthq.outcome.timeout | The server experienced timeout waiting for a response from the gateway |
Data Types¶
INTEGER¶
Value must be an integer. Field specific restrictions such as a minimum and maximum may apply depending on the field.
WASHER_MYCYCLES¶
TODO: Newly defined type needs documentation written.