Go to file

Evan Lawrence 991755ee4e - Device switch status now properly reflects status of mining device (there is a delay for the status to update into Home Assistant) - Added property to switches which contains the last response from the API. This will reflect "Success!" or otherwise the error message that was provided by the API. - Added additional properties 'status' and 'device' to switches.		2023-07-03 17:47:11 +02:00
.devcontainer	docs: minor updates	2020-07-11 21:28:48 +00:00
.github	Initial commit	2020-06-14 15:01:07 -04:00
.vscode	Initial commit	2020-06-14 15:01:07 -04:00
custom_components/nicehash	- Device switch status now properly reflects status of mining device (there is a delay for the status to update into Home Assistant)	2023-07-03 17:47:11 +02:00
.gitattributes	Initial commit	2020-06-14 15:01:07 -04:00
.gitignore	chore: update config	2020-06-16 00:27:38 -04:00
CONTRIBUTING.md	docs: minor updates	2020-07-11 21:28:48 +00:00
hacs.json	refactor: replace requests_async w/ httpx	2020-07-12 02:40:39 +00:00
info.md	docs(readme): update installation instructions	2020-07-12 19:21:38 -04:00
LICENSE	chore: update config	2020-06-16 00:27:38 -04:00
README.md	Update README.md	2023-07-03 17:44:45 +02:00
setup.cfg	chore: update config	2020-06-16 00:27:38 -04:00

README.md

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
- Power
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 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

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 called nicehash.
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 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

Restart Home Assistant

Contributions are welcome!

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