|
2 | 2 |
|
3 | 3 |  |
4 | 4 |
|
5 | | -==TODO: Add Wonderful Intro Here== |
| 5 | +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. |
6 | 6 |
|
7 | | -## Supported Products |
| 7 | +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. |
| 8 | + |
| 9 | +### Key Features |
| 10 | +* Implements common graphics capabilities: pixel, line, rectangle, filled rectangle, circle, filled circle, bitmap, text and raster operators (i.e. XOR). |
| 11 | +* Smart data transfer to the device – only sends _dirty_ regions of the graphics buffer to the OLED device, not the entire buffer. |
| 12 | +* High performance – 2x faster than our previous OLED library, often much higher. |
| 13 | +* Efficient memory usage. No dynamic memory utilized. Static resources are loaded once, and only on explicit declaration. |
| 14 | +* Implements a familiar interface, making migration from older libraries straight forward |
| 15 | + |
| 16 | +### Getting Started |
| 17 | + |
| 18 | +The [Getting Started Page](software.md) outlines library installation and the general use of the qwiic OLED library. |
| 19 | + |
| 20 | +Detailed examples are included as part of the library installation process and available in the Arduino IDE `File > Examples >` menu. A walk-thru of key examples is contained in the [Examples](sparkfun-qwiic-oled-arduino-library-examples/ex_01_hello/) section of this documentation set. |
| 21 | + |
| 22 | + |
| 23 | +A full [API Reference](api_device.md) is also provided for the library. |
| 24 | + |
| 25 | +### Supported Products |
8 | 26 |
|
9 | 27 | The SparkFun Qwiic OLED Arduino Library supports the following SparFun Products |
10 | 28 |
|
@@ -32,11 +50,18 @@ The SparkFun Qwiic OLED Arduino Library supports the following SparFun Products |
32 | 50 | </tr> |
33 | 51 | </table> |
34 | 52 |
|
35 | | -## Getting Started |
36 | 53 |
|
37 | | -The [Getting Started Page] outlines library installation and the general use of the qwiic OLED library. |
38 | 54 |
|
39 | | -Detailed examples are included as part of the library installation process and available in the Arduino IDE `File > Examples >` menu. |
| 55 | +### Supported Microcontrollers - Arduino Environment |
40 | 56 |
|
41 | | -A complete listing of the qwiic OLED library API is available on the [API Page]. |
| 57 | +* [Artemis](https://www.sparkfun.com/products/15574) |
| 58 | +* [SAMD51](https://www.sparkfun.com/products/14713) |
| 59 | +* [ESP32](https://www.sparkfun.com/products/15663) |
| 60 | +* [STM32](https://www.sparkfun.com/products/17712) |
| 61 | +* [SAMD21](https://www.sparkfun.com/products/14812) |
| 62 | +* [nrf5280](https://www.sparkfun.com/products/15025) |
| 63 | +* [Teensy](https://www.sparkfun.com/products/16402) |
| 64 | +* [ATMega328](https://www.sparkfun.com/products/18158) |
42 | 65 |
|
| 66 | +### License |
| 67 | +The SparkFun Qwiic OLED Arduino Library is licensed using the Open Source MIT License |
0 commit comments