234 lines
7.2 KiB
Python
234 lines
7.2 KiB
Python
# The MIT License (MIT)
|
|
#
|
|
# Copyright (c) 2018 Kattni Rembor for Adafruit Industries
|
|
#
|
|
# Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
# of this software and associated documentation files (the "Software"), to deal
|
|
# in the Software without restriction, including without limitation the rights
|
|
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
# copies of the Software, and to permit persons to whom the Software is
|
|
# furnished to do so, subject to the following conditions:
|
|
#
|
|
# The above copyright notice and this permission notice shall be included in
|
|
# all copies or substantial portions of the Software.
|
|
#
|
|
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
# THE SOFTWARE.
|
|
"""
|
|
`adafruit_character_lcd.character_lcd_i2c`
|
|
====================================================
|
|
|
|
Module for using I2C with I2C RGB LCD Shield or I2C RGB LCD Pi Plate
|
|
|
|
* Author(s): Kattni Rembor
|
|
|
|
Implementation Notes
|
|
--------------------
|
|
|
|
**Hardware:**
|
|
|
|
"* `RGB LCD Shield Kit w/ 16x2 Character Display - Negative Display
|
|
<https://www.adafruit.com/product/714>`_"
|
|
|
|
"* `RGB LCD Shield Kit w/ 16x2 Character Display - Positive Display
|
|
<https://www.adafruit.com/product/716>`_"
|
|
|
|
"* `Adafruit RGB Negative 16x2 LCD+Keypad Kit for Raspberry Pi
|
|
<https://www.adafruit.com/product/1110>`_"
|
|
|
|
"* `Adafruit RGB Positive 16x2 LCD+Keypad Kit for Raspberry Pi
|
|
<https://www.adafruit.com/product/1109>`_"
|
|
|
|
**Software and Dependencies:**
|
|
|
|
* Adafruit CircuitPython firmware:
|
|
https://github.com/adafruit/circuitpython/releases
|
|
* Adafruit's Bus Device library (when using I2C/SPI):
|
|
https://github.com/adafruit/Adafruit_CircuitPython_BusDevice
|
|
|
|
"""
|
|
|
|
import digitalio
|
|
from adafruit_mcp230xx.mcp23017 import MCP23017
|
|
from adafruit_character_lcd.character_lcd import Character_LCD_RGB
|
|
|
|
__version__ = "0.0.0-auto.0"
|
|
__repo__ = "https://github.com/adafruit/Adafruit_CircuitPython_CharLCD.git"
|
|
|
|
|
|
class Character_LCD_RGB_I2C(Character_LCD_RGB):
|
|
"""RGB Character LCD connected to I2C shield or Pi plate using I2C connection.
|
|
This is a subclass of Character_LCD_RGB and implements all of the same
|
|
functions and functionality.
|
|
|
|
To use, import and initialise as follows:
|
|
|
|
.. code-block:: python
|
|
|
|
import board
|
|
import busio
|
|
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
|
|
|
|
i2c = busio.I2C(board.SCL, board.SDA)
|
|
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
|
|
|
|
"""
|
|
|
|
def __init__(self, i2c, columns, lines, address=None):
|
|
# pylint: disable=too-many-locals
|
|
"""Initialize RGB character LCD connected to shield using I2C connection
|
|
on the specified I2C bus with the specified number of columns and lines
|
|
on the display.
|
|
"""
|
|
|
|
if address:
|
|
mcp = MCP23017(i2c, address=address)
|
|
else:
|
|
mcp = MCP23017(i2c)
|
|
|
|
self._left_button = mcp.get_pin(4)
|
|
self._up_button = mcp.get_pin(3)
|
|
self._down_button = mcp.get_pin(2)
|
|
self._right_button = mcp.get_pin(1)
|
|
self._select_button = mcp.get_pin(0)
|
|
|
|
self._buttons = [
|
|
self._left_button,
|
|
self._up_button,
|
|
self._down_button,
|
|
self._right_button,
|
|
self._select_button,
|
|
]
|
|
|
|
for pin in self._buttons:
|
|
pin.switch_to_input(pull=digitalio.Pull.UP)
|
|
|
|
super().__init__(
|
|
mcp.get_pin(15),
|
|
mcp.get_pin(13),
|
|
mcp.get_pin(12),
|
|
mcp.get_pin(11),
|
|
mcp.get_pin(10),
|
|
mcp.get_pin(9),
|
|
columns,
|
|
lines,
|
|
mcp.get_pin(6),
|
|
mcp.get_pin(7),
|
|
mcp.get_pin(8),
|
|
mcp.get_pin(14),
|
|
)
|
|
|
|
@property
|
|
def left_button(self):
|
|
"""The left button on the RGB Character LCD I2C Shield or Pi plate.
|
|
|
|
The following example prints "Left!" to the LCD when the left button is pressed:
|
|
|
|
.. code-block:: python
|
|
|
|
import board
|
|
import busio
|
|
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
|
|
|
|
i2c = busio.I2C(board.SCL, board.SDA)
|
|
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
|
|
|
|
while True:
|
|
if lcd.left_button:
|
|
lcd.message = "Left!"
|
|
|
|
"""
|
|
return not self._left_button.value
|
|
|
|
@property
|
|
def up_button(self):
|
|
"""The up button on the RGB Character LCD I2C Shield or Pi plate.
|
|
|
|
The following example prints "Up!" to the LCD when the up button is pressed:
|
|
|
|
.. code-block:: python
|
|
|
|
import board
|
|
import busio
|
|
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
|
|
|
|
i2c = busio.I2C(board.SCL, board.SDA)
|
|
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
|
|
|
|
while True:
|
|
if lcd.up_button:
|
|
lcd.message = "Up!"
|
|
|
|
"""
|
|
return not self._up_button.value
|
|
|
|
@property
|
|
def down_button(self):
|
|
"""The down button on the RGB Character LCD I2C Shield or Pi plate.
|
|
|
|
The following example prints "Down!" to the LCD when the down button is pressed:
|
|
|
|
.. code-block:: python
|
|
|
|
import board
|
|
import busio
|
|
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
|
|
|
|
i2c = busio.I2C(board.SCL, board.SDA)
|
|
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
|
|
|
|
while True:
|
|
if lcd.down_button:
|
|
lcd.message = "Down!"
|
|
|
|
"""
|
|
return not self._down_button.value
|
|
|
|
@property
|
|
def right_button(self):
|
|
"""The right button on the RGB Character LCD I2C Shield or Pi plate.
|
|
|
|
The following example prints "Right!" to the LCD when the right button is pressed:
|
|
|
|
.. code-block:: python
|
|
|
|
import board
|
|
import busio
|
|
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
|
|
|
|
i2c = busio.I2C(board.SCL, board.SDA)
|
|
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
|
|
|
|
while True:
|
|
if lcd.right_button:
|
|
lcd.message = "Right!"
|
|
|
|
"""
|
|
return not self._right_button.value
|
|
|
|
@property
|
|
def select_button(self):
|
|
"""The select button on the RGB Character LCD I2C Shield or Pi plate.
|
|
|
|
The following example prints "Select!" to the LCD when the select button is pressed:
|
|
|
|
.. code-block:: python
|
|
|
|
import board
|
|
import busio
|
|
from adafruit_character_lcd.character_lcd_rgb_i2c import Character_LCD_RGB_I2C
|
|
|
|
i2c = busio.I2C(board.SCL, board.SDA)
|
|
lcd = Character_LCD_RGB_I2C(i2c, 16, 2)
|
|
|
|
while True:
|
|
if lcd.select_button:
|
|
lcd.message = "Select!"
|
|
|
|
"""
|
|
return not self._select_button.value
|