diff --git a/README.md b/README.md index 2e5039b..e26969b 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,14 @@ [![License][license-shield]](LICENSE) -![Project Maintenance][maintenance-shield] -[![BuyMeCoffee][buymecoffeebadge]][buymecoffee] -# home-assistant-dewpoint -Home Assistant custom component to calculate dew point using temperature and humidity sensors. -Calculated using [psychrolib](https://github.com/psychrometrics/psychrolib). +# Dew Point Calculator for Home Assistant +[Home Assistant](https://www.home-assistant.io/) custom component to calculate dew point using temperature and humidity sensors based on [PsychroLib](https://github.com/psychrometrics/psychrolib). +This repository was [forked](https://github.com/miguelangel-nubla/home-assistant-dewpoint) due to inactivity of the original creator and maintaner. ## Installation - -Use [hacs](https://custom-components.github.io/hacs/) with this repo URL https://github.com/miguelangel-nubla/home-assistant-dewpoint or copy `custom_components/` to your HA configuration. +Use [HACS](https://hacs.xyz/) with this custom repository or copy `custom_components/` to your HA configuration. ## Example configuration.yaml - ```yaml sensor: - platform: dewpoint @@ -27,24 +23,18 @@ sensor: ``` ## Configuration options - Key | Type | Required | Description -- | -- | -- | -- -`sensors` | `list` | `True` | List of dewpoint sensors to generate. +`sensors` | `list` | `True` | List of dew point sensors to generate ### Configuration options for `sensors` list Key | Type | Required | Default | Description -- | -- | -- | -- | -- -`friendly_name` | `string` | `False` | `sensor name` | Custom name for the new sensor entity. -`temperature` | `entity_id` | `True` | `none` | Entity ID to read temperature from. (dry-bulb) -`rel_hum` | `entity_id` | `True` | `none` | Entity ID to read relative humidity from. - +`friendly_name` | `string` | `False` | `sensor name` | Friendly name for the new sensor entity +`temperature` | `entity_id` | `True` | `none` | Entity from which to get the dry-bulb temperature +`rel_hum` | `entity_id` | `True` | `none` | Entity from which to get the relative humidity *** -[dewpoint]: https://github.com/custom-components/dewpoint -[buymecoffee]: https://www.buymeacoffee.com/miguelangelnubl -[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge -[license-shield]: https://img.shields.io/github/license/miguelangel-nubla/home-assistant-dewpoint.svg?style=for-the-badge -[maintenance-shield]: https://img.shields.io/badge/maintainer-Miguel%20Angel%20Nubla%20Ruiz-blue.svg?style=for-the-badge \ No newline at end of file +[license-shield]: https://img.shields.io/github/license/ehn/home-assistant-dewpoint.svg?style=for-the-badge diff --git a/custom_components/dewpoint/manifest.json b/custom_components/dewpoint/manifest.json index eeb2d87..5102330 100644 --- a/custom_components/dewpoint/manifest.json +++ b/custom_components/dewpoint/manifest.json @@ -1,9 +1,9 @@ { "domain": "dewpoint", - "name": "DewPoint Sensor Calculator", - "documentation": "https://github.com/miguelangel-nubla/home-assistant-dewpoint", - "dependencies": [], - "codeowners": ["@miguelangel-nubla"], + "name": "Dew Point Calculator", + "documentation": "https://github.com/ehn/home-assistant-dewpoint", + "issue_tracker": "https://github.com/ehn/home-assistant-dewpoint/issues", + "codeowners": ["@miguelangel-nubla", "@lultimouomo", "@ehn"], "requirements": ["psychrolib==2.1.0"], - "version": "0.0.0" + "version": "0.0.1" } diff --git a/custom_components/dewpoint/sensor.py b/custom_components/dewpoint/sensor.py index 38cf7ad..b5b6b4c 100644 --- a/custom_components/dewpoint/sensor.py +++ b/custom_components/dewpoint/sensor.py @@ -2,7 +2,7 @@ Calculate Dew Point based on temperature and humidity sensors For more details about this platform, please refer to the documentation -https://github.com/miguelangel-nubla/home-assistant-dewpoint +https://github.com/ehn/home-assistant-dewpoint """ import logging