RoomioGuidance

value class RoomioGuidance(val raw: String)

What the user should do to get a better scan, from RoomioScanEvent.GuidanceChanged. New values may be added in future releases, so include an else branch when you match on them.

Constructors


RoomioGuidance	constructor(raw: String)

Types

Name	Summary
Companion	object Companion

Properties

Name	Summary
raw	val raw: String The guidance as a string, for example `"slow_down"`.

Functions

Name	Summary
toString	open override fun toString(): String

Companion

object Companion

Properties

Name	Summary
BATTERY_LOW	val BATTERY_LOW: RoomioGuidance The battery is low. Before a scan it can't start, so charge first; during one, finish soon.
DEVICE_HOT	val DEVICE_HOT: RoomioGuidance The device is overheating, which lowers scan quality. Finish the scan soon.
INITIALIZING	val INITIALIZING: RoomioGuidance Tracking is starting. Move the device slowly.
MEMORY_LOW	val MEMORY_LOW: RoomioGuidance The device is running low on memory. Finish the scan soon.
NEED_MORE_DETAIL	val NEED_MORE_DETAIL: RoomioGuidance Too little visual detail to track. Point at a more textured surface.
NEED_MORE_LIGHT	val NEED_MORE_LIGHT: RoomioGuidance Too dark to track. Move somewhere brighter.
POWER_SAVING	val POWER_SAVING: RoomioGuidance Battery Saver (Android) or Low Power Mode (iOS) is on. A scan can't start until it is off; during a scan it only lowers quality, and the scan carries on.
RETURN_TO_SCANNED_AREA	val RETURN_TO_SCANNED_AREA: RoomioGuidance Tracking is lost. Return to somewhere already scanned.
SLOW_DOWN	val SLOW_DOWN: RoomioGuidance The device is moving too fast.
STORAGE_FULL	val STORAGE_FULL: RoomioGuidance The device is nearly out of storage. Before a scan it can't start, so free some space first; during one, finish now.
STORAGE_LOW	val ~~STORAGE_LOW~~: RoomioGuidance No longer sent: low storage before a scan is the warning sheet, and only STORAGE_FULL shows a bar.

BATTERY_LOW

val BATTERY_LOW: RoomioGuidance

The battery is low. Before a scan it can't start, so charge first; during one, finish soon.

DEVICE_HOT

val DEVICE_HOT: RoomioGuidance

The device is overheating, which lowers scan quality. Finish the scan soon.

INITIALIZING

val INITIALIZING: RoomioGuidance

Tracking is starting. Move the device slowly.

MEMORY_LOW

val MEMORY_LOW: RoomioGuidance

The device is running low on memory. Finish the scan soon.

NEED_MORE_DETAIL

val NEED_MORE_DETAIL: RoomioGuidance

Too little visual detail to track. Point at a more textured surface.

NEED_MORE_LIGHT

val NEED_MORE_LIGHT: RoomioGuidance

Too dark to track. Move somewhere brighter.

POWER_SAVING

val POWER_SAVING: RoomioGuidance

Battery Saver (Android) or Low Power Mode (iOS) is on. A scan can't start until it is off; during a scan it only lowers quality, and the scan carries on.