Skip to content

Commit

Permalink
updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
robert-burger committed Feb 7, 2024
1 parent 5382dd0 commit bda881f
Showing 1 changed file with 28 additions and 6 deletions.
34 changes: 28 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,16 +30,38 @@ Hülshorstweg 20, D-33415 Verl, Germany (www.beckhoff.com) or the
EtherCAT Technology Group, Ostendstraße 196, D-90482 Nuremberg,
Germany (ETG, www.ethercat.org).

# Tools
Tools
## Usage

See INTRODUCTION.md or gh-pages for reference.

## Build from source

`libethercat` uses autotools as build system.

### Prerequisites

Ensure that `libosal` is installed in your system. You can get `libosal` from here https://github.com/robert-wm/libosal.git . To build `libethercat` from source execute something like:

```
git clone https://github.com/robert-wm/libethercat.git
cd libethercat
autoreconf -is
./configure
make
sudo make install
```

This will build and install a static as well as a dynamic library. For use in other project you can you the generated pkg-config file to retreave cflags and linker flags.

## Tools

libethercat also provides some small helper programs for the EtherCAT bus.

## eepromtool
### eepromtool

With eepromtool you can read and write EtherCAT slave's eeprom.

### read eeprom
#### read eeprom

To do a read operation simply run:

Expand All @@ -49,7 +71,7 @@ If no filename if specified, eepromtool will print the contents to stdout, which

eepromtool -i eth1 -s 0 -r | hexdump -v -C | less -S

### write
#### write

To do a write operation simply run:

Expand All @@ -59,7 +81,7 @@ If no filename if specified, eepromtool will read from stdin.

cat eeprom.bin | eepromtool -i eth1 -s 0 -w

### example_with_dc
#### example_with_dc

This is a more complex example on how to use libethercat in realtime/control systems.

Expand Down

0 comments on commit bda881f

Please sign in to comment.