Skip to content

Figures

Every figure on this site is drawn by a Python module from facts extracted from the code, so it is rebuilt, not redrawn, when the code changes. CI runs kokeb-docs figures --check and fails when a committed figure no longer matches the code. Each figure below lists the files it is drawn from.

Inside the ISF15ACP4

Block diagram of the ISF15ACP4: its function blocks, how they connect and which package pins reach each block.Block diagram of the ISF15ACP4: its function blocks, how they connect and which package pins reach each block.
Inside the ISF15ACP4
Figure description and sources

The ISF15ACP4's function blocks inside its outline. Arrows between blocks carry signals or data in the direction they point (both ways where they have two heads). The package pins stand on the left and right edges with their numbers, each wired to the block it reaches.

Drawn from: docs/hardware.yml; inc/isf15acp4.hpp; inc/isf15acp4_spi_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

ISF15ACP4: Typical application

Schematic of the ISF15ACP4 typical application: the chip with U2 MCU, J1 OLED supply, R1 resistor 10 kΩ, R2 resistor 100 kΩ; the MCU wires carry the port hooks GpioSet(CtrlPin::Reset), GpioSet(CtrlPin::VccEnable), ReadSwitch(), Write(), Write(DataKind).Schematic of the ISF15ACP4 typical application: the chip with U2 MCU, J1 OLED supply, R1 resistor 10 kΩ, R2 resistor 100 kΩ; the MCU wires carry the port hooks GpioSet(CtrlPin::Reset), GpioSet(CtrlPin::VccEnable), ReadSwitch(), Write(), Write(DataKind).
ISF15ACP4: Typical application
Figure description and sources

A schematic. The MCU is on the left, each of its pins level with the chip pin it connects to; above each wire is the hook of the driver's port that drives or reads it. Supply pins point up to their supply and decoupling, ground pins down. Pins on the right carry the loads and the pins tied to a supply or ground; a cross marks a pin left open. A dot is a junction; wires that cross without a dot are not connected.

Drawn from: docs/hardware.yml; inc/isf15acp4.hpp; inc/isf15acp4_spi_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

ISF15ACP4 package, Module

Outline of the ISF15ACP4 in Module drawn to scale from above: body 23.13 x 23.0 x 18.0 mm, pitch 4.0 mm, 10 pins.Outline of the ISF15ACP4 in Module drawn to scale from above: body 23.13 x 23.0 x 18.0 mm, pitch 4.0 mm, 10 pins.
ISF15ACP4 package, Module
Figure description and sources

The ISF15ACP4 package seen from the top and, when the height is known, from the side, drawn to scale: 23.13 x 23.0 x 18.0 mm. The arrows carry the datasheet's dimensions, the dot marks pin 1 and the pads are numbered counter-clockwise from it, coloured by the pin's electrical type (legend below). Pads sit centred on each side at the stated pitch; the datasheet's land pattern is the reference for a board.

Drawn from: docs/hardware.yml; inc/isf15acp4.hpp; inc/isf15acp4_spi_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

ISF15ACP4 pinout, Module

Pinout of the ISF15ACP4 in Module, top view: 10 pins, each with its name, its electrical type as a colour and the driver hook that uses it.Pinout of the ISF15ACP4 in Module, top view: 10 pins, each with its name, its electrical type as a colour and the driver hook that uses it.
ISF15ACP4 pinout, Module
Figure description and sources

The ISF15ACP4 seen from the top, in its Module package. Pin 1 is marked by the dot; the numbers run counter-clockwise from it. Each pad is coloured by the pin's electrical type (legend below). Next to it is the pin's name and, in mono, the hook of the driver's port that drives or reads it; a pin without a hook is not used by the driver.

Drawn from: docs/hardware.yml; inc/isf15acp4.hpp; inc/isf15acp4_spi_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

The layers, one of them yours

Layer diagram: your application calls the ISF15ACP4 core, which sends register reads and writes through the SPI port contract to the port class you write, which drives the chip; the core and the contract are the same on every MCU.Layer diagram: your application calls the ISF15ACP4 core, which sends register reads and writes through the SPI port contract to the port class you write, which drives the chip; the core and the contract are the same on every MCU.
The layers, one of them yours
Figure description and sources

Top to bottom, each arrow is a call. Your application calls one object, whose public calls are listed from the umbrella header in inc/. The core turns each call into register reads and writes and hands them to the port contract (the CRTP base in inc/*_interface.hpp), which forwards them, at compile time, to the hooks of the port class you write; your port moves the bytes on the bus. The notes on the right say which layers stay the same on every MCU and which one you write. A library without a port contract has only the first two layers.

Drawn from: inc/isf15acp4.hpp public calls; inc/isf15acp4_spi_interface.hpp SpiInterface; figure module docs/diagrams/figures/driver-layers.py.

Figure module: docs/diagrams/figures/driver-layers.py

Drawn from:

From start-up to a drawn rectangle

From start-up to a drawn rectangle: initialisation powers and resets the display and clears its memory, DisplayOn raises the panel supply and sends the display-on command, and DrawRectangle sends one drawing command.From start-up to a drawn rectangle: initialisation powers and resets the display and clears its memory, DisplayOn raises the panel supply and sends the display-on command, and DrawRectangle sends one drawing command.
From start-up to a drawn rectangle
Figure description and sources

Participants, left to right: App, Core and Port. The steps run from top to bottom. App sends EnsureInitialized() to Core. Core sends GpioSet(VccEnable, INACTIVE) to Port. Core sends GpioSet(Reset, ACTIVE) then INACTIVE to Port. Core sends Write(Command, display off, configuration) to Port. Core sends Write(Data, 12 288 zero bytes in chunks) to Port. App sends DisplayOn() to Core. Core sends GpioSet(VccEnable, ACTIVE) to Port. Core sends DelayUs(vcc_settle), Write(Command, AFh), DelayUs(100 ms) to Port. App sends DrawRectangle(...) to Core. Core sends Write(Command, 26h, 22h and 10 parameters) to Port. Core sends DelayUs(engine_settle) to Port.

Drawn from: docs/model/start-up-and-draw.seq.yml.

Hardware description: docs/model/start-up-and-draw.seq.yml

Drawn from: