PySOEM is a Cython wrapper for the Simple Open EtherCAT Master Library (https://github.com/OpenEtherCATsociety/SOEM).
PySOEM enables basic system testing of EtherCAT slave devices with Python.
Features
- input process data read and output process data write
- SDO read and write
- EEPROM read and write
- FoE read and write
Todo
- EoE
Beware that real-time applications need some special considerations.
- Python 3
- GCC (installed on your machine)
- Python scripts that use PySOEM must be executed under administrator privileges
[*] | Make sure you check "Install Npcap in WinPcap API-compatible Mode" during the install |
python -m pip install pysoem
or
pip install pysoem
Consider using a virtualenv.
Although there are some pieces missing, the documentation is hosted on "Read the Docs" at: pysoem.readthedocs.io.
Please also have a look at the examples on GitHub.
Any contributions are welcome and highly appreciated. Let's discuss any (major) API change, or large piles of new code first. Using this pysoem chat room on gitter is one communication channel option.
- Changed the data type for the
name
attribute of SDO info CdefCoeObject and CdefCoeObjectEntry, they are of type bytes now instead of a regular Python 3 string. - Also changed the
desc
attribute of thefind_adapters()
list elements tobytes
. - Introduces the
open()
context manager function. - Adds the
setup_func
that will maybe later replace theconfig_func
.
- Version bump only to re-upload to PyPI with windows-wheel for Python 3.11
- Fix issues with timeouts at
amend_mbx
andset_watchdog
.
- Introduces
amend_mbx
andset_watchdog
, though this is rather experimental - New example
firmware_update.py
.
- Introduces the
manual_state_change
property
- Proper logging
- Introduces
mbx_receive
- Fix the FoE password issue
- Licence change to MIT licence
- Introduces configurable timeouts for SDO read and SDO write
- Improved API docs
- API change: remove the size parameter for
foe_write
- Introduces overlap map support
- No Cython required to install the package from the source distribution
- Introduces FoE
- Update of the underlying SOEM
- Fixes bug when Ibytes = 0 and Ibits > 0
- Exposes ec_DCtime (
dc_time
) for DC synchronization
- Improvement on SDO Aborts
- SDO info read
- Readme update only
- Initial publication