@espressif/rainmaker-base-cdf
Preparing search index...
types
ESPProvisionAdapterInterface
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
connect
create
ESP
Device
disconnect
get
Device
Capabilities
get
Device
Version
Info
initialize
Session
provision
scan
Wifi
List
search
ESP
Devices
send
Data
set
Proof
Of
Possession
stop
ESP
Devices
Search
Methods
connect
connect
(
deviceName
:
string
)
:
Promise
<
ESPConnectStatus
>
Parameters
deviceName
:
string
Returns
Promise
<
ESPConnectStatus
>
create
ESP
Device
createESPDevice
(
name
:
string
,
transport
:
string
,
security
?:
number
,
proofOfPossession
?:
string
,
softAPPassword
?:
string
,
username
?:
string
,
)
:
Promise
<
ESPDeviceInterface
>
Parameters
name
:
string
transport
:
string
Optional
security
:
number
Optional
proofOfPossession
:
string
Optional
softAPPassword
:
string
Optional
username
:
string
Returns
Promise
<
ESPDeviceInterface
>
disconnect
disconnect
(
deviceName
:
string
)
:
Promise
<
void
>
Parameters
deviceName
:
string
Returns
Promise
<
void
>
get
Device
Capabilities
getDeviceCapabilities
(
deviceName
:
string
)
:
Promise
<
string
[]
>
Parameters
deviceName
:
string
Returns
Promise
<
string
[]
>
get
Device
Version
Info
getDeviceVersionInfo
(
deviceName
:
string
)
:
Promise
<
{
[
key
:
string
]:
any
}
>
Parameters
deviceName
:
string
Returns
Promise
<
{
[
key
:
string
]:
any
}
>
initialize
Session
initializeSession
(
deviceName
:
string
)
:
Promise
<
boolean
>
Parameters
deviceName
:
string
Returns
Promise
<
boolean
>
provision
provision
(
deviceName
:
string
,
ssid
:
string
,
passphrase
:
string
,
)
:
Promise
<
ESPProvisionStatus
>
Parameters
deviceName
:
string
ssid
:
string
passphrase
:
string
Returns
Promise
<
ESPProvisionStatus
>
scan
Wifi
List
scanWifiList
(
deviceName
:
string
)
:
Promise
<
ESPWifiList
[]
>
Parameters
deviceName
:
string
Returns
Promise
<
ESPWifiList
[]
>
search
ESP
Devices
searchESPDevices
(
devicePrefix
:
string
,
transport
:
ESPTransport
,
)
:
Promise
<
ESPDeviceInterface
[]
>
Parameters
devicePrefix
:
string
transport
:
ESPTransport
Returns
Promise
<
ESPDeviceInterface
[]
>
send
Data
sendData
(
deviceName
:
string
,
endPoint
:
string
,
data
:
string
)
:
Promise
<
string
>
Parameters
deviceName
:
string
endPoint
:
string
data
:
string
Returns
Promise
<
string
>
set
Proof
Of
Possession
setProofOfPossession
(
deviceName
:
string
,
proofOfPossession
:
string
,
)
:
Promise
<
boolean
>
Parameters
deviceName
:
string
proofOfPossession
:
string
Returns
Promise
<
boolean
>
stop
ESP
Devices
Search
stopESPDevicesSearch
()
:
Promise
<
void
>
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
connect
create
ESP
Device
disconnect
get
Device
Capabilities
get
Device
Version
Info
initialize
Session
provision
scan
Wifi
List
search
ESP
Devices
send
Data
set
Proof
Of
Possession
stop
ESP
Devices
Search
@espressif/rainmaker-base-cdf
Loading...
Represents the methods available for provisioning a device.