Skip to content

Commit 34e9918

Browse files
committed
content updates -- in progress
1 parent 6e7d0e1 commit 34e9918

File tree

1 file changed

+23
-44
lines changed

1 file changed

+23
-44
lines changed

README.md

Lines changed: 23 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -2,17 +2,25 @@
22

33
# SparkFun Qwiic SerLCD - Python Module
44

5-
![Python Versions](https://img.shields.io/pypi/pyversions/sparkfun_qwiic_serlcd)
5+
![PyPi Version](https://img.shields.io/pypi/v/sparkfun_qwiic_serlcd)
66
![GitHub issues](https://img.shields.io/github/issues/sparkfun/Qwiic_SerLCD_Py)
77
![License](https://img.shields.io/github/license/sparkfun/Qwiic_SerLCD_Py)
8-
![X](https://img.shields.io/twitter/follow/sparkfun
9-
)
8+
![X](https://img.shields.io/twitter/follow/sparkfun)
109

1110
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.
1211

1312
This repository implements a Python module for the SparkFun Qwiic SerLCD series of products. This module works with Python, MicroPython and CircuitPython.
1413

15-
## Overview
14+
### Contents
15+
16+
* [About](#about-the-module)
17+
* [Getting Started](#getting-started)
18+
* [Installation](#installation)
19+
* [Supported Platforms](#supported-platforms)
20+
* [Documentation](https://docs.sparkfun.com/Qwiic_SerLCD_Py/)
21+
* [Examples](#examples)
22+
23+
## About the Module
1624

1725
This python module enables the user to access all of the features of these LCD products via a single Qwiic cable. This includes writing text to the screen, adjusting backlight levels (color), customizing splash screen and much much more. They come pre-programmed with the fully open-sourced [OpenLCD firmware](https://github.com/sparkfun/OpenLCD). All of the capabilities of these LCD screens are each demonstrated in the included examples.
1826

@@ -31,48 +39,20 @@ This Python module supports the following SparkFun qwiic products on Python, Mic
3139
| Python | Platform | Boards |
3240
|--|--|--|
3341
| 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) |
34-
| 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)
42+
| MicroPython | 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)
3543
|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)
3644

3745
> [!NOTE]
3846
> 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.
3947
40-
## Overview
41-
42-
This Python module implements support for I2C control of the SparkFun Qwiic Serial LCDs. It supports Python, MicroPython and CircuitPython environments.
43-
44-
This package enables the user to access all of the features of these LCD products via a single Qwiic cable. This includes writing text to the screen, adjusting backlight levels (color), customizing splash screen and much much more. They come pre-programmed with the fully open-sourced [OpenLCD firmware](https://github.com/sparkfun/OpenLCD). All of the capabilities of these LCD screens are each demonstrated in the included 17 examples.
45-
46-
This package can be used in conjunction with the overall [SparkFun qwiic Python Package](https://github.com/sparkfun/Qwiic_Py)
47-
48-
New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
49-
50-
## Contents
51-
52-
* [Supported Platforms](#supported-platforms)
53-
* [Dependencies](#dependencies)
54-
* [Installation](#installation)
55-
* [Documentation](#documentation)
56-
* [Example Use](#example-use)
57-
58-
Supported Platforms
59-
--------------------
60-
The qwiic serlcd python package current supports the following platforms:
61-
* [Raspberry Pi](https://www.sparkfun.com/search/results?term=raspberry+pi)
62-
* [NVidia Jetson Nano](https://www.sparkfun.com/products/15297)
63-
* [Google Coral Development Board](https://www.sparkfun.com/products/15318)
6448

65-
Dependencies
66-
---------------
67-
This driver package depends on the qwiic I2C driver:
68-
[Qwiic_I2C_Py](https://github.com/sparkfun/Qwiic_I2C_Py)
49+
---
50+
---
51+
---
52+
## Getting Started
6953

70-
Documentation
71-
-------------
72-
The SparkFun qwiic serlcd documentation is hosted at [ReadTheDocs](https://qwiic-serlcd-py.readthedocs.io/en/latest/)
54+
### Installation
7355

74-
Installation
75-
-------------
7656

7757
### PyPi Installation
7858
This repository is hosted on PyPi as the [sparkfun-qwiic-serlcd](https://pypi.org/project/sparkfun-qwiic-serlcd/) package. On systems that support PyPi installation via pip, this library is installed using the following commands
@@ -103,10 +83,11 @@ A package file is built and placed in a subdirectory called dist. This package f
10383
```sh
10484
cd dist
10585
pip install sparkfun_qwiic_serlcd-<version>.tar.gz
106-
10786
```
108-
Example Use
109-
---------------
87+
88+
## Examples
89+
90+
11091
See the examples directory for more detailed use examples.
11192

11293
```python
@@ -147,6 +128,4 @@ if __name__ == '__main__':
147128
print("\nEnding Example 1")
148129
sys.exit(0)
149130
```
150-
<p align="center">
151-
<img src="https://cdn.sparkfun.com/assets/custom_pages/3/3/4/dark-logo-red-flame.png" alt="SparkFun - Start Something">
152-
</p>
131+

0 commit comments

Comments
 (0)