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

Renamed DroneCore to DronecodeSDK #438

Merged
merged 3 commits into from
Jul 6, 2018
Merged

Renamed DroneCore to DronecodeSDK #438

merged 3 commits into from
Jul 6, 2018

Conversation

julianoes
Copy link
Collaborator

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.

@JonasVautherin please review the changes in backend in particular.

Copy link
Collaborator

@JonasVautherin JonasVautherin left a 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.
@julianoes
Copy link
Collaborator Author

Note that the backend doesn't yet compile against the latest proto submodule:

camera/camera.proto:103:14: "SettingOption" is not defined.
make[3]: *** [backend/src/CMakeFiles/backend.dir/build.make:70: backend/src/camera/camera.grpc.pb.cc] Error 1

@@ -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:

Copy link
Collaborator

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

Copy link
Collaborator Author

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.

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
Copy link
Collaborator

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).

@@ -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
Copy link
Collaborator

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.

@@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

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

using the Dronecode SDK

@hamishwillee
Copy link
Collaborator

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.

@julianoes
Copy link
Collaborator Author

Thanks a lot @hamishwillee!

@julianoes julianoes merged commit 27027d4 into develop Jul 6, 2018
@julianoes julianoes deleted the rename branch July 6, 2018 08:35
rt-2pm2 pushed a commit to rt-2pm2/DronecodeSDK that referenced this pull request Nov 27, 2018
Renamed DroneCore to DronecodeSDK
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants