https://github.com/apgoetz/buslogger

Tracing embedded-hal busses
https://github.com/apgoetz/buslogger

embedded-hal embedded-rust rust

Last synced: 21 days ago
JSON representation

Tracing embedded-hal busses

• Host: GitHub
• URL: https://github.com/apgoetz/buslogger
• Owner: apgoetz
• License: mit
• Created: 2020-05-10T20:26:40.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-05-10T20:45:34.000Z (over 4 years ago)
• Last Synced: 2024-04-26T23:02:10.908Z (8 months ago)
• Topics: embedded-hal, embedded-rust, rust
• Language: Rust
• Homepage:
• Size: 1.95 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
buslogger

===========

[buslogger](https://github.com/apgoetz/buslogger) is a small helper

library

for [embedded-hal](https://github.com/rust-embedded/embedded-hal) rust

applications. It helps with debugging bus interfaces by logging each

read and write transaction to a separate logging device.

Currently, it only supports I2C busses, but support is planned for

other bus types.

buslogger works by moving in a struct that implements the i2c traits,

as well as a struct that implements the core::fmt::Write trait. It

then returns a new i2c struct that also implements the i2c traits, in

a similiar fashion to

the [shared_bus](https://github.com/Rahix/shared-bus) crate.

Example usage:

```rust

use buslogger::BusLogger;

let i2c = /* some struct that implements read / write / write_read traits */;

let serial = /* some struct that implements core::fmt::Write */;

let i2c = BusLogger::new(serial,i2c);

let mut buf : [u8 ; 1] = [0;1];

// use the i2c device like normal

i2c.write(0x42, &[0x40,0x80]).ok();

i2c.write_read(0x42, &[0x40], &mut buf).ok();

i2c.read(0x42, &mut buf).ok();

i2c.write_read(0x42, &[0x40], &mut buf).ok(); //assume this fails with error i2c::Error::Nack

```

Example output you would see on the trace

```

a[42] w[40, 80]

a[42] w[00] r[01]

a[42] r[00]

a[42] w[01] Nack

```