aboutsummaryrefslogtreecommitdiffhomepage
path: root/docs/customservices.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/customservices.md')
-rw-r--r--docs/customservices.md23
1 files changed, 22 insertions, 1 deletions
diff --git a/docs/customservices.md b/docs/customservices.md
index 43f45f4..150e232 100644
--- a/docs/customservices.md
+++ b/docs/customservices.md
@@ -19,6 +19,27 @@ The following configuration is available for the PiHole service.
19 type: "PiHole" 19 type: "PiHole"
20``` 20```
21 21
22
23## OpenWeatherMap
24
25Using the OpenWeatherMap service you can display weather information about a given location.
26The following configuration is available for the OpenWeatherMap service:
27
28```
29items:
30 - name: "Weather"
31 location: "Amsterdam" # your location.
32 locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy
33 apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api.
34 units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin.
35 background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none.
36 type: "OpenWeather"
37```
38
39**Remarks:**
40If 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).
41
42
22## Medusa 43## Medusa
23 44
24This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application. 45This service displays News (grey), Warning (orange) or Error (red) notifications bubbles from the Medusa application.
@@ -50,4 +71,4 @@ For Paperless you need an API-Key which you have to store at the item in the fie
50 71
51## Ping 72## Ping
52 73
53For Paperless you need an API-Key which you have to store at the item in the field `apikey`. 74For Ping you need an API-Key which you have to store at the item in the field `apikey`.