Difference between revisions of "Component: Webserver (EB023 v1) (E-blocks 1)"

From Flowcode Help
Jump to navigationJump to search
(XML import - Pre 8.0 release)
 
 
(9 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
{| style="width:50%"
−
 
 
−
{| width="50%"
 
 
|-
 
|-
−
| width="20%" style="color: gray;" | Author
+
| width="20%" style="color:gray;" | Author
 
| Matrix TSL
 
| Matrix TSL
 
|-
 
|-
−
| width="20%" style="color: gray;" | Version
+
| width="20%" style="color:gray;" | Version
−
| 2.0 (Release)
+
| 2.0
 
|-
 
|-
−
| width="20%" style="color: gray;" | Category
+
| width="20%" style="color:gray;" | Category
 
| E-blocks 1
 
| E-blocks 1
 
|}
 
|}
  
  
 +
==Webserver 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.
  
−
==[[File:Component Icon c0a18557_a477_4d5a_b9ca_e0724378d983.png|Image]] Webserver (EB023 v1) component==
+
==Component Source Code==
−
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.
 
  
−
==Examples==
+
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_WebServer_EB023-00-1_EB.fcfx FC_Comp_Source_WebServer_EB023-00-1_EB.fcfx]
−
''<span style="color:red;">No additional examples</span>''
 
  
 +
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_WebServer_EB023-00-1_EB.fcfx FC_Comp_Source_WebServer_EB023-00-1_EB.fcfx]
  
−
==Downloadable macro reference==
+
==Detailed description==
  
−
===<span style="font-weight: normal;"><u><tt>SetOutValue</tt></u></span>===
 
−
Set the value of an outbound substitution string
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''index''
 
  
−
:[[Variable Types|<- STRING]] ''value''
 
−
::''This parameter may be returned back to the caller''
 
  
  
−
'''Return value'''
 
  
−
:''This call does not return a value''
 
  
  
−
===<span style="font-weight: normal;"><u><tt>GetInValue</tt></u></span>===
 
−
Returns the string value of a Request parameter
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''index''
+
''No detailed description exists yet for this component''
  
 +
==Examples==
  
