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

Rework frontpage #35

Open
patrickelectric opened this issue Mar 2, 2021 · 3 comments
Open

Rework frontpage #35

patrickelectric opened this issue Mar 2, 2021 · 3 comments

Comments

@patrickelectric
Copy link
Member

No description provided.

@enderocean
Copy link

What do you mean by frontpage ?

@patrickelectric
Copy link
Member Author

0.0.0.0:8088
image

@enderocean
Copy link

enderocean commented Mar 3, 2021

Well. As it is a REST API landing page, I suggest to divide it in several tabs / parts:

  • First tab is a page that is accessing real time to the services like you did. It's really helpful and enable to have a global view of possibilities

  • Second tab is a standard documentation of the input/output using a dedicated tool (like swagger, docAPI or any other). Objective is to be able to enrich documentation easily and create client programmes. I also imagine a quick engine checkup feature where you could detect abnormal situations or breakdowns ; but it is clearly time demanding 🕥

  • Last tab is a list of actions that are commonly executed in ArduSub, ArduCopter, Ardu... For instance for ArduSub: arm/disarm, go forward, backward, stabilize, hold position, open / close gripper... Those examples could be referenced in the second tabs to illustrate the typical usage of mavlink2rest services.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants