4 releases (2 breaking)
new 0.4.0 | Nov 15, 2024 |
---|---|
0.2.0 | May 9, 2024 |
0.1.1 | Dec 28, 2023 |
0.1.0 | Dec 28, 2023 |
#21 in Robotics
270KB
5.5K
SLoC
A PROFIBUS-DP compatible communication stack written in Rust.
What's this?
profirust is a pure-Rust PROFIBUS-DP compatible communication stack. PROFIBUS is an industrial bus protocol used to communicate with field devices like remote I/O, transducers, valves, drives, etc.
If you want to learn more, I suggest reading my blog posts about profirust or my PROFIBUS Primer.
Project Status
profirust works well for the features it currently supports, however it has not proven itself in a real application yet. There are still some features missing which are needed for production use. Check the roadmap below.
At this time, profirust is developed as a spare time project. If you are interested in this project, help is gladly accepted in the following forms:
- Code Contributions
- Donation of PROFIBUS peripherals or other equipment for testing purposes
- Funding of access to the needed IEC standards for improving compliance
- Reporting any kinds of issues encountered while using profirust
Supported Hardware
profirust is designed to have as little hardware dependency as possible.
All you need is a UART interface with an RS-485 transceiver. You can then
write a matching implementation of ProfibusPhy
. It is encouraged to submit
such implementations for inclusion in profirust.
At the moment, the following implementations are available:
LinuxRs485Phy
: Implementation for non-realtime Linux UART devicesRp2040Phy
: Implementation for RP2040 microcontrollers- Planned: Generic implementation for
embedded-hal
-supported microcontrollers
Roadmap
- Single-master bus up to 6 Mbit/s
- Cyclic communication with DP-V0 peripherals
- Basic Diagnostics
- Extended Diagnostics (DP-V0)
- Multi-master bus
- Bus error tracking
- Bus discovery utilities
- Reliable communication at 12 Mbit/s
- Communication with DP-V1 peripherals
- Equidistant bus cycle
- Isochronous bus cycle
Getting Started
This is a short guide for getting communication up and running with your PROFIBUS peripheral:
- Find the GSD (generic station description) file for your peripheral. Usually, the manufacturer offers these for download somewhere.
- Run the
gsdtool
to set up the configuration and parameterization of your peripheral:
The configuration wizard will walk you through all the settings you need to make. At this stage, you also need to setup the modules of your peripheral. The wizard will then give you Rust code for configuring the peripheral options to your selected values.cargo run -p gsdtool -- config-wizard path/to/peripheral.gsd
- Modify an example for your peripheral. Update the peripheral address. Then
paste the
PeripheralOptions
block and I/O buffers thatgsdtool
emitted. - Run the example, ideally with
RUST_LOG=trace
to see bus communication. Hopefully, you should now be able to establish cyclic communication with your peripheral.
License
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Contribution
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
Dependencies
~1–2.4MB
~53K SLoC