Nulo/qmk_firmware
1
0
Fork 0
Code Releases Activity

[Keyboard] Update Tractyl Manuform config for F411 (#14770)

Browse source
This commit is contained in:
Drashna Jaelre 2021-10-09 11:31:13 -07:00 committed by GitHub
parent f90d8b35f2
commit 82bf688e44
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 58 additions and 169 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
keyboards/handwired/tractyl_manuform/5x6_right/f411/config.h
View file

@ -31,22 +31,23 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
#define DIODE_DIRECTION COL2ROW #define DIODE_DIRECTION COL2ROW
#define USB_VBUS_PIN B10 // #define USB_VBUS_PIN B10 // doesn't seem to work for me on one of my controllers... */
#define SPLIT_HAND_PIN C14 // high = left, low = right #define SPLIT_HAND_PIN C14 // high = left, low = right
// WS2812 RGB LED strip input and number of LEDs // WS2812 RGB LED strip input and number of LEDs
#define RGB_DI_PIN A1 #define RGB_DI_PIN A1
#define WS2812_PWM_DRIVER PWMD5 // default: PWMD2 #define WS2812_PWM_DRIVER PWMD2 // default: PWMD2
#define WS2812_PWM_CHANNEL 2 // default: 2 #define WS2812_PWM_CHANNEL 2 // default: 2
#define WS2812_PWM_PAL_MODE 2 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2 #define WS2812_PWM_PAL_MODE 1 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2
//#define WS2812_PWM_COMPLEMENTARY_OUTPUT // Define for a complementary timer output (TIMx_CHyN); omit for a normal timer output (TIMx_CHy). //#define WS2812_PWM_COMPLEMENTARY_OUTPUT // Define for a complementary timer output (TIMx_CHyN); omit for a normal timer output (TIMx_CHy).
#define WS2812_DMA_STREAM STM32_DMA1_STREAM0 // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. #define WS2812_DMA_STREAM STM32_DMA1_STREAM7 // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU.
#define WS2812_DMA_CHANNEL 6 // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. #define WS2812_DMA_CHANNEL 3 // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU.
#define RGBLED_NUM 20 #define RGBLED_NUM 20
#define RGBLIGHT_SPLIT #define RGBLIGHT_SPLIT
#define RGBLED_SPLIT \ #define RGBLED_SPLIT \
{ 10, 10 } { 10, 10 }
#define RGBLIGHT_LIMIT_VAL 80
#define DEBUG_LED_PIN C13 #define DEBUG_LED_PIN C13
@ -68,13 +69,14 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
/* i2c config for oleds */ /* i2c config for oleds */
#define I2C_DRIVER I2CD1 #define I2C_DRIVER I2CD1
#define I2C1_SCL_BANK GPIOB #define I2C1_SCL_PIN B8
#define I2C1_SDA_BANK GPIOB #define I2C1_SDA_PIN B9
#define I2C1_SCL 8
#define I2C1_SDA 9
#define I2C1_SCL_PAL_MODE 4 #define I2C1_SCL_PAL_MODE 4
#define I2C1_SDA_PAL_MODE 4 #define I2C1_SDA_PAL_MODE 4
#define I2C1_CLOCK_SPEED 400000 // #define I2C1_CLOCK_SPEED 400000
/* For Legacy Compatibility: */
#define I2C1_SCL 8
#define I2C1_SDA 9
/* encoder config */ /* encoder config */
#define ENCODERS_PAD_A \ #define ENCODERS_PAD_A \
@ -93,7 +95,7 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
/* eeprom config */ /* eeprom config */
#define EXTERNAL_EEPROM_SPI_SLAVE_SELECT_PIN A4 #define EXTERNAL_EEPROM_SPI_SLAVE_SELECT_PIN A4
#define EXTERNAL_EEPROM_SPI_CLOCK_DIVISOR 8 #define EXTERNAL_EEPROM_SPI_CLOCK_DIVISOR 64
// #define EXTERNAL_EEPROM_BYTE_COUNT 8196 // #define EXTERNAL_EEPROM_BYTE_COUNT 8196
// #define EXTERNAL_EEPROM_PAGE_SIZE 32 // #define EXTERNAL_EEPROM_PAGE_SIZE 32
// #define EXTERNAL_EEPROM_ADDRESS_SIZE 2 // #define EXTERNAL_EEPROM_ADDRESS_SIZE 2
@ -102,4 +104,4 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
/* pmw3360 config */ /* pmw3360 config */
#define PMW3360_CS_PIN B0 #define PMW3360_CS_PIN B0
#define PMW3360_SPI_MODE 3 #define PMW3360_SPI_MODE 3
#define PMW3360_SPI_DIVISOR 4 #define PMW3360_SPI_DIVISOR 64

2
keyboards/handwired/tractyl_manuform/5x6_right/f411/f411.c
View file

@ -24,8 +24,10 @@ void matrix_scan_sub_kb(void) {
} }
} }
#ifdef USB_VBUS_PIN
bool usb_vbus_state(void) { bool usb_vbus_state(void) {
setPinInputLow(USB_VBUS_PIN); setPinInputLow(USB_VBUS_PIN);
wait_us(5); wait_us(5);
return readPin(USB_VBUS_PIN); return readPin(USB_VBUS_PIN);
} }
#endif

