-
-
Notifications
You must be signed in to change notification settings - Fork 530
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: general pass through docs (WIP)
- Loading branch information
Showing
40 changed files
with
915 additions
and
948 deletions.
There are no files selected for viewing
78 changes: 39 additions & 39 deletions
78
docs/en/cpp/api_reference/structmavsdk_1_1_info_1_1_identification.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# mavsdk::Info::Identification Struct Reference | ||
`#include: info.h` | ||
|
||
---- | ||
|
||
|
||
[System](classmavsdk_1_1_system.md) identification. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [hardware_uid](#structmavsdk_1_1_info_1_1_identification_1a68be9823aae193b5473191d287b5e385) {} - UID of the hardware. This refers to uid2 of MAVLink. If the system does not support uid2 yet, this is all zeros. | ||
|
||
uint64_t [legacy_uid](#structmavsdk_1_1_info_1_1_identification_1a2429c1ffc3fbda0d55e85fa5a6f79dc1) {} - Legacy UID of the hardware, referred to as uid in MAVLink (formerly exposed during system discovery as UUID). | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### hardware_uid {#structmavsdk_1_1_info_1_1_identification_1a68be9823aae193b5473191d287b5e385} | ||
|
||
```cpp | ||
std::string mavsdk::Info::Identification::hardware_uid {} | ||
``` | ||
|
||
|
||
UID of the hardware. This refers to uid2 of MAVLink. If the system does not support uid2 yet, this is all zeros. | ||
|
||
|
||
### legacy_uid {#structmavsdk_1_1_info_1_1_identification_1a2429c1ffc3fbda0d55e85fa5a6f79dc1} | ||
|
||
```cpp | ||
uint64_t mavsdk::Info::Identification::legacy_uid {} | ||
``` | ||
|
||
|
||
Legacy UID of the hardware, referred to as uid in MAVLink (formerly exposed during system discovery as UUID). | ||
|
||
# mavsdk::Info::Identification Struct Reference | ||
`#include: info.h` | ||
|
||
---- | ||
|
||
|
||
[System](classmavsdk_1_1_system.md) identification. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [hardware_uid](#structmavsdk_1_1_info_1_1_identification_1a68be9823aae193b5473191d287b5e385) {} - UID of the hardware. This refers to uid2 of MAVLink. If the system does not support uid2 yet, this is all zeros. | ||
|
||
uint64_t [legacy_uid](#structmavsdk_1_1_info_1_1_identification_1a2429c1ffc3fbda0d55e85fa5a6f79dc1) {} - Legacy UID of the hardware, referred to as uid in MAVLink (formerly exposed during system discovery as UUID). | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### hardware_uid {#structmavsdk_1_1_info_1_1_identification_1a68be9823aae193b5473191d287b5e385} | ||
|
||
```cpp | ||
std::string mavsdk::Info::Identification::hardware_uid {} | ||
``` | ||
|
||
|
||
UID of the hardware. This refers to uid2 of MAVLink. If the system does not support uid2 yet, this is all zeros. | ||
|
||
|
||
### legacy_uid {#structmavsdk_1_1_info_1_1_identification_1a2429c1ffc3fbda0d55e85fa5a6f79dc1} | ||
|
||
```cpp | ||
uint64_t mavsdk::Info::Identification::legacy_uid {} | ||
``` | ||
|
||
|
||
Legacy UID of the hardware, referred to as uid in MAVLink (formerly exposed during system discovery as UUID). | ||
|
78 changes: 39 additions & 39 deletions
78
docs/en/cpp/api_reference/structmavsdk_1_1_param_1_1_float_param.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# mavsdk::Param::FloatParam Struct Reference | ||
`#include: param.h` | ||
|
||
---- | ||
|
||
|
||
Type for float parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_1_1_float_param_1a64b1dd40eb04c1fa8f9de7ad2c868a3f) {} - Name of the parameter. | ||
|
||
float [value](#structmavsdk_1_1_param_1_1_float_param_1a65d2f28d30739bfb8b1ceb8785c51f66) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_1_1_float_param_1a64b1dd40eb04c1fa8f9de7ad2c868a3f} | ||
|
||
```cpp | ||
std::string mavsdk::Param::FloatParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_1_1_float_param_1a65d2f28d30739bfb8b1ceb8785c51f66} | ||
|
||
```cpp | ||
float mavsdk::Param::FloatParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
||
# mavsdk::Param::FloatParam Struct Reference | ||
`#include: param.h` | ||
|
||
---- | ||
|
||
|
||
Type for float parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_1_1_float_param_1a64b1dd40eb04c1fa8f9de7ad2c868a3f) {} - Name of the parameter. | ||
|
||
float [value](#structmavsdk_1_1_param_1_1_float_param_1a65d2f28d30739bfb8b1ceb8785c51f66) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_1_1_float_param_1a64b1dd40eb04c1fa8f9de7ad2c868a3f} | ||
|
||
```cpp | ||
std::string mavsdk::Param::FloatParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_1_1_float_param_1a65d2f28d30739bfb8b1ceb8785c51f66} | ||
|
||
```cpp | ||
float mavsdk::Param::FloatParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
78 changes: 39 additions & 39 deletions
78
docs/en/cpp/api_reference/structmavsdk_1_1_param_server_1_1_float_param.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# mavsdk::ParamServer::FloatParam Struct Reference | ||
`#include: param_server.h` | ||
|
||
---- | ||
|
||
|
||
Type for float parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_server_1_1_float_param_1a3988384276ac7ffad9bede8d60a8b50e) {} - Name of the parameter. | ||
|
||
float [value](#structmavsdk_1_1_param_server_1_1_float_param_1a515a8aef124b471b4763bad39015d536) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_server_1_1_float_param_1a3988384276ac7ffad9bede8d60a8b50e} | ||
|
||
```cpp | ||
std::string mavsdk::ParamServer::FloatParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_server_1_1_float_param_1a515a8aef124b471b4763bad39015d536} | ||
|
||
```cpp | ||
float mavsdk::ParamServer::FloatParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
||
# mavsdk::ParamServer::FloatParam Struct Reference | ||
`#include: param_server.h` | ||
|
||
---- | ||
|
||
|
||
Type for float parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_server_1_1_float_param_1a3988384276ac7ffad9bede8d60a8b50e) {} - Name of the parameter. | ||
|
||
float [value](#structmavsdk_1_1_param_server_1_1_float_param_1a515a8aef124b471b4763bad39015d536) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_server_1_1_float_param_1a3988384276ac7ffad9bede8d60a8b50e} | ||
|
||
```cpp | ||
std::string mavsdk::ParamServer::FloatParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_server_1_1_float_param_1a515a8aef124b471b4763bad39015d536} | ||
|
||
```cpp | ||
float mavsdk::ParamServer::FloatParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
78 changes: 39 additions & 39 deletions
78
docs/en/cpp/api_reference/structmavsdk_1_1_param_server_1_1_int_param.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,39 +1,39 @@ | ||
# mavsdk::ParamServer::IntParam Struct Reference | ||
`#include: param_server.h` | ||
|
||
---- | ||
|
||
|
||
Type for integer parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_server_1_1_int_param_1aae5236fe2a7753bff87dec3eae56c292) {} - Name of the parameter. | ||
|
||
int32_t [value](#structmavsdk_1_1_param_server_1_1_int_param_1ad826ffbeb58e4d975c60dc355c96ffb2) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_server_1_1_int_param_1aae5236fe2a7753bff87dec3eae56c292} | ||
|
||
```cpp | ||
std::string mavsdk::ParamServer::IntParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_server_1_1_int_param_1ad826ffbeb58e4d975c60dc355c96ffb2} | ||
|
||
```cpp | ||
int32_t mavsdk::ParamServer::IntParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
||
# mavsdk::ParamServer::IntParam Struct Reference | ||
`#include: param_server.h` | ||
|
||
---- | ||
|
||
|
||
Type for integer parameters. | ||
|
||
|
||
## Data Fields | ||
|
||
|
||
std::string [name](#structmavsdk_1_1_param_server_1_1_int_param_1aae5236fe2a7753bff87dec3eae56c292) {} - Name of the parameter. | ||
|
||
int32_t [value](#structmavsdk_1_1_param_server_1_1_int_param_1ad826ffbeb58e4d975c60dc355c96ffb2) {} - Value of the parameter. | ||
|
||
|
||
## Field Documentation | ||
|
||
|
||
### name {#structmavsdk_1_1_param_server_1_1_int_param_1aae5236fe2a7753bff87dec3eae56c292} | ||
|
||
```cpp | ||
std::string mavsdk::ParamServer::IntParam::name {} | ||
``` | ||
|
||
|
||
Name of the parameter. | ||
|
||
|
||
### value {#structmavsdk_1_1_param_server_1_1_int_param_1ad826ffbeb58e4d975c60dc355c96ffb2} | ||
|
||
```cpp | ||
int32_t mavsdk::ParamServer::IntParam::value {} | ||
``` | ||
|
||
|
||
Value of the parameter. | ||
|
Oops, something went wrong.