Component: WLAN (EB069, WIZ610wi) (Wireless)
| Author | Matrix Ltd. |
| Version | 1.3 (Release) |
| Category | Wireless |
Contents
WLAN (EB069, WIZ610wi) component
Wireless LAN component designed to work with the WIZ610wi module from Wiznet. 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
This example connects the WLAN module to a existing wireless router and starts a web page server running. The web page can be accessed by typing the IP address of the module into your browser.
Please note that due to limitations with use if RAM storage on some processors you will need to ensure that each line of the page text (HTML) is quite short, usually below 100 characters.
Otherwise this can cause an error such as “Error: No remaining RAM block (on target) big enough for:”
Additional examples can be found in the “Apps and Bundles” section of this Wiki:
Wireless LAN Application Guide
The example also hosts a web page server during simulation using your PC. You can access the web pages served by the PC running Flowcode by using the localhost loopback IP address "127.0.0.1:5000" where 5000 is the port assigned to the WLAN component. You can access the web pages from a PC on a network by using the IP address of the machine running Flowcode and specifying the correct port. Port 80 is used by default for HTML transfer but windows can be a bit funny about what is allowed on port 80 so we have used port 5000 in the example. You may have to check your server PC's incoming firewall settings to get this fully functional via a remote PC.
WLAN Webpage Server
Here is one of the pages generated by the example.
The TCPIP tab of the console window will show all the data sent and received during simulation which is useful for learning how things like web page servers work.
Downloadable macro reference
SendString
Sends the given Text.
Appends a CR/LF pair of characters it CrLf is true.
Parameters
- <- STRING Text
- This parameter may be returned back to the caller
- BYTE CrLf
Return value
- This call does not return a value
SendCommand
Sends the given command and returns the reply status.
(See GetReply for return values)
Parameters
- <- STRING Command
- This parameter may be returned back to the caller
Return value
CheckForPageRequests
To be called periodically. Returns non-zero if a request has been processed
Parameters
- This macro has no parameters
Return value
EnableCommandMode
Enables command mode. Must be called before commands are issued.
Parameters
- This macro has no parameters
Return value
- This call does not return a value
ReceiveIncoming
Returns the received data string
Parameters
- This macro has no parameters
Return value
ReadConnectionStatus
Checks the connection status.
Returns 0 if not connected, 1 if connected.
Parameters
- This macro has no parameters
Return value
SetOutValue
Set the value of an outbound substitution string
Parameters
- BYTE index
- <- STRING value
- This parameter may be returned back to the caller
Return value
- This call does not return a value
DisableCommandMode
Exits command mode
Parameters
- This macro has no parameters
Return value
- This call does not return a value
GetInValue
Returns the string value of a Request parameter
Parameters
- BYTE index
- Index of the request paramter, starting at zero.
Return value
ConnectToSSID
Attempts to connect to the given SSID and Key values. Returns 0 if successful.
Parameters
- <- STRING SSID
- This parameter may be returned back to the caller
- <- STRING Key
- This parameter may be returned back to the caller
Return value
GetReply
Returns the last received response to a command.
0 = OK
1 = FAIL_ERR
2 = STX_ERR
3 = CMD_ERR
4 = PARAM_ERR
5 = ETX_ERR
6 = SERIAL
255 = TOUT
Parameters
- This macro has no parameters
Return value
Initialise
Initialise the device with the property data.
Returns 0 if successful
Parameters
- This macro has no parameters
Return value
Simulation macro reference
This component does not contain any simulation macros
Property reference
IP 0
This property is of type Unsigned integer and can be referenced with the variable name IP0.
First number in IP address - e.g. xxx.168.1.1
IP 1
This property is of type Unsigned integer and can be referenced with the variable name IP1.
Second number in IP address - e.g. 192.xxx.1.1
IP 2
This property is of type Unsigned integer and can be referenced with the variable name IP2.
Third number in IP address - e.g. 192.168.xxx.1
IP 3
This property is of type Unsigned integer and can be referenced with the variable name IP3.
Fourth number in IP address - e.g. 192.168.1.xxx
Mask 0
This property is of type Unsigned integer and can be referenced with the variable name MIP0.
First number in Subnet mask - e.g. xxx.255.255.0
Mask 1
This property is of type Unsigned integer and can be referenced with the variable name MIP1.
Second number in Subnet mask - e.g. 255.xxx.255.0
Mask 2
This property is of type Unsigned integer and can be referenced with the variable name MIP2.
Third number in Subnet mask - e.g. 255.255.xxx.0
Mask 3
This property is of type Unsigned integer and can be referenced with the variable name MIP3.
Fourth number in Subnet mask - e.g. 255.255.255.xxx
Gateway 0
This property is of type Unsigned integer and can be referenced with the variable name GIP0.
First number from IP address used as the gateway to the internet e.g. xxx.168.1.1
Gateway 1
This property is of type Unsigned integer and can be referenced with the variable name GIP1.
Second number from IP address used as the gateway to the internet e.g. 192.xxx.1.1
Gateway 2
This property is of type Unsigned integer and can be referenced with the variable name GIP2.
Third number from IP address used as the gateway to the internet e.g. 192.168.xxx.1
Gateway 3
This property is of type Unsigned integer and can be referenced with the variable name GIP3.
Fourth number from IP address used as the gateway to the internet e.g. 192.168.1.xxx
Trigger
This property is of type Single digital pin and can be referenced with the variable name TRIGGER.
WLAN module trigger pin connection
Reset
This property is of type Single digital pin and can be referenced with the variable name RESET.
WLAN module reset pin connection
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
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.
SSID
This property is of type Line of text and can be referenced with the variable name SSID.
Wireless network identifier string
SSID Broadcast
This property is of type Fixed list of ints and can be referenced with the variable name SSID_MODE.
Decides if the network is detectable by a nearby Wifi device.
Server Port
This property is of type Unsigned integer and can be referenced with the variable name PORT.
Port number which is being monitored by the server, for starndard webpages port 80 is the default.
To specify a non standard port you can enter the custom port number in the URL after a colon like this.
192.168.1.1:8080 - here we use 8080 as an alternative port.
WLAN Mode
This property is of type Fixed list of ints and can be referenced with the variable name WLAN_MODEA.
Decides if the WLAN module is configured as a end device (connects to another wifi router)
Or as an access point (allowing other wifi devices to connect to it)
DHCP
This property is of type Fixed list of ints and can be referenced with the variable name WLAN_DHCPA.
Controls if we are assigning IPs to any joing wifi devices or if we are using a fixed IP based system.
Start IP 0
This property is of type Unsigned integer and can be referenced with the variable name SIP0.
Minimum IP address that can be generated for a joining device under DHCP.
Start IP 1
This property is of type Unsigned integer and can be referenced with the variable name SIP1.
Minimum IP address that can be generated for a joining device under DHCP.
Start IP 2
This property is of type Unsigned integer and can be referenced with the variable name SIP2.
Minimum IP address that can be generated for a joining device under DHCP.
Start IP 3
This property is of type Unsigned integer and can be referenced with the variable name SIP3.
Minimum IP address that can be generated for a joining device under DHCP.
End IP 0
This property is of type Unsigned integer and can be referenced with the variable name EIP0.
Maximum IP address that can be generated for a joining device under DHCP.
End IP 1
This property is of type Unsigned integer and can be referenced with the variable name EIP1.
Maximum IP address that can be generated for a joining device under DHCP.
End IP 2
This property is of type Unsigned integer and can be referenced with the variable name EIP2.
Maximum IP address that can be generated for a joining device under DHCP.
End IP 3
This property is of type Unsigned integer and can be referenced with the variable name EIP3.
Maximum IP address that can be generated for a joining device under DHCP.
Security
This property is of type Fixed list of ints and can be referenced with the variable name WLAN_SMODE.
Decides if the security if untouched or reset to open.
Security settings can be assigned using the Wiznet control web interface which is built into the modules.
Channel
This property is of type Fixed list of ints and can be referenced with the variable name CHANNEL.
Configures the Wifi data channel, setting to auto will allow the device to scan for the best channel for your area and the surounding wifi devices.
Data Rate
This property is of type Fixed list of ints and can be referenced with the variable name DATA_RATE.
The data rate to try and acheive with the wifi connection.
Tx Power
This property is of type Fixed list of ints and can be referenced with the variable name TX_POWER.
The amount of power to use when transmitting signals to other wifi devices.
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.
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
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.