22
keyboards/handwired/tractyl_manuform/5x6_right/f411/mcuconf.h
View file

@ -21,8 +21,13 @@
#undef STM32_I2C_USE_I2C1 #undef STM32_I2C_USE_I2C1
#define STM32_I2C_USE_I2C1 TRUE #define STM32_I2C_USE_I2C1 TRUE
#undef STM32_PWM_USE_TIM5 #undef STM32_I2C_I2C1_RX_DMA_STREAM
#define STM32_PWM_USE_TIM5 TRUE #define STM32_I2C_I2C1_RX_DMA_STREAM STM32_DMA_STREAM_ID(1, 0)
#undef STM32_I2C_I2C1_TX_DMA_STREAM
#define STM32_I2C_I2C1_TX_DMA_STREAM STM32_DMA_STREAM_ID(1, 1)
#undef STM32_PWM_USE_TIM2
#define STM32_PWM_USE_TIM2 TRUE
#undef STM32_PWM_USE_TIM3 #undef STM32_PWM_USE_TIM3
#define STM32_PWM_USE_TIM3 TRUE #define STM32_PWM_USE_TIM3 TRUE
@ -30,8 +35,21 @@
#undef STM32_SPI_USE_SPI1 #undef STM32_SPI_USE_SPI1
#define STM32_SPI_USE_SPI1 TRUE #define STM32_SPI_USE_SPI1 TRUE
#undef STM32_SPI_SPI1_RX_DMA_STREAM
#define STM32_SPI_SPI1_RX_DMA_STREAM STM32_DMA_STREAM_ID(2, 0)
#undef STM32_SPI_SPI1_TX_DMA_STREAM
#define STM32_SPI_SPI1_TX_DMA_STREAM STM32_DMA_STREAM_ID(2, 3)
#undef STM32_SERIAL_USE_USART2 #undef STM32_SERIAL_USE_USART2
#define STM32_SERIAL_USE_USART2 TRUE #define STM32_SERIAL_USE_USART2 TRUE
#undef STM32_UART_USART2_RX_DMA_STREAM
#define STM32_UART_USART2_RX_DMA_STREAM STM32_DMA_STREAM_ID(1, 5)
#undef STM32_UART_USART2_TX_DMA_STREAM
#define STM32_UART_USART2_TX_DMA_STREAM STM32_DMA_STREAM_ID(1, 6)
#undef STM32_GPT_USE_TIM4 #undef STM32_GPT_USE_TIM4
#define STM32_GPT_USE_TIM4 TRUE #define STM32_GPT_USE_TIM4 TRUE
#undef STM32_ST_USE_TIMER
#define STM32_ST_USE_TIMER 5

