diff options
Diffstat (limited to 'docs/customservices.md')
-rw-r--r-- | docs/customservices.md | 22 |
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/customservices.md b/docs/customservices.md index 5778fad..4f64ecc 100644 --- a/docs/customservices.md +++ b/docs/customservices.md | |||
@@ -19,6 +19,28 @@ The following configuration is available for the PiHole service. | |||
19 | type: "PiHole" | 19 | type: "PiHole" |
20 | ``` | 20 | ``` |
21 | 21 | ||
22 | |||
23 | ## OpenWeatherMap | ||
24 | |||
25 | Using the OpenWeatherMap service you can display weather information about a given location. | ||
26 | |||
27 | The following configuration is available for the OpenWeatherMap service | ||
28 | |||
29 | ``` | ||
30 | items: | ||
31 | - name: "Weather" | ||
32 | location: "Amsterdam" # your location. | ||
33 | locationId: "2759794" # OpenWeatherMap city ID. | ||
34 | apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. | ||
35 | units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. | ||
36 | background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. | ||
37 | type: "OpenWeather" | ||
38 | ``` | ||
39 | |||
40 | **Remarks:** | ||
41 | If for some reason your city can't be found by entering the name in the `location` property, you could also try to configure the OWM city ID in the `locationId` property. To retrieve your specific City ID, go to the [OWM website](https://openweathermap.org), search for your city and retrieve the ID from the URL (for example, the City ID of Amsterdam is 2759794). | ||
42 | |||
43 | |||
22 | ## Medusa | 44 | ## Medusa |
23 | 45 | ||
24 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. | 46 | This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. |