View source for Component: BBC Weather Forecast (Comms: IoT/Cloud)

From Flowcode Help

← Component: BBC Weather Forecast (Comms: IoT/Cloud)

You do not have permission to edit this page, for the following reason:

---

You can view and copy the source of this page.

{| style="width:50%" |- | width="20%" style="color:gray;" | Author | MatrixTSL |- | width="20%" style="color:gray;" | Version | 1.0 |- | width="20%" style="color:gray;" | Category | Comms: IoT/Cloud |} ==BBC Weather Forecast component== Easily allows you to collect three day forecasted weather metrics for your area using the BBC Weather data service. Supports Min/Max temperature, Wind Direction, Wind Speed, Visibility, Pressure, Humidty, UV Risk, Pollution and Sun Rise/Set times for your selected area. ==Component Source Code== Please click here to download the component source project: [https://www.flowcode.co.uk/wiki/componentsource/FC_Comp_Source_temp/BBCWeatherForecast.fcfx FC_Comp_Source_temp/BBCWeatherForecast.fcfx] Please click here to view the component source code (Beta): [https://www.flowcode.co.uk/FlowchartView/?wfile=componentsource/FC_Comp_Source_temp/BBCWeatherForecast.fcfx FC_Comp_Source_temp/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. {{Fcfile|BBCWeatherForecastDemo.fcfx|BBCWeatherForecastDemo}} 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. On an embedded device you would need a TCP/IP component to allow the communications to the BBC server. This then links to the Network Comms component. ==Macro reference== ===GetDayName=== {| 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;" | '''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'' |} ===GetDaySummary=== {| 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;" | '''GetDaySummary''' |- | 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="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;" | '''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:Fc9-u8-icon.png]] - BYTE | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===GetLocationName=== {| 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;" | '''GetLocationName''' |- | colspan="2" | Reads the reported location name 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'' |} ===GetMaxTemperature=== {| 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;" | '''GetMaxTemperature''' |- | 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-s16-icon.png]] - INT | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===GetMinTemperature=== {| 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;" | '''GetMinTemperature''' |- | colspan="2" | Reads the forecast minimum 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-s16-icon.png]] - INT | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===GetPollution=== {| 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;" | '''GetPollution''' |- | colspan="2" | Reads the forecast pollution as a string for the selected day.  |- |- | 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'' |} ===GetPressure=== {| 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;" | '''GetPressure''' |- | 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:Fc9-u16-icon.png]] - UINT | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===GetSunrise=== {| 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;" | '''GetSunrise''' |- | colspan="2" | Reads the forecast sunrise time as a string for the selected day.  |- |- | 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'' |} ===GetSunset=== {| 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;" | '''GetSunset''' |- | colspan="2" | Reads the forecast sunset time as a string for the selected day.  |- |- | 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'' |} ===GetUVRisk=== {| 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;" | '''GetUVRisk''' |- | colspan="2" | Reads the forecast UV Risk for the selected day.  |- |- | 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'' |} ===GetVisibility=== {| 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;" | '''GetVisibility''' |- | colspan="2" | Reads the forecast visibility for the selected day.  |- |- | 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'' |} ===GetWindDirection=== {| 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;" | '''GetWindDirection''' |- | 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-string-icon.png]] - STRING | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===GetWindSpeed=== {| 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;" | '''GetWindSpeed''' |- | 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="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===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;" | '''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'' |} ===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;" | '''RequestData''' |- | 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-bool-icon.png]] - BOOL | width="90%" style="border-top: 2px solid #000;" | ''Return'' |} ===SetForecastDay=== {| 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;" | '''SetForecastDay''' |- | colspan="2" | Chooses which day of the three day forecast to look at.   |- |- | width="10%" align="center" | [[File:Fc9-u8-icon.png]] - BYTE | width="90%" | Day |- | colspan="2" | 0 = Today, 1 = Tomorrow, 2 = Day After Tomorrow  |- | 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'' |} ===SetLocationCode=== {| 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;" | '''SetLocationCode''' |- | 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" | [[File:Fc9-string-icon.png]] - STRING | width="90%" | NewLocation |- | 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="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-10-icon.png]] | width="90%" | Location Code |- | colspan="2" | BBC code for your area. In a web browser go to www.bbc.co.uk/weather/ Then type in your city in the search bar and your code will be shown at the end of the URL. For example Manchester in the UK = 2643123 In the UK you can also use the first half of your post code, e.g. HX1  |- | width="10%" align="center" | [[File:Fc9-type-21-icon.png]] | width="90%" | Receive Timeout |- | colspan="2" | Maximum time to wait for valid incoming data.  |}

Return to Component: BBC Weather Forecast (Comms: IoT/Cloud).