Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd. |- | width="20%" style="color:gray;" | Version | 1.3 |- | width="20%" style="color:gra..."

2023-11-03T11:57:29Z

Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd. |- | width="20%" style="color:gray;" | Version | 1.3 |- | width="20%" style="color:gra..."

New page

{| style="width:50%"
|-
| width="20%" style="color:gray;" | Author
| Matrix Ltd.
|-
| width="20%" style="color:gray;" | Version
| 1.3
|-
| width="20%" style="color:gray;" | Category
| Misc
|}

==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.

==Component Source Code==

Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WLAN.fcfx FC_Comp_Source_WLAN.fcfx]

Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WLAN.fcfx FC_Comp_Source_WLAN.fcfx]

==Detailed description==

''No detailed description exists yet for this component''

==Examples==

''<span style="color:red;">No additional examples</span>''

==Macro reference==

===CheckForPageRequests===
{| 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;" | '''CheckForPageRequests'''
|-
| colspan="2" | To be called periodically. Returns non-zero if a request has been processed 
|-
|-
| 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 0 if successful. 
|-
|-
| 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" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}

===DisableCommandMode===
{| 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;" | '''DisableCommandMode'''
|-
| colspan="2" | Exits command mode 
|-
|-
| 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''
|}

===EnableCommandMode===
{| 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;" | '''EnableCommandMode'''
|-
| colspan="2" | Enables command mode. Must be called before commands are issued. 
|-
|-
| 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''
|}

===GetInValue===
{| 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;" | '''GetInValue'''
|-
| colspan="2" | Returns the string value of a Request parameter 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" | Index of the request paramter, starting at zero. 
|-
| 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''
|}

===GetReply===
{| 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;" | '''GetReply'''
|-
| colspan="2" | 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 
|-
|-
| 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 device with the property data. Returns 0 if successful 
|-
|-
| 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''
|}

===ReadConnectionStatus===
{| 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;" | '''ReadConnectionStatus'''
|-
| colspan="2" | Checks the connection status. Returns 0 if not connected, 1 if connected. 
|-
|-
| 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''
|}

===ReceiveIncoming===
{| 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;" | '''ReceiveIncoming'''
|-
| colspan="2" | Returns the received data string 
|-
|-
| 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''
|}

===SendCommand===
{| 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;" | '''SendCommand'''
|-
| colspan="2" | Sends the given command and returns the reply status. (See GetReply for return values) 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Command
|-
| 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''
|}

===SendString===
{| 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;" | '''SendString'''
|-
| colspan="2" | Sends the given Text. Appends a CR/LF pair of characters it CrLf is true. 
|-
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | Text
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | CrLf
|-
| 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''
|}

===Send_Embedded_HTML_Page1===
{| 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;" | '''Send_Embedded_HTML_Page1'''
|-
| 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''
|}

===Send_Embedded_HTML_Page2===
{| 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;" | '''Send_Embedded_HTML_Page2'''
|-
| 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''
|}

===Send_Embedded_HTML_Page3===
{| 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;" | '''Send_Embedded_HTML_Page3'''
|-
| 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''
|}

===Send_Embedded_HTML_Page4===
{| 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;" | '''Send_Embedded_HTML_Page4'''
|-
| 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''
|}

===SetOutValue===
{| 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;" | '''SetOutValue'''
|-
| colspan="2" | Set the value of an outbound substitution string 
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | index
|-
| colspan="2" |  
|-
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
| width="90%" | value
|-
| 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''
|}

==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;" | IP Address
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | IP 0
|-
| colspan="2" | First number in IP address - e.g. xxx.168.1.1  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | IP 1
|-
| colspan="2" | Second number in IP address - e.g. 192.xxx.1.1  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | IP 2
|-
| colspan="2" | Third number in IP address - e.g. 192.168.xxx.1  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | IP 3
|-
| colspan="2" | Fourth number in IP address - e.g. 192.168.1.xxx 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Subnet Mask
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Mask 0
|-
| colspan="2" | First number in Subnet mask - e.g. xxx.255.255.0  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Mask 1
|-
| colspan="2" | Second number in Subnet mask - e.g. 255.xxx.255.0  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Mask 2
|-
| colspan="2" | Third number in Subnet mask - e.g. 255.255.xxx.0  
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Mask 3
|-
| colspan="2" | Fourth number in Subnet mask - e.g. 255.255.255.xxx  
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Gateway IP
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Gateway 0
|-
| colspan="2" | First number from IP address used as the gateway to the internet e.g. xxx.168.1.1 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Gateway 1
|-
| colspan="2" | Second number from IP address used as the gateway to the internet e.g. 192.xxx.1.1 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Gateway 2
|-
| colspan="2" | Third number from IP address used as the gateway to the internet e.g. 192.168.xxx.1 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Gateway 3
|-
| colspan="2" | Fourth number from IP address used as the gateway to the internet e.g. 192.168.1.xxx 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
|-
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Trigger
|-
| colspan="2" | WLAN module trigger pin connection 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Reset
|-
| colspan="2" | WLAN module reset pin connection 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | UART
|-
| colspan="2" | WLAN module UART channel selection 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Tx
|-
| colspan="2" | WLAN module UART data transmit pin. Connects to receive pin on WLAN module. 
|-
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
| width="90%" | Rx
|-
| colspan="2" | WLAN module UART data receive pin. Connects to transmit pin on WLAN module. 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | SSID
|-
| colspan="2" | Wireless network identifier string 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | SSID Broadcast
|-
| colspan="2" | Decides if the network is detectable by a nearby Wifi device. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Server Port
|-
| colspan="2" | 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. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | WLAN Mode
|-
| colspan="2" | 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) 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | DHCP
|-
| colspan="2" | Controls if we are assigning IPs to any joing wifi devices or if we are using a fixed IP based system. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | DHCP Pool Start IP Address
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Start IP 0
|-
| colspan="2" | Minimum IP address that can be generated for a joining device under DHCP. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Start IP 1
|-
| colspan="2" | Minimum IP address that can be generated for a joining device under DHCP. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Start IP 2
|-
| colspan="2" | Minimum IP address that can be generated for a joining device under DHCP. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Start IP 3
|-
| colspan="2" | Minimum IP address that can be generated for a joining device under DHCP. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | DHCP Pool End IP Address
|-
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | End IP 0
|-
| colspan="2" | Maximum IP address that can be generated for a joining device under DHCP. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | End IP 1
|-
| colspan="2" | Maximum IP address that can be generated for a joining device under DHCP. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | End IP 2
|-
| colspan="2" | Maximum IP address that can be generated for a joining device under DHCP. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | End IP 3
|-
| colspan="2" | Maximum IP address that can be generated for a joining device under DHCP. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Security
|-
| colspan="2" | 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. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Channel
|-
| colspan="2" | 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. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Data Rate
|-
| colspan="2" | The data rate to try and acheive with the wifi connection. 
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Tx Power
|-
| colspan="2" | The amount of power to use when transmitting signals to other wifi devices. 
|-
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | HTML Source
|-
|-
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
| width="90%" | Max Web Pages
|-
| colspan="2" | Maximum number of individual webpages we can serve up with the component. 
|-
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
| width="90%" | Web Page Timeout
|-
| colspan="2" | Number of cycles to try and send / receive a webpage before timing out. 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name Page 1
|-
| colspan="2" | HTML name of webpage 1 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | HTML Page 1
|-
| colspan="2" | HTML content for webpage 1 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name Page 2
|-
| colspan="2" | HTML name of webpage 2 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | HTML Page 2
|-
| colspan="2" | HTML content for webpage 2 
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name Page 3
|-
| colspan="2" | HTML name of webpage 3 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | HTML Page 3
|-
| colspan="2" | HTML content for webpage 3  
|-
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
| width="90%" | Name Page 4
|-
| colspan="2" | HTML name of webpage 4 
|-
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
| width="90%" | HTML Page 4
|-
| colspan="2" | HTML content for webpage 4 
|-
| 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. 
|}

Component: WLAN (EB069, WIZ610wi) (Misc) - Revision history

Wiki bot: Created page with "{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd. |- | width="20%" style="color:gray;" | Version | 1.3 |- | width="20%" style="color:gra..."