Feature: API Documentation


#1

Continuing the discussion from Choosing a tool to document the OpenROV APIs:

So I have been crafting the API and I have a first cut that can be statically viewed at the moment for those interested in what it looks like: https://htmlpreview.github.io/?https://raw.githubusercontent.com/OpenROV/openrov-software/feature/apidocs/src/plugins/rovpilot/api.html

Let me know your feedback!

Also in PDF:
rovpilot api.pdf (202.9 KB)


Programming the OpenROV Cockpit
Autonomous Control of OpenROV
#2

Thanks Brian. This helps. BTW- the link for the .pdf returns a ‘link doesn’t exist or page private’ message.


#3

pdf has been updated!


#4

@badevguru is there an updated tutorial or other resource to help someone get started using the API and socket.io? The pdf seems very helpful for what I want to be able to do but no sure how to get to a point where I can start using those methods. Thanks!