Merge pull request #88 from hamishwillee/new_plugin_arch

Update docs to new plugin archicture
mavlink · Feb 7, 2018 · ce298ac · ce298ac
2 parents 1d4ea10 + 16e3f62
commit ce298ac
Show file tree

Hide file tree

Showing 30 changed files with 1,056 additions and 409 deletions.
diff --git a/en/README.md b/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).
 
 
 ## Getting Started
@@ -78,8 +77,8 @@ Developers who want to contribute to the API will need to build the C++ library
 
 This guide contains information and examples showing how to use DroneCore. If you have specific questions that are not answered by the documentation, these can be raised on:
 
-* [Slack DroneCore Channel](https://px4.slack.com/messages/C68J8H32A) (get a [Slack login here](http://slack.px4.io))
 * [Discuss board](http://discuss.px4.io/c/dronecore)
+* [Slack DroneCore Channel](https://px4.slack.com/messages/C68J8H32A) (get a [Slack login here](http://slack.px4.io))
 
 Use Github for bug reports/enhancement requests:
 

diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -6,9 +6,10 @@
 * [Guide](guide/README.md)
   * [Usage/Paradigms](guide/general_usage.md)
   * [Connecting to Devices](guide/connections.md)
+  * [Managing Devices](guide/using_plugins.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)
   * [Missions](guide/missions.md)
   * [Offboard Control](guide/offboard.md)
   * [Follow Me](guide/follow_me.md)
@@ -46,7 +47,6 @@
     * [struct Config](api_reference/structdronecore_1_1_follow_me_1_1_config.md)
     * [struct TargetLocation ](api_reference/structdronecore_1_1_follow_me_1_1_target_location.md)
   * [class Logging](api_reference/classdronecore_1_1_logging.md)
-  * [class DevicePluginContainer](api_reference/classdronecore_1_1_device_plugin_container.md)
 * [Contributing](contributing/README.md)
   * [Building Source](contributing/build.md)
   * [Testing](contributing/test.md)

diff --git a/en/api_reference/README.md b/en/api_reference/README.md
@@ -24,5 +24,4 @@
 * [class FollowMe](classdronecore_1_1_follow_me.md)
   * [struct Config](structdronecore_1_1_follow_me_1_1_config.md)
   * [struct TargetLocation ](structdronecore_1_1_follow_me_1_1_target_location.md)
-* [class Logging](classdronecore_1_1_logging.md)
-* [class DevicePluginContainer](classdronecore_1_1_device_plugin_container.md)
+* [class Logging](classdronecore_1_1_logging.md)
diff --git a/en/api_reference/classdronecore_1_1_action.md b/en/api_reference/classdronecore_1_1_action.md
@@ -26,7 +26,7 @@ std::function< void([Result](classdronecore_1_1_action.md#classdronecore_1_1_act
 
 Type | Name | Description
 ---: | --- | ---
-| [Action](#classdronecore_1_1_action_1a4d54f66fbb7629198d5d2f5f261261c0) (ActionImpl *impl) | Constructor (internal use only).
+| [Action](#classdronecore_1_1_action_1a9fd3af84d59048b3c787ed0c5644ed07) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
 | [~Action](#classdronecore_1_1_action_1a6bb0301fecf66d75ca3b27bda25af7f2) () | Destructor (internal use only).
 | [Action](#classdronecore_1_1_action_1ae48b0e06ca2b4b7544a10c7734a03f63) (const Action &)=delete | Copy constructor (object is not copyable).
 [Result](classdronecore_1_1_action.md#classdronecore_1_1_action_1ad92c9d2e08f60f54b17ea0d861339011) | [arm](#classdronecore_1_1_action_1a8b8631ea15655f0c922a9ba7d2e1c72c) () const | Send command to *arm* the drone (synchronous).
@@ -62,18 +62,23 @@ const char * | [result_str](#classdronecore_1_1_action_1a1fefb474ee36cb15fe31b42
 ## Constructor & Destructor Documentation
 
 
-### Action() {#classdronecore_1_1_action_1a4d54f66fbb7629198d5d2f5f261261c0}
+### Action() {#classdronecore_1_1_action_1a9fd3af84d59048b3c787ed0c5644ed07}
 ```cpp
-dronecore::Action::Action(ActionImpl *impl)
+dronecore::Action::Action(Device *device)
 ```
 
+Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
-Constructor (internal use only).
+The plugin is typically created as shown below: 
+
+```cpp
+auto action = std::make_shared<Action>(&device);
+```
 
 
 **Parameters**
 
-* ActionImpl * **impl** - Private internal implementation.
+* [Device](classdronecore_1_1_device.md) * **device** - The specific device associated with this plugin.
 
 ### ~Action() {#classdronecore_1_1_action_1a6bb0301fecf66d75ca3b27bda25af7f2}
 ```cpp