Class ESPCDFProvisioningDevice

constructor

• new ESPCDFProvisioningDevice(
      deviceData: ESPCDFProvisioningDeviceInterface,
  ): ESPCDFProvisioningDevice

  Parameters

  • deviceData: ESPCDFProvisioningDeviceInterface

  Returns ESPCDFProvisioningDevice

Optional_raw

OptionaladvertisementData

Optionalcapabilities

Optionalconnected

name

operations

security

transport

Optionalusername

OptionalversionInfo

checkChallengeResponseSupport

• checkChallengeResponseSupport(): Promise<boolean>

  Check if challenge-response support is available

  Returns Promise<boolean>

checkOnNetworkProvisioning

• checkOnNetworkProvisioning(): Promise<boolean>

  Indicates whether this device is in "on-network" provisioning mode (already on the user's Wi-Fi, talked to via LAN HTTP at the chal-resp endpoint). Same dispatch pattern as checkChallengeResponseSupport — useProvision calls this to decide which stage list to render and which addDevice variant to invoke.

  Defaults to false for adaptors that do not implement the operation, so existing BLE / SoftAP transformers don't need any change.

  Returns Promise<boolean>

  true for mDNS-discovered on-network devices, else false.

connect

• connect(): Promise<boolean>

  Connect to the device

  Returns Promise<boolean>

disconnect

• disconnect(): Promise<void>

  Disconnect from the device

  Returns Promise<void>

getDeviceCapabilities

• getDeviceCapabilities(): Promise<string[]>

  Get device capabilities

  Returns Promise<string[]>

getDeviceVersionInfo

• getDeviceVersionInfo(): Promise<Record<string, any>>

  Get device version information

  Returns Promise<Record<string, any>>

initializeSession

• initializeSession(): Promise<boolean>

  Initialize session with the device

  Returns Promise<boolean>

initiateUserNodeMapping

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

  Initiate user-node mapping (challenge-response flow)

  Parameters

  • Optionalparams: Record<string, any>

  Returns Promise<ESPCDFUserNodeMappingResponse>

provision

• provision(
      ssid: string,
      password: string,
      onProgress?: ESPCDFProvisionProgressCallback,
      homeId?: string,
  ): Promise<void>

  Provision device with WiFi credentials (traditional flow)

  Parameters

  • ssid: string
  • password: string
  • OptionalonProgress: ESPCDFProvisionProgressCallback
  • OptionalhomeId: string

  Returns Promise<void>

resetWifiStatus

• resetWifiStatus(): Promise<boolean>

  Clear the device's Wi-Fi state over the open provisioning session.

  Only the Wi-Fi credentials are cleared — the user-node association survives, which is what lets retryNetworkCredentials resume rather than re-provision from scratch.

  Resolves false when the adaptor does not implement it, so callers can treat "not supported" and "device refused" the same way.

  Returns Promise<boolean>

  true when the device acknowledged the reset.

retryNetworkCredentials

• retryNetworkCredentials(
      ssid: string,
      password: string,
      onProgress?: ESPCDFProvisionProgressCallback,
  ): Promise<void>

  Re-send Wi-Fi credentials after resetWifiStatus, resuming the flow the first attempt started instead of repeating its association.

  Parameters

  • ssid: string

    Wi-Fi SSID, unchanged from the first attempt.

  • password: string

    The corrected Wi-Fi password.

  • OptionalonProgress: ESPCDFProvisionProgressCallback

    Progress callback; emits the same messages as provision.

  Returns Promise<void>

  Throws

  When the adaptor cannot resume a provisioning flow.

scanWifiList

• scanWifiList(): Promise<ESPCDFWifiNetwork[]>

  Scan for available WiFi networks

  Returns Promise<ESPCDFWifiNetwork[]>

sendData

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

  Send data to the device

  Parameters

  • endPoint: string
  • data: string

  Returns Promise<string>

setNetworkCredentials

• setNetworkCredentials(ssid: string, password: string): Promise<number>

  Set network credentials directly (for challenge-response flow)

  Parameters

  • ssid: string
  • password: string

  Returns Promise<number>

setProofOfPossession

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

  Set proof of possession (POP) code

  Parameters

  • pop: string

  Returns Promise<boolean>

startAssistedClaiming

• startAssistedClaiming(
      onProgress?: Function,
      claimCapability?: string,
  ): Promise<void>

  Start assisted claiming

  Parameters

  • OptionalonProgress: Function
  • OptionalclaimCapability: string

  Returns Promise<void>

verifyUserNodeMapping

• verifyUserNodeMapping(
      params: ESPCDFChallengeResponseVerificationRequest,
  ): Promise<ESPCDFUserNodeMappingResponse>

  Verify user-node mapping (challenge-response flow)

  Parameters

  • params: ESPCDFChallengeResponseVerificationRequest

  Returns Promise<ESPCDFUserNodeMappingResponse>