Skip to content
Arcade Coder Wiki

Rust API

Crate Documentation

Version: 0.1.0

Format Version: 45

Module arcadecoder_hw

Simple Rust library for working with the Tech Will Save Us Arcade Coder.

More projects, info and credits on Arcade Coder are available here, and hardware documentation is available here.

Currently the display and single button presses work.

Modules

Module font

Simple fonts for displaying numbers

Fonts are made up of an array of booleans representing on and off pixels.

pub mod font { /* ... */ }

Types

Type Alias Font

pub type Font<''a> = &''a [&''a [bool]];

Constants and Statics

Constant FONT_5X5_SIZE

pub const FONT_5X5_SIZE: (usize, usize) = _;

Static FONT_5X5

A basic 5x5 pixel font

pub static FONT_5X5: Font<''_> = _;

Types

Type Alias Coordinates

Display coordinates

pub type Coordinates = (usize, usize);

Type Alias Color

3-bit color

pub type Color = (bool, bool, bool);

Enum ButtonEvent

pub enum ButtonEvent {
    Pressed(u8, u8),
    Released(u8, u8),
}

Variants

Pressed

Fields:

IndexTypeDocumentation
0u8
1u8
Released

Fields:

IndexTypeDocumentation
0u8
1u8

Implementations

Trait Implementations

  • Freeze

  • Debug

    • fn fmt(self: &Self, f: &mut $crate::fmt::Formatter<''_>) -> $crate::fmt::Result { /* ... */ }

  • Clone

    • fn clone(self: &Self) -> ButtonEvent { /* ... */ }

  • Any

    • fn type_id(self: &Self) -> TypeId { /* ... */ }

  • TryFrom

    • fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> { /* ... */ }

  • TryInto

    • fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error> { /* ... */ }

  • Sync

  • Unpin

  • BorrowMut

    • fn borrow_mut(self: &mut Self) -> &mut T { /* ... */ }

  • From

    • fn from(t: T) -> T { /* ... */ }
      Returns the argument unchanged.

  • Copy

  • Into

    • fn into(self: Self) -> U { /* ... */ }
      Calls U::from(self).

  • RefUnwindSafe

  • Borrow

    • fn borrow(self: &Self) -> &T { /* ... */ }

  • Send

  • UnwindSafe

  • CloneToUninit

    • unsafe fn clone_to_uninit(self: &Self, dest: *mut u8) { /* ... */ }

  • Same

Struct ArcadeCoder

pub struct ArcadeCoder<''a> {
    pub channel_select_delay: embassy_time::Duration,
    pub latch_delay: embassy_time::Duration,
    pub display_buffer: [[u8; 9]; 6],
    pub button_presses: [[bool; 12]; 12],
    pub channel_on_time: embassy_time::Duration,
    pub debounce_reads: u8,
    // Some fields omitted
}

Fields

NameTypeDocumentation
channel_select_delayembassy_time::DurationThe time to wait after switching channels for inputs to settle.
latch_delayembassy_time::DurationThe time to wait after latching.
display_buffer[[u8; 9]; 6]The current display buffer.
button_presses[[bool; 12]; 12]A matrix of button presses corresponding to the physical layout.
channel_on_timeembassy_time::DurationThe time to wait after displaying a row on the display.
debounce_readsu8The number of reads required for a button press to register.
private fields…Some fields have been omitted

Implementations

