├── .gitignore ├── .nojekyll ├── Jenkinsfile ├── LANGS.md ├── LICENSE ├── README.md ├── assets ├── autogen │ ├── autogen_overview.png │ └── mavsdk_overview.png ├── examples │ ├── fly_mission │ │ └── fly_mission_example_qgc.jpg │ ├── fly_qgc_mission │ │ └── fly_qgc_plan_mission_example_qgc.jpg │ ├── follow_me │ │ └── follow_me_example_qgc.jpg │ ├── offboard_mode │ │ └── qgc_offboard_velocity.png │ └── transition_vtol_fixed_wing │ │ └── transition_vtol_fixed_wing_example_qgc.png ├── python │ └── quickstart │ │ ├── jmavsim_takeoff.png │ │ └── mavsdk_pycharm.png └── site │ ├── favicon.png │ ├── gitbook_toolbar.png │ ├── gitbook_toolbar_bug.png │ ├── gitbook_toolbar_edit.png │ ├── github_edit.png │ ├── logo_dronecode.png │ ├── logo_linux_foundation.png │ ├── sdk_logo_full.png │ └── slack.svg ├── book.json └── en ├── README.md ├── SUMMARY.md ├── cpp ├── README.md ├── api_changes.md ├── api_reference │ ├── README.md │ ├── classmavsdk_1_1_action.md │ ├── classmavsdk_1_1_action_server.md │ ├── classmavsdk_1_1_calibration.md │ ├── classmavsdk_1_1_callback_list.md │ ├── classmavsdk_1_1_callback_list_impl.md │ ├── classmavsdk_1_1_camera.md │ ├── classmavsdk_1_1_camera_server.md │ ├── classmavsdk_1_1_component_information.md │ ├── classmavsdk_1_1_component_information_server.md │ ├── classmavsdk_1_1_failure.md │ ├── classmavsdk_1_1_fake_handle.md │ ├── classmavsdk_1_1_follow_me.md │ ├── classmavsdk_1_1_ftp.md │ ├── classmavsdk_1_1_ftp_server.md │ ├── classmavsdk_1_1_geofence.md │ ├── classmavsdk_1_1_gimbal.md │ ├── classmavsdk_1_1_gripper.md │ ├── classmavsdk_1_1_handle.md │ ├── classmavsdk_1_1_info.md │ ├── classmavsdk_1_1_log_files.md │ ├── classmavsdk_1_1_manual_control.md │ ├── classmavsdk_1_1_mavlink_passthrough.md │ ├── classmavsdk_1_1_mavsdk.md │ ├── classmavsdk_1_1_mavsdk_1_1_configuration.md │ ├── classmavsdk_1_1_mission.md │ ├── classmavsdk_1_1_mission_raw.md │ ├── classmavsdk_1_1_mission_raw_server.md │ ├── classmavsdk_1_1_mocap.md │ ├── classmavsdk_1_1_offboard.md │ ├── classmavsdk_1_1_param.md │ ├── classmavsdk_1_1_param_server.md │ ├── classmavsdk_1_1_plugin_base.md │ ├── classmavsdk_1_1_rtk.md │ ├── classmavsdk_1_1_server_component.md │ ├── classmavsdk_1_1_server_plugin_base.md │ ├── classmavsdk_1_1_server_utility.md │ ├── classmavsdk_1_1_shell.md │ ├── classmavsdk_1_1_system.md │ ├── classmavsdk_1_1_telemetry.md │ ├── classmavsdk_1_1_telemetry_server.md │ ├── classmavsdk_1_1_tracking_server.md │ ├── classmavsdk_1_1_transponder.md │ ├── classmavsdk_1_1_tune.md │ ├── classmavsdk_1_1_winch.md │ ├── classmavsdk_1_1geometry_1_1_coordinate_transformation.md │ ├── namespacemavsdk.md │ ├── struct_mavlink_address.md │ ├── structmavsdk_1_1_action_server_1_1_allowable_flight_modes.md │ ├── structmavsdk_1_1_action_server_1_1_arm_disarm.md │ ├── structmavsdk_1_1_calibration_1_1_progress_data.md │ ├── structmavsdk_1_1_camera_1_1_capture_info.md │ ├── structmavsdk_1_1_camera_1_1_euler_angle.md │ ├── structmavsdk_1_1_camera_1_1_information.md │ ├── structmavsdk_1_1_camera_1_1_option.md │ ├── structmavsdk_1_1_camera_1_1_position.md │ ├── structmavsdk_1_1_camera_1_1_quaternion.md │ ├── structmavsdk_1_1_camera_1_1_setting.md │ ├── structmavsdk_1_1_camera_1_1_setting_options.md │ ├── structmavsdk_1_1_camera_1_1_status.md │ ├── structmavsdk_1_1_camera_1_1_video_stream_info.md │ ├── structmavsdk_1_1_camera_1_1_video_stream_settings.md │ ├── structmavsdk_1_1_camera_server_1_1_capture_info.md │ ├── structmavsdk_1_1_camera_server_1_1_capture_status.md │ ├── structmavsdk_1_1_camera_server_1_1_information.md │ ├── structmavsdk_1_1_camera_server_1_1_position.md │ ├── structmavsdk_1_1_camera_server_1_1_quaternion.md │ ├── structmavsdk_1_1_camera_server_1_1_storage_information.md │ ├── structmavsdk_1_1_camera_server_1_1_video_streaming.md │ ├── structmavsdk_1_1_component_information_1_1_float_param.md │ ├── structmavsdk_1_1_component_information_1_1_float_param_update.md │ ├── structmavsdk_1_1_component_information_server_1_1_float_param.md │ ├── structmavsdk_1_1_component_information_server_1_1_float_param_update.md │ ├── structmavsdk_1_1_follow_me_1_1_config.md │ ├── structmavsdk_1_1_follow_me_1_1_target_location.md │ ├── structmavsdk_1_1_ftp_1_1_progress_data.md │ ├── structmavsdk_1_1_geofence_1_1_circle.md │ ├── structmavsdk_1_1_geofence_1_1_geofence_data.md │ ├── structmavsdk_1_1_geofence_1_1_point.md │ ├── structmavsdk_1_1_geofence_1_1_polygon.md │ ├── structmavsdk_1_1_gimbal_1_1_control_status.md │ ├── structmavsdk_1_1_info_1_1_flight_info.md │ ├── structmavsdk_1_1_info_1_1_identification.md │ ├── structmavsdk_1_1_info_1_1_product.md │ ├── structmavsdk_1_1_info_1_1_version.md │ ├── structmavsdk_1_1_log_files_1_1_entry.md │ ├── structmavsdk_1_1_log_files_1_1_progress_data.md │ ├── structmavsdk_1_1_mavlink_passthrough_1_1_command_int.md │ ├── structmavsdk_1_1_mavlink_passthrough_1_1_command_long.md │ ├── structmavsdk_1_1_mission_1_1_mission_item.md │ ├── structmavsdk_1_1_mission_1_1_mission_plan.md │ ├── structmavsdk_1_1_mission_1_1_mission_progress.md │ ├── structmavsdk_1_1_mission_1_1_progress_data.md │ ├── structmavsdk_1_1_mission_1_1_progress_data_or_mission.md │ ├── structmavsdk_1_1_mission_raw_1_1_mission_import_data.md │ ├── structmavsdk_1_1_mission_raw_1_1_mission_item.md │ ├── structmavsdk_1_1_mission_raw_1_1_mission_progress.md │ ├── structmavsdk_1_1_mission_raw_server_1_1_mission_item.md │ ├── structmavsdk_1_1_mission_raw_server_1_1_mission_plan.md │ ├── structmavsdk_1_1_mission_raw_server_1_1_mission_progress.md │ ├── structmavsdk_1_1_mocap_1_1_angle_body.md │ ├── structmavsdk_1_1_mocap_1_1_angular_velocity_body.md │ ├── structmavsdk_1_1_mocap_1_1_attitude_position_mocap.md │ ├── structmavsdk_1_1_mocap_1_1_covariance.md │ ├── structmavsdk_1_1_mocap_1_1_odometry.md │ ├── structmavsdk_1_1_mocap_1_1_position_body.md │ ├── structmavsdk_1_1_mocap_1_1_quaternion.md │ ├── structmavsdk_1_1_mocap_1_1_speed_body.md │ ├── structmavsdk_1_1_mocap_1_1_vision_position_estimate.md │ ├── structmavsdk_1_1_offboard_1_1_acceleration_ned.md │ ├── structmavsdk_1_1_offboard_1_1_actuator_control.md │ ├── structmavsdk_1_1_offboard_1_1_actuator_control_group.md │ ├── structmavsdk_1_1_offboard_1_1_attitude.md │ ├── structmavsdk_1_1_offboard_1_1_attitude_rate.md │ ├── structmavsdk_1_1_offboard_1_1_position_global_yaw.md │ ├── structmavsdk_1_1_offboard_1_1_position_ned_yaw.md │ ├── structmavsdk_1_1_offboard_1_1_velocity_body_yawspeed.md │ ├── structmavsdk_1_1_offboard_1_1_velocity_ned_yaw.md │ ├── structmavsdk_1_1_param_1_1_all_params.md │ ├── structmavsdk_1_1_param_1_1_custom_param.md │ ├── structmavsdk_1_1_param_1_1_float_param.md │ ├── structmavsdk_1_1_param_1_1_int_param.md │ ├── structmavsdk_1_1_param_server_1_1_all_params.md │ ├── structmavsdk_1_1_param_server_1_1_custom_param.md │ ├── structmavsdk_1_1_param_server_1_1_float_param.md │ ├── structmavsdk_1_1_param_server_1_1_int_param.md │ ├── structmavsdk_1_1_rtk_1_1_rtcm_data.md │ ├── structmavsdk_1_1_system_1_1_autopilot_version.md │ ├── structmavsdk_1_1_telemetry_1_1_acceleration_frd.md │ ├── structmavsdk_1_1_telemetry_1_1_actuator_control_target.md │ ├── structmavsdk_1_1_telemetry_1_1_actuator_output_status.md │ ├── structmavsdk_1_1_telemetry_1_1_altitude.md │ ├── structmavsdk_1_1_telemetry_1_1_angular_velocity_body.md │ ├── structmavsdk_1_1_telemetry_1_1_angular_velocity_frd.md │ ├── structmavsdk_1_1_telemetry_1_1_battery.md │ ├── structmavsdk_1_1_telemetry_1_1_covariance.md │ ├── structmavsdk_1_1_telemetry_1_1_distance_sensor.md │ ├── structmavsdk_1_1_telemetry_1_1_euler_angle.md │ ├── structmavsdk_1_1_telemetry_1_1_fixedwing_metrics.md │ ├── structmavsdk_1_1_telemetry_1_1_gps_global_origin.md │ ├── structmavsdk_1_1_telemetry_1_1_gps_info.md │ ├── structmavsdk_1_1_telemetry_1_1_ground_truth.md │ ├── structmavsdk_1_1_telemetry_1_1_heading.md │ ├── structmavsdk_1_1_telemetry_1_1_health.md │ ├── structmavsdk_1_1_telemetry_1_1_imu.md │ ├── structmavsdk_1_1_telemetry_1_1_magnetic_field_frd.md │ ├── structmavsdk_1_1_telemetry_1_1_odometry.md │ ├── structmavsdk_1_1_telemetry_1_1_position.md │ ├── structmavsdk_1_1_telemetry_1_1_position_body.md │ ├── structmavsdk_1_1_telemetry_1_1_position_ned.md │ ├── structmavsdk_1_1_telemetry_1_1_position_velocity_ned.md │ ├── structmavsdk_1_1_telemetry_1_1_quaternion.md │ ├── structmavsdk_1_1_telemetry_1_1_raw_gps.md │ ├── structmavsdk_1_1_telemetry_1_1_rc_status.md │ ├── structmavsdk_1_1_telemetry_1_1_scaled_pressure.md │ ├── structmavsdk_1_1_telemetry_1_1_status_text.md │ ├── structmavsdk_1_1_telemetry_1_1_velocity_body.md │ ├── structmavsdk_1_1_telemetry_1_1_velocity_ned.md │ ├── structmavsdk_1_1_telemetry_server_1_1_acceleration_frd.md │ ├── structmavsdk_1_1_telemetry_server_1_1_actuator_control_target.md │ ├── structmavsdk_1_1_telemetry_server_1_1_actuator_output_status.md │ ├── structmavsdk_1_1_telemetry_server_1_1_angular_velocity_body.md │ ├── structmavsdk_1_1_telemetry_server_1_1_angular_velocity_frd.md │ ├── structmavsdk_1_1_telemetry_server_1_1_battery.md │ ├── structmavsdk_1_1_telemetry_server_1_1_covariance.md │ ├── structmavsdk_1_1_telemetry_server_1_1_distance_sensor.md │ ├── structmavsdk_1_1_telemetry_server_1_1_euler_angle.md │ ├── structmavsdk_1_1_telemetry_server_1_1_fixedwing_metrics.md │ ├── structmavsdk_1_1_telemetry_server_1_1_gps_info.md │ ├── structmavsdk_1_1_telemetry_server_1_1_ground_truth.md │ ├── structmavsdk_1_1_telemetry_server_1_1_heading.md │ ├── structmavsdk_1_1_telemetry_server_1_1_imu.md │ ├── structmavsdk_1_1_telemetry_server_1_1_magnetic_field_frd.md │ ├── structmavsdk_1_1_telemetry_server_1_1_odometry.md │ ├── structmavsdk_1_1_telemetry_server_1_1_position.md │ ├── structmavsdk_1_1_telemetry_server_1_1_position_body.md │ ├── structmavsdk_1_1_telemetry_server_1_1_position_ned.md │ ├── structmavsdk_1_1_telemetry_server_1_1_position_velocity_ned.md │ ├── structmavsdk_1_1_telemetry_server_1_1_quaternion.md │ ├── structmavsdk_1_1_telemetry_server_1_1_raw_gps.md │ ├── structmavsdk_1_1_telemetry_server_1_1_rc_status.md │ ├── structmavsdk_1_1_telemetry_server_1_1_scaled_pressure.md │ ├── structmavsdk_1_1_telemetry_server_1_1_status_text.md │ ├── structmavsdk_1_1_telemetry_server_1_1_velocity_body.md │ ├── structmavsdk_1_1_telemetry_server_1_1_velocity_ned.md │ ├── structmavsdk_1_1_tracking_server_1_1_track_point.md │ ├── structmavsdk_1_1_tracking_server_1_1_track_rectangle.md │ ├── structmavsdk_1_1_transponder_1_1_adsb_vehicle.md │ ├── structmavsdk_1_1_tune_1_1_tune_description.md │ ├── structmavsdk_1_1_winch_1_1_status.md │ ├── structmavsdk_1_1_winch_1_1_status_flags.md │ ├── structmavsdk_1_1geometry_1_1_coordinate_transformation_1_1_global_coordinate.md │ ├── structmavsdk_1_1geometry_1_1_coordinate_transformation_1_1_local_coordinate.md │ └── structmavsdk_1_1overloaded.md ├── contributing │ ├── README.md │ ├── autogen.md │ ├── documentation.md │ ├── faq.md │ ├── plugins.md │ └── release.md ├── examples │ ├── README.md │ ├── autopilot_server.md │ ├── fly_mission.md │ ├── follow_me.md │ ├── offboard_velocity.md │ ├── takeoff_and_land.md │ └── transition_vtol_fixed_wing.md ├── guide │ ├── README.md │ ├── build.md │ ├── build_docs.md │ ├── build_mavsdk_server.md │ ├── code_style.md │ ├── connections.md │ ├── dev_logging.md │ ├── follow_me.md │ ├── general_usage.md │ ├── installation.md │ ├── logging.md │ ├── missions.md │ ├── offboard.md │ ├── system_information.md │ ├── taking_off_landing.md │ ├── telemetry.md │ ├── test.md │ ├── toolchain.md │ ├── using_plugins.md │ └── vtol.md ├── quickstart.md ├── server_plugins.md └── troubleshooting.md ├── faq.md ├── python ├── README.md └── quickstart.md └── swift └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | # Node rules: 2 | ## Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 3 | .grunt 4 | 5 | ## Dependency directory 6 | ## Commenting this out is preferred by some people, see 7 | ## https://docs.npmjs.com/misc/faq#should-i-check-my-node_modules-folder-into-git 8 | node_modules 9 | 10 | # Book build output 11 | _book 12 | 13 | # eBook build output 14 | *.epub 15 | *.mobi 16 | *.pdf 17 | -------------------------------------------------------------------------------- /.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/.nojekyll -------------------------------------------------------------------------------- /Jenkinsfile: -------------------------------------------------------------------------------- 1 | pipeline { 2 | agent { 3 | docker { 4 | image 'px4io/px4-docs:2020-01-05' 5 | } 6 | } 7 | stages { 8 | 9 | stage('Build') { 10 | environment { 11 | HOME = "${WORKSPACE}" 12 | } 13 | 14 | steps { 15 | sh('export') 16 | checkout(scm) 17 | sh('gitbook install') 18 | sh('gitbook build') 19 | stash(includes: '_book/', name: 'gitbook') 20 | // publish html 21 | publishHTML(target: [ 22 | reportTitles: 'Mavlink SDK Guide', 23 | allowMissing: false, 24 | alwaysLinkToLastBuild: true, 25 | keepAll: true, 26 | reportDir: '_book', 27 | reportFiles: '*', 28 | reportName: 'Mavlink SDK Guide' 29 | ]) 30 | } 31 | 32 | } // Build 33 | 34 | stage('Deploy') { 35 | environment { 36 | GIT_AUTHOR_EMAIL = "bot@px4.io" 37 | GIT_AUTHOR_NAME = "PX4BuildBot" 38 | GIT_COMMITTER_EMAIL = "bot@px4.io" 39 | GIT_COMMITTER_NAME = "PX4BuildBot" 40 | } 41 | 42 | steps { 43 | sh('export') 44 | unstash('gitbook') 45 | withCredentials([usernamePassword(credentialsId: 'px4buildbot_github_personal_token', passwordVariable: 'GIT_PASS', usernameVariable: 'GIT_USER')]) { 46 | sh('git clone https://${GIT_USER}:${GIT_PASS}@github.com/mavlink/sdk.mavlink.io') 47 | sh('rm -rf sdk.mavlink.io/${BRANCH_NAME}') 48 | sh('mkdir -p sdk.mavlink.io/${BRANCH_NAME}') 49 | sh('cp -r _book/* sdk.mavlink.io/${BRANCH_NAME}/') 50 | sh('cd sdk.mavlink.io; git add ${BRANCH_NAME}; git commit -a -m "gitbook build update `date`"') 51 | sh('cd sdk.mavlink.io; git push origin master') 52 | 53 | } 54 | } 55 | post { 56 | always { 57 | sh('rm -rf sdk.mavlink.io') 58 | } 59 | } 60 | when { 61 | anyOf { 62 | branch "main" 63 | branch "pr-jenkins" 64 | branch "v2.*" 65 | branch "v1.*" 66 | branch "v0.*" 67 | } 68 | } 69 | 70 | } // Deploy 71 | } // stages 72 | 73 | options { 74 | buildDiscarder(logRotator(numToKeepStr: '10', artifactDaysToKeepStr: '30')) 75 | skipDefaultCheckout() 76 | timeout(time: 60, unit: 'MINUTES') 77 | } 78 | 79 | } 80 | -------------------------------------------------------------------------------- /LANGS.md: -------------------------------------------------------------------------------- 1 | * [English](en/) 2 | 3 | 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # MAVSDK Documentation Source 4 | 5 | > **Warning** Under Construction. 6 | 7 | The [MAVSDK documentation](https://mavsdk.mavlink.io/) explains how to use the [MAVSDK](https://github.com/mavlink/MAVSDK) C++ MAVLink API Library, along with auto-generated wrapper APIs written in Python, Java and iOS (forthcoming). 8 | 9 | This repository contains the *source code* for the documentation. 10 | 11 | ## Documentation Build 12 | 13 | Instructions how to setup a Gitbook toolchain and build this documentation can be found in the [Legacy Gitbook toolchain docs](https://github.com/GitbookIO/gitbook/blob/master/docs/setup.md). 14 | 15 | 16 | ## License 17 | 18 | This documentation is licensed under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) license. 19 | The SDK itself is licensed under the permissive [BSD 3-clause](https://github.com/mavlink/MAVSDK/blob/main/LICENSE.md). 20 | 21 | 22 | ## Governance 23 | 24 | The MAVSDK project is hosted under the governance of the [Dronecode Foundation](https://www.dronecode.org/). 25 | 26 | Dronecode Logo 27 | Linux Foundation Logo 28 |
 
