lcd.gpio
lcd.gpio
- class platypush.plugins.lcd.gpio.LcdGpioPlugin(pin_rs: int, pin_e: int, pins_data: List[int], pin_rw: Optional[int] = None, pin_mode: str = 'BOARD', pin_backlight: Optional[int] = None, cols: int = 16, rows: int = 2, backlight_enabled: bool = True, backlight_mode: str = 'active_low', dotsize: int = 8, charmap: str = 'A02', auto_linebreaks: bool = True, compat_mode: bool = False, **kwargs)[source]
Plugin to write to an LCD display connected via GPIO.
Requires:
RPLCD (
pip install RPLCD
)RPi.GPIO (
pip install RPi.GPIO
)
- __init__(pin_rs: int, pin_e: int, pins_data: List[int], pin_rw: Optional[int] = None, pin_mode: str = 'BOARD', pin_backlight: Optional[int] = None, cols: int = 16, rows: int = 2, backlight_enabled: bool = True, backlight_mode: str = 'active_low', dotsize: int = 8, charmap: str = 'A02', auto_linebreaks: bool = True, compat_mode: bool = False, **kwargs)[source]
- Parameters:
pin_rs – Pin for register select (RS).
pin_e – Pin to start data read or write (E).
pins_data – List of data bus pins in 8 bit mode (DB0-DB7) or in 4 bit mode (DB4-DB7) in ascending order.
pin_mode – Which scheme to use for numbering of the GPIO pins, either
BOARD
orBCM
. Default:BOARD
.pin_rw – Pin for selecting read or write mode (R/W). Default:
None
, read only mode.pin_backlight – Pin for controlling backlight on/off. Set this to
None
for no backlight control. Default:None
.cols – Number of columns per row (usually 16 or 20). Default:
16
.rows – Number of display rows (usually 1, 2 or 4). Default:
2
.backlight_enabled – Whether the backlight is enabled initially. Default:
True
. Has no effect if pin_backlight isNone
backlight_mode – Set this to either
active_high
oractive_low
to configure the operating control for the backlight. Has no effect if pin_backlight isNone
dotsize – Some 1 line displays allow a font height of 10px. Allowed:
8
or10
. Default:8
.charmap – The character map used. Depends on your LCD. This must be either
A00
orA02
orST0B
. Default:A02
.auto_linebreaks – Whether or not to automatically insert line breaks. Default:
True
.compat_mode – Whether to run additional checks to support older LCDs that may not run at the reference clock (or keep up with it). Default:
False
.
- clear()
Clear the LCD display.
- close(clear: bool = False)
Close the handler to the LCD display and release the GPIO resources.
- Parameters:
clear – Clear the display as well on close (default: False).
- cr()
Write a carriage return (
\r
) character to the LCD.
- create_char(location: int, bitmap: List[int])
Create a new character. The HD44780 supports up to 8 custom characters (location 0-7).
- Parameters:
location – The place in memory where the character is stored. Values need to be integers between 0 and 7.
bitmap – The bitmap containing the character. This should be a list of 8 numbers, each representing a 5 pixel row.
Example for the smiley character:
[ 0, # 0b00000 10, # 0b01010 10, # 0b01010 0, # 0b00000 17, # 0b10001 17, # 0b10001 14, # 0b01110 0 # 0b00000 ]
- crlf()
Write a carriage return + line feed (
\r\n
) sequence to the LCD.
- disable_backlight()
Disable the display backlight.
- disable_display()
Turn off the display.
- enable_backlight()
Enable the display backlight.
- enable_display()
Turn on the display.
- home()
Set cursor to initial position and reset any shifting.
- lf()
Write a line feed (
\n
) character to the LCD.
- set_cursor_pos(position: List[int])
Change the position of the cursor on the display.
- Parameters:
position – New cursor position, as a list of two elements.
- set_text_align(mode: str)
Change the text align mode.
- Parameters:
mode – Supported values:
left
,right
.
- toggle_backlight()
Toggle the display backlight on/off.
- toggle_display()
Toggle the display state.