Skip to content

Commit

Permalink
Update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
skot authored Sep 21, 2024
1 parent f7411ff commit 605221c
Showing 1 changed file with 8 additions and 61 deletions.
69 changes: 8 additions & 61 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,84 +6,31 @@


# ESP-Miner
esp-miner is open source ESP32 firmware for the [Bitaxe](https://github.com/skot/bitaxe)

| Supported Targets | ESP32-S3 (BitAxe v2+) |
| ----------------- | --------------------- |
If you are looking for binaries 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.

## Requires Python3.4 or later and pip
# 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
```

## Hardware Required

This firmware is designed to run on a BitAxe v2+

If you do have a Bitaxe with no USB connectivity make sure to establish a serial connection with either a JTAG ESP-Prog device or a USB-to-UART bridge

## Preconfiguration

Starting with v2.0.0, the ESP-Miner firmware requires some basic manufacturing data to be flashed in the NVS partition.

1. Download the esp-miner-factory-v2.0.3.bin file from the release tab.
Click [here](https://github.com/skot/ESP-Miner/releases) for the release tab

2. Copy `config.cvs.example` to `config.cvs` and modify `asicfrequency`, `asicvoltage`, `asicmodel`, `devicemodel`, and `boardversion`

The following are recommendations but it is necessary that you do have all values in your `config.cvs`file to flash properly.

- recommended values for the Bitaxe 1368 (supra)

```
key,type,encoding,value
main,namespace,,
asicfrequency,data,u16,490
asicvoltage,data,u16,1200
asicmodel,data,string,BM1368
devicemodel,data,string,supra
boardversion,data,string,400
```

- recommended values for the Bitaxe 1366 (ultra)

```
key,type,encoding,value
main,namespace,,
asicfrequency,data,u16,485
asicvoltage,data,u16,1200
asicmodel,data,string,BM1366
devicemodel,data,string,ultra
boardversion,data,string,0.11
```

- recomended values for the Bitaxe 1397 (MAX)

```
key,type,encoding,value
main,namespace,,
asicfrequency,data,u16,475
asicvoltage,data,u16,1400
asicmodel,data,string,BM1397
devicemodel,data,string,max
boardversion,data,string,2.2
```

## Flash

The bitaxetool includes all necessary library for flashing the binary file to the Bitaxe Hardware.

The bitaxetool requires a config.cvs preloaded file and the appropiate firmware.bin file in it's executed directory.

3. Flash with the bitaxetool
- Flash with the bitaxetool

```
bitaxetool --config ./config.cvs --firmware ./esp-miner-factory-v2.0.3.bin
```

## API
## AxeOS API
Bitaxe provides an API to expose actions and information.

For more details take a look at `main/http_server/http_server.c`.
Expand Down

0 comments on commit 605221c

Please sign in to comment.