diff --git a/config.cvs.example b/config.cvs.example index 02a07eb..0c61b77 100644 --- a/config.cvs.example +++ b/config.cvs.example @@ -2,7 +2,7 @@ key,type,encoding,value main,namespace,, wifissid,data,string,myssid wifipass,data,string,mypass -stratumurl,data,string,solo.ckpool.org -stratumport,data,u16,3333 +stratumurl,data,string,public-pool.io +stratumport,data,u16,21496 stratumuser,data,string,1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa.bitaxe stratumpass,data,string,x diff --git a/main/Kconfig.projbuild b/main/Kconfig.projbuild index 4f2cfbd..eafc703 100755 --- a/main/Kconfig.projbuild +++ b/main/Kconfig.projbuild @@ -19,20 +19,20 @@ menu "Stratum Configuration" config STRATUM_URL string "Stratum Address" - default "solo.ckpool.org" + default "public-pool.io" help The example will connect to this Stratum pool address. config STRATUM_PORT int "Stratum Port" range 0 65535 - default 3333 + default 21496 help The stratum server port to connect to. config STRATUM_USER string "Stratum username" - default "" + default "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa.bitaxe" help Stratum user to use with pool diff --git a/readme.md b/readme.md index b060ba4..2d6f4e6 100755 --- a/readme.md +++ b/readme.md @@ -1,10 +1,19 @@ | Supported Targets | ESP32-S3 (BitAxe v2+) | | ----------------- | --------------------- | - # ESP-Miner -## Requires ESP-IDF v4.4.4 +## Requires ESP-IDF v4.4 + +You can chose between 2 methods of installations: + +### Manual Installation + +Follow the official [instructions](https://docs.espressif.com/projects/esp-idf/en/v4.4.5/esp32s3/get-started/index.html#installation-step-by-step). + +### ESP-IDF Visual Studio Code Extension + +Install the "Espressif IDF" extension, it will automate the IDF installation for you. ## Hardware Required @@ -19,18 +28,20 @@ idf.py set-target esp32s3 ``` Use menuconfig to set the stratum server address/port and WiFi SSID/Password + ``` idf.py menuconfig ``` + Set following parameters under Stratum Configuration Options, these will define the stratum server you connect to: -* Set `Stratum Address` to the stratum pool domain name. example "solo.ckpool.org" +* Set `Stratum Address` to the stratum pool domain name. example "public-pool.io" -* Set `Stratum Port` to the stratum pool port. example "3333" +* Set `Stratum Port` to the stratum pool port. example "21496" -* Set `Stratum username` to the stratum pool username +* Set `Stratum username` to the stratum pool username. example ".bitaxe" -* Set `Stratum password` to the stratum pool password +* Set `Stratum password` to the stratum pool password. example "x" Set following parameters under Example Connection Configuration Options: @@ -38,9 +49,7 @@ Set following parameters under Example Connection Configuration Options: * Set `Wifi Password` to the password for your target SSID. - -For more information about the example_connect() method used here, check out https://github.com/espressif/esp-idf/blob/master/examples/protocols/README.md. - +For more information about the example_connect() method used here, check out . ## Build and Flash @@ -58,11 +67,10 @@ See the Getting Started Guide for full steps to configure and use ESP-IDF to bui The unit tests for the project use the unity test framework and currently require actual esp32 hardware to run. -They are located at https://github.com/johnny9/esp-miner/tree/master/components/stratum/test +They are located at ``` cd ./test/ idf.py set-target esp32s3 idf.py -p PORT flash monitor ``` -