Component: Reddit News Headlines (Comms: IoT/Cloud): Difference between revisions

Revision as of 12:02, 3 February 2023

Author	MatrixTSL
Version	1.0
Category	Comms: IoT/Cloud

Reddit News Headlines component

Easily allows you to collect the news headlines RSS feed from reddit.com

Component Source Code

Please click here to download the component source project: FC_Comp_Source_temp/RedditNewsHeadlines.fcfx

Please click here to view the component source code (Beta): FC_Comp_Source_temp/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

	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

Initialise

	Initialise
Sets up the component ready to collect weather data.
- VOID	Return

RequestData

	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

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.

@@ Line 17: / Line 17: @@
 ==Component Source Code==
-Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_RedditNewsHeadlines.fcfx FC_Comp_Source_RedditNewsHeadlines.fcfx]
+Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/RedditNewsHeadlines.fcfx FC_Comp_Source_temp/RedditNewsHeadlines.fcfx]
-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]
+Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/RedditNewsHeadlines.fcfx FC_Comp_Source_temp/RedditNewsHeadlines.fcfx]
 ==Detailed description==
@@ Line 79: / Line 79: @@
 Example showing how to retrieve and display the time using bytes or string RTC component.
@@ Line 110: / Line 112: @@
-===RequestData===
+===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;" | '''RequestData'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''Initialise'''
 |-
-| 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.&nbsp;
+| colspan="2" | Sets up the component ready to collect weather data.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-bool-icon.png]] - BOOL
+| 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''
 |}
-===Initialise===
+===RequestData===
 {| 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'''
+| width="90%" style="background-color:#D8C9D8; color:#4B008D;" | '''RequestData'''
 |-
-| colspan="2" | Sets up the component ready to collect weather data.&nbsp;
+| 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.&nbsp;
 |-
 |-
-| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-void-icon.png]] - VOID
+| 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''
 |}

Wiki bot (talk | contribs)