Skip to content

HelixNewton/NerdMiner_v3

BranchesTags
 
 

Repository files navigation

NerdSoloMiner

The NerdSoloMiner v2

This is a free and open source project that let you try to reach a bitcoin block with a small piece of hardware.

The main aim of this project is to let you learn more about minery and to have a beautiful piece of hardware in your desktop.

Original project https://github.com/valerio-vaccaro/HAN

image

Web Dashboard (NerdMiner v3)

NerdMiner v3 adds a built-in web dashboard served directly from the device — no app, no cloud, no extra hardware required.

Web Dashboard

Features

  • Live stats — hashrate, shares accepted/rejected, best difficulty, uptime, free heap, templates received
  • Fleet view — monitor all your miners from one dashboard: Scan LAN auto-discovers every NerdMiner on your subnet (or add them by IP/hostname), then see combined hashrate, total shares, and per-device status side by side (no need to open each IP individually)
  • Real-time share log & alerts — accepted/rejected shares and pool disconnects appear live as they happen
  • Real-time hashrate chart — canvas sparkline with rolling window
  • One-click pool switching — pick a pool from the toolbar dropdown to retarget the miner instantly (list is served from the firmware's pool registry)
  • Pool & WiFi status — connection state, IP address, signal strength
  • Config panel — update wallet address, pool URL/port, and timezone directly from the browser
  • OTA firmware update — drag-and-drop .bin upload with progress bar; no USB cable needed
  • Restart / Factory Reset — one-click buttons with confirmation dialogs
  • Optional API token auth — protect the dashboard behind a bearer token (set WEBUI_AUTH_TOKEN in build flags)
  • Mobile-friendly — responsive dark UI, works on any browser

The Fleet view aggregates every miner on your network in one place — add them manually or hit Scan LAN to auto-discover them:

Fleet view

Accessing the Dashboard

  1. Flash the firmware and connect the device to your WiFi via the NerdMinerAP captive portal
  2. Find the device IP on your router, or check the serial output
  3. Open http://<device-ip>/ in any browser

REST API

Method Endpoint Description
GET /api/status Live mining stats (JSON)
GET /api/system Chip info, free heap, uptime
GET /api/config Current saved config
POST /api/config Update config (restarts device)
GET /api/pools Known-pool registry used by the pool switcher
GET /api/pool/test Test reachability of the current pool
POST /api/restart Soft restart
POST /api/reset Factory reset (clears NVS)
POST /api/ota OTA firmware upload (multipart)

Fleet polling: the Fleet view fetches each miner's /api/status directly from your browser (CORS is enabled), so all miners must be on the same network you're browsing from. The miner list is stored per-browser in localStorage.

Flash Scripts

Use the included scripts to build and flash from source in one step:

Linux / macOS:

chmod +x flash.sh && ./flash.sh

Windows:

flash.bat

Both scripts auto-detect your serial port and let you choose your board from a menu.

Requirements

  • TTGO T-Display S3 or any supported boards (check Build tutorial 👇)
  • 3D BOX here

Project description

ESP32 implementing Stratum protocol to mine on solo pool. Pool can be changed but originally works with public-pool.io (where Nerdminers are supported).

This project was initialy developed using ESP32-S3, but currently support other boards. It uses WifiManager to modify miner settings and save them to SPIFF. The microMiner comes with several screens to monitor it's working procedure and also to show you network mining stats. Currently includes:

  • NerdMiner Screen > Mining data of Nerdminer
  • ClockMiner Screen > Fashion style clock miner
  • GlobalStats Screen > Global minery stats and relevant data

This miner is multicore and multithreads, both cores are used to mine and several threads are used to implementing stratum work and wifi stuff. Every time an stratum job notification is received miner update its current work to not create stale shares.

IMPORTANT Miner is not seen by all standard pools due to its low share difficulty. You can check miner work remotely using specific pools specified down or seeing logs via UART.

Current project is still in developement and more features will be added

Build Tutorial

Hardware requirements

  • LILYGO T-Display S3 (original one) or any other supported boards
  • 3D BOX here

Current Supported Boards

*Affiliate links

Flash firmware

microMiners Flashtool [Recommended]

Easyiest way to flash firmware. Build your own miner using the folowing firwmare flash tool:

  1. Get a TTGO T-display S3 or any other supported board
  2. Go to NM2 flasher online: https://flasher.bitronics.store/ (recommend via Google Chrome incognito mode)

Standard tool

Create your own miner using the online firwmare flash tool ESPtool and one of the binary files that you will find in the bin folder. If you want you can compile the entire project using Arduino, PlatformIO or Expressif IDF.

  1. Get a TTGO T-display S3 or any supported board
  2. Download this repository
  3. Go to ESPtool online: https://espressif.github.io/esptool-js/
  4. Load the firmware with the binary from one of the sub-folders of bin corresponding to your board.
  5. Plug your board and select each file from the sub-folder (.bin files).

Update firmware

Update NerdMiner firmware following same flashing steps but only using the file 0x10000_firmware.bin.

Build troubleshooting

  1. Online ESP Tool works with chrome, chromium, brave
  2. ESPtool recommendations: use 115200bps
  3. Build errors > If during firmware download upload stops, it's recommended to enter the board in boot mode. Unplug cable, hold right bottom button and then plug cable. Try programming
  4. In extreme case you can "Erase all flash" on ESPtool to clean all current configuration before uploading firmware. There has been cases that experimented Wifi failures until this was made.
  5. In case of ESP32-WROOM Boards, could be necessary to put your board on boot mode. Hold boot button, press reset button and then program.

NerdMiner configuration

After programming, you will only need to setup your Wifi and BTC address.

Note: when BTC address of your selected wallet is not provided, mining will not be started.

Wifi Accesspoint

  1. Connect to NerdMinerAP

    • AP: NerdMinerAP
    • PASS: MineYourCoins

  2. Set up your Wifi Network

  3. Add your BTC address

  4. Change the password if needed

    • If you are using public-pool.io and you want to set a custom name to your worker you can append a string with format .yourworkername to the address

SD card (if available)

  1. Format a SD card using Fat32.
  2. Create a file named "config.json" in your card's root, containing the the following structure. Adjust the settings to your needs:
{  
  "SSID": "myWifiSSID",  
  "WifiPW": "myWifiPassword",  
  "PoolUrl": "public-pool.io",  
  "PoolPort": 21496,
  "PoolPassword": "x",
  "BtcWallet": "walletID",  
  "Timezone": 2,  
  "SaveStats": false  
}
  1. Insert the SD card.
  2. Hold down the "reset configurations" button as described below to reset the configurations and/or boot without settings in your nvmemory.
  3. Power down to remove the SD card. It is not needed for mining.

Pool selection

Recommended low difficulty share pools:

Pool URL Port Web URL Status
public-pool.io 21496 https://web.public-pool.io Open Source Solo Bitcoin Mining Pool supporting open source miners
pool.nerdminers.org 3333 https://nerdminers.org The official Nerdminer pool site - Mantained by @golden-guy
pool.nerdminer.io 3333 https://nerdminer.io Mantained by CHMEX
pool.pyblock.xyz 3333 https://pool.pyblock.xyz/ Mantained by curly60e
pool.sethforprivacy.com 3333 https://pool.sethforprivacy.com/ Mantained by @sethforprivacy - public-pool fork
pool.stompi.de 3333 http://web.stompi.de Mantained by @odinstar - public-pool fork
pool.solomining.de 3333 https://pool.solomining.de/ Mantained by https://x.com/solo_mining

Other standard pools not compatible with low difficulty share:

Pool URL Port Web URL
solo.ckpool.org 3333 https://solo.ckpool.org/
btc.zsolo.bid 6057 https://zsolo.bid/en/btc-solo-mining-pool
eu.stratum.slushpool.com 3333 https://braiins.com/pool

Buttons

One button devices:

  • One click > change screen.
  • Double click > change screen orientation.
  • Tripple click > turn the screen off and on again.
  • Hold 5 seconds > reset the configurations and reboot your NerdMiner.

Two button devices:

With the USB-C port to the right:

TOP BUTTON

  • One click > change screen.
  • Hold 5 seconds > top right button to reset the configurations and reboot your NerdMiner.
  • Hold and power up > enter configuration mode and edit current config via Wifi. You could change your settings or verify them.

BOTTOM BUTTON

  • One Click > turn the screen off and on again
  • Double click > change orientation (default is USB-C to the right)

Build video

Ver video aquí

Developers

Project guidelines

  • Current project was adapted to work with PlatformIO
  • Current project works with ESP32-S3 and ESP32-wroom.
  • Partition squeme should be build as huge app
  • All libraries needed shown on platform.ini

Job done

  • Move project to platformIO
  • Bug rectangle on screen when 1milion shares
  • Bug memory leaks
  • Bug Reboots when received JSON contains some null values
  • Implement midstate sha256
  • Bug Wificlient DNS unresolved on Wifi.h
  • Code refactoring
  • Add blockHeight to screen
  • Add clock to show current time
  • Add new screen with global mining stats
  • Add pool support for low difficulty miners
  • Add best difficulty on miner screen
  • Add suport to standard ESP32 dev-kit / ESP32-WROOM
  • Code changes to support adding multiple boards
  • Add support to TTGO T-display 1.14
  • Add support to Amoled

In process

  • Create a daisy chain protocol via UART or I2C to support ESP32 hashboards
  • Create new screen like clockMiner but with BTC price
  • Add support to control BM1397
  • Add password field in web configuration form

Donations/Project contributions

If you would like to contribute and help dev team with this project you can send a donation to the following LN address ⚡teamnerdminer@getalby.com⚡ or using one of the affiliate links above.

If you want to order a fully assembled Nerdminer you can contribute to my job at 🛒bitronics.store🛒

Support the NerdMiner v3 fork:

Buy Me A Coffee

Enjoy

About

Improved version of first ESP32 NerdMiner

Resources

Readme

License

View license
Activity

Stars

1 star

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages

  • C 96.5%
  • C++ 3.4%
  • Processing 0.1%
  • Python 0.0%
  • Shell 0.0%
  • Batchfile 0.0%