Projects/Plasma/Weather/Ions: Difference between revisions

From KDE TechBase
(Fix some units)
(Update to follow the current spec, add mentions about WeatherFormula::Unit, add 'list' request)
Line 1: Line 1:
== Introduction ==
== Introduction ==
This page describes the general naming specification and other information regarding to the Ions. All the data may not be used by the applet(s). If you are going to write an applet or an Ion you should follow this specification to make all parts compatible to eachother.
This page describes the general naming specification and other information regarding to the Ions. All the data may not be used by the applet(s). If you are going to write an applet or an Ion you should follow this specification to make all parts compatible with each other.
 
For providing the weather units use WeatherFormula::Unit so that the applet can easily convert between the units by the user's preference. See plasma/weather/formulas.h for the enum of supported formats, which currently includes the following units:
* Celsius
* Fahrenheit
* Kelvin
* Kilometers
* MetersPerSecond
* Miles
* Kilopascals
* InchesHG
* Millibars
* Hectopascals
* Centimeters
* Millimeters
* Inches
* Knots
* Beaufort
The conversions between related units can be done between them on the applet's side.


== Applet requests ==
== Applet requests ==


The updateIonSource() of the Ion should answer to two requests, ''validate'' and ''weather''.
The updateIonSource(const QString& source) of the Ion should answer to two requests, ''validate'' and ''weather''. In case there is reasonable number of available sources, the ion can provide also ''list'' call.
 
The format of the request is like this: <code>[name of the ion]|[request]|[parameters]</code>


When adding the source in the settings dialog of the applet, it will request validation from the Ion. When the Ion has been added, the applet will request for weather information by issuing ''weather'' request when it wants to get weather data. See the following chapters for information regarding to these requests.
When adding the source in the settings dialog of the applet, it will request validation from the Ion. When the Ion has been added, the applet will request for weather information by issuing ''weather'' request when it wants to get weather data. See the following chapters for information regarding to these requests.
=== Providing a source list ===
Ions with reasonable number of sources may want to provide a list of them directly to the user. This can be used in configure dialogs to provide an easy access for them afterwards.
Request looks always like this:
<code>[name of the ion]|list</code>


=== Answering to validation request ===
=== Answering to validation request ===


''validate'' request has multiple options and it's answers may differ:
<ocde>[name of the ion]|validate|[place name]</code>


When the ''validate|place'' is requested, the engine should validate the give place and set the data depending on what happened:
The answers for ''validate'' request differ depending the results of the query:
* ionname|valid|single|place|[place name] is being set the value of ''validate'' key of the source when there is one matching place for the search.
 
* ionname|valid|multiple|place|[place name]|place|[place name] is being set the value of ''validate'' key of the source when there is multiple choices available. The places are separated with ''''|''''.
When the validation is requested, the engine should validate the given place and set the data depending on what happened:
* ionname|invalid|single|[place] is being set the value of the ''validate'' key of the source when the search gives no matches.
* When only one valid place for the request is found, the ion should provide
<code>[ionname]|valid|single|place|[place name]</code>
set as the value of ''validate'' key of the source.
 
* When multiple possible places are found, the ion should provide
<code>[ionname]|valid|multiple|place|[place name]|place|[place name]</code>
set as the value of ''validate'' key of the source. The places are separated with ''''|place|''''.
 
* When no valid sources are found, the ion should provide
<code>[ionname]|invalid|single|[place]</code>
set as the value of the ''validate'' key of the source.


=== Answering to the weather information request ===
=== Answering to the weather information request ===


When the ''weather'' request is made the Ion should set the appropriate data for the requested source.
When the ''weather'' request is made the Ion should set the appropriate data for the requested source.
The request looks always like this:
<code>[name of the ion]|weather|[place]</code>
and the ion should provide the weather data in format which follows the naming scheme found below.


== Naming scheme ==
== Naming scheme ==
Line 54: Line 95:
! Key !! Value type !! Description
! Key !! Value type !! Description
|-
|-
| Temperature || int || Temperature observed
| Temperature || WeatherFormula::Unit || Temperature observed
|-
|-
| Temperature Unit || C,F || The format of the temperature is in
| Temperature Unit || C,F || The format of the temperature is in
Line 64: Line 105:
! Key !! Value type !! Description
! Key !! Value type !! Description
|-
|-
| Wind Direction || int || Direction of the wind in degrees
| Wind Direction || string || Direction of the wind in degrees or as a cardinal
|-
|-
| Wind Speed || int || Speed of the wind
| Wind Speed || int || Speed of the wind
|-
|-
| Wind Speed Unit || mph,km/h,m/s,bft || The format of the wind speed
| Wind Speed Unit || WeatherFormula::Unit || The format of the wind speed
|-
|-
| Wind Gust || int || Wind gust
| Wind Gust || int || Wind gust
|-
|-
| Wind Gust Unit || mph,km/h,m/s,bft || The format of the wind gust
| Wind Gust Unit || WeatherFormula::Unit || The format of the wind gust
|-
|-
| Windchill || int || Wind chill
| Windchill || int || Wind chill
|-
|-
| Windchill Unit || C,F || The format of the wind chill
| Windchill Unit || WeatherFormula::Unit || The format of the wind chill
|-
|-
| Humidex || int || Humidex
| Humidex || int || Humidex
Line 90: Line 131:
| Dewpoint || int || Dewpoint
| Dewpoint || int || Dewpoint
|-
|-
| Dewpoint Unit || C,F || The format of the dewpoint
| Dewpoint Unit || WeatherFormula::Unit || The format of the dewpoint
|-
|-
| Pressure || int || Air pressure
| Pressure || int || Air pressure
|-
|-
| Pressure Unit || kPa/in, others later || The format of the air pressure
| Pressure Unit || WeatherFormula::Unit || The format of the air pressure
|-
|-
| Pressure Tendency || string || Tendency of the pressure
| Pressure Tendency || string || Tendency of the pressure
Line 100: Line 141:
| Visibility || int || Visibility
| Visibility || int || Visibility
|-
|-
| Visibility Unit || mi/km || Visibility unit
| Visibility Unit || WeatherFormula::Unit || Visibility unit
|}
|}


