qmk-keychron-q3-colemak-dh/keyboards/handwired/sono1
James Young a03aa301de
Remove Full Bootmagic (#13846)
* disambiguate Bootmagic rules in keymaps

The files edited by this commit were added at a point in time where `BOOTMAGIC_ENABLE = yes` enabled full Bootmagic.

This commit edits the files to specify that full Bootmagic is intended.

* remove BOOTMAGIC_ENABLE=full setting

* unify commented BOOTMAGIC_ENABLE rules in keyboards

Explicitly sets `BOOTMAGIC_ENABLE = no` in keyboards where the rule was commented out.

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;#[ \t]*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-zA-Z]\+\).*;\1 = no       # Virtual DIP switch configuration;g' {} +
```

* remove commented Bootmagic rules from keymap/user level

Command:

```
find keyboards/ layouts/ users/ -type f -name 'rules.mk' -exec sed -i -e '/#.*\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*/d' {} +
```

* update keyboard BOOTMAGIC_ENABLE rule formatting

Sets the formatting of BOOTMAGIC_ENABLE rules to `BOOTMAGIC_ENABLE = [value]`, without the inline comments (which will be replaced later).

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
```

* update keyboards' BOOTMAGIC_ENABLE settings

Updates keyboard `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.

Command:

```
find keyboards/ -type f -name 'rules.mk' -and -not -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = \)full;\1lite;g' '{}' +
```

* update keymap/user BOOTMAGIC_ENABLE settings

Updates keymap/user `rules.mk` files to use `BOOTMAGIC_ENABLE = lite` where `BOOTMAGIC_ENABLE = full` was being used.

Commands:

```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE[ \t=]\+\)full;\1lite;g' '{}' +
```

* remove and replace inline comments in keyboards and keymap/user files

Removes and replaces the inline comments, which have been updated to read `Enable Bootmagic Lite`.

Commands:

```
find keyboards/ -type f -name 'rules.mk' -and -path '*/keymaps/*' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE\)[ \t=]\+\([a-z]\+\).*;\1 = \2;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = lite\);\1     # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = yes\);\1      # Enable Bootmagic Lite;g' '{}' +
find keyboards/ layouts/community/ users/ -type f -name 'rules.mk' -exec sed -i -e 's;\(BOOTMAGIC_ENABLE = no\);\1       # Enable Bootmagic Lite;g' '{}' +
```

* rename improperly named makefiles

Some files intended to be used as makefiles had improper names causing them to not be used as intended when building.

This commit corrects the filenames of the affected files.

* update renamed file with new rule formatting

* update QMK's template files

Updates QMK's `rules.mk` templates to use the new inline comment.

* update QMK Docs

- remove documentation of full Bootmagic
- update links to Bootmagic Lite doc
- add doc for Magic Keycodes

* rules.mk patch for coarse/ixora and coarse/vinta
2021-08-06 23:59:56 -07:00
..
keymaps [Keyboard] add ASkeyboard Sono1 (#11114) 2020-12-22 10:10:56 -08:00
chconf.h ChibiOS conf migrations... take 11 (#11646) 2021-01-21 17:00:53 +11:00
config.h [Keyboard] add ASkeyboard Sono1 (#11114) 2020-12-22 10:10:56 -08:00
halconf.h Fix up comments showing how to execute config migration. (#11621) 2021-01-20 02:19:36 +11:00
info.json Handwired ASkeyboard Sono1: Configurator fixes (#11625) 2021-01-19 23:27:04 -08:00
mcuconf.h Fix up comments showing how to execute config migration. (#11621) 2021-01-20 02:19:36 +11:00
readme.md [Keyboard] add ASkeyboard Sono1 (#11114) 2020-12-22 10:10:56 -08:00
rules.mk Remove Full Bootmagic (#13846) 2021-08-06 23:59:56 -07:00
sono1.c [Keyboard] add ASkeyboard Sono1 (#11114) 2020-12-22 10:10:56 -08:00
sono1.h [Keyboard] add ASkeyboard Sono1 (#11114) 2020-12-22 10:10:56 -08:00

QMK-based firmware for ASkeyboard Sono1 keyboard with additional Sono2 numpad

Sono1

ASkeyboard Sono1 keyboard conversion project: direct connection of Black Pill to the matrix.

  • Keyboard Maintainer: DmNosachev
  • Hardware Supported: ASkeyboard Sono1, Black Pill STM32F103C8T6 MCU board. Alternatively you can use any MCU which is supported by QMK and has 28 IO pins or more (15x8 matrix and 5 LEDs): Teensy 2.0++, Blue Pill, etc.

Make example for this keyboard (after setting up your build environment):

make handwired/sono1:default

See the build environment setup and the make instructions for more information. Brand new to QMK? Start with our Complete Newbs Guide.

Modding

Matrix

ASkeyboard Sono1 has 15x8 matrix. Sono2 numpad connects directly to the main matrix.

Rows (R0-RE) and columns (R0-C7): Sono1 rows and columns

LEDs

Keyboard has 5 LEDs with common anode. Their cathodes are connected to R10R14 resistors (you may want to replace them to adjust LED brightness for 3.3V voltage). Add 5 wire jumpers to connect them to the corresponding traces.

Sono1 LEDs

Black Pill

Suggested mount position for the Black Pill (view from the bottom side of the PCB):

      R8  R9  RA  RB  RC  RD  RE  L0         Vcc  C7  C6  C5  C4  C3  C2       C1  C0 Vcc
       *   |   |   |   *   |   |   |               |   |   |   |   |   |        *   *   *
    ,------------------------------------------------------------------------,
,---|GND  B8  B9 C13 RST  A0  A1  A2  A3  A4  A5  A6  A7  B0  B1 B10 B11  3V3| A3  A4 3V3
|   | B7             A15                                                  A13|
|USB|                                                                     A14|
|   |                        B12                                     A10  GND|
'---|GND 3V3  B7  B6  B5  B4  B3 A15 A12 A11 A10  A9  A8 B15 B14 B13 B12     |
    '------------------------------------------------------------------------' A9  B3  A5
      |            |   |   |   *                       |   |   |   |   *        *   *   *
     GND          L2  L1  L3  L4                      R7  R6  R5  R4  R3       R2  R1  R0

Asterisk sign designates pins of the Black Pill that don't align properly with PCB and need to be rewired.

Black Pill

  1. Desolder all ICs, capacitors and resistors except R10R14.
  2. Solder 4-pin SWD header to Black Pill.
  3. Burn STM32duino bootloader to Black Pill.
  4. Compile and flash the firmware: make handwired/sono1:default:flash
  5. Connect rows, columns and LED pads to the corresponding pins of the Black Pill.

Keymap

'CUR LOCK' key on Sono2 numpad has locking switch by default (Alps SKCL lock). QMK supports mechanical locking switches for CapsLock, NumLock and ScrollLock keycodes.