Skip to content

This custom component integrates Greyhound Bin App API with [Home Assistant][ha], it will add a new local calendar allowing you to monitor your Bin collections for the next 30 days. There are a few extra sensors, e.g. - next collection date, next collection bin type.

License

Notifications You must be signed in to change notification settings

JosyBan/greyhound_bin

Repository files navigation

greyhound_bin

GitHub Release GitHub Activity License

pre-commit Black

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

This custom component integrates Greyhound Bin App API with [Home Assistant][ha], it will add a new local calendar allowing you to monitor your Bin collections for the next 30 days. There are a few extra sensors, e.g. - next collection date, next collection bin type.

This component will set up the following platforms.

Platform Description
sensor Displays information from the greyhound_bin API.
calendar Shows upcoming bin collection events.

example

HACS Installation

This is the recommended way to install.

  1. Open HACS in your Home Assistant UI
  2. Click on the three dots in the top right corner and select Custom repositories.
  3. In the "Add custom repository" field, paste https://github.com/JosyBan/greyhound_bin.
  4. Select Integration as the Category.
  5. Click ADD
  6. Once added, search for "ventaxia" in the HACS Integrations section.
  7. Click on the "ventaxia" integration.
  8. Click Download and confirm.
  9. Restart Home Assistant.
  10. In the HA UI, click Settings in the left nav bar, then click "Devices & Services". By default you should be viewing the Integrations tab. Click "+ Add Integration" button at bottom right and then search for "ventaxia".

Manual Installation

  1. Download the integration: Download the latest release from the Release Page.
  2. Unpack the ventaxia_ha folder from the downloaded archive.
  3. Copy the entire ventaxia_ha folder into your Home Assistant's custom_components directory. If this directory doesn't exist, you'll need to create it.
  4. Your Home Assistant configuration directory typically resides at /config (e.g., /config/custom_components/ventaxia_ha/).
  5. Restart Home Assistant.
  6. In the HA UI, click Settings in the left nav bar, then click "Devices & Services". By default you should be viewing the Integrations tab. Click "+ Add Integration" button at bottom right and then search for "ventaxia".

Configuration

After installation and restarting Home Assistant, you can configure the Greyhound Bin integration via the Home Assistant UI.

Go to Settings > Devices & Services.

Click on ADD INTEGRATION.

Search for "Greyhound Bin" and select it.

Follow the on-screen prompts to enter your Greyhound Bin account details

Once successfully configured, the integration will automatically create the calendar and relevant sensor entities. You can find the full list of available entities under Settings > Devices & Services > Greyhound Bin integration once it's set up.

Contributions are welcome!

If you want to contribute to this please read the Contribution guidelines

Credits

This project was generated from @oncleben31's Home Assistant Custom Component Cookiecutter template.

Code template was mainly taken from @Ludeeus's integration_blueprint template


About

This custom component integrates Greyhound Bin App API with [Home Assistant][ha], it will add a new local calendar allowing you to monitor your Bin collections for the next 30 days. There are a few extra sensors, e.g. - next collection date, next collection bin type.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages