~mil/ppbbq10

5066dd8675b295ff7ffed11123a519a6c30def8e — Miles Alan 9 months ago 815c0db
README clarifications
2 files changed, 12 insertions(+), 6 deletions(-)

M README.md
A ppbbkb.jpg
M README.md => README.md +12 -6
@@ 1,15 1,21 @@
# ppbbq10

Kernel module for [Arturo182's BBQ10](https://www.tindie.com/products/arturo182/bb-q10-keyboard-pmod/) PMOD.
Forked from: 
[![ppbbkb.jpg](ppbbkb.jpg)](http://media.lrdu.org/experiments/pinephone_bbkb.webm)

Current differences:
- Assumed Pinephones I2C (e.g. uses /dev/i2c-3 rather then relying on DTC update)
## Overview

Kernel module for [Arturo182's BBQ10](https://www.tindie.com/products/arturo182/bb-q10-keyboard-pmod/) PMOD that works out of the box with the Pinephone. Forked from:  https://github.com/arturo182/bbq10pmod_module . Supports multiple layers and mod-tap modifiers.

Current differences from Arturo's original kernel module:
- Assumes Pinephones I2C (e.g. uses /dev/i2c-3 rather then relying on DTC update)
- Uses polling rather then interrupts (yes I know this is aint great)
- Support secondary layer by pressing Sym button (rather then keymap)
- Tap-modifier & Hold-modifiers for Ctrl, Alt, Shift, and 2ndary layer

Planned:
- Support QMK-like features (like tap modifiers etc.)
- Multiple layers
- 3rd layer support for programming symbols etc
- Remove polling, figure out interrupts
- Bugfixes to improve reliability on disconnect / reconnect and suspend / resume

## Usage Instructions
Tested on pmOS but should generally work on any distro.

A ppbbkb.jpg => ppbbkb.jpg +0 -0