Merge pull request #206 from matteocrippa/feature/worker

Improved doc with custom worker

README.md

@@ -1,25 +1,28 @@
 # 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](images/bgNerdMinerV2.png)
 
 ## Requirements
+
 - TTGO T-Display S3 or any supported boards (check Build tutorial 👇)
 - 3D BOX [here](3d_files/)
 
 ### 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).
+
+**ESP32 implementing Stratum protocol** to mine on solo pool. Pool can be changed but originally works with [public-pool.io][https://web.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
@@ -29,46 +32,54 @@ Every time an stratum job notification is received miner update its current work
 
 **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***
+**_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](3d_files/)
 
 #### Current Supported Boards
-- LILYGO T-Display S3 ([Aliexpress link*](https://s.click.aliexpress.com/e/_Ddy7739))
+
-- ESP32-WROOM-32, ESP32-Devkit1.. ([Aliexpress link*](https://s.click.aliexpress.com/e/_DCzlUiX))
+- LILYGO T-Display S3 ([Aliexpress link\*](https://s.click.aliexpress.com/e/_Ddy7739))
-- LILYGO T-QT pro ([Aliexpress link*](https://s.click.aliexpress.com/e/_DBQIr43))
+- ESP32-WROOM-32, ESP32-Devkit1.. ([Aliexpress link\*](https://s.click.aliexpress.com/e/_DCzlUiX))
-- LILYGO T-Display 1.14 ([Aliexpress link*](https://s.click.aliexpress.com/e/_DEqGvSJ))
+- LILYGO T-QT pro ([Aliexpress link\*](https://s.click.aliexpress.com/e/_DBQIr43))
-- LILYGO T-Display S3 AMOLED ([Aliexpress link*](https://s.click.aliexpress.com/e/_DmOIK6j))
+- LILYGO T-Display 1.14 ([Aliexpress link\*](https://s.click.aliexpress.com/e/_DEqGvSJ))
-- LILYGO T-Dongle S3 ([Aliexpress link*](https://s.click.aliexpress.com/e/_DmQCPyj))
+- LILYGO T-Display S3 AMOLED ([Aliexpress link\*](https://s.click.aliexpress.com/e/_DmOIK6j))
-- ESP32-2432S028R 2,8" ([Aliexpress link*](https://s.click.aliexpress.com/e/_DdXkvLv) / Dev support: @nitroxgas / ⚡jadeddonald78@walletofsatoshi.com)
+- LILYGO T-Dongle S3 ([Aliexpress link\*](https://s.click.aliexpress.com/e/_DmQCPyj))
+- ESP32-2432S028R 2,8" ([Aliexpress link\*](https://s.click.aliexpress.com/e/_DdXkvLv) / Dev support: @nitroxgas / ⚡jadeddonald78@walletofsatoshi.com)
 - ESP32-cam ([Board Info](https://lastminuteengineers.com/getting-started-with-esp32-cam/) / Dev support: @elmo128)
 
-*Affiliate links
+\*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
 1. Go to NM2 flasher online: https://bitmaker-hub.github.io/diyflasher/
 
 #### 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.
+
+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
 1. Download this repository
 1. Go to ESPtool online: https://espressif.github.io/esptool-js/
-1. Load the firmware with the binary from one of the sub-folders of ``bin`` corresponding to your board.
+1. Load the firmware with the binary from one of the sub-folders of `bin` corresponding to your board.
-1. Plug your board and select each file from the sub-folder (``.bin`` files).
+1. 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 ESPtool works with chrome, chromium, brave
 1. ESPtool recommendations: use 115200bps
 1. 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
@@ -76,6 +87,7 @@ Update NerdMiner firmware following same flashing steps but only using the file
 1. 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.
 
 #### Wifi Accesspoint
@@ -85,6 +97,7 @@ After programming, you will only need to setup your Wifi and BTC address.
    - PASS: MineYourCoins
 1. Setup your Wifi Network
 1. Add your BTCaddress
+   - 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)
 
@@ -108,7 +121,7 @@ After programming, you will only need to setup your Wifi and BTC address.
 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 |
 | nerdminers.org    |       | https://nerdminers.org     | Team domain for future pool - Currently pointing to public-pool.io |
 | pool.nerdminer.io | 3333  | https://nerdminer.io       | Mantained by CHMEX                                                 |
@@ -117,7 +130,7 @@ Recommended low difficulty share pools:
 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                  |
@@ -132,30 +145,35 @@ Other standard pools not compatible with low difficulty share:
 - 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í](https://img.youtube.com/vi/POUT2R_opDs/0.jpg)](https://youtu.be/POUT2R_opDs)
 
 ## Developers
+
 ### Project guidelines
+
 - Current project was addapted 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
+
 - [x] Move project to platformIO
 - [x] Bug rectangle on screen when 1milion shares
 - [x] Bug memory leaks
@@ -174,11 +192,14 @@ With the USB-C port to the right:
 - [x] Add support to Amoled
 
 ### On 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](https://bitronics.store).