Line 132: Line 173:
| Record Rainfall || int || The rainfall record for the day
| Record Rainfall || int || The rainfall record for the day
|-
|-
| Record Rainfall Unit || in/mm || The format of rainfall
| Record Rainfall Unit || WeatherFormula::Unit || The format of rainfall
|-
|-
| Record Snowfall || int || The snowfall record for the day
| Record Snowfall || int || The snowfall record for the day
|-
|-
| Record Snowfall Unit || in/cm || The format of the snowfall
| Record Snowfall Unit || WeatherFormula::Unit|| The format of the snowfall
|}
|}


Revision as of 00:37, 1 August 2008

Introduction

This page describes the general naming specification and other information regarding to the Ions. All the data may not be used by the applet(s). If you are going to write an applet or an Ion you should follow this specification to make all parts compatible with each other.

For providing the weather units use WeatherFormula::Unit so that the applet can easily convert between the units by the user's preference. See plasma/weather/formulas.h for the enum of supported formats, which currently includes the following units:

  • Celsius
  • Fahrenheit
  • Kelvin
  • Kilometers
  • MetersPerSecond
  • Miles
  • Kilopascals
  • InchesHG
  • Millibars
  • Hectopascals
  • Centimeters
  • Millimeters
  • Inches
  • Knots
  • Beaufort

The conversions between related units can be done between them on the applet's side.

Applet requests

The updateIonSource(const QString& source) of the Ion should answer to two requests, validate and weather. In case there is reasonable number of available sources, the ion can provide also list call.

The format of the request is like this: [name of the ion]|[request]|[parameters]

When adding the source in the settings dialog of the applet, it will request validation from the Ion. When the Ion has been added, the applet will request for weather information by issuing weather request when it wants to get weather data. See the following chapters for information regarding to these requests.

Providing a source list

Ions with reasonable number of sources may want to provide a list of them directly to the user. This can be used in configure dialogs to provide an easy access for them afterwards.

Request looks always like this: [name of the ion]|list

Answering to validation request

<ocde>[name of the ion]|validate|[place name]

The answers for validate request differ depending the results of the query:

When the validation is requested, the engine should validate the given place and set the data depending on what happened:

  • When only one valid place for the request is found, the ion should provide

[ionname]|valid|single|place|[place name] set as the value of validate key of the source.

  • When multiple possible places are found, the ion should provide

[ionname]|valid|multiple|place|[place name]|place|[place name] set as the value of validate key of the source. The places are separated with '|place|'.

  • When no valid sources are found, the ion should provide

[ionname]|invalid|single|[place] set as the value of the validate key of the source.

Answering to the weather information request

When the weather request is made the Ion should set the appropriate data for the requested source.

The request looks always like this: [name of the ion]|weather|[place] and the ion should provide the weather data in format which follows the naming scheme found below.

Naming scheme

Location data

Key Value type Description
Credit string The credit for the data provider
Country string The country where the weather station is located
Place string City, territory and perhaps other information where the weather station is located
Region string Region where the weather station is located
Station string Name of the station

Observation data

Key Value type Description
Observation Period date How often the weather status is updated
Current Conditions conditions Current weather conditions

Temperature fields

Key Value type Description
Temperature WeatherFormula::Unit Temperature observed
Temperature Unit C,F The format of the temperature is in

Wind data

Key Value type Description
Wind Direction string Direction of the wind in degrees or as a cardinal
Wind Speed int Speed of the wind
Wind Speed Unit WeatherFormula::Unit The format of the wind speed
Wind Gust int Wind gust
Wind Gust Unit WeatherFormula::Unit The format of the wind gust
Windchill int Wind chill
Windchill Unit WeatherFormula::Unit The format of the wind chill
Humidex int Humidex

Air conditions

Key Value type Description
Humidity int Humidity in percents
Dewpoint int Dewpoint
Dewpoint Unit WeatherFormula::Unit The format of the dewpoint
Pressure int Air pressure
Pressure Unit WeatherFormula::Unit The format of the air pressure
Pressure Tendency string Tendency of the pressure
Visibility int Visibility
Visibility Unit WeatherFormula::Unit Visibility unit

Sun/moon related data

Key Value type Description
Sunrise At time When the sun rises
Sunset At time When the sunset happens
Moonrise At time When the moon rises
Moonset At time When the moonset happens
UV Index int Ultraviolet index as integer
UV Rating string Ultraviolet rating in text

Records related data

Key Value type Description
Record High Temperature int The temperature record for the day
Record Low Temperature int The low temperature record for the day
Record Rainfall int The rainfall record for the day
Record Rainfall Unit WeatherFormula::Unit The format of rainfall
Record Snowfall int The snowfall record for the day
Record Snowfall Unit WeatherFormula::Unit The format of the snowfall

Forecast related data

Key Value type Description
Long Forecast Day <something?> ? The forecast for up to eight days
Short Forecast Day <something> ? The forecast for up to five days
Retrieved from "https://techbase.kde.org/index.php?title=Projects/Plasma/Weather/Ions&oldid=31060"