View source for Component: WLAN ESP32 (Dummy) (ESP32) (Comms: Networking)

From Flowcode Help

← Component: WLAN ESP32 (Dummy) (ESP32) (Comms: Networking)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd. |- | width="20%" style="color:gray;" | Version | 2.3 |- | width="20%" style="color:gray;" | Category | Comms: Networking |} ==WLAN ESP32 (Dummy) component== Wireless LAN component designed to work with ESP32 modules ==Component Source Code== Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/WLAN_ESP32_Dummy.fcfx FC_Comp_Source_temp/WLAN_ESP32_Dummy.fcfx] Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/WLAN_ESP32_Dummy.fcfx FC_Comp_Source_temp/WLAN_ESP32_Dummy.fcfx] ==Detailed description== ''No detailed description exists yet for this component'' ==Examples== Here is an example Flowcode program to send analogue data to a html web page. The web page is set up to refresh every second Instructions on how to change the refresh rate and access the web page is explained within the example file. {{Fcfile|ESP Webpage.fcfx|ESP Webpage}} ==Macro reference== ===AcceptClose=== {| 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'' |} ===AcceptOpen=== {| 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'' |} ===ConnectToSSID=== {| 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'' |} ===CreateAccessPoint=== {| 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'' |} ===Initialise=== {| 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'' |} ===ReadEncryptionModeFromScan=== {| 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'' |} ===ReadIP=== {| 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 the local IP address  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Index |- | 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'' |} ===ReadSSIDFromScan=== {| 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'' |} ===ReadSignalStrengthFromScan=== {| 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'' |} ===ScanForSSID=== {| 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'' |} ===SocketClose=== {| 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'' |} ===SocketConnect=== {| 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'' |} ===SocketListen=== {| 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'' |} ===SocketOpen=== {| 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'' |} ===SocketRead=== {| 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'' |} ===SocketWrite=== {| 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'' |} ==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" 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-10-icon.png]] | width="90%" | Label |- | colspan="2" | Text label used to help identify the component on the panel.  |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Simulation Method |- | colspan="2" | Decides how to handle the simulation of the component. TCP Base - Allows simulation of the network communications using the TCP Base component and DLL. COM/Injector - Allows the simulation to connect to real hardware or injectors.  |}

Return to Component: WLAN ESP32 (Dummy) (ESP32) (Comms: Networking).