Crate riot_wrappers

Safe and idiomatic Rust wrappers for RIOT-OS

See RIOT’s documentation on using Rust for a general introduction to Rust on RIOT, this crate’s README file on general concepts (such as the interaction between modules here, RIOT modules and features), and the individual modules’ documentation entries for details.

Re-exports

• pub use riot_sys;
• pub use cstr;

Modules

• adc
• auto_init
  Tools for declaring a function that is run during initialization
• bluetil
  Bluetil tools for BLE Advertising Data (AD)
• coap_handler
• coap_message
• error
  Common error handling components for the RIOT operating system
• gcoap
• gnrc
• gnrc_util
  Experimental area for GNRC utility functions
• gpio
  Access to RIOT’s GPIO pins
• i2c
  Controlling the I²C bus
• interrupt
  Interaction with interrupts
• led
  Wrappers for the LEDn_{ON,OFF,TOGGLE} macros
• main
  Tools for providing a RIOT main function
• msg
  Access to messages by explicit type indication
• mutex
  Data-carrying mutex built using RIOT’s mutex module
• nimble
• saul
  Registration and use of SAUL, the Sensor Actuator Uber Layer
• shell
  Tools for running RIOT’s built-in shell
• socket
• socket_embedded_nal
  An implementation of the embedded_nal (Network Abstradtion Layer) UDP traits based on RIOT sockets
• socket_embedded_nal_tcp
  An implementation of the embedded_nal (Network Abstradtion Layer) TCP traits based on RIOT sockets
• spi
• stdio
  Wrappers for the stdio
• thread
  Create, inspect or modify RIOT processes (“threads”)
• vfs
  Access to the Virtual File System (VFS) layer
• ztimer
  ztimer high level timer

Macros

• auto_init
  Run the function $func during auto initialization, with the priority giving the position in the initialization sequence.
• dbg
• interruptDeprecated
  Wrap a Rust interrupt handler in an extern “C” wrapper that does the post-return cleaups.
• println
• riot_main
  To have a nice Rust main function, run the riot_main! macro with the name of your main function an item (ie. top level in a module) in your crate. The function identified by it must return something that implements the Termination trait.
• riot_main_with_tokensDeprecated
• static_command
  Make a function whose signature is fn(&mut Stdio, Args<'b>) -> impl Termination available through XFA in any RIOT shell, even when called throuch C. (The function’s signature may be more generic, eg. accepting an impl Write and an impl IntoIterator<&str>).

Functions

• board
  Name of the RIOT board that is being used