Skip to content

Commit 52a21b0

Browse files
committed
content updates -- in progress
1 parent 5f6cdf5 commit 52a21b0

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,39 @@
1+
# SparkFun Qwiic SerLCD - Python Module
12

23
![Qwiic SerLCD Python Module](docs/images/gh-banner-py-qwiic-serlcd.png "qwiic SerLCD Python Module" )
34

4-
# SparkFun Qwiic SerLCD Python Module
5-
6-
A Python module for the SparkFun Qwiic SerLCD series of products. This module works with Python, MicroPython and CircuitPython.
7-
85

96
![Python Versions](https://img.shields.io/pypi/pyversions/sparkfun_qwiic_serlcd)
107
![GitHub issues](https://img.shields.io/github/issues/sparkfun/Qwiic_SerLCD_Py)
118
![License](https://img.shields.io/github/license/sparkfun/Qwiic_SerLCD_Py)
129
![X](https://img.shields.io/twitter/follow/sparkfun
1310
)
1411

15-
## Supported SparkFun Products
12+
The line of SparkFun Qwiic SerLCD products provide a simple and cost effective solution for adding a "text based" LCD display to your project. Implementing a SparkFun Qwiic interface, a SerLCD is rapidly added to any board that is part of the SparkFun Qwiic ecosystem.
13+
14+
This repository implements a Python module for the SparkFun Qwiic SerLCD series of products. This module works with Python, MicroPython and CircuitPython.
15+
16+
## Overview
17+
18+
### Supported SparkFun Products
1619

1720
This Python module supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
1821

1922
* [SparkFun SerLCD 16x2 - RGB Backlight (QWIIC)](https://www.sparkfun.com/products/16396)
2023
* [SparkFun SerLCD 16x2 - RGB Text (QWIIC)](https://www.sparkfun.com/products/16397)
2124
* [SparkFun SerLCD 20x2 - RGB Backlight (QWIIC)](https://www.sparkfun.com/products/16398)
2225

26+
### Supported Platforms
27+
28+
| Python | Platform | Boards |
29+
|--|--|--|
30+
| Python | Linux | [Raspberry Pi](https://www.sparkfun.com/raspberry-pi-5-8gb.html) , [NVIDIA Jetson Orin Nano](https://www.sparkfun.com/nvidia-jetson-orin-nano-developer-kit.html) via the [SparkFun Qwiic SHIM](https://www.sparkfun.com/sparkfun-qwiic-shim-for-raspberry-pi.html) |
31+
| Micro Python | Raspberry Pi - RP2, ESP32 | [SparkFun RP2040 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2040.html), [SparkFun RP2350 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2350.html), [SparkFun ESP32 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-esp32-wroom-usb-c.html)
32+
|CircuitPython | Raspberry Pi - RP2, ESP32 | [SparkFun RP2040 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2040.html), [SparkFun RP2350 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-rp2350.html), [SparkFun ESP32 Thing+](https://www.sparkfun.com/sparkfun-thing-plus-esp32-wroom-usb-c.html)
33+
34+
> [!NOTE]
35+
> The listed supported platforms and boards are the primary platform targets tested. It is fully expected that this module will work across a wide variety of Python enabled systems.
36+
2337
## Overview
2438

2539
This Python module implements support for I2C control of the SparkFun Qwiic Serial LCDs. It supports Python, MicroPython and CircuitPython environments.

0 commit comments

Comments
 (0)