Jump to content

Component: Webserver (EB023 v2) (E-blocks 1): Difference between revisions

From Flowcode Help
Newer edit →

Wiki bot (talk | contribs)

3 user groups
14,227 edits
XML import - Pre 8.0 release
 
No edit summary
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 WIZ810MJ module from Wiznet, as used in the version 2 EB023 E-block and MIAC System Industrial Addon. Provides a very simple interface to allow webpages to be hosted from hardware or simulation.


==[[File:Component Icon ee1635e0_3008_4836_89e1_005435f4a33d.png|Image]] Webserver (EB023 v2) component==
==Component Source Code==
Webserver component designed to work with the WIZ810MJ module from Wiznet,
as used in the version 2 EB023 E-block and MIAC System Industrial Addon.
Provides a very simple interface to allow webpages to be hosted from hardware or simulation.


==Examples==
Please click here for the component source code: [https://www.flowcode.co.uk/wikicopy/componentsource/FC_Comp_Source_WebServer_EB023-00-2_EB.fcfx FC_Comp_Source_WebServer_EB023-00-2_EB.fcfx]
''<span style="color:red;">No additional examples</span>''


==Detailed description==


==Downloadable macro reference==
''No detailed description exists yet for this component''


===<span style="font-weight: normal;"><u><tt>SetOutValue</tt></u></span>===
==Examples==
Set the value of an outbound substitution string


'''Parameters'''


:[[Variable Types|BYTE]] ''index''
''<span style="color:red;">No additional examples</span>''


:[[Variable Types|<- STRING]] ''value''
::''This parameter may be returned back to the caller''


==Downloadable macro reference==


'''Return value'''
{| 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;" | '''WM_CH_MR'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:''This call does not return a value''


{| 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;" | '''WM_CH_PORT'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


===<span style="font-weight: normal;"><u><tt>GetInValue</tt></u></span>===
Returns the string value of a Request parameter


'''Parameters'''
{| 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;" | '''WM_TXMEM'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]] ''index''


{| 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;" | '''MIAC_Module_SetData'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Count
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D0
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D1
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D2
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D3
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D4
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | D5
|-
| 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''
|}


'''Return value'''


:[[Variable Types|STRING]]
{| 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;" | '''WM_CH_RX_RSR'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




===<span style="font-weight: normal;"><u><tt>CreateServerSocket</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Creates a listening socket on the selected channel and port ready to accept incoming web page requests.
|-
| width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]]
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''MIAC_Module_GetData'''
|-
| colspan="2" | &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-u8-icon.png]] - BYTE
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


'''Parameters'''


:[[Variable Types|BYTE]] ''Channel''
{| 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''
|}


:[[Variable Types|UINT]] ''Port''


{| 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''
|}


'''Return value'''


:[[Variable Types|BYTE]]
{| 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;" | '''MIAC_Module_Message'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CAN_ID
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" | CMD_ID
|-
| 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''
|}




===<span style="font-weight: normal;"><u><tt>CheckSocketActivity</tt></u></span>===
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
Checks for activity on the server socket and serves out the webpages to any requesting parties.
|-
| 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''
|}


'''Parameters'''


:''This macro has no parameters''
{| 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''
|}




'''Return value'''
{| 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;" | '''WM_CH_IR'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


:[[Variable Types|BYTE]]


{| 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''
|}


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


:''This macro has no parameters''


{| 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;" | '''MIAC_Module_PushData'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | Data
|-
| 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''
|}


'''Return value'''


:''This call does not return a value''
{| 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-u16-icon.png]] - UINT
| width="90%" | Port
|-
| 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''
|}