−
'''Return value'''
 
  
−
:[[Variable Types|STRING]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>CreateServerSocket</tt></u></span>===
 
−
Creates a listening socket on the selected channel and port ready to accept incoming web page requests.
 
  
−
'''Parameters'''
 
  
−
:[[Variable Types|BYTE]] ''Channel''
 
  
−
:[[Variable Types|BYTE]] ''Port_Hi''
 
  
−
:[[Variable Types|BYTE]] ''Port_Lo''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
 +
''<span style="color:red;">No additional examples</span>''
  
−
===<span style="font-weight: normal;"><u><tt>CheckSocketActivity</tt></u></span>===
 
−
Checks for activity on the server socket and serves out the webpages to any requesting parties.
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
 
  
−
:[[Variable Types|BYTE]]
 
  
  
−
===<span style="font-weight: normal;"><u><tt>Initialise</tt></u></span>===
 
−
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
 
  
−
'''Parameters'''
 
  
−
:''This macro has no parameters''
 
  
  
−
'''Return value'''
+
==Macro reference==
  
−
:''This call does not return a value''
+
===CheckSocketActivity===
 +
{| 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;" | '''CheckSocketActivity'''
 +
|-
 +
| colspan="2" | Checks for activity on the server socket and serves out the webpages to any requesting parties.&nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
  
 +
===CreateServerSocket===
 +
{| 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;" | '''CreateServerSocket'''
 +
|-
 +
| colspan="2" | Creates a listening socket on the selected channel and port ready to accept incoming web page requests.&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Port_Hi
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Port_Lo
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
==Simulation macro reference==
 
  
−
''This component does not contain any simulation macros''
+
===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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | index
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
  
−
==Property reference==
+
===IncRxPtr===
−
<span style="font-weight: normal;"><u>Label</u></span>
+
{| 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;" | '''IncRxPtr'''
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | Channel
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
 
  
−
Label used to help identify the component on the panel.
+
===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" | 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;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>Max Channels</u></span>
 
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''max_channels''.
+
===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" | &nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
Max number of concurrent channels allowed
 
  
−
<span style="font-weight: normal;"><u>I2C Address</u></span>
+
===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" | &nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''MAC_WR_ADDR''.
 
  
−
I2C address of the module - bit 0
+
===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" | &nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
<span style="font-weight: normal;"><u>HTML Source</u></span>
 
  
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''html_source''.
+
===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" | &nbsp;
 +
|-
 +
|-
 +
| 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''
 +
|}
  
−
Sets the method for streaming data, we can either host it loacally using a property or refer to external files.
 
  
−
<span style="font-weight: normal;"><u>Max Pages</u></span>
+
===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&nbsp;
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
 +
| width="90%" | index
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 +
| width="90%" | value
 +
|-
 +
| colspan="2" | &nbsp;
 +
|-
 +
| 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''
 +
|}
  
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''max_pages''.
 
  
−
Maximum number of pages we can serve using the embedded page type webserver.
+
==Property reference==
  
−
<span style="font-weight: normal;"><u>Name Page 1</u></span>
+
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''name1''.
+
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
−
 
+
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
−
Name of HTML page 1 - index.htm is the default page that will be presented.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>HTML Page 1</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
 
+
| width="90%" | Label
−
This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html1''.
+
|-
−
 
+
| colspan="2" | Label used to help identify the component on the panel.&nbsp;
−
Embedded HTML code used for page 1
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Name Page 2</u></span>
+
| width="90%" | Max Channels
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''name2''.
+
| colspan="2" | Max number of concurrent channels allowed&nbsp;
−
 
+
|-
−
Name of HTML page 2
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | I2C Address
−
<span style="font-weight: normal;"><u>HTML Page 2</u></span>
+
|-
−
 
+
| colspan="2" | I2C address of the module - bit 0&nbsp;
−
This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html2''.
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Embedded HTML code used for page 2
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | HTML Source
−
 
+
|-
−
<span style="font-weight: normal;"><u>Name Page 3</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
This property is of type ''Line of text'' and can be referenced with the variable name ''name3''.
+
| width="90%" | HTML Source
−
 
+
|-
−
Name of HTML page 3
+
| colspan="2" | Sets the method for streaming data, we can either host it loacally using a property or refer to external files.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>HTML Page 3</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Max Pages
−
This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html3''.
+
|-
−
 
+
| colspan="2" | Maximum number of pages we can serve using the embedded page type webserver.&nbsp;
−
Embedded HTML code used for page 3
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
<span style="font-weight: normal;"><u>Name Page 4</u></span>
+
| width="90%" | Name Page 1
−
 
+
|-
−
This property is of type ''Line of text'' and can be referenced with the variable name ''name4''.
+
| colspan="2" | Name of HTML page 1 - index.htm is the default page that will be presented.&nbsp;
−
 
+
|-
−
Name of HTML page 4
+
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
−
 
+
| width="90%" | HTML Page 1
−
<span style="font-weight: normal;"><u>HTML Page 4</u></span>
+
|-
−
 
+
| colspan="2" | Embedded HTML code used for page 1&nbsp;
−
This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html4''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
Embedded HTML code used for page 4
+
| width="90%" | Name Page 2
−
 
+
|-
−
<span style="font-weight: normal;"><u>Channel</u></span>
+
| colspan="2" | Name of HTML page 2&nbsp;
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c::CHANNEL''.
+
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
−
 
+
| width="90%" | HTML Page 2
−
Channel selection
+
|-
−
 
+
| colspan="2" | Embedded HTML code used for page 2&nbsp;
−
<span style="font-weight: normal;"><u>Baud Select</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_i2c::BAUD_LIST''.
+
| width="90%" | Name Page 3
−
 
+
|-
−
Baud rate option selector
+
| colspan="2" | Name of HTML page 3 &nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Baud Rate</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
−
 
+
| width="90%" | HTML Page 3
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''cal_i2c::BAUD''.
+
|-
−
 
+
| colspan="2" | Embedded HTML code used for page 3 &nbsp;
−
Baud rate to be used
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
−
<span style="font-weight: normal;"><u>Stop Delay</u></span>
+
| width="90%" | Name Page 4
−
 
+
|-
−
This property is of type ''True or false'' and can be referenced with the variable name ''cal_i2c::StopDel''.
+
| colspan="2" | Name of HTML page 4&nbsp;
−
 
+
|-
−
On older microcontroller devices there is a potential for the I2C hardware channel to lock up if there is not
+
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
−
 
+
| width="90%" | HTML Page 4
−
a 10ms delay between an I2C stop event and the next I2C start event.
+
|-
−
 
+
| colspan="2" | Embedded HTML code used for page 4&nbsp;
−
 
+
|-
−
 
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
Most modern microcontrollers will not have a problem so this property can be disabled to speed up the
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
−
 
+
|-
−
I2C communications.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
<span style="font-weight: normal;"><u>SDA</u></span>
+
| width="90%" | Channel
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c::SDA''.
+
| colspan="2" | Channel selection&nbsp;
−
 
+
|-
−
Pin used for SDA (data signal)
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Baud Select
−
<span style="font-weight: normal;"><u>SCL</u></span>
+
|-
−
 
+
| colspan="2" | Baud rate option selector&nbsp;
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_i2c::SCL''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Pin used for SCL (clock signal)
+
| width="90%" | Baud Rate
−
 
+
|-
−
<span style="font-weight: normal;"><u>Int Pin</u></span>
+
| colspan="2" | Baud rate to be used&nbsp;
−
 
+
|-
−
This property is of type ''Single digital pin'' and can be referenced with the variable name ''int_pin''.
+
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]]
−
 
