mirror of
https://github.com/skot/ESP-Miner.git
synced 2025-03-17 13:22:53 +01:00
f9e1672d6f
* Add instructions for development * Update readme.md with nodejs/npm for building --------- Co-authored-by: Peter Ryszkiewicz <3519085+pRizz@users.noreply.github.com>
115 lines
4.4 KiB
Markdown
Executable File
115 lines
4.4 KiB
Markdown
Executable File
[](https://discord.gg/3E8ca2dkcC)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
# ESP-Miner
|
|
esp-miner is open source ESP32 firmware for the [Bitaxe](https://github.com/skot/bitaxe)
|
|
|
|
If you are looking for premade images to load on your Bitaxe, check out the [releases](https://github.com/skot/ESP-Miner/releases) page. Maybe you want [instructions](https://github.com/skot/ESP-Miner/blob/master/flashing.md) for loading factory images.
|
|
|
|
# Bitaxetool
|
|
We also have a command line python tool for flashing Bitaxe and updating the config called Bitaxetool
|
|
|
|
**Bitaxetool Requires Python3.4 or later and pip**
|
|
|
|
Install bitaxetool from pip. pip is included with Python 3.4 but if you need to install it check <https://pip.pypa.io/en/stable/installation/>
|
|
|
|
```
|
|
pip install --upgrade bitaxetool
|
|
```
|
|
The bitaxetool includes all necessary library for flashing the binaries to the Bitaxe Hardware.
|
|
|
|
- Flash a "factory" image to a Bitaxe to reset to factory settings. Make sure to choose an image built for your hardware version (401) in this case:
|
|
|
|
```
|
|
bitaxetool --firmware ./esp-miner-factory-401-v2.4.2.bin
|
|
```
|
|
- Flash just the NVS config to a bitaxe:
|
|
|
|
```
|
|
bitaxetool --config ./config-401.cvs
|
|
```
|
|
- Flash both a factory image _and_ a config to your Bitaxe: note the settings in the config file will overwrite the config already baked into the factory image:
|
|
|
|
```
|
|
bitaxetool --config ./config-401.cvs --firmware ./esp-miner-factory-401-v2.4.2.bin
|
|
```
|
|
|
|
## AxeOS API
|
|
The esp-miner UI is called AxeOS and provides an API to expose actions and information.
|
|
|
|
For more details take a look at `main/http_server/http_server.c`.
|
|
|
|
Things that can be done are:
|
|
|
|
- Get System Info
|
|
- Get Swarm Info
|
|
- Update Swarm
|
|
- Swarm Options
|
|
- System Restart Action
|
|
- Update System Settings Action
|
|
- System Options
|
|
- Update OTA Firmware
|
|
- Update OTA WWW
|
|
- WebSocket
|
|
|
|
Some API examples in curl:
|
|
```bash
|
|
# Get system information
|
|
curl http://YOUR-BITAXE-IP/api/system/info
|
|
```
|
|
```bash
|
|
# Get swarm information
|
|
curl http://YOUR-BITAXE-IP/api/swarm/info
|
|
```
|
|
```bash
|
|
# System restart action
|
|
curl -X POST http://YOUR-BITAXE-IP/api/system/restart
|
|
```
|
|
|
|
## Administration
|
|
|
|
The firmware hosts a small web server on port 80 for administrative purposes. Once the Bitaxe device is connected to the local network, the admin web front end may be accessed via a web browser connected to the same network at `http://<IP>`, replacing `IP` with the LAN IP address of the Bitaxe device, or `http://bitaxe`, provided your network supports mDNS configuration.
|
|
|
|
### Recovery
|
|
|
|
In the event that the admin web front end is inaccessible, for example because of an unsuccessful firmware update (`www.bin`), a recovery page can be accessed at `http://<IP>/recovery`.
|
|
|
|
## Development
|
|
|
|
### Prerequisites
|
|
|
|
- Install the ESP-IDF toolchain from https://docs.espressif.com/projects/esp-idf/en/stable/esp32/get-started/
|
|
- Install nodejs/npm from https://nodejs.org/en/download
|
|
- (Optional) Install the ESP-IDF extension for VSCode from https://marketplace.visualstudio.com/items?itemName=espressif.esp-idf-extension
|
|
|
|
### Building
|
|
|
|
At the root of the repository, run:
|
|
```
|
|
idf.py build && ./merge_bin.sh ./esp-miner-merged.bin
|
|
```
|
|
|
|
Note: the merge_bin.sh script is a custom script that merges the bootloader, partition table, and the application binary into a single file.
|
|
|
|
Note: if using VSCode, you may have to configure the settings.json file to match your esp hardware version. For example, if your bitaxe has something other than an esp32-s3, you will need to change the version in the `.vscode/settings.json` file.
|
|
|
|
### Flashing
|
|
|
|
With the bitaxe connected to your computer via USB, run:
|
|
|
|
```
|
|
bitaxetool --config ./config-xxx.cvs --firmware ./esp-miner-merged.bin
|
|
```
|
|
|
|
where xxx is the config file for your hardware version. You can see the list of available config files in the root of the repository.
|
|
|
|
Note: if you are developing within a dev container, you will need to run the bitaxetool command from outside the container. Otherwise, you will get an error about the device not being found.
|
|
|
|
## Attributions
|
|
|
|
The display font is Portfolio 6x8 from https://int10h.org/oldschool-pc-fonts/ by VileR.
|