5
keyboards/handwired/tractyl_manuform/5x6_right/f411/readme.md
View file

@ -4,11 +4,12 @@
* Split Hand Pin, using PC14 * Split Hand Pin, using PC14
* Full Duplex Serial/USART using PA3 and PA4 on USART2 * Full Duplex Serial/USART using PA3 and PA4 on USART2
* PWM Audio using PB1 and TIM3 and GPT on TIM4 * PWM Audio using PB1 and TIM3 and GPT on TIM4
* PWM RGB using PA1 TIM5 * PWM RGB using PA1 TIM2
* pmw3360 sensor sharing PA5-PA7 on SPI1, with B0 as CS pin * pmw3360 sensor sharing PA5-PA7 on SPI1, with B0 as CS pin
* 8KB SPI EEPROM chip sharing PA5-PA7 on SPI1 with PA4 as CS pin * 8KB SPI EEPROM chip sharing PA5-PA7 on SPI1 with PA4 as CS pin
* Encoder using PA10 and PA12 * Encoder using PA13 and PA14
* SSD1306 OLED display (128x64) using PB8-PB9 on I2C1 * SSD1306 OLED display (128x64) using PB8-PB9 on I2C1
* Pull-up resistor (22k) on A10 to fix reset issue.
* Keyboard Maintainer: [Drashna Jael're](https://github.com/drashna) * Keyboard Maintainer: [Drashna Jael're](https://github.com/drashna)
* Hardware Supported: [Design files](https://gitlab.com/keyboards1/dm_r_track/-/tree/master/boolean), [WeAct BlackPill (F411)](https://github.com/WeActTC/MiniSTM32F4x1), [PMW3360 Optical Sensor](https://www.tindie.com/products/jkicklighter/pmw3360-motion-sensor/) * Hardware Supported: [Design files](https://gitlab.com/keyboards1/dm_r_track/-/tree/master/boolean), [WeAct BlackPill (F411)](https://github.com/WeActTC/MiniSTM32F4x1), [PMW3360 Optical Sensor](https://www.tindie.com/products/jkicklighter/pmw3360-motion-sensor/)

6
keyboards/handwired/tractyl_manuform/5x6_right/keymaps/drashna/keymap.c
View file

@ -117,8 +117,8 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
[_ADJUST] = LAYOUT_5x6_right_wrapper( [_ADJUST] = LAYOUT_5x6_right_wrapper(
KC_MAKE, ___________________BLANK___________________, _________________ADJUST_R1_________________, KC_RST, KC_MAKE, ___________________BLANK___________________, _________________ADJUST_R1_________________, KC_RST,
VRSN, _________________ADJUST_L1_________________, _________________ADJUST_R1_________________, EEP_RST, VRSN, _________________ADJUST_L1_________________, _________________ADJUST_R1_________________, EEP_RST,
UC_MOD, _________________ADJUST_L2_________________, _________________ADJUST_R2_________________, TG_MODS, _______, _________________ADJUST_L2_________________, _________________ADJUST_R2_________________, TG_MODS,
_______, _________________ADJUST_L3_________________, _________________ADJUST_R3_________________, KC_MPLY, UC_MOD, _________________ADJUST_L3_________________, _________________ADJUST_R3_________________, KC_MPLY,
HPT_DWLI, HPT_DWLD, TG_GAME, TG_DBLO, HPT_DWLI, HPT_DWLD, TG_GAME, TG_DBLO,
HPT_TOG, HPT_BUZ, KC_NUKE, HPT_TOG, HPT_BUZ, KC_NUKE,
_______, _______, _______, _______, _______, _______,
@ -350,7 +350,7 @@ void render_kitty(void) {
// assumes 1 frame prep stage // assumes 1 frame prep stage
extern bool swap_hands; extern bool swap_hands;
void animation_phase(void) { void animation_phase(void) {
if (swap_hands) { if (tap_toggling) {
anim_frame_duration = 300; anim_frame_duration = 300;
current_rtogi_frame = (current_rtogi_frame + 1) % RTOGI_FRAMES; current_rtogi_frame = (current_rtogi_frame + 1) % RTOGI_FRAMES;
oled_write_raw_P(rtogi[abs((RTOGI_FRAMES - 1) - current_rtogi_frame)], ANIM_SIZE); oled_write_raw_P(rtogi[abs((RTOGI_FRAMES - 1) - current_rtogi_frame)], ANIM_SIZE);

164
keyboards/handwired/tractyl_manuform/readme.md
View file

@ -1,159 +1,25 @@
Dactyl Manuform (4x5, 5x6, 5x7, 6x6) # Tractyl Manuform (4x6, 5x6)
======
the [Dactyl-Manuform](https://github.com/tshort/dactyl-keyboard) is a split curved keyboard based on the design of [adereth dactyl](https://github.com/adereth/dactyl-keyboard) and thumb cluster design of the [manuform](https://geekhack.org/index.php?topic=46015.0) keyboard, the hardware is similar to the let's split keyboard. all information needed for making one is in the first link. the [Dactyl-Manuform](https://github.com/tshort/dactyl-keyboard) is a split curved keyboard based on the design of [adereth dactyl](https://github.com/adereth/dactyl-keyboard) and thumb cluster design of the [manuform](https://geekhack.org/index.php?topic=46015.0) keyboard, the hardware is similar to the let's split keyboard. all information needed for making one is in the first link.
![Imgur](https://i.imgur.com/7y0Vbyd.jpg) ![Imgur](https://i.imgur.com/kDNVTI4l.jpeg)
* Keyboard Maintainer: [drashna](https://github.com/drashna)
* Hardware Supported: Teensy 2.0++, WeAct BlackPill F411
## First Time Setup Make example for this keyboard (after setting up your build environment):
Download or clone the `qmk_firmware` repo and navigate to its top level directory. Once your build environment is setup, you'll be able to generate the default .hex using: make handwired/tractyl_manuform/5x6_right/f411/drashna:default
Depending on your Layout chose one of the follwing commands: Flashing example for this keyboard:
``` make handwired/tractyl_manuform/5x6_right/f411/drashna:default:flash
$ make handwired/dactyl_manuform/YOUR_LAYOUT:YOUR_KEYMAP_NAME
```
example: See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) and the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information. Brand new to QMK? Start with our [Complete Newbs Guide](https://docs.qmk.fm/#/newbs).
```
$ make handwired/dactyl_manuform/4x5:default
```
If everything worked correctly you will see a file: ## Bootloader
``` Enter the bootloader in 3 ways:
dactyl_manuform_YOUR_LAYOUT_YOUR_KEYMAP_NAME.hex
```
For more information on customizing keymaps, take a look at the primary documentation for [Customizing Your Keymap](/docs/faq_keymap.md) in the main readme.md. * **Bootmagic reset**: Hold down the key at (0,0) in the matrix (usually the top left key or Escape) and plug in the keyboard
* **Physical reset button**: Briefly press the button on the back of the PCB - some may have pads you must short instead
* **Keycode in layout**: Press the key mapped to `RESET` if it is available
## Keymaps
### [Keymaps 4x5](/keyboards/handwired/dactyl_manuform/4x5/keymaps/)
#### Default
Simple QWERTY layout with 3 Layers.
#### Dvorak
### [Keymaps 5x6](/keyboards/handwired/dactyl_manuform/5x6/keymaps/)
#### Default
Just a copy of the Impstyle keymap. Feel free to adjust it.
#### Impstyle
A simple QWERTY keymap with 3 Layers. Both sides are connected via serial and the Left ist the master.
### [Keymaps 5x7 aka almost Ergodox](/keyboards/handwired/dactyl_manuform/5x7/keymaps/)
#### Default
Keymap of Loligagger from geekhack.
### [Keymaps 6x6](/keyboards/handwired/dactyl_manuform/6x6/keymaps/)
#### Default
Simple QWERTY layout with 3 Layers.
## Required Hardware
Apart from diodes and key switches for the keyboard matrix in each half, you
will need:
* 2 Arduino Pro Micros. You can find these on AliExpress for ≈3.50USD each.
* 2 TRRS sockets and 1 TRRS cable, or 2 TRS sockets and 1 TRS cable
Alternatively, you can use any sort of cable and socket that has at least 3
wires. If you want to use I2C to communicate between halves, you will need a
cable with at least 4 wires and 2x 4.7kΩ pull-up resistors
## Optional Hardware
A speaker can be hooked-up to either side to the `5` (`C6`) pin and `GND`, and turned on via `AUDIO_ENABLE`.
## Wiring
The 3 wires of the TRS/TRRS cable need to connect GND, VCC, and digital pin 3 (i.e.
PD0 on the ATmega32u4) between the two Pro Micros.
Next, wire your key matrix to any of the remaining 17 IO pins of the pro micro
and modify the `matrix.c` accordingly.
The wiring for serial:
![serial wiring](https://i.imgur.com/C3D1GAQ.png)
The wiring for i2c:
![i2c wiring](https://i.imgur.com/Hbzhc6E.png)
The pull-up resistors may be placed on either half. It is also possible
to use 4 resistors and have the pull-ups in both halves, but this is
unnecessary in simple use cases.
You can change your configuration between serial and i2c by modifying your `config.h` file.
## Notes on Software Configuration
the keymaps in here are for the 4x5 layout of the keyboard only.
## Flashing
To flash your firmware take a look at: [Flashing Instructions and Bootloader Information](https://docs.qmk.fm/#/flashing)
## Choosing which board to plug the USB cable into (choosing Master)
Because the two boards are identical, the firmware has logic to differentiate the left and right board.
It uses two strategies to figure things out: looking at the EEPROM (memory on the chip) or looking if the current board has the usb cable.
The EEPROM approach requires additional setup (flashing the eeprom) but allows you to swap the usb cable to either side.
The USB cable approach is easier to setup and if you just want the usb cable on the left board, you do not need to do anything extra.
### Setting the left hand as master
If you always plug the usb cable into the left board, nothing extra is needed as this is the default. Comment out `EE_HANDS` and comment out `I2C_MASTER_RIGHT` or `MASTER_RIGHT` if for some reason it was set.
### Setting the right hand as master
If you always plug the usb cable into the right board, add an extra flag to your `config.h`
```
#define MASTER_RIGHT
```
### Setting EE_hands to use either hands as master
If you define `EE_HANDS` in your `config.h`, you will need to set the
EEPROM for the left and right halves.
The EEPROM is used to store whether the
half is left handed or right handed. This makes it so that the same firmware
file will run on both hands instead of having to flash left and right handed
versions of the firmware to each half. To flash the EEPROM file for the left
half run:
```
make handwired/dactyl_promicro:default:dfu-split-left
make handwired/dactyl_promicro:default:dfu-split-right
```
After you have flashed the EEPROM, you then need to set `EE_HANDS` in your config.h, rebuild the hex files and reflash.
Note that you need to program both halves, but you have the option of using
different keymaps for each half. You could program the left half with a QWERTY
layout and the right half with a Colemak layout using bootmagic's default layout option.
Then if you connect the left half to a computer by USB the keyboard will use QWERTY and Colemak when the
right half is connected.
Notes on Using Pro Micro 3.3V
-----------------------------
Do update the `F_CPU` parameter in `rules.mk` to `8000000` which reflects
the frequency on the 3.3V board.
Also, if the slave board is producing weird characters in certain columns,
update the following line in `matrix.c` to the following:
```
// wait_us(30); // without this wait read unstable value.
wait_us(300); // without this wait read unstable value.
```