+
| width="90%" | Stop Delay
−
Interrupt pin connection on Wiznet module
+
|-
−
 
+
| colspan="2" | 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. &nbsp;
−
<span style="font-weight: normal;"><u>Gateway0</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway0''.
+
| width="90%" | SDA
−
 
+
|-
−
IP address of the gateway to the internet if applicable.
+
| colspan="2" | Pin used for SDA (data signal)&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Gateway1</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
 
+
| width="90%" | SCL
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway1''.
+
|-
−
 
+
| colspan="2" | Pin used for SCL (clock signal)&nbsp;
−
IP address of the gateway to the internet if applicable.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
−
<span style="font-weight: normal;"><u>Gateway2</u></span>
+
| width="90%" | Int Pin
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway2''.
+
| colspan="2" | Interrupt pin connection on Wiznet module&nbsp;
−
 
+
|-
−
IP address of the gateway to the internet if applicable.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Gateway IP
−
<span style="font-weight: normal;"><u>Gateway3</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway3''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Gateway0
−
IP address of the gateway to the internet if applicable.
+
|-
−
 
+
| colspan="2" | IP address of the gateway to the internet if applicable.&nbsp;
−
<span style="font-weight: normal;"><u>Subnet0</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet0''.
+
| width="90%" | Gateway1
−
 
+
|-
−
Subnet mask of the server - usually 255.255.255.0
+
| colspan="2" | IP address of the gateway to the internet if applicable.&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>Subnet1</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Gateway2
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet1''.
+
|-
−
 
+
| colspan="2" | IP address of the gateway to the internet if applicable.&nbsp;
−
Subnet mask of the server - usually 255.255.255.0
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Subnet2</u></span>
+
| width="90%" | Gateway3
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet2''.
+
| colspan="2" | IP address of the gateway to the internet if applicable.&nbsp;
−
 
