Skip to content

Comments

Zultron/2022 09 19 rebase for PRs: 4 config io#17

Closed
zultron wants to merge 34 commits intotormach:foxy-develfrom
zultron:zultron/2022-09-19-rebase_for_PRs-4-config_io
Closed

Zultron/2022 09 19 rebase for PRs: 4 config io#17
zultron wants to merge 34 commits intotormach:foxy-develfrom
zultron:zultron/2022-09-19-rebase_for_PRs-4-config_io

Conversation

@zultron
Copy link
Collaborator

@zultron zultron commented Sep 19, 2022

This is 4 of 9 in a series of PRs refactoring the hw_device_mgr to run outside ROS, handle file resources more intelligently, manage PDO configurations, improve abstraction, improve CiA402 homing, simplify initialization, fix a state_cmd race condition, and other fixes and improvements.

This PR is based on & should be merged after #16 .

This fourth PR reworks access to drive ESI XML files and to various YAML config files. This eliminates the hackish symlinks inside the repo and eliminates the need to duplicate files from external using code. The interface enables loading files from package resources (non-Python files included in Python sources) or from an arbitrary path.

Fix test_dot test.  External projects may have mgr classes without a
separate category, i.e. in the `all` class, which causes collisions.
I'm not sury why this was ever this way in the first place.

Other changes for cleanliness only; nothing fixed:
- Remove redundant piece of conditional
- Improve assertion exception messages
...and `update()` that interface from `get_feedback()`.

This fixes issues with the manager class.  It also shows that for a
more intuitive interface, interfaces should be reset from a `reset()`
method in the base `read()`, and `update()` renamed to `set()`.
When dumping drive params, uploading some objects is expected to fail;
suppressing stderr silences the cryptic & out of context error
messages printed by the `ethercat` command
The `dump_param_values()` method uploads all device SDO values and
returns in a dict of `{sdo_obj : value}` pairs.
Remove unneeded fixtures
The dash character in e.g. `-1` confuses the `ethercat` utility.  Fix
up the `ethercat download` command to explicitly signal the end of
options.
The `LCECCommand.upload()` method can now handle string types.
The `munge_config()` method was too rigid, requiring each key to be
named.  It also clobbered bits of the original.  Instead, copy the
whole raw device config, avoiding skipped and clobbered keys, and
munge just the bits that need munging.
Add objects shown in manual (and seen on drives) but not in original
ESI from Inovance

- 2002-06h, 2002-07h:  Stop mode settings
- 2004-18h:  Forced DO output in non-OP state
- 2005-08h, 2005-0Ah:  Electronic gear ratio settings
- 200D-03h:  Offline autotuning setting
The `index` attribute was unused other than to compute pin names in
the `HALDevice` class.  Replace it with a generic string used for
generated identifiers.
The base `Device` class `index` attribute, unused outside this class,
was removed.  Generate HAL pins by munging the `address` attribute
instead.
LinuxCNC doesn't support these
Add a general `ConfigIO` class.  It covers several cases, broken down
into categories:

- Config file source:
  - POSIX path for reading or writing
  - Python `importlib` resource (possibly in an "egg" zip file)

- Config file use case:
  - Open as IOStream object (can use as context manager; has `read()`,
    etc. methods)
  - Read (path + resource) or write (path only) YAML data

This will clean up config data handling for both the device manager
classes and their tests.  It makes sharing config data from package
resources easier, both internally within this package, and also for
use by external packages (the latter being the main motivation for
this change).
Following previous commit for `errors`.
In addition to YAML configs, also move XML ESI files.

Some rework in `hw_device_mgr.ethercat.xml_reader.EtherCATXMLReader`
needed to support this.

Use logger instead of `print()` in ESI parser so scripts can control
output.
@zultron
Copy link
Collaborator Author

zultron commented Aug 8, 2025

Superseded by #22.

@zultron zultron closed this Aug 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant