LCD_tools

lcd-tools expands upon the RPLCD library to provide short-cut commands for various LCD Display control options.

Install Command:

pip install lcd-tools

Commands:

write_to_lcd( ) - A multi-function command that writes string variables to the LCD display. The exact behavior will depend on arguments.

Write single string variable to LCD:

    # lcd = CharLCD object as defined by rplcd
    write_to_lcd(lcd, "Example String")

Write a single string variable to a specific row on the LCD screen:

    # lcd = CharLCD object as defined by rplcd
    write_to_lcd(lcd, "Example String", row=1)

Write a frame_buffer to the LCD screen:

    # lcd = CharLCD object as defined by rplcd
    
    # frame_buffer = ["Line 0", "Line 1", "Line2"]
    #   List of strings representing each line of the LCD screen
    
    # num_cols = int **Number of columns on LCD screen

    write_to_lcd(lcd, frame_buffer, num_cols)

scroll_line( ) - Command used to scroll a single string across the specified line on LCD
- Arguments: scroll_line(lcd, string, row, num_cols, direction, speed)
  - lcd (list): ** REQUIRED ** - LCD object as defined by RPLCD library:
  - string (string): ** REQUIRED ** - String variable that will be scrolled across screen
  - row (int): ** optional ** - Integer var for the LCD screen row the text will be scrolled on.—defaults to row 0 if undefined.
  - num_cols (int): ** REQUIRED ** - Integer var for number of columns on LCD screen
  - direction (string): ** optional ** - String var with direction ("left" or "right") text should scroll—defaults to left scrolling if undefined.
  - speed (int): ** optional ** - Integer var (1-10) representing the speed of scrolling.—defaults to 8 if undefined.
```
    scroll_line(lcd, "Hello World", 1, 12, "right", 9)
```
scroll_frame_buffer( ) - Command used to scroll all lines in an input frame_buffer across the LCD screen
- Arguments: scroll_frame_buffer(lcd, frame_buffer, num_cols, direction, speed)
  - lcd (list): ** REQUIRED ** - LCD object as defined by RPLCD library:
  - frame_buffer (string list): ** REQUIRED ** - List of strings that represent each line on LCD screen
  - num_cols (int): ** REQUIRED ** - Integer var for number of columns on LCD screen
  - direction (string): ** optional ** - String var with direction ("left" or "right") text should scroll—defaults to left scrolling if undefined.
  - speed (int): ** optional ** - Integer var (1-10) representing speed of scrolling.—defaults to 8 if undefined.
```
    frame_buffer = ["Line 0", "Line 1"]
    scroll_frame_buffer(lcd, frame_buffer, 12, "left", 8)
```

Metadata

Release files for lcd-tools 0.1.88

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lcd-tools 0.1.88
File	Size	Uploaded
lcd_tools-0.1.88.tar.gz	4.3 kB	Jun 19, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for lcd-tools 0.1.88
File	Interpreter	ABI	Platform	Reset
lcd_tools-0.1.88-py3-none-any.whl 5.1 kB Jun 19, 2024	Python 3	none	any	Details

Total release size: 9.4 kB

Release files / lcd_tools-0.1.88.tar.gz

Download URL	lcd_tools-0.1.88.tar.gz
Size	4.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`9a2d0265fbd45dabe2993a5e370df319f9b46c59fa63f3741607121a46e9fbcf`
BLAKE2b-256 checksum How to use checksums	`aceabf5f1554c6fd701c4ed3dd653c3fb743e6c41bb27271759074417270a121`
Upload date	Jun 19, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.3 CPython/3.8.10 Linux/4.4.0-19041-Microsoft`

Release files / lcd_tools-0.1.88-py3-none-any.whl

Download URL	lcd_tools-0.1.88-py3-none-any.whl
Size	5.1 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`506899cec7349b779f1a6ba973c7ef876c762961bc266a0b0412e171dde6917a`
BLAKE2b-256 checksum How to use checksums	`e1a5dec54a0387e0542aaa9cd9474a4536eb166c2007b779e1898f7cc8895696`
Upload date	Jun 19, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.8.3 CPython/3.8.10 Linux/4.4.0-19041-Microsoft`