A rust driver for the notecard?

gauteh · October 9, 2021, 4:19pm

Hi,

has there been any attempt at writing an API for Rust that works with embedded-hal I2C? I am currently working on my own driver.

Regards, Gaute

bsatrom · October 9, 2021, 11:31pm

Hi @gauteh thanks for posting, and welcome to the community, we’re glad you’re here! We’ve not tried our hands at a Rust API yet, but would love to see one! Please let us know how it goes, and share your progress here as I’m sure there are others in the community that would be interested in a Rust SDK.

gauteh · October 14, 2021, 4:55pm

Hi, here is the repository for the driver. Currently working on the I2C interface.

gauteh · October 15, 2021, 8:54am

I am de-serializing the JSON from card.time, and as specified I get an error before the notecard has available data. I am wondering where the schema for errors and the incomplete structs are (e.g. what are optional fields?).

github.com

gauteh/notecard-rs/blob/main/src/card.rs#L28

    
      
          
          
    /// Retrieves current date and time information. Upon power-up, the Notecard must complete a
              /// sync to Notehub in order to obtain time and location data. Before the time is obtained,
              /// this request will return `{"zone":"UTC,Unknown"}`.
              pub fn time(self) -> Result<FutureResponse<'a, TimeResponse, IOM>, NoteError> {
                  self.note.request(b"{\"req\":\"card.time\"}\n")?;
                  Ok(FutureResponse::<'a, TimeResponse, IOM>::from(self.note))
              }
          }
          
          
#[derive(Deserialize, defmt::Format)]
          pub struct TimeResponse {
              time: u32,
              area: heapless::String<20>,
              zone: heapless::String<20>,
              minutes: i32,
              lat: f32,
              lon: f32,
              country: heapless::String<10>
          }

So far this driver does not use any allocations.

gauteh · June 17, 2022, 6:38pm

I’ve just published v0.1.0 of the rust driver to crates.io: https://crates.io/crates/blues-notecard, typed requests and responses, no dynamic allocations (everything known upfront and on the stack), generic (and reconfigurable) buffer sizes, a wait / async-ish type API (you can do stuff while waiting for the response.

Set up with defmt ( deferred formatting ), so you don’t compile a bunch of formatting code, just the data when debugging the program.

It also contains a raw, untyped API, so you can deal with dynamic JSON objects if you want.

– gaute

esden · October 13, 2023, 9:11pm

Hi,

I am working on a rust embedded notecard project. Big thanks to @gauteh for publishing a rust crate for the notecard. I hope at some point Blues will make it a first class citizen in the provided notecard libraries, or contribute to @gauteh notecard-rs crate to make it support all types of communication and the full API.

Cheers,
Piotr

Topic		Replies	Views
Total noob looking for a simple python3 example Firmware python	24	1594	March 26, 2021
Reducing SEGMENT_DELAY: at the bandwidth limit, but capped by I2C comms Hardware	3	365	August 12, 2022
New Notecard Guide For End-To-End Encryption Notecard API encryption , security	6	757	October 9, 2021
Notecard Zephyr West Module Tools & SDKs	5	163	March 7, 2024
Notecard seemingly stuck and not responding meaningful over I2C Troubleshooting	4	682	February 17, 2022

A rust driver for the notecard?

Related Topics