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 SparkFun Qwiic Alphanumeric Display ALPHANUMERIC Module provides a simple and cost effective solution for adding Alphanumeric Display capabilities to your project. Implementing a SparkFun Qwiic I2C interface, these sensors can be rapidly added to any project with boards that are part of the SparkFun Qwiic ecosystem.
This python package is a port of the existing [SparkFun Qwiic Alphanumeric Arduino Library](https://github.com/sparkfun/SparkFun_Alphanumeric_Display_Arduino_Library)
24
+
## About the Package
37
25
38
-
This package can be used in conjunction with the overall [SparkFun qwiic Python Package](https://github.com/sparkfun/Qwiic_Py)
26
+
This python package enables the user to access the features of the ALPHANUMERIC via a single Qwiic cable. This includes <writing to the display, setting the blink rate, scrolling characters> and more. The capabilities of the ALPHANUMERIC are each demonstrated in the included examples.
39
27
40
28
New to qwiic? Take a look at the entire [SparkFun qwiic ecosystem](https://www.sparkfun.com/qwiic).
41
29
42
-
##Contents
30
+
### Supported SparkFun Products
43
31
44
-
*[Supported Platforms](#supported-platforms)
45
-
*[Dependencies](#dependencies)
46
-
*[Installation](#installation)
47
-
*[Documentation](#documentation)
48
-
*[Example Use](#example-use)
32
+
This Python package supports the following SparkFun qwiic products on Python, MicroPython and Circuit python.
49
33
50
-
Supported Platforms
51
-
--------------------
52
-
The Qwiic LED Stick Python package currently supports the following platforms:
The SparkFun Qwiic LED Stick module documentation is hosted at [ReadTheDocs](https://qwiic-alphanumeric-py.readthedocs.io/en/latest/index.html)
38
+
| Python | Platform | Boards |
39
+
|--|--|--|
40
+
| 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)|
> 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.
67
46
68
-
This repository is hosted on PyPi as the [sparkfun-qwiic-alphanumeric](https://pypi.org/project/sparkfun-qwiic-alphanumeric/) package. On systems that support PyPi installation via pip, this library is installed using the following commands
47
+
## Installation
69
48
70
-
For all users (note: the user must have sudo privileges):
49
+
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.
50
+
51
+
### Python
52
+
53
+
#### PyPi Installation
54
+
55
+
The package is primarily installed using the `pip3` command, downloading the package from the Python Index - "PyPi".
56
+
57
+
Note - the below instructions outline installation on a Linux-based (Raspberry Pi) system.
58
+
59
+
First, setup a virtual environment from a specific directory using venv:
71
60
```sh
72
-
sudo pip install sparkfun-qwiic-alphanumeric
61
+
python3 -m venv path/to/venv
73
62
```
74
-
For the current user:
63
+
You can pass any path as path/to/venv, just make sure you use the same one for all future steps. For more information on venv [click here](https://docs.python.org/3/library/venv.html).
Now you should be able to run any example or custom python scripts that have `import qwiic_alphanumeric` by running e.g.:
76
70
```sh
77
-
pip install sparkfun-qwiic-alphanumeric
71
+
path/to/venv/bin/python3 example_script.py
78
72
```
79
-
To install, make sure the setuptools package is installed on the system.
80
73
81
-
Direct installation at the command line:
74
+
### MicroPython Installation
75
+
If not already installed, follow the [instructions here](https://docs.micropython.org/en/latest/reference/mpremote.html) to install mpremote on your computer.
76
+
77
+
Connect a device with MicroPython installed to your computer and then install the package directly to your device with mpremote mip.
If not already installed, follow the [instructions here](https://docs.circuitpython.org/projects/circup/en/latest/#installation) to install CircUp on your computer.
89
+
90
+
Ensure that you have the latest version of the SparkFun Qwiic CircuitPython bundle.
82
91
```sh
83
-
python setup.py install
92
+
circup bundle-add sparkfun/Qwiic_Py
84
93
```
85
94
86
-
To build a package for use with pip:
95
+
Finally, connect a device with CircuitPython installed to your computer and then install the package directly to your device with circup.
87
96
```sh
88
-
python setup.py sdist
89
-
```
90
-
A package file is built and placed in a subdirectory called dist. This package file can be installed using pip.
97
+
circup install --py qwiic_alphanumeric
98
+
```
99
+
100
+
If you would like to install any of the examples from this repository, issue the corresponding circup command from below. (NOTE: The below syntax assumes you are using CircUp on Windows. Linux and Mac will have different path seperators (i.e. "/" vs. "\"). See the [CircUp "example" command documentation](https://learn.adafruit.com/keep-your-circuitpython-libraries-on-devices-up-to-date-with-circup/example-command) for more information)
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex01_print_string
104
+
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex02_turn_on_one_segment
105
+
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex03_print_char
106
+
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex04_set_brightness
107
+
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex05_set_blink_rate
108
+
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex06_colon_and_decimal
109
+
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex07_unknown_char
110
+
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex08_multi_display
111
+
circup example qwiic_alphanumeric\qwiic_alphanumeric_ex09_scrolling_string
94
112
```
95
113
96
114
Example Use
97
-
-------------
98
-
See the examples directory for more detailed use examples.
115
+
---------------
116
+
Below is a quickstart program to print readings from the ALPHANUMERIC.
117
+
118
+
See the examples directory for more detailed use examples and [examples/README.md](https://github.com/sparkfun/qwiic_alphanumeric_py/blob/main/examples/README.md) for a summary of the available examples.
99
119
100
120
```python
101
-
from__future__import print_function
121
+
102
122
import qwiic_alphanumeric
103
123
import time
104
124
import sys
105
125
106
126
defrun_example():
107
127
108
-
print("\nSparkFun Qwiic Alphanumeric - Example 4: Print String")
128
+
print("\nSparkFun Qwiic Alphanumeric - Example 1: Print String")
Below is a brief summary of each of the example programs included in this repository. To report a bug in any of these examples or to request a new feature or example [submit an issue in our GitHub issues.](https://github.com/sparkfun/qwiic_alphanumeric_py/issues).
3
+
4
+
NOTE: Any numbering of examples is to retain consistency with the Arduino library from which this was ported.
5
+
6
+
## Qwiic Alphanumeric Ex01 Print String
7
+
This example shows how to use the print() function to illuminate strings
0 commit comments