Class Hierarchy

This inheritance list is sorted roughly, but not completely, alphabetically:

• class hal::accelerometer Acceleration sensing hardware abstraction interface.
  • class hal::soft::inert_accelerometer Inert implementation of acceleration sensing hardware.
• class hal::adc Analog to Digital Converter (ADC) hardware abstraction interface.
  • class hal::lpc40::adc Analog to digital converter.
  • struct hal::mock::adc Mock adc implementation for use in unit tests and simulations.
  • class hal::soft::adc_mux_pin A class that represents a multiplexer pin for ADC.
  • class hal::soft::inert_adc Inert implementation of Analog to Digital Converter (ADC) hardware.
• class hal::angular_velocity_sensor angular velocity sensor hardware abstraction interface
  • class hal::rmd::drc_angular_velocity_sensor angular velocity sensor adaptor for DRC
• class hal::bit_value
  • class hal::bit_modify
• class hal::can Controller Area Network (CAN bus) hardware abstraction interface.
  • class hal::lpc40::can
  • struct hal::mock::can Mock can implementation for use in unit tests and simulations.
• class hal::can_router Route CAN messages received on the can bus to callbacks based on ID.
• class hal::steady_clock Hardware abstraction interface for a steady clock mechanism.
  • class hal::cortex_m::dwt_counter A counter with a frequency fixed to the CPU clock rate.
  • struct hal::mock::steady_clock mock steady_clock implementation for use in unit tests and simulations.
  • class hal::soft::inert_steady_clock Inert implementation of steady clock mechanism.
• class hal::cortex_m::interrupt Cortex M series interrupt controller.
• class hal::cortex_m::interrupt::exception_number represents an interrupt request number along with helper functions for setting up the interrupt controller registers.
• class hal::timer Timer hardware abstraction interface.
  • class hal::cortex_m::systick_timer SysTick driver for the ARM Cortex Mx series chips.
  • struct hal::mock::timer Mock timer implementation for use in unit tests and simulations with spy functions for schedule() , clear(), andis_running() __
  • class hal::soft::inert_timer Inert implementation of timer hardware.
• class hal::current_sensor current sensor hardware abstraction interface
  • class hal::rmd::mc_x_current_sensor current sensor adaptor for mc_x __
• class hal::dac Digital to Analog Converter (DAC) hardware abstraction interface.
  • struct hal::mock::dac Mock dac implementation for use in unit tests and simulations with a spy function for write() __
  • class hal::soft::inert_dac Inert implementation of Digital to Analog Converter (DAC) hardware.
• class hal::distance_sensor Linear distance hardware abstraction interface.
  • class hal::soft::inert_distance_sensor Inert implementation of linear distance hardware.
• class hal::esp8266::at AT Command network driver for the esp8266 .
• class hal::gyroscope Angular velocity sensing hardware abstraction interface.
  • class hal::soft::inert_gyroscope Inert implementation of angular velocity sensing hardware.
• class hal::i2c Inter-integrated Circuit (I2C) hardware abstract interface.
  • class hal::lpc40::i2c
  • class hal::soft::minimum_speed_i2c A i2c wrapper to ensure that the lowesti2c device frequency is used.
• class hal::input_pin Digital input pin hardware abstraction interface.
  • class hal::lpc40::input_pin Input pin implementation for the lpc40xx.
  • struct hal::mock::input_pin mock input_pin implementation for use in unit tests and simulations.
  • class hal::soft::inert_input_pin Inert implementation of digital input pin hardware.
  • class hal::soft::input_pin_inverter
• class hal::interrupt_pin Digital interrupt pin hardware abstraction.
  • class hal::lpc40::interrupt_pin Interrupt pin implementation for the lpc40xx.
  • struct hal::mock::interrupt_pin mock interrupt_pin implementation for use in unit tests and simulations.
  • class hal::soft::inert_interrupt_pin Inert implementation of digital interrupt pin hardware.
• class hal::lpc40::clock Allows user code to manipulate and retrieve the various system clocks speeds.
• class hal::output_pin Digital output pin hardware abstraction.
  • class hal::lpc40::output_pin Output pin implementation for the lpc40xx.
  • struct hal::mock::output_pin mock output pin for use in unit tests and simulations
  • class hal::soft::inert_output_pin Inert implementation of digital output pin hardware.
  • class hal::soft::output_pin_inverter
  • class hal::stm32f1::output_pin Output pin implementation for the stm32::f10x.
• class hal::lpc40::pin lpc40xx pin multiplexing and control driver used drivers and apps seeking to tune the pins.
• class hal::lpc40::power Power control for lpc40xx peripherals.
• class hal::pwm Pulse Width Modulation (PWM) channel hardware abstraction.
  • class hal::lpc40::pwm pwm driver for the lpc40xx series of micro controllers
  • struct hal::mock::pwm Mock pwm implementation for use in unit tests and simulations with spy functions for frequency() andduty_cycle() .
  • class hal::soft::inert_pwm Inert implementation of Pulse Width Modulation (PWM) channel hardware.
