diff options
| author | Joel Challis <git@zvecr.com> | 2020-03-18 18:14:45 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-03-18 11:14:45 -0700 |
| commit | b6316c502499fd245cfb5ad468d7870d229f55d4 (patch) | |
| tree | 9f61de0140fccabaa7f499008cc3ec03931e8414 /keyboards/handwired/onekey/keymaps/i2c_scanner/readme.md | |
| parent | fc4ef6934dc8596882428d11877d065ca6272129 (diff) | |
| download | qmk_firmware-b6316c502499fd245cfb5ad468d7870d229f55d4.tar.gz qmk_firmware-b6316c502499fd245cfb5ad468d7870d229f55d4.zip | |
[Keymap] I2C scanner (#8454)
* Add i2c scanner keymap
* Add bodge for chibios
* Fix readme title
* make chibios bodge a little cleaner
* fix typo in readme
Diffstat (limited to 'keyboards/handwired/onekey/keymaps/i2c_scanner/readme.md')
| -rw-r--r-- | keyboards/handwired/onekey/keymaps/i2c_scanner/readme.md | 36 |
1 files changed, 36 insertions, 0 deletions
diff --git a/keyboards/handwired/onekey/keymaps/i2c_scanner/readme.md b/keyboards/handwired/onekey/keymaps/i2c_scanner/readme.md new file mode 100644 index 0000000000..ce6357a9c2 --- /dev/null +++ b/keyboards/handwired/onekey/keymaps/i2c_scanner/readme.md @@ -0,0 +1,36 @@ +# i2c_scanner + +Aiming to provide a more qmk friendly version of <https://playground.arduino.cc/Main/I2cScanner/> + +> This very simple ~~sketch~~ keymap scans the I2C-bus for devices. If a device is found, it is reported to the ~~Arduino serial monitor~~ console. + + +## Flashing + +Pick a target that is aligned to the MCU you want to test: + +```console +make handwired/onekey/elite_c:i2c_scanner:flash # also 32u4 + dfu bootloader +make handwired/onekey/promicro:i2c_scanner:flash +make handwired/onekey/teensy_2:i2c_scanner:flash + +# ChibiOS is currently 'best effort' and might not report accurate results +make handwired/onekey/proton_c:i2c_scanner:flash +``` + +others might work with additional configuration. + +## Usage + +Output is viewable through a compatible tool <https://docs.qmk.fm/#/newbs_testing_debugging?id=debugging-tools>. + +You can change the wires, and plug-in I2C devices while the i2c_scanner is running. + +The output of the console will look like this: + +``` +Listening: +Scanning... + I2C device found at address 0x20 +done +``` |