viam.module.types

Classes

Reconfigurable

The Reconfigurable protocol defines the requirements for making a resource Reconfigurable

Stoppable

The Stoppable protocol defines the requirements for making a resource Stoppable.

Module Contents

class viam.module.types.Reconfigurable[source]

Bases: Protocol

The Reconfigurable protocol defines the requirements for making a resource Reconfigurable

reconfigure(config: viam.proto.app.robot.ComponentConfig, dependencies: Mapping[viam.proto.common.ResourceName, viam.resource.base.ResourceBase])[source]
class viam.module.types.Stoppable[source]

Bases: Protocol

The Stoppable protocol defines the requirements for making a resource Stoppable.

All resources that physically move should be Stoppable.

stop(*, extra: Mapping[str, Any] | None = None, timeout: float | None = None, **kwargs)[source]