• class hal::spi Serial peripheral interface (SPI) communication protocol hardware abstract interface.
  • class hal::lpc40::spi
  • struct hal::mock::write_only_spi Mock spi implementation for use in unit tests and simulations with a spy functions for configure() and a record for thetransfer() out data. The record ignores the in buffer and just stores the data being sent so it can be inspected later.
• class hal::serial Hardware abstract interface for the serial communication protocol.
  • class hal::lpc40::uart Implementation of the UART peripheral for the LPC40xx family of microcontrollers.
• class hal::magnetometer Magnetic field strength sensing hardware abstraction interface.
  • class hal::soft::inert_magnetometer Inert implementation of magnetic field strength sensing hardware.
• class hal::motor Hardware abstraction for an open loop rotational actuator.
  • struct hal::mock::motor Mock motor implementation for use in unit tests and simulations with a spy function for power() __
  • class hal::rmd::drc_motor Motor interface adaptor for DRC.
  • class hal::rmd::mc_x_motor Control a mc_x motor driver like ahal::motor .
  • class hal::soft::inert_motor Inert implementation of open loop motorized actuator hardware.
• class hal::move_interceptor Use this to perform changes on an object its move constructor is executed.
• class hal::mpl::mpl3115a2
• class hal::overflow_counter Extend a counter's count from an arbitrary bit width to 64-bits by detecting overflows in the count. Each detected overflow is added to an overflow counter which is combined with the current count in order create a count up to 64-bits in length.
• class hal::read_into Non-blocking callable for reading serial data into a buffer.
• class hal::read_uint32 Read bytes from serial port and convert to integer.
• class hal::read_upto Discard received bytes until the sequence is found.
• class hal::rmd::drc Driver for RMD motors equip with the DRC motor drivers.
• class hal::rotation_sensor Rotation measuring hardware abstraction interface.
  • class hal::rmd::drc_rotation_sensor Rotation sensor adaptor for DRC motors.
  • class hal::rmd::mc_x_rotation Reports the rotation of the DRC motor.
  • class hal::soft::inert_rotation_sensor Inert implementation of rotation measuring hardware.
• class hal::servo Hardware abstraction for a closed loop position controlled rotational actuator.
  • struct hal::mock::servo Mock servo implementation for use in unit tests and simulations with a spy function for position() __
  • class hal::rmd::drc_servo Servo interface adaptor for DRC.
  • class hal::rmd::mc_x_servo Control a mc_x motor driver like ahal::servo .
  • class hal::soft::rc_servo Generic RC servo driver.
• class hal::temperature_sensor Temperature sensing hardware abstraction interface.
  • class hal::rmd::drc_temperature_sensor Temperature sensor adaptor for DRC motors.
  • class hal::rmd::mc_x_temperature Reports the temperature of the DRC motor.
  • class hal::soft::inert_temperature_sensor Inert implementation of temperature sensing hardware.
