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

fixed docs formatting

Browse Source
This commit is contained in:
Cole Smith
2022-04-18 17:28:00 -07:00
committed by xs5871
parent 9b34fcd7ef
commit 719cef4945
1 changed files with 11 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

22
docs/peg_oled_display.md
View File

@@ -4,14 +4,14 @@ To use this you need to make some changes to your kb.py as well as you main.py I
### What you can and cant do ### What you can and cant do
#### Can do #### Can do
* display images * Display images
* display text * Display text
* set images or text to react to your layer * Set images or text to react to your layer
#### Cant do yet / on the way #### Cant do yet / on the way
* react to battery percentage * React to battery percentage
* react to WPM * React to WPM
## Required Libs ## 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.
@@ -44,13 +44,13 @@ no mater how you are going to use the oled you need this part
### Photos ### Photos
So the config for photos is quite simple. Getting the photos maybe not so much. I will explain. So the config for photos is quite simple. Getting the photos maybe not so much. I will explain.
oled takes 2-3 arguments Oled takes 2-3 arguments
1. OledData 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 * 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 * 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. 2. toDisplay this takes a OledDisplayMode TXT or IMG.
* this tells the extension to load images or text. * this tells the extension to load images or text.
3. flip Boolean this will simply flip your display. 3. flip Boolean this will simply flip your display.
@@ -71,10 +71,10 @@ Ok now we get into something that looks a lot more complicated but we will get t
Almost everything is the same We swap toDisplay to TXT and there are more items in the OledData Class, lets get into that. Almost everything is the same We swap toDisplay to TXT and there are more items in the OledData Class, lets get into that.
1. top left 1. Top left
2. top right 2. Top right
3. bottom left 3. Bottom left
4. bottom right 4. Bottom right
After that is the same as the previous example. Each one has two fields 0:the reaction type. 1:what to display After that is the same as the previous example. Each one has two fields 0:the reaction type. 1:what to display