ISF15ACP4 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Public Attributes | List of all members
isf15acp4::Config Struct Reference

Everything the driver sends at start-up, and its own time knobs. More...

#include <isf15acp4_types.hpp>

Public Attributes

Variant variant {Variant::Isf15acp4}
 Which module; sets the geometry.
 
Remap remap {}
 A0h.
 
uint8_t contrast_a {0x1C}
 81h. Reset value 0x80.
 
uint8_t contrast_b {0x2E}
 82h.
 
uint8_t contrast_c {0x2C}
 83h.
 
uint8_t precharge_speed_a {0x4F}
 8Ah: second pre-charge speed, colour A.
 
uint8_t precharge_speed_b {0x74}
 8Bh.
 
uint8_t precharge_speed_c {0x88}
 8Ch.
 
uint8_t master_current {0x0F}
 87h, 0 to 15 (1/16 to 16/16).
 
uint8_t start_line {0}
 A1h, 0 to 63.
 
uint8_t display_offset {0}
 A2h, 0 to 63.
 
DisplayMode mode {DisplayMode::Normal}
 A4h to A7h.
 
DimSettings dim {}
 ABh.
 
bool power_save {false}
 B0h: false = disabled (reset value: enabled).
 
uint8_t phase1 {7}
 B1h phase 1, 1 to 15 DCLK.
 
uint8_t phase2 {1}
 B1h phase 2, 1 to 15 DCLK.
 
uint8_t clock_divide {0}
 B3h A[3:0]: ratio is this + 1.
 
uint8_t clock_frequency {15}
 B3h A[7:4].
 
uint8_t precharge_level {14}
 BBh A[5:1], 0 to 31.
 
bool precharge_bit0 {true}
 BBh bit 0 (reserved): NKK Table 3 sends 1Dh, Tables 1/2 12h.
 
bool send_precharge_speeds {true}
 8Ah to 8Ch: only the ISF15ACP4 table (Table 3) has them.
 
uint8_t vcomh_level {16}
 BEh A[5:1], 0 to 31.
 
bool linear_gray_scale {true}
 B9h at start-up (false: the reset table stays).
 
bool clear_ram {true}
 Zero GDDRAM before the supply is enabled.
 
bool red_on_segment_a {true}
 Panel wiring: segment group A carries red.
 
bool writes_while_scrolling {false}
 Allow RAM writes while scrolling (datasheet is silent).
 
uint32_t vcc_settle_ms {50}
 VCC enable to AFh; the datasheet says only "stable".
 
uint32_t vcc_off_ms {reg::kVccOffTypicalMs}
 VCC off to the end of power-down (tOFF typical).
 
uint32_t engine_settle_us {3000}
 Wait after a drawing command; not in the datasheet.
 
uint32_t idle_dim_ms {0}
 Poll(): dim after this idle time; 0 = never.
 
uint32_t idle_sleep_ms {0}
 Poll(): sleep after this idle time; 0 = never.
 
ButtonConfig button {}
 The switch.
 

Detailed Description

Everything the driver sends at start-up, and its own time knobs.

Config{} is the ISF15ACP4 (NKK Table 3). The controller values are the module's table values (contrast, offset, multiplex ratio, master configuration, phase periods, clock, gray scale, pre-charge, VCOMH): NKK Note 1 says changing them may damage the OLED module. The dim contrasts may not exceed the contrasts. The time knobs are the driver's own and document an open point of the datasheets (docs/ambiguities.md). It has no operator==.


The documentation for this struct was generated from the following file: