Returns a specification to start this module under a supervisor.

See Supervisor.

@spec command(pid(), byte(), Keyword.t()) :: :ok

Write a byte to the display as command data.

• display: %ILI9486{}
• cmd: command data
• opts:
  • cmd_data: cmd data to be sent. Default value: []. (no data will be sent)
  • delay: wait delay ms after the cmd data is sent Default value: 0. (no wait)

return: display

@spec data(pid(), iodata()) :: :ok

Write a byte or array of bytes to the display as display data.

• display: %ILI9486{}
• data: display data

return: display

@spec display(pid(), image_data(), color_format()) :: :ok

Write the provided 24bit BGR888/RGB888 image to the hardware.

• display: %ILI9486{}
• image_data: Should be 24bit format and the same dimensions (width x height x 3) as the display hardware.
• pix_fmt: Either :rgb888 or :bgr888. Indicates the channel order of the provided image_data.

return: display

@spec display_565(pid(), image_data()) :: :ok

Write the provided 16bit BGR565/RGB565 image to the hardware.

• display: %ILI9486{}
• image_data: Should be 16bit BGR565/RGB565 format (same channel order as in display) and the same dimensions (width x height x 3) as the display hardware.

return: display

@spec display_666(pid(), image_data()) :: :ok

Write the provided 18bit BGR666/RGB666 image to the hardware.

• display: %ILI9486{}
• image_data: Should be 18bit BGR666/RGB666 format (same channel order as in display) and the same dimensions (width x height x 3) as the display hardware.

return: display

@spec pix_fmt(pid()) :: pixel_format()

Get display pixel format

• display: %ILI9486{}

return: one of :bgr565, :rgb565, :bgr666, :rgb666

@spec reset(pid()) :: :ok

Reset the display, if reset pin is connected.

• display: %ILI9486{}

return: display

@spec send(pid(), integer() | iodata(), boolean()) :: :ok

Send bytes to the ILI9486

• display: %ILI9486{}

• bytes: The bytes to be sent to display

  • when is_integer(bytes), sent will take the 8 least-significant bits [band(bytes, 0xFF)] and send it to display
  • when is_list(bytes), bytes will be casting to bitstring and then sent to display

• is_data:

  • true: bytes will be sent as data
  • false: bytes will be sent as commands

return: display

@spec set_display(pid(), :on | :off) :: :ok

Turn on/off display

• display: %ILI9486{}
• status: either :on or :off

return: display

@spec set_display_mode(pid(), display_mode()) :: :ok

Set display mode

• display: %ILI9486{}
• display_mode: Valid values: :normal, :partial, :idle

return: display

@spec set_frame_rate(pid(), frame_rate()) :: :ok

Set frame rate

• display: %ILI9486{}
• frame_rate: Valid value should be one of the following
  • 28
  • 30
  • 32
  • 34
  • 36
  • 39
  • 42
  • 46
  • 50
  • 56
  • 62
  • 70
  • 81
  • 96
  • 117

return: :ok

@spec set_pix_fmt(pid(), pixel_format()) :: :ok

Set display pixel format

• display: %ILI9486{}
• pix_fmt: one of :bgr565, :rgb565, :bgr666, :rgb666

return: display

@spec set_touch_callback(pid(), touch_callback()) :: :ok

Set touch panel callback function

• display: %ILI9486{}
• callback: callback function. 3 arguments: pin, timestamp, status

@spec size(pid()) :: %{height: pos_integer(), width: pos_integer()}

Get screen size

• display: %ILI9486{}

return: %{height: height, width: width}

@spec start_link([ili9486_option()]) :: GenServer.on_start()

Start a new connection to an ILI9486.

return: %ILI9486{}

Example

# default
# assuming LCD device at /dev/spidev0.0
# DC connects to PIN 24
# RST not connected
# SPI speed: 16MHz
# Pixel Format: BGR565
{:ok, disp} = ILI9486.start_link()

# default with touch panel
# DC connects to PIN 24
# RST connects to PIN 25
# SPI speed: 16MHz
# Pixel Format: RGB666 (for demo only, not necessary)
# Touch panel device at /dev/spidev0.1
# Touch panel IRQ PIN 17
{:ok, disp} = ILI9486.start_link(
  speed_hz: 16_000_000,
  pix_fmt: :bgr666,
  rst: 25,
  touch_cs: 1,
  touch_irq: 17
)

high-speed variant (125MHz SPI)

# assuming LCD device at /dev/spidev0.0
# DC connects to PIN 24
# RST connects to PIN 25 (for demo only, not necessary)
# SPI speed: 125MHz
# Pixel Format: BGR666 (for demo only, not necessary)
{:ok, disp} = ILI9486.start_link(
  is_high_speed: true,
  speed_hz: 125_000_000,
  pix_fmt: :bgr666,
  rst: 25
)

high-speed variant (125MHz SPI) with touch panel

# assuming LCD device at /dev/spidev0.0
# DC connects to PIN 24
# RST connects to PIN 25 (for demo only, not necessary)
# SPI speed: 125MHz
# Pixel Format: BGR666 (for demo only, not necessary)
# Touch panel device at /dev/spidev0.1
# Touch panel IRQ PIN 17
{:ok, disp} = ILI9486.start_link(
  is_high_speed: true,
  speed_hz: 125_000_000,
  pix_fmt: :bgr666,
  rst: 25,
  touch_cs: 1,
  touch_irq: 17
)

@spec terminate(any(), t()) :: :ok

Closes all SPI and GPIO resources on shutdown.