mampfes / hacs_waste_collection_schedule

Home Assistant integration framework for (garbage collection) schedules
MIT License
1.08k stars 658 forks source link

Specify local file path information in docs #553

Closed bcutter closed 1 year ago

bcutter commented 1 year ago

Neither

nor

specify, where the file has to be stored.

  1. Is "calendar.ics" meant to be the share /config/calendar.ics?
  2. What would the file: parameter need to look like when the file is e. g. located in /config/customfolder/calendar.ics ?
dt215git commented 1 year ago

I've always assumed path references are relative to the configuration.yaml as that's where the config info is based and being called from. On the assumption your configuration.yaml file is in the config folder, this should work for the set-up you've described (and isn't too different to how I've referenced .ics files in the past).

waste_collection_schedule:
  sources:
    - name: ics
      args:
        file: "./customfolder/calendar.ics"
bcutter commented 1 year ago

Update: according to https://github.com/mampfes/hacs_waste_collection_schedule/blob/master/doc/installation.md#configuring-waste-collection-schedules the ICS always needs to be in /config/www/.

path then specified as file: "www/calendar.ics" following https://youtu.be/aCKLKGYiA7w?t=365.

Please specify this too. Just too many things which could fail.

mampfes commented 1 year ago

The problem with local files and relative paths is, that it also depends on the Home Assistant installation type (core vs supervised vs OS vs ...). Therefore it is not easy to give a single answer. But it would be nice if you could help, e.g. by creating a PR which describes your environment and solution.

bcutter commented 1 year ago

Running on HA OS I'm using file: "www/abfall/abfuhrkalender_home.ics" now. That information basically originates from the linked YT video (you referenced).

mampfes commented 1 year ago

@bcutter Please check if the docu is correct for your environment.

bcutter commented 1 year ago

Looking good now (except one typo in "Therefore place the ics file their." ==> their --> there).

Thx for updating the docs 👍🏼