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 WS2812B

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

The WS2812B'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/ws2812_rmt.hpp; inc/ws2812_rmt_gpio_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

WS2812B: Level shifter for a 3.3 V MCU, supply always on

Schematic of the WS2812B level shifter for a 3.3 v mcu, supply always on: the chip with U2 MCU, U4 74HCT buffer, R1 resistor 330 Ω, C1 capacitor 100 nF, R2 resistor 10 kΩ; the MCU wires carry the port hooks GpioSet(CtrlPin::Power), Transmit().Schematic of the WS2812B level shifter for a 3.3 v mcu, supply always on: the chip with U2 MCU, U4 74HCT buffer, R1 resistor 330 Ω, C1 capacitor 100 nF, R2 resistor 10 kΩ; the MCU wires carry the port hooks GpioSet(CtrlPin::Power), Transmit().
WS2812B: Level shifter for a 3.3 V MCU, supply always on
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/ws2812_rmt.hpp; inc/ws2812_rmt_gpio_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

WS2812B: Typical application

Schematic of the WS2812B typical application: the chip with U2 MCU, U3 Load switch, U4 74HCT buffer, J1 5 V supply, R1 resistor 330 Ω, C1 capacitor 100 nF, R2 resistor 10 kΩ; the MCU wires carry the port hooks GpioSet(CtrlPin::Power), Transmit().Schematic of the WS2812B typical application: the chip with U2 MCU, U3 Load switch, U4 74HCT buffer, J1 5 V supply, R1 resistor 330 Ω, C1 capacitor 100 nF, R2 resistor 10 kΩ; the MCU wires carry the port hooks GpioSet(CtrlPin::Power), Transmit().
WS2812B: 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/ws2812_rmt.hpp; inc/ws2812_rmt_gpio_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

WS2812B package, 5050 (WS2812B)

Outline of the WS2812B in 5050 (WS2812B) drawn to scale from above: body 5.4 x 5.0 x 1.57 mm, 4 pins.Outline of the WS2812B in 5050 (WS2812B) drawn to scale from above: body 5.4 x 5.0 x 1.57 mm, 4 pins.
WS2812B package, 5050 (WS2812B)
Figure description and sources

The WS2812B package seen from the top and, when the height is known, from the side, drawn to scale: 5.4 x 5.0 x 1.57 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, evenly spaced; the datasheet's land pattern is the reference for a board.

Drawn from: docs/hardware.yml; inc/ws2812_rmt.hpp; inc/ws2812_rmt_gpio_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

WS2812B pinout, 5050 (WS2812B)

Pinout of the WS2812B in 5050 (WS2812B), top view: 4 pins, each with its name, its electrical type as a colour and the driver hook that uses it.Pinout of the WS2812B in 5050 (WS2812B), top view: 4 pins, each with its name, its electrical type as a colour and the driver hook that uses it.
WS2812B pinout, 5050 (WS2812B)
Figure description and sources

The WS2812B seen from the top, in its 5050 (WS2812B) 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/ws2812_rmt.hpp; inc/ws2812_rmt_gpio_interface.hpp.

Hardware description: docs/hardware.yml

Drawn from:

The layers, one of them yours

Layer diagram: your application calls the Ws2812Rmt core, which sends whole frames of pixel bytes through the GPIO 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 Ws2812Rmt core, which sends whole frames of pixel bytes through the GPIO 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/ws2812_rmt.hpp public calls; inc/ws2812_rmt_gpio_interface.hpp GpioInterface; figure module docs/diagrams/figures/driver-layers.py.

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

Drawn from: