Component: BBC Weather Forecast (Comms: IoT/Cloud): Difference between revisions
No edit summary |
m Text replacement - "width="90%" style="background-color:#D8C9D8; color:#4B008D;"" to "width="90%" class="mtx-class-macrohead"" |
||
| (19 intermediate revisions by 3 users not shown) | |||
| Line 13: | Line 13: | ||
==BBC Weather Forecast component== | ==BBC Weather Forecast component== | ||
Easily allows you to collect | Easily allows you to collect observed weather metrics for your area using the BBC Weather data service. Supports temperature and humidity etc. for your selected area. Also available are Wind Direction, Wind Speed and Air Pressure but please note these are not always available depending on your selected area. This component is used for data gathering from the internet. | ||
==Component Source Code== | |||
Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_BBCWeatherForecast.fcfx FC_Comp_Source_BBCWeatherForecast.fcfx] | |||
Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_BBCWeatherForecast.fcfx FC_Comp_Source_BBCWeatherForecast.fcfx] | |||
==Detailed description== | ==Detailed description== | ||
| Line 24: | Line 50: | ||
==Examples== | ==Examples== | ||
| Line 38: | Line 84: | ||
The location can be set by adjusting the BBC Weather location property, see the component property tooltips for more information on how to do this. | The location can be set by adjusting the BBC Weather location property, see the component property tooltips for more information on how to do this. | ||
Here is an example of a next-day weather predictor that also shows the current-day weather for a ESP32 embedded device | |||
{{Fcfile|ESP32_TTGO_Weather_Forecast_Predictor.fcfx|ESP32 weather predictor}} | |||
==Macro reference== | |||
===GetDayName=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''GetDayName''' | |||
|- | |||
| colspan="2" | Gets the name of the currently selected day as a string. | |||
|- | |||
|- | |||
| 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 | ===GetDaySummary=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetDaySummary''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Gets the summary of the currently selected day as a string. | ||
|- | |||
|- | |||
| 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'' | |||
|} | |||
===GetHumidity=== | |||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | |||
| width="90%" class="mtx-class-macrohead" | '''GetHumidity''' | |||
|- | |- | ||
| | | colspan="2" | Reads the forecast humidity in Relative Humdity for the selected day. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===GetLocationName=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetLocationName''' | ||
|- | |- | ||
| colspan="2" | Reads the | | colspan="2" | Reads the reported location name as a string. | ||
|- | |- | ||
|- | |- | ||
| Line 73: | Line 148: | ||
{| class="wikitable | ===GetMaxTemperature=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetMaxTemperature''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Reads the forecast maximum temperature in the selected scale for the selected day. | ||
|- | |||
|- | |||
| width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | |||
| width="90%" | Scale | |||
|- | |- | ||
| colspan="2" | 0 = Celcius, 1 = Farenheit | |||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===GetMinTemperature=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetMinTemperature''' | ||
|- | |- | ||
| colspan="2" | Reads the forecast minimum temperature in the selected scale for the selected day. | | colspan="2" | Reads the forecast minimum temperature in the selected scale for the selected day. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:]] - | | width="10%" align="center" | [[File:Fc9-bool-icon.png]] - BOOL | ||
| width="90%" | Scale | | width="90%" | Scale | ||
|- | |- | ||
| colspan="2" | 0 = Celcius, 1 = Farenheit | | colspan="2" | 0 = Celcius, 1 = Farenheit | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | | width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-s16-icon.png]] - INT | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===GetPollution=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetPollution''' | ||
|- | |- | ||
| colspan="2" | Reads the forecast | | colspan="2" | Reads the forecast pollution as a string for the selected day. | ||
|- | |- | ||
|- | |- | ||
| Line 117: | Line 200: | ||
{| class="wikitable | ===GetPressure=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetPressure''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Reads the forecast air pressure in milli bar (mb) for the selected day. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:]] - | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===GetSunrise=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetSunrise''' | ||
|- | |- | ||
| colspan="2" | Reads the forecast | | colspan="2" | Reads the forecast sunrise time as a string for the selected day. | ||
|- | |- | ||
|- | |- | ||
| Line 143: | Line 228: | ||
{| class="wikitable | ===GetSunset=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetSunset''' | ||
|- | |- | ||
| colspan="2" | Reads the forecast sunset time as a string for the selected day. | | colspan="2" | Reads the forecast sunset time as a string for the selected day. | ||
| Line 156: | Line 242: | ||
{| class="wikitable | ===GetUVRisk=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetUVRisk''' | ||
|- | |- | ||
| colspan="2" | Reads the forecast | | colspan="2" | Reads the forecast UV Risk for the selected day. | ||
|- | |- | ||
|- | |- | ||
| Line 169: | Line 256: | ||
{| class="wikitable | ===GetVisibility=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetVisibility''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Reads the forecast visibility for the selected day. | ||
|- | |- | ||
|- | |- | ||
| Line 182: | Line 270: | ||
{| class="wikitable | ===GetWindDirection=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetWindDirection''' | ||
|- | |- | ||
| colspan="2" | Reads the | | colspan="2" | Reads the forecast wind direction as a string for the selected day. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===GetWindSpeed=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''GetWindSpeed''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Reads the reported wind speed in MPH for the selected day. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9-u8-icon.png]] - BYTE | |||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | |||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===Initialise=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Initialise''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Sets up the component ready to collect weather data. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===RequestData=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''RequestData''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Requests data about your selected location from the BBC weather service. Returns true if the request was successful. Must be called before trying to call any of the GetXXX macros. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" style="border-top: 2px solid #000;" | [[File:Fc9- | | 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'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
{| class="wikitable | ===SetForecastDay=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetForecastDay''' | ||
|- | |- | ||
| colspan="2" | Chooses which day of the three day forecast to look at. | | colspan="2" | Chooses which day of the three day forecast to look at. | ||
| Line 257: | Line 345: | ||
{| class="wikitable | ===SetLocationCode=== | ||
{| class="mtx-class-macrotable wikitable" | |||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-comp-macro.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''SetLocationCode''' | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | Allows the location code to be altered from the default location code set in the component properties. After changing the location the RequestData macro must be called to refresh the forecast variables. | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center | | width="10%" align="center" | [[File:Fc9-string-icon.png]] - STRING | ||
| width="90%" | NewLocation | |||
| width="90%" | |||
| | |||
|- | |- | ||
| colspan="2" | New location string, see Location property tooltip for more info. | |||
|- | |- | ||
| 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-void-icon.png]] - VOID | ||
| width="90%" style="border-top: 2px solid #000;" | ''Return'' | | width="90%" style="border-top: 2px solid #000;" | ''Return'' | ||
|} | |} | ||
==Property reference== | ==Property reference== | ||
{| class="wikitable | {| class="mtx-class-macrotable wikitable" | ||
|- | |- | ||
| width="10%" align="center" | | width="10%" align="center" class="mtx-class-macrohead" | [[File:Fc9-prop-icon.png]] | ||
| width="90%" | | width="90%" class="mtx-class-macrohead" | '''Properties''' | ||
|- | |- | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type- | | width="10%" align="center" | [[File:Fc9-type-16-icon.png]] | ||
| width="90%" | | | width="90%" | LinkTo | ||
|- | |- | ||
| colspan="2" | | | colspan="2" | | ||
|- | |- | ||
| width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | | width="10%" align="center" | [[File:Fc9-type-10-icon.png]] | ||
| Line 325: | Line 391: | ||
|- | |- | ||
| colspan="2" | Maximum time to wait for valid incoming data. | | colspan="2" | Maximum time to wait for valid incoming data. | ||
|} | |} | ||
Latest revision as of 14:23, 13 July 2026
| Author | MatrixTSL |
| Version | 1.0 |
| Category | Comms: IoT/Cloud |
BBC Weather Forecast component
Easily allows you to collect observed weather metrics for your area using the BBC Weather data service. Supports temperature and humidity etc. for your selected area. Also available are Wind Direction, Wind Speed and Air Pressure but please note these are not always available depending on your selected area. This component is used for data gathering from the internet.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_BBCWeatherForecast.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_BBCWeatherForecast.fcfx
Detailed description
No detailed description exists yet for this component
Examples
Here is a basic example to read the three day forecast data and report the information on a graphical display.
The location can be set by adjusting the BBC Weather location property, see the component property tooltips for more information on how to do this.
Here is an example of a next-day weather predictor that also shows the current-day weather for a ESP32 embedded device
Macro reference
GetDayName
| GetDayName | |
| Gets the name of the currently selected day as a string. | |
| Return | |
GetDaySummary
| GetDaySummary | |
| Gets the summary of the currently selected day as a string. | |
| Return | |
GetHumidity
| GetHumidity | |
| Reads the forecast humidity in Relative Humdity for the selected day. | |
| Return | |
GetLocationName
| GetLocationName | |
| Reads the reported location name as a string. | |
| Return | |
GetMaxTemperature
| GetMaxTemperature | |
| Reads the forecast maximum temperature in the selected scale for the selected day. | |
| Scale | |
| 0 = Celcius, 1 = Farenheit | |
| Return | |
GetMinTemperature
| GetMinTemperature | |
| Reads the forecast minimum temperature in the selected scale for the selected day. | |
| Scale | |
| 0 = Celcius, 1 = Farenheit | |
| Return | |
GetPollution
| GetPollution | |
| Reads the forecast pollution as a string for the selected day. | |
| Return | |
GetPressure
| GetPressure | |
| Reads the forecast air pressure in milli bar (mb) for the selected day. | |
| Return | |
GetSunrise
| GetSunrise | |
| Reads the forecast sunrise time as a string for the selected day. | |
| Return | |
GetSunset
| GetSunset | |
| Reads the forecast sunset time as a string for the selected day. | |
| Return | |
GetUVRisk
| GetUVRisk | |
| Reads the forecast UV Risk for the selected day. | |
| Return | |
GetVisibility
| GetVisibility | |
| Reads the forecast visibility for the selected day. | |
| Return | |
GetWindDirection
| GetWindDirection | |
| Reads the forecast wind direction as a string for the selected day. | |
| Return | |
GetWindSpeed
| GetWindSpeed | |
| Reads the reported wind speed in MPH for the selected day. | |
| Return | |
Initialise
| Initialise | |
| Sets up the component ready to collect weather data. | |
| Return | |
RequestData
SetForecastDay
| SetForecastDay | |
| Chooses which day of the three day forecast to look at. | |
| Day | |
| 0 = Today, 1 = Tomorrow, 2 = Day After Tomorrow | |
| Return | |
SetLocationCode