/ha-nhqm-octune

NiceHash QuickMiner OCTune Integration for Home Assistant

Primary LanguagePythonMIT LicenseMIT

NiceHash QuickMiner OCTune Integration for Home Assistant

GitHub Release GitHub Activity License Project Maintenance BuyMeCoffee

This component only works if the miner and Home Assistant are on the same network.

This integration is a simple method to receive data from your GPUs in your mining rigs without using the NiceHash servers. I'm using the Excavator api (https://github.com/nicehash/excavator/tree/master/api) to communicate with the miner.

Features

  • Support for multiple mining rigs
  • Sensors for each GPU
    • Hashrate
    • GPU temperature
    • Hotspot temperature
    • VRAM temperature
    • Fan speed in percent
    • Fan speed in RPM
    • Power usage
    • Overheating
  • Sensors for the mining rig
    • Hashrate (sum of all GPUs inside the rig)
  • Global sensors (all rigs together)
    • Hashrate (sum of all GPUs)

Request a new feature here.

Installation

1. Prepare OCTune

In order to be able to establish a connection between OCTune and Home Assistant, it must first be ensured that OCTune can be reached by other devices.

  1. Open your Nice Hash Quick Miner config file.

    You can open the file via the Windows GUI as shown in the image below or directly via the file path: C:\NiceHash\NiceHash QuickMiner\nhqm.conf

    openconfigfile

  2. Change OCTune API host

    You have to find the parameter watchDogAPIHost and change it from localhost to 0.0.0.0.

  3. Restart

    Now you need to restart NH QuickMiner for the changes to take effect. not just restart the Excavator

2. Enable this Integration in HACS

  1. Open the HACS page in your Home Assistant
  2. Go to the Integrations tab
  3. Click on the 3 points in the top right corner and click on Custom repositories
  4. In the Repository field, type https://github.com/pascalberski/ha-nhqm-octune and select Integration for Category. Click on ADD.
  5. Now you can browse through the HACS integrations and can install this integration.

3. Configuration

  1. Open your Home Assistant config file configuration.yaml.
  2. Insert this example and modify it. 
    octune:
  refreshinterval: 60
  miners:
    - host: 192.168.178.10
      port: 18000
      name: Miner1
      auth: 6A5FDC7B932864GHNK993EEF
    - host: 192.168.178.11
      port: 18000
      name: Miner2
      auth: 034C534SDG2F1D1477E50A01
  3. Restart Home Assistant and you are to go.

ToDo

View my current ToDos

Report a bug or request a feature?

Please let me know in the Issues tab