.devcontainer | ||
.github | ||
.vscode | ||
custom_components/nicehash | ||
.gitattributes | ||
.gitignore | ||
CONTRIBUTING.md | ||
hacs.json | ||
info.md | ||
LICENSE | ||
README.md | ||
setup.cfg |
NiceHash Home Assistant Integration
A Home Assistant integration that creates a collection of NiceHash account balance, rig, and individual device sensors.
Available Sensors
- Account Balances (BTC and USD/EUR)
- Total
- Pending
- Available
- Rigs
- Status
- Temperature
- Profitability
- Devices
- Status
- Algorithm
- Speed
- Temperature
- HotSpot 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)
- Open HACS > Integrations
- Add https://github.com/brianberg/ha-nicehash as a custom repository as Category: Integration
- Click install under "NiceHash" in the Integrations tab
- Add
nicehash
toconfiguration.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
- Restart Home Assistant
Manual
- Using the tool of choice open the directory (folder) for your HA configuration (where you find
configuration.yaml
). - If you do not have a
custom_components
directory (folder) there, you need to create it. - In the
custom_components
directory (folder) create a new folder callednicehash
. - Download all the files from the
custom_components/nicehash/
directory (folder) in this repository. - Place the files you downloaded in the new directory (folder) you created.
- Add
nicehash
toconfiguration.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
- Restart Home Assistant
Contributions are welcome!
If you want to contribute to this please read the Contribution guidelines