• class hal::rmd::mc_x Driver for RMD series motors equip with the MC-X motor driver.
• class hal::skip_past Discard received bytes until the sequence is found.
• class hal::soft::adc_multiplexer A driver for an ADC multiplexer that manages and reads ADC mux pins. This driver is intended to be used with multiplexers that use digital signals. An ADC multiplexer can be used to expand the number of input channels of an ADC.
• class hal::spy_handler Helper utility for making mocks for class functions that return status.
• class hal::static_callable General class which will be used to allow for signature to be used and then split by the below class.
• class hal::static_callable< owner_class, reference_designator, return_t(args_t... p_args)> Specialization of static_callable with the return type and arguments split up.
• class hal::static_list static_list is a non-owning non-allocating doubly linked list container with O(1) memory utilization.
• class hal::static_list::item Item/node within the static linked list.
• class hal::static_list::item_iterator Iterator for the static list.
• class hal::steady_clock_timeout Timeout object based on hal::steady_clock .
• class hal::stream_fill Non-blocking callable for reading serial data into a buffer.
• class hal::stream_fill_upto Discard received bytes until the sequence is found.
• class hal::stream_find Discard received bytes until the sequence is found.
• class hal::stream_parse Read bytes from stream and convert to integer.
• class hal::stream_skip Skip number of bytes in a byte stream.
• class hal::esp8266::at::packet_manager
• struct hal::accelerometer::read_t Result from reading the accelerometer.
• struct hal::adc::read_t Result from reading the adc.
• struct hal::angular_velocity_sensor::read_t angular velocity reading from the sensor
• struct hal::bit_limits Similar to std::numeric_limits<T> except that this object can give properties of integral types of arbitrary bit widths.
• struct hal::bit_mask Represents a bit mask of contiguous bits.
• struct hal::byte_mask Helper for generating byte position masks.
• struct hal::can::message_t A CAN message.
• struct hal::can::send_t Feedback from sending data over the CAN BUS.
• struct hal::can::settings Generic settings for a can peripheral.
• struct hal::can_router::route
• struct hal::current_sensor::read_t current reading from the sensor
• struct hal::dac::write_t Feedback from writing a voltage to the dac.
• struct hal::distance_sensor::read_t Result from sampling the distance sensor.
• struct hal::esp8266::at::read_t
• struct hal::esp8266::at::socket_config
• struct hal::esp8266::at::write_t
• struct hal::gyroscope::read_t Result from reading the gyroscope.
• struct hal::i2c::settings Generic settings for a standard I2C device.
• struct hal::i2c::transaction_t Feedback from performing a transaction on the i2c bus.
• struct hal::input_pin::level_t Input pin level reading structure.
• struct hal::input_pin::settings Generic settings for input pins.
• struct hal::interrupt_pin::settings Generic settings for interrupt pins.
• struct hal::lpc40::adc::channel Channel specific information.
• struct hal::lpc40::can::port
• struct hal::lpc40::clock::configuration Clock configuration object.
• struct hal::lpc40::clock::configuration::cpu_t cpu clock control config struct
• struct hal::lpc40::clock::configuration::pll_t phase locked loops config struct
• struct hal::lpc40::clock::configuration::spifi_t spifi clock control config struct
• struct hal::lpc40::clock::configuration::usb_t usb clock control config struct
• struct hal::lpc40::i2c::bus_info
• struct hal::lpc40::pwm::channel Channel specific information.
• struct hal::lpc40::spi::bus_info Information used to configure the spi bus.
• struct hal::lpc40::uart::port
• struct hal::magnetometer::read_t Result from reading the accelerometer.
• struct hal::motor::power_t Feedback from setting the motor power.
• struct hal::mpl::mpl3115a2::altitude_read_t
• struct hal::mpl::mpl3115a2::pressure_read_t
• struct hal::mpl::mpl3115a2::temperature_read_t
• struct hal::nibble_mask Helper for generating nibble position masks.
• struct hal::output_pin::level_t Pin level reading structure.
• struct hal::output_pin::set_level_t Feedback from setting the pin state.
• struct hal::output_pin::settings Generic settings for output pins.
• struct hal::pwm::duty_cycle_t Feedback setting the pwm duty cycle.
• struct hal::pwm::frequency_t Feedback setting the pwm frequency.
• struct hal::rmd::drc::feedback_t
• struct hal::rmd::mc_x::feedback_t
• struct hal::rotation_sensor::read_t Result from reading the rotation sensor.
• struct hal::serial::flush_t Feedback from performing a flush operation.
• struct hal::serial::read_t Return type for serial read operations.
• struct hal::serial::settings Generic settings for a standard serial device.
• struct hal::serial::write_t Return type for serial write operations.
• struct hal::servo::position_t Feedback from setting the servo position.
• struct hal::servo::range_error Error information indicating the range of the servo.
• struct hal::soft::rc_servo::settings Information about the RC servo needed to control it properly.
• struct hal::spi::settings Generic settings for a standard SPI device.
• struct hal::spi::transfer_t Feedback from performing a transfer on the spi bus.
• struct hal::steady_clock::frequency_t Result from requesting the operating frequency of the steady clock.
• struct hal::steady_clock::uptime_t Result from calling uptime.
• struct hal::stm32f1::clock_tree
• struct hal::stm32f1::clock_tree::ahb_t Defines the configuration of the dividers beyond system clock mux.
• struct hal::stm32f1::clock_tree::ahb_t::apb1_t Maximum rate of 36 MHz.
• struct hal::stm32f1::clock_tree::ahb_t::apb2_t
• struct hal::stm32f1::clock_tree::ahb_t::apb2_t::adc_t
• struct hal::stm32f1::clock_tree::pll_t Defines the configuration of the PLL.
• struct hal::stm32f1::clock_tree::pll_t::usb_divider_t
• struct hal::stm32f1::clock_tree::rtc_t Defines the configuration for the RTC.
• struct hal::temperature_sensor::read_t Result from reading the temperature sensor.
• struct hal::timer::cancel_t Feedback from cancelling a timer.
• struct hal::timer::is_running_t Feedback after checking if the timer is running.
• struct hal::timer::out_of_bounds_error Error type indicating that the desired time delay is not achievable with this timer.
• struct hal::timer::schedule_t Feedback from scheduling a timer.
• struct hal::soft::rc_servo::ranges
• class std::false_type
  • struct hal::error::invalid_option_t Used for defining static_asserts that should always fail, but only if the static_assert line is hit via if constexpr control block. Prefer to NOT use this directly but to useinvalid_option instead.