GrovePi

v0.6.1

GrovePi v0.6.1 GrovePi.RGBLCD View Source

Conveniences for controlling a RGB LCD Display. The display should be connected to the I2C-1 port.

Example usage:

iex> {:ok, config} = GrovePi.RGBLCD.initialize()
{:ok, %GrovePi.RGBLCD.Config{display_control: 12, entry_mode: 6, function: 56}}
iex> {:ok, new_config} = GrovePi.RGBLCD.cursor_on(config)
{:ok, %GrovePi.RGBLCD.Config{display_control: 14, entry_mode: 6, function: 56}}
iex> GrovePi.RGBLCD.set_rgb(0, 255, 0)
:ok
iex> GrovePi.RGBLCD.set_text("hello world!")
:ok

Link to this section Summary

Functions

autoscroll(config)

Autoscroll so display moves with cursor

autoscroll_off(config)

Display does not move with cursor

clear_display()

Clears the LCD Display

cursor_blink_off(config)

Turn off blinking the cursor

cursor_blink_on(config)

Turn on blinking the cursor

cursor_left(spaces \\ 1)

Moves cursor to the left. Accepts spaces (integer), defaults to 1

cursor_off(config)

Turn off the underline cursor

cursor_on(config)

Turn on the underline cursor

cursor_right(spaces \\ 1)

Moves cursor to the right. Accepts spaces (integer), defaults to 1

display_off(config)

Turns display off quickly

display_on(config)

Turns display on quickly

get_default_config()

Returns a GrovePi.RGBLCD.Config struct with default configuration.

  • 2 Line
  • 8 bit mode
  • 5x8 dots
  • display on
  • cursor off
  • blink off
  • increment after entry (right to left)
  • display shift (autoscroll) off
home()

Sets cursor position to zero

initialize()

Initializes the LCD Display. Returns tuple with :ok, and %GrovePi.RGBLCD.Config{} with initial configuration

scroll_left(spaces \\ 1)

Scroll display left. Accepts spaces (integer) as an argument, defaults to 1

scroll_right(spaces \\ 1)

Scroll display right. Accepts spaces (integer) as an argument, defaults to 1

set_color_white()

Sets display to white (255 for Red, Green, and Blue)

set_cursor(arg1, col)

Sets cursor given row and value. Home position is (0, 0)

set_rgb(red, green, blue)

Sets the red, green, and blue values for a RGB LCD Display. Accepts an integer from 0 - 255 for each color

set_text(text)

Updates the text on a RGB LCD Display. Deletes existing text

text_left_to_right(config)

Set text flow from left to right

text_right_to_left(config)

Set text flow from right to left

write_text(text)

Write text at cursor. Does not delete existing text

Link to this section Functions

Link to this function autoscroll(config) View Source

Autoscroll so display moves with cursor

Link to this function autoscroll_off(config) View Source

Display does not move with cursor

Link to this function clear_display() View Source

Clears the LCD Display

Link to this function cursor_left(spaces \\ 1) View Source

Moves cursor to the left. Accepts spaces (integer), defaults to 1.

Link to this function cursor_off(config) View Source

Turn off the underline cursor

Link to this function cursor_on(config) View Source

Turn on the underline cursor

Link to this function cursor_right(spaces \\ 1) View Source

Moves cursor to the right. Accepts spaces (integer), defaults to 1.

Link to this function display_off(config) View Source

Turns display off quickly

Link to this function display_on(config) View Source

Turns display on quickly

Link to this function get_default_config() View Source

Returns a GrovePi.RGBLCD.Config struct with default configuration.

  • 2 Line
  • 8 bit mode
  • 5x8 dots
  • display on
  • cursor off
  • blink off
  • increment after entry (right to left)
  • display shift (autoscroll) off
Link to this function home() View Source

Sets cursor position to zero

Link to this function initialize() View Source

Initializes the LCD Display. Returns tuple with :ok, and %GrovePi.RGBLCD.Config{} with initial configuration.

Link to this function scroll_left(spaces \\ 1) View Source

Scroll display left. Accepts spaces (integer) as an argument, defaults to 1.

Link to this function scroll_right(spaces \\ 1) View Source

Scroll display right. Accepts spaces (integer) as an argument, defaults to 1.

Link to this function set_color_white() View Source

Sets display to white (255 for Red, Green, and Blue)

Link to this function set_cursor(arg1, col) View Source

Sets cursor given row and value. Home position is (0, 0).

Link to this function set_rgb(red, green, blue) View Source

Sets the red, green, and blue values for a RGB LCD Display. Accepts an integer from 0 - 255 for each color.

Link to this function set_text(text) View Source

Updates the text on a RGB LCD Display. Deletes existing text.

Link to this function text_left_to_right(config) View Source

Set text flow from left to right

Link to this function text_right_to_left(config) View Source

Set text flow from right to left

Link to this function write_text(text) View Source

Write text at cursor. Does not delete existing text.