-
-
Notifications
You must be signed in to change notification settings - Fork 520
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
Renamed DroneCore to DronecodeSDK #438
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fine for me, given that it passes the backend unit tests :-)
It was decided that DroneCore should be renamed to Dronecode SDK because that's essentially what it is and should create less confusion. This commit renames: - The DroneCore class to DronecodeSDK. - The dronecore library to dronecode_sdk. - The dronecore.h|cpp source files. - Some remaining instances of DroneCore in the README. - The proto submodule with renamed package names. - Various install and CI paths. - The dockerhub repository names. It does not rename the github repository URLs yet since the repository has not been moved/renamed yet.
Note that the backend doesn't yet compile against the latest proto submodule:
|
@@ -30,7 +30,7 @@ The library provides both synchronous (blocking) API calls, as well as asynchron | |||
|
|||
## API Overview | |||
|
|||
API consumers use the `DroneCore` class to discover and manage vehicles (`System` objects). Using the `System` object plugins such as e.g. `Action`, `Telemetry`, or `Mission` can be instantiated which provide information about the state of the drone and allow to interact with it. | |||
API consumers use the `DronecodeSDK` class to discover and manage vehicles (`System` objects). Using the `System` object plugins such as e.g. `Action`, `Telemetry`, or `Mission` can be instantiated which provide information about the state of the drone and allow to interact with it. | |||
|
|||
The links below take you to the respective header files: | |||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Link below needs to be fixed: dronecore
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not yet, as written in the description we should change them once the github repo has moved.
core/dronecode_sdk.h
Outdated
class System; | ||
|
||
/** | ||
* @brief This is the main class of **%DroneCore MAVLink API Library** (for the Dronecode Platform). | ||
* @brief This is the main class of **%DronecodeSDK MAVLink API Library** (for the Dronecode |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe change to:
This is the main class of Dronecode SDK (a MAVLink API Library for the Dronecode Platform).
core/plugin_impl_base.h
Outdated
@@ -17,14 +17,14 @@ class PluginImplBase { | |||
* when a system is constructed. This does not mean that the system actually | |||
* exists and is connected, it might just be an empty dummy system. | |||
* | |||
* Plugins should do initialization steps with other parts of DroneCore | |||
* Plugins should do initialization steps with other parts of DronecodeSDK |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"... other parts of Dronecode SDK" - This is a reference to the library, not the class.
example/fly_mission/fly_mission.cpp
Outdated
@@ -1,7 +1,7 @@ | |||
/** | |||
* @file fly_mission.cpp | |||
* | |||
* @brief Demonstrates how to Add & Fly Waypoint missions using DroneCore. | |||
* @brief Demonstrates how to Add & Fly Waypoint missions using DronecodeSDK. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
using the Dronecode SDK
Wow. I've scanned through this and fixed up all but the issue above (link to dronecore.h in the README). The changes were generally just DronecodeSDK to "the Dronecode SDK" in the cases where we were talking about the SDK and not the class. Updating the docs will be a challenge. |
Thanks a lot @hamishwillee! |
Renamed DroneCore to DronecodeSDK
It was decided that DroneCore should be renamed to Dronecode SDK because
that's essentially what it is and should create less confusion.
This commit renames:
It does not rename the github repository URLs yet since the repository
has not been moved/renamed yet.
@JonasVautherin please review the changes in backend in particular.