HS4 Web Control


API Information

rnbweather can connect to various API's to retrieve weather data
The pages shown above are the various API's that can be configured in rnbWeather. Instructions for obtaining a key/token are included with each API below.When connecting to each API, you must comply with all terms and conditions of the API


Celestial Data

All sunrise, sunset and solar noon times are calculated based the actual location and not that of the weather station.
Why is this important? It means that if reviewing the sunrise, sunset times etc online at the weather service, you may see a small difference by up to 5 minutes.This approach has been taken as not all weather services make sunrise/sunset times etc available when required. When it is available, it is at the point of the weather station and not your chosen location.By doing the celestial calculation, it is ensuring the times are correct for your location and is available for all weather services/locations. Other calculations are also done such as moon phase, zodiac sign etc which are not available in most weather services but are relevant.
All celestial times are local to the location and not where your HomeSeer controller is located.


weatherXL

Part of the design of this plugin is based, with permission, on weatherXML for HS3 by Jeff Farmer (CFGuy)


Additional Software Used

rnbWeather makes use of a number of software packages. These packages, included within the plugin, and are shown below:

  • Newtonsoft Json - a popular high-performance JSON framework for .NET
  • CoordinateSharp - CoordinateSharp is a library that is designed to assist with geographic coordinate conversions, formatting and location based celestial calculations.
  • GeoTimeZone - Provides an IANA time zone identifier for latitude and longitude coordinates.
  • Noda Time - Noda Time is a date and time API acting as an alternative to the built-in DateTime/DateTimeOffset etc types in .NET.
  • Tmds.MDns - Tmds.MDns finds services announced via multicast DNS (RFC6762 and RFC6763).

Logging Level

rnbWeather provides feedback to you through the Homeseer log and/or a txt log. To support this all feedback is categorised into 1 of four categories as shown in the list below. The options increment as you go along meaning that if you choose the third option, it will also provide feedback on items 1 and 2 as well in the log.
It is suggested to set the option to: Show Errors only so as not to fill up your log with feedback that you will not need. If you are experiencing issues with rnbWeather, turning the log to Debug Logging will provide more insight into potential issues.

  • Show Errors Only
  • This option will only show errors in the Homeseer log. Items such as device creation check will not be logged.
  • Show all Warnings and Errors
  • This option will only show errors in the Homeseer log. Items such as device creation check will not be logged.
  • Show all Info items in log
  • This option will only show errors in the Homeseer log. Items such as device creation check will not be logged.
  • Debug Logging - Log everything
  • This option will only show errors in the Homeseer log. Items such as device creation check will not be logged.

External/TextFile Logging

rnbWeather will output its log entries to a text file in addition to or instead of the HomeSeer log. This can be useful when trying to diagnoise an issue and need the debug log but do not want to fillup your HomeSeer log. Setting this option below will output any rnbWeather logs to a text file stored in your Logs folder in the HomeSeer root directory

Mapping/Formats

This mapping section allows you to map common names to more meaningful names. Text replacement will be later replaced by localization suppport The use the mapping, select the mapping type below and follow the instructions in that section.

Day of Week Mapping allows you to change all rnbWeather devices day names to anything you want. To use the mapping enter the desired name you want to use for each day of the week eg: Thursday could be changed to Thur. You must enable the mapping service below. When enaled, all day names we be updated as below. When the day mapping is disabled, all day names will revert to the full english name for each day.

Date/Time formats are used in some of the key features as below. You can select which format you want the date/time displayed that meets your needs.the use of '.' vs ',' is determined by your computer (locale) settings. You can use different formats for different features however it will set for all features eg: setting sunrise to a time/dateformat will set all/any sunrise features you have to use this. You can use the sample box below to test your format before saving! you can learn more about the date/time formats in the user guide here!

These settings control different settings on the rnbWeather Overview page

Each page refresh does not poll the weather service directly. Each time a weather service is polled, it stores a copy of this data in homeseer_directory/html/rnb/pidata folder. This data is then used to update this page. A shorter update interval will help to reflect when alerts are actually occuring or not.

Select the forecast types below you want displayed on the rnbWeather Overview page


rnbWeather includes some features/icons that are not within the weather service or are common across all. rnbWeather has created a generic set of icons to use with these common features. These icons are used by default but can be changed to use a custom set of icons that you choose. Below are the common icon groups within rnbWeather. to use your own icons, simply enable cutom icons and place your icons in the folder called custom within that group (eg: custom folder under compass folder)


World Air Quality
The World Air Quality Index project is a non-profit project started in 2007. Its mission is to promote air pollution awareness for citizens and provide a unified and world-wide air quality information. The project is providing transparent air quality information for more than 130 countries, covering more than 30,000 stations in 2000 major cities. The founding team, located in Beijing China. The team has been expanding worldwide, with new key supporters from Singapore, India, Australia, USA.
Air Quality is available for: Worldwide

Obtaining an API KEY
If you do not already have an API key, you can obtain a new API key from the World Air Quality Index Project by following these steps:
    REQUESTING API KEY
  • Go to Air Quality Open Data Platform and complete the API Token Request Form
  • Enter your email address, and your name. Review/confirm the terms of service as appropriate
  • Go to your email and using the email from WAQI, click Confirm your email address

  • Remember to enable this service above if you want to retrieve Air Quality Index for your locations


The table below defines the Air Quality Index scale as defined by the US-EPA 2016 standard
AQIAir Pollution LevelHealth ImplicationsCautionary Statement (for PM2.5)
0-50GoodAir quality is considered satisfactory, and air pollution poses little or no riskNone
51-100ModerateAir quality is acceptable; however, for some pollutants there may be a moderate health concern for a very small number of people who are unusually sensitive to air pollution.Active children and adults, and people with respiratory disease, such as asthma, should limit prolonged outdoor exertion.
101-150Unhealthy for Sensitive GroupsMembers of sensitive groups may experience health effects. The general public is not likely to be affected.Active children and adults, and people with respiratory disease, such as asthma, should limit prolonged outdoor exertion.
151-200UnhealthyEveryone may begin to experience health effects; members of sensitive groups may experience more serious health effectsActive children and adults, and people with respiratory disease, such as asthma, should avoid prolonged outdoor exertion; everyone else, especially children, should limit prolonged outdoor exertion
201-300Very UnhealthyHealth warnings of emergency conditions. The entire population is more likely to be affected.Active children and adults, and people with respiratory disease, such as asthma, should avoid all outdoor exertion; everyone else, especially children, should limit outdoor exertion.
300+HazardousHealth alert: everyone may experience more serious health effectsEveryone should avoid all outdoor exertion

rnbWeather allows you to log each weather measure to a database of your choosing. This data can then be used by you to look at weather trends over time etc. rnbWeather does not have any features currently build in for accessing the database and data. This is up to the user if they want to access the data.


Norwegian Meteorological Institute
The Bureau of Meteorology is Australia's national weather, climate and water agency. Its expertise and services assist Australians in dealing with the harsh realities of their natural environment, including drought, floods, fires, storms, tsunami and tropical cyclones. Through regular forecasts, warnings, monitoring and advice spanning the Australian region and Antarctic territory, the Bureau provides one of the most fundamental and widely used services of government.
Weather is available for: Australia only

AU BOM API Key

Where no terms of use are associated with a set of material, then you may download, use and copy that material for personal use, or use within your organisation but you may not supply that material to any other person or use it for any commercial purpose. See here for information on your rights to use material on the Bureau of Meteorology websites