sporq/kmk_firmware
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

I missed a few things in the docs

Browse Source
This commit is contained in:
Cole Smith 2022-04-19 10:05:19 -07:00 committed by xs5871
parent 719cef4945
commit 664af4d4f2
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/peg_oled_display.md
View File

@ -14,16 +14,16 @@ To use this you need to make some changes to your kb.py as well as you main.py I
* React to WPM
## Required Libs
you need these frozen into your circuitpython or in a lib folder at the root of your drive.
You need these frozen into your circuitpython or in a lib folder at the root of your drive.
* [Adafruit_CircuitPython_DisplayIO_SSD1306](https://github.com/adafruit/Adafruit_CircuitPython_DisplayIO_SSD1306)
* [Adafruit_CircuitPython_Display_Text](https://github.com/adafruit/Adafruit_CircuitPython_Display_Text)
* [download .mpy versions from here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20220415/adafruit-circuitpython-bundle-7.x-mpy-20220415.zip)
* [Download .mpy versions from here](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/releases/download/20220415/adafruit-circuitpython-bundle-7.x-mpy-20220415.zip)
## kb.py
Your chosen board may already have these changes done If not you will need to add them.
you need to add SCL and SDA to your keyboard. The pins the oled are connected to on your controller may not be called "SCL"and "SDA" they could be "GP21" and "GP13" for example. The best way to find out what they are is look at the boards pinout.
You need to add SCL and SDA to your keyboard. The pins the oled are connected to on your controller may not be called "SCL"and "SDA" they could be "GP21" and "GP13" for example. The best way to find out what they are is look at the boards pinout.
```python
SCL=board.SCL
SDA=board.SDA
@ -33,7 +33,7 @@ you need to add SCL and SDA to your keyboard. The pins the oled are connected to
## Main.py
These are the changes that need to be made / added to your main.py
### Config
no mater how you are going to use the oled you need this part
No mater how you are going to use the oled you need this part
```python
from kmk.extensions.peg_oled_Display import Oled,OledDisplayMode,OledReactionType,OledData
keyboard = KMKKeyboard()
@ -47,13 +47,13 @@ So the config for photos is quite simple. Getting the photos maybe not so much.
Oled takes 2-3 arguments
1. OledData
* OledData can take image **or** corner_one,corner_two,corner_three and corner_four
* OledData can take image **or** corner_one, corner_two, corner_three and corner_four
* Every item in OledData has 2 fields
* 0: this is the reaction type right now it can be OledReactionType.LAYER or OledReactionType.STATIC
* 0: This is the reaction type right now it can be OledReactionType.LAYER or OledReactionType.STATIC
* 1: An array of the items you want to show for the reaction. In this example 4 images to switch on the 4 layers
2. toDisplay this takes a OledDisplayMode TXT or IMG.
* this tells the extension to load images or text.
3. flip Boolean this will simply flip your display.
2. To display called as "toDisplay=OledDisplayMode.TXT" this takes a OledDisplayMode TXT or IMG.
* This tells the extension to load images or text.
3. Flip called as "flip= Boolean" this will simply flip your display.
```python
@ -94,7 +94,7 @@ oled_ext = Oled(
```
### Note
your oled data can be a variable as shown below with images
Your oled data can be a variable as shown below with images.
```python
oled_display_data=OledData(image={0:OledReactionType.LAYER,1:["1.bmp","2.bmp","1.bmp","2.bmp"]})