:py:mod:`viam.proto.provisioning`
=================================

.. py:module:: viam.proto.provisioning

.. autoapi-nested-parse::

   @generated by Viam.
   Do not edit manually!



Package Contents
----------------

Classes
~~~~~~~

.. autoapisummary::

   viam.proto.provisioning.ProvisioningServiceBase
   viam.proto.provisioning.ProvisioningServiceStub
   viam.proto.provisioning.UnimplementedProvisioningServiceBase
   viam.proto.provisioning.CloudConfig
   viam.proto.provisioning.GetNetworkListRequest
   viam.proto.provisioning.GetNetworkListResponse
   viam.proto.provisioning.GetSmartMachineStatusRequest
   viam.proto.provisioning.GetSmartMachineStatusResponse
   viam.proto.provisioning.NetworkInfo
   viam.proto.provisioning.ProvisioningInfo
   viam.proto.provisioning.SetNetworkCredentialsRequest
   viam.proto.provisioning.SetNetworkCredentialsResponse
   viam.proto.provisioning.SetSmartMachineCredentialsRequest
   viam.proto.provisioning.SetSmartMachineCredentialsResponse




.. py:class:: ProvisioningServiceBase


   Bases: :py:obj:`abc.ABC`

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

   .. py:method:: GetSmartMachineStatus(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.GetSmartMachineStatusRequest, provisioning.v1.provisioning_pb2.GetSmartMachineStatusResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: SetNetworkCredentials(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.SetNetworkCredentialsRequest, provisioning.v1.provisioning_pb2.SetNetworkCredentialsResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: SetSmartMachineCredentials(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsRequest, provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: GetNetworkList(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.GetNetworkListRequest, provisioning.v1.provisioning_pb2.GetNetworkListResponse]) -> None
      :abstractmethod:
      :async:


   .. py:method:: __mapping__() -> Dict[str, grpclib.const.Handler]



.. py:class:: ProvisioningServiceStub(channel: grpclib.client.Channel)



.. py:class:: UnimplementedProvisioningServiceBase


   Bases: :py:obj:`ProvisioningServiceBase`

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

   .. py:method:: GetSmartMachineStatus(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.GetSmartMachineStatusRequest, provisioning.v1.provisioning_pb2.GetSmartMachineStatusResponse]) -> None
      :async:


   .. py:method:: SetNetworkCredentials(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.SetNetworkCredentialsRequest, provisioning.v1.provisioning_pb2.SetNetworkCredentialsResponse]) -> None
      :async:


   .. py:method:: SetSmartMachineCredentials(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsRequest, provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsResponse]) -> None
      :async:


   .. py:method:: GetNetworkList(stream: grpclib.server.Stream[provisioning.v1.provisioning_pb2.GetNetworkListRequest, provisioning.v1.provisioning_pb2.GetNetworkListResponse]) -> None
      :async:



.. py:class:: CloudConfig(*, id: str = ..., secret: str = ..., app_address: str = ...)


   Bases: :py:obj:`google.protobuf.message.Message`

   minimal CloudConfig to create /etc/viam.json

   .. py:attribute:: id
      :type: str

      SmartMachine part id

   .. py:attribute:: secret
      :type: str

      SmartMachine part secret

   .. py:attribute:: app_address
      :type: str

      


.. py:class:: GetNetworkListRequest


   Bases: :py:obj:`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.


.. py:class:: GetNetworkListResponse(*, networks: collections.abc.Iterable[global___NetworkInfo] | None = ...)


   Bases: :py:obj:`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.

   .. py:property:: networks
      :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___NetworkInfo]



.. py:class:: GetSmartMachineStatusRequest


   Bases: :py:obj:`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.


.. py:class:: 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: :py:obj:`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.

   .. py:property:: provisioning_info
      :type: global___ProvisioningInfo


   .. py:property:: latest_connection_attempt
      :type: global___NetworkInfo


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


   .. py:attribute:: has_smart_machine_credentials
      :type: bool

      

   .. py:attribute:: is_online
      :type: bool

      

   .. py:method:: 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, :exc:`ValueError` will
      be raised.

      :param field_name: The name of the field to check for presence.
      :type field_name: str

      :returns: Whether a value has been set for the named field.
      :rtype: bool

      :raises ValueError: if the `field_name` is not a member of this message.



.. py:class:: NetworkInfo(*, type: str = ..., ssid: str = ..., security: str = ..., signal: int = ..., connected: bool = ..., last_error: str = ...)


   Bases: :py:obj:`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.

   .. py:attribute:: type
      :type: str

      

   .. py:attribute:: ssid
      :type: str

      

   .. py:attribute:: security
      :type: str

      

   .. py:attribute:: signal
      :type: int

      

   .. py:attribute:: connected
      :type: bool

      

   .. py:attribute:: last_error
      :type: str

      


.. py:class:: ProvisioningInfo(*, fragment_id: str = ..., model: str = ..., manufacturer: str = ...)


   Bases: :py:obj:`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.

   .. py:attribute:: fragment_id
      :type: str

      

   .. py:attribute:: model
      :type: str

      

   .. py:attribute:: manufacturer
      :type: str

      


.. py:class:: SetNetworkCredentialsRequest(*, type: str = ..., ssid: str = ..., psk: str = ...)


   Bases: :py:obj:`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.

   .. py:attribute:: type
      :type: str

      

   .. py:attribute:: ssid
      :type: str

      

   .. py:attribute:: psk
      :type: str

      


.. py:class:: SetNetworkCredentialsResponse


   Bases: :py:obj:`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.


.. py:class:: SetSmartMachineCredentialsRequest(*, cloud: global___CloudConfig | None = ...)


   Bases: :py:obj:`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.

   .. py:property:: cloud
      :type: global___CloudConfig


   .. py:method:: 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, :exc:`ValueError` will
      be raised.

      :param field_name: The name of the field to check for presence.
      :type field_name: str

      :returns: Whether a value has been set for the named field.
      :rtype: bool

      :raises ValueError: if the `field_name` is not a member of this message.



.. py:class:: SetSmartMachineCredentialsResponse


   Bases: :py:obj:`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.