Class ProvisioningClient

Index

Constructors

Methods

getNetworkList getSmartMachineStatus setNetworkCredentials setSmartMachineCredentials

Constructors

constructor

new ProvisioningClient(transport: Transport): ProvisioningClient
Parameters
- transport: Transport
Returns ProvisioningClient

Methods

getNetworkList

getNetworkList(): Promise<NetworkInfo[]>
Get the networks that are visible to the Smart Machine.

Returns Promise<NetworkInfo[]>
A list of networks

getSmartMachineStatus

getSmartMachineStatus(): Promise<GetSmartMachineStatusResponse>
Get the status of the Smart Machine.

Returns Promise<GetSmartMachineStatusResponse>
The Smart Machine status

setNetworkCredentials

setNetworkCredentials(type: string, ssid: string, psk: string): Promise<void>
Set the network credentials of the Smart Machine, so it can connect to the internet.
Parameters
- type: string
  The type of network
- ssid: string
  The SSID of the network
- psk: string
  The network's passkey
Returns Promise<void>

setSmartMachineCredentials

setSmartMachineCredentials(cloud?: CloudConfig): Promise<void>
Set the Viam credentials of the smart machine credentials, so it connect to the Cloud.
Parameters
- Optionalcloud: CloudConfig
  The configuration of the Cloud
Returns Promise<void>