libhal API documentation

Welcome to libhal API documentation

Here you will find an organized list of the interfaces used in libhal. This includes soft drivers which are drivers that are not tied to specific hardware. This will also include utility functions.

libhal Docs

• Libhal Interfaces
  • Accelerometer
    • Hardware Interface
      • accelerometer
        • accelerometer::read()
        • accelerometer::read_t
  • Analog Digital Converter (ADC)
    • Hardware Interface
      • adc
        • adc::read()
  • Angular Velocity Sensor
    • Hardware Interface
      • angular_velocity_sensor
        • angular_velocity_sensor::read()
  • Controlled Area Network (CAN)
    • Hardware Interface
      • can
        • can::id_t
        • can::handler
        • can::configure()
        • can::bus_on()
        • can::send()
        • can::on_receive()
        • can::message_t
        • can::settings
    • Utilities
      • operator==()
      • calculate_can_bus_divider()
      • can_bus_divider_t
        • can_bus_divider_t::clock_divider
        • can_bus_divider_t::propagation_delay
        • can_bus_divider_t::phase_segment1
        • can_bus_divider_t::phase_segment2
        • can_bus_divider_t::synchronization_jump_width
        • can_bus_divider_t::total_tq
        • can_bus_divider_t::sync_segment
  • Digital Analog Converter (DAC)
    • Hardware Interface
      • dac
        • dac::write()
  • Distance Sensor
    • Hardware Interface
      • distance_sensor
        • distance_sensor::read()
  • Error
    • Documentation
      • safe_throw()
      • exception
        • exception::instance()
        • exception::error_code()
      • no_such_device
        • no_such_device::no_such_device()
      • io_error
        • io_error::io_error()
      • resource_unavailable_try_again
        • resource_unavailable_try_again::resource_unavailable_try_again()
      • timed_out
        • timed_out::timed_out()
      • operation_not_supported
        • operation_not_supported::operation_not_supported()
      • operation_not_permitted
      • argument_out_of_domain
      • message_size
      • not_connected
      • unknown
      • error
        • error::invalid_option
        • error::invalid_option_t
  • Functional
    • Documentation
  • Gyroscope
    • Hardware Interface
      • gyroscope
        • gyroscope::read()
        • gyroscope::read_t
  • Inter-integrated Circuit (I2C)
    • Hardware Interface
      • i2c
        • i2c::configure()
        • i2c::transaction()
        • i2c::transaction()
        • i2c::settings
    • Utilities
      • i2c_operation
        • i2c_operation::write
        • i2c_operation::read
      • write()
      • write()
      • read()
      • read()
      • read()
      • read()
      • write_then_read()
      • write_then_read()
      • write_then_read()
      • probe()
      • to_8_bit_address()
  • Input Pin
    • Hardware Interface
      • input_pin
        • input_pin::configure()
        • input_pin::level()
        • input_pin::settings
    • Utilities
  • Interrupt Pin
    • Hardware Interface
      • interrupt_pin
        • interrupt_pin::trigger_edge
        • interrupt_pin::handler
        • interrupt_pin::configure()
        • interrupt_pin::on_trigger()
        • interrupt_pin::settings
    • Utilities
  • Magnetometer
    • Hardware Interface
      • magnetometer
        • magnetometer::read()
        • magnetometer::read_t
  • Motor
    • Hardware Interface
      • motor
        • motor::power()
  • Output Pin
    • Hardware Interface
      • output_pin
        • output_pin::configure()
        • output_pin::level()
        • output_pin::level()
        • output_pin::settings
    • Utilities
  • Pulse Width Modulation (PWM)
    • Hardware Interface
      • pwm
        • pwm::frequency()
        • pwm::duty_cycle()
  • Rotational Sensor
    • Hardware Interface
      • rotation_sensor
        • rotation_sensor::read()
        • rotation_sensor::read_t
  • Serial
    • Hardware Interface
      • serial
        • serial::configure()
        • serial::write()
        • serial::read()
        • serial::flush()
        • serial::read_t
        • serial::settings
        • serial::write_t
    • Utilities
      • write_partial()
      • write()
      • write()
      • read()
      • read()
      • write_then_read()
      • write_then_read()
      • print()
      • print()
    • Coroutines
      • skip_past()
      • operator()()
      • read_into()
      • read_upto()
      • read_uint32()
      • skip_past
        • skip_past::skip_past()
        • skip_past::operator()()
      • read_into
        • read_into::read_into()
        • read_into::operator()()
      • read_upto
        • read_upto::read_upto()
        • read_upto::operator()()
      • read_uint32
        • read_uint32::read_uint32()
        • read_uint32::operator()()
        • read_uint32::get()
  • Servo
    • Hardware Interface
      • servo
        • servo::position()
  • Serial Peripheral Interface (SPI)
    • Hardware Interface
      • spi
        • spi::configure()
        • spi::transfer()
        • spi::default_filler
        • spi::settings
    • Utilities
      • operator==()
      • write()
      • read()
      • read()
      • write_then_read()
      • write_then_read()
  • Steady Clock
    • Hardware Interface
      • steady_clock
        • steady_clock::frequency()
        • steady_clock::uptime()
    • Utilities
      • future_deadline()
      • steady_clock_timeout()
      • steady_clock_timeout()
      • operator=()
      • steady_clock_timeout()
      • operator=()
      • operator()()
      • create_timeout()
      • delay()
      • timeout_generator()
      • steady_clock_timeout
        • steady_clock_timeout::steady_clock_timeout()
        • steady_clock_timeout::steady_clock_timeout()
        • steady_clock_timeout::operator=()
        • steady_clock_timeout::steady_clock_timeout()
        • steady_clock_timeout::operator=()
        • steady_clock_timeout::operator()()
  • Temperature Sensor
    • Hardware Interface
      • temperature_sensor
        • temperature_sensor::read()
  • Timeout
    • Core Functionality
      • timeout_function
      • work_function
      • work_state
        • work_state::in_progress
        • work_state::failed
        • work_state::finished
      • never_timeout()
    • Utilities
      • try_until()
      • try_until()
  • Timer
    • Hardware Interface
      • timer
        • timer::is_running()
        • timer::cancel()
        • timer::schedule()
  • Units
    • Core Functionality
      • hal
        • hal::time_duration
        • hal::byte
        • hal::u8
        • hal::u16
        • hal::u32
        • hal::u64
        • hal::i8
        • hal::i16
        • hal::i32
        • hal::i64
        • hal::hertz
        • hal::g_force
        • hal::ampere
        • hal::volts
        • hal::celsius
        • hal::rpm
        • hal::meters
        • hal::degrees
        • hal::gauss
        • hal::pin_resistor
        • hal::literals
    • Utilities
      • cycles_per()
      • wavelength()
      • duration_from_cycles()
      • operator<<()
