Class ESPDevice

constructor

• new ESPDevice(deviceConfig: ESPDeviceInterface): ESPDevice

  Parameters

  • deviceConfig: ESPDeviceInterface

  Returns ESPDevice

OptionaladvertisementData

Optionalcapabilities

Optionalconnected

ESPProvisionAdapter

name

security

transport

Optionalusername

OptionalversionInfo

connect

• connect(): Promise<ESPConnectStatus>

  Connects to the device.

  Returns Promise<ESPConnectStatus>

  A promise that resolves to the provisioning response.

disconnect

• disconnect(): Promise<void>

  Disconnect the device.

  Returns Promise<void>

getDeviceCapabilities

• getDeviceCapabilities(): Promise<string[]>

  Gets the capabilities of the device.

  Returns Promise<string[]>

  A promise that resolves to an array of capabilities.

getDeviceVersionInfo

• getDeviceVersionInfo(): Promise<{ [key: string]: any }>

  Gets the version info of the device.

  Returns Promise<{ [key: string]: any }>

  A promise that resolves to an object containing version info.

initializeSession

• initializeSession(): Promise<boolean>

  Initialize session with the device.

  Returns Promise<boolean>

  A promise that resolves to a boolean indicating whether the session was successfully initialized.

initiateUserNodeMapping

• initiateUserNodeMapping(requestBody?: Record<string, any>): Promise<any>

  Initiates a user node mapping request.

  Parameters

  • OptionalrequestBody: Record<string, any>

    The request body for the user node mapping.

  Returns Promise<any>

  A promise that resolves to the response from the API.

provision

• provision(
      ssid: string,
      passphrase: string,
      onProgress: (message: ESPProvResponse) => void,
      groupId?: string,
  ): Promise<void>

  Provisions the device with the given Wi-Fi credentials.

  Parameters

  • ssid: string

    The SSID of the Wi-Fi network.
  • passphrase: string

    The passphrase of the Wi-Fi network.
  • onProgress: (message: ESPProvResponse) => void

    A callback function to report progress.
  • OptionalgroupId: string

    (optional) - The unique identifier of the group to which the node should be added.

  Returns Promise<void>

scanWifiList

• scanWifiList(): Promise<ESPWifiList[]>

  Scans for available Wi-Fi networks.

  Returns Promise<ESPWifiList[]>

  A promise that resolves to an array of Wi-Fi networks.

sendData

• sendData(endPoint: string, data: string): Promise<string>

  Sends data to the device.

  Parameters

  • endPoint: string

    The endpoint to send data to.
  • data: string

    The data to send.

  Returns Promise<string>

  A promise that resolves to the response data.

setNetworkCredentials

• setNetworkCredentials(
      ssid: string,
      passphrase: string,
  ): Promise<ESPProvisionStatus>

  Sets the network credentials for the device.

  Parameters

  • ssid: string

    The SSID of the Wi-Fi network.
  • passphrase: string

    The passphrase of the Wi-Fi network.

  Returns Promise<ESPProvisionStatus>

setProofOfPossession

• setProofOfPossession(proofOfPossession: string): Promise<boolean>

  Sets the proof of possession for the device.

  Parameters

  • proofOfPossession: string

    The proof of possession string.

  Returns Promise<boolean>

  A promise that resolves to a boolean indicating whether the proof of possession was successfully set.

startAssistedClaiming

• startAssistedClaiming(): Promise<void>

  Starts the assisted claiming process.

  Returns Promise<void>

verifyUserNodeMapping

• verifyUserNodeMapping(
      requestBody?: Record<string, any>,
  ): Promise<ESPAPIResponse>

  Verifies the mapping between a user and a node.

  Parameters

  • OptionalrequestBody: Record<string, any>

    The request body for the user node mapping verification.

  Returns Promise<ESPAPIResponse>

  A promise that resolves to the response from the API.