+
|-
−
Subnet mask of the server - usually 255.255.255.0
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Subnet Mask
−
<span style="font-weight: normal;"><u>Subnet3</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet3''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Subnet0
−
Subnet mask of the server - usually 255.255.255.0
+
|-
−
 
+
| colspan="2" | Subnet mask of the server - usually 255.255.255.0&nbsp;
−
<span style="font-weight: normal;"><u>IP0</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''ip0''.
+
| width="90%" | Subnet1
−
 
+
|-
−
IP address of the server - usually 192.168.0.x or 192.168.1.x
+
| colspan="2" | Subnet mask of the server - usually 255.255.255.0&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>IP1</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | Subnet2
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''ip1''.
+
|-
−
 
+
| colspan="2" | Subnet mask of the server - usually 255.255.255.0&nbsp;
−
IP address of the server - usually 192.168.0.x or 192.168.1.x
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>IP2</u></span>
+
| width="90%" | Subnet3
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''ip2''.
+
| colspan="2" | Subnet mask of the server - usually 255.255.255.0&nbsp;
−
 
+
|-
−
IP address of the server - usually 192.168.0.x or 192.168.1.x
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | IP Address
−
<span style="font-weight: normal;"><u>IP3</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''ip3''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | IP0
−
IP address of the server - usually 192.168.0.x or 192.168.1.x
+
|-
−
 
+
| colspan="2" | IP address of the server - usually 192.168.0.x or 192.168.1.x&nbsp;
−
<span style="font-weight: normal;"><u>MAC0</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac0''.
+
| width="90%" | IP1
−
 
+
|-
−
MAC address of the server
+
| colspan="2" | IP address of the server - usually 192.168.0.x or 192.168.1.x&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>MAC1</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | IP2
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac1''.
+
|-
−
 
+
| colspan="2" | IP address of the server - usually 192.168.0.x or 192.168.1.x&nbsp;
−
MAC address of the server
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>MAC2</u></span>
+
| width="90%" | IP3
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac2''.
+
| colspan="2" | IP address of the server - usually 192.168.0.x or 192.168.1.x&nbsp;
−
 
+
|-
−
MAC address of the server
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | MAC Address
−
<span style="font-weight: normal;"><u>MAC3</u></span>
+
|-
−
 
+
|-
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac3''.
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | MAC0
−
MAC address of the server
+
|-
−
 
+
| colspan="2" | MAC address of the server&nbsp;
−
<span style="font-weight: normal;"><u>MAC4</u></span>
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac4''.
+
| width="90%" | MAC1
−
 
+
|-
−
MAC address of the server
+
| colspan="2" | MAC address of the server&nbsp;
−
 
+
|-
−
<span style="font-weight: normal;"><u>MAC5</u></span>
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | MAC2
−
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac5''.
+
|-
−
 
+
| colspan="2" | MAC address of the server&nbsp;
−
MAC address of the server
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
<span style="font-weight: normal;"><u>Count</u></span>
+
| width="90%" | MAC3
−
 
+
|-
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Outgoing_Count''.
+
| colspan="2" | MAC address of the server&nbsp;
−
 
+
|-
−
Maximum number of outbound string substitutions
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
 
+
| width="90%" | MAC4
−
<span style="font-weight: normal;"><u>Length 0</u></span>
+
|-
−
 
+
| colspan="2" | MAC address of the server&nbsp;
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Out_Len_0''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
−
Number of bytes to reserve for data string.
+
| width="90%" | MAC5
−
 
+
|-
−
<span style="font-weight: normal;"><u>Length 1</u></span>
+
| colspan="2" | MAC address of the server&nbsp;
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Out_Len_1''.
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Substitutions
−
Number of bytes to reserve for data string.
+
|-
−
 
+
|-
−
<span style="font-weight: normal;"><u>Length 2</u></span>
+
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
−
 
+
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Outgoing
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Out_Len_2''.
+
|-
−
 
