Robot Cleaner

Device Profile

Property

Resource		Property		Value
Module Class	Type	Name	Type	R/W	Value	Description
runState	Object	currentState	Enum	R	CHARGING	Charging
				R	DIAGNOSIS	Running diagnosis
				R	HOMING	Moving to the charging station - r9
				R	INITIALIZING	Initialization
				R	MACROSECTOR	Remote controlling
				R	MONITORING_DETECTING	Running Home Guard
				R	MONITORING_MOVING	Moving to the set Home Guard target (from charging station)
				R	MONITORING_POSITIONING	Moving to the set Home Guard position
				R	PAUSE	Pause
				R	RESERVATION	Setting remote control timer
				R	SETDATE	Setting time for remote control
				R	SLEEP	In sleep mode
				R	STANDBY	Standby
				R	WORKING	Cleaning
				R	ERROR	Error
robotCleanerJobMode	Object	currentJobMode	Enum	R	ZIGZAG	ZigZag Clean
				R	SECTOR_BASE	Thorough cleaning
				R	SPOT	Focused cleaning
				R	EDGE	Edge cleaning (LG CordZero R9: Edge Mode)
				R	MACRO	Macro mode (assign area with remote control for cleaning)
				R	SELECT	My Space clean
operation	Object	cleanOperationMode	Enum	W	START	Start Cleaning
				W	RESUME	Resume Cleaning
				W	PAUSE	Pause while cleaning
				W	HOMING	Go to the charging terminal
				W	WAKE_UP	Wake up the device in sleep mode.
battery	Object	level	Enum	R	MOVELESS	Low (cannot move)
				R	DOCK_LEVEL	Low (can make it to docking)
				R	LOW	Low
				R	MID	Normal
				R	HIGH	High
				R	FULL	Full
				R	OVER_CHARGE	Overcharged
		percent	Number	R		Battery percent
timer	Object	absoluteHourToStart	Number	RW		Cleaning Timer - Hour
		absoluteMinuteToStart	Number	RW		Cleaning Timer - Minute
		runningHour	Number	R		Running Time - Hour
		runningMinute	Number	R		Running Time - Minute

Notification

Value	Description
CLEANING_IS_COMPLETED	Cleaning is complete.
CLEANING_IS_FAILED	Cleaning has failed.
MOTION_IS_DETECTED	Photograph is sent as movement is detected during Home Guard.
NEED_TO_CHECK_LOCATION	Location check is required.
HOMEGUARD_IS_STOPPED	Home Guard has stopped.
SCHEDULED_CLEANING_STARTS	Scheduled cleaning starts.

Error

Value	Description
BRUSH_ERROR	The error on the brush
NO_BATTERY_ERROR	No battery
DUST_FULL_ERROR	The error that the dust bin is full
NO_DUST_BIN_ERROR	No dust bin
MOVE_ERROR	The error of unable to move
BLOCK_ERROR	The error on movement blockage
RIGHT_WHEEL_ERROR	The error on the right wheel
LEFT_WHEEL_ERROR	The error on the left wheel
CLIFF_ERROR	The error of unable to move slope
SUCTION_BLOCKED_ERROR	The error on the suction
MOP_ERROR	The error on the mop status
UNKNOWN_ERROR	Undefined error

JSON

#Robot Cleaner 
{
  "property": {
    "battery": {
      "level": {
        "mode": ["r"],
        "type": "enum",
        "value": {
          "r": ["MOVELESS",
            "DOCK_LEVEL",
            "LOW",
            "MID",
            "HIGH",
            "FULL",
            "OVER_CHARGE"
          ]
        }
      }
    },
    "operation": {
      "cleanOperationMode": {
        "mode": ["w"],
        "type": "enum",
        "value": {
          "w": ["HOMING",
            "PAUSE",
            "START"
          ]
        }
      }
    },
    "robotCleanerJobMode": {
      "currentJobMode": {
        "mode": ["r"],
        "type": "enum",
        "value": {
          "r": ["ZIGZAG",
            "SPOT",
            "MACARO",
            "SECTOR_BASE"
          ]
        }
      }
    },
    "runState": {
      "currentState": {
        "mode": ["r"],
        "type": "enum",
        "value": {
          "r": ["MONITORING",
            "WORKING",
            "DIAGNOSIS",
            "MONITORING_POSITIONING",
            "MONITORING_MOVING",
            "MACROSECTOR",
            "RESERVATION",
            "SETDATE",
            "STANDBY",
            "MONITORING_DETECTING",
            "CHARGING",
            "PAUSE",
            "HOMING"
          ]
        }
      }
    },
    "timer": {
      "absoluteHourToStart": {
        "mode": ["r", "w"],
        "type": "number"
      },
      "absoluteMinuteToStart": {
        "mode": ["r", "w"],
        "type": "number"
      },
      "runningHour": {
        "mode": ["r"],
        "type": "number"
      },
      "runningMinute": {
        "mode": ["r"],
        "type": "number"
      }
    }
  },
  "push": ["HOMEGUARD_IS_STOPPED",
    "MOTION_IS_DETECTED",
    "NEED_TO_CHECK_LOCATION",
    "CLEANING_IS_COMPLETED",
    "CLEANING_IS_FAILED"
  ]
}

 

Status Inquiry Result

Example

#Robot Cleaner
{
  "battery": {
    "level": "MOVELESS"
  },
  "robotCleanerJobMode": {
    "currentJobMode": "SPOT"
  },
  "runState": {
    "currentState": "CHARGING"
  },
  "timer": {
    "absoluteHourToStart": 5,
    "absoluteMinuteToStart": 30,
    "runningHour": 0,
    "runningMinute": 6
  }
}

Example - In Error State

#Robot Cleaner
{
  "error": "MOVE_ERROR",
  "runState": {
    "currentState": "ERROR"
  }
}

Control Command

Example

Starting the robot cleaner

{
  "operation": {
    "cleanOperationMode": "START"
  }
}

Robot cleaner on timer (Timer set for 11:30)

{
  "timer": {"absoluteHourToStart": 11, "absoluteMinuteToStart": 30}
}