Difference between revisions of "Component: Reddit News Headlines (Comms: IoT/Cloud)"
From Flowcode Help
Jump to navigationJump to search| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
| − | Please click here | + | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_RedditNewsHeadlines.fcfx FC_Comp_Source_RedditNewsHeadlines.fcfx] |
==Detailed description== | ==Detailed description== | ||
| + | |||
| + | |||
| Line 40: | Line 42: | ||
==Examples== | ==Examples== | ||
| + | |||
| + | |||
| Line 63: | Line 67: | ||
==Macro reference== | ==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;" | '''GetHeadline''' | ||
| + | |- | ||
| + | | colspan="2" | Returns the next headline in the prodivded string parameter. Returns true if a new headline is available, else returns false if we are at the end of the feed. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| + | | width="90%" | Headline | ||
| + | |- | ||
| + | | colspan="2" | | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | ||
| + | | width="90%" | MaxLength | ||
| + | |- | ||
| + | | colspan="2" | The maximum size of the string variable available to us. | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | 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;" | '''RequestData''' | ||
| + | |- | ||
| + | | colspan="2" | Requests headline RSS feed from reddit Returns true if the request was successful. Must be called before trying to call the GetHeadline macro. | ||
| + | |- | ||
| + | |- | ||
| + | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| + | | 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" | Sets up the component ready to collect weather data. | ||
| + | |- | ||
| + | |- | ||
| + | | 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-17-icon.png]] | ||
| + | | width="90%" | Network Comms Component | ||
| + | |- | ||
| + | | colspan="2" | Network Communications component to use as the bridge to the TCP/IP network. | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| + | | width="90%" | Reddit IP Address | ||
| + | |- | ||
| + | | colspan="2" | IP Address linked to the following URL: reddit.com | ||
| + | |- | ||
| + | | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | ||
| + | | width="90%" | Receive Timeout | ||
| + | |- | ||
| + | | colspan="2" | Maximum time to wait for valid incoming data. | ||
| + | |}==Macro reference== | ||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 15:16, 20 January 2023
| Author | MatrixTSL |
| Version | 1.0 |
| Category | Comms: IoT/Cloud |
Contents
Reddit News Headlines component
Easily allows you to collect the news headlines RSS feed from reddit.com
Component Source Code
Please click here to view the component source code (Beta): FC_Comp_Source_RedditNewsHeadlines.fcfx
Detailed description
No detailed description exists yet for this component
Examples
RTC DS1307 DS3231 Example.fcfx
Example showing how to retrieve and display the time using bytes or string RTC component.
Macro reference
|
GetHeadline |
| Returns the next headline in the prodivded string parameter. Returns true if a new headline is available, else returns false if we are at the end of the feed. | |
 - STRING
|
Headline |
 - UINT
|
MaxLength |
| The maximum size of the string variable available to us. | |
 - BOOL
|
Return |
|
|
RequestData |
| Requests headline RSS feed from reddit Returns true if the request was successful. Must be called before trying to call the GetHeadline macro. | |
| - BOOL
|
Return |
|
|
Initialise |
| Sets up the component ready to collect weather data. | |
 - VOID
|
Return |
Property reference
|
Properties |
|
Network Comms Component |
| Network Communications component to use as the bridge to the TCP/IP network. | |
|
Reddit IP Address |
| IP Address linked to the following URL: reddit.com | |
|
Receive Timeout |
| Maximum time to wait for valid incoming data. | |
==Macro reference==
|
|
GetHeadline |
| Returns the next headline in the prodivded string parameter. Returns true if a new headline is available, else returns false if we are at the end of the feed. | |
| - STRING
|
Headline |
| - UINT
|
MaxLength |
| The maximum size of the string variable available to us. | |
| - BOOL
|
Return |
|
|
RequestData |
| Requests headline RSS feed from reddit Returns true if the request was successful. Must be called before trying to call the GetHeadline macro. | |
| - BOOL
|
Return |
|
|
Initialise |
| Sets up the component ready to collect weather data. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
Network Comms Component |
| Network Communications component to use as the bridge to the TCP/IP network. | |
|
|
Reddit IP Address |
| IP Address linked to the following URL: reddit.com | |
|
|
Receive Timeout |
| Maximum time to wait for valid incoming data. | |
