You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
11
11
12
-
This repository implements a Python module for the SparkFun Qwiic SerLCD series of products. This module works with Python, MicroPython and CircuitPython.
12
+
This repository implements a Python package for the SparkFun Qwiic SerLCD series of products. This package works with Python, MicroPython and CircuitPython.
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.
25
+
This python 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 examples.
26
26
27
27
28
28
New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
29
29
### Supported SparkFun Products
30
30
31
-
This Python module supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
31
+
This Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
> 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.
46
+
> The listed supported platforms and boards are the primary platform targets tested. It is fully expected that this package will work across a wide variety of Python enabled systems.
47
47
48
48
49
49
---
50
50
---
51
51
---
52
52
## Getting Started
53
53
54
-
### Installation
55
54
56
55
57
-
### PyPi Installation
58
-
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
56
+
## Installation
57
+
58
+
The first step to using this package is installing it on your system. The install method depends on the python platform. The following sections outline installation on Python, MicroPython and CircuitPython.
59
+
60
+
### Python
61
+
62
+
The package is primarily installed using the `pip` command, downloading the package from the Python Index - "PyPi". Note - the below instructions outline installation an Linux-based (Raspberry Pi) system.
63
+
64
+
#### PyPi Installation
65
+
66
+
The SparkFun Qwiic SerLCD Python package is part of the overall SparkFun Qwiic Python package which is hosted on PyPi. On systems that support PyPi installation via pip, this library is installed using the following commands
59
67
60
68
For all users (note: the user must have sudo privileges):
61
69
```sh
62
-
sudo pip install sparkfun-qwiic-serlcd
70
+
sudo pip install sparkfun-qwiic
63
71
```
64
72
For the current user:
65
73
66
74
```sh
67
-
pip install sparkfun-qwiic-serlcd
75
+
pip install sparkfun-qwiic
68
76
```
69
77
70
-
### Local Installation
78
+
> [!CAUTION]
79
+
> **TODO** Put together how this works with the new virtual environments used with the latest Python install
80
+
81
+
#### Local Installation
71
82
To install, make sure the setuptools package is installed on the system.
0 commit comments