29 | -------------------------------------------------------------------------------- /assets/autogen/autogen_overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/autogen/autogen_overview.png -------------------------------------------------------------------------------- /assets/autogen/mavsdk_overview.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/autogen/mavsdk_overview.png -------------------------------------------------------------------------------- /assets/examples/fly_mission/fly_mission_example_qgc.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/examples/fly_mission/fly_mission_example_qgc.jpg -------------------------------------------------------------------------------- /assets/examples/fly_qgc_mission/fly_qgc_plan_mission_example_qgc.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/examples/fly_qgc_mission/fly_qgc_plan_mission_example_qgc.jpg -------------------------------------------------------------------------------- /assets/examples/follow_me/follow_me_example_qgc.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/examples/follow_me/follow_me_example_qgc.jpg -------------------------------------------------------------------------------- /assets/examples/offboard_mode/qgc_offboard_velocity.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/examples/offboard_mode/qgc_offboard_velocity.png -------------------------------------------------------------------------------- /assets/examples/transition_vtol_fixed_wing/transition_vtol_fixed_wing_example_qgc.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/examples/transition_vtol_fixed_wing/transition_vtol_fixed_wing_example_qgc.png -------------------------------------------------------------------------------- /assets/python/quickstart/jmavsim_takeoff.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/python/quickstart/jmavsim_takeoff.png -------------------------------------------------------------------------------- /assets/python/quickstart/mavsdk_pycharm.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/python/quickstart/mavsdk_pycharm.png -------------------------------------------------------------------------------- /assets/site/favicon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/site/favicon.png -------------------------------------------------------------------------------- /assets/site/gitbook_toolbar.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/site/gitbook_toolbar.png -------------------------------------------------------------------------------- /assets/site/gitbook_toolbar_bug.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/site/gitbook_toolbar_bug.png -------------------------------------------------------------------------------- /assets/site/gitbook_toolbar_edit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/site/gitbook_toolbar_edit.png -------------------------------------------------------------------------------- /assets/site/github_edit.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/site/github_edit.png -------------------------------------------------------------------------------- /assets/site/logo_dronecode.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/site/logo_dronecode.png -------------------------------------------------------------------------------- /assets/site/logo_linux_foundation.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/site/logo_linux_foundation.png -------------------------------------------------------------------------------- /assets/site/sdk_logo_full.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/mavlink/MAVSDK-docs/6943b751e520e8d6c9e8560f6a7ac3e221d02901/assets/site/sdk_logo_full.png -------------------------------------------------------------------------------- /assets/site/slack.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | slack 19 | slack 20 | Join us! 21 | Join us! 22 | 23 | 24 | 25 | -------------------------------------------------------------------------------- /en/cpp/api_reference/classmavsdk_1_1_callback_list.md: -------------------------------------------------------------------------------- 1 | # mavsdk::CallbackList Class Reference 2 | `#include: UNKNOWN` 3 | 4 | ---- 5 | 6 | -------------------------------------------------------------------------------- /en/cpp/api_reference/classmavsdk_1_1_callback_list_impl.md: -------------------------------------------------------------------------------- 1 | # mavsdk::CallbackListImpl Class Reference 2 | `#include: UNKNOWN` 3 | 4 | ---- 5 | 6 | -------------------------------------------------------------------------------- /en/cpp/api_reference/classmavsdk_1_1_fake_handle.md: -------------------------------------------------------------------------------- 1 | # mavsdk::FakeHandle Class Reference 2 | `#include: UNKNOWN` 3 | 4 | ---- 5 | 6 | -------------------------------------------------------------------------------- /en/cpp/api_reference/classmavsdk_1_1_handle.md: -------------------------------------------------------------------------------- 1 | # mavsdk::Handle Class Reference 2 | `#include: handle.h` 3 | 4 | ---- 5 | 6 | 7 | A handle returned from subscribe which allows to unsubscribe again. 8 | 9 | 10 | ## Public Member Functions 11 | 12 | 13 | Type | Name | Description 14 | ---: | --- | --- 15 |   | [Handle](#classmavsdk_1_1_handle_1a4dde9be588a605aa7a7fa77cc4ed98f2) ()=default | 16 |   | [~Handle](#classmavsdk_1_1_handle_1a986e2ba72802e6cc5bdc5f06f27f6acb) ()=default | 17 | 18 | 19 | ## Constructor & Destructor Documentation 20 | 21 | 22 | ### Handle() {#classmavsdk_1_1_handle_1a4dde9be588a605aa7a7fa77cc4ed98f2} 23 | ```cpp 24 | mavsdk::Handle< Args >::Handle()=default 25 | ``` 26 | 27 | 28 | ### ~Handle() {#classmavsdk_1_1_handle_1a986e2ba72802e6cc5bdc5f06f27f6acb} 29 | ```cpp 30 | mavsdk::Handle< Args >::~Handle()=default 31 | ``` 32 | 33 | -------------------------------------------------------------------------------- /en/cpp/api_reference/classmavsdk_1_1_plugin_base.md: -------------------------------------------------------------------------------- 1 | # mavsdk::PluginBase Class Reference 2 | `#include: plugin_base.h` 3 | 4 | ---- 5 | 6 | 7 | Base class for every plugin. 8 | 9 | 10 | ## Public Member Functions 11 | 12 | 13 | Type | Name | Description 14 | ---: | --- | --- 15 |   | [PluginBase](#classmavsdk_1_1_plugin_base_1afbb5a017df6856e58fb576d65a9fe207) ()=default | Default Constructor. 16 |   | [~PluginBase](#classmavsdk_1_1_plugin_base_1a038befc8f15d34e0be17ec7df8e9d092) ()=default | Default Destructor. 17 |   | [PluginBase](#classmavsdk_1_1_plugin_base_1a717e8eda4a615730256f4a707f00aa72) (const [PluginBase](classmavsdk_1_1_plugin_base.md) &)=delete | Copy constructor (object is not copyable). 18 | const [PluginBase](classmavsdk_1_1_plugin_base.md) & | [operator=](#classmavsdk_1_1_plugin_base_1a7336d48f2784ef2ffe284ee2aaea3063) (const [PluginBase](classmavsdk_1_1_plugin_base.md) &)=delete | Assign operator (object is not copyable). 19 | 20 | 21 | ## Constructor & Destructor Documentation 22 | 23 | 24 | ### PluginBase() {#classmavsdk_1_1_plugin_base_1afbb5a017df6856e58fb576d65a9fe207} 25 | ```cpp 26 | mavsdk::PluginBase::PluginBase()=default 27 | ``` 28 | 29 | 30 | Default Constructor. 31 | 32 | 33 | ### ~PluginBase() {#classmavsdk_1_1_plugin_base_1a038befc8f15d34e0be17ec7df8e9d092} 34 | ```cpp 35 | virtual mavsdk::PluginBase::~PluginBase()=default 36 | ``` 37 | 38 | 39 | Default Destructor. 40 | 41 | 42 | ### PluginBase() {#classmavsdk_1_1_plugin_base_1a717e8eda4a615730256f4a707f00aa72} 43 | ```cpp 44 | mavsdk::PluginBase::PluginBase(const PluginBase &)=delete 45 | ``` 46 | 47 | 48 | Copy constructor (object is not copyable). 49 | 50 | 51 | **Parameters** 52 | 53 | * const [PluginBase](classmavsdk_1_1_plugin_base.md)& - 54 | 55 | ## Member Function Documentation 56 | 57 | 58 | ### operator=() {#classmavsdk_1_1_plugin_base_1a7336d48f2784ef2ffe284ee2aaea3063} 59 | ```cpp 60 | const PluginBase& mavsdk::PluginBase::operator=(const PluginBase &)=delete 61 | ``` 62 | 63 | 64 | Assign operator (object is not copyable). 65 | 66 | 67 | **Parameters** 68 | 69 | * const [PluginBase](classmavsdk_1_1_plugin_base.md)& - 70 | 71 | **Returns** 72 | 73 |  const [PluginBase](classmavsdk_1_1_plugin_base.md) & - -------------------------------------------------------------------------------- /en/cpp/api_reference/classmavsdk_1_1_server_component.md: -------------------------------------------------------------------------------- 1 | # mavsdk::ServerComponent Class Reference 2 | `#include: server_component.h` 3 | 4 | ---- 5 | 6 | 7 | This class represents a component, used to initialize a server plugin. 8 | 9 | 10 | ## Public Member Functions 11 | 12 | 13 | Type | Name | Description 14 | ---: | --- | --- 15 |   | [~ServerComponent](#classmavsdk_1_1_server_component_1aa93dd133c0c5476bfd9269365e4afcec) ()=default | Destructor. 16 | uint8_t | [component_id](#classmavsdk_1_1_server_component_1af05efb79ba6c1ed9992e13671d3268ba) () const | MAVLink component ID of this component. 17 | 18 | 19 | ## Constructor & Destructor Documentation 20 | 21 | 22 | ### ~ServerComponent() {#classmavsdk_1_1_server_component_1aa93dd133c0c5476bfd9269365e4afcec} 23 | ```cpp 24 | mavsdk::ServerComponent::~ServerComponent()=default 25 | ``` 26 | 27 | 28 | Destructor. 29 | 30 | 31 | ## Member Function Documentation 32 | 33 | 34 | ### component_id() {#classmavsdk_1_1_server_component_1af05efb79ba6c1ed9992e13671d3268ba} 35 | ```cpp 36 | uint8_t mavsdk::ServerComponent::component_id() const 37 | ``` 38 | 39 | 40 | MAVLink component ID of this component. 41 | 42 | 43 | **Returns** 44 | 45 |  uint8_t - -------------------------------------------------------------------------------- /en/cpp/api_reference/classmavsdk_1_1_server_plugin_base.md: -------------------------------------------------------------------------------- 1 | # mavsdk::ServerPluginBase Class Reference 2 | `#include: server_plugin_base.h` 3 | 4 | ---- 5 | 6 | 7 | Base class for every server plugin. 8 | 9 | 10 | ## Public Member Functions 11 | 12 | 13 | Type | Name | Description 14 | ---: | --- | --- 15 |   | [ServerPluginBase](#classmavsdk_1_1_server_plugin_base_1a77b7c74e4e2a10cf55071e95b53eedae) ()=default | Default Constructor. 16 |   | [~ServerPluginBase](#classmavsdk_1_1_server_plugin_base_1a97e1d14c2b72253d53f9284621b1d248) ()=default | Default Destructor. 17 |   | [ServerPluginBase](#classmavsdk_1_1_server_plugin_base_1a86ef071b10d0afc7d287069ac8d11575) (const [ServerPluginBase](classmavsdk_1_1_server_plugin_base.md) &)=delete | Copy constructor (object is not copyable). 18 | const [ServerPluginBase](classmavsdk_1_1_server_plugin_base.md) & | [operator=](#classmavsdk_1_1_server_plugin_base_1ab424dcb3a08fcb7159ca326361548301) (const [ServerPluginBase](classmavsdk_1_1_server_plugin_base.md) &)=delete | Assign operator (object is not copyable). 19 | 20 | 21 | ## Constructor & Destructor Documentation 22 | 23 | 24 | ### ServerPluginBase() {#classmavsdk_1_1_server_plugin_base_1a77b7c74e4e2a10cf55071e95b53eedae} 25 | ```cpp 26 | mavsdk::ServerPluginBase::ServerPluginBase()=default 27 | ``` 28 | 29 | 30 | Default Constructor. 31 | 32 | 33 | ### ~ServerPluginBase() {#classmavsdk_1_1_server_plugin_base_1a97e1d14c2b72253d53f9284621b1d248} 34 | ```cpp 35 | virtual mavsdk::ServerPluginBase::~ServerPluginBase()=default 36 | ``` 37 | 38 | 39 | Default Destructor. 40 | 41 | 42 | ### ServerPluginBase() {#classmavsdk_1_1_server_plugin_base_1a86ef071b10d0afc7d287069ac8d11575} 43 | ```cpp 44 | mavsdk::ServerPluginBase::ServerPluginBase(const ServerPluginBase &)=delete 45 | ``` 46 | 47 | 48 | Copy constructor (object is not copyable). 49 | 50 | 51 | **Parameters** 52 | 53 | * const [ServerPluginBase](classmavsdk_1_1_server_plugin_base.md)& - 54 | 55 | ## Member Function Documentation 56 | 57 | 58 | ### operator=() {#classmavsdk_1_1_server_plugin_base_1ab424dcb3a08fcb7159ca326361548301} 59 | ```cpp 60 | const ServerPluginBase& mavsdk::ServerPluginBase::operator=(const ServerPluginBase &)=delete 61 | ``` 62 | 63 | 64 | Assign operator (object is not copyable). 65 | 66 | 67 | **Parameters** 68 | 69 | * const [ServerPluginBase](classmavsdk_1_1_server_plugin_base.md)& - 70 | 71 | **Returns** 72 | 73 |  const [ServerPluginBase](classmavsdk_1_1_server_plugin_base.md) & - -------------------------------------------------------------------------------- /en/cpp/api_reference/struct_mavlink_address.md: -------------------------------------------------------------------------------- 1 | # MavlinkAddress Struct Reference 2 | `#include: mavlink_address.h` 3 | 4 | ---- 5 | 6 | 7 | Struct to represent a MAVLink address. 8 | 9 | 10 | ## Data Fields 11 | 12 | 13 | uint8_t [system_id](#struct_mavlink_address_1ace50a41854b60452a8cb8fddd86348af) - System ID, also called sysid. 14 | 15 | uint8_t [component_id](#struct_mavlink_address_1a666949f3b25592649b66a96bebf1d82b) - Component ID, also called compid. 16 | 17 | 18 | ## Field Documentation 19 | 20 | 21 | ### system_id {#struct_mavlink_address_1ace50a41854b60452a8cb8fddd86348af} 22 | 23 | ```cpp 24 | uint8_t MavlinkAddress::system_id 25 | ``` 26 | 27 | 28 | System ID, also called sysid. 29 | 30 | 31 | ### component_id {#struct_mavlink_address_1a666949f3b25592649b66a96bebf1d82b} 32 | 33 | ```cpp 34 | uint8_t MavlinkAddress::component_id 35 | ``` 36 | 37 | 38 | Component ID, also called compid. 39 | 40 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_action_server_1_1_allowable_flight_modes.md: -------------------------------------------------------------------------------- 1 | # mavsdk::ActionServer::AllowableFlightModes Struct Reference 2 | `#include: action_server.h` 3 | 4 | ---- 5 | 6 | 7 | State to check if the vehicle can transition to respective flightmodes. 8 | 9 | 10 | ## Data Fields 11 | 12 | 13 | bool [can_auto_mode](#structmavsdk_1_1_action_server_1_1_allowable_flight_modes_1ac953fe1b15d9cb4fc127e16f989d34ab) {} - Auto/mission mode. 14 | 15 | bool [can_guided_mode](#structmavsdk_1_1_action_server_1_1_allowable_flight_modes_1a1887755bf34cba572c96fc44dc4cae3b) {} - Guided mode. 16 | 17 | bool [can_stabilize_mode](#structmavsdk_1_1_action_server_1_1_allowable_flight_modes_1a341661c5e1d018f3f4595f8cc9e67ed3) {} - Stabilize mode. 18 | 19 | 20 | ## Field Documentation 21 | 22 | 23 | ### can_auto_mode {#structmavsdk_1_1_action_server_1_1_allowable_flight_modes_1ac953fe1b15d9cb4fc127e16f989d34ab} 24 | 25 | ```cpp 26 | bool mavsdk::ActionServer::AllowableFlightModes::can_auto_mode {} 27 | ``` 28 | 29 | 30 | Auto/mission mode. 31 | 32 | 33 | ### can_guided_mode {#structmavsdk_1_1_action_server_1_1_allowable_flight_modes_1a1887755bf34cba572c96fc44dc4cae3b} 34 | 35 | ```cpp 36 | bool mavsdk::ActionServer::AllowableFlightModes::can_guided_mode {} 37 | ``` 38 | 39 | 40 | Guided mode. 41 | 42 | 43 | ### can_stabilize_mode {#structmavsdk_1_1_action_server_1_1_allowable_flight_modes_1a341661c5e1d018f3f4595f8cc9e67ed3} 44 | 45 | ```cpp 46 | bool mavsdk::ActionServer::AllowableFlightModes::can_stabilize_mode {} 47 | ``` 48 | 49 | 50 | Stabilize mode. 51 | 52 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_action_server_1_1_arm_disarm.md: -------------------------------------------------------------------------------- 1 | # mavsdk::ActionServer::ArmDisarm Struct Reference 2 | `#include: action_server.h` 3 | 4 | ---- 5 | 6 | 7 | Arming message type. 8 | 9 | 10 | ## Data Fields 11 | 12 | 13 | bool [arm](#structmavsdk_1_1_action_server_1_1_arm_disarm_1acfcd754fb8389f43830cc64505a2bdf1) {} - Should vehicle arm. 14 | 15 | bool [force](#structmavsdk_1_1_action_server_1_1_arm_disarm_1af36cd34928194ab74904e053721886e5) {} - Should arm override pre-flight checks. 16 | 17 | 18 | ## Field Documentation 19 | 20 | 21 | ### arm {#structmavsdk_1_1_action_server_1_1_arm_disarm_1acfcd754fb8389f43830cc64505a2bdf1} 22 | 23 | ```cpp 24 | bool mavsdk::ActionServer::ArmDisarm::arm {} 25 | ``` 26 | 27 | 28 | Should vehicle arm. 29 | 30 | 31 | ### force {#structmavsdk_1_1_action_server_1_1_arm_disarm_1af36cd34928194ab74904e053721886e5} 32 | 33 | ```cpp 34 | bool mavsdk::ActionServer::ArmDisarm::force {} 35 | ``` 36 | 37 | 38 | Should arm override pre-flight checks. 39 | 40 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_calibration_1_1_progress_data.md: -------------------------------------------------------------------------------- 1 | # mavsdk::Calibration::ProgressData Struct Reference 2 | `#include: calibration.h` 3 | 4 | ---- 5 | 6 | 7 | Progress data coming from calibration. 8 | 9 | 10 | Can be a progress percentage, or an instruction text. 11 | 12 | 13 | ## Data Fields 14 | 15 | 16 | bool [has_progress](#structmavsdk_1_1_calibration_1_1_progress_data_1a1b34241aba778eb9e1e67ae9f3404249) { false} - Whether this [ProgressData](structmavsdk_1_1_calibration_1_1_progress_data.md) contains a 'progress' status or not. 17 | 18 | float [progress](#structmavsdk_1_1_calibration_1_1_progress_data_1a573b314b1440961d593881f931aeca32) {float(NAN)} - Progress (percentage) 19 | 20 | bool [has_status_text](#structmavsdk_1_1_calibration_1_1_progress_data_1ac6780fbc4f8e8eaea3a2ccf6290a2c78) { false} - Whether this [ProgressData](structmavsdk_1_1_calibration_1_1_progress_data.md) contains a 'status_text' or not. 21 | 22 | std::string [status_text](#structmavsdk_1_1_calibration_1_1_progress_data_1a8fae64b0166ed65158d045b07ed9b48d) {} - Instruction text. 23 | 24 | 25 | ## Field Documentation 26 | 27 | 28 | ### has_progress {#structmavsdk_1_1_calibration_1_1_progress_data_1a1b34241aba778eb9e1e67ae9f3404249} 29 | 30 | ```cpp 31 | bool mavsdk::Calibration::ProgressData::has_progress { false} 32 | ``` 33 | 34 | 35 | Whether this [ProgressData](structmavsdk_1_1_calibration_1_1_progress_data.md) contains a 'progress' status or not. 36 | 37 | 38 | ### progress {#structmavsdk_1_1_calibration_1_1_progress_data_1a573b314b1440961d593881f931aeca32} 39 | 40 | ```cpp 41 | float mavsdk::Calibration::ProgressData::progress {float(NAN)} 42 | ``` 43 | 44 | 45 | Progress (percentage) 46 | 47 | 48 | ### has_status_text {#structmavsdk_1_1_calibration_1_1_progress_data_1ac6780fbc4f8e8eaea3a2ccf6290a2c78} 49 | 50 | ```cpp 51 | bool mavsdk::Calibration::ProgressData::has_status_text { false} 52 | ``` 53 | 54 | 55 | Whether this [ProgressData](structmavsdk_1_1_calibration_1_1_progress_data.md) contains a 'status_text' or not. 56 | 57 | 58 | ### status_text {#structmavsdk_1_1_calibration_1_1_progress_data_1a8fae64b0166ed65158d045b07ed9b48d} 59 | 60 | ```cpp 61 | std::string mavsdk::Calibration::ProgressData::status_text {} 62 | ``` 63 | 64 | 65 | Instruction text. 66 | 67 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_camera_1_1_euler_angle.md: -------------------------------------------------------------------------------- 1 | # mavsdk::Camera::EulerAngle Struct Reference 2 | `#include: camera.h` 3 | 4 | ---- 5 | 6 | 7 | Euler angle type. 8 | 9 | 10 | All rotations and axis systems follow the right-hand rule. The Euler angles follow the convention of a 3-2-1 intrinsic Tait-Bryan rotation sequence. 11 | 12 | 13 | For more info see [https://en.wikipedia.org/wiki/Euler_angles](https://en.wikipedia.org/wiki/Euler_angles) 14 | 15 | 16 | ## Data Fields 17 | 18 | 19 | float [roll_deg](#structmavsdk_1_1_camera_1_1_euler_angle_1aa63fe9f7e9c4346686d554f37d47a178) {} - Roll angle in degrees, positive is banking to the right. 20 | 21 | float [pitch_deg](#structmavsdk_1_1_camera_1_1_euler_angle_1a682e6baf3c8051afefec07d620b510f2) {} - Pitch angle in degrees, positive is pitching nose up. 22 | 23 | float [yaw_deg](#structmavsdk_1_1_camera_1_1_euler_angle_1ad828494c6937d685ab33e02c04f529dd) {} - Yaw angle in degrees, positive is clock-wise seen from above. 24 | 25 | 26 | ## Field Documentation 27 | 28 | 29 | ### roll_deg {#structmavsdk_1_1_camera_1_1_euler_angle_1aa63fe9f7e9c4346686d554f37d47a178} 30 | 31 | ```cpp 32 | float mavsdk::Camera::EulerAngle::roll_deg {} 33 | ``` 34 | 35 | 36 | Roll angle in degrees, positive is banking to the right. 37 | 38 | 39 | ### pitch_deg {#structmavsdk_1_1_camera_1_1_euler_angle_1a682e6baf3c8051afefec07d620b510f2} 40 | 41 | ```cpp 42 | float mavsdk::Camera::EulerAngle::pitch_deg {} 43 | ``` 44 | 45 | 46 | Pitch angle in degrees, positive is pitching nose up. 47 | 48 | 49 | ### yaw_deg {#structmavsdk_1_1_camera_1_1_euler_angle_1ad828494c6937d685ab33e02c04f529dd} 50 | 51 | ```cpp 52 | float mavsdk::Camera::EulerAngle::yaw_deg {} 53 | ``` 54 | 55 | 56 | Yaw angle in degrees, positive is clock-wise seen from above. 57 | 58 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_camera_1_1_option.md: -------------------------------------------------------------------------------- 1 | # mavsdk::Camera::Option Struct Reference 2 | `#include: camera.h` 3 | 4 | ---- 5 | 6 | 7 | Type to represent a setting option. 8 | 9 | 10 | ## Data Fields 11 | 12 | 13 | std::string [option_id](#structmavsdk_1_1_camera_1_1_option_1aaa7f93e9d89a0b16c319a6ca695bc2e7) {} - Name of the option (machine readable) 14 | 15 | std::string [option_description](#structmavsdk_1_1_camera_1_1_option_1a72fc01f628a19a44fb730964ad50459e) {} - Description of the option (human readable) 16 | 17 | 18 | ## Field Documentation 19 | 20 | 21 | ### option_id {#structmavsdk_1_1_camera_1_1_option_1aaa7f93e9d89a0b16c319a6ca695bc2e7} 22 | 23 | ```cpp 24 | std::string mavsdk::Camera::Option::option_id {} 25 | ``` 26 | 27 | 28 | Name of the option (machine readable) 29 | 30 | 31 | ### option_description {#structmavsdk_1_1_camera_1_1_option_1a72fc01f628a19a44fb730964ad50459e} 32 | 33 | ```cpp 34 | std::string mavsdk::Camera::Option::option_description {} 35 | ``` 36 | 37 | 38 | Description of the option (human readable) 39 | 40 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_camera_1_1_position.md: -------------------------------------------------------------------------------- 1 | # mavsdk::Camera::Position Struct Reference 2 | `#include: camera.h` 3 | 4 | ---- 5 | 6 | 7 | [Position](structmavsdk_1_1_camera_1_1_position.md) type in global coordinates. 8 | 9 | 10 | ## Data Fields 11 | 12 | 13 | double [latitude_deg](#structmavsdk_1_1_camera_1_1_position_1a6f8941d78449d5228fa43fe8c1182317) {} - Latitude in degrees (range: -90 to +90) 14 | 15 | double [longitude_deg](#structmavsdk_1_1_camera_1_1_position_1a7b464ed04437649533787e1442400264) {} - Longitude in degrees (range: -180 to +180) 16 | 17 | float [absolute_altitude_m](#structmavsdk_1_1_camera_1_1_position_1a543460f2a6039e6be3a4dfe50fd3b2d0) {} - Altitude AMSL (above mean sea level) in metres. 18 | 19 | float [relative_altitude_m](#structmavsdk_1_1_camera_1_1_position_1a07b0b2baef1707c4a99eaa29cd3912dd) {} - Altitude relative to takeoff altitude in metres. 20 | 21 | 22 | ## Field Documentation 23 | 24 | 25 | ### latitude_deg {#structmavsdk_1_1_camera_1_1_position_1a6f8941d78449d5228fa43fe8c1182317} 26 | 27 | ```cpp 28 | double mavsdk::Camera::Position::latitude_deg {} 29 | ``` 30 | 31 | 32 | Latitude in degrees (range: -90 to +90) 33 | 34 | 35 | ### longitude_deg {#structmavsdk_1_1_camera_1_1_position_1a7b464ed04437649533787e1442400264} 36 | 37 | ```cpp 38 | double mavsdk::Camera::Position::longitude_deg {} 39 | ``` 40 | 41 | 42 | Longitude in degrees (range: -180 to +180) 43 | 44 | 45 | ### absolute_altitude_m {#structmavsdk_1_1_camera_1_1_position_1a543460f2a6039e6be3a4dfe50fd3b2d0} 46 | 47 | ```cpp 48 | float mavsdk::Camera::Position::absolute_altitude_m {} 49 | ``` 50 | 51 | 52 | Altitude AMSL (above mean sea level) in metres. 53 | 54 | 55 | ### relative_altitude_m {#structmavsdk_1_1_camera_1_1_position_1a07b0b2baef1707c4a99eaa29cd3912dd} 56 | 57 | ```cpp 58 | float mavsdk::Camera::Position::relative_altitude_m {} 59 | ``` 60 | 61 | 62 | Altitude relative to takeoff altitude in metres. 63 | 64 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_camera_1_1_quaternion.md: -------------------------------------------------------------------------------- 1 | # mavsdk::Camera::Quaternion Struct Reference 2 | `#include: camera.h` 3 | 4 | ---- 5 | 6 | 7 | [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) type. 8 | 9 | 10 | All rotations and axis systems follow the right-hand rule. The Hamilton quaternion product definition is used. A zero-rotation quaternion is represented by (1,0,0,0). The quaternion could also be written as w + xi + yj + zk. 11 | 12 | 13 | For more info see: [https://en.wikipedia.org/wiki/Quaternion](https://en.wikipedia.org/wiki/Quaternion) 14 | 15 | 16 | ## Data Fields 17 | 18 | 19 | float [w](#structmavsdk_1_1_camera_1_1_quaternion_1a1521eb9ca360cd59714a6dd0a38e8c74) {} - [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) entry 0, also denoted as a. 20 | 21 | float [x](#structmavsdk_1_1_camera_1_1_quaternion_1a1a8f92a67b3b55313dce82c214b66a86) {} - [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) entry 1, also denoted as b. 22 | 23 | float [y](#structmavsdk_1_1_camera_1_1_quaternion_1ab6e0c3eb312bc4f1c111b9f63ec41b79) {} - [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) entry 2, also denoted as c. 24 | 25 | float [z](#structmavsdk_1_1_camera_1_1_quaternion_1a03afdb3eed56e43d51d183f5d087d552) {} - [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) entry 3, also denoted as d. 26 | 27 | 28 | ## Field Documentation 29 | 30 | 31 | ### w {#structmavsdk_1_1_camera_1_1_quaternion_1a1521eb9ca360cd59714a6dd0a38e8c74} 32 | 33 | ```cpp 34 | float mavsdk::Camera::Quaternion::w {} 35 | ``` 36 | 37 | 38 | [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) entry 0, also denoted as a. 39 | 40 | 41 | ### x {#structmavsdk_1_1_camera_1_1_quaternion_1a1a8f92a67b3b55313dce82c214b66a86} 42 | 43 | ```cpp 44 | float mavsdk::Camera::Quaternion::x {} 45 | ``` 46 | 47 | 48 | [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) entry 1, also denoted as b. 49 | 50 | 51 | ### y {#structmavsdk_1_1_camera_1_1_quaternion_1ab6e0c3eb312bc4f1c111b9f63ec41b79} 52 | 53 | ```cpp 54 | float mavsdk::Camera::Quaternion::y {} 55 | ``` 56 | 57 | 58 | [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) entry 2, also denoted as c. 59 | 60 | 61 | ### z {#structmavsdk_1_1_camera_1_1_quaternion_1a03afdb3eed56e43d51d183f5d087d552} 62 | 63 | ```cpp 64 | float mavsdk::Camera::Quaternion::z {} 65 | ``` 66 | 67 | 68 | [Quaternion](structmavsdk_1_1_camera_1_1_quaternion.md) entry 3, also denoted as d. 69 | 70 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_camera_1_1_setting.md: -------------------------------------------------------------------------------- 1 | # mavsdk::Camera::Setting Struct Reference 2 | `#include: camera.h` 3 | 4 | ---- 5 | 6 | 7 | Type to represent a setting with a selected option. 8 | 9 | 10 | ## Data Fields 11 | 12 | 13 | std::string [setting_id](#structmavsdk_1_1_camera_1_1_setting_1a8dcb34e9a21bc0c72a38ff918d7d9efa) {} - Name of a setting (machine readable) 14 | 15 | std::string [setting_description](#structmavsdk_1_1_camera_1_1_setting_1a6a86a6d058b991d6df42b881315ace6c) {} - Description of the setting (human readable). This field is meant to be read from the drone, ignore it when setting. 16 | 17 | [Option](structmavsdk_1_1_camera_1_1_option.md) [option](#structmavsdk_1_1_camera_1_1_setting_1a7ae3fde46fe0446a52563e521ea3d3e7) {} - Selected option. 18 | 19 | bool [is_range](#structmavsdk_1_1_camera_1_1_setting_1ac11ee3ca5ed15460b27409a9d516a759) {} - If option is given as a range. This field is meant to be read from the drone, ignore it when setting. 20 | 21 | 22 | ## Field Documentation 23 | 24 | 25 | ### setting_id {#structmavsdk_1_1_camera_1_1_setting_1a8dcb34e9a21bc0c72a38ff918d7d9efa} 26 | 27 | ```cpp 28 | std::string mavsdk::Camera::Setting::setting_id {} 29 | ``` 30 | 31 | 32 | Name of a setting (machine readable) 33 | 34 | 35 | ### setting_description {#structmavsdk_1_1_camera_1_1_setting_1a6a86a6d058b991d6df42b881315ace6c} 36 | 37 | ```cpp 38 | std::string mavsdk::Camera::Setting::setting_description {} 39 | ``` 40 | 41 | 42 | Description of the setting (human readable). This field is meant to be read from the drone, ignore it when setting. 43 | 44 | 45 | ### option {#structmavsdk_1_1_camera_1_1_setting_1a7ae3fde46fe0446a52563e521ea3d3e7} 46 | 47 | ```cpp 48 | Option mavsdk::Camera::Setting::option {} 49 | ``` 50 | 51 | 52 | Selected option. 53 | 54 | 55 | ### is_range {#structmavsdk_1_1_camera_1_1_setting_1ac11ee3ca5ed15460b27409a9d516a759} 56 | 57 | ```cpp 58 | bool mavsdk::Camera::Setting::is_range {} 59 | ``` 60 | 61 | 62 | If option is given as a range. This field is meant to be read from the drone, ignore it when setting. 63 | 64 | -------------------------------------------------------------------------------- /en/cpp/api_reference/structmavsdk_1_1_camera_1_1_setting_options.md: -------------------------------------------------------------------------------- 1 | # mavsdk::Camera::SettingOptions Struct Reference 2 | `#include: camera.h` 3 | 4 | ---- 5 | 6 | 7 | Type to represent a setting with a list of options to choose from. 8 | 9 | 10 | ## Data Fields 11 | 12 | 13 | std::string [setting_id](#structmavsdk_1_1_camera_1_1_setting_options_1aca647af6e140ee78b41d85565d673f14) {} - Name of the setting (machine readable) 14 | 15 | std::string [setting_description](#structmavsdk_1_1_camera_1_1_setting_options_1a8902e7f9dfc25ee9c8363cf5f4775b92) {} - Description of the setting (human readable) 16 | 17 | std::vector< [Option](structmavsdk_1_1_camera_1_1_option.md) > [options](#structmavsdk_1_1_camera_1_1_setting_options_1a06b292df50c638625ef942b1a19917c3) {} - List of options or if range [min, max] or [min, max, interval]. 18 | 19 | bool [is_range](#structmavsdk_1_1_camera_1_1_setting_options_1af6459fc1e354ec95f67f07248242a3b7) {} - If option is given as a range. 20 | 21 | 22 | ## Field Documentation 23 | 24 | 25 | ### setting_id {#structmavsdk_1_1_camera_1_1_setting_options_1aca647af6e140ee78b41d85565d673f14} 26 | 27 | ```cpp 28 | std::string mavsdk::Camera::SettingOptions::setting_id {} 29 | ``` 30 | 31 | 32 | Name of the setting (machine readable) 33 | 34 | 35 | ### setting_description {#structmavsdk_1_1_camera_1_1_setting_options_1a8902e7f9dfc25ee9c8363cf5f4775b92} 36 | 37 | ```cpp 38 | std::string mavsdk::Camera::SettingOptions::setting_description {} 39 | ``` 40 | 41 | 42 | Description of the setting (human readable) 43 | 44 | 45 | ### options {#structmavsdk_1_1_camera_1_1_setting_options_1a06b292df50c638625ef942b1a19917c3} 46 | 47 | ```cpp 48 | std::vector