qmk_firmware

QMK firmware for my keyboards (Corne, Sweep Ferris) and trackball (Ploopy Adept)
Log | Files | Refs | Submodules | LICENSE

readme.md (2712B)


      1 # bluepill splittest
      2 
      3 This is the splittest example for the bluepill MCU.
      4 To trigger keypress, short together pins _B10_ and _B1_.
      5 
      6 ## Keyboard Configuration
      7 
      8 The type of communication (bitbang, serial (half/full duplex)) is set by the keymap `config.h` file with variables with `SPLIT_` prefix.
      9 So this example uses:
     10 
     11 -   `config.h` to set which SDI to use for serial. Either define `USE_SDI1_ON_STANDARD_ROLE_PINS`, `USE_SDI1_ON_ALTERNATE_ROLE_PINS` or `USE_SDI2` before the `#ifdef` that configures the default case when none of these variable is defined.
     12 -   `post_config.h` for defining the communication pins between the halves once the keymap is configured.
     13 
     14 On your keyboard, you most likely will only use `config.h` because you'd have already chosen your communication scheme: serial type, SDI, pins.
     15 
     16 ## Wiring
     17 
     18 ### Switches
     19 
     20 -   Add switches to both Bluepills across B10 and B1 pins
     21 
     22 ### Handedness
     23 
     24 Have a look at the [handedness documentation](https://docs.qmk.fm/#/feature_split_keyboard?id=setting-handedness)
     25 
     26 -   Add pull-up resistor to left side between VCC and A7
     27 -   Add pull-down resistors to right side between GND and A7
     28 
     29 ### Send power to the other half
     30 
     31 -   Connect the following pins on both sides together: GND, VCC
     32 
     33 ### Halves data connection
     34 
     35 Choose one of the connection type
     36 
     37 #### serial - bitbang
     38 
     39 -   Connect the B8 pins on both sides together
     40 
     41 #### serial - usart half duplex
     42 
     43 Check the [documentation](https://docs.qmk.fm/#/serial_driver?id=usart-half-duplex) to determine the pull-up resistor.
     44 
     45 -   To use the default usart (USART1) with the standard role pins,
     46     -   Connect the A9 pins on both sides together and to add a pull-up resistor on one of these pins
     47     -   Define USE_SDI1_ON_STANDARD_ROLE_PINS in config.h
     48 -   To use the default usart (USART1) with the alternate role pins,
     49     -   Connect the B6 pins on both sides together and to add a pull-up resistor on one of these pins
     50     -   Define USE_SDI1_ON_ALTERNATE_ROLE_PINS in config.h
     51 -   To use the usart2 (USART2) pins,
     52     -   Connect the A2 pins on both sides together and to add a pull-up resistor on one of these pins
     53     -   Define USE_SDI2 in config.h
     54 
     55 #### serial - usart full duplex
     56 
     57 -   To use the default usart (USART1) with the standard role pins,
     58     -   Connect the mpins on A9, A10 one to the other on each side
     59     -   Define USE_SDI1_ON_STANDARD_ROLE_PINS in config.h
     60 -   To use the default usart (USART1) with the alternate role pins,
     61     -   Connect the pins B6, B7 one to the other on each side
     62     -   Define USE_SDI1_ON_ALTERNATE_ROLE_PINS in config.h
     63 -   To use the usart2 (USART2) pins,
     64     -   Connect the pins A2, A3 one to the other on each side
     65     -   Define USE_SDI2 in config.h