HomeException.Codes

const val ABORTED = 10: Int

The operation was aborted, typically due to a concurrency issue such as a sequencer check failure or transaction abort.

const val ALREADY_EXISTS = 6: Int

The entity that a client attempted to create, for example a file or directory, already exists.

const val API_NOT_CONNECTED = 17: Int

The client attempted to call a method from an API that failed to connect. This can happen when the device is offline or doesn't support the API that the client attempted to call.

const val CANCELLED = 1: Int

The operation was cancelled, typically by the caller.

const val COMMAND_FAILED = 19: Int

The command failed to execute. Please check the sub error codes for more details.

const val CURSOR_WINDOW_NOT_SUPPORTED = 22: Int

The client attempted to call method which uses cursor window but it is not enabled/supported.

const val DATA_HOLDER_COLUMN_EMPTY = 26: Int

The column was empty in the data holder.

const val DATA_HOLDER_COLUMN_NOT_FOUND = 24: Int

The column was not found in the data holder.

const val DATA_HOLDER_COLUMN_NULL = 25: Int

The column was null in the data holder.

const val DATA_LOSS = 15: Int

Unrecoverable data loss or corruption has occurred.

const val DEADLINE_EXCEEDED = 4: Int

The deadline expired before the operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully.

const val DECOMMISSIONING_INELIGIBLE = 21: Int

The client attempted to decommission a device that is ineligible for some reason.

const val FAILED_PRECONDITION = 9: Int

The operation was rejected because the system is not in a state required for the operation's execution. For example, you might get this message if the stop command of the OvenCavityOperationalStateTrait was called on an oven that's already stopped, or if you attempted to run an rmdir operation on a non-directory.

const val INTERNAL = 13: Int

Internal errors. This means that some invariants expected by the underlying system have been broken. This error code is reserved for serious errors.

const val INVALID_ARGUMENT = 3: Int

The client provided an argument that is outside the range of expected values.

const val INVALID_DATA_HOLDER = 23: Int

Data holder was invalid.

const val NOT_FOUND = 5: Int

A requested entity, such as a file or directory, was not found. If a request is denied for an entire class of users, such as a gradual feature rollout or undocumented allowlist, NOT_FOUND may be used. If a request is denied for some users within a class of users, such as user-based access control, PERMISSION_DENIED must be used.

const val OUT_OF_RANGE = 11: Int

The operation was attempted past the valid range, such as seeking or reading past end-of-file. Unlike INVALID_ARGUMENT, this error indicates a problem that may be fixed if the system state changes.

const val PERMISSION_DENIED = 7: Int

The caller does not have permission to execute the specified operation. PERMISSION_DENIED must not be used for rejections caused by exhausting some resource (use RESOURCE_EXHAUSTED for those errors). PERMISSION_DENIED must not be used if the caller cannot be identified (use UNAUTHENTICATED for those errors). This error code does not imply the request is valid or that the requested entity exists or satisfies other preconditions.

const val RESOURCE_EXHAUSTED = 8: Int

Some resource has been exhausted, perhaps due to a per-user quota being reached or the entire file system running out of space. For example, this error could be thrown if the dispense command of the DispenseTrait is called on a pet-feeder device but there is no more food left in the unit.

const val SDK_INITIALIZATION_MISSING_INFO = 18: Int

The SDK was initialized without all the required information. For example, this error is thrown if the client attempts to get a TraitFactory for a given trait ID but the trait was not included when initializing the SDK. See Initialize the home on Android.

const val UNAUTHENTICATED = 16: Int

The caller cannot be identified or the request doesn't have valid authentication credentials.

const val UNAVAILABLE = 14: Int

The service is currently unavailable. This is most likely a transient condition, which can be corrected by retrying with a backoff. Note that it is not always safe to retry non-idempotent operations.

const val UNIMPLEMENTED = 12: Int

The requested operation isn't implemented, supported or enabled in this service.

const val UNKNOWN = 2: Int

Unknown error. UNKNOWN appears when an error condition occurs that can't be classified using any of the other error codes. For example, this error may be returned when a status value received from an external API lacks sufficient information as to the root cause.

const val WRITE_FAILED = 20: Int

The write failed to execute. Please check the sub error codes for more details.