ISF15ACP4 Driver 0.1.0
API reference
Loading...
Searching...
No Matches
Classes | Namespaces
isf15acp4.hpp File Reference

ISF15ACP4 driver: the one header to include. More...

#include <algorithm>
#include <array>
#include <cstddef>
#include <cstdint>
#include <span>
#include "isf15acp4_button.hpp"
#include "isf15acp4_detail.hpp"
#include "isf15acp4_registers.hpp"
#include "isf15acp4_spi_interface.hpp"
#include "isf15acp4_types.hpp"
#include "isf15acp4_version.h"
#include "../src/isf15acp4.ipp"

Go to the source code of this file.

Classes

struct  isf15acp4::ScrollSetup
 The scroll parameters of command 27h. More...
 
class  isf15acp4::ISF15ACP4< Port >
 Driver for one ISF15ACP4 on a platform port. More...
 

Namespaces

namespace  isf15acp4
 The ISF15ACP4 driver: everything it declares lives here; internals in detail.
 

Detailed Description

ISF15ACP4 driver: the one header to include.

isf15acp4::ISF15ACP4<Port> drives one NKK ISF15ACP4 frameless OLED pushbutton through a platform port you write (see isf15acp4_spi_interface.hpp): the SSD1331-class display controller over write-only SPI, the 15 V OLED supply through an enable pin, and the SPST switch through a pin read. The driver has no platform code, allocates nothing, throws nothing, takes no lock and is not thread-safe: give each object one owner, or guard it with one mutex.

The controller cannot be read: the driver knows only what it sent (docs/contract.md).