ziyan_waypoint_v2.h
4.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
/**
********************************************************************
* @file ziyan_waypoint_v2.h
* @brief This is the header file for "ziyan_waypoint_v2.c", defining the structure and
* (exported) function prototypes.
*
* @copyright (c) 2021 ZIYAN. All rights reserved.
*
* All information contained herein is, and remains, the property of ZIYAN.
* The intellectual and technical concepts contained herein are proprietary
* to ZIYAN and may be covered by U.S. and foreign patents, patents in process,
* and protected by trade secret or copyright law. Dissemination of this
* information, including but not limited to data and other proprietary
* material(s) incorporated within the information, in any form, is strictly
* prohibited without the express written consent of ZIYAN.
*
* If you receive this source code without ZIYAN’s authorization, you may not
* further disseminate the information, and you must immediately remove the
* source code and notify ZIYAN of its removal. ZIYAN reserves the right to pursue
* legal actions against you for any loss(es) or damage(s) caused by your
* failure to do so.
*
*********************************************************************
*/
/* Define to prevent recursive inclusion -------------------------------------*/
#ifndef ZIYAN_WAYPOINT_V2_H
#define ZIYAN_WAYPOINT_V2_H
/* Includes ------------------------------------------------------------------*/
#include "ziyan_typedef.h"
#include "ziyan_waypoint_v2_type.h"
#ifdef __cplusplus
extern "C" {
#endif
/* Exported constants --------------------------------------------------------*/
/* Exported types ------------------------------------------------------------*/
typedef T_ZiyanReturnCode (*WaypointV2EventCbFunc)(T_ZiyanWaypointV2MissionEventPush eventData);
typedef T_ZiyanReturnCode (*WaypointV2StateCbFunc)(T_ZiyanWaypointV2MissionStatePush stateData);
/* Exported functions --------------------------------------------------------*/
/**
* @brief Initialise waypoint v2 module, and user should call this function
* before using waypoint v2 features.
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_Init(void);
/**
* @brief Deinitialise waypoint v2 module.
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_Deinit(void);
/**
* @brief Init waypoint v2 mission settings
* @param info: see reference of T_ZiyanWayPointV2MissionSettings.
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_UploadMission(const T_ZiyanWayPointV2MissionSettings *info);
/**
* @brief Start execute waypoint v2 mission
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_Start(void);
/**
* @brief Stop execute waypoint v2 mission
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_Stop(void);
/**
* @brief Pause execute waypoint v2 mission
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_Pause(void);
/**
* @brief Resume execute waypoint v2 mission
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_Resume(void);
/**
* @brief Get the global cruise speed setting from flight controller
* @param cruiseSpeed: see references of T_ZiyanWaypointV2GlobalCruiseSpeed.
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_GetGlobalCruiseSpeed(T_ZiyanWaypointV2GlobalCruiseSpeed *cruiseSpeed);
/**
* @brief Set the global cruise speed setting to flight controller
* @param cruiseSpeed: see references of T_ZiyanWaypointV2GlobalCruiseSpeed.
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_SetGlobalCruiseSpeed(T_ZiyanWaypointV2GlobalCruiseSpeed cruiseSpeed);
/**
* @brief Subscribe to waypointV2 event with a callback function.
* @note There will be data when the event is triggered.
* @param callback: see references of WaypointV2EventCbFunc.
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_RegisterMissionEventCallback(WaypointV2EventCbFunc callback);
/**
* @brief Subscribe to waypointV2 mission state with a callback function.
* @note Data is pushed with a frequency of 10Hz.
* @param callback: see references of WaypointV2StateCbFunc.
* @return Execution result.
*/
T_ZiyanReturnCode ZiyanWaypointV2_RegisterMissionStateCallback(WaypointV2StateCbFunc callback);
#ifdef __cplusplus
}
#endif
#endif // ZIYAN_WAYPOINT_V2_H
/************************ (C) COPYRIGHT ZIYAN Innovations *******END OF FILE******/