Official Kodi Wiki - User contributions [en]

Add-on rules

2026-05-31T12:22:51Z

Roman VM:

{{mininav|[[Development]]|[[Add-on development]]}}

== Repository Submission Guidelines - Please Read Before Submitting Your Addon ==

Inclusion in the Kodi.org repository is at the sole discretion of Team Kodi. Because maintaining such a large repository is a large task, we have set some guidelines for inclusion. Please ensure that these guidelines are met before submitting request to be added. In order to be considered for the official repository, the following guidelines must be met:

* All add-ons must be developed as described on the [https://kodi.wiki/view/Add-on_development Add-on development] page.
* All add-ons must be compatible with Python 3. Contributions requiring Python 2 are no longer accepted. For more details see: [https://kodi.tv/article/the-sun-sets-on-python-2/ The Sun Sets on Python 2]
* You '''must''' include a license file (named <code>LICENSE.txt</code>). We recommend the [http://creativecommons.org/choose/non-web-popup?license_code=by-sa&jurisdiction=&version=3.0&lang=en CC-BY-SA 3.0] for skins and the [http://www.gnu.org/licenses/gpl-howto.html GPL v2+] for others, but most copy left licenses will suffice. Proprietary licenses will not be allowed. Please investigate which license suits your needs and you fully understand the contents.
* All files must be free and legal to distribute.
* The add-on must not violate any known copyright laws - if in doubt, let us know and we'll look into it for you.
* All source files must be included. No pre-compiled or obfuscated files will be allowed. The only exception may be granted for minified JS/CSS files of web interface addons.
* You acknowledge that you are the maintainer of your add-on.
* Team-Kodi reserves the right to update or remove it at any time as we deem necessary.
* If a new stable Kodi is going to be released no new submissions are accepted to the repository for the previous version. This will start from when the first [http://en.wikipedia.org/wiki/Release_candidate#Release_candidate release candidate (RC)] of the new version is released. Only fixes and updates will be accepted and processed for the previous version (e.g. if the current stable is 13.x, no updates are allowed for 11.x any more). See: [https://kodi.wiki/view/Submitting_Add-ons#Allowed_submissions Allowed submissions]
* Monetization of add-ons (for instance advertising or paid subscriptions) will not be allowed. We can make an exception in case you own the copyright for the content the add-on provides. Please contact us on the forum if you believe such an exception may apply to your add-on.
* All <code>xbmc.python.module</code> addons must be used by at least one other add-on in official repository.

== Updates ==

Keep in mind that add-ons in the official repository should be considered '''stable'''. This means that they should be well-tested before you submit them for inclusion. Because they are for stable users, they should avoid being updated too often. Too often is of course subjective. If your add-on is in rapid development, and features are constantly being added, hold off until you have hit a good stopping point and '''tested''' the current version.

This means that you should '''not''' submit a request every time you change your code. If you are submitting updates more than once per week something is wrong. Once or twice per month is probably a better goal, barring unforeseen conditions (like a content source changing its paths). With good reasons provided we will of course make exceptions as we strive to provide the best user experience.

== General requirements ==

Here's a list of what basic sanity checks are done by repository maintainer on each submission.

=== Basic file checks ===

* all strings used by add-ons must be localized, no hard-coded language strings should ever be used
* all paths should be treated as case-sensitive, so that they work on all OSs and file systems.
* all paths and files should be lower-case due to the previous point
** exceptions are README, COPYING, <code>LICENSE.txt</code> that should be upper-case and the "Default" directory in <code>resources/skins</code>, for add-ons that need it.
* the following file-types are not allowed: <code>.so .dll .pyo .exe .xbt .xpr Thumbs.db</code> and so on (any binary files)
* all text files should use UNIX end-of-line
* all <code>.xml</code> files must pass xml validation
* all <code>.xml</code> files must have xml declaration as header
* all <code>.xml/.txt</code> must have unix style EOL's
* don't use a BOM at the start of your files
* file permissions: files should not be marked as executable
* filenames must have correct encoding (for skins: check your studio logos for corrupt filenames)
* use 4-letter '''lc_CC''' language codes for localized addon metadata in <code>addon.xml</code>
* <code>addon.xml</code> must have at least '''en_GB''' metadata.

=== Things that must be included ===

* [https://kodi.wiki/view/Add-on_structure#addon.xml addon.xml] must contain correct and valid info / version
* [https://kodi.wiki/view/Add-on_structure#icon.png icon.png] must be present (256x256) or (512x512) with solid colors (no transparency)
* [https://kodi.wiki/view/Add-on_structure#fanart.jpg fanart.jpg] must be present (1280x720 or 1920x1080 or 3840x2160)
* [https://kodi.wiki/view/Add-on_structure#LICENSE.txt LICENSE.txt] must be present

See also: [https://kodi.wiki/view/Add-on_structure '''Add-on structure''']

=== Things that can't be included ===

* no <code>.xbt</code> files (these will be generated by our repository)
* no other add-ons included (skinners: if you need a script, submit it separately and depend on it)
* don't include unneeded files (<code>.pdf</code>, <code>.doc</code>, <code>thumbs.db</code>, etc...)
* no licensed fonts / background images / anything
* binary/compiled/obfuscated files (with possible exception for minified JS/CSS files)

== Requirements for skins ==

=== Basic checks ===

* The file size must be sane. There is no hard limit, but a 100mb skin is pushing it.
* No mods. Mods are great, and pop up frequently in the forums. But we would rather not have several versions of the same skin in our repo. But if your mod is substantial different enough from the original (and by giving it a different name), we will of course take it in consideration. Also if the original skin is no longer available through our repo, we would have no problem replacing it with a mod.
* In order to compile your images with TexturePacker, all graphics files should have a resolution of at least 4x4.
* themes must be in a subfolder of the <code>themes/</code> folder in the skin root (eg. <code>skin.foo/themes/blue/</code>). The <code>.xbt</code> file will be created by our repo backend.
* If you want to have some images outside of <code>Textures.xbt</code>, then make sure you place those images outside of the <code>media/</code> folder and reference them using <code>special://skin/backdrops/</code> or similar. This is most useful for backgrounds - it keeps the size of the packed textures down. Any images you have in the <code>media/</code> folder will be placed in <code>Textures.xbt</code> in the official repository.
* Please be careful with addon dependencies. Only add dependencies that are needed for the skin to function properly.

=== Code checks ===

* all labels must be localized
* code should be case-sensitive
* skins should not create warning/errors in the logfile, this can be a lot of things:
** invalid includes
** undefined actions
** unable to evaluate condition
** undefined vars
** can't focus 'id'

'''Note:''' This of course also applies to script add-ons that use skin files

==== Optional support ====

This is optional and should not block inclusion in official repo.

* Mouse support
* Touchscreen support
* Peripheral dialogs
* PVR support
* ADSP support
* RDS support
* Game support

== Requirements for all python addons ==

We do not enforce any specific code style rules or coding practices. It's the developer's responsibility to ensure proper functioning of their addons.

General requirements:

* all <code>special://</code> paths should be translated using <code>xbmc.translatePath("special://foo/bar")</code>
* <code>xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('path'))</code> should be used for files included with the add-on
* <code>xbmc.translatePath(xbmcaddon.Addon().getAddonInfo('profile'))</code> should be used for storing add-on related files
* direct access to the Kodi database is '''not''' allowed. You must use [https://kodi.wiki/view/JSON-RPC_API JSON RPC] for this.
* directly using any kind of analytics (Google Analytics for example) from within add-ons is not allowed. This should be handled server side by using user-agent.
* addons should use the <code>xbmc.log()</code> method to write to the logfile and use the debug logging level only. <code>print()</code> functions should not be used.
* Plugins should '''not''' force certain skin viewtypes on their own by calling <code>Container.SetViewMode(id)</code> or <code>Container.SetSortMethod(id)</code> built-in functions. They should set the correct media content from which the correct skin view type is automatically provided.
* add-ons should store all their data in their own profile subfolder inside the <code>addon_data</code> folder (accessed via <code>Addon.getAddonInfo('profile')</code> or <code>special://profile</code>). Access (read/write/delete) to any other files or folders is not allowed by default and should require an explicit user confirmation, e.g. via a UI modal dialog or a file selector. Short-lived files may also be stored in the Kodi temp folder <code>special://temp</code> directory but the addon profile folder is preferable.
* addons must not install other addons or modify their files.

''Exceptions to this rule may be granted in specific cases only. Please contact Team XBMC's add-on repository maintainers on github if your add-on needs access to such files.''

In case we grant such an exception for your addon, access (read/write/delete) to other files/directories must be opt-in by the user, and be clear for the user to understand what is being accessed.

== Specific requirements for scrapers ==

* scraper must return the following minimum information: movie title, year, plot, cast, poster, fanart
* Scrapers should store their file cache in <code>special://temp/scrapers/<addon_id></code> folder that is monitored by Kodi.

[[Category:Add-on development]]

HOW-TO:Video addon

2025-06-21T11:21:28Z

Roman VM:

{{mininav|[[Development]]|[[Add-on development]]|[[Python development]]}}
<br />

=Introduction=
This tutorial will explain how to write your first Kodi/XBMC video plugin Add-on<br />

=Tools=
Assuming you have already followed the Hello World Add-on you will have a text editor already setup. Since we are dealing with videos this time its probably a good idea to have a video player setup. We recommend another great open source project for this

- VLC http://www.videolan.org/vlc/

=Installing=
You can find the Add-on source code here:

https://github.com/romanvm/plugin.video.example

You need to download an installable zip from "Releases" section of the repo and install it from the '''Addons''' section of kodi GUI
by clicking a "package" icon in the top left corner and selecting "Instal from ZIP".

Note that Kodi no longer supports "drop in" installing by copying addon files into '''addon''' sub-directory of the Kodi profile directory.

=Testing=
You can first give the add-on a test run by going to:
System >> Add-Ons >> Enabled Add-Ons >> Video Add-Ons >> Example Kodi video Plugin. You should now be able to watch some test videos hosted from an internet web server.

[[File:Plugin-video-example.jpg.jpg]]

=Explanation=
So whats happening in this add-on?

Basically the Add-on is checking a website for the hosted videos. In this example we are directly linking to the videos, but there are possibilities for dynamic content and scraping of just about any online source

Once the video link is sent to Kodi, our video player takes over and buffers, then plays the video just like any other media.

=Structure=
main.py <-- This is the actual python code for your Add-On

addon.xml <-- This is the Add-Ons metadata

icon.png <-- A PNG icon for the add-on. It can be 256x256 or 512x512 pixels big. Try to make it look nice!

Readme.md <-- The readme text file with a description of the Add-on and install instructions. This shows on the front of the GitHub page and helps users to understand your Add-on before downloading.

=The Code=
So now we come to the actual Add-On code, this is where most of your Add-on is written and is a simple text file containing python code.

Since this is a very simple Add-On, all its code are located in https://github.com/romanvm/plugin.video.example/blob/master/main.py file that is the Add-On entry point.
Read the comments in the file that explain what each part of the code does.

More complex Add-Ons may include additional modules and packages. In this case a good practice is to put only minimal code in your Add-On entrypoint and keep the rest
of the code in importable modueles.

=Changing the code=

Hopefully by now you have managed to run the Add-On, understand the structure and can see what the code can do. Now lets trying changing it a little!

Since we already have the Add-on installed we can go directly to the Kodi userdata folder and edit the python directly. You can also have Kodi open at this time ready to run the Add-on when required. Just switch between your text editor and Kodi any time.

Note that all the data for video strams are located in movies.json file. This allows to separate media information from the actual Python code.

Try changing some of the links to another jpeg file or hosted online video. Also try to change the genre and see how that effects the view in Kodi.

Click save on your text editor and now try running the Add-On inside Kodi. You should see the new video links and navigation right away.

Congratulations! you've just played an online video from your very own Video Add-on

=Streaming Video=
In addition to this guide, here are some comments from an experienced developer who has worked with streaming video sites:

The docs will help you a lot, way more than any wiki.

https://xbmc.github.io/docs.kodi.tv/master/kodi-base/index.html

Speaking of docs, the ListItem reference will be most useful, time and time again.

https://xbmc.github.io/docs.kodi.tv/master/kodi-base/d8/d29/group__python__xbmcgui__listitem.html

Since you're relying on a streaming platform you won't need to do anything particular yourself, you can get away with fetching the data and posting an item with the URL of the video. InputStream.Adaptive configuration might be needed, especially if the videos need DRM.

You can get a lot done with the requests module, depending on the data you're processing. It's fully supported in Kodi, cookie and sessions included.
In short, it's really simple, you:

- get the information you need off the internet (title/URL could suffice for a start);

- you generate items that Kodi will treat as video sources (see xbmcplugin.addDirectoryItem() and xbmcgui.ListItem());

You could also read the sources of plugins such as AsciiDisco's Netflix or Sandmann79's Amazon/AmazonVOD addons.

You can read more in this thread
https://forum.kodi.tv/showthread.php?tid=348328

=Final Thoughts=

Writing a Video Add-on is actually pretty simple once you get the basic structure correct. You can scrape most online sources with Regex, or host your own videos on the web. You can also play youtube clips or vevo videos using some additional easy to use modules.

If you have any questions about this tutorial, feel free to discuss it on our forums here: http://forum.kodi.tv/showthread.php?tid=248774

=Extra info=

Just a reminder...
IMPORTANT!!!!!!! Do not mix tabs and spaces in python

[[Category:Add-on development]]

File:Plugin-video-example.jpg.jpg

2025-06-21T11:00:08Z

Roman VM:

plugin-video-example screenshot

Weather addons

2024-10-28T13:31:34Z

Roman VM: /* Weather location configuration */

{{Main|Weather}}

{{Note|This page describes the development of Weather addons for Kodi. If you're interested in them from a user's perspective (where to get them, how to configure them, etc.), please use the link above.}}

== addon.xml ==
Weather addons use the 'xbmc.python.weather' extension point.
The basic layout of the addon.xml of a weather addon will look like:
<syntaxhighlight lang="xml" line highlight="6" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="weather.name" name="My Weather" version="1.2.3" provider-name="me">
<requires>
<import addon="xbmc.python" version="3.0.0" />
</requires>
<extension point="xbmc.python.weather" library="" />
<extension point="xbmc.addon.metadata">
<summary lang="en_GB"></summary>
<description lang="en_GB"></description>
<language></language>
<platform></platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

== Things to know ==
There are a few things (quirks) you need to be aware of when creating a weather addon...
* A weather addon will be run automatically when the skins asks to display one of these weather-specific infolabels:
** <code>Weather.Conditions</code>
** <code>Weather.Temperature</code>
** <code>Weather.Location</code>
* The weather addon will run at 30 minute intervals (as long the current skin window displays one of the above-mentioned infolabels)
* In the weather window, Kodi will automatically try to translate all the weather strings
* Kodi will also handle transformations between units (for instance, Celsius to Fahrenheit, km/h to mph)

== Theory of operation ==
Kodi can run a weather addon in two modes:

=== Weather location configuration ===
In order to set up a weather addon, you need to include a settings.xml file for your weather addon. It needs to have this structure:
<syntaxhighlight lang="xml" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings version="1">
<section id="weather.name">
<category id="locations" label="">
<group id="1">
<setting id="location1" type="string" label="" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location1)</data>
</control>
</setting>
<setting id="location2" type="string" label="32003" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location2)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location1" />
</dependencies>
</setting>
<setting id="location3" type="string" label="32004" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location3)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location2" />
</dependencies>
</setting>
</group>
</category>
</section>
</settings>
</syntaxhighlight>

You can define as many weather locations as you want in your settings.xml file. Additional location parameters, like longitude and latitude,
can be saved as invisible settings.

When you're going to set up a location in the weather addon settings, Kodi will pass the argument(s) you've defined in the RunScript() action above to your addon. For instance, if you set the 'Location 2' entry active in the Weather settings, Kodi will pass 'Loc2' to your addon.

=== Retrieving weather data ===
When weather information needs to be retrieved, Kodi will pass the location number to your addon. For instance, if the weather for Location 4 is requested, Kodi will pass '4' to the weather addon.

=== Required output ===
When a weather addon is asked to retrieve weather information, it needs to return this info to Kodi. This is done by making the various pieces of information available as window properties of the weather window.

The basic python code needed to provide a window property:
<syntaxhighlight lang="python">
WINDOW = xbmcgui.Window(12600)
WINDOW.setProperty(name, value)
</syntaxhighlight>

Kodi expects a weather addon to populate these properties:

=== Current Weather ===

{{Glossary}}
{{Term|1=Current.Condition|2=<code>Current.Condition</code>}}
{{Defn|1=the weather condition as a string|style=margin-left: 4em;}}
{{Term|1=Current.Temperature|2=<code>Current.Temperature</code>}}
{{Defn|1=temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Wind|2=<code>Current.Wind</code>}}
{{Defn|1=windspeed in km/h|style=margin-left: 4em;}}
{{Term|1=Current.WindDirection|2=<code>Current.WindDirection</code>}}
{{Defn|1=wind direction, NNE|style=margin-left: 4em;}}
{{Term|1=Current.Humidity|2=<code>Current.Humidity</code>}}
{{Defn|1=relative humidity as a percentage|style=margin-left: 4em;}}
{{Term|1=Current.FeelsLike|2=<code>Current.FeelsLike</code>}}
{{Defn|1=feels-like temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.UVIndex|2=<code>Current.UVIndex</code>}}
{{Defn|1=the UV-index as an integer|style=margin-left: 4em;}}
{{Term|1=Current.DewPoint|2=<code>Current.DewPoint</code>}}
{{Defn|1=dewpoint in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Precipitation|2=<code>Current.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Term|1=Current.Cloudiness|2=<code>Current.Cloudiness</code>}}
{{Defn|1=cloud cover in %|style=margin-left: 4em;}}
{{Term|1=Current.OutlookIcon|2=<code>Current.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Current.FanartCode|2=<code>Current.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Glossary end}}

Kodi will read those window properties and do unit conversions if needed, depending on the regional settings in Kodi.<br />

=== Hourly Weather ===

{{Glossary}}
{{Term|1=Hourly.%i.Time|2=<code>Hourly.%i.Time</code>}}
{{Defn|1=hour time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.LongDate|2=<code>Hourly.%i.LongDate</code>}}
{{Defn|1=long date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.ShortDate|2=<code>Hourly.%i.ShortDate</code>}}
{{Defn|1=short date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Outlook|2=<code>Hourly.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.OutlookIcon|2=<code>Hourly.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FanartCode|2=<code>Hourly.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindSpeed|2=<code>Hourly.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindDirection|2=<code>Hourly.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Humidity|2=<code>Hourly.%i.Humidity</code>}}
{{Defn|1=humidity in %|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Temperature|2=<code>Hourly.%i.Temperature</code>}}
{{Defn|1=temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.DewPoint|2=<code>Hourly.%i.DewPoint</code>}}
{{Defn|1=dew point as temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FeelsLike|2=<code>Hourly.%i.FeelsLike</code>}}
{{Defn|1=apparent temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Pressure|2=<code>Hourly.%i.Pressure</code>}}
{{Defn|1=pressure with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Precipitation|2=<code>Hourly.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Hourly items are 1-indexed, that is, they start from 1.

=== Daily Weather ===

{{Term|1=Daily.%i.ShortDate|2=<code>Daily.%i.ShortDate</code>}}
{{Defn|1=short date|style=margin-left: 4em;}}
{{Term|1=Daily.%i.ShortDay|2=<code>Daily.%i.ShortDay</code>}}
{{Defn|1=short day label, e.g. Mon|style=margin-left: 4em;}}
{{Term|1=Daily.%i.HighTemperature|2=<code>Daily.%i.HighTemperature</code>}}
{{Defn|1=high temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.LowTemperature|2=<code>Daily.%i.LowTemperature</code>}}
{{Defn|1=low temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Outlook|2=<code>Daily.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Daily.%i.OutlookIcon|2=<code>Daily.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.FanartCode|2=<code>Daily.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindSpeed|2=<code>Daily.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindDirection|2=<code>Daily.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Precipitation|2=<code>Daily.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Daily items are 1-indexed, that is, they start from 1.

=== Additional Weather Properties ===

Some skins, e.g. aeon.nox.silvo, may use the following properties (up to 7 days):

{{Glossary}}
{{Term|1=Day%i.Title|2=<code>Day%i.Title</code>}}
{{Defn|1=day of the week|style=margin-left: 4em;}}
{{Term|1=Day%i.HighTemp|2=<code>Day%i.HighTemp</code>}}
{{Defn|1=high temperature for the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.LowTemp|2=<code>Day%i.LowTemp</code>}}
{{Defn|1=low temperature of the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.Outlook|2=<code>Day%i.Outlook</code>}}
{{Defn|1=the weather forecast|style=margin-left: 4em;}}
{{Term|1=Day%i.OutlookIcon|2=<code>Day%i.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename|style=margin-left: 4em;}}
{{Term|1=Day%i.FanartCode|2=<code>Day%i.FanartCode</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Glossary end}}

Note that those properties are 0-indexed.

=== General Properties ===

{{Glossary}}
{{Term|1=Location|2=<code>Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=Current.Location|2=<code>Current.Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=WeatherProvider|2=<code>WeatherProvider</code>}}
{{Defn|1=weather addon name|style=margin-left: 4em;}}
{{Term|1=WeatherProviderLogo|2=<code>WeatherProviderLogo</code>}}
{{Defn|1=path to the addon logo file, preferrabely in a banner format|style=margin-left: 4em;}}
{{Term|1=Weather.IsFetched|2=<code>Weather.IsFetched</code>}}
{{Defn|1=true if weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Current.IsFetched|2=<code>Current.IsFetched</code>}}
{{Defn|1=true if current weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Hourly.IsFetched|2=<code>Hourly.IsFetched</code>}}
{{Defn|1=true if hourly weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Daily.IsFetched|2=<code>Daily.IsFetched </code>}}
{{Defn|1=true if daily weather info is fetched|style=margin-left: 4em;}}
{{Glossary end}}

The name of the window property set by the weather addon and the resulting window property for the skin will differ in a few scenarios:
* Current.OutlookIcon (addon) -> Current.ConditionIcon (skin)
* Current.Wind (addon) -> Current.WindSpeed (skin)
* Current.Wind / Current.WindDirection (addon) -> Current.Wind (skin)
Kodi combines the Wind and WindDirection properties into a Wind property with this format: 'From <wind dir> at <speed> <unit>'<br />

In addition, several window properties set by the addon will be made available to the skin as infolabels:
* Current.Condition (addon) -> Weather.Conditions (skin)
* Current.Temperature (addon) -> Weather.Temperature (skin)
* Current.FanartCode (addon) -> Weather.FanartCode (skin)

Finally, at the end of your script, you need to set the following window properties:
<pre>
* Location%i (the name of each weather location that has been configured by the user. for locations that are not configured, set an empty property.)
* Locations (the total number of locations that have been set up by the user. don't count the ones that have not been configured!)
</pre><br />

Once the addon has finished, Kodi will make one additional infolabel available to the skin:
<pre>
* Weather.Location (the name of the current weather location)
</pre>

The name of the weather addon, can be displayed by the skin using:
<pre>
* Weather.Plugin (the name of the weather addon)
</pre>

=Advanced weather info (optional)=
Besides the weather infolabels mentioned above, your addon can return many more, basically there are no limits.
Keep in mind though, that it requires skin support to display this additional information in Kodi.

If you want to go this route, have a look at the infolabels provided by the Openweathermap and Wunderground addons:<br />
* https://github.com/xbmc/repo-scripts/blob/krypton/weather.openweathermap.extended/README.txt<br />
* https://github.com/xbmc/repo-scripts/blob/jarvis/weather.wunderground/README.txt<br />

The infolabels provided by those addons are reasonably well supported by a number of skins already,
so try if you can use the same infolabel names in your addon.

=Weather Codes=
Kodi ships with an icon pack that includes an icon for each weather condition.<br />
(https://github.com/xbmc/xbmc/tree/master/addons/resource.images.weathericons.default)<br />
Several additional weather icon packs are available through the official Kodi repository.

The following condition-code table is used for the icon names:
<pre>
0 tornado
1 tropical storm
2 hurricane
3 severe thunderstorms
4 thunderstorms
5 mixed rain and snow
6 mixed rain and sleet
7 mixed snow and sleet
8 freezing drizzle
9 drizzle
10 freezing rain
11 showers
12 showers
13 snow flurries
14 light snow showers
15 blowing snow
16 snow
17 hail
18 sleet
19 dust
20 foggy
21 haze
22 smoky
23 blustery
24 windy
25 cold
26 cloudy
27 mostly cloudy (night)
28 mostly cloudy (day)
29 partly cloudy (night)
30 partly cloudy (day)
31 clear (night)
32 sunny
33 fair (night)
34 fair (day)
35 mixed rain and hail
36 hot
37 isolated thunderstorms
38 scattered thunderstorms
39 scattered thunderstorms
40 scattered showers
41 heavy snow
42 scattered snow showers
43 heavy snow
44 partly cloudy
45 thundershowers
46 snow showers
47 isolated thundershowers
na not available
</pre>

[[Category:Add-on_development]]

Weather addons

2024-10-28T13:30:59Z

Roman VM:

{{Main|Weather}}

{{Note|This page describes the development of Weather addons for Kodi. If you're interested in them from a user's perspective (where to get them, how to configure them, etc.), please use the link above.}}

== addon.xml ==
Weather addons use the 'xbmc.python.weather' extension point.
The basic layout of the addon.xml of a weather addon will look like:
<syntaxhighlight lang="xml" line highlight="6" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="weather.name" name="My Weather" version="1.2.3" provider-name="me">
<requires>
<import addon="xbmc.python" version="3.0.0" />
</requires>
<extension point="xbmc.python.weather" library="" />
<extension point="xbmc.addon.metadata">
<summary lang="en_GB"></summary>
<description lang="en_GB"></description>
<language></language>
<platform></platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

== Things to know ==
There are a few things (quirks) you need to be aware of when creating a weather addon...
* A weather addon will be run automatically when the skins asks to display one of these weather-specific infolabels:
** <code>Weather.Conditions</code>
** <code>Weather.Temperature</code>
** <code>Weather.Location</code>
* The weather addon will run at 30 minute intervals (as long the current skin window displays one of the above-mentioned infolabels)
* In the weather window, Kodi will automatically try to translate all the weather strings
* Kodi will also handle transformations between units (for instance, Celsius to Fahrenheit, km/h to mph)

== Theory of operation ==
Kodi can run a weather addon in two modes:

=== Weather location configuration ===
In order to set up a weather addon, you need to include a settings.xml file for your weather addon. It needs to have this structure:
<syntaxhighlight lang="xml" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings version="1">
<section id="weather.name">
<category id="locations" label="">
<group id="1">
<setting id="location1" type="string" label="" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location1)</data>
</control>
</setting>
<setting id="location2" type="string" label="32003" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location2)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location1" />
</dependencies>
</setting>
<setting id="location3" type="string" label="32004" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location3)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location2" />
</dependencies>
</setting>
</group>
</category>
</section>
</settings>
</syntaxhighlight>

You can define as many weather locations as you want in your settings.xml file. Additional location parameters, like longitude and latitude,
can be saved as invissble settings.

When you're going to set up a location in the weather addon settings, Kodi will pass the argument(s) you've defined in the RunScript() action above to your addon. For instance, if you set the 'Location 2' entry active in the Weather settings, Kodi will pass 'Loc2' to your addon.

=== Retrieving weather data ===
When weather information needs to be retrieved, Kodi will pass the location number to your addon. For instance, if the weather for Location 4 is requested, Kodi will pass '4' to the weather addon.

=== Required output ===
When a weather addon is asked to retrieve weather information, it needs to return this info to Kodi. This is done by making the various pieces of information available as window properties of the weather window.

The basic python code needed to provide a window property:
<syntaxhighlight lang="python">
WINDOW = xbmcgui.Window(12600)
WINDOW.setProperty(name, value)
</syntaxhighlight>

Kodi expects a weather addon to populate these properties:

=== Current Weather ===

{{Glossary}}
{{Term|1=Current.Condition|2=<code>Current.Condition</code>}}
{{Defn|1=the weather condition as a string|style=margin-left: 4em;}}
{{Term|1=Current.Temperature|2=<code>Current.Temperature</code>}}
{{Defn|1=temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Wind|2=<code>Current.Wind</code>}}
{{Defn|1=windspeed in km/h|style=margin-left: 4em;}}
{{Term|1=Current.WindDirection|2=<code>Current.WindDirection</code>}}
{{Defn|1=wind direction, NNE|style=margin-left: 4em;}}
{{Term|1=Current.Humidity|2=<code>Current.Humidity</code>}}
{{Defn|1=relative humidity as a percentage|style=margin-left: 4em;}}
{{Term|1=Current.FeelsLike|2=<code>Current.FeelsLike</code>}}
{{Defn|1=feels-like temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.UVIndex|2=<code>Current.UVIndex</code>}}
{{Defn|1=the UV-index as an integer|style=margin-left: 4em;}}
{{Term|1=Current.DewPoint|2=<code>Current.DewPoint</code>}}
{{Defn|1=dewpoint in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Precipitation|2=<code>Current.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Term|1=Current.Cloudiness|2=<code>Current.Cloudiness</code>}}
{{Defn|1=cloud cover in %|style=margin-left: 4em;}}
{{Term|1=Current.OutlookIcon|2=<code>Current.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Current.FanartCode|2=<code>Current.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Glossary end}}

Kodi will read those window properties and do unit conversions if needed, depending on the regional settings in Kodi.<br />

=== Hourly Weather ===

{{Glossary}}
{{Term|1=Hourly.%i.Time|2=<code>Hourly.%i.Time</code>}}
{{Defn|1=hour time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.LongDate|2=<code>Hourly.%i.LongDate</code>}}
{{Defn|1=long date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.ShortDate|2=<code>Hourly.%i.ShortDate</code>}}
{{Defn|1=short date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Outlook|2=<code>Hourly.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.OutlookIcon|2=<code>Hourly.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FanartCode|2=<code>Hourly.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindSpeed|2=<code>Hourly.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindDirection|2=<code>Hourly.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Humidity|2=<code>Hourly.%i.Humidity</code>}}
{{Defn|1=humidity in %|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Temperature|2=<code>Hourly.%i.Temperature</code>}}
{{Defn|1=temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.DewPoint|2=<code>Hourly.%i.DewPoint</code>}}
{{Defn|1=dew point as temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FeelsLike|2=<code>Hourly.%i.FeelsLike</code>}}
{{Defn|1=apparent temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Pressure|2=<code>Hourly.%i.Pressure</code>}}
{{Defn|1=pressure with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Precipitation|2=<code>Hourly.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Hourly items are 1-indexed, that is, they start from 1.

=== Daily Weather ===

{{Term|1=Daily.%i.ShortDate|2=<code>Daily.%i.ShortDate</code>}}
{{Defn|1=short date|style=margin-left: 4em;}}
{{Term|1=Daily.%i.ShortDay|2=<code>Daily.%i.ShortDay</code>}}
{{Defn|1=short day label, e.g. Mon|style=margin-left: 4em;}}
{{Term|1=Daily.%i.HighTemperature|2=<code>Daily.%i.HighTemperature</code>}}
{{Defn|1=high temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.LowTemperature|2=<code>Daily.%i.LowTemperature</code>}}
{{Defn|1=low temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Outlook|2=<code>Daily.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Daily.%i.OutlookIcon|2=<code>Daily.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.FanartCode|2=<code>Daily.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindSpeed|2=<code>Daily.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindDirection|2=<code>Daily.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Precipitation|2=<code>Daily.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Daily items are 1-indexed, that is, they start from 1.

=== Additional Weather Properties ===

Some skins, e.g. aeon.nox.silvo, may use the following properties (up to 7 days):

{{Glossary}}
{{Term|1=Day%i.Title|2=<code>Day%i.Title</code>}}
{{Defn|1=day of the week|style=margin-left: 4em;}}
{{Term|1=Day%i.HighTemp|2=<code>Day%i.HighTemp</code>}}
{{Defn|1=high temperature for the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.LowTemp|2=<code>Day%i.LowTemp</code>}}
{{Defn|1=low temperature of the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.Outlook|2=<code>Day%i.Outlook</code>}}
{{Defn|1=the weather forecast|style=margin-left: 4em;}}
{{Term|1=Day%i.OutlookIcon|2=<code>Day%i.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename|style=margin-left: 4em;}}
{{Term|1=Day%i.FanartCode|2=<code>Day%i.FanartCode</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Glossary end}}

Note that those properties are 0-indexed.

=== General Properties ===

{{Glossary}}
{{Term|1=Location|2=<code>Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=Current.Location|2=<code>Current.Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=WeatherProvider|2=<code>WeatherProvider</code>}}
{{Defn|1=weather addon name|style=margin-left: 4em;}}
{{Term|1=WeatherProviderLogo|2=<code>WeatherProviderLogo</code>}}
{{Defn|1=path to the addon logo file, preferrabely in a banner format|style=margin-left: 4em;}}
{{Term|1=Weather.IsFetched|2=<code>Weather.IsFetched</code>}}
{{Defn|1=true if weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Current.IsFetched|2=<code>Current.IsFetched</code>}}
{{Defn|1=true if current weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Hourly.IsFetched|2=<code>Hourly.IsFetched</code>}}
{{Defn|1=true if hourly weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Daily.IsFetched|2=<code>Daily.IsFetched </code>}}
{{Defn|1=true if daily weather info is fetched|style=margin-left: 4em;}}
{{Glossary end}}

The name of the window property set by the weather addon and the resulting window property for the skin will differ in a few scenarios:
* Current.OutlookIcon (addon) -> Current.ConditionIcon (skin)
* Current.Wind (addon) -> Current.WindSpeed (skin)
* Current.Wind / Current.WindDirection (addon) -> Current.Wind (skin)
Kodi combines the Wind and WindDirection properties into a Wind property with this format: 'From <wind dir> at <speed> <unit>'<br />

In addition, several window properties set by the addon will be made available to the skin as infolabels:
* Current.Condition (addon) -> Weather.Conditions (skin)
* Current.Temperature (addon) -> Weather.Temperature (skin)
* Current.FanartCode (addon) -> Weather.FanartCode (skin)

Finally, at the end of your script, you need to set the following window properties:
<pre>
* Location%i (the name of each weather location that has been configured by the user. for locations that are not configured, set an empty property.)
* Locations (the total number of locations that have been set up by the user. don't count the ones that have not been configured!)
</pre><br />

Once the addon has finished, Kodi will make one additional infolabel available to the skin:
<pre>
* Weather.Location (the name of the current weather location)
</pre>

The name of the weather addon, can be displayed by the skin using:
<pre>
* Weather.Plugin (the name of the weather addon)
</pre>

=Advanced weather info (optional)=
Besides the weather infolabels mentioned above, your addon can return many more, basically there are no limits.
Keep in mind though, that it requires skin support to display this additional information in Kodi.

If you want to go this route, have a look at the infolabels provided by the Openweathermap and Wunderground addons:<br />
* https://github.com/xbmc/repo-scripts/blob/krypton/weather.openweathermap.extended/README.txt<br />
* https://github.com/xbmc/repo-scripts/blob/jarvis/weather.wunderground/README.txt<br />

The infolabels provided by those addons are reasonably well supported by a number of skins already,
so try if you can use the same infolabel names in your addon.

=Weather Codes=
Kodi ships with an icon pack that includes an icon for each weather condition.<br />
(https://github.com/xbmc/xbmc/tree/master/addons/resource.images.weathericons.default)<br />
Several additional weather icon packs are available through the official Kodi repository.

The following condition-code table is used for the icon names:
<pre>
0 tornado
1 tropical storm
2 hurricane
3 severe thunderstorms
4 thunderstorms
5 mixed rain and snow
6 mixed rain and sleet
7 mixed snow and sleet
8 freezing drizzle
9 drizzle
10 freezing rain
11 showers
12 showers
13 snow flurries
14 light snow showers
15 blowing snow
16 snow
17 hail
18 sleet
19 dust
20 foggy
21 haze
22 smoky
23 blustery
24 windy
25 cold
26 cloudy
27 mostly cloudy (night)
28 mostly cloudy (day)
29 partly cloudy (night)
30 partly cloudy (day)
31 clear (night)
32 sunny
33 fair (night)
34 fair (day)
35 mixed rain and hail
36 hot
37 isolated thunderstorms
38 scattered thunderstorms
39 scattered thunderstorms
40 scattered showers
41 heavy snow
42 scattered snow showers
43 heavy snow
44 partly cloudy
45 thundershowers
46 snow showers
47 isolated thundershowers
na not available
</pre>

[[Category:Add-on_development]]

Weather addons

2024-10-28T13:28:35Z

Roman VM: fix /* General Properties */

{{Main|Weather}}

{{Note|This page describes the development of Weather addons for Kodi. If you're interested in them from a user's perspective (where to get them, how to configure them, etc.), please use the link above.}}

== addon.xml ==
Weather addons use the 'xbmc.python.weather' extension point.
The basic layout of the addon.xml of a weather addon will look like:
<syntaxhighlight lang="xml" line highlight="6" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="weather.name" name="My Weather" version="1.2.3" provider-name="me">
<requires>
<import addon="xbmc.python" version="3.0.0" />
</requires>
<extension point="xbmc.python.weather" library="" />
<extension point="xbmc.addon.metadata">
<summary lang="en_GB"></summary>
<description lang="en_GB"></description>
<language></language>
<platform></platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

== Things to know ==
There are a few things (quirks) you need to be aware of when creating a weather addon...
* A weather addon will be run automatically when the skins asks to display one of these weather-specific infolabels:
** <code>Weather.Conditions</code>
** <code>Weather.Temperature</code>
** <code>Weather.Location</code>
* The weather addon will run at 30 minute intervals (as long the current skin window displays one of the above-mentioned infolabels)
* In the weather window, Kodi will automatically try to translate all the weather strings
* Kodi will also handle transformations between units (for instance, Celsius to Fahrenheit, km/h to mph)

== Theory of operation ==
Kodi can run a weather addon in two modes:

=== Weather location configuration ===
In order to set up a weather addon, you need to include a settings.xml file for your weather addon. It needs to have this structure:
<syntaxhighlight lang="xml" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings version="1">
<section id="weather.name">
<category id="locations" label="">
<group id="1">
<setting id="location1" type="string" label="" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location1)</data>
</control>
</setting>
<setting id="location2" type="string" label="32003" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location2)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location1" />
</dependencies>
</setting>
<setting id="location3" type="string" label="32004" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location3)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location2" />
</dependencies>
</setting>
</group>
</category>
</section>
</settings>
</syntaxhighlight>

You can define as many weather locations as you want in your settings.xml file.

When you're going to set up a location in the weather addon settings, Kodi will pass the argument(s) you've defined in the RunScript() action above to your addon. For instance, if you set the 'Location 2' entry active in the Weather settings, Kodi will pass 'Loc2' to your addon.

=== Retrieving weather data ===
When weather information needs to be retrieved, Kodi will pass the location number to your addon. For instance, if the weather for Location 4 is requested, Kodi will pass '4' to the weather addon.

=== Required output ===
When a weather addon is asked to retrieve weather information, it needs to return this info to Kodi. This is done by making the various pieces of information available as window properties of the weather window.

The basic python code needed to provide a window property:
<syntaxhighlight lang="python">
WINDOW = xbmcgui.Window(12600)
WINDOW.setProperty(name, value)
</syntaxhighlight>

Kodi expects a weather addon to populate these properties:

=== Current Weather ===

{{Glossary}}
{{Term|1=Current.Condition|2=<code>Current.Condition</code>}}
{{Defn|1=the weather condition as a string|style=margin-left: 4em;}}
{{Term|1=Current.Temperature|2=<code>Current.Temperature</code>}}
{{Defn|1=temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Wind|2=<code>Current.Wind</code>}}
{{Defn|1=windspeed in km/h|style=margin-left: 4em;}}
{{Term|1=Current.WindDirection|2=<code>Current.WindDirection</code>}}
{{Defn|1=wind direction, NNE|style=margin-left: 4em;}}
{{Term|1=Current.Humidity|2=<code>Current.Humidity</code>}}
{{Defn|1=relative humidity as a percentage|style=margin-left: 4em;}}
{{Term|1=Current.FeelsLike|2=<code>Current.FeelsLike</code>}}
{{Defn|1=feels-like temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.UVIndex|2=<code>Current.UVIndex</code>}}
{{Defn|1=the UV-index as an integer|style=margin-left: 4em;}}
{{Term|1=Current.DewPoint|2=<code>Current.DewPoint</code>}}
{{Defn|1=dewpoint in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Precipitation|2=<code>Current.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Term|1=Current.Cloudiness|2=<code>Current.Cloudiness</code>}}
{{Defn|1=cloud cover in %|style=margin-left: 4em;}}
{{Term|1=Current.OutlookIcon|2=<code>Current.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Current.FanartCode|2=<code>Current.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Glossary end}}

Kodi will read those window properties and do unit conversions if needed, depending on the regional settings in Kodi.<br />

=== Hourly Weather ===

{{Glossary}}
{{Term|1=Hourly.%i.Time|2=<code>Hourly.%i.Time</code>}}
{{Defn|1=hour time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.LongDate|2=<code>Hourly.%i.LongDate</code>}}
{{Defn|1=long date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.ShortDate|2=<code>Hourly.%i.ShortDate</code>}}
{{Defn|1=short date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Outlook|2=<code>Hourly.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.OutlookIcon|2=<code>Hourly.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FanartCode|2=<code>Hourly.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindSpeed|2=<code>Hourly.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindDirection|2=<code>Hourly.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Humidity|2=<code>Hourly.%i.Humidity</code>}}
{{Defn|1=humidity in %|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Temperature|2=<code>Hourly.%i.Temperature</code>}}
{{Defn|1=temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.DewPoint|2=<code>Hourly.%i.DewPoint</code>}}
{{Defn|1=dew point as temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FeelsLike|2=<code>Hourly.%i.FeelsLike</code>}}
{{Defn|1=apparent temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Pressure|2=<code>Hourly.%i.Pressure</code>}}
{{Defn|1=pressure with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Precipitation|2=<code>Hourly.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Hourly items are 1-indexed, that is, they start from 1.

=== Daily Weather ===

{{Term|1=Daily.%i.ShortDate|2=<code>Daily.%i.ShortDate</code>}}
{{Defn|1=short date|style=margin-left: 4em;}}
{{Term|1=Daily.%i.ShortDay|2=<code>Daily.%i.ShortDay</code>}}
{{Defn|1=short day label, e.g. Mon|style=margin-left: 4em;}}
{{Term|1=Daily.%i.HighTemperature|2=<code>Daily.%i.HighTemperature</code>}}
{{Defn|1=high temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.LowTemperature|2=<code>Daily.%i.LowTemperature</code>}}
{{Defn|1=low temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Outlook|2=<code>Daily.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Daily.%i.OutlookIcon|2=<code>Daily.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.FanartCode|2=<code>Daily.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindSpeed|2=<code>Daily.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindDirection|2=<code>Daily.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Precipitation|2=<code>Daily.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Daily items are 1-indexed, that is, they start from 1.

=== Additional Weather Properties ===

Some skins, e.g. aeon.nox.silvo, may use the following properties (up to 7 days):

{{Glossary}}
{{Term|1=Day%i.Title|2=<code>Day%i.Title</code>}}
{{Defn|1=day of the week|style=margin-left: 4em;}}
{{Term|1=Day%i.HighTemp|2=<code>Day%i.HighTemp</code>}}
{{Defn|1=high temperature for the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.LowTemp|2=<code>Day%i.LowTemp</code>}}
{{Defn|1=low temperature of the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.Outlook|2=<code>Day%i.Outlook</code>}}
{{Defn|1=the weather forecast|style=margin-left: 4em;}}
{{Term|1=Day%i.OutlookIcon|2=<code>Day%i.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename|style=margin-left: 4em;}}
{{Term|1=Day%i.FanartCode|2=<code>Day%i.FanartCode</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Glossary end}}

Note that those properties are 0-indexed.

=== General Properties ===

{{Glossary}}
{{Term|1=Location|2=<code>Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=Current.Location|2=<code>Current.Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=WeatherProvider|2=<code>WeatherProvider</code>}}
{{Defn|1=weather addon name|style=margin-left: 4em;}}
{{Term|1=WeatherProviderLogo|2=<code>WeatherProviderLogo</code>}}
{{Defn|1=path to the addon logo file, preferrabely in a banner format|style=margin-left: 4em;}}
{{Term|1=Weather.IsFetched|2=<code>Weather.IsFetched</code>}}
{{Defn|1=true if weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Current.IsFetched|2=<code>Current.IsFetched</code>}}
{{Defn|1=true if current weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Hourly.IsFetched|2=<code>Hourly.IsFetched</code>}}
{{Defn|1=true if hourly weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Daily.IsFetched|2=<code>Daily.IsFetched </code>}}
{{Defn|1=true if daily weather info is fetched|style=margin-left: 4em;}}
{{Glossary end}}

The name of the window property set by the weather addon and the resulting window property for the skin will differ in a few scenarios:
* Current.OutlookIcon (addon) -> Current.ConditionIcon (skin)
* Current.Wind (addon) -> Current.WindSpeed (skin)
* Current.Wind / Current.WindDirection (addon) -> Current.Wind (skin)
Kodi combines the Wind and WindDirection properties into a Wind property with this format: 'From <wind dir> at <speed> <unit>'<br />

In addition, several window properties set by the addon will be made available to the skin as infolabels:
* Current.Condition (addon) -> Weather.Conditions (skin)
* Current.Temperature (addon) -> Weather.Temperature (skin)
* Current.FanartCode (addon) -> Weather.FanartCode (skin)

Finally, at the end of your script, you need to set the following window properties:
<pre>
* Location%i (the name of each weather location that has been configured by the user. for locations that are not configured, set an empty property.)
* Locations (the total number of locations that have been set up by the user. don't count the ones that have not been configured!)
</pre><br />

Once the addon has finished, Kodi will make one additional infolabel available to the skin:
<pre>
* Weather.Location (the name of the current weather location)
</pre>

The name of the weather addon, can be displayed by the skin using:
<pre>
* Weather.Plugin (the name of the weather addon)
</pre>

=Advanced weather info (optional)=
Besides the weather infolabels mentioned above, your addon can return many more, basically there are no limits.
Keep in mind though, that it requires skin support to display this additional information in Kodi.

If you want to go this route, have a look at the infolabels provided by the Openweathermap and Wunderground addons:<br />
* https://github.com/xbmc/repo-scripts/blob/krypton/weather.openweathermap.extended/README.txt<br />
* https://github.com/xbmc/repo-scripts/blob/jarvis/weather.wunderground/README.txt<br />

The infolabels provided by those addons are reasonably well supported by a number of skins already,
so try if you can use the same infolabel names in your addon.

=Weather Codes=
Kodi ships with an icon pack that includes an icon for each weather condition.<br />
(https://github.com/xbmc/xbmc/tree/master/addons/resource.images.weathericons.default)<br />
Several additional weather icon packs are available through the official Kodi repository.

The following condition-code table is used for the icon names:
<pre>
0 tornado
1 tropical storm
2 hurricane
3 severe thunderstorms
4 thunderstorms
5 mixed rain and snow
6 mixed rain and sleet
7 mixed snow and sleet
8 freezing drizzle
9 drizzle
10 freezing rain
11 showers
12 showers
13 snow flurries
14 light snow showers
15 blowing snow
16 snow
17 hail
18 sleet
19 dust
20 foggy
21 haze
22 smoky
23 blustery
24 windy
25 cold
26 cloudy
27 mostly cloudy (night)
28 mostly cloudy (day)
29 partly cloudy (night)
30 partly cloudy (day)
31 clear (night)
32 sunny
33 fair (night)
34 fair (day)
35 mixed rain and hail
36 hot
37 isolated thunderstorms
38 scattered thunderstorms
39 scattered thunderstorms
40 scattered showers
41 heavy snow
42 scattered snow showers
43 heavy snow
44 partly cloudy
45 thundershowers
46 snow showers
47 isolated thundershowers
na not available
</pre>

[[Category:Add-on_development]]

Weather addons

2024-10-28T13:27:20Z

Roman VM: clarification

{{Main|Weather}}

{{Note|This page describes the development of Weather addons for Kodi. If you're interested in them from a user's perspective (where to get them, how to configure them, etc.), please use the link above.}}

== addon.xml ==
Weather addons use the 'xbmc.python.weather' extension point.
The basic layout of the addon.xml of a weather addon will look like:
<syntaxhighlight lang="xml" line highlight="6" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="weather.name" name="My Weather" version="1.2.3" provider-name="me">
<requires>
<import addon="xbmc.python" version="3.0.0" />
</requires>
<extension point="xbmc.python.weather" library="" />
<extension point="xbmc.addon.metadata">
<summary lang="en_GB"></summary>
<description lang="en_GB"></description>
<language></language>
<platform></platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

== Things to know ==
There are a few things (quirks) you need to be aware of when creating a weather addon...
* A weather addon will be run automatically when the skins asks to display one of these weather-specific infolabels:
** <code>Weather.Conditions</code>
** <code>Weather.Temperature</code>
** <code>Weather.Location</code>
* The weather addon will run at 30 minute intervals (as long the current skin window displays one of the above-mentioned infolabels)
* In the weather window, Kodi will automatically try to translate all the weather strings
* Kodi will also handle transformations between units (for instance, Celsius to Fahrenheit, km/h to mph)

== Theory of operation ==
Kodi can run a weather addon in two modes:

=== Weather location configuration ===
In order to set up a weather addon, you need to include a settings.xml file for your weather addon. It needs to have this structure:
<syntaxhighlight lang="xml" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings version="1">
<section id="weather.name">
<category id="locations" label="">
<group id="1">
<setting id="location1" type="string" label="" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location1)</data>
</control>
</setting>
<setting id="location2" type="string" label="32003" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location2)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location1" />
</dependencies>
</setting>
<setting id="location3" type="string" label="32004" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location3)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location2" />
</dependencies>
</setting>
</group>
</category>
</section>
</settings>
</syntaxhighlight>

You can define as many weather locations as you want in your settings.xml file.

When you're going to set up a location in the weather addon settings, Kodi will pass the argument(s) you've defined in the RunScript() action above to your addon. For instance, if you set the 'Location 2' entry active in the Weather settings, Kodi will pass 'Loc2' to your addon.

=== Retrieving weather data ===
When weather information needs to be retrieved, Kodi will pass the location number to your addon. For instance, if the weather for Location 4 is requested, Kodi will pass '4' to the weather addon.

=== Required output ===
When a weather addon is asked to retrieve weather information, it needs to return this info to Kodi. This is done by making the various pieces of information available as window properties of the weather window.

The basic python code needed to provide a window property:
<syntaxhighlight lang="python">
WINDOW = xbmcgui.Window(12600)
WINDOW.setProperty(name, value)
</syntaxhighlight>

Kodi expects a weather addon to populate these properties:

=== Current Weather ===

{{Glossary}}
{{Term|1=Current.Condition|2=<code>Current.Condition</code>}}
{{Defn|1=the weather condition as a string|style=margin-left: 4em;}}
{{Term|1=Current.Temperature|2=<code>Current.Temperature</code>}}
{{Defn|1=temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Wind|2=<code>Current.Wind</code>}}
{{Defn|1=windspeed in km/h|style=margin-left: 4em;}}
{{Term|1=Current.WindDirection|2=<code>Current.WindDirection</code>}}
{{Defn|1=wind direction, NNE|style=margin-left: 4em;}}
{{Term|1=Current.Humidity|2=<code>Current.Humidity</code>}}
{{Defn|1=relative humidity as a percentage|style=margin-left: 4em;}}
{{Term|1=Current.FeelsLike|2=<code>Current.FeelsLike</code>}}
{{Defn|1=feels-like temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.UVIndex|2=<code>Current.UVIndex</code>}}
{{Defn|1=the UV-index as an integer|style=margin-left: 4em;}}
{{Term|1=Current.DewPoint|2=<code>Current.DewPoint</code>}}
{{Defn|1=dewpoint in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Precipitation|2=<code>Current.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Term|1=Current.Cloudiness|2=<code>Current.Cloudiness</code>}}
{{Defn|1=cloud cover in %|style=margin-left: 4em;}}
{{Term|1=Current.OutlookIcon|2=<code>Current.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Current.FanartCode|2=<code>Current.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Glossary end}}

Kodi will read those window properties and do unit conversions if needed, depending on the regional settings in Kodi.<br />

=== Hourly Weather ===

{{Glossary}}
{{Term|1=Hourly.%i.Time|2=<code>Hourly.%i.Time</code>}}
{{Defn|1=hour time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.LongDate|2=<code>Hourly.%i.LongDate</code>}}
{{Defn|1=long date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.ShortDate|2=<code>Hourly.%i.ShortDate</code>}}
{{Defn|1=short date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Outlook|2=<code>Hourly.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.OutlookIcon|2=<code>Hourly.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FanartCode|2=<code>Hourly.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindSpeed|2=<code>Hourly.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindDirection|2=<code>Hourly.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Humidity|2=<code>Hourly.%i.Humidity</code>}}
{{Defn|1=humidity in %|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Temperature|2=<code>Hourly.%i.Temperature</code>}}
{{Defn|1=temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.DewPoint|2=<code>Hourly.%i.DewPoint</code>}}
{{Defn|1=dew point as temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FeelsLike|2=<code>Hourly.%i.FeelsLike</code>}}
{{Defn|1=apparent temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Pressure|2=<code>Hourly.%i.Pressure</code>}}
{{Defn|1=pressure with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Precipitation|2=<code>Hourly.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Hourly items are 1-indexed, that is, they start from 1.

=== Daily Weather ===

{{Term|1=Daily.%i.ShortDate|2=<code>Daily.%i.ShortDate</code>}}
{{Defn|1=short date|style=margin-left: 4em;}}
{{Term|1=Daily.%i.ShortDay|2=<code>Daily.%i.ShortDay</code>}}
{{Defn|1=short day label, e.g. Mon|style=margin-left: 4em;}}
{{Term|1=Daily.%i.HighTemperature|2=<code>Daily.%i.HighTemperature</code>}}
{{Defn|1=high temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.LowTemperature|2=<code>Daily.%i.LowTemperature</code>}}
{{Defn|1=low temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Outlook|2=<code>Daily.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Daily.%i.OutlookIcon|2=<code>Daily.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.FanartCode|2=<code>Daily.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindSpeed|2=<code>Daily.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindDirection|2=<code>Daily.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Precipitation|2=<code>Daily.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Daily items are 1-indexed, that is, they start from 1.

=== Additional Weather Properties ===

Some skins, e.g. aeon.nox.silvo, may use the following properties (up to 7 days):

{{Glossary}}
{{Term|1=Day%i.Title|2=<code>Day%i.Title</code>}}
{{Defn|1=day of the week|style=margin-left: 4em;}}
{{Term|1=Day%i.HighTemp|2=<code>Day%i.HighTemp</code>}}
{{Defn|1=high temperature for the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.LowTemp|2=<code>Day%i.LowTemp</code>}}
{{Defn|1=low temperature of the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.Outlook|2=<code>Day%i.Outlook</code>}}
{{Defn|1=the weather forecast|style=margin-left: 4em;}}
{{Term|1=Day%i.OutlookIcon|2=<code>Day%i.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename|style=margin-left: 4em;}}
{{Term|1=Day%i.FanartCode|2=<code>Day%i.FanartCode</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Glossary end}}

Note that those properties are 0-indexed.

=== General Properties ===

{{Glossary}}
{{Term|1=Location|2=<code>Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=Current.Location|2=<code>Current.Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=WeatherProvider|2=<code>WeatherProvider</code>}}
{{Defn|1=weather addon name|style=margin-left: 4em;}}
{{Term|1=WeatherProviderLogo|2=<code>Location</code>}}
{{Defn|1=path to the addon logo file, preferrabely in a banner format|style=margin-left: 4em;}}
{{Term|1=Weather.IsFetched|2=<code>Weather.IsFetched</code>}}
{{Defn|1=true if weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Current.IsFetched|2=<code>Current.IsFetched</code>}}
{{Defn|1=true if current weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Hourly.IsFetched|2=<code>Hourly.IsFetched</code>}}
{{Defn|1=true if hourly weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Daily.IsFetched|2=<code>Daily.IsFetched </code>}}
{{Defn|1=true if daily weather info is fetched|style=margin-left: 4em;}}
{{Glossary end}}

The name of the window property set by the weather addon and the resulting window property for the skin will differ in a few scenarios:
* Current.OutlookIcon (addon) -> Current.ConditionIcon (skin)
* Current.Wind (addon) -> Current.WindSpeed (skin)
* Current.Wind / Current.WindDirection (addon) -> Current.Wind (skin)
Kodi combines the Wind and WindDirection properties into a Wind property with this format: 'From <wind dir> at <speed> <unit>'<br />

In addition, several window properties set by the addon will be made available to the skin as infolabels:
* Current.Condition (addon) -> Weather.Conditions (skin)
* Current.Temperature (addon) -> Weather.Temperature (skin)
* Current.FanartCode (addon) -> Weather.FanartCode (skin)

Finally, at the end of your script, you need to set the following window properties:
<pre>
* Location%i (the name of each weather location that has been configured by the user. for locations that are not configured, set an empty property.)
* Locations (the total number of locations that have been set up by the user. don't count the ones that have not been configured!)
</pre><br />

Once the addon has finished, Kodi will make one additional infolabel available to the skin:
<pre>
* Weather.Location (the name of the current weather location)
</pre>

The name of the weather addon, can be displayed by the skin using:
<pre>
* Weather.Plugin (the name of the weather addon)
</pre>

=Advanced weather info (optional)=
Besides the weather infolabels mentioned above, your addon can return many more, basically there are no limits.
Keep in mind though, that it requires skin support to display this additional information in Kodi.

If you want to go this route, have a look at the infolabels provided by the Openweathermap and Wunderground addons:<br />
* https://github.com/xbmc/repo-scripts/blob/krypton/weather.openweathermap.extended/README.txt<br />
* https://github.com/xbmc/repo-scripts/blob/jarvis/weather.wunderground/README.txt<br />

The infolabels provided by those addons are reasonably well supported by a number of skins already,
so try if you can use the same infolabel names in your addon.

=Weather Codes=
Kodi ships with an icon pack that includes an icon for each weather condition.<br />
(https://github.com/xbmc/xbmc/tree/master/addons/resource.images.weathericons.default)<br />
Several additional weather icon packs are available through the official Kodi repository.

The following condition-code table is used for the icon names:
<pre>
0 tornado
1 tropical storm
2 hurricane
3 severe thunderstorms
4 thunderstorms
5 mixed rain and snow
6 mixed rain and sleet
7 mixed snow and sleet
8 freezing drizzle
9 drizzle
10 freezing rain
11 showers
12 showers
13 snow flurries
14 light snow showers
15 blowing snow
16 snow
17 hail
18 sleet
19 dust
20 foggy
21 haze
22 smoky
23 blustery
24 windy
25 cold
26 cloudy
27 mostly cloudy (night)
28 mostly cloudy (day)
29 partly cloudy (night)
30 partly cloudy (day)
31 clear (night)
32 sunny
33 fair (night)
34 fair (day)
35 mixed rain and hail
36 hot
37 isolated thunderstorms
38 scattered thunderstorms
39 scattered thunderstorms
40 scattered showers
41 heavy snow
42 scattered snow showers
43 heavy snow
44 partly cloudy
45 thundershowers
46 snow showers
47 isolated thundershowers
na not available
</pre>

[[Category:Add-on_development]]

Weather addons

2024-10-28T12:15:59Z

Roman VM: minor update

{{Main|Weather}}

{{Note|This page describes the development of Weather addons for Kodi. If you're interested in them from a user's perspective (where to get them, how to configure them, etc.), please use the link above.}}

== addon.xml ==
Weather addons use the 'xbmc.python.weather' extension point.
The basic layout of the addon.xml of a weather addon will look like:
<syntaxhighlight lang="xml" line highlight="6" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="weather.name" name="My Weather" version="1.2.3" provider-name="me">
<requires>
<import addon="xbmc.python" version="3.0.0" />
</requires>
<extension point="xbmc.python.weather" library="" />
<extension point="xbmc.addon.metadata">
<summary lang="en_GB"></summary>
<description lang="en_GB"></description>
<language></language>
<platform></platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

== Things to know ==
There are a few things (quirks) you need to be aware of when creating a weather addon...
* A weather addon will be run automatically when the skins asks to display one of these weather-specific infolabels:
** <code>Weather.Conditions</code>
** <code>Weather.Temperature</code>
** <code>Weather.Location</code>
* The weather addon will run at 30 minute intervals (as long the current skin window displays one of the above-mentioned infolabels)
* In the weather window, Kodi will automatically try to translate all the weather strings
* Kodi will also handle transformations between units (for instance, Celsius to Fahrenheit, km/h to mph)

== Theory of operation ==
Kodi can run a weather addon in two modes:

=== Weather location configuration ===
In order to set up a weather addon, you need to include a settings.xml file for your weather addon. It needs to have this structure:
<syntaxhighlight lang="xml" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings version="1">
<section id="weather.name">
<category id="locations" label="">
<group id="1">
<setting id="location1" type="string" label="" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location1)</data>
</control>
</setting>
<setting id="location2" type="string" label="32003" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location2)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location1" />
</dependencies>
</setting>
<setting id="location3" type="string" label="32004" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location3)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location2" />
</dependencies>
</setting>
</group>
</category>
</section>
</settings>
</syntaxhighlight>

You can define as many weather locations as you want in your settings.xml file.

When you're going to set up a location in the weather addon settings, Kodi will pass the argument(s) you've defined in the RunScript() action above to your addon. For instance, if you set the 'Location 2' entry active in the Weather settings, Kodi will pass 'Loc2' to your addon.

=== Retrieving weather data ===
When weather information needs to be retrieved, Kodi will pass the location number to your addon. For instance, if the weather for Location 4 is requested, Kodi will pass '4' to the weather addon.

=== Required output ===
When a weather addon is asked to retrieve weather information, it needs to return this info to Kodi. This is done by making the various pieces of information available as window properties of the weather window.

The basic python code needed to provide a window property:
<syntaxhighlight lang="python">
WINDOW = xbmcgui.Window(12600)
WINDOW.setProperty(name, value)
</syntaxhighlight>

Kodi expects a weather addon to return these properties:

=== Current Weather ===

{{Glossary}}
{{Term|1=Current.Condition|2=<code>Current.Condition</code>}}
{{Defn|1=the weather condition as a string|style=margin-left: 4em;}}
{{Term|1=Current.Temperature|2=<code>Current.Temperature</code>}}
{{Defn|1=temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Wind|2=<code>Current.Wind</code>}}
{{Defn|1=windspeed in km/h|style=margin-left: 4em;}}
{{Term|1=Current.WindDirection|2=<code>Current.WindDirection</code>}}
{{Defn|1=wind direction, NNE|style=margin-left: 4em;}}
{{Term|1=Current.Humidity|2=<code>Current.Humidity</code>}}
{{Defn|1=relative humidity as a percentage|style=margin-left: 4em;}}
{{Term|1=Current.FeelsLike|2=<code>Current.FeelsLike</code>}}
{{Defn|1=feels-like temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.UVIndex|2=<code>Current.UVIndex</code>}}
{{Defn|1=the UV-index as an integer|style=margin-left: 4em;}}
{{Term|1=Current.DewPoint|2=<code>Current.DewPoint</code>}}
{{Defn|1=dewpoint in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Precipitation|2=<code>Current.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Term|1=Current.Cloudiness|2=<code>Current.Cloudiness</code>}}
{{Defn|1=cloud cover in %|style=margin-left: 4em;}}
{{Term|1=Current.OutlookIcon|2=<code>Current.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Current.FanartCode|2=<code>Current.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Glossary end}}

Kodi will read those window properties and do unit conversions if needed, depending on the regional settings in Kodi.<br />

=== Hourly Weather ===

{{Glossary}}
{{Term|1=Hourly.%i.Time|2=<code>Hourly.%i.Time</code>}}
{{Defn|1=hour time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.LongDate|2=<code>Hourly.%i.LongDate</code>}}
{{Defn|1=long date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.ShortDate|2=<code>Hourly.%i.ShortDate</code>}}
{{Defn|1=short date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Outlook|2=<code>Hourly.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.OutlookIcon|2=<code>Hourly.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FanartCode|2=<code>Hourly.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindSpeed|2=<code>Hourly.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindDirection|2=<code>Hourly.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Humidity|2=<code>Hourly.%i.Humidity</code>}}
{{Defn|1=humidity in %|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Temperature|2=<code>Hourly.%i.Temperature</code>}}
{{Defn|1=temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.DewPoint|2=<code>Hourly.%i.DewPoint</code>}}
{{Defn|1=dew point as temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FeelsLike|2=<code>Hourly.%i.FeelsLike</code>}}
{{Defn|1=apparent temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Pressure|2=<code>Hourly.%i.Pressure</code>}}
{{Defn|1=pressure with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Precipitation|2=<code>Hourly.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Hourly items are 1-indexed, that is, they start from 1.

=== Daily Weather ===

{{Term|1=Daily.%i.ShortDate|2=<code>Daily.%i.ShortDate</code>}}
{{Defn|1=short date|style=margin-left: 4em;}}
{{Term|1=Daily.%i.ShortDay|2=<code>Daily.%i.ShortDay</code>}}
{{Defn|1=short day label, e.g. Mon|style=margin-left: 4em;}}
{{Term|1=Daily.%i.HighTemperature|2=<code>Daily.%i.HighTemperature</code>}}
{{Defn|1=high temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.LowTemperature|2=<code>Daily.%i.LowTemperature</code>}}
{{Defn|1=low temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Outlook|2=<code>Daily.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Daily.%i.OutlookIcon|2=<code>Daily.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.FanartCode|2=<code>Daily.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindSpeed|2=<code>Daily.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindDirection|2=<code>Daily.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Precipitation|2=<code>Daily.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Daily items are 1-indexed, that is, they start from 1.

=== Additional Weather Properties ===

Some skins, e.g. aeon.nox.silvo, may use the following properties (up to 7 days):

{{Glossary}}
{{Term|1=Day%i.Title|2=<code>Day%i.Title</code>}}
{{Defn|1=day of the week|style=margin-left: 4em;}}
{{Term|1=Day%i.HighTemp|2=<code>Day%i.HighTemp</code>}}
{{Defn|1=high temperature for the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.LowTemp|2=<code>Day%i.LowTemp</code>}}
{{Defn|1=low temperature of the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.Outlook|2=<code>Day%i.Outlook</code>}}
{{Defn|1=the weather forecast|style=margin-left: 4em;}}
{{Term|1=Day%i.OutlookIcon|2=<code>Day%i.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename|style=margin-left: 4em;}}
{{Term|1=Day%i.FanartCode|2=<code>Day%i.FanartCode</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Glossary end}}

Note that those properties are 0-indexed.

=== General Properties ===

{{Glossary}}
{{Term|1=Location|2=<code>Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=Current.Location|2=<code>Current.Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=WeatherProvider|2=<code>WeatherProvider</code>}}
{{Defn|1=weather addon name|style=margin-left: 4em;}}
{{Term|1=WeatherProviderLogo|2=<code>Location</code>}}
{{Defn|1=path to the addon logo file, preferrabely in a banner format|style=margin-left: 4em;}}
{{Term|1=Weather.IsFetched|2=<code>Weather.IsFetched</code>}}
{{Defn|1=true if weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Current.IsFetched|2=<code>Current.IsFetched</code>}}
{{Defn|1=true if current weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Hourly.IsFetched|2=<code>Hourly.IsFetched</code>}}
{{Defn|1=true if hourly weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Daily.IsFetched|2=<code>Daily.IsFetched </code>}}
{{Defn|1=true if daily weather info is fetched|style=margin-left: 4em;}}
{{Glossary end}}

The name of the window property set by the weather addon and the resulting window property for the skin will differ in a few scenarios:
* Current.OutlookIcon (addon) -> Current.ConditionIcon (skin)
* Current.Wind (addon) -> Current.WindSpeed (skin)
* Current.Wind / Current.WindDirection (addon) -> Current.Wind (skin)
Kodi combines the Wind and WindDirection properties into a Wind property with this format: 'From <wind dir> at <speed> <unit>'<br />

In addition, several window properties set by the addon will be made available to the skin as infolabels:
* Current.Condition (addon) -> Weather.Conditions (skin)
* Current.Temperature (addon) -> Weather.Temperature (skin)
* Current.FanartCode (addon) -> Weather.FanartCode (skin)

Finally, at the end of your script, you need to set the following window properties:
<pre>
* Location%i (the name of each weather location that has been configured by the user. for locations that are not configured, set an empty property.)
* Locations (the total number of locations that have been set up by the user. don't count the ones that have not been configured!)
</pre><br />

Once the addon has finished, Kodi will make one additional infolabel available to the skin:
<pre>
* Weather.Location (the name of the current weather location)
</pre>

The name of the weather addon, can be displayed by the skin using:
<pre>
* Weather.Plugin (the name of the weather addon)
</pre>

=Advanced weather info (optional)=
Besides the weather infolabels mentioned above, your addon can return many more, basically there are no limits.
Keep in mind though, that it requires skin support to display this additional information in Kodi.

If you want to go this route, have a look at the infolabels provided by the Openweathermap and Wunderground addons:<br />
* https://github.com/xbmc/repo-scripts/blob/krypton/weather.openweathermap.extended/README.txt<br />
* https://github.com/xbmc/repo-scripts/blob/jarvis/weather.wunderground/README.txt<br />

The infolabels provided by those addons are reasonably well supported by a number of skins already,
so try if you can use the same infolabel names in your addon.

=Weather Codes=
Kodi ships with an icon pack that includes an icon for each weather condition.<br />
(https://github.com/xbmc/xbmc/tree/master/addons/resource.images.weathericons.default)<br />
Several additional weather icon packs are available through the official Kodi repository.

The following condition-code table is used for the icon names:
<pre>
0 tornado
1 tropical storm
2 hurricane
3 severe thunderstorms
4 thunderstorms
5 mixed rain and snow
6 mixed rain and sleet
7 mixed snow and sleet
8 freezing drizzle
9 drizzle
10 freezing rain
11 showers
12 showers
13 snow flurries
14 light snow showers
15 blowing snow
16 snow
17 hail
18 sleet
19 dust
20 foggy
21 haze
22 smoky
23 blustery
24 windy
25 cold
26 cloudy
27 mostly cloudy (night)
28 mostly cloudy (day)
29 partly cloudy (night)
30 partly cloudy (day)
31 clear (night)
32 sunny
33 fair (night)
34 fair (day)
35 mixed rain and hail
36 hot
37 isolated thunderstorms
38 scattered thunderstorms
39 scattered thunderstorms
40 scattered showers
41 heavy snow
42 scattered snow showers
43 heavy snow
44 partly cloudy
45 thundershowers
46 snow showers
47 isolated thundershowers
na not available
</pre>

[[Category:Add-on_development]]

Weather addons

2024-10-28T12:08:26Z

Roman VM: Add the current info about weather addon development

{{Main|Weather}}

{{Note|This page describes the development of Weather addons for Kodi. If you're interested in them from a user's perspective (where to get them, how to configure them, etc.), please use the link above.}}

== addon.xml ==
Weather addons use the 'xbmc.python.weather' extension point.
The basic layout of the addon.xml of a weather addon will look like:
<syntaxhighlight lang="xml" line highlight="6" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<addon id="weather.name" name="My Weather" version="1.2.3" provider-name="me">
<requires>
<import addon="xbmc.python" version="3.0.0" />
</requires>
<extension point="xbmc.python.weather" library="" />
<extension point="xbmc.addon.metadata">
<summary lang="en_GB"></summary>
<description lang="en_GB"></description>
<language></language>
<platform></platform>
<license></license>
<forum></forum>
<website></website>
<email></email>
<source></source>
</extension>
</addon>
</syntaxhighlight>

== Things to know ==
There are a few things (quirks) you need to be aware of when creating a weather addon...
* A weather addon will be run automatically when the skins asks to display one of these weather-specific infolabels:
** <code>Weather.Conditions</code>
** <code>Weather.Temperature</code>
** <code>Weather.Location</code>
* The weather addon will run at 30 minute intervals (as long the current skin window displays one of the above-mentioned infolabels)
* In the weather window, Kodi will automatically try to translate all the weather strings
* Kodi will also handle transformations between units (for instance, Celsius to Fahrenheit, km/h to mph)

== Theory of operation ==
Kodi can run a weather addon in two modes:

=== Weather location configuration ===
In order to set up a weather addon, you need to include a settings.xml file for your weather addon. It needs to have this structure:
<syntaxhighlight lang="xml" style="white-space: pre-wrap;">
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<settings version="1">
<section id="weather.name">
<category id="locations" label="">
<group id="1">
<setting id="location1" type="string" label="" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location1)</data>
</control>
</setting>
<setting id="location2" type="string" label="32003" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location2)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location1" />
</dependencies>
</setting>
<setting id="location3" type="string" label="32004" help="">
<level>0</level>
<default/>
<constraints>
<allowempty>true</allowempty>
</constraints>
<control type="button" format="action">
<data>RunScript(weather.name,location3)</data>
</control>
<dependencies>
<dependency type="enable" operator="!is" setting="location2" />
</dependencies>
</setting>
</group>
</category>
</section>
</settings>
</syntaxhighlight>

You can define as many weather locations as you want in your settings.xml file.

When you're going to set up a location in the weather addon settings, Kodi will pass the argument(s) you've defined in the RunScript() action above to your addon. For instance, if you set the 'Location 2' entry active in the Weather settings, Kodi will pass 'Loc2' to your addon.

=== Retrieving weather data ===
When weather information needs to be retrieved, Kodi will pass the location number to your addon. For instance, if the weather for Location 4 is requested, Kodi will pass '4' to the weather addon.

=== Required output ===
When a weather addon is asked to retrieve weather information, it needs to return this info to Kodi. This is done by making the various pieces of information available as window properties of the weather window.

The basic python code needed to provide a window property:
<syntaxhighlight lang="python">
WINDOW = xbmcgui.Window(12600)
WINDOW.setProperty(name, value)
</syntaxhighlight>

Kodi expects a weather addon to return these properties:

=== Current Weather ===

{{Glossary}}
{{Term|1=Current.Condition|2=<code>Current.Condition</code>}}
{{Defn|1=the weather condition as a string|style=margin-left: 4em;}}
{{Term|1=Current.Temperature|2=<code>Current.Temperature</code>}}
{{Defn|1=temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Wind|2=<code>Current.Wind</code>}}
{{Defn|1=windspeed in km/h|style=margin-left: 4em;}}
{{Term|1=Current.WindDirection|2=<code>Current.WindDirection</code>}}
{{Defn|1=wind direction, NNE|style=margin-left: 4em;}}
{{Term|1=Current.Humidity|2=<code>Current.Humidity</code>}}
{{Defn|1=relative humidity as a percentage|style=margin-left: 4em;}}
{{Term|1=Current.FeelsLike|2=<code>Current.FeelsLike</code>}}
{{Defn|1=feels-like temperature in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.UVIndex|2=<code>Current.UVIndex</code>}}
{{Defn|1=the UV-index as an integer|style=margin-left: 4em;}}
{{Term|1=Current.DewPoint|2=<code>Current.DewPoint</code>}}
{{Defn|1=dewpoint in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Current.Precipitation|2=<code>Current.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Term|1=Current.Cloudiness|2=<code>Current.Cloudiness</code>}}
{{Defn|1=cloud cover in %|style=margin-left: 4em;}}
{{Term|1=Current.OutlookIcon|2=<code>Current.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Current.FanartCode|2=<code>Current.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Glossary end}}

Kodi will read those window properties and do unit conversions if needed, depending on the regional settings in Kodi.<br />

=== Hourly Weather ===

{{Glossary}}
{{Term|1=Hourly.%i.Time|2=<code>Hourly.%i.Time</code>}}
{{Defn|1=hour time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.LongDate|2=<code>Hourly.%i.LongDate</code>}}
{{Defn|1=long date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.ShortDate|2=<code>Hourly.%i.ShortDate</code>}}
{{Defn|1=short date and time|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Outlook|2=<code>Hourly.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.OutlookIcon|2=<code>Hourly.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FanartCode|2=<code>Hourly.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindSpeed|2=<code>Hourly.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.WindDirection|2=<code>Hourly.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Humidity|2=<code>Hourly.%i.Humidity</code>}}
{{Defn|1=humidity in %|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Temperature|2=<code>Hourly.%i.Temperature</code>}}
{{Defn|1=temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.DewPoint|2=<code>Hourly.%i.DewPoint</code>}}
{{Defn|1=dew point as temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.FeelsLike|2=<code>Hourly.%i.FeelsLike</code>}}
{{Defn|1=apparent temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Pressure|2=<code>Hourly.%i.Pressure</code>}}
{{Defn|1=pressure with a unit|style=margin-left: 4em;}}
{{Term|1=Hourly.%i.Precipitation|2=<code>Hourly.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Hourly items are 1-indexed, that is, they start from 1.

=== Daily Weather ===

{{Term|1=Daily.%i.ShortDate|2=<code>Daily.%i.ShortDate</code>}}
{{Defn|1=short date|style=margin-left: 4em;}}
{{Term|1=Daily.%i.ShortDay|2=<code>Daily.%i.ShortDay</code>}}
{{Defn|1=short day label, e.g. Mon|style=margin-left: 4em;}}
{{Term|1=Daily.%i.HighTemperature|2=<code>Daily.%i.HighTemperature</code>}}
{{Defn|1=high temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.LowTemperature|2=<code>Daily.%i.LowTemperature</code>}}
{{Defn|1=low temperature with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Outlook|2=<code>Daily.%i.Outlook</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Term|1=Daily.%i.OutlookIcon|2=<code>Daily.%i.OutlookIcon</code>}}
{{Defn|1=weather icon as a filename (e.g. 34.png)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.FanartCode|2=<code>Daily.%i.FanartCode</code>}}
{{Defn|1=condition code, as an integer (see Weather Codes section below)|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindSpeed|2=<code>Daily.%i.WindSpeed</code>}}
{{Defn|1=wind speed with a unit|style=margin-left: 4em;}}
{{Term|1=Daily.%i.WindDirection|2=<code>Daily.%i.WindDirection</code>}}
{{Defn|1=wind direction as a label, e.g. NW|style=margin-left: 4em;}}
{{Term|1=Daily.%i.Precipitation|2=<code>Daily.%i.Precipitation</code>}}
{{Defn|1=precipitation probability in %|style=margin-left: 4em;}}
{{Glossary end}}

Note that those parameters are not localized autmatically so it's addon's responsibility
to localize them properly. Daily items are 1-indexed, that is, they start from 1.

=== Additional Weather Properties ===

Some skins, e.g. aeon.nox.silvo, may use the following properties:

{{Glossary}}
{{Term|1=Day%i.Title|2=<code>Day%i.Title</code>}}
{{Defn|1=day of the week|style=margin-left: 4em;}}
{{Term|1=Day%i.HighTemp|2=<code>Day%i.HighTemp</code>}}
{{Defn|1=high temperature for the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.LowTemp|2=<code>Day%i.LowTemp</code>}}
{{Defn|1=low temperature of the day, in degrees Celsius|style=margin-left: 4em;}}
{{Term|1=Day%i.Outlook|2=<code>Day%i.Outlook</code>}}
{{Defn|1=the weather forecast|style=margin-left: 4em;}}
{{Term|1=Day%i.OutlookIcon|2=<code>Day%i.OutlookIcon</code>}}
{{Defn|1=weather icon, as a filename|style=margin-left: 4em;}}
{{Term|1=Day%i.FanartCode|2=<code>Day%i.FanartCode</code>}}
{{Defn|1=weather forecast as a string|style=margin-left: 4em;}}
{{Glossary end}}

Note that those properties are 0-indexed.

=== General Properties ===

{{Glossary}}
{{Term|1=Location|2=<code>Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=Current.Location|2=<code>Current.Location</code>}}
{{Defn|1=location name|style=margin-left: 4em;}}
{{Term|1=WeatherProvider|2=<code>WeatherProvider</code>}}
{{Defn|1=weather addon name|style=margin-left: 4em;}}
{{Term|1=WeatherProviderLogo|2=<code>Location</code>}}
{{Defn|1=path to the addon logo file, preferrabely in a banner format|style=margin-left: 4em;}}
{{Term|1=Weather.IsFetched|2=<code>Weather.IsFetched</code>}}
{{Defn|1=true if weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Current.IsFetched|2=<code>Current.IsFetched</code>}}
{{Defn|1=true if current weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Hourly.IsFetched|2=<code>Hourly.IsFetched</code>}}
{{Defn|1=true if hourly weather info is fetched|style=margin-left: 4em;}}
{{Term|1=Daily.IsFetched|2=<code>Daily.IsFetched </code>}}
{{Defn|1=true if daily weather info is fetched|style=margin-left: 4em;}}
{{Glossary end}}

The name of the window property set by the weather addon and the resulting window property for the skin will differ in a few scenarios:
* Current.OutlookIcon (addon) -> Current.ConditionIcon (skin)
* Current.Wind (addon) -> Current.WindSpeed (skin)
* Current.Wind / Current.WindDirection (addon) -> Current.Wind (skin)
Kodi combines the Wind and WindDirection properties into a Wind property with this format: 'From <wind dir> at <speed> <unit>'<br />

In addition, several window properties set by the addon will be made available to the skin as infolabels:
* Current.Condition (addon) -> Weather.Conditions (skin)
* Current.Temperature (addon) -> Weather.Temperature (skin)
* Current.FanartCode (addon) -> Weather.FanartCode (skin)

Finally, at the end of your script, you need to set the following window properties:
<pre>
* Location%i (the name of each weather location that has been configured by the user. for locations that are not configured, set an empty property.)
* Locations (the total number of locations that have been set up by the user. don't count the ones that have not been configured!)
</pre><br />

Once the addon has finished, Kodi will make one additional infolabel available to the skin:
<pre>
* Weather.Location (the name of the current weather location)
</pre>

The name of the weather addon, can be displayed by the skin using:
<pre>
* Weather.Plugin (the name of the weather addon)
</pre>

=Advanced weather info (optional)=
Besides the weather infolabels mentioned above, your addon can return many more, basically there are no limits.
Keep in mind though, that it requires skin support to display this additional information in Kodi.

If you want to go this route, have a look at the infolabels provided by the Openweathermap and Wunderground addons:<br />
* https://github.com/xbmc/repo-scripts/blob/krypton/weather.openweathermap.extended/README.txt<br />
* https://github.com/xbmc/repo-scripts/blob/jarvis/weather.wunderground/README.txt<br />

The infolabels provided by those addons are reasonably well supported by a number of skins already,
so try if you can use the same infolabel names in your addon.

=Weather Codes=
Kodi ships with an icon pack that includes an icon for each weather condition.<br />
(https://github.com/xbmc/xbmc/tree/master/addons/resource.images.weathericons.default)<br />
Several additional weather icon packs are available through the official Kodi repository.

The following condition-code table is used for the icon names:
<pre>
0 tornado
1 tropical storm
2 hurricane
3 severe thunderstorms
4 thunderstorms
5 mixed rain and snow
6 mixed rain and sleet
7 mixed snow and sleet
8 freezing drizzle
9 drizzle
10 freezing rain
11 showers
12 showers
13 snow flurries
14 light snow showers
15 blowing snow
16 snow
17 hail
18 sleet
19 dust
20 foggy
21 haze
22 smoky
23 blustery
24 windy
25 cold
26 cloudy
27 mostly cloudy (night)
28 mostly cloudy (day)
29 partly cloudy (night)
30 partly cloudy (day)
31 clear (night)
32 sunny
33 fair (night)
34 fair (day)
35 mixed rain and hail
36 hot
37 isolated thunderstorms
38 scattered thunderstorms
39 scattered thunderstorms
40 scattered showers
41 heavy snow
42 scattered snow showers
43 heavy snow
44 partly cloudy
45 thundershowers
46 snow showers
47 isolated thundershowers
na not available
</pre>

[[Category:Add-on_development]]