OpenWeatherMap plugin

Provides weather forecast data from OpenWeatherMap. Depends on plugins that create location entities with a latitude and longitude.

Note: You need the Geodata plugin to be able to use the OpenWeatherMap plugin. The Geodata plugin will provide the country and city objects while the OpenWeatherMap plugin will provide the Data Streams to use with these objects, for example to show the current temperature for a list of cities.

About the Geodata plugin

The Geodata plugin creates objects for countries, cities, and currencies which can be used in Data Streams that come from other plugins.

It's a utility plugin that can be added without entering any credentials, which means you don't have to create an API key, user account, or anything like that.

How to add the OpenWeatherMap plugin

1. In SquaredUp browse to Settings > Plugins > Add plugin and search for the plugin.

2. Display Name:

   Enter a name for your plugin. This helps you to identify this plugin in the list of your plugins.

3. API Key:

   Create an API key in your OpenWeatherMap account.

   Note:

   OpenWeather offers free and payed accounts. Depending on the account, there can be a rate limit for how many API calls you can make per minute. If you exceed your limit, tiles that use the OpenWeatherMap plugin will show an error. Here you'll find an overview about their account options, and you can sign up for the one that fits your needs: https://openweathermap.org/price
   

4. Leave the checkbox for Automatically create a workspace ticked, this will create a new workspace for this plugin containing out of the box dashboards and scopes.

5. Optionally, select whether you would like to restrict access to this plugin instance. By default, restricted access is set to off.

   Restrict access to this workspace?

   The term plugin here really means plugin instance. For example, a user may configure two instances of the AWS plugin, one for their development environment and one for production. In that case, each plugin instance has its own access control settings.

   By default, Restrict access to this plugin? is set to off. The plugin can be viewed, edited and administered by anyone. If you would like to control who has access to this plugin, switch Restrict access to this plugin? to on.

   Use the Restrict access to this plugin? dropdown to control who has access to the workspace:

   • By default, the user setting the permissions for the plugin will be given Full Control and the Everyone group will be given Link to workspace permissions.

   • Tailor access to the plugin, as required, by selecting individual users or user groups from the dropdown and giving them Link to workspace or Full Control permissions.

   • If the user is not available from the dropdown, you are able to invite them to the plugin by typing in their email address and then clicking Add. The new user will then receive an email inviting them to create an account on SquaredUp Cloud. Once the account has been created, they will gain access to the tenant.

   • At least one user or group must be given Full Control.

   • Admin users can edit the configuration, modify the Access Control List (ACL) and delete the plugin, regardless of the ACL chosen.

   Plugin access levels

   Access Level:

   Link to workspace	User can link the plugin to any workspace they have at least Editor permissions for. Data from the plugin can then be viewed by anyone with any access to the workspace. User can share the plugin data with anyone they want. User cannot configure the plugin in any way, or delete it.
   Full Control	User can change the plugin configuration, ACL, and delete the plugin.

   See Access control for more information.

6. Click Save.

7. If you haven't added the Geodata plugin yet, add the Geodata plugin. To be able to use the Data Streams that come with the OpenWeatherMap plugin, you need city or country objects from the Geodata plugin. See Geodata plugin

   The Geodata plugin creates objects for countries, cities, and currencies which can be used in Data Streams that come from other plugins.

   It's a utility plugin that can be added without entering any credentials, which means you don't have to create an API key, user account, or anything like that.

Using the OpenWeatherMap plugin

Create a scope using the Geodata plugin

1. In the OpenWeatherMap workspace click Scope on the left hand side.

2. Under Plugins click on Geodata.

3. Under Types click on City.

4. Search for the city you want to show weather for, for example your nearest city.

5. Click Next.

6. Give your scope a name, perhaps the city name, for example London.

Create a tile

1. Under Scopeclick on Existing and then on the scope you created, for example London.

2. Click on the data stream for the weather you want to display, for example Current Temperature.

3. Click on the visualization you want, for example Scalar.

Troubleshooting tiles that use the OpenWeatherMap plugin

Error because of exceeded API call rate limit

OpenWeather offers free and payed accounts. Depending on the account, there can be a rate limit for how many API calls you can make per minute. If you exceed your limit, tiles that use the OpenWeatherMap plugin will show an error. Here you'll find an overview about their account options, and you can sign up for the one that fits your needs: https://openweathermap.org/price