ha-nicehash/README.md
2020-07-09 02:24:21 +00:00

3.4 KiB

NiceHash Home Assistant Integration

GitHub Release License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

Component to integrate with NiceHash

This component will set up the following platforms.

Platform Description
sensor Show info from NiceHash API

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 nicehash.
  4. Download all the files from the custom_components/nicehash/ directory (folder) in this repository.
  5. Place the files you downloaded in the new directory (folder) you created.
  6. Generate NiceHash API key
    • Supported API Permissions
      • Wallet Permissions > View balances...
      • Mining Permissions > View mining data...
    • See this repository for assistance
  7. Add nicehash to configuration.yaml
    nicehash:
      organization_id: <org_id>
      api_key: <api_key_code>
      api_secret: <api_secret_key_code>
      currency: EUR (default = USD)
      rigs: true (default = false) - Enable rig sensors
      devices: true (default = false) - Enable device sensors
    
  8. Restart Home Assistant

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

custom_components/nicehash/translations/en.json
custom_components/nicehash/__init__.py
custom_components/nicehash/const.py
custom_components/nicehash/data_coordinators.py
custom_components/nicehash/manifest.json
custom_components/nicehash/sensor.py
custom_components/nicehash/sensors.py

Contributions are welcome!

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