+
|-
−
Number of bytes to reserve for data string.
+
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
−
 
+
| width="90%" | Count
−
<span style="font-weight: normal;"><u>Count</u></span>
+
|-
−
 
+
| colspan="2" | Maximum number of outbound string substitutions&nbsp;
−
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Incoming_Count''.
+
|-
−
 
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
Maximum number of inbound string substitutions
+
| width="90%" | Length 0
−
 
+
|-
−
<span style="font-weight: normal;"><u>Length 0</u></span>
+
| colspan="2" | Number of bytes to reserve for data string.&nbsp;
−
 
+
|-
−
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''In_Len_0''.
+
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
−
 
+
| width="90%" | Length 1
−
Number of bytes to reserve for data string.
+
|-
 +
| colspan="2" | Number of bytes to reserve for data string.&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Length 2
 +
|-
 +
| 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="90%" style="background-color:#EAE1EA; color:#4B008D;" | Incoming
 +
|-
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 +
| width="90%" | Count
 +
|-
 +
| colspan="2" | Maximum number of inbound string substitutions&nbsp;
 +
|-
 +
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 +
| width="90%" | Length 0
 +
|-
 +
| colspan="2" | Number of bytes to reserve for data string.&nbsp;
 +
|}

Latest revision as of 13:13, 7 February 2023

Author Matrix TSL
Version 2.0
Category E-blocks 1


Webserver 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_EB023-00-1_EB.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_WebServer_EB023-00-1_EB.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples







Macro reference

CheckSocketActivity

Fc9-comp-macro.png CheckSocketActivity
Checks for activity on the server socket and serves out the webpages to any requesting parties. 
Fc9-u8-icon.png - BYTE Return


CreateServerSocket

Fc9-comp-macro.png CreateServerSocket
Creates a listening socket on the selected channel and port ready to accept incoming web page requests. 
Fc9-u8-icon.png - BYTE Channel
 
Fc9-u8-icon.png - BYTE Port_Hi
 
Fc9-u8-icon.png - BYTE Port_Lo
 
Fc9-u8-icon.png - BYTE Return


GetInValue

Fc9-comp-macro.png GetInValue
Returns the string value of a Request parameter 
Fc9-u8-icon.png - BYTE index
 
Fc9-string-icon.png - STRING Return


IncRxPtr

Fc9-comp-macro.png IncRxPtr
 
Fc9-u8-icon.png - BYTE Channel
 
Fc9-void-icon.png - VOID Return


Initialise

Fc9-comp-macro.png 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  
Fc9-void-icon.png - VOID Return


Send_Embedded_HTML_Page1

Fc9-comp-macro.png Send_Embedded_HTML_Page1
 
Fc9-void-icon.png - VOID Return


Send_Embedded_HTML_Page2

Fc9-comp-macro.png Send_Embedded_HTML_Page2
 
Fc9-void-icon.png - VOID Return


Send_Embedded_HTML_Page3

Fc9-comp-macro.png Send_Embedded_HTML_Page3
 
Fc9-void-icon.png - VOID Return


Send_Embedded_HTML_Page4

Fc9-comp-macro.png Send_Embedded_HTML_Page4
 
Fc9-void-icon.png - VOID Return


SetOutValue

Fc9-comp-macro.png SetOutValue
Set the value of an outbound substitution string 
Fc9-u8-icon.png - BYTE index
 
Fc9-string-icon.png - STRING value
 
