Air Purifier
Device Profile
Supported features may vary by model and country.
Property
| Resource | Property | Value | ||||
|---|---|---|---|---|---|---|
|
Module Class |
Type |
Name |
Type |
R/W |
Value |
Description |
|
airPurifierJobMode |
Object |
currentJobMode (Run mode) |
Enum |
RW |
CLEAN |
Cleaning Mode |
|
RW |
SLEEP |
Sleep Mode |
||||
|
RW |
SILENT |
Quiet, Low Noise Mode |
||||
|
RW |
HUMIDITY |
Humidification and Cleaning |
||||
|
RW |
CIRCULATOR |
Circulation and Cleaning |
||||
|
RW |
BABY_CARE |
Baby Care |
||||
|
RW |
DUAL_CLEAN |
Dual Cleaning |
||||
|
RW |
AUTO |
Auto Mode |
||||
|
RW |
FAST |
Fast Mode |
||||
|
RW |
SMART |
Smart Mode |
||||
|
operation |
Object |
airPurifierOperationMode (Main Body Operation) |
Enum |
RW |
POWER_ON |
Start air purifier operation |
|
RW |
POWER_OFF |
Stop air purifier operation |
||||
|
timer |
Object |
absoluteHourToStart |
Number |
RW |
|
Set On Timer - Hour |
|
absoluteMinuteToStart |
Number |
RW |
|
Set On Timer - Minute |
||
|
absoluteHourToStop |
Number |
RW |
|
Set Off Timer - Hour |
||
|
absoluteMinuteToStop |
Number |
RW |
|
Set Off Timer - Minute |
||
|
airFlow |
Object |
windStrength (Wind Strength) |
Enum |
RW |
LOW |
Low wind speed |
|
RW |
MID |
Medium wind speed |
||||
|
RW |
HIGH |
High wind speed |
||||
|
RW |
POWER |
Power |
||||
|
RW |
AUTO |
Automatic |
||||
|
airQualitySensor |
Object |
PM1 (PM1.0 Ultrafine particulate matter concentration, ㎍/㎥) |
Number |
R |
76~ |
Red (Very Bad) |
|
36~75 |
Yellow (Bad) |
|||||
|
16~35 |
Green (Moderate) |
|||||
|
0~15 |
Blue (Good) |
|||||
|
PM2 (PM2.5 Fine particulate matter concentration, ㎍/㎥) |
Number |
R |
76~ |
Red (Very Bad) |
||
|
36~75 |
Yellow (Bad) |
|||||
|
16~35 |
Green (Moderate) |
|||||
|
0~15 |
Blue (Good) |
|||||
|
PM10 (PM10 Coarse particulate matter concentration, ㎍/㎥) |
Number |
R |
150~ |
Red (Very Bad) |
||
|
81~150 |
Yellow (Bad) |
|||||
|
31~80 |
Green (Moderate) |
|||||
|
0~30 |
Blue (Good) |
|||||
|
oder |
Number |
R |
|
Odor concentration value |
||
|
humidity |
Number |
R |
|
Humidity value |
||
|
totalPollution (Air quality index) |
Number |
R |
0 |
Sensor power-off state, or the initializing state after power-on |
||
|
1 |
Good |
|||||
|
2 |
Moderate |
|||||
|
3 |
Bad |
|||||
|
4 |
Very Bad |
|||||
|
monitoringEnabled (Sensor Monitoring On) |
Enum |
R |
ON_WORKING |
Sensor Monitoring - During Operation |
||
|
R |
ALWAYS |
Sensor Monitoring - Always |
||||
Notification
| Push Code | Description |
|---|---|
|
LACK_OF_WATER |
There is not enough water. |
|
TIME_TO_CLEAN_FILTER |
Filter cleaning is required. |
|
POLLUTION_IS_HIGH |
There is high level of pollution. |
|
TIME_TO_CHANGE_FILTER |
It is time to replace the filter. |
JSON
#Air Purifier
{"notification": {"push": ["TIME_TO_CHANGE_FILTER",
"LACK_OF_WATER",
"POLLUTION_IS_HIGH",
"TIME_TO_CLEAN_FILTER"]},
"property": {"airFlow": {"windStrength": {"mode": ["r", "w"],
"type": "enum",
"value": {"r": ["POWER",
"HIGH",
"MID",
"AUTO",
"LOW",
"SLOW"],
"w": ["POWER",
"HIGH",
"MID",
"AUTO",
"LOW",
"SLOW"]}}},
"airPurifierJobMode": {"currentJobMode": {"mode": ["r", "w"],
"type": "enum",
"value": {"r": ["OFF",
"ACO",
"HUMIDITY",
"DRY",
"AI",
"BABY_CARE",
"CIRCULATOR",
"AROMA",
"ENERGY_SAVING",
"SILENT",
"SLEEP",
"FAN",
"AUTO",
"DUAL_CLEAN",
"HEAT",
"AIRCLEAN",
"COOL",
"CLEAN"],
"w": ["OFF",
"ACO",
"HUMIDITY",
"DRY",
"AI",
"BABY_CARE",
"CIRCULATOR",
"AROMA",
"ENERGY_SAVING",
"SILENT",
"SLEEP",
"FAN",
"AUTO",
"DUAL_CLEAN",
"HEAT",
"AIRCLEAN",
"COOL",
"CLEAN"]}}},
"airQualitySensor": {"PM1": {"mode": ["r"], "type": "number"},
"PM10": {"mode": ["r"], "type": "number"},
"PM2": {"mode": ["r"], "type": "number"},
"humidity": {"mode": ["r"],
"type": "number"},
"monitoringEnabled": {"mode": ["r", "w"],
"type": "enum",
"value": {"r": ["ON_WORKING",
"ALWAYS"],
"w": ["ON_WORKING",
"ALWAYS"]}},
"oder": {"mode": ["r"], "type": "number"}},
"operation": {"airPurifierOperationMode": {"mode": ["r", "w"],
"type": "enum",
"value": {"r": ["POWER_ON",
"POWER_OFF"],
"w": ["POWER_ON",
"POWER_OFF"]}}},
"timer": {"absoluteHourToStart": {"mode": ["r", "w"],
"type": "number"},
"absoluteHourToStop": {"mode": ["r", "w"],
"type": "number"},
"absoluteMinuteToStart": {"mode": ["r", "w"],
"type": "number"},
"absoluteMinuteToStop": {"mode": ["r", "w"],
"type": "number"}}}}
Status Inquiry Result
Example
#Air Purifier
{
"airPurifierJobMode": {
"currentJobMode": "AIRCLEAN"
},
"operation": {
"airPurifierOperationMode": "POWER_ON"
},
"timer": {
"absoluteHourToStart": 9,
"absoluteMinuteToStart": 20,
"absoluteHourToStop": 22,
"absoluteMinuteToStop": 40
},
"airFlow": {
"windStrength": "AUTO"
},
"airQualitySensor": {
"PM1": 8,
"PM2": 9,
"PM10": 10,
"oder": 1,
"humidity": 30,
"monitoringEnabled": "ON_WORKING"
}
}
Control Command
Example
Air purifier power on
{
"operation": {"airPurifierOperationMode": "POWER_ON"}
}
Air purifier wind strength adjustment
{
"airFlow": {"windStrength": "HIGH"}
}
Air purifier on timer (Timer set on 11: 30)
{
"timer": {"absoluteHourToStart": 11, "absoluteMinuteToStart": 30}
}
Disables the timer: -1
{
"timer": {"absoluteHourToStart": -1, "absoluteMinuteToStart": -1}
}
Handling Exceptions When Controlling Wind Strength
The device may not be controlled depending on its status. When requesting to control the device, you must first retrieve its state and handle exceptions for cases where it is in an uncontrollable state. See the following examples.
E.g., User command: "Set the wind strength stronger/weaker."
Handling POWER_OFF
If the value of airPurifierOperationMode is POWER_OFF, the device is uncontrollable. Provide an appropriate response to the user by referring to the following example.
- Example of response:
- "The air conditioner is powered off."
Handling POWER_ON
If the value of airPurifierOperationMode is POWER_ON, the following should be handled depending on the currentJobMode or windStrength.
currentJobMode or windStrength is AUTO
If windStrength or currentJobMode is AUTO, wind strength is automatically set and manually uncontrollable. Provide an appropriate response to the user by referring the following example.
- Example of response:
- "As the air purifier operates in the AUTO mode, you cannot change the wind strength."
Neither currentJobMode nor windStrength is AUTO
If the value of currentJobMode is NOT AUTO and windStrength is NOT AUTO, do as follows.
-
Retrieve the device profile to get possible values of airFlow supported by the device. Possible values vary by product model.
-
Change the header of the device control request.
-
Set x-conditional-control to false.
{ "x-conditional-control": false, }
-
-
Change the body of the device control request.
{ "airFlow": { "windStrength": X } } -
Provide an appropriate response to the user.
- Example of response:
- The wind strength of the air purifier changed to power/high/medium/low.
- The wind strength of the air purifier is at the maximum or minimum.
- Example of response: