Difference between revisions of "Component: WLAN (ESP32) (Comms: Networking)"
From Flowcode Help
Jump to navigationJump to searchLine 48: | Line 48: | ||
''<span style="color:red;">No additional examples</span>'' | ''<span style="color:red;">No additional examples</span>'' | ||
+ | |||
+ | |||
Line 53: | Line 55: | ||
==Macro reference== | ==Macro reference== | ||
+ | ===ReadIPString=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 66: | Line 69: | ||
+ | ===SocketConnect=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 89: | Line 93: | ||
+ | ===SocketListen=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 107: | Line 112: | ||
+ | ===ReadSSIDFromScan=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 125: | Line 131: | ||
+ | ===CreateAccessPoint=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 158: | Line 165: | ||
+ | ===ReadIP=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 176: | Line 184: | ||
+ | ===SocketWrite=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 199: | Line 208: | ||
+ | ===Disconnect=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 212: | Line 222: | ||
+ | ===ReadSignalStrengthFromScan=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 230: | Line 241: | ||
+ | ===ReadEncryptionModeFromScan=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 248: | Line 260: | ||
+ | ===ConnectToSSID=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 276: | Line 289: | ||
+ | ===SocketOpen=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 289: | Line 303: | ||
+ | ===SocketClose=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 302: | Line 317: | ||
+ | ===Uninitialise=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 315: | Line 331: | ||
+ | ===AcceptOpen=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 328: | Line 345: | ||
+ | ===ScanForSSID=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 341: | Line 359: | ||
+ | ===SocketRead=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 364: | Line 383: | ||
+ | ===AcceptClose=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- | ||
Line 377: | Line 397: | ||
+ | ===Initialise=== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
|- | |- |
Revision as of 11:53, 3 February 2023
Author | Matrix Ltd. |
Version | 2.4 |
Category | Comms: Networking |
Contents
- 1 WLAN (ESP32) component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 ReadIPString
- 5.2 SocketConnect
- 5.3 SocketListen
- 5.4 ReadSSIDFromScan
- 5.5 CreateAccessPoint
- 5.6 ReadIP
- 5.7 SocketWrite
- 5.8 Disconnect
- 5.9 ReadSignalStrengthFromScan
- 5.10 ReadEncryptionModeFromScan
- 5.11 ConnectToSSID
- 5.12 SocketOpen
- 5.13 SocketClose
- 5.14 Uninitialise
- 5.15 AcceptOpen
- 5.16 ScanForSSID
- 5.17 SocketRead
- 5.18 AcceptClose
- 5.19 Initialise
- 6 Property reference
WLAN (ESP32) component
Wireless LAN component designed to work with ESP32 modules
Component Source Code
Please click here to download the component source project: FC_Comp_Source_WLAN_ESP32.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_WLAN_ESP32.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
ReadIPString
ReadIPString | |
Collects the local IP address and returns it as an ASCII string. e.g. "192.168.0.1" | |
- STRING | Return |
SocketConnect
SocketConnect | |
- STRING | Address |
- UINT | Port |
- BYTE | Return |
SocketListen
SocketListen | |
Listen on, or bind, local port to already opened socket. Returns 1 if OK, 0 if fail | |
- UINT | Port |
- BYTE | Return |
ReadSSIDFromScan
ReadSSIDFromScan | |
Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first. | |
- BYTE | Index |
SSID Index | |
- STRING | Return |
CreateAccessPoint
ReadIP
SocketWrite
SocketWrite | |
- STRING | Buffer |
- UINT | Size |
- UINT | Return |
Disconnect
Disconnect | |
Attempts to disconnect from the SSID. | |
- BYTE | Return |
ReadSignalStrengthFromScan
ReadEncryptionModeFromScan
ConnectToSSID
SocketOpen
SocketOpen | |
Returns 1 if socket sucessfully opened | |
- BYTE | Return |
SocketClose
SocketClose | |
- VOID | Return |
Uninitialise
Uninitialise | |
Shuts down the WiFi system for low power operation. Returns 1 if successful Returns 0 if not | |
- BYTE | Return |
AcceptOpen
AcceptOpen | |
Returns 1 if there is an incoming connection on the listening port | |
- BYTE | Return |
ScanForSSID
SocketRead
SocketRead | |
- STRING | Buffer |
- UINT | Size |
- UINT | Return |
AcceptClose
AcceptClose | |
Close the socket associated with the Accepted incoming connection | |
- VOID | Return |
Initialise
Initialise | |
Initialise the WiFi system Returns 1 if successful Returns 0 if not | |
- BYTE | Return |
Property reference
Properties | |
Verbose Debug | |
Simulation | |
Network Interface | |
List of network interfaces connected to the PC. Sets which interface we are communicating via. | |
Console Data | |
Generate Console Data |