Interface ESPProvisionAdapterInterface
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>;} Methods
createESPDevice
- createESPDevice(
name: string,
transport: string,
security?: number,
proofOfPossession?: string,
softAPPassword?: string,
username?: string,
): Promise<ESPDeviceInterface> Parameters
- name: string
- transport: string
Optional
security: numberOptional
proofOfPossession: stringOptional
softAPPassword: stringOptional
username: string
disconnect
- disconnect(deviceName: string): Promise<void>
Returns Promise<void>
getDeviceCapabilities
- getDeviceCapabilities(deviceName: string): Promise<string[]>
Returns Promise<string[]>
getDeviceVersionInfo
- getDeviceVersionInfo(deviceName: string): Promise<{ [key: string]: any }>
Returns Promise<{ [key: string]: any }>
initializeSession
- initializeSession(deviceName: string): Promise<boolean>
Returns Promise<boolean>
provision
- provision(
deviceName: string,
ssid: string,
passphrase: string,
): Promise<ESPProvisionStatus> Parameters
- deviceName: string
- ssid: string
- passphrase: string
scanWifiList
- scanWifiList(deviceName: string): Promise<ESPWifiList[]>
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
- stopESPDevicesSearch(): Promise<void>
Returns Promise<void>
Represents the methods available for provisioning a device.