Skip to content

Commit 276a972

Browse files
authored
Merge pull request #2 from bitcraze/rik/readme
Update README
2 parents 822208b + 14b6eab commit 276a972

File tree

3 files changed

+35
-19
lines changed

3 files changed

+35
-19
lines changed

README.md

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -44,10 +44,23 @@ The firmware implements the following capabilities:
4444

4545
### GPIO Pin Mapping
4646

47-
The firmware controls 11 GPIO pins through memory-mapped registers. Each bit in the 16-bit GPIO registers corresponds to one pin:
48-
49-
**GPIOA pins**: PA2, PA3, PA4, PA5, PA6, PA7, PA8, PA11, PA12 (bits 0-8)
50-
**GPIOC pins**: PC14, PC15 (bits 9-10)
47+
The firmware controls 13 GPIO pins through memory-mapped registers. Each bit in the 16-bit GPIO registers corresponds to one pin:
48+
49+
| GPIO Index | Physical Pin | Description |
50+
|------------|--------------|-------------|
51+
| 0 | PA0 | GPIO pin 0 |
52+
| 1 | PA1 | GPIO pin 1 |
53+
| 2 | PA2 | GPIO pin 2 |
54+
| 3 | PA3 | GPIO pin 3 |
55+
| 4 | PA4 | GPIO pin 4 |
56+
| 5 | PA5 | GPIO pin 5 |
57+
| 6 | PA6 | GPIO pin 6 |
58+
| 7 | PA7 | GPIO pin 7 |
59+
| 8 | PA8 | GPIO pin 8 |
60+
| 9 | PA11 | GPIO pin 9 |
61+
| 10 | PA12 | GPIO pin 10 |
62+
| 11 | PC14 | GPIO pin 11 |
63+
| 12 | PC15 | GPIO pin 12 |
5164

5265
The GPIO control uses two 16-bit registers:
5366
- **Direction register (0x1000-0x1001)**: Controls pin direction (1=output, 0=input)
@@ -162,23 +175,12 @@ STM32_Programmer_CLI -c port=SWD mode=UR -ob RDP=0xAA -ob nBOOT_SEL=0
162175

163176
### Deck configuration
164177

165-
The configuration can be written using the [cfcli](https://github.com/evoggy/cfcli) tool. First create
166-
the desired configuration YAML file:
167-
168-
```yaml
169-
version_major: 0
170-
version_minor: 1
171-
vid: 0xBC
172-
pid: 0x13
173-
rev: 'B'
174-
name: 'HP LED'
175-
partitions: []
176-
```
177-
178-
Then use cfcli tool to flash the configuration via SWD:
178+
The configuration can be written using the [cfcli](https://github.com/evoggy/cfcli) tool. Flash a configuration via SWD:
179179

180180
```bash
181-
cfcli util deck-ctrl binflash deck-ctrl.yaml
181+
cfcli util deck-ctrl binflash configs/bottom_config.yaml
182+
# or
183+
cfcli util deck-ctrl binflash configs/top_config.yaml
182184
```
183185

184186
### VS Code Integration

configs/bottom_config.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version_major: 0
2+
version_minor: 1
3+
vid: 0xBC
4+
pid: 0x13
5+
rev: 'B'
6+
name: 'bcColorLEDBot'
7+
partitions: []

configs/top_config.yaml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
version_major: 0
2+
version_minor: 1
3+
vid: 0xBC
4+
pid: 0x14
5+
rev: 'B'
6+
name: 'bcColorLEDTop'
7+
partitions: []

0 commit comments

Comments
 (0)