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

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

Last synced: about 1 month ago
JSON representation

Asynchronous Linux SocketCAN sockets with tokio

• Host: GitHub
• URL: https://github.com/idletea/tokio-socketcan
• Owner: idletea
• Created: 2019-01-10T17:12:41.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-05-09T23:46:52.000Z (about 1 year ago)
• Last Synced: 2024-03-27T06:10:10.013Z (2 months ago)
• Language: Rust
• Size: 30.3 KB
• Stars: 34
• Watchers: 6
• Forks: 16
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Lists

• awesome-rust - idletea/tokio-socketcan - socketcan](https://crates.io/crates/tokio-socketcan)] — Linux SocketCAN support for tokio based on the socketcan crate (Libraries / Automotive)

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

```