Skip to content

Commit 0c9eaeb

Browse files
max-arnoldmax-arnold
committed
Move most of the README to docs
1 parent 1fc3be5 commit 0c9eaeb

File tree

5 files changed

+69
-58
lines changed

5 files changed

+69
-58
lines changed

‎CHANGELOG.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Changelog
22

3+
The project documentation is avaiable at https://esp32-si4732.github.io/ats-mini/
4+
35
## 1.05 (2025-03-16)
46

57

‎README.md‎

Lines changed: 4 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -11,64 +11,10 @@ Based on the following sources:
1111
* Goshante: https://github.com/goshante/ats20_ats_ex
1212
* G8PTN, Dave: https://github.com/G8PTN/ATS_MINI
1313

14-
## Development notes
14+
## Releases
1515

16-
1. Install [Arduino CLI](https://arduino.github.io/arduino-cli/1.2/installation/).
17-
2. Go to the repository root folder
18-
3. Compile and flash the firmware
16+
Check out the [Releases](https://github.com/esp32-si4732/ats-mini/releases) page.
1917

20-
``` shell
21-
arduino-cli compile --clean -e -p COM_PORT -u ats-mini
22-
```
18+
## Documentation
2319

24-
25-
## Pinout
26-
27-
The pinout table is shown below.
28-
29-
The relevant colums are ESP32-S3-WROOM-1 "Pin Name" and "ATS-Mini Sketch Pin Definitions"
30-
31-
| ESP32-S3-WROOM-1<br>Pin # | ESP32-S3-WROOM-1<br>Pin Name | ATS-MINI Sketch<br>Pin Definitions | TFT_eSPI<br>Pin Definition | xtronic.org<br>Schematic | Comments<br>Info |
32-
|---------------------------|------------------------------|------------------------------------|----------------------------|--------------------------|--------------------------|
33-
| 1 | GND | | | GND | |
34-
| 2 | 3V3 | | | VCC_33 | |
35-
| 3 | EN | | | EN | RST Button |
36-
| 4 | IO4 | VBAT_MON | | BAT_ADC | Battery monitor |
37-
| 5 | IO5 | | TFT_RST | LCD_RES | |
38-
| 6 | IO6 | | TFT_CS | LCD_CS | |
39-
| 7 | IO7 | | TFT_DC | LCD_DC | |
40-
| 8 | IO15 | PIN_POWER_ON | | RADIO_EN | 1= Radio LDO Enable |
41-
| 9 | IO16 | RESET_PIN | | RST | SI4732 Reset |
42-
| 10 | IO17 | ESP32_I2C_SCL | | I2C_SCL | SI4732 Clock |
43-
| 11 | IO18 | ESP32_I2C_SDA | | I2C_SDA | SI4732 Data |
44-
| 12 | IO8 | | TFT_WR | LCD_WR | |
45-
| 13 | IO19 | | | USB_DM | USB_D- (CDC Port) |
46-
| 14 | IO20 | | | USB_DP | USB_D+ (CDC Port) |
47-
| 15 | IO3 | AUDIO_MUTE | | MUTE | 1 = Mute L/R audio |
48-
| 16 | IO46 | | TFT_D5 | LCD_DS | |
49-
| 17 | IO9 | | TFT_RD | LCD_RD | |
50-
| 18 | IO10 | PIN_AMP_EN | | AMP_EN | 1 = Audio Amp Enable |
51-
| 19 | IO11 | | | NC | Spare |
52-
| 20 | IO12 | | | NC | Spare |
53-
| 21 | IO13 | | | NC | Spare |
54-
| 22 | IO14 | | | NC | Spare |
55-
| 23 | IO21 | ENCODER_PUSH_BUTTON | | SW | Rotary encoder SW signal |
56-
| 24 | IO47 | | TFT_D6 | LCD_D6 | |
57-
| 25 | IO48 | | TFT_D7 | LCD_D7 | |
58-
| 26 | IO45 | | TFT_D4 | LCD_D4 | |
59-
| 27 | IO0 | | | GPIO0 | BOOT button |
60-
| 28 | IO35 | | | NC | Used for OSPI PSRAM |
61-
| 29 | IO36 | | | NC | Used for OSPI PSRAM |
62-
| 30 | IO37 | | | NC | Used for OSPI PSRAM |
63-
| 31 | IO38 | PIN_LCD_BL | TFT_BL | LCD_BL | Backlight control |
64-
| 32 | IO39 | | TFT_D0 | LCD_D0 | |
65-
| 33 | IO40 | | TFT_D1 | LCD_D1 | |
66-
| 34 | IO41 | | TFT_D2 | LCD_D2 | |
67-
| 35 | IO42 | | TFT_D3 | LCD_D2 | |
68-
| 36 | RXD0 | | | NC | GPIO44 |
69-
| 37 | TXD0 | | | NC | GPIO43 |
70-
| 38 | IO2 | ENCODER_PIN_A | | A | Rotary encoder A signal |
71-
| 39 | IO1 | ENCODER_PIN_B | | B | Rotary encoder B signal |
72-
| 40 | GND | | | GND | |
73-
| 41 | EPAD | | | GND | |
74-
-----------------------------------------------------------------------------------------------------------------
20+
The hardware, software and flashing documentation is available at <https://esp32-si4732.github.io/ats-mini/>

‎docs/source/development.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Development
2+
3+
1. Install [Arduino CLI](https://arduino.github.io/arduino-cli/1.2/installation/).
4+
2. Go to the repository root folder
5+
3. Compile and flash the firmware
6+
7+
``` shell
8+
arduino-cli compile --clean -e -p COM_PORT -u ats-mini
9+
```

‎docs/source/hardware.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Hardware notes
2+
3+
## Pinout
4+
5+
The pinout table is shown below.
6+
7+
The relevant columns are ESP32-S3-WROOM-1 "Pin Name" and "ATS-Mini Sketch Pin Definitions"
8+
9+
| ESP32-S3-WROOM-1<br>Pin # | ESP32-S3-WROOM-1<br>Pin Name | ATS-MINI Sketch<br>Pin Definitions | TFT_eSPI<br>Pin Definition | xtronic.org<br>Schematic | Comments<br>Info |
10+
|---------------------------|------------------------------|------------------------------------|----------------------------|--------------------------|--------------------------|
11+
| 1 | GND | | | GND | |
12+
| 2 | 3V3 | | | VCC_33 | |
13+
| 3 | EN | | | EN | RST Button |
14+
| 4 | IO4 | VBAT_MON | | BAT_ADC | Battery monitor |
15+
| 5 | IO5 | | TFT_RST | LCD_RES | |
16+
| 6 | IO6 | | TFT_CS | LCD_CS | |
17+
| 7 | IO7 | | TFT_DC | LCD_DC | |
18+
| 8 | IO15 | PIN_POWER_ON | | RADIO_EN | 1= Radio LDO Enable |
19+
| 9 | IO16 | RESET_PIN | | RST | SI4732 Reset |
20+
| 10 | IO17 | ESP32_I2C_SCL | | I2C_SCL | SI4732 Clock |
21+
| 11 | IO18 | ESP32_I2C_SDA | | I2C_SDA | SI4732 Data |
22+
| 12 | IO8 | | TFT_WR | LCD_WR | |
23+
| 13 | IO19 | | | USB_DM | USB_D- (CDC Port) |
24+
| 14 | IO20 | | | USB_DP | USB_D+ (CDC Port) |
25+
| 15 | IO3 | AUDIO_MUTE | | MUTE | 1 = Mute L/R audio |
26+
| 16 | IO46 | | TFT_D5 | LCD_DS | |
27+
| 17 | IO9 | | TFT_RD | LCD_RD | |
28+
| 18 | IO10 | PIN_AMP_EN | | AMP_EN | 1 = Audio Amp Enable |
29+
| 19 | IO11 | | | NC | Spare |
30+
| 20 | IO12 | | | NC | Spare |
31+
| 21 | IO13 | | | NC | Spare |
32+
| 22 | IO14 | | | NC | Spare |
33+
| 23 | IO21 | ENCODER_PUSH_BUTTON | | SW | Rotary encoder SW signal |
34+
| 24 | IO47 | | TFT_D6 | LCD_D6 | |
35+
| 25 | IO48 | | TFT_D7 | LCD_D7 | |
36+
| 26 | IO45 | | TFT_D4 | LCD_D4 | |
37+
| 27 | IO0 | | | GPIO0 | BOOT button |
38+
| 28 | IO35 | | | NC | Used for OSPI PSRAM |
39+
| 29 | IO36 | | | NC | Used for OSPI PSRAM |
40+
| 30 | IO37 | | | NC | Used for OSPI PSRAM |
41+
| 31 | IO38 | PIN_LCD_BL | TFT_BL | LCD_BL | Backlight control |
42+
| 32 | IO39 | | TFT_D0 | LCD_D0 | |
43+
| 33 | IO40 | | TFT_D1 | LCD_D1 | |
44+
| 34 | IO41 | | TFT_D2 | LCD_D2 | |
45+
| 35 | IO42 | | TFT_D3 | LCD_D2 | |
46+
| 36 | RXD0 | | | NC | GPIO44 |
47+
| 37 | TXD0 | | | NC | GPIO43 |
48+
| 38 | IO2 | ENCODER_PIN_A | | A | Rotary encoder A signal |
49+
| 39 | IO1 | ENCODER_PIN_B | | B | Rotary encoder B signal |
50+
| 40 | GND | | | GND | |
51+
| 41 | EPAD | | | GND | |
52+

‎docs/source/index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
maxdepth: 1
44
hidden: true
55
---
6+
development.md
7+
hardware.md
68
changelog.md
79
```
810

0 commit comments

Comments
 (0)