mirror of
https://github.com/qmk/qmk_userspace.git
synced 2025-11-03 10:20:07 -05:00
Add QMK configuration and flashing documentation for fingerpunch/sweeeeep keyboard
- Created CONFIG_HIERARCHY.md to explain configuration file hierarchy and settings placement. - Added FLASH_HANDEDNESS.md detailing the flashing process for split keyboard handedness using Liatris controllers. - Introduced LIATRIS_QUICK_START.txt as a quick reference for handedness setup and flashing steps. - Included LICENSE file for GNU General Public License v2. - Added Makefile for building QMK firmware with user-specific configurations. - Updated README.md with instructions for configuring and building QMK userspace. - Created build_all.sh script to automate the building of regular and handedness initialization firmware. - Added qmk.json to define userspace version and build targets.
This commit is contained in:
parent
a26527d2ae
commit
63991df09d
13 changed files with 1062 additions and 29 deletions
124
root_files_backup/BUILD_GUIDE.md
Normal file
124
root_files_backup/BUILD_GUIDE.md
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
# QMK Firmware Build Guide for Fingerpunch Sweeeeep
|
||||
|
||||
This guide explains how to build and flash firmware for your split keyboard with EE_HANDS.
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Build All Firmware Files
|
||||
|
||||
```bash
|
||||
./build_all.sh
|
||||
```
|
||||
|
||||
This creates three files:
|
||||
- `fingerpunch_sweeeeep_smathev.uf2` - Regular firmware
|
||||
- `fingerpunch_sweeeeep_smathev_LEFT.uf2` - LEFT hand initialization
|
||||
- `fingerpunch_sweeeeep_smathev_RIGHT.uf2` - RIGHT hand initialization
|
||||
|
||||
## First-Time Setup (One-Time Only)
|
||||
|
||||
You only need to do this ONCE to set the handedness in EEPROM:
|
||||
|
||||
1. **Initialize LEFT keyboard half:**
|
||||
- Unplug both halves
|
||||
- Plug in the LEFT half
|
||||
- Double-tap RESET button on Liatris controller
|
||||
- Drag `fingerpunch_sweeeeep_smathev_LEFT.uf2` to the RPI-RP2 drive
|
||||
- Wait for it to disconnect/reconnect
|
||||
|
||||
2. **Initialize RIGHT keyboard half:**
|
||||
- Unplug both halves
|
||||
- Plug in the RIGHT half
|
||||
- Double-tap RESET button on Liatris controller
|
||||
- Drag `fingerpunch_sweeeeep_smathev_RIGHT.uf2` to the RPI-RP2 drive
|
||||
- Wait for it to disconnect/reconnect
|
||||
|
||||
3. **Test:** Plug either half in via USB - keys should work correctly regardless of which side is plugged in!
|
||||
|
||||
## Regular Firmware Updates
|
||||
|
||||
After handedness is initialized, use the regular firmware for all future updates:
|
||||
|
||||
1. **Flash regular firmware to BOTH halves:**
|
||||
- Double-tap RESET on each half
|
||||
- Drag `fingerpunch_sweeeeep_smathev.uf2` to each
|
||||
|
||||
2. **Handedness is preserved:** The EEPROM remembers which half is which, so you don't need the `_LEFT` or `_RIGHT` files anymore (unless you want to change handedness).
|
||||
|
||||
## How It Works
|
||||
|
||||
### EE_HANDS (EEPROM Handedness)
|
||||
|
||||
- Each keyboard half stores its identity (LEFT or RIGHT) in EEPROM
|
||||
- The handedness firmware (`_LEFT.uf2` and `_RIGHT.uf2`) initializes this EEPROM value on first flash
|
||||
- After initialization, either half can be plugged in as master
|
||||
- Regular firmware preserves the EEPROM handedness value
|
||||
|
||||
### Build Process
|
||||
|
||||
The `build_all.sh` script:
|
||||
|
||||
1. **Regular firmware:** Builds with `EE_HANDS` defined
|
||||
2. **LEFT firmware:** Temporarily adds `INIT_EE_HANDS_LEFT` to config.h and builds
|
||||
3. **RIGHT firmware:** Temporarily adds `INIT_EE_HANDS_RIGHT` to config.h and builds
|
||||
4. **Restores:** Original config.h is restored after builds
|
||||
|
||||
The `INIT_EE_HANDS_LEFT/RIGHT` defines tell QMK to write the handedness to EEPROM on boot.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Keys are backwards when plugging in one side
|
||||
|
||||
- You probably flashed the wrong `_LEFT` or `_RIGHT` file to the wrong keyboard half
|
||||
- Solution: Re-flash with the correct handedness files
|
||||
|
||||
### Master side always seems to be the same regardless of which I plug in
|
||||
|
||||
- The `EE_HANDS` setting may not be properly configured
|
||||
- Check that `config.h` has `#define EE_HANDS` (not `MASTER_LEFT` or `MASTER_RIGHT`)
|
||||
- Rebuild and reflash handedness files
|
||||
|
||||
### How do I reset/change handedness?
|
||||
|
||||
- Simply flash the opposite handedness firmware to swap a keyboard half's identity
|
||||
- Example: Flash `_RIGHT.uf2` to what was previously the LEFT half
|
||||
|
||||
## File Structure
|
||||
|
||||
```
|
||||
qmk_userspace/
|
||||
├── build_all.sh # Main build script (builds all 3 files)
|
||||
├── build_handedness_manual.sh # Legacy handedness-only builder
|
||||
├── fingerpunch_sweeeeep_smathev.uf2 # Regular firmware
|
||||
├── fingerpunch_sweeeeep_smathev_LEFT.uf2 # LEFT initialization
|
||||
├── fingerpunch_sweeeeep_smathev_RIGHT.uf2# RIGHT initialization
|
||||
├── keyboards/
|
||||
│ └── fingerpunch/
|
||||
│ └── sweeeeep/
|
||||
│ └── keymaps/
|
||||
│ └── smathev/
|
||||
│ ├── config.h # Keyboard-specific config (EE_HANDS)
|
||||
│ └── keymap.c # Your keymap
|
||||
└── users/
|
||||
└── smathev/
|
||||
├── config.h # Userspace config
|
||||
├── combos.c/h # Combo definitions
|
||||
└── ...
|
||||
```
|
||||
|
||||
## Additional Notes
|
||||
|
||||
### Liatris Controller
|
||||
|
||||
- The Liatris uses RP2040 (same as Raspberry Pi Pico)
|
||||
- Firmware files are `.uf2` format
|
||||
- Double-tap RESET to enter bootloader mode (appears as RPI-RP2 drive)
|
||||
- No need for QMK Toolbox - just drag and drop files
|
||||
|
||||
### Configuration Hierarchy
|
||||
|
||||
1. **users/smathev/config.h** - User preferences (applies to all keyboards)
|
||||
2. **keyboards/.../keymaps/smathev/config.h** - Keyboard-specific overrides
|
||||
3. **Keyboard defaults** - Base keyboard configuration
|
||||
|
||||
The `EE_HANDS` setting is in the keyboard-specific config because it's hardware-dependent.
|
||||
122
root_files_backup/CONFIG_HIERARCHY.md
Normal file
122
root_files_backup/CONFIG_HIERARCHY.md
Normal file
|
|
@ -0,0 +1,122 @@
|
|||
# QMK Configuration Hierarchy
|
||||
|
||||
Understanding where to put your settings in QMK userspace.
|
||||
|
||||
## Configuration Priority (Highest to Lowest)
|
||||
|
||||
```
|
||||
1. keyboards/.../keymaps/smathev/config.h ← HIGHEST PRIORITY (keyboard-specific)
|
||||
↓ overrides
|
||||
2. users/smathev/config.h ← USER DEFAULTS (all keyboards)
|
||||
↓ overrides
|
||||
3. keyboards/.../config.h ← KEYBOARD DEFAULTS
|
||||
↓ overrides
|
||||
4. QMK defaults ← LOWEST PRIORITY
|
||||
```
|
||||
|
||||
## Your Current Setup
|
||||
|
||||
### 📁 `users/smathev/config.h`
|
||||
**Purpose:** Settings that apply to ALL your keyboards
|
||||
|
||||
**What belongs here:**
|
||||
- ✅ Tapping terms (`TAPPING_TERM`, `PERMISSIVE_HOLD`)
|
||||
- ✅ Auto-shift settings (`AUTO_SHIFT_TIMEOUT`, `RETRO_SHIFT`)
|
||||
- ✅ Combo preferences (`COMBO_REF_DEFAULT`)
|
||||
- ✅ Personal preferences that don't change between keyboards
|
||||
- ✅ Layout aliases (`LAYOUT_sweeeeep`)
|
||||
|
||||
**Example:**
|
||||
```c
|
||||
#define TAPPING_TERM 140
|
||||
#define PERMISSIVE_HOLD
|
||||
#define CASEMODES_ENABLE
|
||||
```
|
||||
|
||||
### 📁 `keyboards/fingerpunch/sweeeeep/keymaps/smathev/config.h`
|
||||
**Purpose:** Settings specific to THIS keyboard/keymap
|
||||
|
||||
**What belongs here:**
|
||||
- ✅ Split keyboard settings (`EE_HANDS`, `SPLIT_USB_DETECT`)
|
||||
- ✅ Hardware-specific features (`OLED_FONT_H`)
|
||||
- ✅ Keyboard-specific overrides
|
||||
- ✅ Split communication settings
|
||||
|
||||
**Example:**
|
||||
```c
|
||||
#define EE_HANDS
|
||||
#define SPLIT_USB_DETECT
|
||||
#define OLED_FONT_H "path/to/font.c"
|
||||
```
|
||||
|
||||
## Why This Matters
|
||||
|
||||
### ❌ Wrong Approach:
|
||||
Putting everything in `users/smathev/config.h`
|
||||
- Split keyboard settings affect non-split keyboards
|
||||
- OLED settings break keyboards without OLED
|
||||
- Hardware-specific settings cause conflicts
|
||||
|
||||
### ✅ Correct Approach:
|
||||
- **Userspace (`users/`)**: Personal preferences that work everywhere
|
||||
- **Keymap (`keymaps/`)**: Keyboard-specific hardware and features
|
||||
|
||||
## Common Settings Placement
|
||||
|
||||
| Setting | Location | Reason |
|
||||
|---------|----------|--------|
|
||||
| `TAPPING_TERM` | `users/` | Personal preference |
|
||||
| `EE_HANDS` | `keymaps/` | Split keyboard specific |
|
||||
| `OLED_FONT_H` | `keymaps/` | Hardware specific |
|
||||
| `COMBO_REF_DEFAULT` | `users/` | User preference |
|
||||
| `SPLIT_USB_DETECT` | `keymaps/` | Split keyboard specific |
|
||||
| `AUTO_SHIFT_TIMEOUT` | `users/` | Personal preference |
|
||||
| `PERMISSIVE_HOLD` | `users/` | Personal preference |
|
||||
|
||||
## Your Configuration Files
|
||||
|
||||
### Current Structure:
|
||||
```
|
||||
qmk_userspace/
|
||||
├── users/smathev/
|
||||
│ ├── config.h ← User-wide settings
|
||||
│ ├── rules.mk ← User-wide features
|
||||
│ ├── combos.c/h
|
||||
│ └── ...
|
||||
└── keyboards/
|
||||
└── fingerpunch/sweeeeep/
|
||||
└── keymaps/smathev/
|
||||
├── config.h ← Keyboard-specific settings (EE_HANDS here!)
|
||||
├── keymap.c
|
||||
└── keymap.json
|
||||
```
|
||||
|
||||
## Testing Your Configuration
|
||||
|
||||
```bash
|
||||
# Compile to see if settings are applied correctly
|
||||
qmk compile -kb fingerpunch/sweeeeep -km smathev
|
||||
|
||||
# Check for configuration conflicts in warnings
|
||||
qmk compile -kb fingerpunch/sweeeeep -km smathev 2>&1 | grep "config.h"
|
||||
```
|
||||
|
||||
## Pro Tips
|
||||
|
||||
💡 **Use Comments:** Clearly mark which config file is for what purpose
|
||||
|
||||
💡 **Test on Multiple Keyboards:** If you add more keyboards, userspace settings will automatically apply
|
||||
|
||||
💡 **Override When Needed:** Keymap config.h can override userspace defaults
|
||||
|
||||
💡 **Keep It DRY:** Don't repeat settings - put them in the most appropriate place
|
||||
|
||||
## If You Add More Keyboards
|
||||
|
||||
When you add another keyboard (e.g., a 60% board):
|
||||
|
||||
1. **User settings automatically apply** (tapping, combos, etc.)
|
||||
2. **Create keyboard-specific config.h** only for that keyboard's unique needs
|
||||
3. **Split settings don't affect** your non-split boards
|
||||
|
||||
This is the power of QMK userspace! 🚀
|
||||
163
root_files_backup/FLASH_HANDEDNESS.md
Normal file
163
root_files_backup/FLASH_HANDEDNESS.md
Normal file
|
|
@ -0,0 +1,163 @@
|
|||
# Flashing Split Keyboard Handedness (EE_HANDS)
|
||||
|
||||
Your fingerpunch/sweeeeep keyboard with **Liatris controllers** uses `EE_HANDS` for split keyboard handedness detection. This means each half needs to be flashed with its handedness information stored in EEPROM.
|
||||
|
||||
> **Note:** The Liatris is an RP2040-based Pro Micro replacement controller. It uses `.uf2` files and bootloader mode for flashing.
|
||||
|
||||
## Visual Guide
|
||||
|
||||
```
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ STEP 1: Build handedness firmware files │
|
||||
│ $ ./build_handedness.sh │
|
||||
│ → Creates _LEFT.uf2 and _RIGHT.uf2 │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
↓
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ STEP 2: Flash LEFT half │
|
||||
│ 1. Unplug both halves │
|
||||
│ 2. Plug in LEFT half │
|
||||
│ 3. Double-tap RESET button on Liatris │
|
||||
│ 4. Drag _LEFT.uf2 to RPI-RP2 drive │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
↓
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ STEP 3: Flash RIGHT half │
|
||||
│ 1. Unplug both halves │
|
||||
│ 2. Plug in RIGHT half │
|
||||
│ 3. Double-tap RESET button on Liatris │
|
||||
│ 4. Drag _RIGHT.uf2 to RPI-RP2 drive │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
↓
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ STEP 4: Test │
|
||||
│ • Test each half independently (plug in solo) │
|
||||
│ • Both halves should work when connected │
|
||||
│ • If one acts wrong, re-flash that specific half │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
```
|
||||
|
||||
## Quick Reference
|
||||
|
||||
### Build Commands
|
||||
|
||||
```bash
|
||||
# Build LEFT hand firmware with EEPROM handedness
|
||||
qmk compile -kb fingerpunch/sweeeeep -km smathev -e INIT_EE_HANDS_LEFT=yes
|
||||
|
||||
# Build RIGHT hand firmware with EEPROM handedness
|
||||
qmk compile -kb fingerpunch/sweeeeep -km smathev -e INIT_EE_HANDS_RIGHT=yes
|
||||
```
|
||||
|
||||
### Generated Files
|
||||
|
||||
After building, you'll have:
|
||||
- `fingerpunch_sweeeeep_smathev.uf2` - The most recent build (left OR right)
|
||||
- Copy this immediately after building to preserve it!
|
||||
|
||||
### Recommended Workflow
|
||||
|
||||
```bash
|
||||
cd /home/smathev/git_dev/keyboards/qmk_userspace
|
||||
|
||||
# Build and save LEFT hand
|
||||
qmk compile -kb fingerpunch/sweeeeep -km smathev -e INIT_EE_HANDS_LEFT=yes
|
||||
cp fingerpunch_sweeeeep_smathev.uf2 fingerpunch_sweeeeep_smathev_LEFT.uf2
|
||||
|
||||
# Build and save RIGHT hand
|
||||
qmk compile -kb fingerpunch/sweeeeep -km smathev -e INIT_EE_HANDS_RIGHT=yes
|
||||
cp fingerpunch_sweeeeep_smathev.uf2 fingerpunch_sweeeeep_smathev_RIGHT.uf2
|
||||
|
||||
# Now you have both files ready to flash
|
||||
ls -lh fingerpunch_sweeeeep_smathev_*.uf2
|
||||
```
|
||||
|
||||
## Flashing Instructions
|
||||
|
||||
### For Liatris Controllers (RP2040-based):
|
||||
|
||||
The **Liatris** has a **RESET button** (small button on the controller). To enter bootloader mode:
|
||||
|
||||
#### Method 1: Double-tap Reset (Recommended)
|
||||
1. **Left Half:**
|
||||
- Unplug both halves
|
||||
- Plug in LEFT half
|
||||
- **Quickly double-tap the RESET button** on the Liatris controller
|
||||
- The controller will appear as a USB drive named `RPI-RP2`
|
||||
- Copy/drag `fingerpunch_sweeeeep_smathev_LEFT.uf2` to the `RPI-RP2` drive
|
||||
- The board will reboot automatically and disappear
|
||||
|
||||
2. **Right Half:**
|
||||
- Unplug both halves
|
||||
- Plug in RIGHT half
|
||||
- **Quickly double-tap the RESET button** on the Liatris controller
|
||||
- The controller will appear as a USB drive named `RPI-RP2`
|
||||
- Copy/drag `fingerpunch_sweeeeep_smathev_RIGHT.uf2` to the `RPI-RP2` drive
|
||||
- The board will reboot automatically and disappear
|
||||
|
||||
#### Method 2: Hold Boot + Plug In
|
||||
1. If double-tap doesn't work, you can hold the BOOT button while plugging in the USB cable
|
||||
2. The Liatris has a small BOOT button - check the controller PCB for its location
|
||||
|
||||
> **💡 Tip:** If the `RPI-RP2` drive doesn't appear, try:
|
||||
> - Double-tapping faster or slower
|
||||
> - Using a different USB cable/port
|
||||
> - Checking that the Liatris is properly seated in the sockets
|
||||
|
||||
3. **Test:**
|
||||
- Plug in ONLY the left half → keyboard should work
|
||||
- Plug in ONLY the right half → keyboard should work
|
||||
- If either half doesn't work solo, re-flash that half
|
||||
|
||||
## After Initial Handedness Setup
|
||||
|
||||
Once each half has been flashed with its handedness, you can flash regular firmware to BOTH halves:
|
||||
|
||||
```bash
|
||||
# Normal build (no handedness parameter)
|
||||
qmk compile -kb fingerpunch/sweeeeep -km smathev
|
||||
|
||||
# Flash this to BOTH halves - handedness is preserved in EEPROM
|
||||
```
|
||||
|
||||
The handedness information persists in EEPROM through normal firmware updates!
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### "Wrong half detected"
|
||||
- Re-flash the problematic half with the handedness firmware
|
||||
- Make sure you're copying the correct file (LEFT vs RIGHT)
|
||||
- Verify you're flashing the correct physical half
|
||||
|
||||
### "Both halves act as the same side"
|
||||
- You need to flash different files to each half
|
||||
- `*_LEFT.uf2` → left physical half (usually has the TRRS jack on the left side)
|
||||
- `*_RIGHT.uf2` → right physical half (usually has the TRRS jack on the right side)
|
||||
|
||||
### "RPI-RP2 drive doesn't appear"
|
||||
- **Liatris-specific:** Try double-tapping the RESET button faster or slower
|
||||
- The timing can be finicky - practice a few times
|
||||
- Make sure you're using a data USB cable (not charge-only)
|
||||
- Try a different USB port
|
||||
- Check that the Liatris is properly installed in the Pro Micro sockets
|
||||
|
||||
### "Keyboard not detected as USB device"
|
||||
- Check USB cable (must be a data cable, not charge-only)
|
||||
- Try a different USB port
|
||||
- Verify the Liatris is correctly inserted (orientation matters!)
|
||||
- Check for bent pins on the Liatris controller
|
||||
|
||||
### "Compile fails with 'converter not found'"
|
||||
- Your keymap should have `"converter": "liatris"` in `keymap.json`
|
||||
- This tells QMK to build for the Liatris controller
|
||||
|
||||
## File Naming Convention
|
||||
|
||||
To avoid confusion, use this naming:
|
||||
- `*_LEFT.uf2` - For the **left physical half**
|
||||
- `*_RIGHT.uf2` - For the **right physical half**
|
||||
- `*.uf2` (no suffix) - Regular firmware (both halves)
|
||||
|
||||
## Build Script
|
||||
|
||||
Created: `build_handedness.sh` for easier building
|
||||
81
root_files_backup/LIATRIS_QUICK_START.txt
Normal file
81
root_files_backup/LIATRIS_QUICK_START.txt
Normal file
|
|
@ -0,0 +1,81 @@
|
|||
╔══════════════════════════════════════════════════════════════════╗
|
||||
║ LIATRIS SPLIT KEYBOARD - HANDEDNESS QUICK REFERENCE ║
|
||||
╚══════════════════════════════════════════════════════════════════╝
|
||||
|
||||
🎯 YOUR SETUP: Fingerpunch Sweeeeep + Liatris (RP2040) Controllers
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
STEP 1: BUILD HANDEDNESS FIRMWARE
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
Run this script to build both files:
|
||||
$ ./build_handedness.sh
|
||||
|
||||
Or manually:
|
||||
$ qmk compile -kb fingerpunch/sweeeeep -km smathev -e INIT_EE_HANDS_LEFT=yes
|
||||
$ cp fingerpunch_sweeeeep_smathev.uf2 fingerpunch_sweeeeep_smathev_LEFT.uf2
|
||||
|
||||
$ qmk compile -kb fingerpunch/sweeeeep -km smathev -e INIT_EE_HANDS_RIGHT=yes
|
||||
$ cp fingerpunch_sweeeeep_smathev.uf2 fingerpunch_sweeeeep_smathev_RIGHT.uf2
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
STEP 2: FLASH LEFT HALF
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
1. ⚡ Unplug BOTH keyboard halves
|
||||
2. 🔌 Plug in LEFT half to computer
|
||||
3. 🔘 Double-tap RESET button on Liatris
|
||||
└─► A drive named "RPI-RP2" will appear
|
||||
4. 📋 Copy fingerpunch_sweeeeep_smathev_LEFT.uf2 to the RPI-RP2 drive
|
||||
5. ⏳ Board reboots automatically (drive disappears = success!)
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
STEP 3: FLASH RIGHT HALF
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
1. ⚡ Unplug BOTH keyboard halves
|
||||
2. 🔌 Plug in RIGHT half to computer
|
||||
3. 🔘 Double-tap RESET button on Liatris
|
||||
└─► A drive named "RPI-RP2" will appear
|
||||
4. 📋 Copy fingerpunch_sweeeeep_smathev_RIGHT.uf2 to the RPI-RP2 drive
|
||||
5. ⏳ Board reboots automatically (drive disappears = success!)
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
STEP 4: TEST
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
✓ Plug in ONLY left half → Should type normally
|
||||
✓ Plug in ONLY right half → Should type normally
|
||||
✓ Connect both halves → Should work as full split keyboard
|
||||
|
||||
If a half types the wrong keys, re-flash that specific half.
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
💡 TIPS & TROUBLESHOOTING
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
🔘 Finding the RESET button:
|
||||
- Small tactile button on the Liatris controller PCB
|
||||
- Usually located near the USB connector
|
||||
- Requires a small tool or fingernail to press
|
||||
|
||||
📱 Double-tap timing:
|
||||
- Tap quickly like a mouse double-click
|
||||
- Too slow = won't work, too fast = won't work
|
||||
- Practice a few times to get the timing right
|
||||
|
||||
❌ RPI-RP2 drive doesn't appear?
|
||||
- Try double-tapping faster or slower
|
||||
- Use a data USB cable (not charge-only)
|
||||
- Try a different USB port
|
||||
- Verify Liatris is properly seated in sockets
|
||||
|
||||
🔄 After initial setup:
|
||||
- Future firmware updates can be flashed to BOTH halves
|
||||
- Handedness is saved in EEPROM and persists
|
||||
- Only need handedness files for the FIRST flash or after EEPROM reset
|
||||
|
||||
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
|
||||
|
||||
📚 Detailed documentation: FLASH_HANDEDNESS.md
|
||||
🔧 Build script: ./build_handedness.sh
|
||||
339
root_files_backup/LICENSE
Normal file
339
root_files_backup/LICENSE
Normal file
|
|
@ -0,0 +1,339 @@
|
|||
GNU GENERAL PUBLIC LICENSE
|
||||
Version 2, June 1991
|
||||
|
||||
Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
The licenses for most software are designed to take away your
|
||||
freedom to share and change it. By contrast, the GNU General Public
|
||||
License is intended to guarantee your freedom to share and change free
|
||||
software--to make sure the software is free for all its users. This
|
||||
General Public License applies to most of the Free Software
|
||||
Foundation's software and to any other program whose authors commit to
|
||||
using it. (Some other Free Software Foundation software is covered by
|
||||
the GNU Lesser General Public License instead.) You can apply it to
|
||||
your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
this service if you wish), that you receive source code or can get it
|
||||
if you want it, that you can change the software or use pieces of it
|
||||
in new free programs; and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to make restrictions that forbid
|
||||
anyone to deny you these rights or to ask you to surrender the rights.
|
||||
These restrictions translate to certain responsibilities for you if you
|
||||
distribute copies of the software, or if you modify it.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must give the recipients all the rights that
|
||||
you have. You must make sure that they, too, receive or can get the
|
||||
source code. And you must show them these terms so they know their
|
||||
rights.
|
||||
|
||||
We protect your rights with two steps: (1) copyright the software, and
|
||||
(2) offer you this license which gives you legal permission to copy,
|
||||
distribute and/or modify the software.
|
||||
|
||||
Also, for each author's protection and ours, we want to make certain
|
||||
that everyone understands that there is no warranty for this free
|
||||
software. If the software is modified by someone else and passed on, we
|
||||
want its recipients to know that what they have is not the original, so
|
||||
that any problems introduced by others will not reflect on the original
|
||||
authors' reputations.
|
||||
|
||||
Finally, any free program is threatened constantly by software
|
||||
patents. We wish to avoid the danger that redistributors of a free
|
||||
program will individually obtain patent licenses, in effect making the
|
||||
program proprietary. To prevent this, we have made it clear that any
|
||||
patent must be licensed for everyone's free use or not licensed at all.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
GNU GENERAL PUBLIC LICENSE
|
||||
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
|
||||
|
||||
0. This License applies to any program or other work which contains
|
||||
a notice placed by the copyright holder saying it may be distributed
|
||||
under the terms of this General Public License. The "Program", below,
|
||||
refers to any such program or work, and a "work based on the Program"
|
||||
means either the Program or any derivative work under copyright law:
|
||||
that is to say, a work containing the Program or a portion of it,
|
||||
either verbatim or with modifications and/or translated into another
|
||||
language. (Hereinafter, translation is included without limitation in
|
||||
the term "modification".) Each licensee is addressed as "you".
|
||||
|
||||
Activities other than copying, distribution and modification are not
|
||||
covered by this License; they are outside its scope. The act of
|
||||
running the Program is not restricted, and the output from the Program
|
||||
is covered only if its contents constitute a work based on the
|
||||
Program (independent of having been made by running the Program).
|
||||
Whether that is true depends on what the Program does.
|
||||
|
||||
1. You may copy and distribute verbatim copies of the Program's
|
||||
source code as you receive it, in any medium, provided that you
|
||||
conspicuously and appropriately publish on each copy an appropriate
|
||||
copyright notice and disclaimer of warranty; keep intact all the
|
||||
notices that refer to this License and to the absence of any warranty;
|
||||
and give any other recipients of the Program a copy of this License
|
||||
along with the Program.
|
||||
|
||||
You may charge a fee for the physical act of transferring a copy, and
|
||||
you may at your option offer warranty protection in exchange for a fee.
|
||||
|
||||
2. You may modify your copy or copies of the Program or any portion
|
||||
of it, thus forming a work based on the Program, and copy and
|
||||
distribute such modifications or work under the terms of Section 1
|
||||
above, provided that you also meet all of these conditions:
|
||||
|
||||
a) You must cause the modified files to carry prominent notices
|
||||
stating that you changed the files and the date of any change.
|
||||
|
||||
b) You must cause any work that you distribute or publish, that in
|
||||
whole or in part contains or is derived from the Program or any
|
||||
part thereof, to be licensed as a whole at no charge to all third
|
||||
parties under the terms of this License.
|
||||
|
||||
c) If the modified program normally reads commands interactively
|
||||
when run, you must cause it, when started running for such
|
||||
interactive use in the most ordinary way, to print or display an
|
||||
announcement including an appropriate copyright notice and a
|
||||
notice that there is no warranty (or else, saying that you provide
|
||||
a warranty) and that users may redistribute the program under
|
||||
these conditions, and telling the user how to view a copy of this
|
||||
License. (Exception: if the Program itself is interactive but
|
||||
does not normally print such an announcement, your work based on
|
||||
the Program is not required to print an announcement.)
|
||||
|
||||
These requirements apply to the modified work as a whole. If
|
||||
identifiable sections of that work are not derived from the Program,
|
||||
and can be reasonably considered independent and separate works in
|
||||
themselves, then this License, and its terms, do not apply to those
|
||||
sections when you distribute them as separate works. But when you
|
||||
distribute the same sections as part of a whole which is a work based
|
||||
on the Program, the distribution of the whole must be on the terms of
|
||||
this License, whose permissions for other licensees extend to the
|
||||
entire whole, and thus to each and every part regardless of who wrote it.
|
||||
|
||||
Thus, it is not the intent of this section to claim rights or contest
|
||||
your rights to work written entirely by you; rather, the intent is to
|
||||
exercise the right to control the distribution of derivative or
|
||||
collective works based on the Program.
|
||||
|
||||
In addition, mere aggregation of another work not based on the Program
|
||||
with the Program (or with a work based on the Program) on a volume of
|
||||
a storage or distribution medium does not bring the other work under
|
||||
the scope of this License.
|
||||
|
||||
3. You may copy and distribute the Program (or a work based on it,
|
||||
under Section 2) in object code or executable form under the terms of
|
||||
Sections 1 and 2 above provided that you also do one of the following:
|
||||
|
||||
a) Accompany it with the complete corresponding machine-readable
|
||||
source code, which must be distributed under the terms of Sections
|
||||
1 and 2 above on a medium customarily used for software interchange; or,
|
||||
|
||||
b) Accompany it with a written offer, valid for at least three
|
||||
years, to give any third party, for a charge no more than your
|
||||
cost of physically performing source distribution, a complete
|
||||
machine-readable copy of the corresponding source code, to be
|
||||
distributed under the terms of Sections 1 and 2 above on a medium
|
||||
customarily used for software interchange; or,
|
||||
|
||||
c) Accompany it with the information you received as to the offer
|
||||
to distribute corresponding source code. (This alternative is
|
||||
allowed only for noncommercial distribution and only if you
|
||||
received the program in object code or executable form with such
|
||||
an offer, in accord with Subsection b above.)
|
||||
|
||||
The source code for a work means the preferred form of the work for
|
||||
making modifications to it. For an executable work, complete source
|
||||
code means all the source code for all modules it contains, plus any
|
||||
associated interface definition files, plus the scripts used to
|
||||
control compilation and installation of the executable. However, as a
|
||||
special exception, the source code distributed need not include
|
||||
anything that is normally distributed (in either source or binary
|
||||
form) with the major components (compiler, kernel, and so on) of the
|
||||
operating system on which the executable runs, unless that component
|
||||
itself accompanies the executable.
|
||||
|
||||
If distribution of executable or object code is made by offering
|
||||
access to copy from a designated place, then offering equivalent
|
||||
access to copy the source code from the same place counts as
|
||||
distribution of the source code, even though third parties are not
|
||||
compelled to copy the source along with the object code.
|
||||
|
||||
4. You may not copy, modify, sublicense, or distribute the Program
|
||||
except as expressly provided under this License. Any attempt
|
||||
otherwise to copy, modify, sublicense or distribute the Program is
|
||||
void, and will automatically terminate your rights under this License.
|
||||
However, parties who have received copies, or rights, from you under
|
||||
this License will not have their licenses terminated so long as such
|
||||
parties remain in full compliance.
|
||||
|
||||
5. You are not required to accept this License, since you have not
|
||||
signed it. However, nothing else grants you permission to modify or
|
||||
distribute the Program or its derivative works. These actions are
|
||||
prohibited by law if you do not accept this License. Therefore, by
|
||||
modifying or distributing the Program (or any work based on the
|
||||
Program), you indicate your acceptance of this License to do so, and
|
||||
all its terms and conditions for copying, distributing or modifying
|
||||
the Program or works based on it.
|
||||
|
||||
6. Each time you redistribute the Program (or any work based on the
|
||||
Program), the recipient automatically receives a license from the
|
||||
original licensor to copy, distribute or modify the Program subject to
|
||||
these terms and conditions. You may not impose any further
|
||||
restrictions on the recipients' exercise of the rights granted herein.
|
||||
You are not responsible for enforcing compliance by third parties to
|
||||
this License.
|
||||
|
||||
7. If, as a consequence of a court judgment or allegation of patent
|
||||
infringement or for any other reason (not limited to patent issues),
|
||||
conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot
|
||||
distribute so as to satisfy simultaneously your obligations under this
|
||||
License and any other pertinent obligations, then as a consequence you
|
||||
may not distribute the Program at all. For example, if a patent
|
||||
license would not permit royalty-free redistribution of the Program by
|
||||
all those who receive copies directly or indirectly through you, then
|
||||
the only way you could satisfy both it and this License would be to
|
||||
refrain entirely from distribution of the Program.
|
||||
|
||||
If any portion of this section is held invalid or unenforceable under
|
||||
any particular circumstance, the balance of the section is intended to
|
||||
apply and the section as a whole is intended to apply in other
|
||||
circumstances.
|
||||
|
||||
It is not the purpose of this section to induce you to infringe any
|
||||
patents or other property right claims or to contest validity of any
|
||||
such claims; this section has the sole purpose of protecting the
|
||||
integrity of the free software distribution system, which is
|
||||
implemented by public license practices. Many people have made
|
||||
generous contributions to the wide range of software distributed
|
||||
through that system in reliance on consistent application of that
|
||||
system; it is up to the author/donor to decide if he or she is willing
|
||||
to distribute software through any other system and a licensee cannot
|
||||
impose that choice.
|
||||
|
||||
This section is intended to make thoroughly clear what is believed to
|
||||
be a consequence of the rest of this License.
|
||||
|
||||
8. If the distribution and/or use of the Program is restricted in
|
||||
certain countries either by patents or by copyrighted interfaces, the
|
||||
original copyright holder who places the Program under this License
|
||||
may add an explicit geographical distribution limitation excluding
|
||||
those countries, so that distribution is permitted only in or among
|
||||
countries not thus excluded. In such case, this License incorporates
|
||||
the limitation as if written in the body of this License.
|
||||
|
||||
9. The Free Software Foundation may publish revised and/or new versions
|
||||
of the General Public License from time to time. Such new versions will
|
||||
be similar in spirit to the present version, but may differ in detail to
|
||||
address new problems or concerns.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies a version number of this License which applies to it and "any
|
||||
later version", you have the option of following the terms and conditions
|
||||
either of that version or of any later version published by the Free
|
||||
Software Foundation. If the Program does not specify a version number of
|
||||
this License, you may choose any version ever published by the Free Software
|
||||
Foundation.
|
||||
|
||||
10. If you wish to incorporate parts of the Program into other free
|
||||
programs whose distribution conditions are different, write to the author
|
||||
to ask for permission. For software which is copyrighted by the Free
|
||||
Software Foundation, write to the Free Software Foundation; we sometimes
|
||||
make exceptions for this. Our decision will be guided by the two goals
|
||||
of preserving the free status of all derivatives of our free software and
|
||||
of promoting the sharing and reuse of software generally.
|
||||
|
||||
NO WARRANTY
|
||||
|
||||
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
|
||||
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
|
||||
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
|
||||
PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
|
||||
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
||||
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
|
||||
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
|
||||
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
|
||||
REPAIR OR CORRECTION.
|
||||
|
||||
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
|
||||
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
|
||||
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
|
||||
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
|
||||
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
|
||||
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
|
||||
POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
convey the exclusion of warranty; and each file should have at least
|
||||
the "copyright" line and a pointer to where the full notice is found.
|
||||
|
||||
<one line to give the program's name and a brief idea of what it does.>
|
||||
Copyright (C) <year> <name of author>
|
||||
|
||||
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
|
||||
the Free Software Foundation; either version 2 of the License, or
|
||||
(at your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful,
|
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
GNU General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License along
|
||||
with this program; if not, write to the Free Software Foundation, Inc.,
|
||||
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
If the program is interactive, make it output a short notice like this
|
||||
when it starts in an interactive mode:
|
||||
|
||||
Gnomovision version 69, Copyright (C) year name of author
|
||||
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
|
||||
This is free software, and you are welcome to redistribute it
|
||||
under certain conditions; type `show c' for details.
|
||||
|
||||
The hypothetical commands `show w' and `show c' should show the appropriate
|
||||
parts of the General Public License. Of course, the commands you use may
|
||||
be called something other than `show w' and `show c'; they could even be
|
||||
mouse-clicks or menu items--whatever suits your program.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or your
|
||||
school, if any, to sign a "copyright disclaimer" for the program, if
|
||||
necessary. Here is a sample; alter the names:
|
||||
|
||||
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
|
||||
`Gnomovision' (which makes passes at compilers) written by James Hacker.
|
||||
|
||||
<signature of Ty Coon>, 1 April 1989
|
||||
Ty Coon, President of Vice
|
||||
|
||||
This General Public License does not permit incorporating your program into
|
||||
proprietary programs. If your program is a subroutine library, you may
|
||||
consider it more useful to permit linking proprietary applications with the
|
||||
library. If this is what you want to do, use the GNU Lesser General
|
||||
Public License instead of this License.
|
||||
16
root_files_backup/Makefile
Normal file
16
root_files_backup/Makefile
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
.SILENT:
|
||||
|
||||
MAKEFLAGS += --no-print-directory
|
||||
|
||||
QMK_USERSPACE := $(patsubst %/,%,$(dir $(shell realpath "$(lastword $(MAKEFILE_LIST))")))
|
||||
ifeq ($(QMK_USERSPACE),)
|
||||
QMK_USERSPACE := $(shell pwd)
|
||||
endif
|
||||
|
||||
QMK_FIRMWARE_ROOT = $(shell qmk config -ro user.qmk_home | cut -d= -f2 | sed -e 's@^None$$@@g')
|
||||
ifeq ($(QMK_FIRMWARE_ROOT),)
|
||||
$(error Cannot determine qmk_firmware location. `qmk config -ro user.qmk_home` is not set)
|
||||
endif
|
||||
|
||||
%:
|
||||
+$(MAKE) -C $(QMK_FIRMWARE_ROOT) $(MAKECMDGOALS) QMK_USERSPACE=$(QMK_USERSPACE)
|
||||
59
root_files_backup/README.md
Normal file
59
root_files_backup/README.md
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
# QMK Userspace
|
||||
|
||||
This is a template repository which allows for an external set of QMK keymaps to be defined and compiled. This is useful for users who want to maintain their own keymaps without having to fork the main QMK repository.
|
||||
|
||||
## Howto configure your build targets
|
||||
|
||||
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
|
||||
1. Fork this repository
|
||||
1. Clone your fork to your local machine
|
||||
1. Enable userspace in QMK config using `qmk config user.overlay_dir="$(realpath qmk_userspace)"`
|
||||
1. Add a new keymap for your board using `qmk new-keymap`
|
||||
* This will create a new keymap in the `keyboards` directory, in the same location that would normally be used in the main QMK repository. For example, if you wanted to add a keymap for the Planck, it will be created in `keyboards/planck/keymaps/<your keymap name>`
|
||||
* You can also create a new keymap using `qmk new-keymap -kb <your_keyboard> -km <your_keymap>`
|
||||
* Alternatively, add your keymap manually by placing it in the location specified above.
|
||||
* `layouts/<layout name>/<your keymap name>/keymap.*` is also supported if you prefer the layout system
|
||||
1. Add your keymap(s) to the build by running `qmk userspace-add -kb <your_keyboard> -km <your_keymap>`
|
||||
* This will automatically update your `qmk.json` file
|
||||
* Corresponding `qmk userspace-remove -kb <your_keyboard> -km <your_keymap>` will delete it
|
||||
* Listing the build targets can be done with `qmk userspace-list`
|
||||
1. Commit your changes
|
||||
|
||||
## Howto build with GitHub
|
||||
|
||||
1. In the GitHub Actions tab, enable workflows
|
||||
1. Push your changes above to your forked GitHub repository
|
||||
1. Look at the GitHub Actions for a new actions run
|
||||
1. Wait for the actions run to complete
|
||||
1. Inspect the Releases tab on your repository for the latest firmware build
|
||||
|
||||
## Howto build locally
|
||||
|
||||
1. Run the normal `qmk setup` procedure if you haven't already done so -- see [QMK Docs](https://docs.qmk.fm/#/newbs) for details.
|
||||
1. Fork this repository
|
||||
1. Clone your fork to your local machine
|
||||
1. `cd` into this repository's clone directory
|
||||
1. Set global userspace path: `qmk config user.overlay_dir="$(realpath .)"` -- you MUST be located in the cloned userspace location for this to work correctly
|
||||
* This will be automatically detected if you've `cd`ed into your userspace repository, but the above makes your userspace available regardless of your shell location.
|
||||
1. Compile normally: `qmk compile -kb your_keyboard -km your_keymap` or `make your_keyboard:your_keymap`
|
||||
|
||||
Alternatively, if you configured your build targets above, you can use `qmk userspace-compile` to build all of your userspace targets at once.
|
||||
|
||||
## Extra info
|
||||
|
||||
If you wish to point GitHub actions to a different repository, a different branch, or even a different keymap name, you can modify `.github/workflows/build_binaries.yml` to suit your needs.
|
||||
|
||||
To override the `build` job, you can change the following parameters to use a different QMK repository or branch:
|
||||
```
|
||||
with:
|
||||
qmk_repo: qmk/qmk_firmware
|
||||
qmk_ref: master
|
||||
```
|
||||
|
||||
If you wish to manually manage `qmk_firmware` using git within the userspace repository, you can add `qmk_firmware` as a submodule in the userspace directory instead. GitHub Actions will automatically use the submodule at the pinned revision if it exists, otherwise it will use the default latest revision of `qmk_firmware` from the main repository.
|
||||
|
||||
This can also be used to control which fork is used, though only upstream `qmk_firmware` will have support for external userspace until other manufacturers update their forks.
|
||||
|
||||
1. (First time only) `git submodule add https://github.com/qmk/qmk_firmware.git`
|
||||
1. (To update) `git submodule update --init --recursive`
|
||||
1. Commit your changes to your userspace repository
|
||||
125
root_files_backup/build_all.sh
Executable file
125
root_files_backup/build_all.sh
Executable file
|
|
@ -0,0 +1,125 @@
|
|||
#!/usr/bin/env bash
|
||||
# Complete firmware builder for fingerpunch/sweeeeep with Liatris
|
||||
# Builds three versions:
|
||||
# 1. Regular firmware (for normal use after handedness is set)
|
||||
# 2. LEFT handedness initialization firmware
|
||||
# 3. RIGHT handedness initialization firmware
|
||||
|
||||
set -e # Exit on error
|
||||
|
||||
KEYBOARD="fingerpunch/sweeeeep"
|
||||
KEYMAP="smathev"
|
||||
OUTPUT_NAME="fingerpunch_sweeeeep_smathev"
|
||||
|
||||
CONFIG_FILE="$HOME/git_dev/keyboards/qmk_userspace/keyboards/fingerpunch/sweeeeep/keymaps/smathev/config.h"
|
||||
BACKUP_FILE="${CONFIG_FILE}.backup"
|
||||
QMK_FIRMWARE_DIR="$HOME/git_dev/keyboards/qmk_firmware"
|
||||
OUTPUT_DIR="$HOME/git_dev/keyboards/latest_firmware"
|
||||
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "🔨 Building ALL firmware versions for $KEYBOARD"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo ""
|
||||
echo "⚙️ Keyboard: $KEYBOARD"
|
||||
echo "⚙️ Keymap: $KEYMAP"
|
||||
echo "⚙️ Controller: Liatris (RP2040)"
|
||||
echo ""
|
||||
|
||||
# Clean build
|
||||
echo "🧹 Cleaning previous build..."
|
||||
qmk clean > /dev/null 2>&1
|
||||
echo ""
|
||||
|
||||
# ============================================================================
|
||||
# 1. Build REGULAR firmware (for normal use)
|
||||
# ============================================================================
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "📦 [1/3] Building REGULAR firmware..."
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
qmk compile -kb "$KEYBOARD" -km "$KEYMAP"
|
||||
if [ $? -eq 0 ]; then
|
||||
cp "$QMK_FIRMWARE_DIR/${OUTPUT_NAME}.uf2" "$OUTPUT_DIR/${OUTPUT_NAME}.uf2"
|
||||
echo "✅ Regular firmware: ${OUTPUT_NAME}.uf2"
|
||||
else
|
||||
echo "❌ Regular firmware build failed!"
|
||||
exit 1
|
||||
fi
|
||||
echo ""
|
||||
|
||||
# Backup original config for handedness builds
|
||||
cp "$CONFIG_FILE" "$BACKUP_FILE"
|
||||
|
||||
# ============================================================================
|
||||
# 2. Build LEFT handedness initialization firmware
|
||||
# ============================================================================
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "📍 [2/3] Building LEFT hand initialization firmware..."
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
# Add INIT_EE_HANDS_LEFT to config
|
||||
sed -i '/^#define EE_HANDS/a #define INIT_EE_HANDS_LEFT' "$CONFIG_FILE"
|
||||
|
||||
qmk compile -kb "$KEYBOARD" -km "$KEYMAP"
|
||||
if [ $? -eq 0 ]; then
|
||||
cp "$QMK_FIRMWARE_DIR/${OUTPUT_NAME}.uf2" "$OUTPUT_DIR/${OUTPUT_NAME}_LEFT.uf2"
|
||||
echo "✅ LEFT hand firmware: ${OUTPUT_NAME}_LEFT.uf2"
|
||||
else
|
||||
echo "❌ LEFT hand build failed!"
|
||||
cp "$BACKUP_FILE" "$CONFIG_FILE"
|
||||
rm "$BACKUP_FILE"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Restore config
|
||||
cp "$BACKUP_FILE" "$CONFIG_FILE"
|
||||
echo ""
|
||||
|
||||
# ============================================================================
|
||||
# 3. Build RIGHT handedness initialization firmware
|
||||
# ============================================================================
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "📍 [3/3] Building RIGHT hand initialization firmware..."
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
# Add INIT_EE_HANDS_RIGHT to config
|
||||
sed -i '/^#define EE_HANDS/a #define INIT_EE_HANDS_RIGHT' "$CONFIG_FILE"
|
||||
|
||||
qmk compile -kb "$KEYBOARD" -km "$KEYMAP"
|
||||
if [ $? -eq 0 ]; then
|
||||
cp "$QMK_FIRMWARE_DIR/${OUTPUT_NAME}.uf2" "$OUTPUT_DIR/${OUTPUT_NAME}_RIGHT.uf2"
|
||||
echo "✅ RIGHT hand firmware: ${OUTPUT_NAME}_RIGHT.uf2"
|
||||
else
|
||||
echo "❌ RIGHT hand build failed!"
|
||||
cp "$BACKUP_FILE" "$CONFIG_FILE"
|
||||
rm "$BACKUP_FILE"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
# Restore original config
|
||||
cp "$BACKUP_FILE" "$CONFIG_FILE"
|
||||
rm "$BACKUP_FILE"
|
||||
rm "$QMK_FIRMWARE_DIR/${OUTPUT_NAME}.uf2"
|
||||
|
||||
|
||||
echo ""
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "🎉 ALL FIRMWARE FILES BUILT SUCCESSFULLY!"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo ""
|
||||
echo "📁 Files created:"
|
||||
ls -lh "$OUTPUT_DIR/${OUTPUT_NAME}.uf2" "$OUTPUT_DIR/${OUTPUT_NAME}_LEFT.uf2" "$OUTPUT_DIR/${OUTPUT_NAME}_RIGHT.uf2"
|
||||
echo ""
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo "📝 USAGE GUIDE:"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
echo ""
|
||||
echo "🔧 FIRST-TIME SETUP (Set handedness in EEPROM):"
|
||||
echo " 1. Flash ${OUTPUT_NAME}_LEFT.uf2 to LEFT keyboard half"
|
||||
echo " 2. Flash ${OUTPUT_NAME}_RIGHT.uf2 to RIGHT keyboard half"
|
||||
echo " 3. Only do this ONCE to initialize handedness"
|
||||
echo ""
|
||||
echo "🔄 REGULAR UPDATES (After handedness is set):"
|
||||
echo " 1. Flash ${OUTPUT_NAME}.uf2 to BOTH keyboard halves"
|
||||
echo " 2. Handedness is preserved in EEPROM"
|
||||
echo " 3. Either half can be plugged in as master"
|
||||
echo ""
|
||||
echo "💡 TIP: To enter bootloader, double-tap RESET on Liatris"
|
||||
echo "━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━"
|
||||
6
root_files_backup/qmk.json
Normal file
6
root_files_backup/qmk.json
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
{
|
||||
"userspace_version": "1.1",
|
||||
"build_targets": [
|
||||
["fingerpunch/sweeeeep", "smathev"]
|
||||
]
|
||||
}
|
||||
|
|
@ -1,23 +1,26 @@
|
|||
#include "combos.h"
|
||||
#include "smathev.h"
|
||||
#include "keycodes.h"
|
||||
#include "keymap_danish.h"
|
||||
|
||||
// COMBOS - https://github.com/qmk/qmk_firmware/blob/master/docs/feature_combo.md
|
||||
const uint16_t PROGMEM undo_combo[] = {KC_Y, DK_ARNG, COMBO_END}; // L3_K1 + L3_K2
|
||||
const uint16_t PROGMEM ent_combo[] = {KC_S, KC_D, COMBO_END}; // R2_K4 + R2_K5
|
||||
|
||||
//l3 + R3 doesn't work because of homerow-mods
|
||||
const uint16_t PROGMEM undo_combo[] = {KC_X, KC_H, COMBO_END}; // L3_K1 + L3_K2
|
||||
const uint16_t PROGMEM cut_combo[] = {KC_H, KC_L, COMBO_END}; //L3_K2 + L3_K3
|
||||
const uint16_t PROGMEM copy_combo[] = {KC_L, KC_F, COMBO_END}; // L3_K3 + L3_K4
|
||||
const uint16_t PROGMEM paste_combo[] = {KC_C, KC_COMM, COMBO_END}; // L3_K4 + L3_K5 KC_I
|
||||
|
||||
const uint16_t PROGMEM enter_combo[] = {KC_S, KC_D, COMBO_END}; // R2_K4 + R2_K5
|
||||
const uint16_t PROGMEM tab_combo[] = {KC_O, KC_I, COMBO_END}; // L2_K1 + L2_K2
|
||||
const uint16_t PROGMEM cut_combo[] = {DK_ARNG, KC_V, COMBO_END}; //L3_K2 + L3_K3
|
||||
const uint16_t PROGMEM copy_combo[] = {KC_V, KC_C, COMBO_END}; // L3_K3 + L3_K4
|
||||
const uint16_t PROGMEM paste_combo[] = {KC_C, KC_COMM, COMBO_END}; // L3_K4 + L3_K5
|
||||
const uint16_t PROGMEM del_combo[] = {KC_L, KC_H, COMBO_END}; // R1_K3 + R1_K4
|
||||
const uint16_t PROGMEM delete_combo[] = {KC_L, KC_H, COMBO_END}; // R1_K3 + R1_K4
|
||||
const uint16_t PROGMEM bcksp_combo[] = {KC_H, KC_X, COMBO_END}; // R1_K4 + R1_K5
|
||||
const uint16_t PROGMEM cttb_combo[] = {KC_G, KC_J, COMBO_END}; // L1_K4 + L1_K5
|
||||
const uint16_t PROGMEM new_tab_combo[] = {KC_G, KC_J, COMBO_END}; // L1_K4 + L1_K5
|
||||
const uint16_t PROGMEM esc_combo[] = {DK_OSTR, DK_AE, COMBO_END}; // L1_K1 + L1_K2
|
||||
const uint16_t PROGMEM svfile_combo[] = {KC_Q, KC_Z, COMBO_END}; // R3_K3 + R3_K4
|
||||
const uint16_t PROGMEM srch_combo[] = {KC_F, KC_B, COMBO_END}; // R1_K1 + R1_K2
|
||||
const uint16_t PROGMEM ctcl_combo[] = {FP_SUPER_TAB, KC_PGDN, COMBO_END}; // L1_K4 + L1_K5
|
||||
const uint16_t PROGMEM search_ctrl_f_combo[] = {KC_F, KC_B, COMBO_END}; // R1_K1 + R1_K2
|
||||
const uint16_t PROGMEM close_window_combo[] = {FP_SUPER_TAB, KC_PGDN, COMBO_END}; // L1_K4 + L1_K5
|
||||
const uint16_t PROGMEM cancel_combo[] = {KC_LEFT, KC_HOME, COMBO_END}; // l2_K1 + L2_K2
|
||||
const uint16_t PROGMEM ctrop_combo[] = {FP_SUPER_TAB, KC_PGDN, KC_UP, COMBO_END}; // L1_K3 + L1_K4 + L1_K5
|
||||
const uint16_t PROGMEM ffive_combo[] = {KC_U, KC_G, COMBO_END}; // L1_K3 + L1_K4
|
||||
const uint16_t PROGMEM reopen_closed_tab_combo[] = {FP_SUPER_TAB, KC_PGDN, KC_UP, COMBO_END}; // L1_K3 + L1_K4 + L1_K5
|
||||
const uint16_t PROGMEM ffive_reload_combo[] = {KC_U, KC_G, COMBO_END}; // L1_K3 + L1_K4
|
||||
const uint16_t PROGMEM reset_keyboard_left_combo[] = {KC_J, KC_M, KC_C, COMBO_END}; // L1_K3 + L1_K4 + L1_K5
|
||||
const uint16_t PROGMEM reset_keyboard_right_combo[] = {KC_B, KC_P, KC_W, COMBO_END}; // L1_K3 + L1_K4 + L1_K5
|
||||
combo_t key_combos[COMBO_COUNT] = {
|
||||
|
|
@ -25,17 +28,16 @@ combo_t key_combos[COMBO_COUNT] = {
|
|||
COMBO(copy_combo, LCTL(KC_C)),
|
||||
COMBO(cut_combo, LCTL(KC_X)),
|
||||
COMBO(paste_combo, LCTL(KC_V)),
|
||||
COMBO(cttb_combo, LCTL(KC_T)),
|
||||
COMBO(ctcl_combo, LCTL(KC_W)),
|
||||
COMBO(new_tab_combo, LCTL(KC_T)),
|
||||
COMBO(close_window_combo, LCTL(KC_W)),
|
||||
COMBO(cancel_combo, LCTL(KC_C)),
|
||||
COMBO(ctrop_combo, RCS(KC_T)),
|
||||
COMBO(svfile_combo, LCTL(KC_S)),
|
||||
COMBO(srch_combo, LCTL(KC_F)),
|
||||
COMBO(ffive_combo, KC_F5),
|
||||
COMBO(ent_combo, KC_ENT),
|
||||
COMBO(reopen_closed_tab_combo, RCS(KC_T)),
|
||||
COMBO(search_ctrl_f_combo, LCTL(KC_F)),
|
||||
COMBO(ffive_reload_combo, KC_F5),
|
||||
COMBO(enter_combo, KC_ENT),
|
||||
COMBO(tab_combo, KC_TAB),
|
||||
COMBO(bcksp_combo, KC_BSPC),
|
||||
COMBO(del_combo, KC_DEL),
|
||||
COMBO(delete_combo, KC_DEL),
|
||||
COMBO(esc_combo, KC_ESC),
|
||||
COMBO(reset_keyboard_left_combo, QK_BOOT),
|
||||
COMBO(reset_keyboard_right_combo, QK_BOOT)
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@
|
|||
#include QMK_KEYBOARD_H
|
||||
|
||||
// Define the number of combos
|
||||
#define COMBO_COUNT 18
|
||||
#define COMBO_COUNT 17
|
||||
|
||||
// Combo array declaration
|
||||
extern combo_t key_combos[COMBO_COUNT];
|
||||
|
|
|
|||
|
|
@ -28,7 +28,10 @@
|
|||
#define AUTO_SHIFT_TIMEOUT 170 // Slightly longer than TAPPING_TERM
|
||||
#define RETRO_SHIFT // Enable retroactive shift
|
||||
#define RETRO_TAPPING // Enable retroactive tapping
|
||||
#define HOLD_ON_OTHER_KEY_PRESS // Enable hold on other key press
|
||||
|
||||
// Combo configuration
|
||||
#define CASEMODES_ENABLE
|
||||
#define COMBO_REF_DEFAULT _NORTO
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -23,13 +23,6 @@
|
|||
#include "process_records.h"
|
||||
#include "keymap_danish.h"
|
||||
|
||||
#if defined(USERSPACE_RGBLIGHT_ENABLE)
|
||||
# include "rgb_stuff.h"
|
||||
#endif
|
||||
#if defined(HAPTIC_ENABLE)
|
||||
# include "haptic_stuff.h"
|
||||
#endif
|
||||
|
||||
/* Define layer names */
|
||||
enum userspace_layers {
|
||||
_NORTO= 0,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue