Skip to content

Latest commit

 

History

History
22 lines (15 loc) · 1.36 KB

README.md

File metadata and controls

22 lines (15 loc) · 1.36 KB

TURAG-Feldbus

Simple yet feature-rich serial bus protocol for embedded devices.

This repository contains the reference implementation for bus devices.

The protocol specification can be found in the wiki.

Code reference: https://turag-ev.github.io/TURAG-Feldbus/modules.html

Currently, host implementations can be found within the Tina library.

The TURAG-Console makes use of the host implementations and allows it to communicate with bus devices through a serial port.

Usage

To enable your project to act as a TURAG-Feldbus device, you need

  • clone the repository or add it to your project as a git submodule
  • configure the contents of the directory TURAG-Feldbus/src/feldbus to be compiled into your project. C++ is required.
  • make the directory TURAG-Feldbus/src visible to the compiler as an include path
  • copy the file TURAG-Feldbus/src/feldbus/device/feldbus_config.h into to a different directory (e.g. next to your main.c file), remove the compiler error at the top of the file and adjust it to your needs
  • make sure the directory containing the new feldbus_config.h file is visible to the compiler as an include path.

Note for users of STM32CubeIDE: keep in mind that include paths are set separately for languages and configurations.