fixes adafruit/io-issues#276 - add public documentation for io services: time, weather and words

This commit is contained in:
Justin Cooper 2021-03-10 10:47:14 -06:00
parent 93ef500e3b
commit 131c56163e
4 changed files with 60 additions and 0 deletions

View file

@ -0,0 +1,32 @@
# Services
Adafruit IO provides access to several connected services. The current services offered are [IFTTT](https://io.adafruit.com/services/ifttt), [Zapier](https://io.adafruit.com/services/zapier), [Weather](https://io.adafruit.com/services/weather), [Randomizer](https://io.adafruit.com/services/words) and [Time](https://io.adafruit.com/services/time).
Each of these services is unique in that you may need to do some setup at the links above prior to utilizing the service via the Adafruit IO HTTP API.
## Time
The Adafruit IO time service does not replace a time-synchronization service like NTP, but it can help you figure out your local time on an Internet of Things device that doesn't have a built in clock.
Detailed documentation on the usage of the time API is found within [Adafruit IO on the time services page](https://io.adafruit.com/services/time).
## Randomizer
Create random data streams that can generate colors, words, numbers, or pick a value from a custom data set and send it directly to your devices.
The four available data types are:
* Pronounceable nonsense words
* Colors (RGB values, HSL values, CSS hex, or CSS color name)
* Numbers
* Preset (sample from a given set of values)
Detailed documentation on the usage and setup of the randomizer API is found within [Adafruit IO on the randomizer services page](https://io.adafruit.com/services/words).
## Weather
With access to weather data powered by Dark Sky, you can get hyper-local forecasts sent directly to your devices. Weather data is updated at most once every 20 minutes.
When you have an IO Plus account, you can track the weather through our HTTP or MQTT APIs for up to 5 locations at a time.
Detailed documentation on the usage and setup of the weather API is found within [Adafruit IO on the weather services page](https://io.adafruit.com/services/weather).

View file

@ -0,0 +1,26 @@
# Weather Topics (IO+)
With access to weather data powered by Dark Sky, you can get hyper-local forecasts sent directly to your devices. Weather data is updated at most once every 20 minutes.
When you have an IO Plus account, you can track the weather through our HTTP or MQTT APIs for up to 5 locations at a time.
Prior to subscribing to the weather topic, you'll need to [generate the topics](https://io.adafruit.com/services/weather) to get the id.
## Subscribe to the Generated Topic
* `{username}/integration/weather/{id}/{type}`
Where :id is the ID of the weather record you want data for and :type is the kind of forecast data you want. Valid types are:
* current
* forecast_minutes_5
* forecast_minutes_30
* forecast_hours_1
* forecast_hours_2
* forecast_hours_6
* forecast_hours_24
* forecast_days_1
* forecast_days_2
* forecast_days_5
MQTT weather subscriptions will publish updated data once per minute to every client that is subscribed to a valid topic.

View file

@ -40,6 +40,7 @@ includes:
- http/permissions.md.erb
- http/users.md.erb
- http/tokens.md.erb
- http/services.md.erb
- errors

View file

@ -33,6 +33,7 @@ includes:
- mqtt/mqtt_group_topics.md.erb
- mqtt/time_topics.md.erb
- mqtt/randomizer_topics.md.erb
- mqtt/weather_topics.md.erb
- mqtt/errors.md.erb
- mqtt/troubleshooting.md.erb