Interface ESPProvisionAdapterInterface

Represents the methods available for provisioning a device.

interface ESPProvisionAdapterInterface {
    connect(deviceName: string): Promise<ESPConnectStatus>;
    createESPDevice(
        name: string,
        transport: string,
        security?: number,
        proofOfPossession?: string,
        softAPPassword?: string,
        username?: string,
    ): Promise<ESPDeviceInterface>;
    disconnect(deviceName: string): Promise<void>;
    getDeviceCapabilities(deviceName: string): Promise<string[]>;
    getDeviceVersionInfo(deviceName: string): Promise<{ [key: string]: any }>;
    initializeSession(deviceName: string): Promise<boolean>;
    provision(
        deviceName: string,
        ssid: string,
        passphrase: string,
    ): Promise<ESPProvisionStatus>;
    resetWifiStatus(deviceName: string): Promise<boolean>;
    scanWifiList(deviceName: string): Promise<ESPWifiList[]>;
    searchESPDevices(
        devicePrefix: string,
        transport: ESPTransport,
    ): Promise<ESPDeviceInterface[]>;
    sendData(
        deviceName: string,
        endPoint: string,
        data: string,
    ): Promise<string>;
    setProofOfPossession(
        deviceName: string,
        proofOfPossession: string,
    ): Promise<boolean>;
    stopESPDevicesSearch(): Promise<void>;
}

Methods

connect createESPDevice disconnect getDeviceCapabilities getDeviceVersionInfo initializeSession provision resetWifiStatus? scanWifiList searchESPDevices sendData setProofOfPossession stopESPDevicesSearch

Methods

connect

createESPDevice

  • createESPDevice(
        name: string,
        transport: string,
        security?: number,
        proofOfPossession?: string,
        softAPPassword?: string,
        username?: string,
    ): Promise<ESPDeviceInterface>

    Parameters

    • name: string
    • transport: string
    • Optionalsecurity: number
    • OptionalproofOfPossession: string
    • OptionalsoftAPPassword: string
    • Optionalusername: string

    Returns Promise<ESPDeviceInterface>

disconnect

  • disconnect(deviceName: string): Promise<void>

    Parameters

    • deviceName: string

    Returns Promise<void>

getDeviceCapabilities

  • getDeviceCapabilities(deviceName: string): Promise<string[]>

    Parameters

    • deviceName: string

    Returns Promise<string[]>

getDeviceVersionInfo

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

    Parameters

    • deviceName: string

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

initializeSession

  • initializeSession(deviceName: string): Promise<boolean>

    Parameters

    • deviceName: string

    Returns Promise<boolean>

provision

OptionalresetWifiStatus

  • resetWifiStatus(deviceName: string): Promise<boolean>

    Clears the device's Wi-Fi state over the open provisioning session. Requires an established session; the user-node association is left intact.

    Optional so that adapters written against an earlier SDK keep compiling; ESPDevice.resetWifiStatus resolves false when it is absent.

    Parameters

    • deviceName: string

      Name of the connected provisioning device.

    Returns Promise<boolean>

    Promise resolving to true when the device acknowledged the reset.

scanWifiList

searchESPDevices

sendData

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

    Parameters

    • deviceName: string
    • endPoint: string
    • data: string

    Returns Promise<string>

setProofOfPossession

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

    Parameters

    • deviceName: string
    • proofOfPossession: string

    Returns Promise<boolean>

stopESPDevicesSearch

Settings

Member Visibility

On This Page

Methods