esp32-javascript › "wifi-events/modules/wifi-events/index"
- afterSuspend
- connectWifi
- convertBssidToArray
- convertBssidToString
- convertIPAddress
- createSoftAp
- getBssid
- getIPAddress
- resetWifiStatus
• wifi: Esp32JsWifi | undefined = undefined
Defined in wifi-events/modules/wifi-events/index.ts:38
▸ afterSuspend(evt: Esp32JsEventloopEvent, collected: function[]): boolean
Defined in wifi-events/modules/wifi-events/index.ts:152
Parameters:
| Name | Type |
|---|---|
evt |
Esp32JsEventloopEvent |
collected |
function[] |
Returns: boolean
▸ connectWifi(ssid: string, password: string, callback: function, bssid?: undefined | string): void
Defined in wifi-events/modules/wifi-events/index.ts:58
Connect to AP with given ssid and password.
Parameters:
▪ ssid: string
The ssid of the wifi network.
▪ password: string
The password of the wifi network.
▪ callback: function
A cb which gets the connect status updates.
▸ (event: Esp32JsWifiEvent, ip: string | undefined): void
Parameters:
| Name | Type |
|---|---|
event |
Esp32JsWifiEvent |
ip |
string | undefined |
▪Optional bssid: undefined | string
Optional bssid to pin to a specific AP.
Returns: void
▸ convertBssidToArray(bssid: string): [number, number, number, number, number, number] | undefined
Defined in wifi-events/modules/wifi-events/index.ts:117
Converts a bssid string representation in a 6 number array.
Parameters:
| Name | Type |
|---|---|
bssid |
string |
Returns: [number, number, number, number, number, number] | undefined
The bssid as 6 number array.
▸ convertBssidToString(bssid: [number, number, number, number, number, number]): string | undefined
Defined in wifi-events/modules/wifi-events/index.ts:100
Converts a 6 number array into a string representation of a BSSID.
Parameters:
| Name | Type |
|---|---|
bssid |
[number, number, number, number, number, number] |
Returns: string | undefined
The bssid as string representation.
▸ convertIPAddress(ip: number): string | undefined
Defined in wifi-events/modules/wifi-events/index.ts:130
Convert 32 bit number to ip address string.
Parameters:
| Name | Type |
|---|---|
ip |
number |
Returns: string | undefined
The ip address as string representation.
▸ createSoftAp(ssid: string, password: string, callback: function): void
Defined in wifi-events/modules/wifi-events/index.ts:79
Create soft AP with given ssid and password.
Parameters:
▪ ssid: string
The ssid of the wifi network.
▪ password: string
The password of the wifi network.
▪ callback: function
A cb which gets the connect status updates.
▸ (event: Esp32JsWifiEvent): void
Parameters:
| Name | Type |
|---|---|
event |
Esp32JsWifiEvent |
Returns: void
▸ getBssid(): string | undefined
Defined in wifi-events/modules/wifi-events/index.ts:92
Get the bssid of the current connected wifi AP as formatted as hex string.
Returns: string | undefined
The bssid.
▸ getIPAddress(): string | undefined
Defined in wifi-events/modules/wifi-events/index.ts:148
Get the ip address.
Returns: string | undefined
The ip address or undefined..
▸ resetWifiStatus(callback: function): Esp32JsWifi
Defined in wifi-events/modules/wifi-events/index.ts:40
Parameters:
▪ callback: function
▸ (event: Esp32JsWifiEvent, ip: string | undefined): void
Parameters:
| Name | Type |
|---|---|
event |
Esp32JsWifiEvent |
ip |
string | undefined |
Returns: Esp32JsWifi