viam.proto.provisioning

@generated by Viam. Do not edit manually!

Package Contents

Classes

ProvisioningServiceBase	Helper class that provides a standard way to create an ABC using
ProvisioningServiceStub
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.

class viam.proto.provisioning.ProvisioningServiceBase

Bases: abc.ABC

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

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

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

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

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

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

class viam.proto.provisioning.ProvisioningServiceStub(channel: grpclib.client.Channel)

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.

property provisioning_info: global___ProvisioningInfo

property latest_connection_attempt: global___NetworkInfo

property errors: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

has_smart_machine_credentials: bool

is_online: bool

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.