"Extra" Tock Capsules

This crate contains miscellaneous capsules which do not fit into any other, more specific category, and which do not require any external (non-vendored and unvetted) dependencies.

For more information on capsules, see the top-level README.

The remainder of this document contains a list of capsules in this crate, along with a short description.

Sensor and other IC Drivers

These implement a driver to setup and read various physical sensors.

• ADC Microphone: Single ADC pin microphone.
• Analog Sensors: Single ADC pin sensors.
• APDS9960: Proximity sensor.
• ATECC508A: Cryptographic Co-Processor Breakout.
• BME280: Humidity and air pressure sensor.
• BMM150: Geomagnetic sensor.
• BMP280: Temperature (and air pressure) sensor.
• CCS811: VOC gas sensor.
• Chirp I2C Moisture: I2C moisture sensor from Chirp project.
• DFRobot Rainfall Sensor: Rainfall sensor.
• FXOS8700CQ: Accelerometer and magnetometer.
• HS3003: Temperature and humidity sensor.
• HTS221: Temperature and humidity sensor.
• ISL29035: Light sensor.
• L3GD20: MEMS 3 axys digital gyroscope and temperature sensor.
• LSM303xx Support: Shared files.
  • LSM303AGR: 3D accelerometer and 3D magnetometer sensor.
  • LSM303DLHC: 3D accelerometer and 3D magnetometer sensor.
• LSM6DSOXTR: 3D accelerometer and 3D magnetometer sensor.
• LPS22HB: Pressure sensor.
• LPS25HB: Pressure sensor.
• MLX90614: Infrared temperature sensor.
• RP2040 Temperature: Analog RP2040 temperature sensor.
• SHT3x: Temperature and humidity sensor.
• SHT4x: Temperature and humidity sensor.
• SI7021: Temperature and humidity sensor.
• SK68XX: Tri-color, single-wire LED.
• STM32 Temperature: Analog STM32 temperature sensor.
• TSL2561: Light sensor.
• HC-SR04: Ultrasonic distance sensor

These drivers provide support for various ICs.

• AT24C32/64: EEPROM chip.
• FM25CL: FRAM chip.
• FT6x06: FT6x06 touch panel.
• HD44780 LCD: HD44780 LCD screen.
• LPM013M126: LPM013M126 LCD screen.
• LTC294X: LTC294X series of coulomb counters.
• MAX17205: Battery fuel gauge.
• MCP230xx: I2C GPIO extender.
• MX25r6435F: SPI flash chip.
• PCA9544A: Multiple port I2C selector.
• SD Card: Support for SD cards.
• Seven Segment Display: Seven segment displays.
• SH1106: SH1106 OLED screen driver.
• SSD1306: SSD1306 OLED screen driver.
• ST77xx: ST77xx IPS screen.

Wireless and Networking

Support for wireless radios, network stacks and related infrastructure.

• nRF51822 Serialization: Kernel support for using the nRF51 serialization library.
• RF233: Driver for RF233 radio.
• BLE Advertising: Driver for sending BLE advertisements.
• [LoRa Phy]: Support for exposing Semtech devices to userspace See the lora_things_plus board for an example
• Ethernet Tap Driver: Forwarding raw IEEE 802.3 Ethernet frames from / to userspace. Useful for running network stacks in userspace.
• WiFi Driver: Support for WiFi devices.
• CYW4343x Driver: Support for Infineon CYW4343x WiFi chips.

Libraries

Protocol stacks and other libraries.

• IEEE 802.15.4: 802.15.4 networking.
• Networking: Networking stack.
• USB: USB 2.0.
• Symmetric Cryptography: Symmetric encryption.
• Public Key Cryptography: Asymmetric encryption.

MCU Peripherals for Userspace

These capsules provide a Driver interface for common MCU peripherals.

• Analog Comparator: Voltage comparison.
• CRC: CRC calculation.
• DAC: Digital to analog conversion.
• CAN: CAN communication.

Helpful Userspace Capsules

These provide common and better abstractions for userspace.

• Air Quality: Query air quality sensors.
• Ambient Light: Query light sensors.
• App Flash: Allow applications to write their own flash.
• App Loader: Allow applications to request to install and load new applications.
• Buzzer: Simple buzzer.
• Servo: Servo motor.
• Date-Time: Real time clock date/time support.
• EUI64: Query device's extended unique ID.
• HMAC: Hash-based Message Authentication Code support.
• Humidity: Query humidity sensors.
• Key-Value Store: Store key-value data.
• LED Matrix: Control a 2D array of LEDs.
• Moisture: Query moisture sensors.
• Pressure: Pressure sensors.
• Proximity: Proximity sensors.
• PWM: Pulse-width modulation support.
• Rainfall: Query rainfall sensors.
• Read Only State: Read-only state sharing.
• Screen: Displays and screens.
• Screen Shared: App-specific screen windows.
• SHA: SHA hashes.
• Sound Pressure: Query sound pressure levels.
• Temperature: Query temperature sensors.
• Text Screen: Text-based displays.
• Touch: User touch panels.
• Distance: Distance sensor.

Virtualized Sensor Capsules for Userspace

These provide virtualized (i.e. multiple applications can use them simultaneously) support for generic sensor interfaces.

• Asynchronous GPIO: GPIO pins accessed by split-phase calls.
• 9DOF: 9DOF sensors (acceleration, magnetometer, gyroscope).
• Nonvolatile Storage: Persistent storage for userspace.
• Isolated Nonvolatile Storage: Per-app isolated persistent storage for userspace.

Utility Capsules

Other capsules that implement reusable logic.

• Bus Adapters: Generic abstraction for SPI/I2C/8080.
• Button Keyboard: Convert keyboard key presses into button presses.
• Buzzer PWM: Buzzer with a PWM pin.
• SG90 PWM: SG90 servomotor.
• HMAC-SHA256: HMAC using SHA-256.
• Key-Value Store with Permissions: Key-value interface that requires read/write permissions.
• Log Storage: Log storage abstraction on flash devices.
• Nonvolatile to Pages: Map arbitrary reads and writes to flash pages.
• Screen Adapters: Adapters to convert pixel formats for implementations of the Screen HIL, such as ScreenARGB8888ToMono8BitPage.
• Screen On Led: Draw fake LEDs on the screen.
• SHA256: SHA256 software hash.
• SignatureVerifyInMemoryKeys: Signature verification with multiple in-memory keys.
• SipHash: SipHash software hash.
• TicKV: Key-value storage.
• TicKV KV Store: Provide hil::kv::KV with TickV.
• Virtual KV: Virtualize access to KV with permissions.
• Virtual Screen Split: Virtualize access to the screen by splitting into sections.

Debugging Capsules

These are selectively included on a board to help with testing and debugging various elements of Tock.

• Cycle Counter: Start, stop, reset, and read a hardware cycle counter from userspace.
• Debug Process Restart: Force all processes to enter a fault state when a button is pressed.
• Panic Button: Use a button to force a panic!().
• Process Info: Inspect and control processes.