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

    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>;
        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>;
    }
    Index

    Methods

    • Parameters

      • deviceName: string

      Returns Promise<ESPConnectStatus>

    • Parameters

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

      Returns Promise<ESPDeviceInterface>

    • Parameters

      • deviceName: string

      Returns Promise<void>

    • Parameters

      • deviceName: string

      Returns Promise<string[]>

    • Parameters

      • deviceName: string

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

    • Parameters

      • deviceName: string

      Returns Promise<boolean>

    • Parameters

      • deviceName: string
      • ssid: string
      • passphrase: string

      Returns Promise<ESPProvisionStatus>

    • Parameters

      • deviceName: string

      Returns Promise<ESPWifiList[]>

    • Parameters

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

      Returns Promise<string>

    • Parameters

      • deviceName: string
      • proofOfPossession: string

      Returns Promise<boolean>

    • Returns Promise<void>