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
Copy file name to clipboardExpand all lines: README.md
+27-5Lines changed: 27 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -56,8 +56,6 @@ The package is primarily installed using the `pip3` command, downloading the pac
56
56
57
57
#### PyPi Installation
58
58
59
-
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.
60
-
61
59
First, setup a virtual environment from a specific directory using venv:
62
60
```sh
63
61
python3 -m venv path/to/venv
@@ -66,11 +64,11 @@ You can pass any path as path/to/venv, just make sure you use the same one for a
If not already installed, follow the [instructions here](https://docs.circuitpython.org/projects/circup/en/latest/#installation) to install CircUp on your computer.
86
89
@@ -94,7 +97,26 @@ Finally, connect a device with CircuitPython installed to your computer and then
94
97
circup install --py qwiic_serlcd
95
98
```
96
99
97
-
## Getting Started
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)
101
+
```sh
102
+
circup example qwiic_serlcd\ex1_qwiic_serlcd_hello_world
103
+
circup example qwiic_serlcd\ex2_qwiic_serlcd_backlight
104
+
circup example qwiic_serlcd\ex3_qwiic_serlcd_set_cursor_position
105
+
circup example qwiic_serlcd\ex4_qwiic_serlcd_move_cursor
106
+
circup example qwiic_serlcd\ex5_qwiic_serlcd_enable_cursor
107
+
circup example qwiic_serlcd\ex6_qwiic_serlcd_blink_cursor
108
+
circup example qwiic_serlcd\ex7_qwiic_serlcd_scroll
109
+
circup example qwiic_serlcd\ex8_qwiic_serlcd_autoscroll_with_text
110
+
circup example qwiic_serlcd\ex9_qwiic_serlcd_custom_character
111
+
circup example qwiic_serlcd\ex10_qwiic_serlcd_turn_off_display
112
+
circup example qwiic_serlcd\ex11_qwiic_serlcd_text_direction
113
+
circup example qwiic_serlcd\ex12_qwiic_serlcd_console_input_to_display
114
+
circup example qwiic_serlcd\ex13_qwiic_serlcd_fast_backlight
115
+
circup example qwiic_serlcd\ex14_qwiic_serlcd_show_firmware_version
116
+
circup example qwiic_serlcd\ex15_qwiic_serlcd_message_enable
117
+
circup example qwiic_serlcd\ex16_qwiic_serlcd_set_splash
118
+
circup example qwiic_serlcd\ex17_qwiic_serlcd_change_i2c_address.py
119
+
```
98
120
99
121
## Examples
100
122
Below is a quickstart program to print "Hello World!" to the Serial LCD.
0 commit comments