Update docs to new plugin archicture #88

hamishwillee · 2018-02-05T06:04:51Z

This PR updates docs to match up with mavlink/MAVSDK#188

Examples and most of guide done (though there will be further comments inline). This also includes docs from mavlink/MAVSDK#242 (not yet merged). Writing plugins and extensions not yet done. Some outstanding questions/actions

DevicePluginContainer removed. Need to check no longer referenced.
Confirm whether PluginBase, and MavlinkHandlerTableEntry part of the public API? If so need docs for those.
Device needs docs: Device API needs documentation MAVSDK#243

@julianoes Even though this is not "complete", provided it is accurate as is, it might be worth accepting and then doing how to write plugins etc as separate PRs.

hamishwillee · 2018-02-05T06:08:57Z

en/getting_started/faq.md

@@ -24,7 +24,7 @@ The architecture has stubs for serial, TCP, and UDP connections. However, only U

 ### Why is libCURL a dependency?

-libCURL will be required to download the camera definition file which is referenced in [CAMERA_INFORMATION](http://mavlink.org/messages/common#CAMERA_INFORMATION). It might also come in handy whenever any other REST resources are required.
+libCURL will be required to download the camera definition file which is referenced in [CAMERA_INFORMATION](http://mavlink.org/messages/common#CAMERA_INFORMATION). It might also come in handy whenever any other REST resources are required. 


@julianoes Where does DroneCore use CAMERA_INFORMATION?

Hehe, that's still proprietary but I'll open source that camera plugin soon.

Cool. Created #90 just to make sure this doesn't fall off the radar

hamishwillee · 2018-02-05T06:09:47Z

en/README.md

@@ -64,7 +64,6 @@ The most important classes are:
 - [Gimbal](/api_reference/classdronecore_1_1_gimbal.md): Control a gimbal.
 - [FollowMe](/api_reference/classdronecore_1_1_follow_me.md): Drone tracks a position supplied by DroneCore.
 - [Logging](/api_reference/classdronecore_1_1_logging.md): Data logging and streaming from the vehicle.
- [include/device_plugin_container.h.in](https://github.com/dronecore/DroneCore/blob/{{ book.github_branch }}/include/device_plugin_container.h.in): Auto-generated file that is required for DroneCore plugin development - see [DevicePluginContainer](/api_reference/classdronecore_1_1_device_plugin_container.md).


Deleted the DevicePluginContainer. Need to know if need to add: PluginBase, and MavlinkHandlerTableEntry

Not just yet, I think.

hamishwillee · 2018-02-05T06:10:15Z

en/SUMMARY.md

  * [Vehicle Information](guide/device_version.md)
  * [Telemetry](guide/telemetry.md)
-  * [Taking Off and Landing](guide/taking_off_landing.md)
+  * [Actions - Take Off, Arm, ...](guide/taking_off_landing.md)


Renamed to focus on "Actions" old name too specific for broad content of topic.

Makes sense.

hamishwillee · 2018-02-05T06:10:54Z

en/api_reference/classdronecore_1_1_plugin_base.md

@@ -0,0 +1,58 @@
+# dronecore::PluginBase Class Reference


@julianoes If this is public, need some docs.

hamishwillee · 2018-02-05T06:12:42Z

en/guide/device_version.md


+The following code assumes that you already have included DroneCore (`#include <dronecore/dronecore.h>`) and that there is a [connection to a device](../guide/connections.md) obtained as shown below:


@julianoes Conscious decision here NOT to include mention of also having to link to the plugin library. Do you think this has to be mentioned? We do link to the using plugins doc that covers this sort of thing.

You now need to include and link to each plugin that you require. So in this case we do require info.

I had hoped that having that in the "Using Plugins" section would be sufficient (since all the sections otherwise have to duplicate similar instructions). Anyway, I've updated so that this is in every docs as "Create the Plugin" (rather than preconditions). OK?

hamishwillee · 2018-02-05T06:19:29Z

@julianoes What needs to change for local installation?
https://docs.dronecore.io/v/develop/en/guide/toolchain.html#dronecore_local_install

Do you think you could provide an example? I suspect it is just addition of the plugin libs to ${dronecore_lib}

julianoes · 2018-02-05T10:21:16Z

en/README.md

@@ -64,7 +64,6 @@ The most important classes are:
 - [Gimbal](/api_reference/classdronecore_1_1_gimbal.md): Control a gimbal.
 - [FollowMe](/api_reference/classdronecore_1_1_follow_me.md): Drone tracks a position supplied by DroneCore.
 - [Logging](/api_reference/classdronecore_1_1_logging.md): Data logging and streaming from the vehicle.
- [include/device_plugin_container.h.in](https://github.com/dronecore/DroneCore/blob/{{ book.github_branch }}/include/device_plugin_container.h.in): Auto-generated file that is required for DroneCore plugin development - see [DevicePluginContainer](/api_reference/classdronecore_1_1_device_plugin_container.md).


Not just yet, I think.

julianoes · 2018-02-05T10:21:29Z

en/SUMMARY.md

  * [Vehicle Information](guide/device_version.md)
  * [Telemetry](guide/telemetry.md)
-  * [Taking Off and Landing](guide/taking_off_landing.md)
+  * [Actions - Take Off, Arm, ...](guide/taking_off_landing.md)


Makes sense.

julianoes · 2018-02-05T10:23:02Z

en/examples/offboard_velocity.md

@@ -152,16 +161,18 @@ inline void offboard_log(const std::string &offb_mode, const std::string msg)
 */
 bool offb_ctrl_ned(Device &device)
 {
+    std::shared_ptr<Offboard> offboard = std::make_shared<Offboard>(&device);


This is actually wrong. We should not create offboard twice but only once and then pass it on as std::shared_ptr<Offboard> offboard instead of Device &device.

I guess we need to fix the example first.

Update to example is here: mavlink/MAVSDK#246
Untested because I can't build dronecore mavlink/MAVSDK#245

I'll update docs after that example is merged.

julianoes · 2018-02-05T10:29:47Z

en/getting_started/faq.md

@@ -24,7 +24,7 @@ The architecture has stubs for serial, TCP, and UDP connections. However, only U

 ### Why is libCURL a dependency?

-libCURL will be required to download the camera definition file which is referenced in [CAMERA_INFORMATION](http://mavlink.org/messages/common#CAMERA_INFORMATION). It might also come in handy whenever any other REST resources are required.
+libCURL will be required to download the camera definition file which is referenced in [CAMERA_INFORMATION](http://mavlink.org/messages/common#CAMERA_INFORMATION). It might also come in handy whenever any other REST resources are required. 


Hehe, that's still proprietary but I'll open source that camera plugin soon.

julianoes · 2018-02-05T10:30:51Z

en/guide/device_version.md


+The following code assumes that you already have included DroneCore (`#include <dronecore/dronecore.h>`) and that there is a [connection to a device](../guide/connections.md) obtained as shown below:


You now need to include and link to each plugin that you require. So in this case we do require info.

hamishwillee · 2018-02-06T03:48:07Z

@julianoes I've updated in line with your feedback. More to do, but I'd like to get this PR in - can you check again please?

julianoes · 2018-02-06T08:47:29Z

Thanks, your comments make sense. I'll look into your PR and issue.

hamishwillee · 2018-02-07T10:38:41Z

OK to merge this @julianoes ? There is more to be done - like updating for the Offboard example (mavlink/MAVSDK#246), and looking at the external example, but I'd like to get this in.

julianoes

Sure this can then go in.

hamishwillee · 2018-02-07T10:45:15Z

Thanks!

hamishwillee added 7 commits February 5, 2018 10:41

Update example docs

ec6d562

Update build docs clean instructions

e249416

Update API Ref. Remove DevicePluginContainer toc

db5c75d

Fix docs for plugin constructors

167b129

Make if more clear that copter is main target currently

3c1696f

Remove the old auto-generated plugin container from API

d347a3f

Add guide updates for new plugin API

18cae89

hamishwillee requested a review from julianoes February 5, 2018 06:07

hamishwillee commented Feb 5, 2018

View reviewed changes

julianoes reviewed Feb 5, 2018

View reviewed changes

hamishwillee added 2 commits February 6, 2018 13:21

Fix incorrect constructor description

a6cdb74

Add more extensive create-plugin sections

16e3f62

julianoes approved these changes Feb 7, 2018

View reviewed changes

hamishwillee merged commit ce298ac into mavlink:develop Feb 7, 2018

hamishwillee deleted the new_plugin_arch branch February 7, 2018 10:45

hamishwillee mentioned this pull request Feb 8, 2018

Update all docs following changes for more flexible plugin architecture #87

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs to new plugin archicture #88

Update docs to new plugin archicture #88

hamishwillee commented Feb 5, 2018 •

edited

Loading

hamishwillee Feb 5, 2018

julianoes Feb 5, 2018

hamishwillee Feb 6, 2018

hamishwillee Feb 5, 2018

julianoes Feb 5, 2018

hamishwillee Feb 5, 2018

julianoes Feb 5, 2018

hamishwillee Feb 5, 2018

hamishwillee Feb 5, 2018

julianoes Feb 5, 2018

hamishwillee Feb 6, 2018

hamishwillee commented Feb 5, 2018

julianoes Feb 5, 2018

julianoes Feb 5, 2018

julianoes Feb 5, 2018

hamishwillee Feb 6, 2018 •

edited

Loading

julianoes Feb 5, 2018

julianoes Feb 5, 2018

hamishwillee commented Feb 6, 2018

julianoes commented Feb 6, 2018 •

edited

Loading

hamishwillee commented Feb 7, 2018

julianoes left a comment

hamishwillee commented Feb 7, 2018


		The following code assumes that you already have included DroneCore (`#include <dronecore/dronecore.h>`) and that there is a [connection to a device](../guide/connections.md) obtained as shown below:

Update docs to new plugin archicture #88

Update docs to new plugin archicture #88

Conversation

hamishwillee commented Feb 5, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hamishwillee commented Feb 5, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hamishwillee Feb 6, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hamishwillee commented Feb 6, 2018

julianoes commented Feb 6, 2018 • edited Loading

hamishwillee commented Feb 7, 2018

julianoes left a comment

Choose a reason for hiding this comment

hamishwillee commented Feb 7, 2018

hamishwillee commented Feb 5, 2018 •

edited

Loading

hamishwillee Feb 6, 2018 •

edited

Loading

julianoes commented Feb 6, 2018 •

edited

Loading