Viam SDK
    Preparing search index...

    Enumeration ModuleStatus_State

    from enum viam.robot.v1.ModuleStatus.State

    Index

    Enumeration Members

    CLOSING PENDING READY STARTING UNHEALTHY UNSPECIFIED

    Enumeration Members

    CLOSING: 5

    module process is shutting down, either because the module is being removed from the machine or because it is restarting during a reconfigure. on removal the module's status stops being tracked once shutdown completes; on restart it transitions -> state_starting

    from enum value: STATE_CLOSING = 5;

    PENDING: 1

    module is configured but viam-server has not yet attempted to start it (because e.g. a required package is still downloading) transitions -> state_starting after pre-setup completes

    from enum value: STATE_PENDING = 1;

    READY: 3

    module has sent a Ready response, registered its models, and is running transitions -> state_unhealthy on bad exit

    from enum value: STATE_READY = 3;

    STARTING: 2

    module process has been spawned and viam-server is waiting for it to send a Ready response and register its models transitions -> state_ready on success

    from enum value: STATE_STARTING = 2;

    UNHEALTHY: 4

    module failed to start, exited unexpectedly, or is being restarted after a crash. any failure in any other state goes to this state

    from enum value: STATE_UNHEALTHY = 4;

    UNSPECIFIED: 0

    state is unknown or has not been set yet

    from enum value: STATE_UNSPECIFIED = 0;

    Settings

    Member Visibility

    On This Page

    Enumeration Members