@espressif/rainmaker-base-cdf
    Preparing search index...

    Interface ESPCDFProvisionAdapterInterface

    Provisioning adapter interface exposed by native module bridge.

    interface ESPCDFProvisionAdapterInterface {
        connect(deviceName: string): Promise<ESPConnectStatus>;
        createESPDevice(
            deviceName: string,
            transport: string,
            security?: number,
            proofOfPossession?: string,
            softAPPassword?: string,
            username?: string,
        ): Promise<ESPCDFProvisioningDeviceInterface>;
        disconnect(deviceName: string): Promise<void>;
        getDeviceCapabilities(deviceName: string): Promise<string[]>;
        getDeviceVersionInfo(deviceName: string): Promise<Record<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<ESPCDFWifiNetwork[]>;
        searchESPDevices(
            devicePrefix: string,
            transport: string,
        ): Promise<ESPCDFProvisioningDeviceInterface[]>;
        sendData(
            deviceName: string,
            endPoint: string,
            data: string,
        ): Promise<string>;
        setProofOfPossession(
            deviceName: string,
            proofOfPossession: string,
        ): Promise<boolean>;
        stopESPDevicesSearch(): Promise<void>;
    }
    Index

    Methods

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

    Methods

    • Parameters

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

      Returns Promise<ESPCDFProvisioningDeviceInterface>

    • Parameters

      • deviceName: string

      Returns Promise<void>

    • Parameters

      • deviceName: string

      Returns Promise<string[]>

    • Parameters

      • deviceName: string

      Returns Promise<Record<string, any>>

    • Parameters

      • deviceName: string

      Returns Promise<boolean>

    • Clear the device's Wi-Fi state over the open provisioning session. Requires an established session; leaves the user-node association intact.

      Optional so adapters written against an earlier release keep compiling — same choice as the RainMaker and RainMaker Neo SDKs.

      Parameters

      • deviceName: string

        Name of the connected provisioning device.

      Returns Promise<boolean>

      Promise resolving to true when the device acknowledged the reset.

    • Parameters

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

      Returns Promise<string>

    • Parameters

      • deviceName: string
      • proofOfPossession: string

      Returns Promise<boolean>

    Settings

    Member Visibility

    On This Page

    Methods