Updated for both versions

This should now work with the newest version of QMK and be able to flash both board versions (1.0.1X and 1.1.X) with a slight modification to config.h
This commit is contained in:
Nathan Olivares 2022-11-10 21:16:06 -05:00
parent 7c2410d288
commit f1615aab52
12 changed files with 19 additions and 110 deletions

View file

@ -1,91 +0,0 @@
diff --git a/quantum/process_keycode/process_steno.c b/quantum/process_keycode/process_steno.c
index 57e279f21..de610d02e 100644
--- a/quantum/process_keycode/process_steno.c
+++ b/quantum/process_keycode/process_steno.c
@@ -61,9 +61,6 @@
static uint8_t state[MAX_STATE_SIZE] = {0};
static uint8_t chord[MAX_STATE_SIZE] = {0};
static int8_t pressed = 0;
-static steno_mode_t mode;
-
-static const uint8_t boltmap[64] PROGMEM = {TXB_NUL, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_S_L, TXB_S_L, TXB_T_L, TXB_K_L, TXB_P_L, TXB_W_L, TXB_H_L, TXB_R_L, TXB_A_L, TXB_O_L, TXB_STR, TXB_STR, TXB_NUL, TXB_NUL, TXB_NUL, TXB_STR, TXB_STR, TXB_E_R, TXB_U_R, TXB_F_R, TXB_R_R, TXB_P_R, TXB_B_R, TXB_L_R, TXB_G_R, TXB_T_R, TXB_S_R, TXB_D_R, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_NUM, TXB_Z_R};
static void steno_clear_state(void) {
memset(state, 0, sizeof(state));
@@ -81,16 +78,9 @@ static void send_steno_state(uint8_t size, bool send_empty) {
}
void steno_init() {
- if (!eeconfig_is_enabled()) {
- eeconfig_init();
- }
- mode = eeprom_read_byte(EECONFIG_STENOMODE);
}
void steno_set_mode(steno_mode_t new_mode) {
- steno_clear_state();
- mode = new_mode;
- eeprom_update_byte(EECONFIG_STENOMODE, mode);
}
/* override to intercept chords right before they get sent.
@@ -103,19 +93,9 @@ __attribute__((weak)) bool postprocess_steno_user(uint16_t keycode, keyrecord_t
__attribute__((weak)) bool process_steno_user(uint16_t keycode, keyrecord_t *record) { return true; }
static void send_steno_chord(void) {
- if (send_steno_chord_user(mode, chord)) {
- switch (mode) {
- case STENO_MODE_BOLT:
- send_steno_state(BOLT_STATE_SIZE, false);
-#ifdef VIRTSER_ENABLE
- virtser_send(0); // terminating byte
-#endif
- break;
- case STENO_MODE_GEMINI:
- chord[0] |= 0x80; // Indicate start of packet
- send_steno_state(GEMINI_STATE_SIZE, true);
- break;
- }
+ if (send_steno_chord_user(STENO_MODE_GEMINI, chord)) {
+ chord[0] |= 0x80; // Indicate start of packet
+ send_steno_state(GEMINI_STATE_SIZE, true);
}
steno_clear_state();
}
@@ -124,17 +104,6 @@ uint8_t *steno_get_state(void) { return &state[0]; }
uint8_t *steno_get_chord(void) { return &chord[0]; }
-static bool update_state_bolt(uint8_t key, bool press) {
- uint8_t boltcode = pgm_read_byte(boltmap + key);
- if (press) {
- state[TXB_GET_GROUP(boltcode)] |= boltcode;
- chord[TXB_GET_GROUP(boltcode)] |= boltcode;
- } else {
- state[TXB_GET_GROUP(boltcode)] &= ~boltcode;
- }
- return false;
-}
-
static bool update_state_gemini(uint8_t key, bool press) {
int idx = key / 7;
uint8_t bit = 1 << (6 - (key % 7));
@@ -171,16 +140,9 @@ bool process_steno(uint16_t keycode, keyrecord_t *record) {
if (!process_steno_user(keycode, record)) {
return false;
}
- switch (mode) {
- case STENO_MODE_BOLT:
- update_state_bolt(keycode - QK_STENO, IS_PRESSED(record->event));
- break;
- case STENO_MODE_GEMINI:
- update_state_gemini(keycode - QK_STENO, IS_PRESSED(record->event));
- break;
- }
+ update_state_gemini(keycode - QK_STENO, IS_PRESSED(record->event));
// allow postprocessing hooks
- if (postprocess_steno_user(keycode, record, mode, chord, pressed)) {
+ if (postprocess_steno_user(keycode, record, STENO_MODE_GEMINI, chord, pressed)) {
if (IS_PRESSED(record->event)) {
++pressed;
} else {

View file

@ -1,4 +1,4 @@
/* Copyright 2021 Nathan Olivares /* Copyright 2022 Nathan Olivares
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -19,18 +19,20 @@
/* USB Device descriptor parameter */ /* USB Device descriptor parameter */
#define VENDOR_ID 0xFEED // recommended by QMK #define VENDOR_ID 0xFEED // recommended by QMK
#define PRODUCT_ID 0x3621 #define PRODUCT_ID 0x3621
#define DEVICE_VER 0x0100 #define DEVICE_VER 0x0112
#define MANUFACTURER Noll Electronics LLC #define MANUFACTURER Noll Electronics LLC
#define PRODUCT EcoSteno #define PRODUCT Ecosteno
/* key matrix size */ /* key matrix size */
#define MATRIX_ROWS 4 #define MATRIX_ROWS 4
#define MATRIX_COLS 12 #define MATRIX_COLS 12
//#define MATRIX_COL_PINS { B15, B14, B13, B12, B11, B10, B9, B8, B7, B6, B5, B4 } // old 0.12 /* This is for the pink switched versions, 1.1.X */
#define MATRIX_COL_PINS { B15, B14, B13, B12, B1, B0, B9, B8, B7, B6, B5, B4 } // gd #define MATRIX_COL_PINS { B15, B14, B13, B12, B1, B0, B9, B6, B5, B4, B3, A15 }
//#define MATRIX_ROW_PINS { A15, B3, B1, B0 } // old 0.12 #define MATRIX_ROW_PINS { B8, B7, A7, A6 }
#define MATRIX_ROW_PINS { A15, B3, A7, A6 } // current 0.16 /* This is for the blue switched versions, 1.0.1X */
// #define MATRIX_COL_PINS { B15, B14, B13, B12, B1, B0, B9, B8, B7, B6, B5, B4 }
// #define MATRIX_ROW_PINS { A15, B3, A7, A6 }
#define DIODE_DIRECTION COL2ROW #define DIODE_DIRECTION COL2ROW
/* Set 0 if debouncing isn't needed */ /* Set 0 if debouncing isn't needed */

View file

@ -1,4 +1,4 @@
/* Copyright 2021 Nathan Olivares /* Copyright 2022 Nathan Olivares
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View file

@ -1,4 +1,4 @@
/* Copyright 2021 Nathan Olivares /* Copyright 2022 Nathan Olivares
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by

View file

@ -21,6 +21,6 @@
#pragma once #pragma once
// I don't think I need anything? // I don't think I need anything here
#include_next <halconf.h> #include_next <halconf.h>

View file

@ -1,4 +1,4 @@
/* Copyright 2021 Nathan Olivares /* Copyright 2022 Nathan Olivares
* *
* This program is free software: you can redistribute it and/or modify * This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by * it under the terms of the GNU General Public License as published by
@ -467,10 +467,7 @@ const uint16_t PROGMEM keymaps[][MATRIX_ROWS][MATRIX_COLS] = {
}; };
void matrix_init_user(void) { void matrix_init_user(void) {
steno_set_mode(STENO_MODE_BOLT); // STENO_MODE_GEMINI or STENO_MODE_BOLT // this shouldn't be needed in modern versions of QMK
//steno_set_mode(STENO_MODE_GEMINI);
// STENO_MODE_GEMINI only works if you remove references to TX Bolt in QMK
// follow ecosteno-geminipr.diff to do this (thanks to dnaq in the Plover discord)
}; };
layer_state_t layer_state_set_user(layer_state_t state) { layer_state_t layer_state_set_user(layer_state_t state) {

View file

@ -1,10 +1,10 @@
EcoSteno Ecosteno
=== ===
![EcoSteno](https://nolltronics.com/wp-content/uploads/2021/04/Noll-Steno-Front-Angle.jpg) ![Ecosteno](https://nolltronics.com/wp-content/uploads/2021/04/Noll-Steno-Front-Angle.jpg)
* Keyboard Maintainer: [Nathan Olivares](https://github.com/nkotech) * Keyboard Maintainer: [Nathan Olivares](https://github.com/nkotech)
* Hardware Supported: EcoSteno v1.0.1X and v1.0.2X * Hardware Supported: Ecosteno v1.1.X with pink switches and V1.0.1X with blue switches
* Hardware Availability: [Nolltronics](https://nolltronics.com/product/ecosteno) * Hardware Availability: [Nolltronics](https://nolltronics.com/product/ecosteno)
Make example for this keyboard (after setting up your build environment): Make example for this keyboard (after setting up your build environment):
@ -19,4 +19,4 @@ See the [build environment setup](https://docs.qmk.fm/#/getting_started_build_to
[Here's a quick video demonstrating how to flash firmware onto the ecosteno](https://youtu.be/dqeZ40PPEW4) [Here's a quick video demonstrating how to flash firmware onto the ecosteno](https://youtu.be/dqeZ40PPEW4)
The steno protocol currently included in this project is TX Bolt. I'm not entirely sure why getting Gemini PR to work isn't as simple as changing steno_set_mode(STENO_MODE_GEMINI) in keymap.c, but for now, if you want to compile ecosteno firmware that works with Gemini PR, you'll need to remove some references to TX Bolt by following ecosteno-geminipr.diff in EcoSteno-Firmware/keyboards/noll/ (thanks to dnaq in the Plover discord). V1.1.X and V1.0.1X have different pinouts, but the only file this affects is config.h . It's set up to work with the newer 1.1.X boards, but all you have to do to build firmware for 1.0.1X boards is comment out the MATRIX_COL_PINS and MATRIX_ROW_PINS for the 1.1.X and uncomment the lines for the 1.0.1X.

View file

@ -16,4 +16,5 @@ SLEEP_LED_ENABLE = yes # Breathing sleep LED during USB suspend
NKRO_ENABLE = yes # USB Nkey Rollover NKRO_ENABLE = yes # USB Nkey Rollover
COMBO_ENABLE = yes # Enable Key Combos COMBO_ENABLE = yes # Enable Key Combos
STENO_ENABLE = yes # Stenography keys STENO_ENABLE = yes # Stenography keys
STENO_PROTOCOL = geminipr # Can be geminipr or txbolt
MOUSEKEY_ENABLE = no # Mouse keys MOUSEKEY_ENABLE = no # Mouse keys