search

soloam / ha-fireflyiii-integration

FireflyIII Integration for Home Assistant
MIT License
22 stars 1 forks source link
finance firefly-iii hacs homeassistant integration python

readme

FireflyIII Integration

Component to integrate with FireflyIII.

This is a custom component developed by me to integrate FireflyIII with Home Assistant, this project is independent from the great work done by James Cole in FireflyIII

gh_release hacs_badge gh_last_commit buy_coffee_badge

This component will set up the following platforms.

Platform Description
sensor Show info from an FireflyIII API.
calendar Calendar for bills
binary_sensor Server status

Installation via HACS (recommended)

Open your Home Assistant instance and open a repository inside the Home Assistant Community Store.

  1. Follow the link here
  2. Use the custom repo link https://github.com/soloam/ha-fireflyiii-integration
  3. Select the category type integration
  4. Then once it's there (still in HACS) click the INSTALL button
  5. Restart Home Assistant
  6. Once restarted, in the HA UI go to Configuration (the ⚙️ in the lower left) -> Devices and Services click + Add Integration and search for fireflyiii

Manual (non-HACS)

Instructions
You probably do not want to do this! Use the HACS method above unless you know what you are doing and have a good reason as to why you are installing manually
1. Using the tool of choice open the directory (folder) for your HA configuration (where you find `configuration.yaml`). 2. If you do not have a `custom_components` directory (folder) there, you need to create it. 3. In the `custom_components` directory (folder) create a new folder called `fireflyiii_integration`. 4. Download _all_ the files from the `custom_components/fireflyiii_integration/` directory (folder) in this repository. 5. Place the files you downloaded in the new directory (folder) you created. 6. Restart Home Assistant 7. Once restarted, in the HA UI go to `Configuration` (the ⚙️ in the lower left) -> `Devices and Services` click `+ Add Integration` and search for `fireflyiii`

Configuration is done in the UI

Planned Improvements

Feedbacks and feature requests are welcome.

References

I just love coffee and beer

buy_coffee