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

    Interface ESPCDFProvisioningDeviceOperations

    Provisioning device operations interface Defines all methods available on a provisioning device

    interface ESPCDFProvisioningDeviceOperations {
        checkChallengeResponseSupport(): Promise<boolean>;
        checkOnNetworkProvisioning?(): Promise<boolean>;
        connect(): Promise<boolean>;
        disconnect(): Promise<void>;
        getDeviceCapabilities(): Promise<string[]>;
        getDeviceVersionInfo(): Promise<Record<string, any>>;
        initializeSession(): Promise<boolean>;
        initiateUserNodeMapping(
            params?: Record<string, any>,
        ): Promise<ESPCDFUserNodeMappingResponse>;
        provision(
            ssid: string,
            password: string,
            onProgress?: ESPCDFProvisionProgressCallback,
            homeId?: string,
            provisionType?: string,
            options?: Record<string, any>,
        ): Promise<void>;
        scanWifiList(): Promise<ESPCDFWifiNetwork[]>;
        sendData(endPoint: string, data: string): Promise<string>;
        setNetworkCredentials(ssid: string, password: string): Promise<number>;
        setProofOfPossession(pop: string): Promise<boolean>;
        startAssistedClaiming(
            onProgress?: Function,
            claimCapability?: string,
        ): Promise<void>;
        verifyUserNodeMapping(
            params: ESPCDFChallengeResponseVerificationRequest,
        ): Promise<ESPCDFUserNodeMappingResponse>;
    }
    Index

    Methods

    checkChallengeResponseSupport checkOnNetworkProvisioning? connect disconnect getDeviceCapabilities getDeviceVersionInfo initializeSession initiateUserNodeMapping provision scanWifiList sendData setNetworkCredentials setProofOfPossession startAssistedClaiming verifyUserNodeMapping

    Methods

    • Check if challenge-response support is available

      Returns Promise<boolean>

      Promise resolving to boolean indicating support

    • Check whether this device represents an "on-network" target (already on the user's Wi-Fi, discovered via mDNS). Used by useProvision to pick the LAN-HTTP challenge-response flow vs. the BLE/SoftAP Wi-Fi flow — same dispatch pattern as checkChallengeResponseSupport for chal-resp vs. MQTT.

      Optional: adaptors / device transformers that don't construct on-network provisioning devices may omit this method; the entity wrapper defaults to false.

      Returns Promise<boolean>

      Promise resolving to true for on-network devices, false otherwise.

    • Connect to the device

      Returns Promise<boolean>

      Promise resolving to connection status

    • Disconnect from the device

      Returns Promise<void>

      Promise resolving when disconnected

    • Get device capabilities

      Returns Promise<string[]>

      Promise resolving to array of capability strings

    • Get device version information

      Returns Promise<Record<string, any>>

      Promise resolving to version info object

    • Initialize session with the device

      Returns Promise<boolean>

      Promise resolving to boolean indicating success

    • Provision device with WiFi credentials (traditional flow)

      Parameters

      • ssid: string

        WiFi SSID

      • password: string

        WiFi password

      • OptionalonProgress: ESPCDFProvisionProgressCallback

        Optional progress callback

      • OptionalhomeId: string

        Optional home/group ID for node association

      • OptionalprovisionType: string

        Optional provision type (challenge-response or mqtt)

      • Optionaloptions: Record<string, any>

      Returns Promise<void>

      Promise resolving when provisioning completes

    • Send data to the device

      Parameters

      • endPoint: string

        End point

      • data: string

        Data to send

      Returns Promise<string>

      Promise resolving to the response

    • Set network credentials directly (for challenge-response flow)

      Parameters

      • ssid: string

        WiFi SSID

      • password: string

        WiFi password

      Returns Promise<number>

      Promise resolving to status code (0 = success)

    • Set proof of possession (POP) code

      Parameters

      • pop: string

        The POP code string

      Returns Promise<boolean>

      Promise resolving to boolean indicating success

    • Start assisted claiming

      Parameters

      • OptionalonProgress: Function

        Optional progress callback

      • OptionalclaimCapability: string

        Optional claim capability

      Returns Promise<void>

      Promise resolving when claiming completes

    Settings

    Member Visibility

    On This Page

    Methods