PX4-user_guide
PX4-user_guide copied to clipboard
Document mappydot distance sensor
trafficstars
https://github.com/PX4/Firmware/pull/12147
@mhkabir You did the work on this right? Can you create some basic docs, or talk me though it in bullet form here. Not much point adding a driver for anything without how to use docs.
@hamishwillee , I wrote this driver, i am glad to help with the docs. Let me get a start on it and ask for your help to polish things up!
Thanks @mcsauder - much appreciated!
Just to give you a starting point
- Good to have some docs here: https://dev.px4.io/master/en/middleware/modules_driver_distance_sensor.html but you can do those last
- Distance sensors typically have a very high level introduction here: http://docs.px4.io/master/en/sensor/rangefinders.html - mostly this is just a very high level introduction to the sensor and link to dedicated page. By introduction I mean "this is how the marketing for the sensor self describes + some info on distances and key selling point"
- Docs structure for individual page can be inferred from examples - they are all pretty much the same. Basically though you want people to know what it is (range, key characteristics), be able to wire the specific hardware, any specific configuration, links to any general configuration. If there is anything special about the driver setup add that too - e.g. this one (only) can be used for collision prevention, so I added that info: http://docs.px4.io/master/en/sensor/cm8jl65_ir_distance_sensor.html#parameter-setup
Some sensors can be used on I2C, others UAVCAN, others Serial. So we try capture what works with what.