Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tmecklem authored Aug 14, 2019
1 parent 0a70fad commit f2938d4
Showing 1 changed file with 8 additions and 20 deletions.
28 changes: 8 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
# Scenic Driver Inky
# Scenic Driver FB TFT

A library to provide a Scenic framework driver implementation for the Inky series of eInk displays from Pimoroni. Built on top of the pappersverk/inky library. All in Elixir.

The Scenic UI framework is the easiest way to render text and geometries to your Inky through Elixir.
A library to provide a Scenic framework driver implementation for SPI serial connected displays

This driver only runs on RPi devices as far as we know as it is based on the scenic rpi driver generating a framebuffer we can use.

Expand All @@ -14,35 +12,25 @@ by adding `scenic_driver_inky` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:scenic_driver_inky, "~> 1.0.0"}
{:scenic_driver_fb_tft, "~> 1.0.0"}
]
end
```

## Usage

This library provides the `ScenicDriverInky` driver module. A solid usage example is provided in [pappersverk/sample_scenic_inky](https://github.com/pappersverk/sample_scenic_inky). It boils down to driver configuration:
This library provides the `ScenicDriverFBTFT` driver module. Driver configuration:

```
config :sample_scenic_inky, :viewport, %{
config :sample_scenic_fb_tft, :viewport, %{
name: :main_viewport,
default_scene: {SampleScenicInky.Scene.Main, nil},
size: {212, 104},
default_scene: {YourApp.Scene.Main, nil},
size: {480, 320},
opts: [scale: 1.0],
drivers: [
%{
module: ScenicDriverInky,
opts: [
type: :phat,
accent: :red,
opts: %{
border: :black
}
# dithering: :halftone
]
module: ScenicDriverFBTFT
}
]
}
```

For development on host, we recommend just using the glfw driver for scenic (also shown in the sample). It won't give you that sweet lo-fi representation of the Inky though, so be mindful of accidentally using all those colors when you do.

0 comments on commit f2938d4

Please sign in to comment.