Open source

Open source

Every crate and repository, from register to GUI: what it does, a code sample and where to read more.

1. ProductsDonguru · rePort · CAN line · IOWeaver · RockFace
2. API
   

   wire_weaver

   v0.4.0 · 866 downloads

   API description language and code generator: RPC, streams and properties, backwards and forwards compatible, no_std and no alloc.

   Source · Docs · docs.rs

   #[ww_trait]
   #[claim(exclusive)]
   pub trait Uart {
       #[counted]
       stream!(rx: RxChunk<'i>);
   
       #[credit]
       sink!(tx: MaxLen<RefVec<'i, u8>,
                        UART_TX_MAX>);
   
       fn capabilities() -> Capabilities<'i>;
   }

3. Wire format
   

   shrink_wrap

   v0.1.2 · 1,700 downloads

   Compact zero-copy wire format for microcontrollers. No allocator, dynamic types, packed down to the bit.

   Source · docs.rs

   // 1 + 7 or 1 + 10 bits
   #[derive_shrink_wrap(ww_repr = u1)]
   enum I2cAddress { Seven(U7), Ten(U10) }
   
   #[derive_shrink_wrap]
   struct I2cWrite<'i> {
       // 0x50: 0 1010000
       addr: I2cAddress,
       stop: bool,            // 1 bit
       fast: bool,            // 1 bit
       retries: Nibble,       // 3: 0011
       // Some(500): 1 0111110100
       timeout_ms: Option<U10>,
       data: RefVec<'i, u8>,  // ab cd
   }
   // 50 83 be 80 ab cd 02: 7 bytes, the
   // count (02) at the back. repr(C): 20.

4. Units
   

   exact_units

   not on crates.io yet

   Units of measure checked at compile time, with exact scales. The same bytes as the plain integer, no_std and no alloc.

   Source · Docs

   // exact or refused, never rounded
   let t: Micros<u32> = Fixed::new(1500);
   assert_eq!(t.to::<Milli, u16>(), None);
   // 1500 µs is not a whole number of ms
   
   // V/V and W/W are different kinds,
   // and the kind picks the dB formula
   type V = Per<Volt, Volt>;
   type W = Per<Watt, Watt>;
   Fixed::<V, One, f64>::new(2.0).to_db();
   // 6.0206 dB: 20·lg 2
   Fixed::<W, One, f64>::new(2.0).to_db();
   // 3.0103 dB: 10·lg 2
   
   // a threshold in dB: an integer, exact,
   // 501 mV/V but 251 mW/W
   let v: Fixed<V, Milli, u16> = db!(-6);
   let p: Fixed<W, Milli, u16> = db!(-6);
   
   // 0.5 duty is not -3 dB: a Ratio has no dB
   // Fixed::<Ratio, One, f64>::new(0.5)
   //     .to_db();
   // error[E0080]: decibels are for W/W or
   // V/V, A/A, Pa/Pa: a plain Ratio has no
   // level form

5. Firmware

   embedded_bedrock

   not on crates.io yet

   Bare-metal firmware template with ruggedizing, debugging and logging built in. Optional embassy, RTIC and HAL support.

   Source

   use bedrock_led::code::*;
   use bedrock_sync::{Config, Sync};
   use cortex_m::asm::delay;
   
   // A firmware that will not start
   // says why on its status LED, then
   // waits in the ROM bootloader.
   if !guard.runs_board() {
       let pause = |n| delay(n * KHZ);
       blink(Code::UnknownRework,
             led, pause);
       reboot_into_rom_bootloader();
   }
   
   // One clock on all boards, steered
   // by the host over WireWeaver:
   // Acquiring, Locked within 2 ms.
   // `ww sync` locks the boards in
   // 1.2-1.6 s. On Donguru it costs
   // about 1.5 KB of flash.
   static SYNC: Sync =
       Sync::new(Config::DEFAULT);
   
   // clock.steer, once a second
   let r = SYNC.with(|clock, now| {
       server.steer(clock, now, &p)
   });
   
   // all boards act at the same µs
   SYNC.wait_until_shared(t).await?;

6. Firmware

   cnt

   v0.5.1 · 261 downloads

   When logging is not an option, count: events and errors in a RAM array, safe in any interrupt, without a critical section. Read over the debug probe with `cnt read` or `cnt tui`.

   Source · docs.rs

   // one RAM counter per call site,
   // no critical section, safe in an IRQ
   fn high_frequency_irq() {
       let r = do_something();
       cnt::cnt_if!(r.is_err(),
                    unpack_errors: u64);
   }
   
   fn process_packet() {
       cnt::cnt!(packet_count: u32);
   }
   
   // on the PC, over the debug probe:
   // $ cnt tui --chip STM32H533RE

7. Firmware

   canzone work in progress

   renamed from mcan, not on crates.io yet

   Stand-alone Rust driver for the Bosch M_CAN controller, aimed at STM32 G0, G4, H5, H7 and L5. Goals: no panics, no blocking waits without a timeout, optional async.

   Source

   let mut can =
       unwrap!(can.into_config_mode());
   can.set_nominal_bit_timing(unwrap!(
       NominalBitTiming::new(1, 55, 8, 1)
   ));
   unwrap!(can.set_layout(layout_fdcan1));
   can.set_automatic_bus_off_recovery(true);
   let mut can = unwrap!(can.into_normal());
   
   let id = unwrap!(StandardId::new(0x123));
   can.write_tx_buffer_pend(
       tx_buffers.idx1,
       TxFrameHeader::fd_brs(Id::Standard(id)),
       &[0xAA, 0xBB, 0xCC],
   );

8. Test bench

   choreograph

   not on crates.io yet

   Plans and runs jobs over shared instruments and resources, with priorities and deadlines. Says why each waiting job waits.

   Source

   [[resource]]
   name = "supply"
   kind = "supply"
   states = ["off", "3V0", "3V3", "3V6"]
   safe = "off"
   
   [[job]]
   name = "a-3V3"
   needs = [
     { kind = "probe", state = "fw-a" },
     { kind = "supply", state = "3V3" },
   ]
   run = "10s"

9. GUI

   egui_tabular

   v0.2.0 · 42 downloads

   Fast table viewer and editor that only draws the visible rows. Data from vectors, files, databases or live bus traces.

   Source · docs.rs

   let mut table = VariantTable::new([
       ColumnDef::new("Name", VariantTy::Str),
   ]);
   let opts = TableViewOptions::default();
   let mut view = TableView::new(opts);
   let mut config = TableViewConfig::default();
   
   // Every frame:
   let output = view.show(
       ui,
       &mut table,
       &mut VariantCellUi,
       &mut config,
   );

10. GUI

    vhrd_egui

    not on crates.io yet

    egui building blocks: the widget frame every panel sits in, a dock that moves widgets between windows, an HDR phosphor scope.

    Source

    // min, nom and wide sizes, and a tall form
    let hints = SizeHints::new(
        [90.0, 30.0],
        [200.0, 80.0],
        [360.0, 80.0],
    )
    .tall(200.0);
    WidgetFrame::new("log")
        .sizes(hints)
        .show_area(ui, &mut state, |ui, area| {
            let rows = match area.height {
                Height::Min => 1,
                Height::Nom => 5,
                Height::Tall => 15,
            };
        });