viam.proto.service.sensors

@generated by Viam. Do not edit manually!

Classes

`SensorsServiceBase`	Helper class that provides a standard way to create an ABC using
`SensorsServiceStub`
`UnimplementedSensorsServiceBase`	Helper class that provides a standard way to create an ABC using
`GetReadingsRequest`	Abstract base class for protocol messages.
`GetReadingsResponse`	Abstract base class for protocol messages.
`GetSensorsRequest`	The sensors service messages are deprecated
`GetSensorsResponse`	Abstract base class for protocol messages.
`Readings`	Abstract base class for protocol messages.

Package Contents

class viam.proto.service.sensors.SensorsServiceBase[source]

Bases: abc.ABC

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

abstract GetSensors(stream: grpclib.server.Stream[service.sensors.v1.sensors_pb2.GetSensorsRequest, service.sensors.v1.sensors_pb2.GetSensorsResponse]) → None[source]

Async:

abstract GetReadings(stream: grpclib.server.Stream[service.sensors.v1.sensors_pb2.GetReadingsRequest, service.sensors.v1.sensors_pb2.GetReadingsResponse]) → None[source]

Async:

abstract DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

Async:

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

class viam.proto.service.sensors.SensorsServiceStub(channel: grpclib.client.Channel)[source]

GetSensors

GetReadings

DoCommand

class viam.proto.service.sensors.UnimplementedSensorsServiceBase[source]

Bases: SensorsServiceBase

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

async GetSensors(stream: grpclib.server.Stream[service.sensors.v1.sensors_pb2.GetSensorsRequest, service.sensors.v1.sensors_pb2.GetSensorsResponse]) → None[source]

async GetReadings(stream: grpclib.server.Stream[service.sensors.v1.sensors_pb2.GetReadingsRequest, service.sensors.v1.sensors_pb2.GetReadingsResponse]) → None[source]

async DoCommand(stream: grpclib.server.Stream[common.v1.common_pb2.DoCommandRequest, common.v1.common_pb2.DoCommandResponse]) → None[source]

class viam.proto.service.sensors.GetReadingsRequest(*, name: str = ..., sensor_names: collections.abc.Iterable[viam.gen.common.v1.common_pb2.ResourceName] | None = ..., extra: google.protobuf.struct_pb2.Struct | 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.

name: str

property sensor_names: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → 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.service.sensors.GetReadingsResponse(*, readings: collections.abc.Iterable[global___Readings] | 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 readings: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Readings]

class viam.proto.service.sensors.GetSensorsRequest(*, name: str = ..., extra: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

The sensors service messages are deprecated

name: str

property extra: google.protobuf.struct_pb2.Struct: Additional arguments to the method

HasField(field_name: Literal['extra', b'extra']) → 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.service.sensors.GetSensorsResponse(*, sensor_names: collections.abc.Iterable[viam.gen.common.v1.common_pb2.ResourceName] | 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 sensor_names: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.ResourceName]

class viam.proto.service.sensors.Readings(*, name: viam.gen.common.v1.common_pb2.ResourceName | None = ..., readings: collections.abc.Mapping[str, google.protobuf.struct_pb2.Value] | 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.

class ReadingsEntry(*, key: str = ..., value: google.protobuf.struct_pb2.Value | 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.

key: str

property value: google.protobuf.struct_pb2.Value

HasField(field_name: Literal['value', b'value']) → 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.

property name: viam.gen.common.v1.common_pb2.ResourceName

property readings: google.protobuf.internal.containers.MessageMap[str, google.protobuf.struct_pb2.Value]

HasField(field_name: Literal['name', b'name']) → 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.