View source for Component: Webserver (GENERIC Flash / File) (Comms: Networking)

From Flowcode Help

← Component: Webserver (GENERIC Flash / File) (Comms: Networking)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | Matrix Ltd. |- | width="20%" style="color:gray;" | Version | 1.5 |- | width="20%" style="color:gray;" | Category | Comms: Networking |} ==Webserver (GENERIC - Flash / File) component== Webserver component designed to work with Network Comms abstraction layer. Provides a very simple interface to allow webpages to be hosted from hardware or simulation. Webpages can be embedded into ROM or can be pulled directly from a local file or a SD card via the File component. The File mode allows for images and other media to be served to the web client. ==Component Pack== COMMSC ==Detailed description== ''No detailed description exists yet for this component'' ==Examples== ===Webserver Embedded Files=== A simple example demonstrating how to host a website with fixed HTTP content including dynamic sections that can be passed in and out of Flowcode SCADA. For example a dynamic section could be used to display a variable value on a webpage such as a temperature or used to control Flowcode e.g. turn on an output. {{Fcfile|Webserver_Embedded.fcsx|Webserver Embedded}} ===Webserver Dynamic Files=== ====Flowcode Embedded==== A simple example demonstrating how to host a website with dynamic content based on external files including dynamic sections that can be passed in and out of an embedded system using an SD card and an ESP8266 module. For example a dynamic section could be used to display a variable value on a webpage such as a temperature or used to control Flowcode e.g. turn on an output. {{Fcfile|ESP8266_Webserver.fcfx|ESP8266 Webserver FileSystem}} {{Zip|WebserverFiles.zip|Webserver Files}} ====Flowcode App Developer==== A simple example demonstrating how to host a website with dynamic content based on external files including dynamic sections that can be passed in and out of Flowcode App Developer. For example a dynamic section could be used to display a variable value on a webpage such as a temperature or used to control Flowcode e.g. turn on an output. {{Fcfile|Webserver_FileSystem.fcsx|Webserver FileSystem}} {{Zip|WebserverFiles.zip|Webserver Files}} ==Downloadable macro reference== {| 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;" | '''GetInValueFloat''' |- | colspan="2" | Returns the float value of an incoming Request parameter  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Index |- | colspan="2" | Range: 0 to IncomingCount - 1  |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-f32-icon.png]] - FLOAT | 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;" | '''SetOutValueFloat''' |- | colspan="2" | Sets one of the outgoing substitution values from a floating point value.  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Index |- | colspan="2" | Range: 0 to OutgoingCount - 1  |- | width="10%" align="center" | [[File:Fc9-f32-icon.png]] - FLOAT | width="90%" | Value |- | colspan="2" | Floating point value to assign to the substitution  |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | NumDP |- | colspan="2" | Number of decimal points to add  |- | 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'' |} {| 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;" | '''SetOutValueLong''' |- | colspan="2" | Sets one of the outgoing substitution values from a numeric value.  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Index |- | colspan="2" | Range: 0 to OutgoingCount - 1  |- | width="10%" align="center" | [[File:Fc9-s32-icon.png]] - LONG | width="90%" | Value |- | colspan="2" | signed long integer value to assign to the substitution  |- | 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'' |} {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |- | width="10%" align="center" style="background-color:#D8C9D8;" align="center" | [[File:Fc9-comp-macro.png]] | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''SetOutValue''' |- | colspan="2" | Set the value of an outbound substitution string  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Index |- | colspan="2" | Incoming string Index Range: 0 to Outgoing Count - 1  |- | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | width="90%" | Value |- | colspan="2" | Value string to assign  |- | 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'' |} {| 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 an incoming Request parameter  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Index |- | colspan="2" | Incoming string Index Range: 0 to Incoming Count - 1  |- | 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'' |} {| 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;" | '''GetInValueLong''' |- | colspan="2" | Returns the integer value of an incoming Request parameter  |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Index |- | colspan="2" | Range: 0 to IncomingCount - 1  |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s32-icon.png]] - LONG | 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;" | '''CreateServerSocket''' |- | colspan="2" | Creates a listening socket on the selected port ready to accept incoming web page requests. Returns: 1 = OK / 0 = Listen Err / 255 = Socket Open Err  |- |- | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | width="90%" | Port |- | colspan="2" | Default HTTP port = 80  |- | 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;" | '''CheckSocketActivity''' |- | colspan="2" | Checks for activity on the server socket and serves out the webpages to any requesting parties. Returns: URL string request, or null string if no activity has occured.  |- |- | 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'' |} {| 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 Web Server component.  |- |- | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ==Property reference== {| class="wikitable" style="width:60%; background-color:#FFFFFF;" |- | width="10%" align="center" style="background-color:#D8C9D8;" | [[File:Fc9-prop-icon.png]] | width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Properties''' |- |- | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | width="90%" | Label |- | colspan="2" | Label used to help identify the component on the panel.  |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | RX Buffer Size |- | colspan="2" |   |- | width="10%" align="center" | [[File:Fc9-type-17-icon.png]] | width="90%" | Network Comms Component |- | colspan="2" | Redirects communications via the selected component allowing different TCP/IP modules with different macros to work.  |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Source Files |- |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | HTML Source |- | colspan="2" | Sets the method for streaming data, we can either host it loacally using a property or refer to external files.  |- | width="10%" align="center" | [[File:Fc9-type-14-icon.png]] | width="90%" | Max Pages |- | colspan="2" | Maximum number of pages we can serve using the embedded page type webserver. Currently limited to 4 pages.  |- | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | width="90%" | Name Page 1 |- | colspan="2" | Name of HTML page 1 - index.htm is the default page that will be presented.  |- | width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | width="90%" | HTML Page 1 |- | colspan="2" | Embedded HTML code used for page 1  |- | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | width="90%" | Name Page 2 |- | colspan="2" | Name of HTML page 2  |- | width="10%" align="center" | [[File:Fc9-type-11-icon.png]] | width="90%" | HTML Page 2 |- | colspan="2" | Embedded HTML code used for page 2   |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Substitutions |- |- | width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Outgoing |- |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Count |- | colspan="2" | Maximum number of outbound string substitutions  |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Length 0 |- | colspan="2" | 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;" | Incoming |- |- | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | width="90%" | Count |- | colspan="2" | Maximum number of inbound string substitutions  |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Length 0 |- | colspan="2" | Number of bytes to reserve for data string.  |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Length 1 |- | colspan="2" | Number of bytes to reserve for data string.  |}

Return to Component: Webserver (GENERIC Flash / File) (Comms: Networking).