Device Specific Options

Some device display drivers have options that are unique to that display. When dealing with the device directly these are often added when initializing or displaying an image on the device. To handle these, additional options can be set in the INI file loaded at runtime. These can be set in either the [EPD] section or a device specific section (example: [omni_epd.mock]) of the file depending on your need. As always device specific configurations override global (EPD section) settings.

Below is a list of devices that have additional INI options and what they are:

[inky.impression]
saturation=.5  # saturation of palette - higher value results in a more saturated image
border=clean  # sets a border around the display, valid colors are black, white, green, blue, red, yellow, orange, or clean (no color)

[inky.phat_black]
palette_filter=[[R,G,B],[R,G,B]]  # colors to filter from image prior to writing to display, max colors is 2
border=white  # sets a border around the display, valid colors are black, or white

[inky.phat_red]
palette_filter=[[R,G,B],[R,G,B]]  # colors to filter from image prior to writing to display, max colors is 2 or 3 depending on color mode used
border=white  # sets a border around the display, valid colors are black, white, or red

[inky.phat_yellow]
palette_filter=[[R,G,B],[R,G,B]]  # colors to filter from image prior to writing to display, max colors is 2 or 3 depending on color mode used
border=white  # sets a border around the display, valid colors are black, white, or  yellow

[inky.what_black]
palette_filter=[[R,G,B],[R,G,B]]  # colors to filter from image prior to writing to display, max colors is 2
border=white  # sets a border around the display, valid colors are black, or white

[inky.what_red]
palette_filter=[[R,G,B],[R,G,B]]  # colors to filter from image prior to writing to display, max colors is 2 or 3 depending on color mode used
border=white  # sets a border around the display, valid colors are black, white, or red

[inky.what_yellow]
palette_filter=[[R,G,B],[R,G,B]]  # colors to filter from image prior to writing to display, max colors is 2 or 3 depending on color mode used
border=white  # sets a border around the display, valid colors are black, white, or  yellow

[omni_epd.mock]
palette_filter=[[R,G,B],[R,G,B]]  # colors to filter from image when in palette mode, max is 256
file=mock_output.png  # path to the file where the image will be written when calling display() on the mock object
write_file=True  # True/False value on if image file should be written when calling display()
width=400  # width of the image written to disk
height=200  # height of the image written to disk