Skip to content

Commit

Permalink
fix images in hacs docu
Browse files Browse the repository at this point in the history
  • Loading branch information
mampfes committed Feb 28, 2021
1 parent ba43328 commit 1e7ab43
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 42 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,27 +19,27 @@ A complete example can be found [here](./doc/configuration.yaml).

Per default (without further configuration), the time to the next collection will be shown in an [entity card](https://www.home-assistant.io/lovelace/entity/):

<img src="./doc/default-entity.png">
![Default Lovelace Card](./doc/default-entity.png)

You can also setup dedicated entities per waste type and show the schedule in various formats:

<img src="./doc/days-to-next-collections.png">
<img src="./doc/date-of-next-collections.png">
<img src="./doc/next-collections-date-and-days.png">
![Days to next collections](./doc/days-to-next-collections.png)
![Date of next collections](./doc/date-of-next-collections.png)
![Date and days to next collections](./doc/next-collections-date-and-days.png)

The information in the more-info popup can be displayed in different formats:

1. List of upcoming collections:

<img src="./doc/more-info-upcoming.png">
![More info: upcoming](./doc/more-info-upcoming.png)

2. List of waste types and collection date:

<img src="./doc/more-info-appointment-types.png">
![Moe info: waste types](./doc/more-info-appointment-types.png)

[Button Card](https://github.com/custom-cards/button-card) can be used to create individual Lovelace cards:

![Button Card](./doc/button-cards.png "Button Card")
![Button Card](./doc/button-cards.png)

## Supported Service Providers

Expand Down Expand Up @@ -246,15 +246,15 @@ Possible choices:

- ```upcoming``` shows a list of upcoming collections.

![Upcoming](./doc/more-info-upcoming.png "Upcoming")
![Upcoming](./doc/more-info-upcoming.png)

- ```appointment_types``` shows a list of waste types and their next collection date.

![Waste Types](./doc/more-info-appointment-types.png "Waste Types")
![Waste Types](/doc/more-info-appointment-types.png)

- ```generic``` provides all attributes as generic Python data types. This can be used by a specialized Lovelace card (which doesn't exist so far).<br>

![Generic](./doc/more-info-generic.png "Generic")
![Generic](./doc/more-info-generic.png)

**count**

Expand Down Expand Up @@ -428,7 +428,7 @@ waste_collection_schedule:

You can use [Button Card](https://github.com/custom-cards/button-card) to create a colored Lovelace cards:

![Button Card](./doc/button-cards.png "Button Card")
![Button Card](./doc/button-cards.png)

```yaml
# configuration.yaml
Expand Down
2 changes: 1 addition & 1 deletion custom_components/waste_collection_schedule/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,5 +5,5 @@
"requirements": ["icalendar", "recurring_ical_events"],
"dependencies": [],
"codeowners": ["@mampfes"],
"version": "1.0.1"
"version": "1.0.2"
}
3 changes: 1 addition & 2 deletions hacs.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"name": "Waste Collection Schedule",
"domains": ["sensor"],
"iot_class": "cloud_polling",
"render_readme": true
"iot_class": "cloud_polling"
}
62 changes: 34 additions & 28 deletions info.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,56 @@
**Waste Collection Schedule** is a framework to easily integrate appointment schedule services, e.g. waste collection services into Home Assistant. The entity state and details can be easily customized using templates. New sources can be added very easily.
# Waste Collection Schedule

## Showroom
Waste Collection Schedule provides schedules from waste collection service providers to Home Assistant. Additionally, it supports schedules from generic ICS files which can be stored locally or fetched from a web site. There is a high flexibility in providing the information to be displayed.

Entity state is highly customizable using templates:
## Examples

<img src="https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/value_template.png">
Per default (without further configuration), the time to the next collection will be shown in an [entity card](https://www.home-assistant.io/lovelace/entity/):

Details view showing the list of upcoming events:
![Default Lovelace Card](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/default-entity.png)

<img src="https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/upcoming_details.png">
You can also setup dedicated entities per waste type and show the schedule in various formats:

Date format is also customizable using templates:
![Days to next collections](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/days-to-next-collections.png)
![Date of next collections](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/date-of-next-collections.png)
![Date and days to next collections](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/next-collections-date-and-days.png)

<img src="https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/date_template_details.png">
The information in the more-info popup can be displayed in different formats:

Alternative details view showing the list of appointment types and their next event:
1. List of upcoming collections:

<img src="https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/appointment_types_details.png">
![More info: upcoming](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/more-info-upcoming.png)

[Button Cards](https://github.com/custom-cards/button-card) can be used to create individual widgets:
2. List of waste types and collection date:

![Moe info: waste types](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/more-info-appointment-types.png)

[Button Card](https://github.com/custom-cards/button-card) can be used to create individual Lovelace cards:

![Button Card](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/button-cards.png)

## Documentation

## Useful Links
- [Full Documentation](https://github.com/mampfes/hacs_waste_collection_schedule)
- [Buy Me A Coffee](https://buymeacoffee.com/mampfes)

## Supported Service Providers

Currently the following service providers are supported:

### Germany

- [Abfall.IO / AbfallPlus.de](./doc/source/abfall_io.md)
- [Abfall_Kreis_Tuebingen.de](./doc/source/abfall_kreis_tuebingen_de.md)
- [AbfallNavi.de (RegioIT.de)](./doc/source/abfallnavi_de.md)
- [Abfallwirtschaft Stuttgart](./doc/source/stuttgart_de.md)
- [AWBKoeln.de](./doc/source/awbkoeln_de.md)
- [BSR.de / Berliner Stadtreinigungsbetriebe](./doc/source/bsr_de.md)
- [Generic ICS / iCal File](./doc/source/ics.md)
- [Jumomind.de](./doc/source/jumomind_de.md)
- [Muellmax.de](./doc/source/muellmax_de.md)
- [Stadtreinigung.Hamburg](./doc/source/stadtreinigung_hamburg.md)
- [Abfallwirtschaft Zollernalbkreis](./doc/source/abfall_zollernalbkreis_de.md)
- [Abfall.IO / AbfallPlus.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/abfall_io.md)
- [Abfall_Kreis_Tuebingen.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/abfall_kreis_tuebingen_de.md)
- [AbfallNavi.de (RegioIT.de)](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/abfallnavi_de.md)
- [Abfallwirtschaft Stuttgart](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/stuttgart_de.md)
- [AWBKoeln.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/awbkoeln_de.md)
- [BSR.de / Berliner Stadtreinigungsbetriebe](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/bsr_de.md)
- [Generic ICS / iCal File](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/ics.md)
- [Jumomind.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/jumomind_de.md)
- [Muellmax.de](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/muellmax_de.md)
- [Stadtreinigung.Hamburg](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/stadtreinigung_hamburg.md)
- [Abfallwirtschaft Zollernalbkreis](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/abfall_zollernalbkreis_de.md)

### United States of America

- [PGH.ST](./doc/source/pgh_st.md)
- [Seattle Public Utilities](./doc/source/seattle_gov.md)


- [PGH.ST](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/pgh_st.md)
- [Seattle Public Utilities](https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/source/seattle_gov.md)

0 comments on commit 1e7ab43

Please sign in to comment.