ha-nicehash-excavator-monitor's Introduction

Nicehash Excavator Monitor

Home Assistant integration for Nicehash Excavator miner API

(Excavator API Doku: https://github.com/nicehash/excavator/tree/master/api)

Available Sensors:

Combined hashrate for every individual mined algorithm
Hashrate for every card for all mined algorithms on that card
GPU temp for every card
Hotspot temp for every card
Vram temp for every card
CPU & RAM usage
Overtemp (true/false) for every card
Device information will show the Excavator version and build as well as a list of the installed GPU models

Available Switches:

Switch for two diferent update speeds

Requirements:

Home Assistant core-2021.12.5 or higher
Excavator needs to be reachable from the network
Your mining pc needs to be reachable from your Home Assistant instance

Install:

This integration is available in HACS (Home Assistant Community Store). HACS is a third party community store and is not included in Home Assistant out of the box
After downloading the integration you can add it to Home Assistant under Configuration -> Devices & Services
Miner name is the name of your mining rig
Host address is your_mining_pc_ip_v4
Excavator port is the unused_port_of_your_choise
The update intervals are between 1 and 3600 seconds (can be changed later in device configuration)
Confirm the dialog and your mining rig will be added shortly after testing the connection

Make Excavator available from the network:

If you are using the Nicehash Quick Miner:
- Right-click the icon in the icon tray -> Settings -> Edit config file
- Search "watchDogAPIHost" and set the value to "your_mining_pc_ip_v4"
- Search "watchDogAPIPort" and remember the value (default is 18000) or change to another unused_port_of_your_choise
- Save and close the config file
- Create an inbound firewall rule allowing the previusly used port (watchDogAPIPort) to be accessed
- You should now be able to access the Excavator API via your network
If you are running Excavator directly from the command line:
- Add the command line arguments -wi your_mining_pc_ip_v4 and -wp unused_port_of_your_choise
  - Doku: https://github.com/nicehash/excavator#-command-line-parameters
- Create an inbound firewall rule allowing the unused_port_of_your_choise to be accessed
- You should now be able to access the Excavator API via your network

ha-nicehash-excavator-monitor's People

Contributors

Stargazers

Watchers

ha-nicehash-excavator-monitor's Issues

[BUG] Blocking HA startup

Describe the bug
This component blocks HA from starting if mining is not active (even though Quick Hash / Excavator is running)

To Reproduce
Steps to reproduce the behavior:

Stop mining, but leave Quick Hash / Excavator running
Restart HA
Watch it block startup
Now disable integration or uninstall
Restart HA
Notice no issues

Expected behavior
Component needs to better handle if mining is not active.

Screenshots
If applicable, add screenshots to help explain your problem.

Home Assistant (please complete the following information):

Version 2022.2.9
Installation docker

Additional context
HA has a fail-safe built in when components are blocking proper startup, so it eventually ignores the components and starts after about 600 seconds

Web UI error:

Starting nicehash_excavator, not everything will be available until it is finished.

Log snippets:

2022-02-22 08:30:36 WARNING (MainThread) [homeassistant.bootstrap] Waiting on integrations to complete setup: nicehash_excavator
2022-02-22 08:31:36 WARNING (MainThread) [homeassistant.bootstrap] Waiting on integrations to complete setup: nicehash_excavator
2022-02-22 08:32:36 WARNING (MainThread) [homeassistant.bootstrap] Waiting on integrations to complete setup: nicehash_excavator
2022-02-22 08:33:36 WARNING (MainThread) [homeassistant.bootstrap] Waiting on integrations to complete setup: nicehash_excavator
2022-02-22 08:34:19 WARNING (MainThread) [homeassistant.bootstrap] Setup timed out for stage 2 - moving forward
2022-02-22 08:39:19 WARNING (MainThread) [homeassistant.bootstrap] Setup timed out for bootstrap - moving forward
2022-02-22 08:39:19 INFO (MainThread) [homeassistant.bootstrap] Home Assistant initialized in 600.86s

Start/Stop miner. I'd love to be able to start and stop my miner based on automation (in my case surplus solar energy exporting to the grid). I have that trigger but can't figure how to do the post described below...