Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/idletea/tokio-socketcan

Asynchronous Linux SocketCAN sockets with tokio
https://github.com/idletea/tokio-socketcan

Last synced: about 2 months ago
JSON representation

Asynchronous Linux SocketCAN sockets with tokio

Awesome Lists containing this project

README 

        
[![crates.io badge](https://img.shields.io/crates/v/tokio-socketcan.svg)](https://crates.io/crates/tokio-socketcan) [![documentation](https://img.shields.io/badge/documentation-docs.rs-green.svg)](https://docs.rs/tokio-socketcan)

[![Continuous integration](https://github.com/oefd/tokio-socketcan/actions/workflows/ci.yml/badge.svg)](https://github.com/oefd/tokio-socketcan/actions/workflows/ci.yml)



# tokio-socketcan



[SocketCAN](https://www.kernel.org/doc/Documentation/networking/can.txt) support for [tokio](https://tokio.rs/) based on the [socketcan crate](https://crates.io/crates/socketcan).



# Example  echo server



```rust

use futures_util::stream::StreamExt;

use tokio_socketcan::{CANSocket, Error};



#[tokio::main]

async fn main() -> Result<(), Error> {

    let mut socket_rx = CANSocket::open("vcan0")?;

    let socket_tx = CANSocket::open("vcan0")?;

    while let Some(Ok(frame)) = socket_rx.next().await {

        socket_tx.write_frame(frame)?.await?;

    }

    Ok(())

}

```



# Testing



Integrating the test into a CI system is non-trivial as it relies on a `vcan0` virtual can device existing. Adding one to most linux systems is pretty easy with root access but attaching a vcan device to a container for CI seems difficult to find support for.



To run the tests locally, though, setup should be simple:



```sh

sudo modprobe vcan

sudo ip link add vcan0 type vcan

sudo ip link set vcan0 up

cargo test

```