Updated readme

This commit is contained in:
Christoffer Martinsson 2023-08-05 13:47:14 +02:00
parent 8c952f26ed
commit 9440c1d566

136
README.md
View File

@ -1,53 +1,80 @@
# CMDR Joystick # CMDR Joystick 24
RC Joystick with 2 hall effect gimbals and 8 buttons for use both with simulators and ELRS Rx equipped quads. RC Joystick with 2 hall effect gimbals, 2 hat switches and 24 buttons for use both with simulators and ELRS Rx equipped quads.
## Layout ## Layout
```cpp ```cpp
USB Joystick Layer 0 USB Joystick Layer 0
--------------------------------------------------------------
| FnL | B1 | | B5 | FnR |
--------------------------------------------------------------
| | B2 | B3 | MoL | | MoR | B7 | B6 | |
| |
| | B4 | | B8 | |
| | B17 | | B18 | |
| Z/RZ X/Y |
| | H1U | | H2U | |
| | H1L | H1B | H1R || H2L | H2B | H2R | |
| | H1D | | H2D | |
--------------------------------------------------------------
| B3 | | B1 | USB Joystick Layer 1 (FnL)
| Fn1 | | B2 | --------------------------------------------------------------
-------------------------------------------- | FnL | B9 | | B5 | FnR |
| | B4 | | B5 | | --------------------------------------------------------------
| | | | B10 | B11 | MoL | | MoR | B7 | B6 | |
| X1,Y1 X2,Y2 | | |
| | B6 | | B7 | | | | B12 | | B8 | |
-------------------------------------------- | | B19 | | B18 | |
| Z/RZ X/Y |
| | H3U | | H2U | |
| | H3L | H3B | H3R || H2L | H2B | H2R | |
| | H3D | | H2D | |
--------------------------------------------------------------
USB Joystick Layer 1 (Fn1) USB Joystick Layer 2 (FnR)
--------------------------------------------------------------
| FnL | B1 | | B13 | FnR |
--------------------------------------------------------------
| | B2 | B3 | MoL | | MoR | B15 | B14 | |
| |
| | B4 | | B16 | |
| | B17 | | B20 | |
| Z/RZ X(RX)/Y(RY) |
| | H1U | | H4U | |
| | H1L | H1B | H1R || H4L | H4B | H4R | |
| | H1D | | H4D | |
--------------------------------------------------------------
| Fn2 | | B1 | USB Joystick Layer 3 (FnL + FnR)
| Fn1 | | B2 | --------------------------------------------------------------
-------------------------------------------- | FnL | B9 | | B13 | FnR |
| | B8 | | B9 | | --------------------------------------------------------------
| | | | B10 | B11 | MoL | | MoR | B15 | B14 | |
| X1,Y1 X3,Y2 | | |
| | B10 | | B11 | | | | B12 | | B16 | |
-------------------------------------------- | | B19 | | B20 | |
| Z/RZ X(RX)/Y(RY) |
USB Joystick Layer 2 (Fn2) | | H3U | | H4U | |
| | H3L | H3B | H3R || H4L | H4B | H4R | |
| Fn2 | | B16 | | | H3D | | H4D | |
| Fn1 | | B17 | --------------------------------------------------------------
--------------------------------------------
| | B12 | | B13 | |
| |
| X1,Y1 X3,Y3 |
| | B14 | | B15 | |
--------------------------------------------
ELRS Layer ELRS Layer
--------------------------------------------------------------
| CH7 | CH8 | | CH9 | CH10|
--------------------------------------------------------------
| | CH11| - | CH5 | | CH6 | - | CH12| |
| |
| | - | | - | |
| | - | | - | |
| X(CH1)/Y(CH2) X(CH3)/Y(CH4) |
| | - | | - | |
| | - | - | - || - | - | - | |
| | - | | - | |
--------------------------------------------------------------
| CH6 on | | CH5 on |
| CH6 off | | CH5 off |
--------------------------------------------
| | CH7 | | CH8 | |
| |
| X,Y X,Y |
| CH1,CH2 | CH9 | | CH10 | CH3,CH4 |
--------------------------------------------
``` ```
## Features ## Features
@ -55,40 +82,29 @@ ELRS Layer
- Ergonomic design (low profile) - Ergonomic design (low profile)
- Hall effect gimbals - Hall effect gimbals
- Supports both USB HID joystick and ELRS Tx module - Supports both USB HID joystick and ELRS Tx module
- Total 6x axis and 15x buttons (using Fn mode) implemented in USB HID mode - Total 6x axis, 4x hat switches and 24x buttons (using Fn mode) implemented in USB HID mode
- 10 Channels implemented in ELRS mode (4x axis, 6x buttons) - 12 Channels implemented in ELRS mode (4x axis, 8x buttons)
- Low latency (1.6ms ELRS, 5ms USB) - Low latency (1.6ms ELRS, 10ms USB)
## Build environment ## Build environment
- Platformio - Cargo (rust embedded)
- env: teensylc - Flashing via Cargo
- platform: teensy
- board: teensylc
- framework: arduino
- Flashing via Teensy USB bootloader
- Pressing boot button on teensy - Pressing boot button on teensy
- Press and hold "top lower right button" when powering the unit - Press and hold "top lower right button" when powering the unit
## Hardware ## Hardware
- 1x TeensyLC MCU - 1x rp2040zero MCU board
- 2x FrSky M7 or M10 gimbals - 2x FrSky M7 or M10 gimbals
- 6x Kailh choc low profile switches - 6x Kailh choc low profile switches
- 2x Cherry MX switches - 6x Cherry MX switches
- 1x PCB - 2x Alpine hat switches
- 1x PCB
- 1x Bottom case - 1x Bottom case
- 1x Top plate - 1x Top plate
- 2x Gimbal spacers - 2x Hat swith top
## Calibration ## Calibration
_The button is from here reffered to "top lower left button"_ No calibration needed
1. Turn off the unit
2. Press and hold the button while powering the unit
3. Release the button and center the two gimbals
4. Press the button again
5. Move the two gimbals to it maximux X and Y
6. Press the button one mo time
7. Done!