diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 0000000..e69de29 diff --git a/annotated.html b/annotated.html new file mode 100644 index 0000000..ab55381 --- /dev/null +++ b/annotated.html @@ -0,0 +1,111 @@ + + +
+ + + + ++ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
▼Nmrs_uav_hw_api | |
CCommonHandlers_t | A tructure with methods and variables provided to the HW API Plugin |
CDummyApi | |
CHwApiManager | |
CMrsUavHwApi | |
CPublishers_t | A structure with publisher methods provided to the HW API Plugin. The plugin can call these methods at will to provided data to the MRS UAV System. In case the HW API Plugin intents to publish data, the respective varible "produces_***" in the HW API Capabilities of the plugin is supposed to be fill in |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
|
+
|
+
|
+
|
+
|
+|||||
CommonHandlers_t (mrs_uav_hw_api) | +DummyApi (mrs_uav_hw_api) | +HwApiManager (mrs_uav_hw_api) | +MrsUavHwApi (mrs_uav_hw_api) | +Publishers_t (mrs_uav_hw_api) | +|||||
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
This is the complete list of members for mrs_uav_hw_api::DummyApi, including all inherited members.
+callbackAccelerationHdgCmd(const mrs_msgs::HwApiAccelerationHdgCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackAccelerationHdgRateCmd(const mrs_msgs::HwApiAccelerationHdgRateCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackActuatorCmd(const mrs_msgs::HwApiActuatorCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackArming(const bool &request) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackAttitudeCmd(const mrs_msgs::HwApiAttitudeCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackAttitudeRateCmd(const mrs_msgs::HwApiAttitudeRateCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackControlGroupCmd(const mrs_msgs::HwApiControlGroupCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackOffboard(void) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackPositionCmd(const mrs_msgs::HwApiPositionCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackTrackerCmd(const mrs_msgs::TrackerCommand::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackVelocityHdgCmd(const mrs_msgs::HwApiVelocityHdgCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
callbackVelocityHdgRateCmd(const mrs_msgs::HwApiVelocityHdgRateCmd::ConstPtr msg) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
getCapabilities() (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
getStatus() (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
initialize(const ros::NodeHandle &parent_nh, std::shared_ptr< mrs_uav_hw_api::CommonHandlers_t > common_handlers) (defined in mrs_uav_hw_api::DummyApi) | mrs_uav_hw_api::DummyApi | virtual |
~MrsUavHwApi()=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+Public Member Functions | |
+void | initialize (const ros::NodeHandle &parent_nh, std::shared_ptr< mrs_uav_hw_api::CommonHandlers_t > common_handlers) |
+mrs_msgs::HwApiStatus | getStatus () |
+mrs_msgs::HwApiCapabilities | getCapabilities () |
+bool | callbackActuatorCmd (const mrs_msgs::HwApiActuatorCmd::ConstPtr msg) |
+bool | callbackControlGroupCmd (const mrs_msgs::HwApiControlGroupCmd::ConstPtr msg) |
+bool | callbackAttitudeRateCmd (const mrs_msgs::HwApiAttitudeRateCmd::ConstPtr msg) |
+bool | callbackAttitudeCmd (const mrs_msgs::HwApiAttitudeCmd::ConstPtr msg) |
+bool | callbackAccelerationHdgRateCmd (const mrs_msgs::HwApiAccelerationHdgRateCmd::ConstPtr msg) |
+bool | callbackAccelerationHdgCmd (const mrs_msgs::HwApiAccelerationHdgCmd::ConstPtr msg) |
+bool | callbackVelocityHdgRateCmd (const mrs_msgs::HwApiVelocityHdgRateCmd::ConstPtr msg) |
+bool | callbackVelocityHdgCmd (const mrs_msgs::HwApiVelocityHdgCmd::ConstPtr msg) |
+bool | callbackPositionCmd (const mrs_msgs::HwApiPositionCmd::ConstPtr msg) |
+void | callbackTrackerCmd (const mrs_msgs::TrackerCommand::ConstPtr msg) |
+std::tuple< bool, std::string > | callbackArming (const bool &request) |
+std::tuple< bool, std::string > | callbackOffboard (void) |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
This is the complete list of members for mrs_uav_hw_api::HwApiManager, including all inherited members.
+onInit() (defined in mrs_uav_hw_api::HwApiManager) | mrs_uav_hw_api::HwApiManager | virtual |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
This is the complete list of members for mrs_uav_hw_api::MrsUavHwApi, including all inherited members.
+callbackAccelerationHdgCmd(const mrs_msgs::HwApiAccelerationHdgCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackAccelerationHdgRateCmd(const mrs_msgs::HwApiAccelerationHdgRateCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackActuatorCmd(const mrs_msgs::HwApiActuatorCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackArming(const bool &request)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackAttitudeCmd(const mrs_msgs::HwApiAttitudeCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackAttitudeRateCmd(const mrs_msgs::HwApiAttitudeRateCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackControlGroupCmd(const mrs_msgs::HwApiControlGroupCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackOffboard(void)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackPositionCmd(const mrs_msgs::HwApiPositionCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackTrackerCmd(const mrs_msgs::TrackerCommand::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackVelocityHdgCmd(const mrs_msgs::HwApiVelocityHdgCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
callbackVelocityHdgRateCmd(const mrs_msgs::HwApiVelocityHdgRateCmd::ConstPtr msg)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
getCapabilities()=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
getStatus()=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
initialize(const ros::NodeHandle &parent_nh, std::shared_ptr< mrs_uav_hw_api::CommonHandlers_t > common_handlers)=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
~MrsUavHwApi()=0 (defined in mrs_uav_hw_api::MrsUavHwApi) | mrs_uav_hw_api::MrsUavHwApi | pure virtual |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+Public Member Functions | |
+virtual void | initialize (const ros::NodeHandle &parent_nh, std::shared_ptr< mrs_uav_hw_api::CommonHandlers_t > common_handlers)=0 |
+virtual mrs_msgs::HwApiStatus | getStatus ()=0 |
+virtual mrs_msgs::HwApiCapabilities | getCapabilities ()=0 |
+virtual bool | callbackActuatorCmd (const mrs_msgs::HwApiActuatorCmd::ConstPtr msg)=0 |
+virtual bool | callbackControlGroupCmd (const mrs_msgs::HwApiControlGroupCmd::ConstPtr msg)=0 |
+virtual bool | callbackAttitudeRateCmd (const mrs_msgs::HwApiAttitudeRateCmd::ConstPtr msg)=0 |
+virtual bool | callbackAttitudeCmd (const mrs_msgs::HwApiAttitudeCmd::ConstPtr msg)=0 |
+virtual bool | callbackAccelerationHdgRateCmd (const mrs_msgs::HwApiAccelerationHdgRateCmd::ConstPtr msg)=0 |
+virtual bool | callbackAccelerationHdgCmd (const mrs_msgs::HwApiAccelerationHdgCmd::ConstPtr msg)=0 |
+virtual bool | callbackVelocityHdgRateCmd (const mrs_msgs::HwApiVelocityHdgRateCmd::ConstPtr msg)=0 |
+virtual bool | callbackVelocityHdgCmd (const mrs_msgs::HwApiVelocityHdgCmd::ConstPtr msg)=0 |
+virtual bool | callbackPositionCmd (const mrs_msgs::HwApiPositionCmd::ConstPtr msg)=0 |
+virtual void | callbackTrackerCmd (const mrs_msgs::TrackerCommand::ConstPtr msg)=0 |
+virtual std::tuple< bool, std::string > | callbackArming (const bool &request)=0 |
+virtual std::tuple< bool, std::string > | callbackOffboard (void)=0 |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
▼ include | |
▼ mrs_uav_hw_api | |
api.h | |
common_handlers.h | |
publishers.h |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
This page explains how to interpret the graphs that are generated by doxygen.
+Consider the following example:
This will result in the following graph:
+The boxes in the above graph have the following meaning:
+The arrows have the following meaning:
++ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
Cmrs_uav_hw_api::CommonHandlers_t | A tructure with methods and variables provided to the HW API Plugin |
▼Cmrs_uav_hw_api::MrsUavHwApi | |
Cmrs_uav_hw_api::DummyApi | |
▼CNodelet | |
Cmrs_uav_hw_api::HwApiManager | |
Cmrs_uav_hw_api::Publishers_t | A structure with publisher methods provided to the HW API Plugin. The plugin can call these methods at will to provided data to the MRS UAV System. In case the HW API Plugin intents to publish data, the respective varible "produces_***" in the HW API Capabilities of the plugin is supposed to be fill in |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
An abstraction layer between the MRS UAV System and a UAV flight controller.
+++:warning: Attention please: This README is needs work.
+The MRS UAV System 1.5 is being released and this page needs updating. Please, keep in mind that the information on this page might not be valid.
+
This nodes provides an interface between any UAV flight controller (and any Simulator) and the core of the MRS UAV System. On one side, the HW API provides a unified ROS interfaces for the core as if it was a generic flight controller. On the other side, the communication with a particular hardware (or simulator) can be orchestrated using whatever is required.
+ +https://ctu-mrs.github.io/mrs_uav_hw_api/
+The control output can be any of the following:
+TODO
++ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+
+ + |
+ + |
+ + |
+ + |
+ |
+ mrs_uav_hw_api
+
+ An abstraction layer between the MRS UAV System and a low-level Flight Controller
+ |
+