Component: WLAN (EB069, ESP8266) (Wireless)
Author | Matrix Ltd. |
Version | 1.6 (Release) |
Category | Wireless |
Contents
- 1 WLAN (EB069, ESP8266) component
- 2 Examples
- 3 Downloadable macro reference
- 3.1 DisconnectFromSSID
- 3.2 SendString
- 3.3 ClientConnect
- 3.4 ControlTCPServer
- 3.5 GetFirmwareVersion
- 3.6 CheckForPageRequests
- 3.7 ClientSendRequest
- 3.8 ReadSSIDFromScan
- 3.9 CreateAccessPoint
- 3.10 SetOutValue
- 3.11 ReadSignalStrengthFromScan
- 3.12 ReadEncryptionModeFromScan
- 3.13 GetByteWithTimeout
- 3.14 GetInValue
- 3.15 ConnectToSSID
- 3.16 ScanForSSID
- 3.17 Initialise
- 3.18 CheckTCPServerIP
- 4 Simulation macro reference
- 5 Property reference
WLAN (EB069, ESP8266) component
Wireless LAN component designed to work with the ESP8266 module. Provides a very simple interface to allow webpages to be hosted from hardware or simulation. Also available in the form of the EB069 E-block.
Examples
The examples below are all done using a EB091 board as the host
The EB069 ESP8266 Wifi E-block is connected to PORTD 0-7 with the patch setting set to B.
The EB005 LCD E-block is connected to PORTB 0-7 with the patch setting set to Default.
Other host boards are compatible with the examples, simply change the target chip and component connection properties.
Firmware Test
This example collects the firmware version from the ESP8266 module and displays it on an LCD. Tested working with firmware version 00150900.
Wireless Scanner
This example scans for wireless networks in range and prints the network IDs to the LCD along with the signal strength and security type.
Creating An Access Point
This example creates an access point you can connect your phone or laptop to named Flowcode_ESP8266. The password to connect to the access point is flowcode6.
Note this example simply creates an access point, no data is transferred.
Joining An Access Point
This example joins an existing access point. The network ID and Password must be altered to match your local WIFI network settings.
Note this example simply joins an access point, no data is transferred.
TCP Client
This example joins an existing access point. The network ID and Password must be altered to match your local WIFI network settings.
Once joined to the network the example connects to the MatrixTSL website and requests a file which is printed out on the LCD.
TCP Server
This example creates an access point you can connect your phone or laptop to named Flowcode_ESP8266. The password to connect to the access point is flowcode6.
Once the access point is created the example shows the server IP address on the LCD. Connecting to the wireless network on your phone or laptop and visiting the IP address shown on the LCD using a web browser allows you to switch LED outputs on and off.
Downloadable macro reference
DisconnectFromSSID
Disconnects from the current SSID.
Returns 1 if the command was accepted and returned an "OK"
Parameters
- This macro has no parameters
Return value
SendString
Sends the given Text.
Appends a CR to the end of the string it SendCR is greater than 0.
Parameters
- <- STRING Text
- This parameter may be returned back to the caller
- BYTE SendCR
Return value
- This call does not return a value
ClientConnect
Creates a TCP or UDP connection to a remote server.
Returns the state of the connection.
0=Connection failed
1=Connection active
Parameters
- BYTE Type
- 0 = TCP, 1 = UDP
- <- STRING IPAddress
- e.g. "192.168.1.20"
- This parameter may be returned back to the caller
- UINT Port
- Remote port number to connect to, HTTP comms = Port 80
Return value
ControlTCPServer
Allows a TCP web page server to be switched on and off on the selected port.
Returns 1 if the command was completed correctly.
Parameters
- BYTE Enable
- 0 = Stop Server, 1 = Start Server
- UINT Port
- Server port to listen for incoming TCP/IP data requests
Return value
GetFirmwareVersion
Collects the firmware version from the ESP8266 module and returns it as a string.
Parameters
- This macro has no parameters
Return value
CheckForPageRequests
To be called periodically. Returns non-zero if a request has been processed
Parameters
- This macro has no parameters
Return value
ClientSendRequest
Sends out a request for data
Parameters
- <- STRING Request
- e.g. "GET / HTTP/1.0\r\n\r\n"
- This parameter may be returned back to the caller
Return value
- This call does not return a value
ReadSSIDFromScan
Collects one of the SSID name strings from the last SSID Scan.
The ScanForSSID macro must be called first.
Parameters
- BYTE Index
- SSID Index
Return value
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.
Parameters
- <- STRING SSID
- Name of the wireless network to create
- This parameter may be returned back to the caller
- <- STRING Password
- Password used to gain access to the network
- This parameter may be returned back to the caller
- BYTE Channel
- 802.11 Channel Range 1-14
- BYTE Encryption
- 0=Open, 1=WEP, 2=WPA_PSK, 3=WPA2_PSK, 4=WPA_WPA2_PSK
Return value
SetOutValue
Set the value of an outbound substitution string
Parameters
- BYTE index
- Range 0-4
- <- STRING value
- This parameter may be returned back to the caller
Return value
- This call does not return a value
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
Parameters
- BYTE Index
- SSID Index
Return value
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
Parameters
- BYTE Index
- SSID Index
Return value
GetByteWithTimeout
Attempts to receive a byte from the circular buffer.
If nothing is available then waits up to 200 ms for data to become available.
Parameters
- This macro has no parameters
Return value
GetInValue
Returns the string value of a Request parameter
Parameters
- BYTE index
- Index of the request paramter, starting at zero Range 0-2
Return value
ConnectToSSID
Attempts to connect to the given SSID and Key values.
Returns 1 if the SSID has been connected.
Parameters
- <- STRING SSID
- This parameter may be returned back to the caller
- <- STRING Key
- This parameter may be returned back to the caller
- BYTE Timeout
- Number of seconds to wait for the connection, default 2
Return value
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.
Parameters
- This macro has no parameters
Return value
Initialise
Initialise the device with the property data.
Returns 1 if "ready" message successfully received
Returns 0 if no reply from module
Parameters
- This macro has no parameters
Return value
CheckTCPServerIP
Collects the local IP address of the active TCP server.
Parameters
- This macro has no parameters
Return value
Simulation macro reference
This component does not contain any simulation macros
Property reference
Receive Buffer Size
This property is of type Unsigned integer and can be referenced with the variable name RxBufferSize.
Buffer used to store incoming data ready for processing.
Default 128 Bytes.
Scan Buffer Size
This property is of type Unsigned integer and can be referenced with the variable name ScanBufferSize.
Buffer used to hold SSID names when performing a SSID network scan.
Default 100 Bytes.
Reset Mode
This property is of type Fixed list of ints and can be referenced with the variable name ResetMode.
The initialise automatically resets the WIFI module before establishing communications.
Software reset uses an AT command to preform the reset
Hardware reset uses an extra I/O pin to toggle the signal to the reset pin on the module.
Command Termination
This property is of type Fixed list of ints and can be referenced with the variable name Termination.
Older versions of the firmware require \r to terminate a AT command string.
Newer versions of the firmware have changed to use \r\n termination.
UART
This property is of type Fixed list of ints and can be referenced with the variable name UART_CHANNEL.
WLAN module UART channel selection
BAUD
This property is of type Fixed list of ints and can be referenced with the variable name BAUD.
No additional information
Tx
This property is of type Single digital pin and can be referenced with the variable name TX.
WLAN module UART data transmit pin. Connects to receive pin on WLAN module.
Rx
This property is of type Single digital pin and can be referenced with the variable name RX.
WLAN module UART data receive pin. Connects to transmit pin on WLAN module.
Max Web Pages
This property is of type Fixed list of ints and can be referenced with the variable name PAGES.
Maximum number of individual webpages we can serve up with the component.
Web Page Timeout
This property is of type Unsigned integer and can be referenced with the variable name TIMEOUT.
Number of cycles to try and send / receive a webpage before timing out.
Line Delay
This property is of type Unsigned integer and can be referenced with the variable name LineDelay.
Fixed delay in milliseconds sent in between sending a HTML line when running as a web page server.
Name Page 1
This property is of type Line of text and can be referenced with the variable name name1.
HTML name of webpage 1
HTML Page 1
This property is of type Multiple lines of text and can be referenced with the variable name html1.
HTML content for webpage 1
Name Page 2
This property is of type Line of text and can be referenced with the variable name name2.
HTML name of webpage 2
HTML Page 2
This property is of type Multiple lines of text and can be referenced with the variable name html2.
HTML content for webpage 2
Name Page 3
This property is of type Line of text and can be referenced with the variable name name3.
HTML name of webpage 3
HTML Page 3
This property is of type Multiple lines of text and can be referenced with the variable name html3.
HTML content for webpage 3
Name Page 4
This property is of type Line of text and can be referenced with the variable name name4.
HTML name of webpage 4
HTML Page 4
This property is of type Multiple lines of text and can be referenced with the variable name html4.
HTML content for webpage 4
Injector
This property is of type Fixed list of ints and can be referenced with the variable name Injector.
No additional information
Label
This property is of type Line of text and can be referenced with the variable name label.
Text label used to help identify the component on the panel.
Length In 0
This property is of type Unsigned integer and can be referenced with the variable name LenIn0.
Sets the max buffer length
Length In 1
This property is of type Unsigned integer and can be referenced with the variable name LenIn1.
Sets the max buffer length
Length In 2
This property is of type Unsigned integer and can be referenced with the variable name LenIn2.
Sets the max buffer length
Length In 3
This property is of type Unsigned integer and can be referenced with the variable name LenIn3.
Sets the max buffer length
Length In 4
This property is of type Unsigned integer and can be referenced with the variable name LenIn4.
Sets the max buffer length
Length In 5
This property is of type Unsigned integer and can be referenced with the variable name LenIn5.
Sets the max buffer length
Length Out 0
This property is of type Unsigned integer and can be referenced with the variable name LenOut0.
Sets the max buffer length
Length Out 1
This property is of type Unsigned integer and can be referenced with the variable name LenOut1.
Sets the max buffer length
Length Out 2
This property is of type Unsigned integer and can be referenced with the variable name LenOut2.
Sets the max buffer length
Length Out 3
This property is of type Unsigned integer and can be referenced with the variable name LenOut3.
Sets the max buffer length
Length Out 4
This property is of type Unsigned integer and can be referenced with the variable name LenOut4.
Sets the max buffer length