codal-core

Core APIs provided by CODAL as a base hardware abstraction layer. Contains useful utility classes for creating device-specific libraries.

Version: a322592
Namespace: codal::*
Repository: lancaster-university/codal-core

Classes

    Accelerometer

    CODAL’s accelerometer abstraction class. Allows for reading of the micro:bit’s built in accelerometer data, as well as the configuration of the sample rate and range.

    Button

    Represents a single hardware button. Allows for button press event tracking.

    Compass

    A compass abstraction. Reads the magnetometer to determine the orientation of the device, applying tilt compensation from data provided by the accelerometer.

    CoordinateSpace

    Representation of a coordinate space, for easy transformations in 3D space related abstractions.

    KeyValueStorage

    A simple key-value storage medium implemented with flash as the backing store. Utilises an in-memory scratch buffer.

    LEDMatrix

    A software representation of an LED matrix, also used to represent the micro:bit’s LED display.

    ManagedBuffer

    A mutable reference counted byte buffer, for general purpose use.

    ManagedString

    A copy assignable, immutable string class implemented using basic reference counting.

    MessageBus

    A lightweight message bus implementation, with asynchronous event handling using the fiber scheduler.

    MultiButton

    Represents a multi-button group, which can then be detected as a single press event.

    NVMController

    A generic interface to represent non volatile memory controllers.

    Pin

    Abstraction for a simple generic pin, with ability for handling both digital and analogue I/O.

    Sample3D

    A three dimensional vector representing sample data retrieved from a 3D abstraction.

    Timer

    A low level timer abstraction, adding integration with the CODAL message bus event system.

    TouchButton

    Represents a button triggered by capacitive touch. Can be hooked for press events.

    License & Attribution

    Licensing and attribution information for the ‘codal-core’ documentation.