ethercat

Crates.ioethercat
lib.rsethercat
version0.3.1
sourcesrc
created_at2019-03-01 11:11:31.207518
updated_at2023-10-14 07:41:23.141983
descriptionBinding to the IgH/Etherlab open-source EtherCAT master
homepage
repositoryhttps://github.com/ethercat-rs/ethercat
max_upload_size
id117950
size83,389
Markus Kohlhase (flosse)

documentation

README

The ethercat crate

Apache 2.0 licensed MIT licensed crates.io docs

Documentation

About

The ethercat crate provides a Rust wrapper for the IgH/Etherlab EtherCAT Master for Linux.

EtherCAT is an Ethernet-based fieldbus system, originally invented by Beckhoff GmbH but now used by numerous providers of automation related hardware. The IgH master lets you provide an EtherCAT master on a Linux machine without specialized hardware.

Building

In order to build the raw wrapper crate ethercat-sys, you need to set the environment variable ETHERCAT_PATH to the location of a checkout of the IgH Etherlab repository, after running configure there.

The IgH repository is located at https://gitlab.com/etherlab.org/ethercat. Please switch to the stable-1.5 branch in the checkout.

Bindings have been pregenerated for revision c022ddbcf254 - if you activate the feature pregenerated-bindings, you don't need the master code to build, but the kernel modules must match that revision.

The minimum tested Rust version is 1.63.0.

Licensing

The Etherlab master provides Linux kernel modules under GPLv2 with an ioctl based interface, and a userspace library under LGPLv2.1. This crate does not use the userspace library (which is mostly a simple wrapper around the ioctls anyway) but rather communicates with the kernel modules through the raw ioctls.

Therefore, we believe that the crate does not need to be GPLv2-licensed, and are using the dual MIT/Apache-2 license commonly used for Rust crates.

Commit count: 113

cargo fmt