wb-toolbox
wb-toolbox copied to clipboard
Enhance the documentation on the website
Here's a list of possible topics:
- [x] How to create a block (updated to
v4
) -blockfactory@How to create a new library
- [ ] Automatic code generation pipeline -
blockfactory@How to autogenerate C++ code
- [x] ~How to solve errors on missing symbols~ Now the compiler complains if symbols are missing
- [x] How to update / export (and develop) the simulink library -
blockfactory@How to create a new library
- [ ] Example part 1: Develop a simple model that moves
iCub
joints in Gazebo - [ ] Example part 2: Generate and run standalone code -
blockfactory@How to autogenerate C++ code
The upcoming version of WBT should contain only tutorials on how to use the blocks since their creation is demanded by BlockFactory. All the tutorials that involve blocks creation and simulink libraries have been added / moved to BlockFactory.
Slightly OT, but (in addition to the project documentation) it would be good to link vvv-school tutorials that use WB-Toolbox, such as:
- https://github.com/vvv-school/tutorial_impedance-control-simulink
- https://github.com/vvv-school/tutorial_wb-toolbox-gazebo-pendulum
It would be nice having a set of new tutorials here in WBT that address more a new user perspective. Here below some ideas:
- Basic Simulink simulation: How to configure Simulink for a simple real-time compatible simulation. This could involve a Discrete Filter block and a Real-Time Synchronizer, pointing out that we need to use a fixed step. This should provide a primer for new users.
-
Use model blocks: This tutorial should be focused on how to configure the environment e.g. with
YARP_DATA_DIRS
to find amodel.urdf
, and how to use the Config block (in this case, no YARP-related blocks should be used, only iDynTree ones. The enable joints will be the ones specified in the Config block). - Simulink and Gazebo: This tutorial should focus on Gazebo. It should handle all the YARP initialization, how to open Gazebo (with the plugin for synchronizing the clock), how to insert a model, few infos about the co-simulation approach we use, and how to send references and read measurement. It would be nice obtaining the same result of the vvv-school, that consisted in icub moving the elbow with a sine-wave reference.
This can be extremely beneficial with new members of the lab. @DanielePucci can we assign this task to someone?
@traversaro You anticipated my comment, I was writing the same thing while you commented ^^
@diegoferigo
This can be extremely beneficial with new members of the lab. @DanielePucci can we assign this task to someone?
As we discussed F2F, @aikolina may take upon this task