viam.proto.provisioning

@generated by Viam. Do not edit manually!

Classes

ProvisioningServiceBase

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

ProvisioningServiceStub

UnimplementedProvisioningServiceBase

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

CloudConfig

minimal CloudConfig to create /etc/viam.json

GetNetworkListRequest

Abstract base class for protocol messages.

GetNetworkListResponse

Abstract base class for protocol messages.

GetSmartMachineStatusRequest

Abstract base class for protocol messages.

GetSmartMachineStatusResponse

Abstract base class for protocol messages.

NetworkInfo

Abstract base class for protocol messages.

ProvisioningInfo

Abstract base class for protocol messages.

SetNetworkCredentialsRequest

Abstract base class for protocol messages.

SetNetworkCredentialsResponse

Abstract base class for protocol messages.

SetSmartMachineCredentialsRequest

Abstract base class for protocol messages.

SetSmartMachineCredentialsResponse

Abstract base class for protocol messages.

Package Contents

class viam.proto.provisioning.ProvisioningServiceBase[source]

Bases: abc.ABC

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

abstract GetSmartMachineStatus(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.GetSmartMachineStatusRequest, provisioning.v1.provisioning_pb2.GetSmartMachineStatusResponse]) None[source]
Async:

abstract SetNetworkCredentials(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.SetNetworkCredentialsRequest, provisioning.v1.provisioning_pb2.SetNetworkCredentialsResponse]) None[source]
Async:

abstract SetSmartMachineCredentials(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsRequest, provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsResponse]) None[source]
Async:

abstract GetNetworkList(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.GetNetworkListRequest, provisioning.v1.provisioning_pb2.GetNetworkListResponse]) None[source]
Async:

__mapping__() Dict[str, grpclib.const.Handler][source]
class viam.proto.provisioning.ProvisioningServiceStub(channel: grpclib.client.Channel)[source]
class viam.proto.provisioning.UnimplementedProvisioningServiceBase[source]

Bases: ProvisioningServiceBase

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

async GetSmartMachineStatus(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.GetSmartMachineStatusRequest, provisioning.v1.provisioning_pb2.GetSmartMachineStatusResponse]) None[source]
async SetNetworkCredentials(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.SetNetworkCredentialsRequest, provisioning.v1.provisioning_pb2.SetNetworkCredentialsResponse]) None[source]
async SetSmartMachineCredentials(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsRequest, provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsResponse]) None[source]
async GetNetworkList(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.GetNetworkListRequest, provisioning.v1.provisioning_pb2.GetNetworkListResponse]) None[source]
class viam.proto.provisioning.CloudConfig(*, id: str = ..., secret: str = ..., app_address: str = ...)

Bases: google.protobuf.message.Message

minimal CloudConfig to create /etc/viam.json

id: str

SmartMachine part id

secret: str

SmartMachine part secret

app_address: str
class viam.proto.provisioning.GetNetworkListRequest

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.provisioning.GetNetworkListResponse(*, networks: collections.abc.Iterable[global___NetworkInfo] | 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 networks: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___NetworkInfo]
class viam.proto.provisioning.GetSmartMachineStatusRequest

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.provisioning.GetSmartMachineStatusResponse(*, provisioning_info: global___ProvisioningInfo | None = ..., has_smart_machine_credentials: bool = ..., is_online: bool = ..., latest_connection_attempt: global___NetworkInfo | None = ..., errors: 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.

has_smart_machine_credentials: bool
is_online: bool
property provisioning_info: global___ProvisioningInfo
property latest_connection_attempt: global___NetworkInfo
property errors: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
HasField(field_name: Literal['latest_connection_attempt', b'latest_connection_attempt', 'provisioning_info', b'provisioning_info']) 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.provisioning.NetworkInfo(*, type: str = ..., ssid: str = ..., security: str = ..., signal: int = ..., connected: bool = ..., last_error: 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.

type: str
ssid: str
security: str
signal: int
connected: bool
last_error: str
class viam.proto.provisioning.ProvisioningInfo(*, fragment_id: str = ..., model: str = ..., manufacturer: 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.

fragment_id: str
model: str
manufacturer: str
class viam.proto.provisioning.SetNetworkCredentialsRequest(*, type: str = ..., ssid: str = ..., psk: 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.

type: str
ssid: str
psk: str
class viam.proto.provisioning.SetNetworkCredentialsResponse

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.provisioning.SetSmartMachineCredentialsRequest(*, cloud: global___CloudConfig | 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 cloud: global___CloudConfig
HasField(field_name: Literal['cloud', b'cloud']) 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.provisioning.SetSmartMachineCredentialsResponse

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.