• Soft Drivers
  • Inert Drivers
    • Inert Accelerometer
      • Inert Driver
        • inert_accelerometer
    • Inert ADC
      • Inert Driver
        • inert_adc
    • Inert DAC
      • inert_dac
        • inert_dac::inert_dac()
    • Inert Distance Sensor
      • inert_distance_sensor
        • inert_distance_sensor::inert_distance_sensor()
    • Inert Gyroscope
      • inert_gyroscope
        • inert_gyroscope::inert_gyroscope()
    • Inert Input Pin
      • inert_input_pin
        • inert_input_pin::inert_input_pin()
    • Inert Interrupt Pin
      • inert_interrupt_pin
        • inert_interrupt_pin::inert_interrupt_pin()
    • Inert Magnetometer
      • inert_magnetometer
        • inert_magnetometer::inert_magnetometer()
    • Inert Motor
      • inert_motor
        • inert_motor::inert_motor()
    • Inert Output Pin
      • inert_output_pin
        • inert_output_pin::inert_output_pin()
    • Inert PWM
      • inert_pwm
        • inert_pwm::inert_pwm()
    • Inert Rotation Sensor
      • inert_rotation_sensor
        • inert_rotation_sensor::inert_rotation_sensor()
    • Inert Steady Clock
      • inert_steady_clock
        • inert_steady_clock::inert_steady_clock()
    • Inert Temperature Sensor
      • inert_temperature_sensor
        • inert_temperature_sensor::inert_temperature_sensor()
    • Inert Timer
      • inert_timer
        • inert_timer::inert_timer()
  • ADC Multiplexer
    • Soft Driver
      • adc_multiplexer
        • adc_multiplexer::adc_multiplexer()
        • adc_multiplexer::read_channel()
        • adc_multiplexer::get_max_channel()
      • make_adc()
      • adc_mux_pin
  • I2C Minimum Speed
    • Soft Driver
      • minimum_speed_i2c
        • minimum_speed_i2c::minimum_speed_i2c()
  • Inverter
    • Soft Driver
      • output_pin_inverter
        • output_pin_inverter::output_pin_inverter()
      • input_pin_inverter
        • input_pin_inverter::input_pin_inverter()
  • Remote Controlled Servo (RC Servo)
    • Soft Driver
      • rc_servo
        • rc_servo::rc_servo()
        • rc_servo::settings
