Component: Webserver (W5500) (Comms: Networking): Difference between revisions

Latest revision as of 14:37, 13 July 2026

Author	Matrix Ltd.
Version	1.0
Category	Comms: Networking

Webserver (W5500) component

Webserver component designed to work with the W5500 module from Wiznet, as use by the ETH WIZ Click Module. Provides a very simple interface to allow webpages to be hosted from hardware or simulation.

Component Source Code

Please click here to download the component source project: FC_Comp_Source_WebServer_W5500.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_WebServer_W5500.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

CheckSocketActivity

	CheckSocketActivity
Checks for activity on the server socket and serves out the webpages to any requesting parties.
- BYTE	Return

CreateServerSocket

	CreateServerSocket
Creates a listening socket on the selected channel and port ready to accept incoming web page requests.
- BYTE	Channel

- UINT	Port

- BYTE	Return

GetInValue

	GetInValue
Returns the string value of a Request parameter
- BYTE	index

- STRING	Return

IncRxPtr

	IncRxPtr

- BYTE	Channel

- VOID	Return

Initialise

	Initialise
Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros
- VOID	Return

Send_Embedded_HTML_Page1

	Send_Embedded_HTML_Page1

- VOID	Return

Send_Embedded_HTML_Page2

	Send_Embedded_HTML_Page2

- VOID	Return

Send_Embedded_HTML_Page3

	Send_Embedded_HTML_Page3

- VOID	Return

Send_Embedded_HTML_Page4

	Send_Embedded_HTML_Page4

- VOID	Return

SetOutValue

	SetOutValue
Set the value of an outbound substitution string
- BYTE	index

- STRING	value

- VOID	Return

WM_TXMEM

	WM_TXMEM

- BYTE	ch

- UINT	Return

Property reference

	Properties
	HTML Source
	Max Pages
Maximum number of pages we can serve using the embedded page type webserver.
	Name Page 1
Name of HTML page 1 - index.htm is the default page that will be presented.
	HTML Page 1
Embedded HTML code used for page 1
	Name Page 2
Name of HTML page 2
	HTML Page 2
Embedded HTML code used for page 2
	Name Page 3
Name of HTML page 3
	HTML Page 3
Embedded HTML code used for page 3
	Name Page 4
Name of HTML page 4
	HTML Page 4
Embedded HTML code used for page 4
	Connections
	Channel
SPI Channel selector
	Prescale
Prescale option selector
	MOSI
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
	MISO
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
	CLK
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
	CS / SS
Chip Select / Slave Select Pin Master Mode: General purpose output pin used to select the remote SPI device. Slave Mode: Hardware chip select pin input used to select the SPI device.
	Int Pin
Interrupt pin connection on Wiznet module
	Gateway IP
	Gateway0
IP address of the gateway to the internet if applicable.
	Gateway1
IP address of the gateway to the internet if applicable.
	Gateway2
IP address of the gateway to the internet if applicable.
	Gateway3
IP address of the gateway to the internet if applicable.
	Subnet Mask
	Subnet0
Subnet mask of the server - usually 255.255.255.0
	Subnet1
Subnet mask of the server - usually 255.255.255.0
	Subnet2
Subnet mask of the server - usually 255.255.255.0
	Subnet3
Subnet mask of the server - usually 255.255.255.0
	IP Address
	IP0
IP address of the server - usually 192.168.0.x or 192.168.1.x
	IP1
IP address of the server - usually 192.168.0.x or 192.168.1.x
	IP2
IP address of the server - usually 192.168.0.x or 192.168.1.x
	IP3
IP address of the server - usually 192.168.0.x or 192.168.1.x
	MAC Address
	MAC0
MAC address of the server
	MAC1
MAC address of the server
	MAC2
MAC address of the server
	MAC3
MAC address of the server
	MAC4
MAC address of the server
	MAC5
MAC address of the server
	Substitutions
	Outgoing
	Count
Maximum number of outbound string substitutions
	Length 0
Number of bytes to reserve for data string.
	Length 1
Number of bytes to reserve for data string.
	Length 2
Number of bytes to reserve for data string.
	Incoming
	Count
Maximum number of inbound string substitutions
	Length 0
Number of bytes to reserve for data string.
	Simulation
	Label
Label used to help identify the component on the panel.
	Sim Type
Decides how to perform the simulation of the component. TCP IP - Communicates using the Windows TCP IP communications DLL SPI / Injector - Communicates using the CAL SPI to allow the communications to be analysed and debugged.
	TCP Simulation
	Network Interface
List of network interfaces connected to the PC. Sets which interface we are communicating via.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/WebServer_W5500.fcfx FC_Comp_Source_temp/WebServer_W5500.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WebServer_W5500.fcfx FC_Comp_Source_WebServer_W5500.fcfx]
-Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/WebServer_W5500.fcfx FC_Comp_Source_temp/WebServer_W5500.fcfx]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WebServer_W5500.fcfx FC_Comp_Source_WebServer_W5500.fcfx]
 ==Detailed description==
@@ Line 77: / Line 77: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 90: / Line 92: @@
 ===CheckSocketActivity===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CheckSocketActivity'''
+| width="90%" class="mtx-class-macrohead" | '''CheckSocketActivity'''
 |-
 | colspan="2" | Checks for activity on the server socket and serves out the webpages to any requesting parties.&nbsp;
@@ Line 104: / Line 106: @@
 ===CreateServerSocket===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''CreateServerSocket'''
