Data Structures

Here are the data structures with brief descriptions:

[detail level 1234]

▼Nnrfcxx	Primary namespace for nrfcxx functionality
▼Nboard	Namespace holding board-specific configuration data
Ciox_pin	Extension of gpio::generic_pin using the SX1509B IO extender
Cpower_monitor	Support for the power source interface
▼Nclock	Functions and classes related to clocks and time
Calarm	Class supporting an alarm with custom callback and repeatability
Cclock_shift	Support for converting between time domains with the same resolution but unstable clocks
Chfclk	Functions and data related to the high-frequency clock
Clfclk	Functions and data related to the low-frequency clock
►Cuptime	Support for a persistent system clock with 32 KiHz resolution
Ctimestamp24	Class supporting short-term duration measurements
▼Ngpio	Abstractions and constants around GPIO capability
►Cactive_signal	Wrapper supporting GPIO control of output signals by explicit or scoped assertion
Cscoped_assert	RAII instance used to assert the signal within a scope
Cgeneric_pin	Class supporting a generic GPIO pin interface
Cgpio_pin	Extension of generic_pin using an owned pin_reference
Cinstr_psel	Instrumentation through toggling GPIOs
Cinstr_psel_scoped	RAII class for scoped instrumentation
Cpin_reference	Generalized reference to a GPIO pin using a global psel ordinal
▼Nled	Abstractions and constants around LED capability
Cgeneric_led	A class used to manage LEDs
Cled_type	Base class supporting LEDs of different types
CPattern	Class that supports background LED toggles in a repeating pattern
▼Nlpm	Infrastructure to support low-power-mode operations
Clpsm_capable	Base (or mixin) class for anything that supports a state_machine
Cstate_machine	State machine abstraction for time-delayed transitions and error captures
▼Nmisc	Namespace for abstractions that aren't handled in another namespace
Clipo_monitor	A state machine to monitor a LiPo battery and charger
►Csx1509b	Abstraction around the Semtex SX1509B Level-Shifting GPIO Extender
Cgpio_regs_type	Structure for SX1509 registers that are controlled
Ciface_config_type	The pieces you need to talk to the device
Cled_pwm_type	Extended configuration for fade-capable pins
Cled_type	Basic structure for LED configuration
▼Nnrf5	Namespace holding support for bare nRF5 peripheral instances
►Nseries	Namespace holding series-specific implementations that support the genericized API of nrfcxx
CADC_Base	Material common to all ADC peripheral implementations
CADC_Peripheral	Constants and function specific to the nRF51 ADC peripheral
CSAADC_Peripheral	Constants and function specific to the nRF52 SAADC peripheral
CGPIO_Instance	A traits type identifying GPIO peripheral instances
CGPIO_Instance< 0 >
CGPIO_Instance< 1 >
Cperipheral	Capture information about an nRF5 peripheral instance
CPPI_Type
▼Nperiph	Abstractions of nRF51 peripherals
►Ndetails
Ccomm_error_support	Abstracted support for error returns
Cscoped_enabler	RAII instance that ensures the an instance is enabled within a scope
CADC	Wrapper around the ADC or SAADC peripheral
CADCClient	Base class for a client of ADC
►CGPIOTE	Class supporting GPIO task and event operations
Cevent_listener	Object used to manage event callbacks
Csense_listener	Object used to manage sense callbacks
Csense_status_type	Structure used to convey information about pin levels to sense_listener callbacks
Cinstr_psel_gpiote	Class supporting GPIO instrumentation triggered by peripheral events
CPPI	Resource allocation manager for PPI module
►CQSPI	Wrapper around the nRF52 QSPI peripheral
Cconfiguration_type	Configuration parameters for QSPI peripheral
CRNG	Wrapper around the nRF51 RNG peripheral
CRTC	Wrapper around the nRF51 RTC peripheral
►CSPI	Wrapper around the nRF51 SPI peripheral
Cconfiguration_type
►CTIMER	Wrapper around the nRF5 TIMER peripheral
Ctimestamp_type	Class supporting (high-resolution) timing
►CTWI	Wrapper around the nRF51 TWI peripheral
Cconfiguration_type
►CUART	Wrapper around the nRF51 UART peripheral
Cstatistics_type	Statistics on the UART operation
▼Nsd
►CApplicationIdBeacon	Beacon providing application identification information
Cframe_s	Frame content for this beacon
►CBeacon	Helper to schedule and construct beacons
Cframe_prefix_s	Structure providing the prefix for most beacon content
Ctelemetry_state_type	State retained across resets that is used in telemetry beacons
CBroadcaster	Infrastructure that starts and stops the soft device and provides a main event loop for the application, exposed through make_setter()
►CEnvSensorBeacon	Beacon providing information derived from environmental sensors
Cinstance_s	Generic frame data holder
Cthreshold_s	Thresholds for detecting significant changes in readings
►CGenericBeacon	Infrastructure to manage a beacon with a fixed payload
Cframe_s	Frame content for this beacon is the first #content_span octets of a #content_type instance
►CSystemStateBeacon	Beacon providing system state information
Cframe_s	Frame content for this beacon
►CTelemetryBeacon	Beacon providing telemetry information
Cframe_s	Frame content for this beacon
▼Nsensor	Namespace for abstractions of various sensors
►Nadc	Specializations of nrfcxx::periph::ADC for common ADC operations
Clpsm_wrapper	A class that implements an LPM state machine around a periph::ADCClient
CntcThermistor	Class supporting thermistor measurements
CSteinhartHart	Type holding Steinhart-Hart coefficients and extreme values
Cvdd	ADC instance to measure board Vdd
Cvoltage_divider	ADC instance for voltage dividers
Cbattery_level_point_type	A point in a battery discharge curve sequence
►Cbme280	Abstraction around BME280 temperature/humidity/pressure sensor
Cobservations_type	Structure used to return sampled values
CButton	Class that supports button state and timing events
►Cccs811	Interface to the ams CCS811 indoor air quality sensor
Ciface_config_type	Structure providing the system resources necessary to interact with the CCS811
Cobservation_beacon_type	Structure that can be broadcast as a beacon to provide observation data
Cobservations_type	Captured results after an observation
Cpersisted_state_type	State that should be persisted in non-volatile memory using the utility::Persist infrastructure
Cretained_state_type	Structure holding retained state of the sensor
Cscoped_enabler	Class obtained from scoped_enable()
Csystem_beacon_type	Structure that can be broadcast as a beacon to provide detailed system state
Cthreshold_s	Thresholds for detecting significant changes in readings
Cversion_s	Aggregate identity and version from hardware and firmware registers
►Ccontact	State and functionality related to monitoring dry contacts
Cstate_type	An aggregate capturing consistent contact state
►Chts221	Interface to the ST HTS221 capacitive digital sensor for relative humidity and temperature
Ccalibration_type	Structure for calibration information
Ciface_config_type	Information required to communicate with a sensor instance
Cobservations_type	Structure used to return sampled values
►Clps22hb	Interface to the ST LPS22HB piezzoresistave absolute pressure sensor
Ciface_config_type	Information required to communicate with a sensor instance
Cobservations_type	Structure used to return sampled values
►Csdp8xx	Abstraction around SDP8xx differential pressure sensor
Ciface_config_type	Information required to communicate with a sensor instance
Cobservations_type	Storage for cached results
►Csht21	Abstraction around SHT21/HTU21D temperature/humidity sensor
Ciface_config_type	Information required to communicate with a sensor instance
Cobservations_type	Storage for cached results
▼Nutility	Various utilities, probably not dependent on nRF51 at all
►Cmemory_pool	Class supporting allocation from a fixed-size region
Cscoped	RAII class to maintain a shared memory pool within a block scope
►CPersist	Class supporting persistence of tagged records to non-volatile memory
Cheader_type	Header identifying record content and its span
Cevent_set	A record of events that occur asynchonously
Cevent_set_copy	A helper class for processing snapshot nrfcxx::event_set values
Cmutex_irq	Nvic_BlockIRQ as a template type
Cnull_mutex	RAII class that performs no mutex operations
Cnvic_BlockIRQ	RAII class to block a peripheral interrupt
Cprimask	RAII class to block exceptions
▼CsystemState	A class supporting watchdog configuration and cross-reset retention of state
Cscoped_sleeper	RAII instance that configures the operational mode to enter OM_SLEEP when constructed, and to leave OM_SLEEP when destructed
Cstate_type	The raw data supporting cross-reset state transfer
Cwatchdog_extended_channel	Support for extended watchdog channels