Skip to content

Latest commit

 

History

History
113 lines (92 loc) · 4.47 KB

README.md

File metadata and controls

113 lines (92 loc) · 4.47 KB
Raw

NiceHash Home Assistant Integration

GitHub Release License

hacs Project Maintenance BuyMeCoffee

Discord Community Forum

A Home Assistant integration that creates a collection of NiceHash account balance, rig, and individual device sensors.

Preview

Available Sensors

  • Account Balances (BTC and USD/EUR)
    • Total
    • Pending
    • Available
  • Rigs
    • Status
    • Temperature
    • Profitability
  • Devices
    • Status
    • Algorithm
    • Speed
    • Temperature
    • Load
    • RPM
  • Most Recent Mining Payout

None of the sensors are added by default. See installation instructions for available configuration options.

Installation

Prerequisites

These instructions assume you have a NiceHash account and an API key.

Supported API permissions and associated sensors

  • Wallet Permissions > View balances...
    • Account balance sensors
  • Mining Permissions > View mining data...
    • Rig, device, and payout sensors

See this repository for further assistance generating an API key.

HACS (recommended)

  1. Open HACS > Integrations
  2. Add https://github.com/brianberg/ha-nicehash as a custom repository as Category: Integration
  3. Click install under "NiceHash" in the Integrations tab
  4. 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)
  balances: true # (default = false) - Enable balance sensors
  rigs: true # (default = false) - Enable rig sensors
  devices: true # (default = false) - Enable device sensors
  payouts: true # (default = false) - Enable payout sensors
  5. Restart Home Assistant

Manual

  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. 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)
  balances: true # (default = false) - Enable balance sensors
  rigs: true # (default = false) - Enable rig sensors
  devices: true # (default = false) - Enable device sensors
  payouts: true # (default = false) - Enable payout sensors
  7. Restart Home Assistant

Contributions are welcome!

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