+| width="90%" class="mtx-class-macrohead" | '''CreateServerSocket'''
 |-
 | colspan="2" | Creates a listening socket on the selected channel and port ready to accept incoming web page requests.&nbsp;
@@ Line 128: / Line 130: @@
 ===GetInValue===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''GetInValue'''
+| width="90%" class="mtx-class-macrohead" | '''GetInValue'''
 |-
 | colspan="2" | Returns the string value of a Request parameter&nbsp;
@@ Line 147: / Line 149: @@
 ===IncRxPtr===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''IncRxPtr'''
+| width="90%" class="mtx-class-macrohead" | '''IncRxPtr'''
 |-
 | colspan="2" | &nbsp;
@@ Line 166: / Line 168: @@
 ===Initialise===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
+| width="90%" class="mtx-class-macrohead" | '''Initialise'''
 |-
 | colspan="2" | Resets and initialises the Internet E-Block. It sets up the gateway address, subnet mask, device IP address and device MAC address as defined in the properties of the Flowcode component. This macro must be called before any other TCP_IP component macros &nbsp;
@@ Line 180: / Line 182: @@
 ===Send_Embedded_HTML_Page1===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send_Embedded_HTML_Page1'''
+| width="90%" class="mtx-class-macrohead" | '''Send_Embedded_HTML_Page1'''
 |-
 | colspan="2" | &nbsp;
@@ Line 194: / Line 196: @@
 ===Send_Embedded_HTML_Page2===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send_Embedded_HTML_Page2'''
+| width="90%" class="mtx-class-macrohead" | '''Send_Embedded_HTML_Page2'''
 |-
 | colspan="2" | &nbsp;
@@ Line 208: / Line 210: @@
 ===Send_Embedded_HTML_Page3===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send_Embedded_HTML_Page3'''
+| width="90%" class="mtx-class-macrohead" | '''Send_Embedded_HTML_Page3'''
 |-
 | colspan="2" | &nbsp;
@@ Line 222: / Line 224: @@
 ===Send_Embedded_HTML_Page4===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Send_Embedded_HTML_Page4'''
+| width="90%" class="mtx-class-macrohead" | '''Send_Embedded_HTML_Page4'''
 |-
 | colspan="2" | &nbsp;
@@ Line 236: / Line 238: @@
 ===SetOutValue===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOutValue'''
+| width="90%" class="mtx-class-macrohead" | '''SetOutValue'''
 |-
 | colspan="2" | Set the value of an outbound substitution string&nbsp;
@@ Line 260: / Line 262: @@
 ===WM_TXMEM===
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''WM_TXMEM'''
+| width="90%" class="mtx-class-macrohead" | '''WM_TXMEM'''
 |-
 | colspan="2" | &nbsp;
@@ Line 280: / Line 282: @@
 ==Property reference==
-{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+{| class="mtx-class-macrotable wikitable"
 |-
-| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
+| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]]
-| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''
+| width="90%" class="mtx-class-macrohead" | '''Properties'''
 |-
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | HTML Source
+| width="90%" class="mtx-class-propfolder" | HTML Source
 |-
 |-
@@ Line 335: / Line 337: @@
 | colspan="2" | Embedded HTML code used for page 4&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
+| width="90%" class="mtx-class-propfolder" | Connections
 |-
 |-
@@ Line 374: / Line 376: @@
 | colspan="2" | Interrupt pin connection on Wiznet module&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Gateway IP
+| width="90%" class="mtx-class-propfolder" | Gateway IP
 |-
 |-
@@ Line 398: / Line 400: @@
 | colspan="2" | IP address of the gateway to the internet if applicable.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Subnet Mask
+| width="90%" class="mtx-class-propfolder" | Subnet Mask
 |-
 |-
@@ Line 422: / Line 424: @@
 | colspan="2" | Subnet mask of the server - usually 255.255.255.0&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | IP Address
+| width="90%" class="mtx-class-propfolder" | IP Address
 |-
 |-
@@ Line 446: / Line 448: @@
 | colspan="2" | IP address of the server - usually 192.168.0.x or 192.168.1.x&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | MAC Address
+| width="90%" class="mtx-class-propfolder" | MAC Address
 |-
 |-
@@ Line 480: / Line 482: @@
 | colspan="2" | MAC address of the server&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Substitutions
+| width="90%" class="mtx-class-propfolder" | Substitutions
 |-
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Outgoing
+| width="90%" class="mtx-class-propfolder" | Outgoing
 |-
 |-
@@ Line 508: / Line 510: @@
 | colspan="2" | Number of bytes to reserve for data string.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Incoming
+| width="90%" class="mtx-class-propfolder" | Incoming
 |-
 |-
@@ Line 522: / Line 524: @@
 | colspan="2" | Number of bytes to reserve for data string.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
+| width="90%" class="mtx-class-propfolder" | Simulation
 |-
 |-
@@ Line 536: / Line 538: @@
 | colspan="2" | Decides how to perform the simulation of the component. TCP IP - Communicates using the Windows TCP IP communications DLL SPI / Injector - Communicates using the CAL SPI to allow the communications to be analysed and debugged.&nbsp;
 |-
-| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
+| width="10%" align="center" class="mtx-class-propfolder" | [[File:Fc9-conn-icon.png]]
-| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | TCP Simulation
+| width="90%" class="mtx-class-propfolder" | TCP Simulation
 |-
 |-

SteveT (talk | contribs)