ONBOARDING indicates the device has been registered on the system but has not yet completed the on-boarding process.
- Including a test charge step, to validate that communication and control of the device is possible within expected limits.
ONBOARDING_TEST_IN_PROGRESS indicates that there is a test charge in progress for the device.
LIVE indicates that the device has completed the on-boarding process and is ready for control.
FAILED_ONBOARDING_TEST indicates that there has been an issue validating that the device can be reliably communicated with or controlled on the system.
RETIRED indicates that the device has no connection details and is not currently available for control.

Values

ONBOARDING
PENDING_LIVE
LIVE
ONBOARDING_TEST_IN_PROGRESS
FAILED_ONBOARDING_TEST
RETIRED

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

"ONBOARDING"