ZilantRobotics / innopolis_vtol_dynamics

Cyphal/DroneCAN UAV HITL simulator
GNU General Public License v3.0
41 stars 8 forks source link

Into PX4 docs/codelines? #6

Open hamishwillee opened 3 years ago

hamishwillee commented 3 years ago

This is awesome. Would be great to get this linked into the PX4 User Guide! Fantastic for people to be able to find this when looking into Simulators and UAVCAN.

PonomarevDA commented 3 years ago

Linking this into the PX4 User Guide would be really cool. This simulator may be based on master branch as well as any other enough new version of PX4. Here v1.12 is just an example of how we can make it work. In general, the only differences we need to make are:

I leave a link with such modification related to fmu-v5: https://github.com/InnopolisAero/PX4-Autopilot/compare/px4_v1.12.1...px4_v1.12.1_inno_vtol_dynamics. Better approaches are welcome.

I didn't push to the PX4 docs before, but after reading the tutorial it seems to be not too hard to do. Next week I may try to make a simple draft. After that I will ask some questions.

hamishwillee commented 3 years ago

Thank you!

So the PR you point to v1.12 changes needed looks good (I'm not an expert). What you'd ideally do is push that all in a PR to PX4 repo master, get it reviewed, then going forward you would not have to maintain your own fork and everyone could just take master and release to use it with the simulator

Docs updates are generally pretty easy. The toolchain is not hard to set up and I will help review the PR.

Generally the hardest part for people starting out is working out where the docs should go. For simulators I usually update the supported simulators table here with a high level overview of what you can do: http://docs.px4.io/master/en/simulation/#supported-simulators

Then I create a page below that with any detailed setup info. You might copy http://docs.px4.io/master/en/simulation/gazebo.html as a model page. You will need to use git for edits (rather than editing in github) if you want to add images.

After that is done we'd separately link in from UAVCAN docs.