Fc9-void-icon.png - VOID Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-10-icon.png Label
Label used to help identify the component on the panel. 
Fc9-type-14-icon.png Max Channels
Max number of concurrent channels allowed 
Fc9-type-16-icon.png I2C Address
I2C address of the module - bit 0 
Fc9-conn-icon.png HTML Source
Fc9-type-16-icon.png HTML Source
Sets the method for streaming data, we can either host it loacally using a property or refer to external files. 
Fc9-type-14-icon.png Max Pages
Maximum number of pages we can serve using the embedded page type webserver. 
Fc9-type-10-icon.png Name Page 1
Name of HTML page 1 - index.htm is the default page that will be presented. 
Fc9-type-11-icon.png HTML Page 1
Embedded HTML code used for page 1 
Fc9-type-10-icon.png Name Page 2
Name of HTML page 2 
Fc9-type-11-icon.png HTML Page 2
Embedded HTML code used for page 2 
Fc9-type-10-icon.png Name Page 3
Name of HTML page 3  
Fc9-type-11-icon.png HTML Page 3
Embedded HTML code used for page 3  
Fc9-type-10-icon.png Name Page 4
Name of HTML page 4 
Fc9-type-11-icon.png HTML Page 4
Embedded HTML code used for page 4 
Fc9-conn-icon.png Connections
Fc9-type-16-icon.png Channel
Channel selection 
Fc9-type-16-icon.png Baud Select
Baud rate option selector 
Fc9-type-14-icon.png Baud Rate
Baud rate to be used 
Fc9-type-7-icon.png 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.  
Fc9-type-5-icon.png SDA
Pin used for SDA (data signal) 
Fc9-type-5-icon.png SCL
Pin used for SCL (clock signal) 
Fc9-type-5-icon.png Int Pin
Interrupt pin connection on Wiznet module 
Fc9-conn-icon.png Gateway IP
Fc9-type-14-icon.png Gateway0
IP address of the gateway to the internet if applicable. 
Fc9-type-14-icon.png Gateway1
IP address of the gateway to the internet if applicable. 
Fc9-type-14-icon.png Gateway2
IP address of the gateway to the internet if applicable. 
Fc9-type-14-icon.png Gateway3
IP address of the gateway to the internet if applicable. 
Fc9-conn-icon.png Subnet Mask
Fc9-type-14-icon.png Subnet0
Subnet mask of the server - usually 255.255.255.0 
Fc9-type-14-icon.png Subnet1
Subnet mask of the server - usually 255.255.255.0 
Fc9-type-14-icon.png Subnet2
Subnet mask of the server - usually 255.255.255.0 
Fc9-type-14-icon.png Subnet3
Subnet mask of the server - usually 255.255.255.0 
Fc9-conn-icon.png IP Address
Fc9-type-14-icon.png IP0
IP address of the server - usually 192.168.0.x or 192.168.1.x 
Fc9-type-14-icon.png IP1
IP address of the server - usually 192.168.0.x or 192.168.1.x 
Fc9-type-14-icon.png IP2
IP address of the server - usually 192.168.0.x or 192.168.1.x 
Fc9-type-14-icon.png IP3
IP address of the server - usually 192.168.0.x or 192.168.1.x 
Fc9-conn-icon.png MAC Address
Fc9-type-14-icon.png MAC0
MAC address of the server 
Fc9-type-14-icon.png MAC1
MAC address of the server 
Fc9-type-14-icon.png MAC2
MAC address of the server 
Fc9-type-14-icon.png MAC3
MAC address of the server 
Fc9-type-14-icon.png MAC4
MAC address of the server 
Fc9-type-14-icon.png MAC5
MAC address of the server 
Fc9-conn-icon.png Substitutions
Fc9-conn-icon.png Outgoing
Fc9-type-16-icon.png Count
Maximum number of outbound string substitutions 
Fc9-type-21-icon.png Length 0
Number of bytes to reserve for data string. 
Fc9-type-21-icon.png Length 1
Number of bytes to reserve for data string. 
Fc9-type-21-icon.png Length 2
Number of bytes to reserve for data string. 
Fc9-conn-icon.png Incoming
Fc9-type-16-icon.png Count
Maximum number of inbound string substitutions 
Fc9-type-21-icon.png Length 0
Number of bytes to reserve for data string. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Webserver_(EB023_v1)_(E-blocks_1)&oldid=38422"