2020-06-16 04:19:01 +02:00
|
|
|
# NiceHash Home Assistant Integration
|
2020-06-14 21:01:07 +02:00
|
|
|
|
|
|
|
|
[![GitHub Release][releases-shield]][releases]
|
|
|
|
|
[![GitHub Activity][commits-shield]][commits]
|
|
|
|
|
[![License][license-shield]](LICENSE)
|
|
|
|
|
|
|
|
|
|
[![hacs][hacsbadge]][hacs]
|
|
|
|
|
![Project Maintenance][maintenance-shield]
|
|
|
|
|
[![BuyMeCoffee][buymecoffeebadge]][buymecoffee]
|
|
|
|
|
|
|
|
|
|
[![Discord][discord-shield]][discord]
|
|
|
|
|
[![Community Forum][forum-shield]][forum]
|
|
|
|
|
|
2020-06-16 04:19:01 +02:00
|
|
|
_Component to integrate with [NiceHash][nicehash]_
|
2020-06-14 21:01:07 +02:00
|
|
|
|
|
|
|
|
**This component will set up the following platforms.**
|
|
|
|
|
|
|
|
|
|
Platform | Description
|
|
|
|
|
-- | --
|
|
|
|
|
`binary_sensor` | Show something `True` or `False`.
|
2020-06-16 04:19:01 +02:00
|
|
|
`sensor` | Show info from NiceHash API.
|
2020-06-14 21:01:07 +02:00
|
|
|
`switch` | Switch something `True` or `False`.
|
|
|
|
|
|
|
|
|
|
## 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.
|
2020-06-16 04:19:01 +02:00
|
|
|
3. In the `custom_components` directory (folder) create a new folder called `nicehash`.
|
|
|
|
|
4. Download _all_ the files from the `custom_components/nicehash/` directory (folder) in this repository.
|
2020-06-14 21:01:07 +02:00
|
|
|
5. Place the files you downloaded in the new directory (folder) you created.
|
|
|
|
|
6. Restart Home Assistant
|
2020-06-16 04:19:01 +02:00
|
|
|
7. In the HA UI go to "Configuration" -> "Integrations" click "+" and search for "NiceHash"
|
2020-06-14 21:01:07 +02:00
|
|
|
|
|
|
|
|
Using your HA configuration directory (folder) as a starting point you should now also have this:
|
|
|
|
|
|
|
|
|
|
```text
|
2020-06-16 04:19:01 +02:00
|
|
|
custom_components/nicehash/.translations/en.json
|
|
|
|
|
custom_components/nicehash/.translations/nb.json
|
|
|
|
|
custom_components/nicehash/.translations/sensor.nb.json
|
|
|
|
|
custom_components/nicehash/__init__.py
|
|
|
|
|
custom_components/nicehash/binary_sensor.py
|
|
|
|
|
custom_components/nicehash/config_flow.py
|
|
|
|
|
custom_components/nicehash/const.py
|
|
|
|
|
custom_components/nicehash/manifest.json
|
|
|
|
|
custom_components/nicehash/sensor.py
|
|
|
|
|
custom_components/nicehash/switch.py
|
2020-06-14 21:01:07 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Configuration is done in the UI
|
|
|
|
|
|
|
|
|
|
<!---->
|
|
|
|
|
|
|
|
|
|
## Contributions are welcome!
|
|
|
|
|
|
|
|
|
|
If you want to contribute to this please read the [Contribution guidelines](CONTRIBUTING.md)
|
|
|
|
|
|
|
|
|
|
|
2020-06-16 04:19:01 +02:00
|
|
|
[nicehash]: https://nicehash.com
|
|
|
|
|
[buymecoffee]: https://www.buymeacoffee.com/brianberg
|
2020-06-14 21:01:07 +02:00
|
|
|
[buymecoffeebadge]: https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg?style=for-the-badge
|
2020-06-16 04:19:01 +02:00
|
|
|
[commits-shield]: https://img.shields.io/github/commit-activity/y/custom-components/nicehash.svg?style=for-the-badge
|
|
|
|
|
[commits]: https://github.com/custom-components/nicehash/commits/master
|
2020-06-14 21:01:07 +02:00
|
|
|
[hacs]: https://github.com/custom-components/hacs
|
|
|
|
|
[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/
|
2020-06-16 04:19:01 +02:00
|
|
|
[license-shield]: https://img.shields.io/github/license/custom-components/nicehash.svg?style=for-the-badge
|
|
|
|
|
[maintenance-shield]: https://img.shields.io/badge/maintainer-Brian%20Berg%20%40brianberg-blue.svg?style=for-the-badge
|
|
|
|
|
[releases-shield]: https://img.shields.io/github/release/custom-components/nicehash.svg?style=for-the-badge
|
|
|
|
|
[releases]: https://github.com/custom-components/nicehash/releases
|
|
|
|
|
|
