vzense-sys 0.3.1

Rust abstraction layer for the Vzense SDK C library
Documentation 
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141

#ifndef SCEPTER_MORPH_API_H
#define SCEPTER_MORPH_API_H

/**
 * @file Scepter_Morph_api.h
 * @brief Scepter Morph API header file.
 * Copyright (c) 2024 Goermicro Inc.
 */

/*! \mainpage Scepter Morph API Documentation
 *
 * \section intro_sec Introduction
 *
 * Welcome to the Scepter Morph API documentation. This documentation enables you to quickly get started in your
 * development efforts to programmatically interact with the Scepter Morph .
 */

#include "Scepter_define.h"

typedef enum
{
    AI_CONTINUOUS_RUN_MODE = 0x00,   //!< Enter the continuous mode.
    AI_SINGLE_RUN_MODE     = 0x01,   //!< Enter the single run mode, at this time need to invoke scAIModuleTriggerOnce, to trigger the algo result.
} ScAIModuleMode;

#pragma pack(push, 1)

typedef struct
{
    uint32_t resultIndex;       //!< The index of the AI result.
    uint8_t* pResultData;       //!< A buffer containing the AI result's data.
    uint32_t dataLen;           //!< The length of AI result, in bytes.
    uint64_t resultTimestamp;   //!< The timestamp(in milliseconds) when the AI result be generated on the device AI mode.
} ScAIResult;

#pragma pack(pop)

/**
 * @brief        Set the AI module start or stop working.
 * @param[in]    device          The handle of the device on which to set the AI module state.
 * @param[in]    bEnabled        Set to <code>true</code> to start working or <code>false</code> to stop working.
 * @return       ::SC_OK         If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleSetEnabled(ScDeviceHandle device, bool bEnabled);

/**
 * @brief        Get the AI module working state.
 * @param[in]    device          The handle of the device on which to get the AI module state.
 * @param[out]   pEnabled        Get to <code>true</code> to is working or <code>false</code> to is not working.
 * @return       ::SC_OK         If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleGetEnabled(ScDeviceHandle device, bool* pEnabled);

/**
 * @brief        Set the param for the AI module
 * @param[in]    device          The handle of the device from which to set the param value.
 * @param[in]    paramID         The ID of the parameter.
 * @param[in]    pBuffer         Pointer to a buffer containing the property value.
 * @param[in]    bufferSize      The size, in bytes, of the parameter value contained in pBuffer. The max size is 65535.
 * @return       ::SC_OK         If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleSetParam(ScDeviceHandle device, uint32_t paramID, void* pBuffer, uint16_t bufferSize);

/**
 * @brief        Get the param for the AI module
 * @param[in]    device          The handle of the device from which to get the param value.
 * @param[in]    paramID         The ID of the parameter.
 * @param[out]   pBuffer         Pointer to a buffer containing the property value.
 * @param[out]   pBufferSize     The size, in bytes, of the buffer.The max size is 65535.
 * @return       ::SC_OK         If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleGetParam(ScDeviceHandle device, uint32_t paramID, void** pBuffer, uint16_t* pBufferSize);

/**
 * @brief        Set the working mode of the AI module.
 * @param[in]    device      The handle of the device.
 * @param[in]    mode        The mode defined by ::ScAIModuleMode.
 * @return       ::SC_OK     If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleSetWorkMode(ScDeviceHandle device, ScAIModuleMode mode);

/**
 * @brief        Gets the working mode of the AI module.
 * @param[in]    device      The handle of the device.
 * @param[out]   mode        The mode defined by ::ScAIModuleMode.
 * @return       ::SC_OK     If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleGetWorkMode(ScDeviceHandle device, ScAIModuleMode* mode);

/**
 * @brief        Do trigger once if the AI module is in AI_SINGLE_RUN_MODE.
 * @param[in]    device      The handle of the device.
 * @return       ::SC_OK     If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleTriggerOnce(ScDeviceHandle device);

/**
 * @brief        Enables or disables the frame, true: do algorithm with the frameType
 * @param[in]    device       The handle of the device.
 * @param[in]    frameType    The type defined by ::ScFrameType.
 * @param[in]    bEnabled     Set to <code>true</code> to enable the feature or <code>false</code> to disable the feature.
 * @return       ::SC_OK      If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleSetInputFrameTypeEnabled(ScDeviceHandle device, ScFrameType frameType, bool bEnabled);

/**
 * @brief        Get the frame is enables or disables , true: do AI mode with the frameType
 * @param[in]    device       The handle of the device.
 * @param[in]    frameType    The type defined by ::ScFrameType.
 * @param[out]   pEnabled     Get to <code>true</code> to enable the feature or <code>false</code> to disable the feature.
 * @return       ::SC_OK      If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleGetInputFrameTypeEnabled(ScDeviceHandle device, ScFrameType frameType, bool* pEnabled);

/**
 * @brief        Enables or disables the frame, true: the frameType can be getted from the device
 * @param[in]    device       The handle of the device.
 * @param[in]    frameType    The type defined by ::ScFrameType.
 * @param[in]    bEnabled     Set to <code>true</code> to enable the feature or <code>false</code> to disable the feature.
 * @return       ::SC_OK      If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleSetPreviewFrameTypeEnabled(ScDeviceHandle device, ScFrameType frameType, bool bEnabled);

/**
 * @brief        Get the frame is enables or disables , true: the frameType can be getted from the device
 * @param[in]    device       The handle of the device.
 * @param[in]    frameType    The type defined by ::ScFrameType.
 * @param[out]   pEnabled     Get to <code>true</code> to enable the feature or <code>false</code> to disable the feature.
 * @return       ::SC_OK      If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleGetPreviewFrameTypeEnabled(ScDeviceHandle device, ScFrameType frameType, bool* pEnabled);

/**
 * @brief        Get the result of the AI mode
 * @param[in]    device       The handle of the device.
 * @param[in]    waitTime     The unit is millisecond, the value is in the range (0,65535).
 * @param[out]   pAIResult    Pointer to a buffer in which to store the signal on which AI result is ready to be get.
 * @return       ::SC_OK      If the function succeeded, or one of the error values defined by ::ScStatus.
 */
SCEPTER_C_API_EXPORT ScStatus scAIModuleGetResult(ScDeviceHandle device, uint16_t waitTime, ScAIResult* pAIResult);
#endif /* SCEPTER_MORPH_API_H */