Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README documentation #108

Merged
merged 2 commits into from
Feb 24, 2022
Merged

Update README documentation #108

merged 2 commits into from
Feb 24, 2022

Conversation

lrapetti
Copy link
Member

Accordingly to #102

README.md Outdated
@@ -51,9 +51,10 @@ Eprint = {arXiv:1809.02167},
* [YARP](http://www.yarp.it/): to handle the comunication with the robot;
* [iDynTree](http://wiki.icub.org/codyco/dox/html/idyntree/html/): to handle the robot kinematics;
* [iCubContrib](https://github.com/robotology/icub-contrib-common): to configure the modules;
* [icub-main](https://github.com/robotology/icub-main): to handle signale processing;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As far as I see icub-main is used only for the min-jerk-trajectory and the integrator. I didn't know hot to describe it. @S-Dafarra @GiulioRomualdi feel free to suggest better description of it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I also noticed probably this include

is not required

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to remove it and add that modification to this PR

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing those lines I am getting the following compilation error

In file included from /Users/lorenzorapetti/Software/robotology-superbuild/src/walking-controllers/src/SimplifiedModelControllers/src/ZMPController.cpp:18:
/Users/lorenzorapetti/Software/robotology-superbuild/src/walking-controllers/src/SimplifiedModelControllers/include/WalkingControllers/SimplifiedModelControllers/ZMPController.h:60:37: error: no member named 'Integrator' in namespace 'iCub::ctrl'
        std::unique_ptr<iCub::ctrl::Integrator> m_velocityIntegral{nullptr};
                        ~~~~~~~~~~~~^
/Users/lorenzorapetti/Software/robotology-superbuild/src/walking-controllers/src/SimplifiedModelControllers/src/ZMPController.cpp:65:55: error: no member named 'Integrator' in namespace 'iCub::ctrl'
    m_velocityIntegral = std::make_unique<iCub::ctrl::Integrator>(samplingTime, buffer);
                                          ~~~~~~~~~~~~^

Indeed iCub::ctrl::Integrator is included in iCub/ctrl/pids.h (see https://github.com/robotology/icub-main/blob/a210d2e74b069c3df356098de5748be77deb798c/src/libraries/ctrlLib/src/pids.cpp#L28-L38), so we cannot remove it.

README.md Outdated Show resolved Hide resolved
README.md Outdated
@@ -51,9 +51,10 @@ Eprint = {arXiv:1809.02167},
* [YARP](http://www.yarp.it/): to handle the comunication with the robot;
* [iDynTree](http://wiki.icub.org/codyco/dox/html/idyntree/html/): to handle the robot kinematics;
* [iCubContrib](https://github.com/robotology/icub-contrib-common): to configure the modules;
* [icub-main](https://github.com/robotology/icub-main): to handle signale processing;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Feel free to remove it and add that modification to this PR

Co-authored-by: Stefano Dafarra <stefano.dafarra@gmail.com>
@lrapetti
Copy link
Member Author

Hi @S-Dafarra the comment should have been addressed, please let me know if any additional change is required

@S-Dafarra S-Dafarra merged commit 8179e20 into robotology:master Feb 24, 2022
@lrapetti lrapetti deleted the patch-1 branch February 24, 2022 16:53
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.

2 participants