will/InfiniTime
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
ef2c431569
InfiniTime/doc/SimpleWeatherService.md

68 lines
2.2 KiB
Markdown
Raw Normal View History

SimpleWeather service : new weather implementation This new implementation of the weather feature provides a new BLE API and a new weather service. The API uses a single characteristic that allows companion apps to write the weather conditions (current and forecast for the next 5 days). The SimpleWeather service exposes those data as std::optional fields. This new implementation replaces the previous WeahterService. The API is documented in docs/SimpleWeatherService.md.
2023-12-09 19:39:08 +00:00
# Simple Weather Service
## Introduction
The Simple Weather Service provide a simple and straightforward API to specify the current weather and the forecast for the next 5 days. It effectively replaces the original Weather Service (from InfiniTime 1.8) since InfiniTime 1.14
## Service
The service UUID is `00050000-78fc-48fe-8e23-433b3a1942d0`.
## Characteristics
## Weather data (UUID 00050001-78fc-48fe-8e23-433b3a1942d0)
The host uses this characteristic to update the current weather information and the forecast for the next 5 days.
This characteristics accepts a byte array with the following 2-Bytes header:
- [0] Message Type :
- `0` : Current weather
- `1` : Forecast
- [1] Message Version : Version `0` is currently supported. Other versions might be added in future releases
### Current Weather
The byte array must contain the following data:
- [0] : Message type = `0`
- [1] : Message version = `0`
- [2][3][4][5][6][7][8][9] : Timestamp (64 bits UNIX timestamp, number of nanoseconds elapsed since 1 JAN 1970)
- [10] : Current temperature (°C)
- [11] : Minimum temperature (°C)
- [12] : Maximum temperature (°C)
- [13]..[44] : location (string, unused characters should be set to `0`)
- [45] : icon ID
- 0 = Sun, clear sky
- 1 = Few clouds
- 2 = Clouds
- 3 = Heavy clouds
- 4 = Clouds & rain
- 5 = Rain
- 6 = Thunderstorm
Simple Weather Service - code cleaning and improvements Add missing icons (heavy clouds, thunderstorm, snow). Remove unneeded comparison operator (!=), improve conversion of Timestamp and MessageType, order includes. Fix typo in documentation. Remove not related change in StopWatch.
2023-12-18 17:07:36 +00:00
- 7 = Snow
- 8 = Mist, smog
SimpleWeather service : new weather implementation This new implementation of the weather feature provides a new BLE API and a new weather service. The API uses a single characteristic that allows companion apps to write the weather conditions (current and forecast for the next 5 days). The SimpleWeather service exposes those data as std::optional fields. This new implementation replaces the previous WeahterService. The API is documented in docs/SimpleWeatherService.md.
2023-12-09 19:39:08 +00:00
### Forecast
The byte array must contain the following data:
- [0] : Message type = `0`
- [0] : Message version = `0`
- [2][3][4][5][6][7][8][9] : Timestamp (64 bits UNIX timestamp, number of nanoseconds elapsed since 1 JAN 1970)
- [10] Number of days (Max 5, fields for unused days should be set to `0`)
- [11] Day 0 Minimum temperature
- [12] Day 0 Maximum temperature
- [13] Day 0 Icon ID
- [14] Day 1 Minimum temperature
- [15] Day 1 Maximum temperature
- [16] Day 1 Icon ID
- [17] Day 2 Minimum temperature
- [18] Day 2 Maximum temperature
- [19] Day 2 Icon ID
- [20] Day 3 Minimum temperature
- [21] Day 3 Maximum temperature
- [22] Day 3 Icon ID
- [23] Day 4 Minimum temperature
- [24] Day 4 Maximum temperature
Simple Weather Service - code cleaning and improvements Add missing icons (heavy clouds, thunderstorm, snow). Remove unneeded comparison operator (!=), improve conversion of Timestamp and MessageType, order includes. Fix typo in documentation. Remove not related change in StopWatch.
2023-12-18 17:07:36 +00:00
- [25] Day 4 Icon ID
Reference in New Issue Copy Permalink