RainbowMiner

The RainbowMiner integrationIntegrations connect and integrate Home Assistant with your devices, services, and more. [Learn more] allows you to monitor RainbowMiner, an open-source cryptocurrency mining application that automatically switches between algorithms, pools, and coins to maximize profitability.

RainbowMiner runs a local HTTP API server that this integration connects to. With this integration, you can keep track of your mining status, earnings, and power consumption in Home Assistant.

Prerequisites

  1. Make sure RainbowMiner is installed and running on a machine on your network.
  2. Enable the RainbowMiner API server in the RainbowMiner configuration. By default, the API server listens on port 4000.
  3. If API authentication is enabled in RainbowMiner, have your API username and password ready. You only need these when authentication is turned on.

Configuration

To add the RainbowMiner device to your Home Assistant instance, use this My button:

Manual configuration steps

If the above My button doesn’t work, you can also perform the following steps manually:

  • Browse to your Home Assistant instance.

  • Go to Settings > Devices & services.

  • In the bottom right corner, select the Add Integration button.

  • From the list, select RainbowMiner.

  • Follow the instructions on screen to complete the setup.

Host

The hostname or IP address of the RainbowMiner server. For example, 192.168.1.50 or rainbowminer.local.

Port

The port the RainbowMiner API server is listening on. Defaults to 4000.

Username

The API username. Only required when API authentication is enabled in RainbowMiner.

Password

The API password. Only required when API authentication is enabled in RainbowMiner.

Supported functionality

The RainbowMiner integration provides the following entities.

Sensors

General sensors

The following sensors are always available:

  • Active miners: The number of currently running miners.
  • Power: The total power draw of all running miners, in watts.
  • Uptime: The date and time RainbowMiner was started.

Earnings in mBTC

The following sensors show earnings in mBTC and are always available:

  • Total earnings (mBTC): The total amount earned since RainbowMiner started tracking.
  • Unpaid balance (mBTC): The current unpaid balance across all pools.
  • Estimated daily profit (mBTC): The estimated profit per day based on current mining performance.
  • Weekly earnings (mBTC): The total amount earned over the past week.
  • Daily earnings (mBTC): The total amount earned over the past day.
  • Hourly earnings (mBTC): The total amount earned over the past hour.

Earnings in local currency

The following sensors show earnings converted to your local currency. They are created whenever Home Assistant has a currency configured:

  • Total earnings: The total amount earned, in your local currency.
  • Unpaid balance: The current unpaid balance, in your local currency.
  • Estimated daily profit: The estimated profit per day, in your local currency.
  • Weekly earnings: The total amount earned over the past week, in your local currency.
  • Daily earnings: The total amount earned over the past day, in your local currency.
  • Hourly earnings: The total amount earned over the past hour, in your local currency.

If the RainbowMiner API does not have an exchange rate for your configured currency, these sensors temporarily report unknown until a rate becomes available.

Data updates

The RainbowMiner integration pollsData polling is the process of querying a device or service at regular intervals to check for updates or retrieve data. By defining a custom polling interval, you can control how frequently your system checks for new data, which can help optimize performance and reduce unnecessary network traffic. [Learn more] the RainbowMiner API server every 30 seconds for updates.

Removing the integration

This integration follows standard integration removal. No extra steps are required.

To remove an integration instance from Home Assistant

  1. Go to Settings > Devices & services and select the integration card.
  2. Next to the entry you want to remove, select the three dots menu. Then, select Delete.
    • Depending on the integration, the entries are listed under one of the following headings:
      • Devices
      • Hubs
      • Services
      • Integration entries
  3. To confirm, select Delete.
    • Home Assistant also deletes the devices and entities of the entry.
  4. If Home Assistant asks you to restart, restart Home Assistant.
  5. If Home Assistant asks whether to also delete the application credentials, select Remove or Keep.