bnjmnp / pysoem

Cython wrapper for the Simple Open EtherCAT Master Library
MIT License
95 stars 36 forks source link

Add meaning of 'network adapter ID' to documentation #137

Open RobertoRoos opened 2 months ago

RobertoRoos commented 2 months ago

New to pysoem and soem and I had some trouble to get started with the basics.

This page https://pysoem.readthedocs.io/en/latest/basics.html is pretty clear, except I can't find anywhere what the 'network adapter ID' looks like. I'm on Windows, so is the ID the name as show in Control Panel? (E.g. "Ethernet 2") Or the adapter type? (E.g. "I219-V")

RobertoRoos commented 2 months ago

I found out now by using pysoem.find_adapters(). My device name is \\Device\\NPF_{2D594793-2E69-4C58-90F4-3164E860643B}, but I am curious where I could have found this name manually.

EDIT: Also asked here on SO: https://stackoverflow.com/questions/8978670/what-do-windows-interface-names-look-like

bnjmnp commented 3 weeks ago

This is probably badly or not documented in SOEM as well.

Short term, we could at least write a comment mentioning pysoem.find_adapters() in the example where the open() function is called.