Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/abates/schedule-sensor

Daytime scheduling sensor for Home Assistant
https://github.com/abates/schedule-sensor

home-assistant homeassistant

Last synced: about 7 hours ago
JSON representation

Daytime scheduling sensor for Home Assistant

Awesome Lists containing this project

README 

        
# Schedule Sensor



[![GitHub Release][releases-shield]][releases]

[![GitHub Activity][commits-shield]][commits]

[![License][license-shield]](LICENSE)



[![pre-commit][pre-commit-shield]][pre-commit]

[![Black][black-shield]][black]



[![hacs][hacsbadge]][hacs]

[![Project Maintenance][maintenance-shield]][user_profile]

[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]



[![Discord][discord-shield]][discord]

[![Community Forum][forum-shield]][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](https://cookiecutter-homeassistant-custom-component.readthedocs.io/en/stable/quickstart.html)**



**This component will set up the following platforms.**



| Platform        | Description                         |

| --------------- | ----------------------------------- |

| `binary_sensor` | Show something `True` or `False`.   |

| `sensor`        | Show info from Schedule Sensor API. |

| `switch`        | Switch something `True` or `False`. |



![example][exampleimg]



## 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 `schedule_sensor`.

4. Download _all_ the files from the `custom_components/schedule_sensor/` 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 "Schedule Sensor"



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



```text

custom_components/schedule_sensor/translations/en.json

custom_components/schedule_sensor/translations/fr.json

custom_components/schedule_sensor/translations/nb.json

custom_components/schedule_sensor/translations/sensor.en.json

custom_components/schedule_sensor/translations/sensor.fr.json

custom_components/schedule_sensor/translations/sensor.nb.json

custom_components/schedule_sensor/translations/sensor.nb.json

custom_components/schedule_sensor/__init__.py

custom_components/schedule_sensor/api.py

custom_components/schedule_sensor/binary_sensor.py

custom_components/schedule_sensor/config_flow.py

custom_components/schedule_sensor/const.py

custom_components/schedule_sensor/manifest.json

custom_components/schedule_sensor/sensor.py

custom_components/schedule_sensor/switch.py

```



## Configuration is done in the UI



## Contributions are welcome!



If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)



## Credits



This project was generated from [@oncleben31](https://github.com/oncleben31)'s [Home Assistant Custom Component Cookiecutter](https://github.com/oncleben31/cookiecutter-homeassistant-custom-component) template.



Code template was mainly taken from [@Ludeeus](https://github.com/ludeeus)'s [integration_blueprint][integration_blueprint] template



---



[integration_blueprint]: https://github.com/custom-components/integration_blueprint

[black]: https://github.com/psf/black

[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge

[buymecoffee]: https://www.buymeacoffee.com/abates

[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge

[commits-shield]: https://img.shields.io/github/commit-activity/y/abates/schedule-sensor.svg?style=for-the-badge

[commits]: https://github.com/abates/schedule-sensor/commits/main

[hacs]: https://hacs.xyz

[hacsbadge]: https://img.shields.io/badge/HACS-Custom-orange.svg?style=for-the-badge

[discord]: https://discord.gg/Qa5fW2R

[discord-shield]: https://img.shields.io/discord/330944238910963714.svg?style=for-the-badge

[exampleimg]: example.png

[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg?style=for-the-badge

[forum]: https://community.home-assistant.io/

[license-shield]: https://img.shields.io/github/license/abates/schedule-sensor.svg?style=for-the-badge

[maintenance-shield]: https://img.shields.io/badge/maintainer-%40abates-blue.svg?style=for-the-badge

[pre-commit]: https://github.com/pre-commit/pre-commit

[pre-commit-shield]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?style=for-the-badge

[releases-shield]: https://img.shields.io/github/release/abates/schedule-sensor.svg?style=for-the-badge

[releases]: https://github.com/abates/schedule-sensor/releases

[user_profile]: https://github.com/abates