Difference between revisions of "Component: WLAN (ESP32) (Comms: Networking)"
From Flowcode Help
Jump to navigationJump to searchLine 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
− | Please click here to download the component source project: [https://www.flowcode.co.uk/ | + | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WLAN_ESP32.fcfx FC_Comp_Source_WLAN_ESP32.fcfx] |
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WLAN_ESP32.fcfx FC_Comp_Source_WLAN_ESP32.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WLAN_ESP32.fcfx FC_Comp_Source_WLAN_ESP32.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
+ | |||
+ | |||
Line 32: | Line 34: | ||
==Examples== | ==Examples== | ||
+ | |||
+ | |||
Line 42: | Line 46: | ||
==Macro reference== | ==Macro reference== | ||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadIPString''' | ||
+ | |- | ||
+ | | colspan="2" | Collects the local IP address and returns it as an ASCII string. e.g. "192.168.0.1" | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketConnect''' | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Address | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | Port | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketListen''' | ||
+ | |- | ||
+ | | colspan="2" | Listen on, or bind, local port to already opened socket. Returns 1 if OK, 0 if fail | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | Port | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadSSIDFromScan''' | ||
+ | |- | ||
+ | | colspan="2" | Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Index | ||
+ | |- | ||
+ | | colspan="2" | SSID Index | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateAccessPoint''' | ||
+ | |- | ||
+ | | colspan="2" | Sets up the wireless LAN module into AP mode to host a wireless network. Other WIFI enabled devices can then connect to the module. Returns 1 for success. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | SSID | ||
+ | |- | ||
+ | | colspan="2" | Name of the wireless network to create | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Password | ||
+ | |- | ||
+ | | colspan="2" | Password used to gain access to the network | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Channel | ||
+ | |- | ||
+ | | colspan="2" | 802.11 Channel Range 1-14 | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Encryption | ||
+ | |- | ||
+ | | colspan="2" | 0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadIP''' | ||
+ | |- | ||
+ | | colspan="2" | Collects a single byte from the local IP address. For example 192.168.0.1 Index = 3 : Return = 192 / Index = 0 : Return = 1 | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Index | ||
+ | |- | ||
+ | | colspan="2" | Range: 0 to 3 Where 3 = the first number and 0 = the last number | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketWrite''' | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Buffer | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | Size | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Disconnect''' | ||
+ | |- | ||
+ | | colspan="2" | Attempts to disconnect from the SSID. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadSignalStrengthFromScan''' | ||
+ | |- | ||
+ | | colspan="2" | Collects the signal strength from the last SSID Scan. The ScanForSSID macro must be called first. Value returned is in negative dB, smaller value = better signal | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Index | ||
+ | |- | ||
+ | | colspan="2" | SSID Index | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ReadEncryptionModeFromScan''' | ||
+ | |- | ||
+ | | colspan="2" | Collects one of the encryption modes from the last SSID Scan. The ScanForSSID macro must be called first. 0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Index | ||
+ | |- | ||
+ | | colspan="2" | SSID Index | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ConnectToSSID''' | ||
+ | |- | ||
+ | | colspan="2" | Attempts to connect to the given SSID and Key values. Returns 1 if the SSID has been connected. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | SSID | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Key | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" | Timeout | ||
+ | |- | ||
+ | | colspan="2" | Number of seconds to wait for the connection, default 20 | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketOpen''' | ||
+ | |- | ||
+ | | colspan="2" | Returns 1 if socket sucessfully opened | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketClose''' | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Uninitialise''' | ||
+ | |- | ||
+ | | colspan="2" | Shuts down the WiFi system for low power operation. Returns 1 if successful Returns 0 if not | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptOpen''' | ||
+ | |- | ||
+ | | colspan="2" | Returns 1 if there is an incoming connection on the listening port | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''ScanForSSID''' | ||
+ | |- | ||
+ | | colspan="2" | Checks for wireless networks in the local area which are broadcasting their SSID. Must not be connected to a network to allow this to function. Returns the number of wireless networks found, max 8. | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SocketRead''' | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
+ | | width="90%" | Buffer | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" | Size | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''AcceptClose''' | ||
+ | |- | ||
+ | | colspan="2" | Close the socket associated with the Accepted incoming connection | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise''' | ||
+ | |- | ||
+ | | colspan="2" | Initialise the WiFi system Returns 1 if successful Returns 0 if not | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
+ | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
+ | |} | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ==Property reference== | ||
+ | |||
+ | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | ||
+ | | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
+ | | width="90%" | Verbose Debug | ||
+ | |- | ||
+ | | colspan="2" | | ||
+ | |- | ||
+ | | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | ||
+ | | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation | ||
+ | |- | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
+ | | width="90%" | Network Interface | ||
+ | |- | ||
+ | | colspan="2" | List of network interfaces connected to the PC. Sets which interface we are communicating via. | ||
+ | |- | ||
+ | | width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | ||
+ | | width="90%" | Console Data | ||
+ | |- | ||
+ | | colspan="2" | Generate Console Data | ||
+ | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |
Revision as of 10:00, 27 January 2023
Author | Matrix Ltd. |
Version | 2.4 |
Category | Comms: Networking |
Contents
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 |
Collects the local IP address and returns it as an ASCII string. e.g. "192.168.0.1" | |
![]() |
Return |
![]() |
SocketConnect |
![]() |
Address |
![]() |
Port |
![]() |
Return |
![]() |
SocketListen |
Listen on, or bind, local port to already opened socket. Returns 1 if OK, 0 if fail | |
![]() |
Port |
![]() |
Return |
![]() |
ReadSSIDFromScan |
Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first. | |
![]() |
Index |
SSID Index | |
![]() |
Return |
![]() |
SocketWrite |
![]() |
Buffer |
![]() |
Size |
![]() |
Return |
![]() |
Disconnect |
Attempts to disconnect from the SSID. | |
![]() |
Return |
![]() |
SocketOpen |
Returns 1 if socket sucessfully opened | |
![]() |
Return |
![]() |
SocketClose |
![]() |
Return |
![]() |
Uninitialise |
Shuts down the WiFi system for low power operation. Returns 1 if successful Returns 0 if not | |
![]() |
Return |
![]() |
AcceptOpen |
Returns 1 if there is an incoming connection on the listening port | |
![]() |
Return |
![]() |
SocketRead |
![]() |
Buffer |
![]() |
Size |
![]() |
Return |
![]() |
AcceptClose |
Close the socket associated with the Accepted incoming connection | |
![]() |
Return |
![]() |
Initialise |
Initialise the WiFi system Returns 1 if successful Returns 0 if not | |
![]() |
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 |
==Macro reference==
![]() |
ReadIPString |
Collects the local IP address and returns it as an ASCII string. e.g. "192.168.0.1" | |
![]() |
Return |
![]() |
SocketConnect |
![]() |
Address |
![]() |
Port |
![]() |
Return |
![]() |
SocketListen |
Listen on, or bind, local port to already opened socket. Returns 1 if OK, 0 if fail | |
![]() |
Port |
![]() |
Return |
![]() |
ReadSSIDFromScan |
Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first. | |
![]() |
Index |
SSID Index | |
![]() |
Return |
![]() |
SocketWrite |
![]() |
Buffer |
![]() |
Size |
![]() |
Return |
![]() |
Disconnect |
Attempts to disconnect from the SSID. | |
![]() |
Return |
![]() |
SocketOpen |
Returns 1 if socket sucessfully opened | |
![]() |
Return |
![]() |
SocketClose |
![]() |
Return |
![]() |
Uninitialise |
Shuts down the WiFi system for low power operation. Returns 1 if successful Returns 0 if not | |
![]() |
Return |
![]() |
AcceptOpen |
Returns 1 if there is an incoming connection on the listening port | |
![]() |
Return |
![]() |
SocketRead |
![]() |
Buffer |
![]() |
Size |
![]() |
Return |
![]() |
AcceptClose |
Close the socket associated with the Accepted incoming connection | |
![]() |
Return |
![]() |
Initialise |
Initialise the WiFi system Returns 1 if successful Returns 0 if not | |
![]() |
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 |
==Macro reference==
![]() |
ReadIPString |
Collects the local IP address and returns it as an ASCII string. e.g. "192.168.0.1" | |
![]() |
Return |
![]() |
SocketConnect |
![]() |
Address |
![]() |
Port |
![]() |
Return |
![]() |
SocketListen |
Listen on, or bind, local port to already opened socket. Returns 1 if OK, 0 if fail | |
![]() |
Port |
![]() |
Return |
![]() |
ReadSSIDFromScan |
Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first. | |
![]() |
Index |
SSID Index | |
![]() |
Return |
![]() |
SocketWrite |
![]() |
Buffer |
![]() |
Size |
![]() |
Return |
![]() |
Disconnect |
Attempts to disconnect from the SSID. | |
![]() |
Return |
![]() |
SocketOpen |
Returns 1 if socket sucessfully opened | |
![]() |
Return |
![]() |
SocketClose |
![]() |
Return |
![]() |
Uninitialise |
Shuts down the WiFi system for low power operation. Returns 1 if successful Returns 0 if not | |
![]() |
Return |
![]() |
AcceptOpen |
Returns 1 if there is an incoming connection on the listening port | |
![]() |
Return |
![]() |
SocketRead |
![]() |
Buffer |
![]() |
Size |
![]() |
Return |
![]() |
AcceptClose |
Close the socket associated with the Accepted incoming connection | |
![]() |
Return |
![]() |
Initialise |
Initialise the WiFi system Returns 1 if successful Returns 0 if not | |
![]() |
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 |
==Macro reference==
![]() |
ReadIPString |
Collects the local IP address and returns it as an ASCII string. e.g. "192.168.0.1" | |
![]() |
Return |
![]() |
SocketConnect |
![]() |
Address |
![]() |
Port |
![]() |
Return |
![]() |
SocketListen |
Listen on, or bind, local port to already opened socket. Returns 1 if OK, 0 if fail | |
![]() |
Port |
![]() |
Return |
![]() |
ReadSSIDFromScan |
Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first. | |
![]() |
Index |
SSID Index | |
![]() |
Return |
![]() |
SocketWrite |
![]() |
Buffer |
![]() |
Size |
![]() |
Return |
![]() |
Disconnect |
Attempts to disconnect from the SSID. | |
![]() |
Return |
![]() |
SocketOpen |
Returns 1 if socket sucessfully opened | |
![]() |
Return |
![]() |
SocketClose |
![]() |
Return |
![]() |
Uninitialise |
Shuts down the WiFi system for low power operation. Returns 1 if successful Returns 0 if not | |
![]() |
Return |
![]() |
AcceptOpen |
Returns 1 if there is an incoming connection on the listening port | |
![]() |
Return |
![]() |
SocketRead |
![]() |
Buffer |
![]() |
Size |
![]() |
Return |
![]() |
AcceptClose |
Close the socket associated with the Accepted incoming connection | |
![]() |
Return |
![]() |
Initialise |
Initialise the WiFi system Returns 1 if successful Returns 0 if not | |
![]() |
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 |