{| 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;" | '''WM_CH_CR'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


==Simulation macro reference==


''This component does not contain any simulation macros''
{| 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;" | '''WM_CH_TX_WR'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}




==Property reference==
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
<span style="font-weight: normal;"><u>Max Pages</u></span>
|-
| 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 ''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.
{| 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''
|}


<span style="font-weight: normal;"><u>Name Page 1</u></span>


This property is of type ''Line of text'' and can be referenced with the variable name ''name1''.
{| 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;" | '''WM_CH_SR'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


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>
{| 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;" | '''WM_RXMEM'''
|-
| colspan="2" | &nbsp;
|-
|-
| width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE
| width="90%" | ch
|-
| colspan="2" | &nbsp;
|-
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT
| width="90%" style="border-top: 2px solid #000;" | ''Return''
|}


This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html1''.


Embedded HTML code used for page 1
{| 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>Name Page 2</u></span>


This property is of type ''Line of text'' and can be referenced with the variable name ''name2''.


Name of HTML page 2


<span style="font-weight: normal;"><u>HTML Page 2</u></span>
==Property reference==


This property is of type ''Multiple lines of text'' and can be referenced with the variable name ''html2''.
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
Embedded HTML code used for page 2
| width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]]
 
| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties'''  
<span style="font-weight: normal;"><u>Name Page 3</u></span>
|-
 
|-
This property is of type ''Line of text'' and can be referenced with the variable name ''name3''.
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | HTML Source
Name of HTML page 3
|-
 
|-
<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>MIAC Industrial Addon</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 ''ORDINAL''.
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
 
| width="90%" | HTML Page 2
''<span style="color:red;">No additional information</span>''
|-
 
| colspan="2" | Embedded HTML code used for page 2 &nbsp;
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
<span style="font-weight: normal;"><u>Channel</u></span>
| width="90%" | Name Page 3
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::CHANNEL''.
| colspan="2" | Name of HTML page 3&nbsp;
 
|-
SPI Channel selector
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
 
| width="90%" | HTML Page 3
<span style="font-weight: normal;"><u>Prescale</u></span>
|-
 
| colspan="2" | Embedded HTML code used for page 3&nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::PR_SCALE''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
Prescale option selector
| width="90%" | Name Page 4
 
|-
<span style="font-weight: normal;"><u>MOSI</u></span>
| colspan="2" | Name of HTML page 4&nbsp;
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::MOSI''.
| width="10%" align="center" | [[File:Fc9-type-11-icon.png]]
 
| width="90%" | HTML Page 4
SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.
|-
 
| colspan="2" | Embedded HTML code used for page 4&nbsp;
<span style="font-weight: normal;"><u>MISO</u></span>
|-
 
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::MISO''.
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Connections
 
|-
SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
<span style="font-weight: normal;"><u>CLK</u></span>
| width="90%" | Channel
 
|-
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::CLK''.
| colspan="2" | SPI Channel selector&nbsp;
 
|-
SPI Clock Pin CLK - The Clock signal is driven by the SPI master.
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Prescale
<span style="font-weight: normal;"><u>CS / SS</u></span>
|-
 
| colspan="2" | Prescale option selector&nbsp;
This property is of type ''Single digital pin'' and can be referenced with the variable name ''cal_spi::SS''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
Chip Select / Slave Select Pin
| width="90%" | MOSI
 
|-
Master Mode: General purpose output pin used to select the remote SPI device.
| colspan="2" | SPI Data Out Pin SDO - Also Known as Master Out Slave In (MOSI) when used in Master mode.&nbsp;
 
|-
Slave Mode: Hardware chip select pin input used to select the SPI device.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | MISO
<span style="font-weight: normal;"><u>Int Pin</u></span>
|-
 
| colspan="2" | SPI Data In Pin SDI - Also Known as Master In Slave Out (MISO) when used in Master mode.&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-5-icon.png]]
Interrupt pin connection on Wiznet module
| width="90%" | CLK
 
|-
<span style="font-weight: normal;"><u>Gateway0</u></span>
| colspan="2" | SPI Clock Pin CLK - The Clock signal is driven by the SPI master.&nbsp;
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway0''.
| width="10%" align="center" | [[File:Fc9-type-5-icon.png]]
 
| width="90%" | CS / SS
IP address of the gateway to the internet if applicable.
|-
 
| colspan="2" | 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. &nbsp;
<span style="font-weight: normal;"><u>Gateway1</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 ''gateway1''.
| width="90%" | Int Pin
 
|-
IP address of the gateway to the internet if applicable.
| colspan="2" | Interrupt pin connection on Wiznet module&nbsp;
 
|-
<span style="font-weight: normal;"><u>Gateway2</u></span>
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Gateway IP
This property is of type ''Signed integer'' and can be referenced with the variable name ''gateway2''.
|-
 
|-
IP address of the gateway to the internet if applicable.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Gateway0
<span style="font-weight: normal;"><u>Gateway3</u></span>
|-
 
| colspan="2" | IP address of the gateway to the internet if applicable.&nbsp;
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]]
IP address of the gateway to the internet if applicable.
| width="90%" | Gateway1
 
|-
<span style="font-weight: normal;"><u>Subnet0</u></span>
| colspan="2" | IP address of the gateway to the internet if applicable.&nbsp;
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet0''.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Gateway2
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]]
This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet1''.
| width="90%" | Gateway3
 
|-
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>Subnet2</u></span>
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Subnet Mask
This property is of type ''Signed integer'' and can be referenced with the variable name ''subnet2''.
|-
 
|-
Subnet mask of the server - usually 255.255.255.0
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Subnet0
<span style="font-weight: normal;"><u>Subnet3</u></span>
|-
 
| colspan="2" | Subnet mask of the server - usually 255.255.255.0&nbsp;
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]]
Subnet mask of the server - usually 255.255.255.0
| width="90%" | Subnet1
 
|-
<span style="font-weight: normal;"><u>IP0</u></span>
| colspan="2" | Subnet mask of the server - usually 255.255.255.0&nbsp;
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''ip0''.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | Subnet2
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]]
This property is of type ''Signed integer'' and can be referenced with the variable name ''ip1''.
| width="90%" | Subnet3
 
|-
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>IP2</u></span>
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | IP Address
This property is of type ''Signed integer'' and can be referenced with the variable name ''ip2''.
|-
 
|-
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]]
 
| width="90%" | IP0
<span style="font-weight: normal;"><u>IP3</u></span>
|-
 
| colspan="2" | IP address of the server - usually 192.168.0.x or 192.168.1.x&nbsp;
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]]
IP address of the server - usually 192.168.0.x or 192.168.1.x
| width="90%" | IP1
 
|-
<span style="font-weight: normal;"><u>MAC0</u></span>
| colspan="2" | IP address of the server - usually 192.168.0.x or 192.168.1.x&nbsp;
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac0''.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | IP2
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]]
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac1''.
| width="90%" | IP3
 
|-
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>MAC2</u></span>
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | MAC Address
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac2''.
|-
 
|-
MAC address of the server
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | MAC0
<span style="font-weight: normal;"><u>MAC3</u></span>
|-
 
| colspan="2" | MAC address of the server&nbsp;
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]]
MAC address of the server
| width="90%" | MAC1
 
|-
<span style="font-weight: normal;"><u>MAC4</u></span>
| colspan="2" | MAC address of the server&nbsp;
 
|-
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac4''.
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | MAC2
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]]
This property is of type ''Signed integer'' and can be referenced with the variable name ''mac5''.
| width="90%" | MAC3
 
|-
MAC address of the server
| colspan="2" | MAC address of the server&nbsp;
 
|-
<span style="font-weight: normal;"><u>Count</u></span>
| width="10%" align="center" | [[File:Fc9-type-14-icon.png]]
 
| width="90%" | MAC4
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]]
<span style="font-weight: normal;"><u>Length 0</u></span>
| width="90%" | MAC5
 
|-
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Out_Len_0''.
| colspan="2" | MAC address of the server&nbsp;
 
|-
Number of bytes to reserve for data string.
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Substitutions
<span style="font-weight: normal;"><u>Length 1</u></span>
|-
 
|-
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;" | Outgoing
Number of bytes to reserve for data string.
|-
 
|-
<span style="font-weight: normal;"><u>Length 2</u></span>
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Count
This property is of type ''Unsigned integer'' and can be referenced with the variable name ''Out_Len_2''.
|-
 
| colspan="2" | Maximum number of outbound string substitutions&nbsp;
Number of bytes to reserve for data string.
|-
 
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
<span style="font-weight: normal;"><u>Count</u></span>
| width="90%" | Length 0
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''Incoming_Count''.
| colspan="2" | Number of bytes to reserve for data string.&nbsp;
 
|-
Maximum number of inbound string substitutions
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
| width="90%" | Length 1
<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]]
Number of bytes to reserve for data string.
| width="90%" | Length 2
 
|-
<span style="font-weight: normal;"><u>Label</u></span>
| colspan="2" | Number of bytes to reserve for data string.&nbsp;
 
|-
This property is of type ''Line of text'' and can be referenced with the variable name ''label''.
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Incoming
Label used to help identify the component on the panel.
|-
 
|-
<span style="font-weight: normal;"><u>Sim Type</u></span>
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Count
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''SimType''.
|-
 
| colspan="2" | Maximum number of inbound string substitutions&nbsp;
Decides how to perform the simulation of the component.
|-
 
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
TCP IP - Communicates using the Windows TCP IP communications DLL
| width="90%" | Length 0
 
|-
SPI / Injector - Communicates using the CAL SPI to allow the communications to be analysed and debugged.
| colspan="2" | Number of bytes to reserve for data string.&nbsp;
 
|-
<span style="font-weight: normal;"><u>Scope Traces</u></span>
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Simulation
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi::ScopeTraces''.
|-
 
|-
Selects if the scope traces are automatically generated or not
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]]
 
| width="90%" | Label
<span style="font-weight: normal;"><u>Console Data</u></span>
|-
 
| colspan="2" | Label used to help identify the component on the panel.&nbsp;
This property is of type ''True or false'' and can be referenced with the variable name ''cal_spi::ConsoleData''.
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
Selects if the console data is automatically generated or not
| width="90%" | Sim Type
 
|-
<span style="font-weight: normal;"><u>Injector</u></span>
| 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;
 
|-
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''cal_spi::Injector''.
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]]
 
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | TCP Simulation
''<span style="color:red;">No additional information</span>''
|-
 
|-
 
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]]
 
| width="90%" | Network Interface
<span style="font-weight: normal;"><u>Network Interface</u></span>
|-
 
| colspan="2" | List of network interfaces connected to the PC. Sets which interface we are communicating via.&nbsp;
This property is of type ''Fixed list of ints'' and can be referenced with the variable name ''TCP_Base::interface''.
|}
 
List of network interfaces connected to the PC.  
 
Sets which interface we are communicating via.

Revision as of 14:43, 16 January 2023

Author Matrix TSL
Version 2.0
Category E-blocks 1


Webserver component

Webserver component designed to work with the WIZ810MJ module from Wiznet, as used in the version 2 EB023 E-block and MIAC System Industrial Addon. Provides a very simple interface to allow webpages to be hosted from hardware or simulation.

Component Source Code

Please click here for the component source code: FC_Comp_Source_WebServer_EB023-00-2_EB.fcfx

Detailed description

No detailed description exists yet for this component

Examples

No additional examples


Downloadable macro reference

WM_CH_MR
 
- BYTE ch
 
- UINT Return


WM_CH_PORT
 
- BYTE ch
 
- UINT Return


WM_TXMEM
 
- BYTE ch
 
- UINT Return


MIAC_Module_SetData
 
- BYTE Count
 
- BYTE D0
 
- BYTE D1
 
- BYTE D2
 
- BYTE D3
 
- BYTE D4
 
- BYTE D5
 
- VOID Return


WM_CH_RX_RSR
 
- BYTE ch
 
- UINT Return


MIAC_Module_GetData
 
- BYTE Index
 
- BYTE Return


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


Send_Embedded_HTML_Page4
 
- VOID Return


MIAC_Module_Message
 
- UINT CAN_ID
 
- UINT CMD_ID
 
- BYTE Return


Send_Embedded_HTML_Page3
 
- VOID Return


Send_Embedded_HTML_Page2
 
- VOID Return


WM_CH_IR
 
- BYTE ch
 
- UINT Return


Send_Embedded_HTML_Page1
 
- VOID Return


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


MIAC_Module_PushData
 
- BYTE Data
 
- VOID Return


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


WM_CH_CR
 
- BYTE ch
 
- UINT Return


WM_CH_TX_WR
 
- BYTE ch
 
- UINT Return


IncRxPtr
 
- BYTE Channel
 
- VOID Return


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


WM_CH_SR
 
- BYTE ch
 
- UINT Return


WM_RXMEM
 
- BYTE ch
 
- UINT Return


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
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. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Webserver_(EB023_v2)_(E-blocks_1)&oldid=31311"