• Utilities
  • As Bytes
  • Bit
    • from()
    • from()
    • from()
    • origin()
    • value()
    • operator==()
    • bit_extract()
    • bit_extract()
    • byte_m
    • nibble_m
    • bit_mask
      • bit_mask::origin()
      • bit_mask::value()
      • bit_mask::operator==()
      • bit_mask::position
      • bit_mask::width
      • bit_mask::from()
      • bit_mask::from()
      • bit_mask::from()
    • byte_mask
    • nibble_mask
    • bit_value
      • bit_value::bit_value()
      • bit_value::set()
      • bit_value::set()
      • bit_value::clear()
      • bit_value::clear()
      • bit_value::toggle()
      • bit_value::toggle()
      • bit_value::insert()
      • bit_value::insert()
      • bit_value::insert()
      • bit_value::to()
      • bit_value::get()
      • bit_value::width
    • bit_modify
      • bit_modify::bit_modify()
      • bit_modify::~bit_modify()
  • Bit Limits
    • generate_field_of_ones()
    • max()
    • min()
    • bit_limits
      • bit_limits::max()
      • bit_limits::min()
  • Comparison
  • Enum
    • value()
  • Map
    • map()
  • Math
    • multiply()
    • absolute_value()
    • rounding_division()
    • distance()
    • equals()
  • Move Interceptor
    • intercept()
    • move_interceptor
  • Overflow Counter
    • update()
    • reset()
    • overflow_counter
      • overflow_counter::update()
      • overflow_counter::reset()
  • Static Callable
    • static_callable()
    • get_handler()
    • handler()
    • callback
    • static_callable
    • static_callable
      • static_callable::static_callable()
      • static_callable::get_handler()
  • Static List
    • push_back()
    • push_back()
    • push_back()
    • static_list
      • static_list::push_back()
      • static_list::push_back()
      • static_list::push_back()
      • static_list::item
      • static_list::item_iterator
  • Streams
    • stream_find()
    • stream_fill()
    • stream_fill()
    • stream_fill_upto()
    • stream_parse()
    • stream_skip()
    • stream_find
      • stream_find::stream_find()
    • stream_fill
      • stream_fill::stream_fill()
      • stream_fill::stream_fill()
    • stream_fill_upto
      • stream_fill_upto::stream_fill_upto()
    • stream_parse
      • stream_parse::stream_parse()
      • stream_parse::value()
    • stream_skip
      • stream_skip::stream_skip()
  • To Array
    • to_array()