Add howto docs about using temperature compensation and pre-estimated offsets in WBD and add a top-level WBD README

robotology / whole-body-estimators

YARP devices that implement estimators for humanoid robots.

26 stars 12 forks source link

Add howto docs about using temperature compensation and pre-estimated offsets in WBD and add a top-level WBD README #84

Closed prashanthr05 closed 3 years ago

prashanthr05 commented 4 years ago

Move documentation from https://github.com/robotology/whole-body-estimators/wiki/How-to-use-the-temperature-coefficients-and-offset-compensation to docs folder
Moved https://github.com/robotology-legacy/codyco-modules/blob/master/doc/force_control_on_icub.md to docs folder
Moved doxygen documentation of the wholeBodyDynamcis device to a folder level README (removed the doxygen documentation to avoid any future divergence of redundant documentations cc @traversaro's wise words)
Updated the top-level README to link all the above

Fixes #50 Fixes #55

prashanthr05 commented 4 years ago

Relevant links for this must be added when updating the README for https://github.com/robotology/whole-body-estimators/issues/55

prashanthr05 commented 3 years ago

friendly ping @HosameldinMohamed @fjandrad @traversaro !!

prashanthr05 commented 3 years ago

Ok. Minor comment: can we make sure that this page is linked by the README or by some more central piece of documentation (doxygen?).

Ok, I will work on that before merging.

prashanthr05 commented 3 years ago

Ciao guys!

I updated the overall documentation for wholeBodyDynamics device within this PR. I would ask you to re-review it.

For a demo, please see https://github.com/prashanthr05/whole-body-estimators/tree/doc/howto.

Feel free to update the documentation by adding relevant paper references (which is the only thing missing currently).

traversaro commented 3 years ago

Thank @prashanthr05 for handling this! If we want to keep the docs in the README (that I think is indeed a good idea) I suggest to remove them from the doxygen blocks, otherwise the two copies of the docs will probably diverge soon.

prashanthr05 commented 3 years ago

Thank @prashanthr05 for handling this! If we want to keep the docs in the README (that I think is indeed a good idea) I suggest to remove them from the doxygen blocks, otherwise the two copies of the docs will probably diverge soon.

Looks like I missed porting part of the documentation from the doxygen to the README, relating to the FT Offsets and temperature coefficients.

I will update that and remove the doxygen then.

prashanthr05 commented 3 years ago

Thank @prashanthr05 for handling this! If we want to keep the docs in the README (that I think is indeed a good idea) I suggest to remove them from the doxygen blocks, otherwise the two copies of the docs will probably diverge soon.

Looks like I missed porting part of the documentation from the doxygen to the README, relating to the FT Offsets and temperature coefficients.

I will update that and remove the doxygen then.

I've done this in https://github.com/robotology/whole-body-estimators/pull/84/commits/c91e03625b95a82799d8fe1f8940f3d36120690f

prashanthr05 commented 3 years ago

@HosameldinMohamed I request you to look at the relevant changes and merge the PR if you approve. Thanks in advance..!

traversaro commented 3 years ago

Friendly ping @HosameldinMohamed

prashanthr05 commented 3 years ago

Thanks @HosameldinMohamed !