From fd12de9ebd7a75ca2f31e8b28bd2c5ac10c46e21 Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Wed, 13 Jan 2021 21:22:35 +0100 Subject: Improvements --- docs/configuration.md | 4 +++- docs/customservices.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 docs/customservices.md (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index a43d7f1..6c6a444 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -7,7 +7,7 @@ Title, icons, links, colors, and services can be configured in the `config.yml` # Homepage configuration # See https://fontawesome.com/icons for icons options -# Optional: Use external configuration file. +# Optional: Use external configuration file. # Using this will ignore remaining config in this file # externalConfig: https://example.com/server-luci/config.yaml @@ -118,6 +118,8 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` +View the (Custom Services)[customservices.md] file for details about all available custom services (like PiHole). + If you choose to fetch message information from an endpoint, the output format should be: ```json diff --git a/docs/customservices.md b/docs/customservices.md new file mode 100644 index 0000000..42bd87d --- /dev/null +++ b/docs/customservices.md @@ -0,0 +1,35 @@ +# Tips & Tricks + +Here is an overview of all custom services that are avaiable within Homer. + +## PiHole + +Using the PiHole service you can display info about your local PiHole instance right on your Homer dashboard. + +The following configuration is available for the PiHole service. + +``` + items: + - name: "Pi-hole" + logo: "assets/tools/sample.png" + # subtitle: "Network-wide Ad Blocking" # optional, if no subtitle is defined, PiHole statistics will be shown + url: "http://192.168.0.151/admin" + type: "PiHole" +``` + +## OpenWeatherMap + +Using the OpenWeatherMap service you can display weather information about a given location. + +The following configuration is available for the OpenWeatherMap service + +``` +items: + - name: "Weather" + url: "https://api.openweathermap.org/data/2.5/weather" + location: "Amsterdam" # your location. + apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. + units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. + background: "square" choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. + type: "OpenWeather" +``` -- cgit v1.2.3 From dfb0b14626ccf42784d5e4c270ea0e2253db724c Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Wed, 13 Jan 2021 21:25:07 +0100 Subject: Fixed some typo's. --- docs/configuration.md | 2 +- docs/customservices.md | 16 ++++++++-------- 2 files changed, 9 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index 6c6a444..174da4f 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -118,7 +118,7 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` -View the (Custom Services)[customservices.md] file for details about all available custom services (like PiHole). +View the [Custom Services](customservices.md) file for details about all available custom services (like PiHole). If you choose to fetch message information from an endpoint, the output format should be: diff --git a/docs/customservices.md b/docs/customservices.md index 42bd87d..7c1818e 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -1,4 +1,4 @@ -# Tips & Tricks +# Custom Services Here is an overview of all custom services that are avaiable within Homer. @@ -25,11 +25,11 @@ The following configuration is available for the OpenWeatherMap service ``` items: - - name: "Weather" - url: "https://api.openweathermap.org/data/2.5/weather" - location: "Amsterdam" # your location. - apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. - units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. - background: "square" choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. - type: "OpenWeather" + - name: "Weather" + url: "https://api.openweathermap.org/data/2.5/weather" + location: "Amsterdam" # your location. + apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. + units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. + background: "square" choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. + type: "OpenWeather" ``` -- cgit v1.2.3 From 9e0ef05efe00ffd98ff6c7314a67e8a05505dcc4 Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Wed, 13 Jan 2021 21:27:19 +0100 Subject: Removed URL and made fixed. --- docs/configuration.md | 2 +- docs/customservices.md | 3 +-- 2 files changed, 2 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/configuration.md b/docs/configuration.md index 174da4f..c88069e 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -118,7 +118,7 @@ services: # background: red # optional color for card to set color directly without custom stylesheet ``` -View the [Custom Services](customservices.md) file for details about all available custom services (like PiHole). +View [Custom Services](customservices.md) for details about all available custom services (like PiHole) and how to configure them. If you choose to fetch message information from an endpoint, the output format should be: diff --git a/docs/customservices.md b/docs/customservices.md index 7c1818e..a0b143e 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -1,6 +1,6 @@ # Custom Services -Here is an overview of all custom services that are avaiable within Homer. +Here is an overview of all custom services that are available within Homer. ## PiHole @@ -26,7 +26,6 @@ The following configuration is available for the OpenWeatherMap service ``` items: - name: "Weather" - url: "https://api.openweathermap.org/data/2.5/weather" location: "Amsterdam" # your location. apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. -- cgit v1.2.3 From fb158d4767b85160c0c2c5fea5c6429c265576a9 Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Wed, 13 Jan 2021 22:19:17 +0100 Subject: Error handling and fixed link to city. --- docs/customservices.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index a0b143e..d7c5212 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -29,6 +29,6 @@ items: location: "Amsterdam" # your location. apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. - background: "square" choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. + background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. type: "OpenWeather" ``` -- cgit v1.2.3 From 97f0c43ccc724ec4502e55f73874a89f822f0a81 Mon Sep 17 00:00:00 2001 From: Dick Wolff Date: Thu, 28 Jan 2021 13:02:18 +0100 Subject: Added doc for locationID --- docs/customservices.md | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index d7c5212..40f2e3d 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -27,8 +27,12 @@ The following configuration is available for the OpenWeatherMap service items: - name: "Weather" location: "Amsterdam" # your location. + locationId: "2759794" # OpenWeatherMap city ID. apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. type: "OpenWeather" ``` + +**Remarks:** +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). \ No newline at end of file -- cgit v1.2.3 From cb325bd58adcebeb106ccbfdf18b37fd19c8dcca Mon Sep 17 00:00:00 2001 From: Jeremy Meyers Date: Thu, 26 Aug 2021 21:54:59 -0400 Subject: typo --- docs/customservices.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index 43f45f4..5778fad 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -50,4 +50,4 @@ For Paperless you need an API-Key which you have to store at the item in the fie ## Ping -For Paperless you need an API-Key which you have to store at the item in the field `apikey`. +For Ping you need an API-Key which you have to store at the item in the field `apikey`. -- cgit v1.2.3 From f11b1c9dcff418a2995a1089fa91fd9e44d6fe8b Mon Sep 17 00:00:00 2001 From: Bastien Wirtz Date: Mon, 13 Sep 2021 23:13:26 +0200 Subject: Weather service refactoring --- docs/customservices.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) (limited to 'docs') diff --git a/docs/customservices.md b/docs/customservices.md index 4f64ecc..150e232 100644 --- a/docs/customservices.md +++ b/docs/customservices.md @@ -23,14 +23,13 @@ The following configuration is available for the PiHole service. ## OpenWeatherMap Using the OpenWeatherMap service you can display weather information about a given location. - -The following configuration is available for the OpenWeatherMap service +The following configuration is available for the OpenWeatherMap service: ``` items: - name: "Weather" location: "Amsterdam" # your location. - locationId: "2759794" # OpenWeatherMap city ID. + locationId: "2759794" # Optional: Specify OpenWeatherMap city ID for better accuracy apiKey: "<---insert-api-key-here--->" # insert your own API key here. Request one from https://openweathermap.org/api. units: "metric" # units to display temperature. Can be one of: metric, imperial, kelvin. Defaults to kelvin. background: "square" # choose which type of background you want behind the image. Can be one of: square, cicle, none. Defaults to none. -- cgit v1.2.3