Files
Payload-SDK/psdk_lib/api_headers/psdk_core.h
2022-01-12 21:44:58 +08:00

83 lines
4.1 KiB
C
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

/**
********************************************************************
* @file psdk_core.h
* @brief This is the header file for "psdk_core.c", defining the structure and
* (exported) function prototypes.
*
* @copyright (c) 2018 DJI. All rights reserved.
*
* All information contained herein is, and remains, the property of DJI.
* The intellectual and technical concepts contained herein are proprietary
* to DJI 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 DJI.
*
* If you receive this source code without DJIs authorization, you may not
* further disseminate the information, and you must immediately remove the
* source code and notify DJI of its removal. DJI 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 PSDK_CORE_H
#define PSDK_CORE_H
/* Includes ------------------------------------------------------------------*/
#include "psdk_typedef.h"
#ifdef __cplusplus
extern "C" {
#endif
/* Exported constants --------------------------------------------------------*/
/* Exported types ------------------------------------------------------------*/
typedef struct {
char appName[32]; /*!< Specifies Payload SDK app name. This info can be obtained by logging in to the
developer website https://developer.dji.com/payload-sdk. End with '\0'. */
char appId[16]; /*!< Specifies Payload SDK app ID. This info can be obtained by logging in to the
developer website https://developer.dji.com/payload-sdk. */
char appKey[32]; /*!< Specifies Payload SDK app key. This info can be obtained by logging in to the
developer website https://developer.dji.com/payload-sdk. */
char developerAccount[64]; /*!< Specifies Payload SDK developer account email. This info can be obtained by
logging in to the developer website https://developer.dji.com/payload-sdk.
Developer's account and other related information need to be able to correspond.
End with '\0'. */
} T_PsdkUserInfo;
/* Exported functions --------------------------------------------------------*/
/**
* @brief Initialize the Payload SDK core in blocking mode.
* @note The call location of this interface requires special attention, The call needs to be completed after the
* registration of console/OSAL handler functions/HAL handler functions are completed. At the same time, it must be
* initialized at the beginning of calling other functional module interfaces. You need to fill in the developer
* information correctly to ensure the initialization is successful. For additional instructions, please refer to the
* tutorial“PSDK Initialization”.
* @note This function does not return until the correct aircraft type and PSDK adapter type is obtained. The logic ensures
* that aircraft and PSDK adapter have been started up normally before PSDK functional module and user's program run.
* General execution time of this function is 2~4 seconds.
* @param userInfo: pointer to the PSDK application information.
* @return Execution result.
*/
T_PsdkReturnCode PsdkCore_Init(const T_PsdkUserInfo *userInfo);
/**
* @brief Notify that the Payload SDK core application starts.
* @note The call location of this interface requires special attention, The call needs to be completed after all the
* module initialize and register interfaces.
* @return Execution result.
*/
T_PsdkReturnCode PsdkCore_ApplicationStart(void);
#ifdef __cplusplus
}
#endif
#endif //PSDK_CORE_H
/************************ (C) COPYRIGHT DJI Innovations *******END OF FILE******/