viam.proto.module

@generated by Viam. Do not edit manually!

Classes

`ModuleServiceBase`	Helper class that provides a standard way to create an ABC using
`ModuleServiceStub`
`UnimplementedModuleServiceBase`	Helper class that provides a standard way to create an ABC using
`AddResourceRequest`	Abstract base class for protocol messages.
`AddResourceResponse`	Abstract base class for protocol messages.
`HandlerDefinition`	Abstract base class for protocol messages.
`HandlerMap`	Abstract base class for protocol messages.
`ReadyRequest`	Abstract base class for protocol messages.
`ReadyResponse`	Abstract base class for protocol messages.
`ReconfigureResourceRequest`	Abstract base class for protocol messages.
`ReconfigureResourceResponse`	Abstract base class for protocol messages.
`RemoveResourceRequest`	Abstract base class for protocol messages.
`RemoveResourceResponse`	Abstract base class for protocol messages.
`ValidateConfigRequest`	Abstract base class for protocol messages.
`ValidateConfigResponse`	Abstract base class for protocol messages.

Package Contents

class viam.proto.module.ModuleServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstract AddResource(stream: grpclib.server.Stream[module.v1.module_pb2.AddResourceRequest, module.v1.module_pb2.AddResourceResponse]) → None[source]

Async:

abstract ReconfigureResource(stream: grpclib.server.Stream[module.v1.module_pb2.ReconfigureResourceRequest, module.v1.module_pb2.ReconfigureResourceResponse]) → None[source]

Async:

abstract RemoveResource(stream: grpclib.server.Stream[module.v1.module_pb2.RemoveResourceRequest, module.v1.module_pb2.RemoveResourceResponse]) → None[source]

Async:

abstract Ready(stream: grpclib.server.Stream[module.v1.module_pb2.ReadyRequest, module.v1.module_pb2.ReadyResponse]) → None[source]

Async:

abstract ValidateConfig(stream: grpclib.server.Stream[module.v1.module_pb2.ValidateConfigRequest, module.v1.module_pb2.ValidateConfigResponse]) → None[source]

Async:

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.module.ModuleServiceStub(channel: grpclib.client.Channel)[source]

AddResource

ReconfigureResource

RemoveResource

Ready

ValidateConfig

class viam.proto.module.UnimplementedModuleServiceBase[source]

Bases: ModuleServiceBase

Helper class that provides a standard way to create an ABC using inheritance.

async AddResource(stream: grpclib.server.Stream[module.v1.module_pb2.AddResourceRequest, module.v1.module_pb2.AddResourceResponse]) → None[source]

async ReconfigureResource(stream: grpclib.server.Stream[module.v1.module_pb2.ReconfigureResourceRequest, module.v1.module_pb2.ReconfigureResourceResponse]) → None[source]

async RemoveResource(stream: grpclib.server.Stream[module.v1.module_pb2.RemoveResourceRequest, module.v1.module_pb2.RemoveResourceResponse]) → None[source]

async Ready(stream: grpclib.server.Stream[module.v1.module_pb2.ReadyRequest, module.v1.module_pb2.ReadyResponse]) → None[source]

async ValidateConfig(stream: grpclib.server.Stream[module.v1.module_pb2.ValidateConfigRequest, module.v1.module_pb2.ValidateConfigResponse]) → None[source]

class viam.proto.module.AddResourceRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | None = ..., dependencies: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property config: viam.gen.app.v1.robot_pb2.ComponentConfig

property dependencies: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: Literal['config', b'config']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.module.AddResourceResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.module.HandlerDefinition(*, subtype: viam.gen.robot.v1.robot_pb2.ResourceRPCSubtype | None = ..., models: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property subtype: viam.gen.robot.v1.robot_pb2.ResourceRPCSubtype

property models: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: Literal['subtype', b'subtype']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.module.HandlerMap(*, handlers: collections.abc.Iterable[global___HandlerDefinition] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property handlers: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___HandlerDefinition]

class viam.proto.module.ReadyRequest(*, parent_address: str = ..., webrtc_offer: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

parent_address: str

webrtc_offer: str

class viam.proto.module.ReadyResponse(*, ready: bool = ..., handlermap: global___HandlerMap | None = ..., webrtc_answer: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

ready: bool

webrtc_answer: str

property handlermap: global___HandlerMap

HasField(field_name: Literal['handlermap', b'handlermap']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.module.ReconfigureResourceRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | None = ..., dependencies: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property config: viam.gen.app.v1.robot_pb2.ComponentConfig

property dependencies: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

HasField(field_name: Literal['config', b'config']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.module.ReconfigureResourceResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.module.RemoveResourceRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

class viam.proto.module.RemoveResourceResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

class viam.proto.module.ValidateConfigRequest(*, config: viam.gen.app.v1.robot_pb2.ComponentConfig | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property config: viam.gen.app.v1.robot_pb2.ComponentConfig

HasField(field_name: Literal['config', b'config']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

class viam.proto.module.ValidateConfigResponse(*, dependencies: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property dependencies: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]