Skip to content

intrinseca/journey-custom-component

Repository files navigation

Journey

GitHub Release GitHub Activity License

pre-commit Black

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

TO BE REMOVED: If you need help, as a developer, to use this custom component tempalte, please look at the User Guide in the Cookiecutter documentation

This component will set up the following platforms.

Platform Description
binary_sensor Show something True or False.
sensor Show info from Journey API.
switch Switch something True or False.

example

Installation

  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 journey.
  4. Download all the files from the custom_components/journey/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Restart Home Assistant
  7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "Journey"

Using your HA configuration directory (folder) as a starting point you should now also have this:

custom_components/journey/translations/en.json
custom_components/journey/translations/fr.json
custom_components/journey/translations/nb.json
custom_components/journey/translations/sensor.en.json
custom_components/journey/translations/sensor.fr.json
custom_components/journey/translations/sensor.nb.json
custom_components/journey/translations/sensor.nb.json
custom_components/journey/__init__.py
custom_components/journey/api.py
custom_components/journey/binary_sensor.py
custom_components/journey/config_flow.py
custom_components/journey/const.py
custom_components/journey/manifest.json
custom_components/journey/sensor.py
custom_components/journey/switch.py

Configuration is done in the UI

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