Skip to content

Commit 5eb7685

Browse files
jposada202020jposada202020
authored
Merge pull request #62 from jposada202020/correcting_rtype_documentation
correcting_rtype_documentation_sphinx
2 parents 7a50963 + 23ea739 commit 5eb7685

File tree

8 files changed

+75
-67
lines changed

8 files changed

+75
-67
lines changed

‎adafruit_character_lcd/character_lcd.py

Lines changed: 19 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,15 @@
1717
1818
**Hardware:**
1919
20-
* `Adafruit Character LCDs <http://www.adafruit.com/category/63_96>`_
20+
* `Adafruit Character LCDs
21+
<http://www.adafruit.com/category/63_96>`_
2122
2223
**Software and Dependencies:**
2324
24-
* Adafruit CircuitPython firmware:
25-
https://github.com/adafruit/circuitpython/releases
26-
* Adafruit's Bus Device library (when using I2C/SPI):
25+
* Adafruit CircuitPython firmware for the supported boards:
26+
https://circuitpython.org/downloads
27+
28+
* Adafruit's Bus Device library:
2729
https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
2830
2931
"""
@@ -171,10 +173,9 @@ def clear(self):
171173
172174
import time
173175
import board
174-
import busio
175176
import adafruit_character_lcd.character_lcd_i2c as character_lcd
176177
177-
i2c = busio.I2C(board.SCL, board.SDA)
178+
i2c = board.I2C() # uses board.SCL and board.SDA
178179
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
179180
180181
lcd.message = "Hello, world!"
@@ -208,10 +209,9 @@ def cursor(self):
208209
209210
import time
210211
import board
211-
import busio
212212
import adafruit_character_lcd.character_lcd_i2c as character_lcd
213213
214-
i2c = busio.I2C(board.SCL, board.SDA)
214+
i2c = board.I2C() # uses board.SCL and board.SDA
215215
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
216216
217217
lcd.cursor = True
@@ -259,10 +259,9 @@ def blink(self):
259259
260260
import time
261261
import board
262-
import busio
263262
import adafruit_character_lcd.character_lcd_i2c as character_lcd
264263
265-
i2c = busio.I2C(board.SCL, board.SDA)
264+
i2c = board.I2C() # uses board.SCL and board.SDA
266265
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
267266
268267
lcd.blink = True
@@ -291,10 +290,9 @@ def display(self):
291290
292291
import time
293292
import board
294-
import busio
295293
import adafruit_character_lcd.character_lcd_i2c as character_lcd
296294
297-
i2c = busio.I2C(board.SCL, board.SDA)
295+
i2c = board.I2C() # uses board.SCL and board.SDA
298296
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
299297
300298
lcd.message = "Hello, world!"
@@ -326,10 +324,9 @@ def message(self):
326324
327325
import time
328326
import board
329-
import busio
330327
import adafruit_character_lcd.character_lcd_i2c as character_lcd
331328
332-
i2c = busio.I2C(board.SCL, board.SDA)
329+
i2c = board.I2C() # uses board.SCL and board.SDA
333330
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
334331
335332
lcd.message = "Hello, world!"
@@ -389,10 +386,9 @@ def move_left(self):
389386
390387
import time
391388
import board
392-
import busio
393389
import adafruit_character_lcd.character_lcd_i2c as character_lcd
394390
395-
i2c = busio.I2C(board.SCL, board.SDA)
391+
i2c = board.I2C() # uses board.SCL and board.SDA
396392
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
397393
398394
scroll_message = "<-- Scroll"
@@ -413,10 +409,9 @@ def move_right(self):
413409
414410
import time
415411
import board
416-
import busio
417412
import adafruit_character_lcd.character_lcd_i2c as character_lcd
418413
419-
i2c = busio.I2C(board.SCL, board.SDA)
414+
i2c = board.I2C() # uses board.SCL and board.SDA
420415
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
421416
422417
scroll_message = "Scroll -->"
@@ -441,10 +436,9 @@ def text_direction(self):
441436
442437
import time
443438
import board
444-
import busio
445439
import adafruit_character_lcd.character_lcd_i2c as character_lcd
446440
447-
i2c = busio.I2C(board.SCL, board.SDA)
441+
i2c = board.I2C() # uses board.SCL and board.SDA
448442
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
449443
450444
lcd.text_direction = lcd.RIGHT_TO_LEFT
@@ -583,10 +577,9 @@ def backlight(self):
583577
584578
import time
585579
import board
586-
import busio
587580
import adafruit_character_lcd.character_lcd_i2c as character_lcd
588581
589-
i2c = busio.I2C(board.SCL, board.SDA)
582+
i2c = board.I2C() # uses board.SCL and board.SDA
590583
591584
lcd = character_lcd.Character_LCD_I2C(i2c, 16, 2)
592585
@@ -620,12 +613,9 @@ class Character_LCD_RGB(Character_LCD):
620613
:param ~digitalio.DigitalInOut db7: The data line 7
621614
:param columns: The columns on the charLCD
622615
:param lines: The lines on the charLCD
623-
:param red: Red RGB Anode
624-
:type red: ~pwmio.PWMOut or ~digitalio.DigitalInOut
625-
:param green: Green RGB Anode
626-
:type green: ~pwmio.PWMOut or ~digitalio.DigitalInOut
627-
:param blue: Blue RGB Anode
628-
:type blue: ~pwmio.PWMOut or ~digitalio.DigitalInOut
616+
:param ~pwmio.PWMOut,~digitalio.DigitalInOut red: Red RGB Anode
617+
:param ~pwmio.PWMOut,~digitalio.DigitalInOut green: Green RGB Anode
618+
:param ~pwmio.PWMOut,~digitalio.DigitalInOut blue: Blue RGB Anode
629619
:param ~digitalio.DigitalInOut read_write: The rw pin. Determines whether to read to or
630620
write from the display. Not necessary if only writing to the display. Used on shield.
631621
@@ -687,10 +677,9 @@ def color(self):
687677
688678
import time
689679
import board
690-
import busio
691680
import adafruit_character_lcd.character_lcd_rgb_i2c as character_lcd
692681
693-
i2c = busio.I2C(board.SCL, board.SDA)
682+
i2c = board.I2C() # uses board.SCL and board.SDA
694683
695684
lcd = character_lcd.Character_LCD_RGB_I2C(i2c, 16, 2)
696685

‎adafruit_character_lcd/character_lcd_i2c.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@
1515
1616
**Hardware:**
1717
18-
* `I2C / SPI character LCD backpack <https://www.adafruit.com/product/292>`_
18+
* `I2C / SPI character LCD backpack
19+
<https://www.adafruit.com/product/292>`_ (Product ID: 292)
1920
2021
**Software and Dependencies:**
2122
22-
* Adafruit CircuitPython firmware:
23-
https://github.com/adafruit/circuitpython/releases
24-
* Adafruit's Bus Device library (when using I2C/SPI):
23+
* Adafruit CircuitPython firmware for the supported boards:
24+
https://circuitpython.org/downloads
25+
26+
* Adafruit's Bus Device library:
2527
https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
2628
2729
"""
@@ -44,10 +46,9 @@ class Character_LCD_I2C(Character_LCD_Mono):
4446
.. code-block:: python
4547
4648
import board
47-
import busio
4849
from adafruit_character_lcd.character_lcd_i2c import Character_LCD_I2C
4950
50-
i2c = busio.I2C(board.SCL, board.SDA)
51+
i2c = board.I2C() # uses board.SCL and board.SDA
5152
lcd = Character_LCD_I2C(i2c, 16, 2)
5253
"""
5354

‎adafruit_character_lcd/character_lcd_rgb_i2c.py

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,23 @@
1616
**Hardware:**
1717
1818
* `RGB LCD Shield Kit w/ 16x2 Character Display - Negative Display
19-
<https://www.adafruit.com/product/714>`_
19+
<https://www.adafruit.com/product/714>`_ (Product ID: 714)
2020
2121
* `RGB LCD Shield Kit w/ 16x2 Character Display - Positive Display
22-
<https://www.adafruit.com/product/716>`_
22+
<https://www.adafruit.com/product/716>`_ (Product ID: 716)
2323
2424
* `Adafruit RGB Negative 16x2 LCD+Keypad Kit for Raspberry Pi
25-
<https://www.adafruit.com/product/1110>`_
25+
<https://www.adafruit.com/product/1110>`_ (Product ID: 1110)
2626
2727
* `Adafruit RGB Positive 16x2 LCD+Keypad Kit for Raspberry Pi
28-
<https://www.adafruit.com/product/1109>`_
28+
<https://www.adafruit.com/product/1109>`_ (Product ID: 1109)
2929
3030
**Software and Dependencies:**
3131
32-
* Adafruit CircuitPython firmware:
33-
https://github.com/adafruit/circuitpython/releases
34-
* Adafruit's Bus Device library (when using I2C/SPI):
32+
* Adafruit CircuitPython firmware for the supported boards:
33+
https://circuitpython.org/downloads
34+
35+
* Adafruit's Bus Device library:
3536
https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
3637
3738
"""
@@ -54,10 +55,9 @@ class Character_LCD_RGB_I2C(Character_LCD_RGB):
5455
.. code-block:: python
5556
5657
import board
57-
import busio
5858
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
5959
60-
i2c = busio.I2C(board.SCL, board.SDA)
60+
i2c = board.I2C() # uses board.SCL and board.SDA
6161
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
6262
6363
"""
@@ -115,10 +115,9 @@ def left_button(self):
115115
.. code-block:: python
116116
117117
import board
118-
import busio
119118
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
120119
121-
i2c = busio.I2C(board.SCL, board.SDA)
120+
i2c = board.I2C() # uses board.SCL and board.SDA
122121
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
123122
124123
while True:
@@ -137,10 +136,9 @@ def up_button(self):
137136
.. code-block:: python
138137
139138
import board
140-
import busio
141139
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
142140
143-
i2c = busio.I2C(board.SCL, board.SDA)
141+
i2c = board.I2C() # uses board.SCL and board.SDA
144142
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
145143
146144
while True:
@@ -159,10 +157,9 @@ def down_button(self):
159157
.. code-block:: python
160158
161159
import board
162-
import busio
163160
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
164161
165-
i2c = busio.I2C(board.SCL, board.SDA)
162+
i2c = board.I2C() # uses board.SCL and board.SDA
166163
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
167164
168165
while True:
@@ -181,10 +178,9 @@ def right_button(self):
181178
.. code-block:: python
182179
183180
import board
184-
import busio
185181
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
186182
187-
i2c = busio.I2C(board.SCL, board.SDA)
183+
i2c = board.I2C() # uses board.SCL and board.SDA
188184
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
189185
190186
while True:
@@ -203,10 +199,9 @@ def select_button(self):
203199
.. code-block:: python
204200
205201
import board
206-
import busio
207202
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
208203
209-
i2c = busio.I2C(board.SCL, board.SDA)
204+
i2c = board.I2C() # uses board.SCL and board.SDA
210205
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
211206
212207
while True:

‎adafruit_character_lcd/character_lcd_spi.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@
1515
1616
**Hardware:**
1717
18-
* `I2C / SPI character LCD backpack <https://www.adafruit.com/product/292>`_
18+
* `I2C / SPI character LCD backpack
19+
<https://www.adafruit.com/product/292>`_ (Product ID: 4566)
1920
2021
**Software and Dependencies:**
2122
22-
* Adafruit CircuitPython firmware:
23-
https://github.com/adafruit/circuitpython/releases
24-
* Adafruit's Bus Device library (when using I2C/SPI):
23+
* Adafruit CircuitPython firmware for the supported boards:
24+
https://circuitpython.org/downloads
25+
26+
* Adafruit's Bus Device library:
2527
https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
2628
2729
"""
@@ -43,11 +45,10 @@ class Character_LCD_SPI(Character_LCD_Mono): # pylint: disable=too-few-public-m
4345
.. code-block:: python
4446
4547
import board
46-
import busio
4748
import digitalio
4849
import adafruit_character_lcd.character_lcd_mono as character_lcd
4950
50-
spi = busio.SPI(board.SCK, MOSI=board.MOSI)
51+
spi = board.SPI()
5152
latch = digitalio.DigitalInOut(board.D5)
5253
lcd = character_lcd.Character_LCD_SPI(spi, latch, 16, 2)
5354
"""

‎docs/index.rst

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,36 @@ Table of Contents
2323
.. toctree::
2424
:caption: Tutorials
2525

26+
Adafruit Light Meter Learning guide <https://learn.adafruit.com/light-meter>
27+
28+
Adafruit i2c/SPI LCD Backpack Learning Guide <https://learn.adafruit.com/i2c-spi-lcd-backpack>
29+
30+
Adafruit i2c / SPI character LCD backpack Learning Guide <https://learn.adafruit.com/character-lcds>
31+
32+
Adafruit RGB LCD Shield Kit w/ 16x2 Character Display Learning Guide <https://learn.adafruit.com/rgb-lcd-shield>
33+
34+
Adafruit RGB Positive 16x2 LCD+Keypad Kit for Raspberry Pi Learning Guide <https://learn.adafruit.com/adafruit-16x2-character-lcd-plus-keypad-for-raspberry-pi>
35+
2636
.. toctree::
2737
:caption: Related Products
2838

39+
Standard LCD 16x2 + extras - white on blue <https://www.adafruit.com/product/181>
40+
41+
Adafruit Standard LCD 20x4 + extras - white on blue <https://www.adafruit.com/product/198>
42+
2943
Adafruit Character LCDs <http://www.adafruit.com/category/63_96>
3044

45+
Adafruit i2c / SPI character LCD backpack <https://www.adafruit.com/product/292>
46+
47+
Adafruit RGB backlight negative LCD 16x2 + extras - RGB on black <https://www.adafruit.com/product/399>
48+
49+
Adafruit RGB LCD Shield Kit w/ 16x2 Character Display <https://www.adafruit.com/product/716>
50+
51+
Adafruit RGB Positive 16x2 LCD+Keypad Kit for Raspberry Pi <https://www.adafruit.com/product/1109>
52+
53+
Adafruit RGB Negative 16x2 LCD+Keypad Kit for Raspberry Pi <https://www.adafruit.com/product/1110>
54+
55+
3156
.. toctree::
3257
:caption: Other Links
3358

‎examples/charlcd_i2c_mono_simpletest.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44
"""Simple test for 16x2 character lcd connected to an MCP23008 I2C LCD backpack."""
55
import time
66
import board
7-
import busio
87
import adafruit_character_lcd.character_lcd_i2c as character_lcd
98

109
# Modify this if you have a different sized Character LCD
1110
lcd_columns = 16
1211
lcd_rows = 2
1312

1413
# Initialise I2C bus.
15-
i2c = busio.I2C(board.SCL, board.SDA)
14+
i2c = board.I2C() # uses board.SCL and board.SDA
1615

1716
# Initialise the lcd class
1817
lcd = character_lcd.Character_LCD_I2C(i2c, lcd_columns, lcd_rows)

‎examples/charlcd_i2c_rgb_simpletest.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,14 @@
44
"""Simple test for I2C RGB character LCD shield kit"""
55
import time
66
import board
7-
import busio
87
import adafruit_character_lcd.character_lcd_rgb_i2c as character_lcd
98

109
# Modify this if you have a different sized Character LCD
1110
lcd_columns = 16
1211
lcd_rows = 2
1312

1413
# Initialise I2C bus.
15-
i2c = busio.I2C(board.SCL, board.SDA)
14+
i2c = board.I2C() # uses board.SCL and board.SDA
1615

1716
# Initialise the LCD class
1817
lcd = character_lcd.Character_LCD_RGB_I2C(i2c, lcd_columns, lcd_rows)

0 commit comments

Comments
 (0)