# CommandStatus

enum CommandStatus : Enum<CommandStatus>

Enum describing the possible status of commands executed by the Nix device, as provided in the OnDeviceResultListener.

## Entries

SUCCESS
Link copied to clipboard
SUCCESS

Status code indicating that the command completed successfully.

ERROR_NOT_READY
Link copied to clipboard
ERROR_NOT_READY

Status code indicating that the command was aborted because the Nix device was not ready (i.e. - it was already executing another command).

ERROR_NOT_SUPPORTED
Link copied to clipboard
ERROR_NOT_SUPPORTED

Status code indicating that the command was aborted because the it was not supported by the Nix device instance.

ERROR_INVALID_ARGUMENT
Link copied to clipboard
ERROR_INVALID_ARGUMENT

Status code indicating that the command was aborted because it contained invalid arguments.

ERROR_LOW_POWER
Link copied to clipboard
ERROR_LOW_POWER

Status code indicating that the command was aborted because of a low power state on the Nix device (e.g. - insufficient battery power to complete a measurement).

ERROR_TIMEOUT
Link copied to clipboard
ERROR_TIMEOUT

Status code indicating that the command failed due to a timeout error.

ERROR_AMBIENT_LIGHT
Link copied to clipboard
ERROR_AMBIENT_LIGHT

Status code indicating that the measurement operation failed due to the detection of ambient light leakage.

ERROR_SCAN_DELTA
Link copied to clipboard
ERROR_SCAN_DELTA

Status code indicating that the in-field calibration operation failed due to high delta E (i.e. - the calibration reference tile could not be verified by its color value). This status is only possible after a IDeviceCompat.runFieldCalibration command.

ERROR_INTERNAL
Link copied to clipboard
ERROR_INTERNAL

Status code indicating that the command failed due to an unknown / internal SDK error.

WARNING_TEMPERATURE
Link copied to clipboard
WARNING_TEMPERATURE

Status code indicating that the in-field calibration operation completed successfully, but a temperature warning was issued (i.e. - the ambient temperature of the device is currently outside of the recommended range). This status is only possible after a IDeviceCompat.runFieldCalibration command.

ERROR_LICENSE
Link copied to clipboard
ERROR_LICENSE

Status code indicating that the command failed due to a problem with the LicenseManager. Check LicenseManager.Shared.state for details.

## Properties

entries
Link copied to clipboard
val entries: EnumEntries<CommandStatus>

Returns a representation of an immutable list of all enum entries, in the order they're declared.

name
Link copied to clipboard
val name: String
ordinal
Link copied to clipboard
val ordinal: Int
value
Link copied to clipboard
val value: Int

## Functions

valueOf
Link copied to clipboard
fun valueOf(value: String): CommandStatus

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

values
Link copied to clipboard
fun values(): Array<CommandStatus>

Returns an array containing the constants of this enum type, in the order they're declared.