Skip to content

Commit c46f914

Browse files
author
Kirk
committed
actual production readme
1 parent daf362d commit c46f914

File tree

1 file changed

+26
-50
lines changed

1 file changed

+26
-50
lines changed

README.md

Lines changed: 26 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -11,58 +11,34 @@
1111
alt="follow on Twitter"></a>
1212

1313
</p>
14-
A new Arduino library to support SparkFun's qwiic OLED boards
14+
The SparkFun Qwiic OLED Arduino Library is a single graphics module that supports all SparkFun OLED boards based on the SSD1306 from Solomon Systech. Prior to this library, three different libraries were used to support our four different OLED boards.
1515

16-
Currently in Development - Alpha
16+
The SparkFun Qwiic OLED Library delivers a common implementation for all our Qwiic OLED products, delivering a unified, fast, and efficient solution that implements a familiar and easy to understand user experience.
1717

18-
## Contents
19-
* [Documentation](https://sparkfun.github.io/SparkFun_Qwiic_OLED_Arduino_Library/)
20-
* [Development Status](#development-status)
18+
## Key Features
19+
* Implements common graphics capabilities: pixel, line, rectangle, filled rectangle, circle, filled circle, bitmap, text and raster operators (i.e. XOR).
20+
* Smart data transfer to the device – only sends _dirty_ regions of the graphics buffer to the OLED device, not the entire buffer.
21+
* High performance – 2x faster than our previous OLED library, often much higher.
22+
* Efficient memory usage. No dynamic memory utilized. Static resources are loaded once, and only on explicit declaration.
23+
* Implements a familiar interface, making migration from older libraries straight forward
2124

25+
## Documentation
26+
A full library use overview, API reference guide and key example walk through are available on this repositories github page - [sparkfun.github.io/SparkFun_Qwiic_OLED_Arduino_Library](https://sparkfun.github.io/SparkFun_Qwiic_OLED_Arduino_Library/)
2227

23-
Development Status
24-
------------------
25-
### Implemented
26-
* Fast data transfers/updates to OLED device
27-
* Only transfers needed bytes
28-
* 2x to 6x performance gains over current Micro OLED libray. Massive gains over "hyperdisplay"
29-
* C++ / Platform neutral implementation
30-
* Pixel set
31-
* General lines
32-
* Fast horizontal lines
33-
* Fast vertical lines
34-
* Rectangles (fast)
35-
* Filled rectangles (fast)
36-
* Circles
37-
* Filled Circles
38-
* Bitmap images (fast - 5x improvement on demo test)
39-
* Fonts and Text rendering
40-
* scrolling
41-
* flip - vert & horz
42-
* invert
43-
* Raster OPs (ROPS) - XOR, Not, Copy, Not Copy, Black and White
44-
* Arduino Object interface
28+
## Supported Products
4529

46-
### To Be Implemented
47-
* Functionally Complete
48-
### Known Issues
49-
* Filled circles being clipped/not drawn based on positon
50-
* Narrow OLED - some pixels - max X are not getting erased at times
51-
* See on nrf5280 and ESP32
52-
* Fill Circle - XOR - some double draws so not a clean render ..
53-
## Hardware
54-
### Tested/Working
55-
* Qwiic Micro OLED
56-
* Qwiic "narrow OLED"
57-
* Qwiic Transparent OLED
58-
* Artemis
59-
* SAMD51
60-
* ESP32
61-
* STM32
62-
* SAMD21
63-
* nrf5280
64-
* Teensy (MicroMod + ATP carrier)
65-
* Redboard Plus (works mostly. Cube demo w/ Transparent OLED fails - runs out of memory - not surprizing)
66-
### To Be Tested/Supported
67-
* RP2040 - Not working. Note - doesn't work with old Micro OLED library either
68-
*
30+
* [LCD-14532](https://www.sparkfun.com/products/14532) - SparkFun Micro OLED Breakout (Qwiic)
31+
* [LCD-17153](https://www.sparkfun.com/products/17153) - SparkFun Qwiic OLED Display (0.91 in, 128x32)
32+
* [LCD-15173](https://www.sparkfun.com/products/15173) - SparkFun Transparent Graphical OLED Breakout (Qwiic)
33+
* [SPX-18996](https://www.sparkfun.com/products/18996) - smôl Display (0.91 in, 128x32)
34+
35+
### Supported Microcontrollers - Arduino Environment
36+
37+
* [Artemis](https://www.sparkfun.com/products/15574)
38+
* [SAMD51](https://www.sparkfun.com/products/14713)
39+
* [ESP32](https://www.sparkfun.com/products/15663)
40+
* [STM32](https://www.sparkfun.com/products/17712)
41+
* [SAMD21](https://www.sparkfun.com/products/14812)
42+
* [nrf5280](https://www.sparkfun.com/products/15025)
43+
* [Teensy](https://www.sparkfun.com/products/16402)
44+
* [ATMega328](https://www.sparkfun.com/products/18158)

0 commit comments

Comments
 (0)