Component: BBC News (Comms: IoT/Cloud): Difference between revisions
No edit summary |
No edit summary |
||
| Line 17: | Line 17: | ||
==Component Source Code== | ==Component Source Code== | ||
Please click here to download the component source project: [https://www.flowcode.co.uk/ | Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_BBCNews.fcfx FC_Comp_Source_BBCNews.fcfx] | ||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_BBCNews.fcfx FC_Comp_Source_BBCNews.fcfx] | Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_BBCNews.fcfx FC_Comp_Source_BBCNews.fcfx] | ||
==Detailed description== | ==Detailed description== | ||
| Line 44: | Line 46: | ||
==Examples== | ==Examples== | ||
| Line 68: | Line 72: | ||
==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;" | '''GetURL''' | |||
|- | |||
| colspan="2" | Get Selected News Item URL | |||
|- | |||
|- | |||
| 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;" | '''RequestData''' | |||
|- | |||
| colspan="2" | Requests data about your selected location from the BBC news service. Returns the number of headlines if the request was successful. Must be called before trying to call any of the GetXXX macros. | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-u16-icon.png]] - UINT | |||
| width="90%" | ItemNumber | |||
|- | |||
| colspan="2" | Headline Index To Read | |||
|- | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u16-icon.png]] - UINT | |||
| 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;" | '''GetTitle''' | |||
|- | |||
| colspan="2" | Get Selected News Item Title | |||
|- | |||
|- | |||
| 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;" | '''GetDescription''' | |||
|- | |||
| colspan="2" | Get Selected News Item Description | |||
|- | |||
|- | |||
| 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" | Sets up the component ready to collect news 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-16-icon.png]] | |||
| width="90%" | LinkTo | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | |||
| width="90%" | BBC IP Address | |||
|- | |||
| colspan="2" | IP Address linked to the following URL: weather-broker-cdn.api.bbci.co.uk | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | |||
| width="90%" | News Feed | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | |||
| width="90%" | Feed URL | |||
|- | |||
| colspan="2" | | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | |||
| width="90%" | Receive Timeout | |||
|- | |||
| colspan="2" | Maximum time to wait for valid incoming data. | |||
|- | |||
| width="10%" align="center" style="background-color:#EAE1EA;" | [[File:Fc9-conn-icon.png]] | |||
| width="90%" style="background-color:#EAE1EA; color:#4B008D;" | Data | |||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |||
| width="90%" | Record Title | |||
|- | |||
| colspan="2" | Stores the news topic title into RAM. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | |||
| width="90%" | Title Buffer Size | |||
|- | |||
| colspan="2" | Number of bytes to allocate to storing titles. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |||
| width="90%" | Record Description | |||
|- | |||
| colspan="2" | Stores the news topic description into RAM. | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-type-7-icon.png]] | |||
| width="90%" | Record URL | |||
|- | |||
| colspan="2" | Records the news topics full story URL into RAM | |||
|}==Macro reference== | |||
{| class="wikitable" style="width:60%; background-color:#FFFFFF;" | {| class="wikitable" style="width:60%; background-color:#FFFFFF;" | ||
Revision as of 09:52, 27 January 2023
| Author | MatrixTSL |
| Version | 1.0 |
| Category | Comms: IoT/Cloud |
BBC News component
Easily allows you to collect the news headlines and stories from the BBC RSS feed.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_BBCNews.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_BBCNews.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
GetURL |
| Get Selected News Item URL | |
 - STRING
|
Return |
|
|
RequestData |
| Requests data about your selected location from the BBC news service. Returns the number of headlines if the request was successful. Must be called before trying to call any of the GetXXX macros. | |
 - UINT
|
ItemNumber |
| Headline Index To Read | |
| - UINT
|
Return |
|
|
GetTitle |
| Get Selected News Item Title | |
| - STRING
|
Return |
|
|
GetDescription |
| Get Selected News Item Description | |
| - STRING
|
Return |
|
|
Initialise |
| Sets up the component ready to collect news data. | |
 - VOID
|
Return |
Property reference
|
Properties |
|
LinkTo |
|
BBC IP Address |
| IP Address linked to the following URL: weather-broker-cdn.api.bbci.co.uk | |
|
|
News Feed |
|
|
Feed URL |
|
Receive Timeout |
| Maximum time to wait for valid incoming data. | |
|
Data |
|
Record Title |
| Stores the news topic title into RAM. | |
|
|
Title Buffer Size |
| Number of bytes to allocate to storing titles. | |
|
|
Record Description |
| Stores the news topic description into RAM. | |
|
|
Record URL |
| Records the news topics full story URL into RAM | |
==Macro reference==
|
|
GetURL |
| Get Selected News Item URL | |
| - STRING
|
Return |
|
|
RequestData |
| Requests data about your selected location from the BBC news service. Returns the number of headlines if the request was successful. Must be called before trying to call any of the GetXXX macros. | |
| - UINT
|
ItemNumber |
| Headline Index To Read | |
| - UINT
|
Return |
|
|
GetTitle |
| Get Selected News Item Title | |
| - STRING
|
Return |
|
|
GetDescription |
| Get Selected News Item Description | |
| - STRING
|
Return |
|
|
Initialise |
| Sets up the component ready to collect news data. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
LinkTo |
|
|
BBC IP Address |
| IP Address linked to the following URL: weather-broker-cdn.api.bbci.co.uk | |
|
|
News Feed |
|
|
Feed URL |
|
|
Receive Timeout |
| Maximum time to wait for valid incoming data. | |
|
|
Data |
|
|
Record Title |
| Stores the news topic title into RAM. | |
|
|
Title Buffer Size |
| Number of bytes to allocate to storing titles. | |
|
|
Record Description |
| Stores the news topic description into RAM. | |
|
|
Record URL |
| Records the news topics full story URL into RAM | |
==Macro reference==
|
|
GetURL |
| Get Selected News Item URL | |
| - STRING
|
Return |
|
|
RequestData |
| Requests data about your selected location from the BBC news service. Returns the number of headlines if the request was successful. Must be called before trying to call any of the GetXXX macros. | |
| - UINT
|
ItemNumber |
| Headline Index To Read | |
| - UINT
|
Return |
|
|
GetTitle |
| Get Selected News Item Title | |
| - STRING
|
Return |
|
|
GetDescription |
| Get Selected News Item Description | |
| - STRING
|
Return |
|
|
Initialise |
| Sets up the component ready to collect news data. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
LinkTo |
|
|
BBC IP Address |
| IP Address linked to the following URL: weather-broker-cdn.api.bbci.co.uk | |
|
|
News Feed |
|
|
Feed URL |
|
|
Receive Timeout |
| Maximum time to wait for valid incoming data. | |
|
|
Data |
|
|
Record Title |
| Stores the news topic title into RAM. | |
|
|
Title Buffer Size |
| Number of bytes to allocate to storing titles. | |
|
|
Record Description |
| Stores the news topic description into RAM. | |
|
|
Record URL |
| Records the news topics full story URL into RAM | |
==Macro reference==
|
|
GetURL |
| Get Selected News Item URL | |
| - STRING
|
Return |
|
|
RequestData |
| Requests data about your selected location from the BBC news service. Returns the number of headlines if the request was successful. Must be called before trying to call any of the GetXXX macros. | |
| - UINT
|
ItemNumber |
| Headline Index To Read | |
| - UINT
|
Return |
|
|
GetTitle |
| Get Selected News Item Title | |
| - STRING
|
Return |
|
|
GetDescription |
| Get Selected News Item Description | |
| - STRING
|
Return |
|
|
Initialise |
| Sets up the component ready to collect news data. | |
| - VOID
|
Return |
Property reference
|
|
Properties |
|
|
LinkTo |
|
|
BBC IP Address |
| IP Address linked to the following URL: weather-broker-cdn.api.bbci.co.uk | |
|
|
News Feed |
|
|
Feed URL |
|
|
Receive Timeout |
| Maximum time to wait for valid incoming data. | |
|
|
Data |
|
|
Record Title |
| Stores the news topic title into RAM. | |
|
|
Title Buffer Size |
| Number of bytes to allocate to storing titles. | |
|
|
Record Description |
| Stores the news topic description into RAM. | |
|
|
Record URL |
| Records the news topics full story URL into RAM | |