Difference between revisions of "Component: Webserver (NM7010A) (Comms: Networking)"

Revision as of 11:53, 3 February 2023

Author	Matrix Ltd.
Version	2.0
Category	Comms: Networking

Webserver (NM7010A) component

Webserver component designed to work with the NM7010A module from Wiznet, as used in the version 1 EB023 E-block. 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_NM7010A.fcfx

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

Detailed description

No detailed description exists yet for this component

Examples

No additional examples

Macro reference

SetOutValue

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

- STRING	value

- VOID	Return

Send_Embedded_HTML_Page4

	Send_Embedded_HTML_Page4

- VOID	Return

Send_Embedded_HTML_Page3

	Send_Embedded_HTML_Page3

- VOID	Return

Send_Embedded_HTML_Page2

	Send_Embedded_HTML_Page2

- VOID	Return

Send_Embedded_HTML_Page1

	Send_Embedded_HTML_Page1

- VOID	Return

GetInValue

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

- STRING	Return

CreateServerSocket

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

- BYTE	Port_Hi

- BYTE	Port_Lo

- BYTE	Return

IncRxPtr

	IncRxPtr

- BYTE	Channel

- VOID	Return

CheckSocketActivity

	CheckSocketActivity
Checks for activity on the server socket and serves out the webpages to any requesting parties.
- BYTE	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

Property reference

	Properties
	Label
Label used to help identify the component on the panel.
	Max Channels
Max number of concurrent channels allowed
	I2C Address
I2C address of the module - bit 0
	HTML Source
	HTML Source
Sets the method for streaming data, we can either host it loacally using a property or refer to external files.
	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
Channel selection
	Baud Select
Baud rate option selector
	Baud Rate
Baud rate to be used
	Stop Delay
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not a 10ms delay between an I2C stop event and the next I2C start event. Most modern microcontrollers will not have a problem so this property can be disabled to speed up the I2C communications.
	SDA
Pin used for SDA (data signal)
	SCL
Pin used for SCL (clock signal)
	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.

@@ Line 77: / Line 77: @@
 ''<span style="color:red;">No additional examples</span>''
@@ Line 83: / Line 85: @@
 ==Macro reference==
+===SetOutValue===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 106: / Line 109: @@
+===Send_Embedded_HTML_Page4===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 119: / Line 123: @@
+===Send_Embedded_HTML_Page3===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 132: / Line 137: @@
+===Send_Embedded_HTML_Page2===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 145: / Line 151: @@
+===Send_Embedded_HTML_Page1===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 158: / Line 165: @@
+===GetInValue===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 176: / Line 184: @@
+===CreateServerSocket===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 204: / Line 213: @@
+===IncRxPtr===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 222: / Line 232: @@
+===CheckSocketActivity===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-
@@ Line 235: / Line 246: @@
+===Initialise===
 {| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 |-