Component: WLAN (ESP8266) (Comms: Networking)
From Flowcode Help
(Redirected from Component: ID e1bb4679 58ef 40dc 8d09 306ada46f7bf)
Jump to navigationJump to searchAuthor | Matrix Ltd. |
Version | 2.1 |
Category | Comms: Networking |
Contents
- 1 WLAN (ESP8266) component
- 2 Component Source Code
- 3 Detailed description
- 4 Examples
- 5 Macro reference
- 5.1 CheckForPageRequests
- 5.2 CheckTCPServerIP
- 5.3 ClientConnect
- 5.4 ClientSendArray
- 5.5 ClientSendRequest
- 5.6 ConnectToSSID
- 5.7 ControlTCPServer
- 5.8 CreateAccessPoint
- 5.9 DisconnectFromSSID
- 5.10 EndServerConnection
- 5.11 GetByteWithTimeout
- 5.12 GetFirmwareVersion
- 5.13 GetInValue
- 5.14 GetRxArray
- 5.15 Initialise
- 5.16 ReadEncryptionModeFromScan
- 5.17 ReadSSIDFromScan
- 5.18 ReadSignalStrengthFromScan
- 5.19 ScanForSSID
- 5.20 SendString
- 5.21 Send_Embedded_HTML_Page1
- 5.22 Send_Embedded_HTML_Page2
- 5.23 Send_Embedded_HTML_Page3
- 5.24 Send_Embedded_HTML_Page4
- 5.25 SetOutValue
- 6 Property reference
WLAN (ESP8266) component
Wireless LAN component designed to work with the ESP8266 module. Provides a very simple interface to allow webpages to be hosted from hardware or simulation. Also available in the form of the EB069 E-block.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_WLAN_ESP8266.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_WLAN_ESP8266.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
CheckForPageRequests
CheckForPageRequests | |
To be called periodically. Returns non-zero if a request has been processed | |
- BYTE | Return |
CheckTCPServerIP
CheckTCPServerIP | |
Collects the local IP address of the active TCP server. | |
- STRING | Return |
ClientConnect
ClientSendArray
ClientSendArray | |
Sends out an array of data bytes with the required AT+CIPSEND=Length$(Request) initialiser. | |
- BYTE | Data |
- UINT | NumBytes |
- VOID | Return |
ClientSendRequest
ClientSendRequest | |
Sends out a string with the required AT+CIPSEND=Length$(Request) initialiser. | |
- STRING | Request |
e.g. "GET / HTTP/1.0\r\n\r\n" | |
- VOID | Return |
ConnectToSSID
ControlTCPServer
CreateAccessPoint
DisconnectFromSSID
DisconnectFromSSID | |
Disconnects from the current SSID. Returns 1 if the command was accepted and returned an "OK" | |
- BYTE | Return |
EndServerConnection
EndServerConnection | |
Disconnects from the current active TCP/IP pipe. | |
- BYTE | Return |
GetByteWithTimeout
GetByteWithTimeout | |
Attempts to receive a byte from the circular buffer. If nothing is available then waits up to 200 ms for data to become available. | |
- BYTE | Return |
GetFirmwareVersion
GetFirmwareVersion | |
Collects the firmware version from the ESP8266 module and returns it as a string. | |
- STRING | Return |
GetInValue
GetInValue | |
Returns the string value of a Request parameter | |
- BYTE | index |
Index of the request paramter, starting at zero Range 0-2 | |
- STRING | Return |
GetRxArray
Initialise
Initialise | |
Initialise the device with the property data. Returns 1 if "ready" message successfully received Returns 0 if no reply from module | |
- BYTE | Return |
ReadEncryptionModeFromScan
ReadSSIDFromScan
ReadSSIDFromScan | |
Collects one of the SSID name strings from the last SSID Scan. The ScanForSSID macro must be called first. | |
- BYTE | Index |
SSID Index | |
- STRING | Return |
ReadSignalStrengthFromScan
ScanForSSID
SendString
Send_Embedded_HTML_Page1
Send_Embedded_HTML_Page1 | |
- VOID | Return |
Send_Embedded_HTML_Page2
Send_Embedded_HTML_Page2 | |
- VOID | Return |
Send_Embedded_HTML_Page3
Send_Embedded_HTML_Page3 | |
- VOID | Return |
Send_Embedded_HTML_Page4
Send_Embedded_HTML_Page4 | |
- VOID | Return |
SetOutValue
SetOutValue | |
Set the value of an outbound substitution string | |
- BYTE | index |
Range 0-4 | |
- STRING | value |
- VOID | Return |