mkbd65/vial-qmk
Watch
1
0
Fork
You've already forked vial-qmk
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Rename keyboard-level readmes to lower-case (#10759)

Browse source 
This is the recommendation in the [PR
Checklist](https://docs.qmk.fm/#/pr_checklist?id=keyboard-prs) and it
will make working with them easier in the CLI/API/etc.
This commit is contained in:
Erovia 2020-10-25 15:23:42 +00:00 • committed by GitHub
commit ad86894ae7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
58 changed files with 0 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

14
keyboards/4pplet/aekiso60/readme.md Normal file
View file

@ -0,0 +1,14 @@
# AEKISO60
A 60% PCB enabling use of ISO AEK keycaps and ALPS switches
More info: https://geekhack.org/index.php?topic=103627.0
* Keyboard Maintainer: [4pplet](https://github.com/4pplet)
* Hardware Supported: AEKISO60 Rev A
Make example for this keyboard (after setting up your build environment):
make 4pplet/aekiso60/rev_a:default
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).

14
keyboards/4pplet/steezy60/readme.md Normal file
View file

@ -0,0 +1,14 @@
# Steezy60
A 60% PCB with a ton of layout options for SMK and Alps switches
More info: https://geekhack.org/index.php?topic=103531.0
* Keyboard Maintainer: [4pplet](https://github.com/4pplet)
* Hardware Supported: Steezy60 Rev A
Make example for this keyboard (after setting up your build environment):
make 4pplet/steezy60/rev_a:default
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).

14
keyboards/4pplet/waffling60/readme.md Normal file
View file

@ -0,0 +1,14 @@
# waffling60
A 60% PCB for MX switches, one hot swap and one solder-pcb version with decent layout support.
More info: https://geekhack.org/index.php?topic=103531.0
* Keyboard Maintainer: [4pplet](https://github.com/4pplet)
* Hardware Supported: [waffling60](https://github.com/4pplet/waffling60)
Make example for this keyboard (after setting up your build environment):
make 4pplet/steezy60/rev_a:default
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).

17
keyboards/acheron/shark/readme.md Normal file
View file

@ -0,0 +1,17 @@
# Acheron Aχξρων 40-SM-O-MX-TH-WI (Codename "SharkPCB") QMK firmware
<p align="center">
<img align="middle" src="https://raw.githubusercontent.com/Gondolindrim/acheronLibrary/master/graphics/acheronLong.png" width="400">
</p>
This is the QMK firmware repository for the Shark, updated until [revision Alpha](https://github.com/Gondolindrim/SharkPCB/releases/tag/Alpha).
The SharkPCB is an Open-Hardware guidelines compliant PCB which files can be found at [this link](https://github.com/Gondolindrim/SharkPCB). Its designer and maintainer is [Gondolindrim](https://github.com/Gondolindrim).
See the [AcheronDocs](https://gondolindrim.github.io/AcheronDocs/shark/intro.html) page for the SharkPCB full documentation.
Make example for this keyboard (after setting up your build environment):
make acheron/shark:default
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).

4
keyboards/ai03/readme.md Normal file
View file

@ -0,0 +1,4 @@
# ai03
QMK folders for PCB commissions.
Website: [ai03 Keyboard Designs](https://kb.ai03.me/)

41
keyboards/aplx6/readme.md Normal file
View file

@ -0,0 +1,41 @@
# Aplx6
![Front](https://i.imgur.com/flhSvAG.png)
![Back](https://i.imgur.com/PXqNmUh.png)
A stylish (2x3) 6-key MediaPad for your music and browser shortcuts. Designed to be assembled as a sandwich with a blank PCB, using M2.5 screws and spacers, your choice of MX- or Alps-compatible switches, and 1N4148 diodes.
## RGB Underglow (WS2812)
Just wire them to any of the unused ProMicro pins. Don't forget to edit-uncomment the `config.h` and the `rules.mk` for RGB underglow support, or even add your own functions and modes. Used pins can be found in `config.h` or in the [KiCad Schematic](https://github.com/Aplyard/Aplx6/blob/master/kiCad/xd6.sch). All ProMicro pins can be found [here](https://golem.hu/article/pro-micro-pinout/) along with the +2 pins mod.
* Keyboard Maintainer: [Aplyard](https://github.com/Aplyard)
* Hardware Supported: Aplx6 PCB, Pro Micro (ATmega32U4)
* Hardware Availability: [GitHub](https://github.com/Aplyard/Aplx6)
Make example for this keyboard (after setting up your build environment):
make aplx6:default
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).
---
****Designed in**:**
[KiCad](https://github.com/KiCad)
**Components Footprints & Libraries :**
[keebs.pretty](https://github.com/egladman/keebs.pretty)
[keyboard_parts.pretty
](https://github.com/tmk/keyboard_parts.pretty)
[ProMicro KiCad](https://github.com/Biacco42/ProMicroKiCad)
**Usefull Links:**
[Qmk Online Configurator](https://config.qmk.fm/#)
**Alternatives of qmk that worked for me:**
[Keyboard Layout Editor](http://www.keyboard-layout-editor.com/#/)
[Keyboard Plate & Case Builder](http://builder.swillkb.com/)
[Firmware Builder](https://kbfirmware.com/)
---

14
keyboards/ashpil/modelm_usbc/readme.md Normal file
View file

@ -0,0 +1,14 @@
# USB C Model M
![modelm_usbc](https://raw.githubusercontent.com/ashpil/Model-M-Type-C-Controller/master/images/render.png)
This is a configuration of QMK intended to be used with the [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller "USB C Model M alt controller"). Many thanks to iw0rm3r for working on a similar project and providing the foundation for this!
* Keyboard Maintainer: [ashpil](https://github.com/ashpil)
* Hardware Supported: [USB C Model M alt controller](https://github.com/ashpil/Model-M-Type-C-Controller)
Make example for this keyboard (after setting up your build environment):
make ashpil/modelm_usbc:default
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).

30
keyboards/bemeier/bmek/readme.md Executable file
View file

@ -0,0 +1,30 @@
# BMEK
![BMEK](https://i.imgur.com/p1KFi6ql.jpg)
BMEK combines the best of HHKB & Alice-likes. All PCB and case design files are open source.
* Keyboard Maintainer: [Bemeier](https://github.com/Bemeier)
* Hardware Supported: BMEK PCB rev1, rev2, rev3
* Hardware Availability: Case & PCB files: [github.com/bemeier/bmek](https://github.com/bemeier/bmek)
Make example for this keyboard, for an hhkb-like layout and keymap (after setting up your build environment):
make bemeier/bmek/rev3:default
Make the VIA compatible firmware:
make bemeier/bmek/rev3:via
The ```rev3```, denotes the version of the PCB.
Check on the PCB to find out which version you have, and set it to rev1, rev2 or rev3 accordingly (the BMEK group buy PCBs are all rev3).
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).
# Layouts
Starting with rev3 (the version of the PCB to be shipped in the GB), the following layout options are supported:
![layouts](https://i.imgur.com/XuFxwthl.png)
Note that the keymap shown above may not accurately reflect the default keymap of the firmware (see the keymaps folder).

17
keyboards/catch22/readme.md Normal file
View file

@ -0,0 +1,17 @@
# Catch 22 Budget Hotswap Macropad
GB by /u/rockydbull run in July 2018, PCB designed with help from /u/Kilgarah.
Designed to be a budget project board to enjoy hotswapping/switch testing/macro making fun. The board is controlled by a pro micro clone made famous by other projects like the lets split, iris, and nyquist and allows for full QMK implementation. Each Catch22 kit will contain:
* 2 pcbs (one to solder to and one to be a base)(green color)
* 1 pcb material switch plate( green color) with cut out for pcb mount cherry stabilizers
* 40 throughhole diodes (22 for the pcb and the remaining as extras in case you lose one and to use to make the pro micro removeable without desoldering)
* 22 Kailh hotswap sockets
* 1 smd reset button
* 1 dip socket to mount between the pcb and pro micro if you choose to make it removeable without desoldering
* 5 (12mm) m2 standoffs
* 10 m2 screws
* Genuine Cherry pcb mount 2u stabilizer
* 4 rubber bumpons
* Pro Micro is included in kit

15
keyboards/chili/readme.md Normal file
View file

@ -0,0 +1,15 @@
# YDKB Chili
[Chili PCB](https://i.imgur.com/fKi896a.jpg)
The YDKB Chili is a Cherry G80-3000 replacement PCB utilizing the ATmega32U4 microcontroller.
* Keyboard Maintainer: QMK community
* Hardware Supported: YDKB Chili
* Hardware Availability: [TaoBao](https://item.taobao.com/item.htm?id=565823984744)
Make example for this keyboard (after setting up your build environment):
make chili:default
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).

84
keyboards/converter/adb_usb/readme.md Normal file
View file

@ -0,0 +1,84 @@
ADB-to-USB Keyboard Converter
=============================
This firmware converts Apple Desktop Bus (ADB) keyboard protocol to USB so that you can use an ADB keyboard on a modern computer. It works on the PJRC Teensy 2.0 and other USB AVR MCUs (ATMega32U4, AT90USB64/128, etc) and needs at least 10KB of flash memory.
This is a port of the TMK ADB-to-USB converter to QMK. For information on QMK, please consult the following:
https://github.com/qmk/qmk_firmware
https://docs.qmk.fm
Wiring
------
Connect the VCC, GND, and DATA lines of the ADB keyboard to the controller (Teensy 2.0 or similar). By default the DATA line uses port PD0. The Power SW line is unused by the converter.
ADB female socket from the front:
,--_--.
/ o4 3o \ 1: DATA
| o2 1o | 2: Power SW
- === - 3: VCC
`-___-' 4: GND
This converter uses AVR's internal pull-up, but it seems to be too weak, in particular when you want to use a long or coiled cable. Using an external pull-up resistor (1K-10K Ohm) between the DATA and VCC lines is strongly recommended.
Pull-up resistor:
Keyboard Converter
,------.
5V------+------|VCC |
| | |
[R] | |
| | |
Signal--+------|PD0 |
| |
GND------------|GND |
`------'
R: 1K Ohm resistor
Define following macros for ADB connection in config.h if you use other than port PD0.
ADB_PORT, ADB_PIN, ADB_DDR, ADB_DATA_BIT
Building the Firmware
------------------------------------------
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).
Keymap
------
To build the default keymap run this command:
$ make converter/adb_usb:default
You may add your own keymap to the converter/adb_usb/keymaps directory, as you would with any other QMK-powered keyboard.
To build your custom keymap, change the build command to:
$ make converter/adb_usb:my_keymap
Where 'my_keymap' is the name of your custom keymap directory.
Locking Caps Lock
----------------
Many old ADB keyboards use a locking switch for the caps lock key. This converter supports the locking caps lock key by default.
Notes
-----
Non-extended ADB keyboards make no distinction between the left and right modifiers,
i.e. the keycode for the left modifier will be sent even if the right modifier
The Apple Extended Keyboard and Apple Extended Keyboard II can differentiate between the left and right modifiers except for the GUI key (Windows/Command).
Most ADB keyboards have no diodes in its matrix so they are not NKRO,
though the ADB protocol itself supports it. See protocol/adb.c for more info.
QMK Port Changelog
---------
- 2018/09/16 - Initial release.
- 2018/12/23 - Fixed lock LED support.

51
keyboards/converter/m0110_usb/readme.md Normal file
View file

@ -0,0 +1,51 @@
# M0110(A) keyboard converter
This is a port of the original M0110 converter from TMK to QMK. The original converter was designed to work with **ATmega32U2** and **ATmega32U4** based microcontrollers to convert Apple M0110/M0110A keyboards and M0120 numpads to USB. This port has been tested to be compatible with the [**Adafruit Feather 32U4 BLE**](https://learn.adafruit.com/adafruit-feather-32u4-bluefruit-le).
## Enabling Bluetooth for the Adafruit Feather 32U4 BLE
Simply add `BLUETOOTH = AdafruitBLE` to your `rules.mk` file. This enables code specifically for the Adafruit Feather 32U4 BLE. If enabled, the device will use the `PRODUCT` and `DESCRIPTION` values from `config.h` for the device name displayed by the Feather on host devices. You can simply change these values to change the device name.
## Pins
This port utilizes the same pins that the TMK converter used. `PD1` is used for `CLOCK` and `PD0` is used for the `DATA` from the keyboard. These pins can be changed in `config.h`.
## Other important hardware notes from the original TMK converter Readme:
>### Hardware
>--------
>You can buy preassembled [TMK converter] or make yourown with AVR dev board like PJRC [Teensy].
>
>Port of the MCU `PD1` is assigned to `CLOCK` line and `PD0` to `DATA` by default, you can change pin configuration with editing `config.h`.
>
>[![M0110 Converter](http://i.imgur.com/yEp2eRim.jpg)](http://i.imgur.com/yEp2eRi.jpg)
>
>#### 4P4C phone handset cable
>Note that original cable used with Mac is **straight** while phone handset cable is **crossover**.
>
><http://en.wikipedia.org/wiki/Modular_connector#4P4C>
>
>[Teensy]: http://www.pjrc.com/teensy/
>[TMK converter]: https://geekhack.org/index.php?topic=72052.0
>
>
>#### Socket Pinout
>- <http://pinouts.ru/Inputs/MacKeyboard_pinout.shtml>
>
>![Jack fig](http://www.kbdbabel.org/conn/kbd_connector_macplus.png)
>
>
>#### Pull-up Resistor
>You may need pull-up resistors on signal lines(`CLOCK`, `DATA`) in particular when you have long or coiled cable. **1k-10k Ohm** will be OK >for this purpose. In that case the converter may not read signal from keyboard correctly without pull-up resistors.
>
[**View the original TMK converter Readme**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb)\
[**View the original TMK converter Repository**](https://github.com/tmk/tmk_keyboard/tree/master/converter/m0110_usb)
## QMK Port Changelog
- 2018/08/01 - Original Release

30
keyboards/converter/usb_usb/ble/readme.md Normal file
View file

@ -0,0 +1,30 @@
QMK BLE Adapter
===============
A small device that reads USB keyboard input and passes it on over Bluetooth LE HID.
![Picture of Adapter](https://i.imgur.com/O3VwBBJ.png)
Hardware
--------
The hardware is relatively easy to assemble. Just follow the schematic and don't forget to [cut the VBUS jumper](https://www.pjrc.com/teensy/td_libs_USBHostShield_4a.jpg).
Schematic:
![Schematic](https://i.imgur.com/s1Ia9We.png)
Part list:
* [Adafruit Feather 32u4 Bluefruit LE](https://www.adafruit.com/product/2829)
* [USB Host Mini](https://www.circuitsathome.com/arduino_usb_host_shield_projects/)
* [Pololu 5V Step-Up Voltage Regulator U3V12F5](https://www.pololu.com/product/2115)
* [Lithium Ion Battery - 3.7v 2000mAh](https://www.adafruit.com/product/2011)
* Some sort of switch to be able to turn it off
Building and Flashing
---------------------
```
make converter-usb_usb-ble
```
```
make converter-usb_usb-ble-avrdude
```

69
keyboards/converter/usb_usb/readme.md Normal file
View file

@ -0,0 +1,69 @@
USB to USB keyboard protocol converter
======================================
A small device to connect between your USB keyboard and your PC that makes (almost) every keyboard fully programmable.
Original code from the [TMK firmware](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb). Ported to QMK by [Balz Guenat](https://github.com/BalzGuenat).
Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
Hardware Supported: [Hasu's USB-USB converter](https://geekhack.org/index.php?topic=69169.0), [Pro Micro + USB Host Shield](https://geekhack.org/index.php?topic=80421.0), maybe more
Hardware Availability: [GH thread](https://geekhack.org/index.php?topic=72052.0), self-built
Make example for this keyboard (after setting up your build environment):
make converter/usb_usb:default
See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
Note that you have to choose the right hardware variant as your subproject, otherwise you will probably have issues.
Troubleshooting & Known Issues
------------------------------
If something doesn't work, it's probably because of the CPU clock.
Be sure to select the correct subproject (the middle part of the `make` argument) according to your hardware.
If you are sure you have this correct, try changeing the default in `usb_usb/rules.mk` or overriding the value in the `rules.mk` of your keymap.
The Pro Micro variant uses a 3.3V Pro Micro and thus runs at 8MHz, hence the following line in `usb_usb/pro_micro/rules.mk`:
`F_CPU = 8000000`
The converter sold by Hasu runs at 16MHz and so the corresponding line in `usb_usb/hasu/rules.mk` is:
`F_CPU = 16000000`
Getting the Hardware
--------------------
There are two options to get a converter: You can buy one from Hasu or build one yourself.
### Buy a Converter
You can buy a fully assembled converter from me here:
https://geekhack.org/index.php?topic=69169.0
### Build one yourself using Arduino Leonardo + Circuit@Home USB Host Shield 2.0
Buying Arduino Leonardo and USB Host Shield 2.0(from Circuit@home) will be better, you won't need even soldering iron.
- http://arduino.cc/en/Main/ArduinoBoardLeonardo
- https://www.circuitsathome.com/arduino_usb_host_shield_projects/
Other compatible boards like Arduino's Shield will also work well but I think Sparkfun's needs to be modified.
- http://arduino.cc/en/Main/ArduinoUSBHostShield
- https://www.sparkfun.com/products/9947
Also Pro Micro 3.3V(not Mini) or Teensy with mini host shield will work with some fixes on signal/power routing.
- [Build guide](https://geekhack.org/index.php?topic=80421.0)
- https://www.circuitsathome.com/arduino_usb_host_shield_projects/
- https://www.sparkfun.com/products/12587
- https://www.pjrc.com/teensy/td_libs_USBHostShield.html
Limitations
----------
Only supports 'HID Boot protocol'.
Note that the converter can host only USB "boot protocol" keyboard(6KRO), not NKRO, it is possible to support NKRO keyboard but you will need to write HID report parser for that. Every NKRO keyboard can have different HID report and it is difficult to support all kind of NKRO keyboards in the market.
Resources
--------
- [Hasu's main thread for the converter](https://geekhack.org/index.php?topic=69169.0)
- [Build guide for the Pro Micro variant](https://geekhack.org/index.php?topic=80421.0)
- [Original TMK version of the converter](https://github.com/tmk/tmk_keyboard/tree/master/converter/usb_usb)
- [USB Host Shield 2.0](https://www.circuitsathome.com/arduino_usb_host_shield_projects/)
- [USB Host Shield 2.0 source](https://github.com/felis/USB_Host_Shield_2.0)
- [Arduino USB Host Shield (with bootst converter)](http://arduino.cc/en/Main/ArduinoUSBHostShield)
- [Arduino source](https://github.com/arduino/Arduino)
- [Initial release of TMK USB-USB converter](https://geekhack.org/index.php?topic=33057.msg653549#msg653549)
- [Teensy/Arduino + Host Shield](http://deskthority.net/workshop-f7/is-remapping-a-usb-keyboard-using-teensy-possible-t2841-30.html#p74854)
- [Arduino-based hardware keyboard remapper - Colemak forum](http://forum.colemak.com/viewtopic.php?id=1561)
- [Teensy + Host Shield](http://www.pjrc.com/teensy/td_libs_USBHostShield.html)

17
keyboards/converter/xt_usb/readme.md Normal file
View file

@ -0,0 +1,17 @@
XT to USB keyboard converter
==============================
This is a port of TMK's converter/xt_usb to QMK.
This firmware converts XT keyboard protocol to USB.(It supports Scan Code Set 1.)
Connect Wires
-------------
1. Connect **Vcc** and **GND**.
2. Connect **Clock** and **Data** line. **Clock** is on `PD1`, **Data** on `PD0` by default. And optionally you can use `PB7` for **Reset**.(Compatible to Soarer's converter) To change pin configuration edit `config.h`.
3. You need pull-up resistor. **1K-10K Ohm** will be OK.
XT keyboard protocol resource
------------------------------
https://github.com/tmk/tmk_keyboard/wiki/IBM-PC-XT-Keyboard-Protocol

21
keyboards/db/db63/readme.md Normal file
View file

@ -0,0 +1,21 @@
# DB63
A 65% keyboard hotswap with RGB that runs ps2avrgb natively, with USB C, RGB underglow and backlight.
* Keyboard Maintainer: QMK Community
* Hardware Supported: DB63 (ATmega32A)
* [Keyboard layout](http://www.keyboard-layout-editor.com/#/gists/dadea703fc8bfc87dc7c480de9f3ef38)
Make example for this keyboard (after setting up your build environment):
make db/db63:default
Flashing example for this keyboard ([after setting up the bootloadHID flashing environment](https://docs.qmk.fm/#/flashing_bootloadhid))
make db/db63:default:flash
**Reset Key**: Hold down the key located at *K00*, commonly programmed as *Escape* while plugging in the keyboard. (*All backlight LEDs will flash which indicate the board is in bootloader mode.*)
**Tips**: Another trick to enable the board in reset mode is using BootMapper Client->Options->Set Bootloader. (*This is only available for the first time, before flashing QMK Firmware.*)
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).

167
keyboards/fc660c/readme.md Normal file
View file

@ -0,0 +1,167 @@
FC660C Alt Controller
=================
This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c
------------
- Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
- Hardware Supported: Hasu's Alt Controller (see below)
- Hardware Availability: https://geekhack.org/index.php?topic=90317.0
Make example for this keyboard (after setting up your build environment):
make fc660c:default
See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
To flash the firmware, press the reset button on the controller and run:
sudo make fc660c:default:dfu
--------
Thread on Geekhack: https://geekhack.org/index.php?topic=88439.0
Also: https://geekhack.org/index.php?topic=88720.0
Actuation Point adjustment
--------------------------
You can adjust the actuation point of the keys by setting `ACTUATION_DEPTH_ADJUSTMENT` in `config.h`.
A value above 0 will result in a deeper, less sensitive actuation whereas a value above 1 will result in a more shallow, more sensitive actuation.
Be careful with this setting and use small values (+/-5).
See the `actuation-point-example` keymap of the `fc980c` keyboard for an example.
For more information, inspect the `fc660c_i2c` branch of TMK [here](https://github.com/tmk/tmk_keyboard/tree/fc660c_i2c).
Functionality for writing to the EEPROM has deliberately not been included to reduce the chance of people messing up their boards.
Pinouts
-------
|Switch |Controller |
| board | board |Description |Schematic |ATmega32u4
|--------|-----------|--------------------------------------|-----------|------------
| 1 |20 | FG |FG |GND
| 2 |19 | GND |GND |GND
| 3 |18 | GND |GND |GND
| 4 |17 | 3.3V |V33 |3.3V/5V
| 5 |16 | 5V |Vcc |5V
| 6 |15 |*Z6-TP1684-4-HYS(o) |FBSTB |PC7
| 7 |14 |*Z6-TP1684-2-KEY(i) |OUT |PC6
| 8 |13 |*Z2-AD5258-5-SCL(I2C) |SCL |PD0(TWI)
| 9 |12 |*Z2-AD5258-4-SDA(I2C) |SDA |PD1(TWI)
|10 |11 |*Z4-LV4051A-6-~EN(Col 0-7) |INH_1 |PB4
|11 |10 |*Z5-LV4051A-6-~EN(Col 8-F) |INH_2 |PB3
|12 | 9 |+Z7-LV07A-5 (LV4051A-9-C) |SEL_C |PB2
|13 | 8 |+Z7-LV07A-1 (LV4051A-10-B) |SEL_B |PB1
|14 | 7 |+Z7-LV07A-3 (LV4051A-11-A) |SEL_A |PB0
|15 | 6 |+Z3-LVC138A-3-C |COL4 |PD6
|16 | 5 |+Z3-LVC138A-2-B |COL3 |PD5
|17 | 4 |+Z3-LVC138A-1-A |COL2 |PD4
|18 | 3 |+Z3-LVC138A-4-~G2A Z6-TP1684-5-~EN |COL1 |PD7
|19 | 2 |+Z7-LV07A-11-~InsertLED |LED1 |PB5
|20 | 1 |+Z7-LV07A-13-~CapsLED |LED2 |PB6
```
* 5V intferface
+ 3.3V interface
```
- Connector on Switch board: https://i.imgur.com/Zi89xO5.jpg
- Connector on Controller board: https://i.imgur.com/9SZUzYo.jpg
Key Matrix
----------
Row5-7 have no key, you can omit scaning on those lines. Topre original controller scans those rows for some reason.
| |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |A |B |C |D |E |F |
|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
| 0|Q |W |E |Tab |R |U |T |Y |O |P |[ |I |] | |\ |Del |
| 1|1 |2 |3 |Esc |4 |7 |5 |6 |9 |0 |- |8 |= | |BSpc|Ins |
| 2| |LWin|LAlt|LCtl| | | |Spc |RAlt| |RCtl| |Fn |Down|Left|Rght|
| 3| |Z |X |LSft|C |N |V |B |, |. |/ |M |RSft|Up | | |
| 4|A |S |D |Caps|F |J |G |H |L |; |' |K | | |Entr| |
| 5| | | | | | | | | | | | | | | | |
| 6| | | | | | | | | | | | | | | | |
| 7| | | | | | | | | | | | | | | | |
Logic analyzer pics:
- http://i.imgur.com/9XoNTev.png
- https://i.imgur.com/5FCP1Ay.png
This code emuluates what original cotnroller does for matrix scan.
- https://github.com/tmk/tmk_keyboard/blob/master/keyboard/fc660c/fc660c.c
### Row designation
LV138A(Z3) selects a row line and gives strobe by enabling with ~G2A(18).
|Row |A/17|B/16|C/15|
|----|----|----|----|
|0 |0 |0 |0 |
|1 |1 |0 |0 |
|2 |0 |1 |0 |
|3 |1 |1 |0 |
|4 |0 |0 |1 |
|5 |1 |0 |1 |
|6 |0 |1 |1 |
|7 |1 |1 |1 |
### Column designation
LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches.
|Col |A/14|B/13|C/12|Z4-EN/10|Z5-EN/11|
|----|----|----|----|--------|--------|
|0 |0 |0 |0 |0 |1 |
|1 |1 |0 |0 |0 |1 |
|2 |0 |1 |0 |0 |1 |
|3 |1 |1 |0 |0 |1 |
|4 |0 |0 |1 |0 |1 |
|5 |1 |0 |1 |0 |1 |
|6 |0 |1 |1 |0 |1 |
|7 |1 |1 |1 |0 |1 |
|8 |0 |0 |0 |1 |0 |
|9 |1 |0 |0 |1 |0 |
|A |0 |1 |0 |1 |0 |
|B |1 |1 |0 |1 |0 |
|C |0 |0 |1 |1 |0 |
|D |1 |0 |1 |1 |0 |
|E |0 |1 |1 |1 |0 |
|F |1 |1 |1 |1 |0 |
FCC documents
-------------
https://fccid.io/RPKFC660C
- schematic: https://fccid.io/pdf.php?id=1888185
- part list: https://fccid.io/pdf.php?id=1888184
Datasheets
----------
- Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf
- LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf
- LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf
- LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf
- AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf
3.3V power supply
-----------------
LV07A and LVC138A are 5V-tolerant and can be powered with 5V, the keyboard will work only with 5V power supply. It may not be completely safe to operate LV138A with 5V Vcc, its datasheet says:
> Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability.
Digipot AD5258
--------------
Controller can operate AD5258 via I2C to change actuation point of keys. This may make keyboard unusable accidentally and it will be difficult to recovery in some situation. For safety firmware doesn't support it at this point, though.
Lower value of RDAC register causes shallower actuation point.
Resources
---------
- Pics: https://imgur.com/a/UTR8Z

185
keyboards/fc980c/readme.md Normal file
View file

@ -0,0 +1,185 @@
FC980C Alt Controller
=====================
This file and the entire QMK port of this board are based on its TMK implementation: https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc980c
------------
- Keyboard Maintainer: [Balz Guenat](https://github.com/BalzGuenat)
- Hardware Supported: Hasu's Alt Controller (see below)
- Hardware Availability: https://geekhack.org/index.php?topic=90104.0
Make example for this keyboard (after setting up your build environment):
make fc980c:default
See [build environment setup](https://docs.qmk.fm/#/getting_started_build_tools) then the [make instructions](https://docs.qmk.fm/#/getting_started_make_guide) for more information.
To flash the firmware, press the reset button on the controller and run:
sudo make fc980c:default:dfu
-----------
This controller replaces original controller of Leopold FC980C and makes the keyboard programmable.
Discuss this here: https://geekhack.org/index.php?topic=90681.0
The keyboard is very similar electronically to its sibling model FC660C you can also refer this.
FC660C Alt Controller: https://geekhack.org/index.php?topic=88439.0
Actuation Point adjustment
--------------------------
You can adjust the actuation point of the keys by setting `ACTUATION_DEPTH_ADJUSTMENT` in `config.h`.
A value above 0 will result in a deeper, less sensitive actuation whereas a value above 1 will result in a more shallow, more sensitive actuation.
Be careful with this setting and use small values (+/-5).
See the `actuation-point-example` keymap for an example.
For more information, inspect the `fc660c_i2c` branch of TMK [here](https://github.com/tmk/tmk_keyboard/tree/fc660c_i2c).
Functionality for writing to the EEPROM has deliberately not been included to reduce the chance of people messing up their boards.
Hardware
--------
This project uses common and familiar ATmega32u4 but any microcontroller with 5V I/O will work.
- Schematic of Alt controller: schematic.pdf
Pin configuration
-----------------
Connector bridging between switch board and controller is Hirose DF14A-20P-1.25H.
|Switch |Controller |
| board | board |Description |Function |ATmega32u4
|--------|-----------|--------------------------------------|-----------|------------
| 1 |20 | FG |FG |GND
| 2 |19 | GND |GND |GND
| 3 |18 | GND |GND |GND
| 4 |17 | 3.3V |V33 |3.3V/5V
| 5 |16 | 5V |Vcc |5V
| 6 |15 |*Z6-TP1684-4-HYS(o) |KEY_HYS |PC7
| 7 |14 |*Z6-TP1684-2-KEY(i) |KEY_STATE |PC6
| 8 |13 |*Z7-AD5258-5-SCL(I2C) |I2C_SCL |PD0(TWI)
| 9 |12 |*Z7-AD5258-4-SDA(I2C) |I2C_SDA |PD1(TWI)
|10 |11 |*Z5/4-LV4051A-6-~EN(Lo:Z5 Hi:Z4) |COL_bit3 |PB3
|11 |10 |+Z3-LV07A-5 (LV4051A-9-C) |COL_bit2 |PB2
|12 | 9 |+Z3-LV07A-1 (LV4051A-10-B) |COL_bit1 |PB1
|13 | 8 |+Z3-LV07A-3 (LV4051A-11-A) |COL_bit0 |PB0
|14 | 7 |+Z1-LVC138A-3-C |ROW_bit2 |PD6
|15 | 6 |+Z1-LVC138A-2-B |ROW_bit1 |PD5
|16 | 5 |+Z1-LVC138A-1-A |ROW_bit0 |PD4
|17 | 4 |+Z1-LVC138A-4-~G2A Z6-TP1684-5-~EN |KEY_ENABLE |PD7
|18 | 3 |+Q4-NPN-B-NumLock_LED(Hi:On) |LED_NUML |PB4
|19 | 2 |+Q3-NPN-B-CapsLock_LED(Hi:On) |LED_CAPS |PB5
|20 | 1 |+Q2-NPN-B-ScrollLock_LED(Hi:On) |LED_SCRL |PB6
```
* 5V intferface
+ 3.3V interface
```
Switch matrix
-------------
| |0 |1 |2 |3 |4 |5 |6 |7 |8 |9 |A |B |C |D |E |F |
|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|----|
| 0|Left|RCtl|RAlt| |Down|P. |Righ|P0 |X |LGui|` |V | |Esc |M |Spc |
| 1|Fn |. | | |P1 |PEnt|P2 |P3 |Z |LAlt|LCtl|C |K | |N |B |
| 2|' |/ |, | |P4 |P+ |P5 |P6 |D |A |LSft|F |J |F1 |H |G |
| 3|RSft|; |L |] |Up | | | |S |Q |Caps|R |I |F3 |U |T |
| 4| | | | | | | | | | | | | | | | |
| 5|= |- |0 |\ |NLck|BSpc|P/ |P* |3 |2 | |4 |9 |F2 |7 |6 |
| 6|[ |P |O |Ent |P7 |P- |P8 |P9 |W |1 |Tab |E |8 |F4 |Y |5 |
| 7|F11 |F10 |F9 |F12 |Del |PgDn|Ins |PgUp| | | | |F8 |F5 |F7 |F6 |
Row designation
---------------
LV138A(Z1) selects one of 8 row lines and gives strobe by enabling with ~G2A(17).
|ROW |bit0|bit1|bit2|
|----|----|----|----|
|0 |0 |0 |0 |
|1 |1 |0 |0 |
|2 |0 |1 |0 |
|3 |1 |1 |0 |
|4 |0 |0 |1 |
|5 |1 |0 |1 |
|6 |0 |1 |1 |
|7 |1 |1 |1 |
Column designation
------------------
LV4051A(Z4, Z5) select one of 16 column lines to sense capacitance of switches.
|COL |bit0|bit1|bit2|bit3|
|----|----|----|----|----|
|0 |0 |0 |0 |0 |
|1 |1 |0 |0 |0 |
|2 |0 |1 |0 |0 |
|3 |1 |1 |0 |0 |
|4 |0 |0 |1 |0 |
|5 |1 |0 |1 |0 |
|6 |0 |1 |1 |0 |
|7 |1 |1 |1 |0 |
|8 |0 |0 |0 |1 |
|9 |1 |0 |0 |1 |
|A |0 |1 |0 |1 |
|B |1 |1 |0 |1 |
|C |0 |0 |1 |1 |
|D |1 |0 |1 |1 |
|E |0 |1 |1 |1 |
|F |1 |1 |1 |1 |
Firmware
--------
Just `make` to build firmware. And consult with wiki for further information.
- https://github.com/tmk/tmk_keyboard/tree/master/keyboard/fc660c
- https://github.com/tmk/tmk_keyboard/wiki
Datasheets
----------
- Hirose DF14A-20P-1.25H: http://www.mouser.com/ds/2/185/DF14_catalog-939195.pdf
- LV07A: http://www.ti.com/lit/ds/symlink/sn74lv07a.pdf
- LV138A: http://www.ti.com/lit/ds/symlink/sn74lvc138a.pdf
- LV4051A: http://www.ti.com/lit/ds/symlink/sn74lv4051a.pdf
- AD5258: http://www.analog.com/media/en/technical-documentation/data-sheets/AD5258.pdf
- JST S5B-PH-SM4: http://www.jst-mfg.com/product/pdf/eng/ePH.pdf
- Hirose UX60SC-MB-5S8: https://www.hirose.com/product/en/products/UX/UX60SC-MB-5S8%2880%29/
- Tr(E42) for LED?: http://www.bklighting.com/cimages/specs-758.pdf
- TYU TU1252WNR-05S: http://php2.twinner.com.tw/files/goodjob/TY1252series.pdf
3.3V power supply
-----------------
LV07A and LVC138A are 5V-tolerant and can be powered with 5V, the keyboard will work only with 5V power supply. It may not be completely safe to operate LV138A with 5V Vcc, its datasheet says:
> Exposure to absolute-maximum-rated conditions for extended periods may affect device reliability.
Digipot AD5258
--------------
Controller can operate AD5258 via I2C to change actuation point of keys. This may make keyboard unusable accidentally and it will be difficult to recovery in some situation. For safety firmware doesn't support it at this point, though.
Lower value of RDAC register causes shallower actuation point.
USB connector board
-------------------
The keyboard has USB receptacle on small separate 1.0mm-thick PCB. USB receptacle is Hirose UX60SC-MB-5S8 while wire-to-PCB connector is TYU TU1252WNR-05S.
http://i.imgur.com/Nucn6h9.jpg
Resources
---------
- Pics: http://imgur.com/a/HhyIq

16
keyboards/flehrad/bigswitch/readme.md Normal file
View file

@ -0,0 +1,16 @@
Big Switch PCB by flehrad
=========================
Designed by Don of the Board Podcast and sold as a kit by [keeb.io](https://keeb.io/collections/frontpage/products/big-switch-pcb?variant=7507922845726)
### PCB Files
https://github.com/flehrad/Big-Switch-PCB
make: flehrad/bigswitch:default
### Technical Specifications
* Uses a atmega32u4 pro micro or pin compatible MCU
* Pins B5 and B6 connect to the pins on the Big Switch
* Optionally you may add a RGB strip to pin D3 for data and take power from VCC and GND

15
keyboards/handwired/42/readme.md Normal file
View file

@ -0,0 +1,15 @@
# 42
42-keys ergonomic keyboard running on Adafruit Feather BLE.
![42](https://github.com/nglgzz/42/raw/master/42.jpg)
Keyboard Maintainer: [Angelo Gazzola (nglgzz)](https://github.com/nglgzz)
Hardware Supported: 42 (rev2, rev3), Feather 32u4 BLE
Hardware Availability: [GitHub](https://github.com/nglgzz/42/)
Make example for this keyboard (after setting up your build environment):
make handwired/42:default
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).

Some files were not shown because too many files have changed in this diff Show more