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.

Sign up for GitHub

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

Update docs to new plugin archicture #88

Merged
merged 9 commits into from
Feb 7, 2018
Merged

Update docs to new plugin archicture #88

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ec6d562
Update example docs
hamishwillee Feb 4, 2018
e249416
Update build docs clean instructions
hamishwillee Feb 4, 2018
db5c75d
Update API Ref. Remove DevicePluginContainer toc
hamishwillee Feb 4, 2018
167b129
Fix docs for plugin constructors
hamishwillee Feb 5, 2018
3c1696f
Make if more clear that copter is main target currently
hamishwillee Feb 5, 2018
d347a3f
Remove the old auto-generated plugin container from API
hamishwillee Feb 5, 2018
18cae89
Add guide updates for new plugin API
hamishwillee Feb 5, 2018
a6cdb74
Fix incorrect constructor description
hamishwillee Feb 6, 2018
16e3f62
Add more extensive create-plugin sections
hamishwillee Feb 6, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions en/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not just yet, I think.



## Getting Started
Expand All @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions en/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense.

* [Missions](guide/missions.md)
* [Offboard Control](guide/offboard.md)
* [Follow Me](guide/follow_me.md)
Expand Down Expand Up @@ -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)
Expand Down
3 changes: 1 addition & 2 deletions en/api_reference/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
18 changes: 13 additions & 5 deletions en/api_reference/classdronecore_1_1_action.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down Expand Up @@ -62,18 +62,26 @@ 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 (internal use only).
Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).

The plugin is typically created as shown below:

```cpp
auto action = std::make_shared<Action>(&device);
```


The plugin is owned by the device (and will be destroyed along with it).

**Parameters**

* ActionImpl * **impl** - Private internal implementation.
* [Device](classdronecore_1_1_device.md) * **device** - The device associated with this plugin.

### ~Action() {#classdronecore_1_1_action_1a6bb0301fecf66d75ca3b27bda25af7f2}
```cpp
Expand Down
Loading