Crate arduboy_rust

Expand description

This is the arduboy_rust crate To get started import the prelude to your project.

Import the module:

use arduboy_rust::prelude::*;

Inside the root directory is a file named import_config.h

You can disable C++ libraries in the import_config.h file. Just comment the unused library definition out.

Be careful with disabling libraries because:

The only error you get is something like this if you try to use a function that relies on the library you disabled.

game.90c69b91e57f285-cgu.0:(.text.loop+0x290): undefined reference to `sound_tone'

the benefit of disabling will be important in the feature when I add support for the ArduboyG library etc.

To get an idea, the ArduboyTones Library needs additional 2-3% of the flash memory.

Modules

arduboy2
This is the Module to interact in a save way with the Arduboy2 C++ library.
arduboy_tones
This is the Module to interact in a save way with the ArduboyTones C++ library.
arduboyfx
This is the Module to interact in a save way with the ArduboyFX C++ library.
arduino
This is the Module to interact in a save way with the Arduino C++ library.
ardvoice
This is the Module to interact in a save way with the ArdVoice C++ library.
c
Clib functions you can use on the Arduboy
hardware
This is the Module to interact in a save way with the Arduboy hardware.
heapless
static friendly data structures that don’t require dynamic memory allocation
prelude
This is the important one to use this library effective in your project
serial_print
This is the Module to interact in a save way with the Arduino Serial C++ library.
sprites
This is the module to interact in a save way with the Sprites C++ library.

f
This is the way to go if you want print some random text
get_ardvoice_tone_addr
Create a const raw pointer to a ardvoice tone as u8, without creating an intermediate reference.
get_sprite_addr
Create a const raw pointer to a sprite as u8, without creating an intermediate reference.
get_string_addr
Create a const raw pointer to a [u8;_] that saves text, without creating an intermediate reference.
get_tones_addr
Create a const raw pointer to a tone sequenze as u16, without creating an intermediate reference.
progmem
Create a space for Progmem variable

ArdVoice
This is the struct to interact in a save way with the ArdVoice C++ library.
Arduboy2
This is the struct to interact in a save way with the Arduboy2 C++ library.
ArduboyTones
This is the struct to interact in a save way with the ArduboyTones C++ library.
EEPROM
This is the struct to store and read structs objects to/from eeprom memory.
EEPROMBYTE
Use this struct to store and read single bytes to/from eeprom memory.