Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ziteh committed Feb 3, 2024
1 parent 5709c81 commit 1cfa66c
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 45 deletions.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,18 @@
# ErgoSNM nRF Firmware

[ErgoSNM Rev 3.x keyboard](https://github.com/siderakb/ergo-snm-keyboard) wireless edition nRF firmware, based on nRF52840 SoC and [NCS](https://www.nordicsemi.com/Products/Development-software/nrf-connect-sdk).
[ErgoSNM Rev 3.x](https://github.com/siderakb/ergo-snm-keyboard) wireless keyboard nRF firmware, based on nRF52840 SoC and [NCS](https://www.nordicsemi.com/Products/Development-software/nrf-connect-sdk).

- [`mitosis-like/`](/mitosis-like/): Main firmware


```mermaid
flowchart TD
A[PC]---|USB HID| B["ATmega32U4
QMK"]
B --- |UART| C[nRF52 Central]
C -.- |Gazell 2.4GHz| D[nRF52 Left]
C -.- |Gazell 2.4GHz| E[nRF52 Righ]
E --- |SPI| F[PMW3360]
```

- [`three-mod/`](/three-mod/): Experimental firmware
70 changes: 26 additions & 44 deletions mitosis-like/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,53 +3,35 @@
[ErgoSNM Rev 3.x keyboard](https://github.com/siderakb/ergo-snm-keyboard) wireless [mitosis](https://github.com/reversebias/mitosis)-like edition nRF52840 (E73-2G4M08S1C) firmware.

- nRF52 Central: [`central/`](/central/)
- nRF52 Left: [`peripheral/`](/peripheral/) without `PMW3360_ENABLE` symbol
- nRF52 Right: [`peripheral/`](/peripheral/) with `PMW3360_ENABLE` symbol

```css
[PC]
<USB HID>
[ATmega32U4-QMK]
<UART>
[nRF52 Central]
[nRF52 Left]──<Gazell>─┴─<Gazell>──[nRF52 Right]
<SPI>
[PMW3360]
```
- nRF52 Left: [`peripheral/`](/peripheral/) without `PMW3360_ENABLE` and `RIGHT` symbol
- nRF52 Right: [`peripheral/`](/peripheral/) with `PMW3360_ENABLE` and `RIGHT` symbol

## Pin Map

| Name | GPIO |
| ---------------- | ----- |
| Key Row-0 | P0.10 |
| Key Row-1 | P0.28 |
| Key Row-2 | P0.03 |
| Key Row-3 | P1.10 |
| Key Row-4 | P1.11 |
| Key Col-0 | P0.09 |
| Key Col-1 | P1.13 |
| Key Col-2 | P0.02 |
| Key Col-3 | P0.30 |
| Key Col-4 | P0.31 |
| Key Col-5 | P0.29 |
| Key Col-6 | P0.26 |
| Key Col-7 | P0.17 |
| PMW3360 SPI CS | P1.06 |
| PMW3360 SPI SCLK | P0.13 |
| PMW3360 SPI MOSI | P1.09 |
| PMW3360 SPI MISO | P0.05 |
| PMW3360 Motion | P1.04 |
| QMK UART Tx | P1.02 |
| QMK UART Rx | P1.01 |
| Debug UART Tx | P0.06 |
| Debug UART Rx | P0.08 |
| Name | Left | Right | Central |
| ---------------- | ----- | ----- | ------- |
| Key Col-0 | P0.10 | P0.09 | |
| Key Col-1 | P0.09 | P1.13 | |
| Key Col-2 | P1.11 | P0.02 | |
| Key Col-3 | P1.10 | P0.30 | |
| Key Col-4 | P0.03 | P0.31 | |
| Key Col-5 | P0.28 | P0.29 | |
| Key Col-6 | P1.04 | P0.26 | |
| Key Col-7 | P0.13 | P0.17 | |
| Key Row-0 | P0.30 | P0.10 | |
| Key Row-1 | P0.31 | P0.28 | |
| Key Row-2 | P0.29 | P0.03 | |
| Key Row-3 | P0.02 | P1.10 | |
| Key Row-4 | P1.13 | P1.11 | |
| PMW3360 SPI CS | | P1.06 | |
| PMW3360 SPI SCLK | | P0.13 | |
| PMW3360 SPI MOSI | | P1.09 | |
| PMW3360 SPI MISO | | P0.05 | |
| PMW3360 Motion | | P1.04 | |
| QMK UART Tx | | | P1.02 |
| QMK UART Rx | | | P1.01 |
| Debug UART Tx | P0.06 | P0.06 | P0.06 |
| Debug UART Rx | P0.08 | P0.08 | P0.08 |

## Baudrate

Expand Down

0 comments on commit 1cfa66c

Please sign in to comment.