Weather widgets

From SpinetiX Support Wiki

Jump to: navigation, search

This page is about the data-driven widgets included in Elementi 2016, Elementi 2017 and Elementi 2018. For other Elementi versions, see below.

Introduction

These data-driven widgets are useful for displaying the current weather or the forecast for up to 15 days. The weather information can be retrieved from any of the following weather channels: Open Weather Map, Weather Undeground, World Weather Online, or Yahoo! Weather.

The weather widgets can be found by clicking the "Widgets" tab within the Browse panel, then double-clicking the "Weather" folder icon.

Note Notes:
  • The weather data is automatically stored in the player local cache and the update frequency is limited to 3h for current conditions and 6h for forecast.
  • Weather providers require an API key to use their services - this can be obtained after registering on their web site. If you just want to test the weather widgets, you can use the "Open Weather Map" channel without an API key.
  • These widgets should be used in multiscreen projects only if displayed on a single screen, otherwise the data feed widgets must be used instead.

Getting started

Getting started is easy; download Elementi software, launch it and create away! Just follow the 4 quick steps below:

  1. Get Elementi.
  2. Open Elementi and on the main window, click on the "Widgets" tab.
  3. Scroll down and open the "Weather" folder. Pick a widget.
  4. Include that widget into your content and configure it.

Weather widgets

Weather feed widgets

Elementi software comes with several weather widgets accessible from "Widgets" tab within the Browse panel of the Elementi GUI.

  • Current Weather
    Displays the current weather conditions using text & icon layers, which are automatically replaced by data retrieved from Weather provider.
  • Horizontal Forecast and Vertical Forecast
    Displays 1 to 15 days of weather forecast (depending on the provider) using text & icon layers, which are automatically replaced by data retrieved from Weather provider.

Configuration

Properties

Current Weather properties
Forecast Weather properties

The following properties, found under "Properties" tab, can be used to customize the widget:

  • Data
    Click on the Data Feed Properties button (it opens the Data Properties dialog for Weather data). This let the user select the location (city name, country, ...) for which the weather should be displayed.
  • Locale
    Select the locale used for displaying dates and numbers.
  • Delay per column/Delay per row (forecast only)
    Enter the number of seconds to wait before displaying the next cell of the table.
  • Header (forecast only)
    Customize header text using data placeholders (e.g., [[location]])
Note Note:
To modify general properties of the widget, click on the Document Properties icon from the toolbar to open the "Document Properties" dialog.

Data source setup

Data Properties

To edit the properties related to the data source, click on the Data Feed Properties button. This opens the "Data Properties" dialog, which allows changing the following:

  • Channel
    Select OpenWeatherMap or World Weather Online.
    Weather Underground and Yahoo! Weather services can no longer be used.
  • Refresh
    Specify the period after which the widget should refresh the weather data (this is useful especially when the widget is running in a loop); either select one of the provided options ("When document opens", ... , 24h) or enter a number, optionally followed by s (implicit), m or h. Using "When document opens" will refresh the data only when the document is re-opened.
    Note Note:
    The weather data is automatically stored in the player local cache and the update frequency is limited to 3h for current conditions and 6h for forecast.
  • API Key
    Enter the API key that you got after registering on the selected weather provider website; currently, only OpenWeatherMap can be used without an API key, in which case, your usage will be included in our billing plan.
  • Location
    To select the location for which the weather should be displayed, click on the "Change" button, enter the city name or part of it, and then click on "Search" button. In most cases, entering the country code after the city (e.g., "New York,US") would yield better results.
  • Days (forecast only)
    Select the number of days of forecast to be shown. Note that some provider do not provide more than 5 days of forecast.
  • Units
    Select between Metric or Us Customary unit to display temperature and other measurements.
Note Notes:
  • At any point, the data source configuration can be tested by clicking on the "Test..." button.
  • Searching for well-known cities, like New York, might yield results that are in different regions. If using OpenWeatherMap, you might want to search first on their website and find the nearest weather station based on Geo coordinates (you can check them on this map).

Layout

The data retrieved from the weather data source is displayed using a layout composed of text & media layers, each containing one or more data placeholders (e.g., [[location]], [[temp]] etc.), which are automatically filled out with data retrieved from the weather data source when the widget is running. The layout can be edited in Elementi from the Preview panel (mostly for design changes) and / or from the "Layers" tab in Edit panel (gives access to all the layer properties).

Editing the weather layout

To edit the layout within the Preview panel, follow these steps:

  1. Click once within the Preview panel to enter into "Edit mode". The widget is paused and the actual data are replaced by the fallback values (if any were defined) or the layer predefined content.
  2. Click on a layer to select it. The layer predefined content is displayed - usually that contains only the data placeholder.
  3. It is now possible to modify the position / size of the selected layer or remove it. If it's a text layer, it can also be edited.
  4. Click the play button to resume the playback and display the actual weather data.

To edit the slide layout within the Edit panel, follow these steps:

  1. Click the "Layers" tab to list all the layers composing the widget layout.
  2. Click the Elementi Icons Layer Properties.png button to open the "Layer Properties" dialog and edit that layer properties.
  3. Click the "OK" button to apply the changes.

Icons

By default, the weather icons are loaded from the SpinetiX server, through a media layer set to [[href]]. Click the "Test" button when configuring the data source and you'll find within the results set a column named "icon" and one named "href" - the latter is composed of the path to icons location on SpinetiX server, the value from the icon column and the png file extension.

If you want to change the icons set, follow these steps:

  1. Optionally, download the weather icon set and modify / replace the icons as you want.
  2. Import the new / modified icons inside your project.
  3. Open the weather widget and click the "Layers" tab.
  4. Click the Elementi Icons Layer Properties.png button of the [[href]] media layer.
  5. Replace [[href]] with something like /icons/[[icon]].png.
  6. Click the "OK" button to apply the changes.

API deprecation

Yahoo! Weather

Starting with Jan 3, 2019, Yahoo made important changes regarding the Yahoo Weather API: the previous end-points were retired and replaced by a new one, a new process for app whitelisting, and all requests and responses are now using the RSS format. As a consequence, the widgets configured to use Yahoo! Weather as provider stopped working and the only solution is to change to another provider.

Weather Underground

According to this announcement, all Weather Underground API keys will stop working on February 15, 2019 unless otherwise agreed upon with Weather Underground.

See also

This page was last modified on 7 March 2019, at 13:22.