Component: WLAN (ESP32) (Comms: Networking)

Author	Matrix Ltd.
Version	2.4
Category	Comms: Networking

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

Weather Predictor

Here is an example of a next-day weather predictor that also shows the current-day weather for a ESP32 embedded device

It uses the BBC weather component via Netwoekcomms and WLAN ESP32 components to connect to the BBC server and retrieve the weather forecast for the specified area code.

ESP32 weather predictor

User Configurable Network Details

When creating a product using an ESP32 device it is important that it can connect to the network of the person buying the product.

This is complicated as the ESP32 requires that the network SSID and password be defined by the user and this requires a means of getting the data into the ESP32 device.

Luckily as the ESP32 features the ability to host it's own network we can use this to create a simple web interface where the user can enter their network details.

ESP32 Config WIFI

More info on this available here Flowcode Forums - User Configurable Network Details

Macro reference

AcceptClose

	AcceptClose
Close the socket associated with the Accepted incoming connection
- VOID	Return

AcceptOpen

	AcceptOpen
Returns 1 if there is an incoming connection on the listening port
- BYTE	Return

ConnectToSSID

	ConnectToSSID
Attempts to connect to the given SSID and Key values. Returns 1 if the SSID has been connected.
- STRING	SSID
- STRING	Key
- BYTE	Timeout
Number of seconds to wait for the connection, default 20
- BYTE	Return

CreateAccessPoint

	CreateAccessPoint
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.
- STRING	SSID
Name of the wireless network to create
- STRING	Password
Password used to gain access to the network
- BYTE	Channel
802.11 Channel Range 1-14
- BYTE	Encryption
0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK
- BYTE	Return

Disconnect

	Disconnect
Attempts to disconnect from the SSID.
- BYTE	Return

Initialise

	Initialise
Initialise the WiFi system Returns 1 if successful Returns 0 if not
- BYTE	Return

ReadEncryptionModeFromScan

	ReadEncryptionModeFromScan
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
- BYTE	Index
SSID Index
- BYTE	Return

ReadIP

	ReadIP
Collects a single byte from the local IP address. For example 192.168.0.1 Index = 3 : Return = 192 / Index = 0 : Return = 1
- BYTE	Index
Range: 0 to 3 Where 3 = the first number and 0 = the last number
- BYTE	Return

ReadIPString

	ReadIPString
Collects the local IP address and returns it as an ASCII string. e.g. "192.168.0.1"
- STRING	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

ReadSignalStrengthFromScan

	ReadSignalStrengthFromScan
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
- BYTE	Index
SSID Index
- INT	Return

ScanForSSID

	ScanForSSID
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.
- BYTE	Return

SocketClose

	SocketClose
- VOID	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

SocketOpen

	SocketOpen
Returns 1 if socket sucessfully opened
- BYTE	Return

SocketRead

	SocketRead
- STRING	Buffer
- UINT	Size
- UINT	Return

SocketWrite

	SocketWrite
- STRING	Buffer
- UINT	Size
- UINT	Return

Uninitialise

	Uninitialise
Shuts down the WiFi system for low power operation. Returns 1 if successful Returns 0 if not
- BYTE	Return

Property reference

	Properties
	Verbose Debug
Provides verbose debugging output via hardware UART channel 1 which is often connected to a UART to USB bridge.
	SSID Scan Size
Maximum number of SSIDs that can be detailed from a single SSID network scan. Default 8
	Simulation
	Network Interface
List of network interfaces connected to the PC. Sets which interface we are communicating via.
	Console Data
Generate Console Data