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

From Flowcode Help
Jump to navigationJump to search
 
(7 intermediate revisions by one other user not shown)
Line 16: Line 16:
  
 
==Component Source Code==
 
==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 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_RedditNewsHeadlines.fcfx FC_Comp_Source_RedditNewsHeadlines.fcfx]
  
 
==Detailed description==
 
==Detailed description==
 +
 +
 +
 +
 +
 +
  
  
Line 62: Line 70:
  
  
−
{{Fcfile|RTC DS1307 DS3231 Example.fcfx|RTC DS1307 DS3231 Example.fcfx}}
 
  
−
Example showing how to retrieve and display the time using bytes or string RTC component.
+
''<span style="color:red;">No additional examples</span>''
  
 
==Macro reference==
 
==Macro reference==
  
 +
===GetHeadline===
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 91: Line 99:
  
  
−
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
+
===Initialise===
−
|-
 
−
| 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.&nbsp;
 
−
|-
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 117: Line 113:
  
  
−
 
+
===RequestData===
−
 
 
−
==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.&nbsp;
 
−
|-
 
−
| 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&nbsp;
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]]
 
−
| width="90%" | Receive Timeout
 
−
|-
 
−
| colspan="2" | Maximum time to wait for valid incoming data.&nbsp;
 
−
|}==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.&nbsp;
 
−
|-
 
−
|-
 
−
| width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING
 
−
| width="90%" | Headline
 
−
|-
 
−
| colspan="2" | &nbsp;
 
−
|-
 
−
| 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.&nbsp;
 
−
|-
 
−
| 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;"
 
{| class="wikitable" style="width:60%; background-color:#FFFFFF;"
 
|-
 
|-
Line 177: Line 125:
 
| width="90%" style="border-top: 2px solid #000;" | ''Return''
 
| 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.&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''
 
−
|}
 
−
 
−
 
  
  

Latest revision as of 14:41, 24 July 2024

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_RedditNewsHeadlines.fcfx

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

No additional examples

Macro reference

GetHeadline

Fc9-comp-macro.png 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. 
Fc9-string-icon.png - STRING Headline
 
Fc9-u16-icon.png - UINT MaxLength
The maximum size of the string variable available to us. 
Fc9-bool-icon.png - BOOL Return


Initialise

Fc9-comp-macro.png Initialise
Sets up the component ready to collect weather data. 
Fc9-void-icon.png - VOID Return


RequestData

Fc9-comp-macro.png RequestData
Requests headline RSS feed from reddit Returns true if the request was successful. Must be called before trying to call the GetHeadline macro. 
Fc9-bool-icon.png - BOOL Return


Property reference

Fc9-prop-icon.png Properties
Fc9-type-17-icon.png Network Comms Component
Network Communications component to use as the bridge to the TCP/IP network. 
Fc9-type-10-icon.png Reddit IP Address
IP Address linked to the following URL: reddit.com 
Fc9-type-21-icon.png Receive Timeout
Maximum time to wait for valid incoming data. 
Retrieved from "https://www.flowcode.co.uk/wiki/index.php?title=Component:_Reddit_News_Headlines_(Comms:_IoT/Cloud)&oldid=41009"