Methods
  • pub fn new</* synthetic */ impl OutputPin + 'a: OutputPin + ''a, /* synthetic */ impl OutputPin + 'a: OutputPin + ''a, /* synthetic */ impl OutputPin + 'a: OutputPin + ''a, /* synthetic */ impl OutputPin + 'a: OutputPin + ''a, /* synthetic */ impl OutputPin + 'a: OutputPin + ''a, /* synthetic */ impl OutputPin + 'a: OutputPin + ''a, /* synthetic */ impl OutputPin + 'a: OutputPin + ''a, /* synthetic */ impl InputPin + 'a: InputPin + ''a, /* synthetic */ impl InputPin + 'a: InputPin + ''a, /* synthetic */ impl InputPin + 'a: InputPin + ''a, /* synthetic */ impl InputPin + 'a: InputPin + ''a, /* synthetic */ impl InputPin + 'a: InputPin + ''a, /* synthetic */ impl InputPin + 'a: InputPin + ''a>(spi_bus: SPI2<''a>, pin_a0: impl OutputPin + ''a, pin_a1: impl OutputPin + ''a, pin_a2: impl OutputPin + ''a, pin_oe: impl OutputPin + ''a, pin_latch: impl OutputPin + ''a, pin_data: impl OutputPin + ''a, pin_clock: impl OutputPin + ''a, inputs_1_7: impl InputPin + ''a, inputs_2_8: impl InputPin + ''a, inputs_3_9: impl InputPin + ''a, inputs_4_10: impl InputPin + ''a, inputs_5_11: impl InputPin + ''a, inputs_6_12: impl InputPin + ''a) -> Self { /* ... */ }

    Create a new instance of the Arcade Coder.

  • pub fn clear(self: &mut Self) { /* ... */ }

    Clear the display buffer to make the screen blank.

  • pub fn set_pixel(self: &mut Self, pos: Coordinates, color: Color) { /* ... */ }

    Set a pixel to a color

  • pub fn draw_rect(self: &mut Self, pos1: Coordinates, pos2: Coordinates, color: Color) { /* ... */ }
  • pub fn draw_digit(self: &mut Self, n: u32, font: &[&[bool]], font_size: (usize, usize), start_pos: Coordinates, color: Color) { /* ... */ }

    Draw a digit from a font

  • pub fn draw_char(self: &mut Self, character: char, font: &[&[bool]], font_size: (usize, usize), start_pos: Coordinates, color: Color) { /* ... */ }

    Draw a character from a font

  • pub fn handle_input_events<F>(self: &mut Self, handler: F)

where F: FnMut(ButtonEvent) { /* … */ }

Handle button press events. This takes care of debouncing inputs and returns an event for button presses and releases.


- ```rust
pub fn handle_input_events_to_channel<const N: usize>(self: &mut Self, ch: &embassy_sync::channel::Channel<embassy_sync::blocking_mutex::raw::NoopRawMutex, ButtonEvent, N>) { /* ... */ }

Handle button press events. This takes care of debouncing inputs and returns an event for button presses and releases.

  • pub async fn scan(self: &mut Self) { /* ... */ }
    Update the display while also scanning for button inputs.
Trait Implementations

  • RefUnwindSafe

  • Into

    • fn into(self: Self) -> U { /* ... */ }
      Calls U::from(self).

  • UnwindSafe

  • TryInto

    • fn try_into(self: Self) -> Result<U, <U as TryFrom<T>>::Error> { /* ... */ }

  • Borrow

    • fn borrow(self: &Self) -> &T { /* ... */ }

  • Unpin

  • BorrowMut

    • fn borrow_mut(self: &mut Self) -> &mut T { /* ... */ }

  • Freeze

  • Send

  • From

    • fn from(t: T) -> T { /* ... */ }
      Returns the argument unchanged.

  • TryFrom

    • fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error> { /* ... */ }

  • Any

    • fn type_id(self: &Self) -> TypeId { /* ... */ }

  • Same

  • Sync

Constants and Statics

Constant WHITE

pub const WHITE: Color = _;

Constant YELLOW

pub const YELLOW: Color = _;

Constant CYAN

pub const CYAN: Color = _;

Constant RED

pub const RED: Color = _;

Constant MAGENTA

pub const MAGENTA: Color = _;

Constant GREEN

pub const GREEN: Color = _;

Constant BLUE

pub const BLUE: Color = _;

Constant BLACK

pub const BLACK: Color = _;