TYApi.h 86 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913
  1. /**@file TYApi.h
  2. * @brief TYApi.h includes camera control and data receiving interface,
  3. * which supports configuration for image resolution, frame rate, exposure
  4. * time, gain, working mode,etc.
  5. *
  6. */
  7. /**@mainpage
  8. *
  9. * Copyright(C)2016-2023 Percipio All Rights Reserved
  10. *
  11. *
  12. *
  13. * @section Note
  14. * Depth camera, called "device", consists of several components. Each component
  15. * is a hardware module or virtual module, such as RGB sensor, depth sensor.
  16. * Each component has its own features, such as image width, exposure time, etc..
  17. *
  18. * NOTE: The component TY_COMPONENT_DEVICE is a virtual component that contains
  19. * all features related to the whole device, such as trigger mode, device IP.
  20. *
  21. * Each frame consists of several images. Normally, all the images have identical
  22. * timestamp, means they are captured at the same time.
  23. *
  24. * */
  25. #ifndef TY_API_H_
  26. #define TY_API_H_
  27. #include <stddef.h>
  28. #include <stdlib.h>
  29. #ifdef WIN32
  30. # ifndef _WIN32
  31. # define _WIN32
  32. # endif
  33. #endif
  34. #ifdef _WIN32
  35. # ifndef _STDINT_H
  36. # if defined(_MSC_VER) && _MSC_VER < 1600
  37. typedef __int8 int8_t;
  38. typedef __int16 int16_t;
  39. typedef __int32 int32_t;
  40. typedef __int64 int64_t;
  41. typedef unsigned __int8 uint8_t;
  42. typedef unsigned __int16 uint16_t;
  43. typedef unsigned __int32 uint32_t;
  44. typedef unsigned __int64 uint64_t;
  45. # else
  46. # include <stdint.h>
  47. # endif
  48. # endif
  49. #else
  50. # include <stdint.h>
  51. #endif
  52. // copy stdbool.h here in case bool not defined or <stdbool.h> cant be found
  53. #ifndef _STDBOOL_H
  54. # define _STDBOOL_H
  55. # define __bool_true_false_are_defined 1
  56. # ifndef __cplusplus
  57. # define bool _Bool
  58. # define true 1
  59. # define false 0
  60. # endif
  61. #endif
  62. #ifdef _WIN32
  63. # include <WinSock2.h>
  64. # include <Windows.h>
  65. # ifdef TY_STATIC_LIB
  66. # define TY_DLLIMPORT
  67. # define TY_DLLEXPORT
  68. # else
  69. # define TY_DLLIMPORT __declspec(dllimport)
  70. # define TY_DLLEXPORT __declspec(dllexport)
  71. # endif
  72. # define TY_STDC __stdcall
  73. # define TY_CDEC __cdecl
  74. # ifdef RGB
  75. # undef RGB
  76. # endif
  77. #else
  78. # ifdef TY_STATIC_LIB
  79. # define TY_DLLIMPORT
  80. # define TY_DLLEXPORT
  81. # else
  82. # define TY_DLLIMPORT __attribute__((visibility("default")))
  83. # define TY_DLLEXPORT __attribute__((visibility("default")))
  84. # endif
  85. # if defined(__i386__)
  86. # define TY_STDC __attribute__((stdcall))
  87. # define TY_CDEC __attribute__((cdecl))
  88. # else
  89. # define TY_STDC
  90. # define TY_CDEC
  91. # endif
  92. #endif
  93. #ifdef TY_BUILDING_LIB
  94. # define TY_EXPORT TY_DLLEXPORT
  95. #else
  96. # define TY_EXPORT TY_DLLIMPORT
  97. #endif
  98. #if !defined(TY_EXTC)
  99. # if defined(__cplusplus)
  100. # define TY_EXTC extern "C"
  101. # else
  102. # define TY_EXTC
  103. # endif
  104. #endif
  105. #include "TYVer.h"
  106. //------------------------------------------------------------------------------
  107. ///@brief API call return status
  108. typedef enum TY_STATUS_LIST :int32_t
  109. {
  110. TY_STATUS_OK = 0,
  111. TY_STATUS_ERROR = -1001,
  112. TY_STATUS_NOT_INITED = -1002,
  113. TY_STATUS_NOT_IMPLEMENTED = -1003,
  114. TY_STATUS_NOT_PERMITTED = -1004,
  115. TY_STATUS_DEVICE_ERROR = -1005,
  116. TY_STATUS_INVALID_PARAMETER = -1006,
  117. TY_STATUS_INVALID_HANDLE = -1007,
  118. TY_STATUS_INVALID_COMPONENT = -1008,
  119. TY_STATUS_INVALID_FEATURE = -1009,
  120. TY_STATUS_WRONG_TYPE = -1010,
  121. TY_STATUS_WRONG_SIZE = -1011,
  122. TY_STATUS_OUT_OF_MEMORY = -1012,
  123. TY_STATUS_OUT_OF_RANGE = -1013,
  124. TY_STATUS_TIMEOUT = -1014,
  125. TY_STATUS_WRONG_MODE = -1015,
  126. TY_STATUS_BUSY = -1016,
  127. TY_STATUS_IDLE = -1017,
  128. TY_STATUS_NO_DATA = -1018,
  129. TY_STATUS_NO_BUFFER = -1019,
  130. TY_STATUS_NULL_POINTER = -1020,
  131. TY_STATUS_READONLY_FEATURE = -1021,
  132. TY_STATUS_INVALID_DESCRIPTOR= -1022,
  133. TY_STATUS_INVALID_INTERFACE = -1023,
  134. TY_STATUS_FIRMWARE_ERROR = -1024,
  135. /* ret_code from remote device */
  136. TY_STATUS_DEV_EPERM = -1,
  137. TY_STATUS_DEV_EIO = -5,
  138. TY_STATUS_DEV_ENOMEM = -12,
  139. TY_STATUS_DEV_EBUSY = -16,
  140. TY_STATUS_DEV_EINVAL = -22,
  141. /* endof ret_code from remote device */
  142. }TY_STATUS_LIST;
  143. typedef int32_t TY_STATUS;
  144. typedef enum TY_FW_ERRORCODE_LIST:uint32_t
  145. {
  146. TY_FW_ERRORCODE_CAM0_NOT_DETECTED = 0x00000001,
  147. TY_FW_ERRORCODE_CAM1_NOT_DETECTED = 0x00000002,
  148. TY_FW_ERRORCODE_CAM2_NOT_DETECTED = 0x00000004,
  149. TY_FW_ERRORCODE_POE_NOT_INIT = 0x00000008,
  150. TY_FW_ERRORCODE_RECMAP_NOT_CORRECT = 0x00000010,
  151. TY_FW_ERRORCODE_LOOKUPTABLE_NOT_CORRECT = 0x00000020,
  152. TY_FW_ERRORCODE_DRV8899_NOT_INIT = 0x00000040,
  153. TY_FW_ERRORCODE_CONFIG_NOT_FOUND = 0x00010000,
  154. TY_FW_ERRORCODE_CONFIG_NOT_CORRECT = 0x00020000,
  155. TY_FW_ERRORCODE_XML_NOT_FOUND = 0x00040000,
  156. TY_FW_ERRORCODE_XML_NOT_CORRECT = 0x00080000,
  157. TY_FW_ERRORCODE_XML_OVERRIDE_FAILED = 0x00100000,
  158. TY_FW_ERRORCODE_CAM_INIT_FAILED = 0x00200000,
  159. TY_FW_ERRORCODE_LASER_INIT_FAILED = 0x00400000,
  160. }TY_FW_ERRORCODE_LIST;
  161. typedef uint32_t TY_FW_ERRORCODE;
  162. typedef enum TY_EVENT_LIST :int32_t
  163. {
  164. TY_EVENT_DEVICE_OFFLINE = -2001,
  165. TY_EVENT_LICENSE_ERROR = -2002,
  166. TY_EVENT_FW_INIT_ERROR = -2003,
  167. }TY_ENENT_LIST;
  168. typedef int32_t TY_EVENT;
  169. typedef void* TY_INTERFACE_HANDLE; ///<Interface handle
  170. typedef void* TY_DEV_HANDLE;///<Device Handle
  171. ///@breif Device Component list
  172. /// A device contains several component.
  173. /// Each component can be controlled by its own features, such as image width, exposure time, etc..
  174. ///@see To Know how to get feature information please refer to sample code DumpAllFeatures
  175. typedef enum TY_DEVICE_COMPONENT_LIST :uint32_t
  176. {
  177. TY_COMPONENT_DEVICE = 0x80000000, ///< Abstract component stands for whole device, always enabled
  178. TY_COMPONENT_DEPTH_CAM = 0x00010000, ///< Depth camera
  179. TY_COMPONENT_IR_CAM_LEFT = 0x00040000, ///< Left IR camera
  180. TY_COMPONENT_IR_CAM_RIGHT = 0x00080000, ///< Right IR camera
  181. TY_COMPONENT_RGB_CAM_LEFT = 0x00100000, ///< Left RGB camera
  182. TY_COMPONENT_RGB_CAM_RIGHT = 0x00200000, ///< Right RGB camera
  183. TY_COMPONENT_LASER = 0x00400000, ///< Laser
  184. TY_COMPONENT_IMU = 0x00800000, ///< Inertial Measurement Unit
  185. TY_COMPONENT_BRIGHT_HISTO = 0x01000000, ///< virtual component for brightness histogram of ir
  186. TY_COMPONENT_STORAGE = 0x02000000, ///< virtual component for device storage
  187. TY_COMPONENT_RGB_CAM = TY_COMPONENT_RGB_CAM_LEFT ///< Some device has only one RGB camera, map it to left
  188. }TY_DEVICE_COMPONENT_LIST;
  189. typedef uint32_t TY_COMPONENT_ID;///< component unique id @see TY_DEVICE_COMPONENT_LIST
  190. //------------------------------------------------------------------------------
  191. ///Feature Format Type definitions
  192. typedef enum TY_FEATURE_TYPE_LIST :uint32_t
  193. {
  194. TY_FEATURE_INT = 0x1000,
  195. TY_FEATURE_FLOAT = 0X2000,
  196. TY_FEATURE_ENUM = 0x3000,
  197. TY_FEATURE_BOOL = 0x4000,
  198. TY_FEATURE_STRING = 0x5000,
  199. TY_FEATURE_BYTEARRAY = 0x6000,
  200. TY_FEATURE_STRUCT = 0x7000,
  201. }TY_FEATURE_TYPE_LIST;
  202. typedef uint32_t TY_FEATURE_TYPE;
  203. ///feature for component definitions
  204. typedef enum TY_FEATURE_ID_LIST :uint32_t
  205. {
  206. TY_STRUCT_CAM_INTRINSIC = 0x0000 | TY_FEATURE_STRUCT, ///< see TY_CAMERA_INTRINSIC
  207. TY_STRUCT_EXTRINSIC_TO_DEPTH = 0x0001 | TY_FEATURE_STRUCT, ///< extrinsic between depth cam and current component , see TY_CAMERA_EXTRINSIC
  208. TY_STRUCT_EXTRINSIC_TO_IR_LEFT = 0x0002 | TY_FEATURE_STRUCT, ///< extrinsic between left IR and current compoent, see TY_CAMERA_EXTRINSIC
  209. TY_STRUCT_CAM_DISTORTION = 0x0006 | TY_FEATURE_STRUCT, ///< see TY_CAMERA_DISTORTION
  210. TY_STRUCT_CAM_CALIB_DATA = 0x0007 | TY_FEATURE_STRUCT, ///< see TY_CAMERA_CALIB_INFO
  211. TY_STRUCT_CAM_RECTIFIED_INTRI = 0x0008 | TY_FEATURE_STRUCT, ///< the rectified intrinsic. see TY_CAMERA_INTRINSIC
  212. TY_BYTEARRAY_CUSTOM_BLOCK = 0x000A | TY_FEATURE_BYTEARRAY, ///< used for reading/writing custom block
  213. TY_BYTEARRAY_ISP_BLOCK = 0x000B | TY_FEATURE_BYTEARRAY, ///< used for reading/writing fpn block
  214. TY_INT_PERSISTENT_IP = 0x0010 | TY_FEATURE_INT,
  215. TY_INT_PERSISTENT_SUBMASK = 0x0011 | TY_FEATURE_INT,
  216. TY_INT_PERSISTENT_GATEWAY = 0x0012 | TY_FEATURE_INT,
  217. TY_BOOL_GVSP_RESEND = 0x0013 | TY_FEATURE_BOOL,
  218. TY_INT_PACKET_DELAY = 0x0014 | TY_FEATURE_INT, ///< microseconds
  219. TY_INT_ACCEPTABLE_PERCENT = 0x0015 | TY_FEATURE_INT,
  220. TY_INT_NTP_SERVER_IP = 0x0016 | TY_FEATURE_INT, ///< Ntp server IP
  221. TY_INT_PACKET_SIZE = 0x0017 | TY_FEATURE_INT,
  222. TY_INT_LINK_CMD_TIMEOUT = 0x0018 | TY_FEATURE_INT, ///< milliseconds
  223. TY_STRUCT_CAM_STATISTICS = 0x00ff | TY_FEATURE_STRUCT, ///< statistical information, see TY_CAMERA_STATISTICS
  224. TY_INT_WIDTH_MAX = 0x0100 | TY_FEATURE_INT,
  225. TY_INT_HEIGHT_MAX = 0x0101 | TY_FEATURE_INT,
  226. TY_INT_OFFSET_X = 0x0102 | TY_FEATURE_INT,
  227. TY_INT_OFFSET_Y = 0x0103 | TY_FEATURE_INT,
  228. TY_INT_WIDTH = 0x0104 | TY_FEATURE_INT, ///< Image width
  229. TY_INT_HEIGHT = 0x0105 | TY_FEATURE_INT, ///< Image height
  230. TY_ENUM_IMAGE_MODE = 0x0109 | TY_FEATURE_ENUM, ///< Resolution-PixelFromat mode, see TY_IMAGE_MODE_LIST
  231. ///@brief scale unit
  232. ///depth image is uint16 pixel format with default millimeter unit ,for some device can output Sub-millimeter accuracy data
  233. ///the acutal depth (mm)= PixelValue * ScaleUnit
  234. TY_FLOAT_SCALE_UNIT = 0x010a | TY_FEATURE_FLOAT,
  235. TY_ENUM_TRIGGER_POL = 0x0201 | TY_FEATURE_ENUM, ///< Trigger POL, see TY_TRIGGER_POL_LIST
  236. TY_INT_FRAME_PER_TRIGGER = 0x0202 | TY_FEATURE_INT, ///< Number of frames captured per trigger
  237. TY_STRUCT_TRIGGER_PARAM = 0x0523 | TY_FEATURE_STRUCT, ///< param of trigger, see TY_TRIGGER_PARAM
  238. TY_STRUCT_TRIGGER_PARAM_EX = 0x0525 | TY_FEATURE_STRUCT, ///< param of trigger, see TY_TRIGGER_PARAM_EX
  239. TY_STRUCT_TRIGGER_TIMER_LIST = 0x0526 | TY_FEATURE_STRUCT, ///< param of trigger mode 20, see TY_TRIGGER_TIMER_LIST
  240. TY_STRUCT_TRIGGER_TIMER_PERIOD = 0x0527 | TY_FEATURE_STRUCT, ///< param of trigger mode 21, see TY_TRIGGER_TIMER_PERIOD
  241. TY_BOOL_KEEP_ALIVE_ONOFF = 0x0203 | TY_FEATURE_BOOL, ///< Keep Alive switch
  242. TY_INT_KEEP_ALIVE_TIMEOUT = 0x0204 | TY_FEATURE_INT, ///< Keep Alive timeout
  243. TY_BOOL_CMOS_SYNC = 0x0205 | TY_FEATURE_BOOL, ///< Cmos sync switch
  244. TY_INT_TRIGGER_DELAY_US = 0x0206 | TY_FEATURE_INT, ///< Trigger delay time, in microseconds
  245. TY_BOOL_TRIGGER_OUT_IO = 0x0207 | TY_FEATURE_BOOL, ///< Trigger out IO
  246. TY_INT_TRIGGER_DURATION_US = 0x0208 | TY_FEATURE_INT, ///< Trigger duration time, in microseconds
  247. TY_ENUM_STREAM_ASYNC = 0x0209 | TY_FEATURE_ENUM, ///< stream async switch, see TY_STREAM_ASYNC_MODE
  248. TY_INT_CAPTURE_TIME_US = 0x0210 | TY_FEATURE_INT, ///< capture time in multi-ir
  249. TY_ENUM_TIME_SYNC_TYPE = 0x0211 | TY_FEATURE_ENUM, ///< see TY_TIME_SYNC_TYPE
  250. TY_BOOL_TIME_SYNC_READY = 0x0212 | TY_FEATURE_BOOL, ///< time sync done status
  251. TY_BOOL_FLASHLIGHT = 0x0213 | TY_FEATURE_BOOL, ///< flashlight on/off control
  252. TY_INT_FLASHLIGHT_INTENSITY = 0x0214 | TY_FEATURE_INT, ///< flashlight intensity level [0, 63]
  253. TY_STRUCT_DO0_WORKMODE = 0x0215 | TY_FEATURE_STRUCT, ///< DO_0 workmode, see TY_DO_WORKMODE
  254. TY_STRUCT_DI0_WORKMODE = 0x0216 | TY_FEATURE_STRUCT, ///< DI_0 workmode, see TY_DI_WORKMODE
  255. TY_STRUCT_DO1_WORKMODE = 0x0217 | TY_FEATURE_STRUCT, ///< DO_1 workmode, see TY_DO_WORKMODE
  256. TY_STRUCT_DI1_WORKMODE = 0x0218 | TY_FEATURE_STRUCT, ///< DI_1 workmode, see TY_DI_WORKMODE
  257. TY_STRUCT_DO2_WORKMODE = 0x0219 | TY_FEATURE_STRUCT, ///< DO_2 workmode, see TY_DO_WORKMODE
  258. TY_STRUCT_DI2_WORKMODE = 0x0220 | TY_FEATURE_STRUCT, ///< DI_2 workmode, see TY_DI_WORKMODE
  259. TY_BOOL_AUTO_EXPOSURE = 0x0300 | TY_FEATURE_BOOL, ///< Auto exposure switch
  260. TY_INT_EXPOSURE_TIME = 0x0301 | TY_FEATURE_INT, ///< Exposure time in percentage
  261. TY_BOOL_AUTO_GAIN = 0x0302 | TY_FEATURE_BOOL, ///< Auto gain switch
  262. TY_INT_GAIN = 0x0303 | TY_FEATURE_INT, ///< Sensor Gain
  263. TY_BOOL_AUTO_AWB = 0x0304 | TY_FEATURE_BOOL, ///< Auto white balance
  264. TY_STRUCT_AEC_ROI = 0x0305 | TY_FEATURE_STRUCT, ///< region of aec statistics, see TY_AEC_ROI_PARAM
  265. TY_INT_TOF_HDR_RATIO = 0x0306 | TY_FEATURE_INT, ///< tof sensor hdr ratio for depth
  266. TY_INT_TOF_JITTER_THRESHOLD = 0x0307 | TY_FEATURE_INT, ///< tof jitter threshold for depth
  267. TY_INT_LASER_POWER = 0x0500 | TY_FEATURE_INT, ///< Laser power level
  268. TY_BOOL_LASER_AUTO_CTRL = 0x0501 | TY_FEATURE_BOOL, ///< Laser auto ctrl
  269. TY_BOOL_UNDISTORTION = 0x0510 | TY_FEATURE_BOOL, ///< Output undistorted image
  270. TY_BOOL_BRIGHTNESS_HISTOGRAM = 0x0511 | TY_FEATURE_BOOL, ///< Output bright histogram
  271. TY_BOOL_DEPTH_POSTPROC = 0x0512 | TY_FEATURE_BOOL, ///< Do depth image postproc
  272. TY_INT_R_GAIN = 0x0520 | TY_FEATURE_INT, ///< Gain of R channel
  273. TY_INT_G_GAIN = 0x0521 | TY_FEATURE_INT, ///< Gain of G channel
  274. TY_INT_B_GAIN = 0x0522 | TY_FEATURE_INT, ///< Gain of B channel
  275. TY_INT_ANALOG_GAIN = 0x0524 | TY_FEATURE_INT, ///< Analog gain
  276. TY_BOOL_HDR = 0x0525 | TY_FEATURE_BOOL, ///< HDR func enable/disable
  277. TY_BYTEARRAY_HDR_PARAMETER = 0x0526 | TY_FEATURE_BYTEARRAY, ///< HDR parameters
  278. TY_BOOL_IMU_DATA_ONOFF = 0x0600 | TY_FEATURE_BOOL, ///< IMU Data Onoff
  279. TY_STRUCT_IMU_ACC_BIAS = 0x0601 | TY_FEATURE_STRUCT, ///< IMU acc bias matrix, see TY_ACC_BIAS
  280. TY_STRUCT_IMU_ACC_MISALIGNMENT = 0x0602 | TY_FEATURE_STRUCT, ///< IMU acc misalignment matrix, see TY_ACC_MISALIGNMENT
  281. TY_STRUCT_IMU_ACC_SCALE = 0x0603 | TY_FEATURE_STRUCT, ///< IMU acc scale matrix, see TY_ACC_SCALE
  282. TY_STRUCT_IMU_GYRO_BIAS = 0x0604 | TY_FEATURE_STRUCT, ///< IMU gyro bias matrix, see TY_GYRO_BIAS
  283. TY_STRUCT_IMU_GYRO_MISALIGNMENT = 0x0605 | TY_FEATURE_STRUCT, ///< IMU gyro misalignment matrix, see TY_GYRO_MISALIGNMENT
  284. TY_STRUCT_IMU_GYRO_SCALE = 0x0606 | TY_FEATURE_STRUCT, ///< IMU gyro scale matrix, see TY_GYRO_SCALE
  285. TY_STRUCT_IMU_CAM_TO_IMU = 0x0607 | TY_FEATURE_STRUCT, ///< IMU camera to imu matrix, see TY_CAMERA_TO_IMU
  286. TY_ENUM_IMU_FPS = 0x0608 | TY_FEATURE_ENUM, ///< IMU fps, see TY_IMU_FPS_LIST
  287. TY_INT_SGBM_IMAGE_NUM = 0x0610 | TY_FEATURE_INT, ///< SGBM image channel num
  288. TY_INT_SGBM_DISPARITY_NUM = 0x0611 | TY_FEATURE_INT, ///< SGBM disparity num
  289. TY_INT_SGBM_DISPARITY_OFFSET = 0x0612 | TY_FEATURE_INT, ///< SGBM disparity offset
  290. TY_INT_SGBM_MATCH_WIN_HEIGHT = 0x0613 | TY_FEATURE_INT, ///< SGBM match window height
  291. TY_INT_SGBM_SEMI_PARAM_P1 = 0x0614 | TY_FEATURE_INT, ///< SGBM semi global param p1
  292. TY_INT_SGBM_SEMI_PARAM_P2 = 0x0615 | TY_FEATURE_INT, ///< SGBM semi global param p2
  293. TY_INT_SGBM_UNIQUE_FACTOR = 0x0616 | TY_FEATURE_INT, ///< SGBM uniqueness factor param
  294. TY_INT_SGBM_UNIQUE_ABSDIFF = 0x0617 | TY_FEATURE_INT, ///< SGBM uniqueness min absolute diff
  295. TY_INT_SGBM_COST_PARAM = 0x0618 | TY_FEATURE_INT, ///< SGBM cost param
  296. TY_BOOL_SGBM_HFILTER_HALF_WIN = 0x0619 | TY_FEATURE_BOOL, ///< SGBM enable half window size
  297. TY_INT_SGBM_MATCH_WIN_WIDTH = 0x061A | TY_FEATURE_INT, ///< SGBM match window width
  298. TY_BOOL_SGBM_MEDFILTER = 0x061B | TY_FEATURE_BOOL, ///< SGBM enable median filter
  299. TY_BOOL_SGBM_LRC = 0x061C | TY_FEATURE_BOOL, ///< SGBM enable left right consist check
  300. TY_INT_SGBM_LRC_DIFF = 0x061D | TY_FEATURE_INT, ///< SGBM max diff
  301. TY_INT_SGBM_MEDFILTER_THRESH = 0x061E | TY_FEATURE_INT, ///< SGBM median filter thresh
  302. TY_INT_SGBM_SEMI_PARAM_P1_SCALE = 0x061F | TY_FEATURE_INT, ///< SGBM semi global param p1 scale
  303. TY_ENUM_DEPTH_QUALITY = 0x0900 | TY_FEATURE_ENUM, ///< the quality of generated depth, see TY_DEPTH_QUALITY
  304. TY_INT_FILTER_THRESHOLD = 0x0901 | TY_FEATURE_INT, ///< the threshold of the noise filter, 0 for disabled
  305. TY_INT_TOF_CHANNEL = 0x0902 | TY_FEATURE_INT, ///< the frequency channel of tof
  306. TY_INT_TOF_MODULATION_THRESHOLD = 0x0903 | TY_FEATURE_INT, ///< the threshold of the tof modulation
  307. TY_STRUCT_TOF_FREQ = 0x0904 | TY_FEATURE_STRUCT, ///< the frequency of tof, see TY_TOF_FREQ
  308. TY_BOOL_TOF_ANTI_INTERFERENCE = 0x0905 | TY_FEATURE_BOOL, ///< cooperation if multi-device used
  309. }TY_FEATURE_ID_LIST;
  310. typedef uint32_t TY_FEATURE_ID;///< feature unique id @see TY_FEATURE_ID_LIST
  311. typedef enum TY_DEPTH_QUALITY_LIST :uint32_t
  312. {
  313. TY_DEPTH_QUALITY_BASIC = 1,
  314. TY_DEPTH_QUALITY_MEDIUM = 2,
  315. TY_DEPTH_QUALITY_HIGH = 4,
  316. }TY_DEPTH_QUALITY_LIST;
  317. typedef uint32_t TY_DEPTH_QUALITY;
  318. ///set external trigger signal edge
  319. typedef enum TY_TRIGGER_POL_LIST :uint32_t
  320. {
  321. TY_TRIGGER_POL_FALLINGEDGE = 0,
  322. TY_TRIGGER_POL_RISINGEDGE = 1,
  323. }TY_TRIGGER_POL_LIST;
  324. typedef uint32_t TY_TRIGGER_POL;
  325. ///Interface type definition
  326. ///@see TYGetInterfaceList
  327. typedef enum TY_INTERFACE_TYPE_LIST :uint32_t
  328. {
  329. TY_INTERFACE_UNKNOWN = 0,
  330. TY_INTERFACE_RAW = 1,
  331. TY_INTERFACE_USB = 2,
  332. TY_INTERFACE_ETHERNET = 4,
  333. TY_INTERFACE_IEEE80211 = 8,
  334. TY_INTERFACE_ALL = 0xffff,
  335. }TY_INTERFACE_TYPE_LIST;
  336. typedef uint32_t TY_INTERFACE_TYPE;
  337. ///Indicate a feature is readable or writable
  338. ///@see TYGetFeatureInfo
  339. typedef enum TY_ACCESS_MODE_LIST :uint32_t
  340. {
  341. TY_ACCESS_READABLE = 0x1,
  342. TY_ACCESS_WRITABLE = 0x2,
  343. }TY_ACCESS_MODE_LIST;
  344. typedef uint8_t TY_ACCESS_MODE;
  345. ///stream async mode
  346. typedef enum TY_STREAM_ASYNC_MODE_LIST :uint32_t
  347. {
  348. TY_STREAM_ASYNC_OFF = 0,
  349. TY_STREAM_ASYNC_DEPTH = 1,
  350. TY_STREAM_ASYNC_RGB = 2,
  351. TY_STREAM_ASYNC_DEPTH_RGB = 3,
  352. TY_STREAM_ASYNC_ALL = 0xff,
  353. }TY_STREAM_ASYNC_MODE_LIST;
  354. typedef uint8_t TY_STREAM_ASYNC_MODE;
  355. //------------------------------------------------------------------------------
  356. ///Pixel size type definitions
  357. ///to define the pixel size in bits
  358. ///@see TY_PIXEL_FORMAT_LIST
  359. typedef enum TY_PIXEL_BITS_LIST :uint32_t {
  360. TY_PIXEL_8BIT = 0x1 << 28,
  361. TY_PIXEL_16BIT = 0x2 << 28,
  362. TY_PIXEL_24BIT = 0x3 << 28,
  363. TY_PIXEL_32BIT = 0x4 << 28,
  364. TY_PIXEL_10BIT = 0x5 << 28,
  365. TY_PIXEL_12BIT = 0x6 << 28,
  366. TY_PIXEL_14BIT = 0x7 << 28,
  367. TY_PIXEL_48BIT = (uint32_t)0x8 << 28,
  368. TY_PIXEL_64BIT = (uint32_t)0xa << 28,
  369. }TY_PIXEL_BITS_LIST;
  370. typedef uint32_t TY_PIXEL_BITS;
  371. ///pixel format definitions
  372. typedef enum TY_PIXEL_FORMAT_LIST :uint32_t {
  373. TY_PIXEL_FORMAT_UNDEFINED = 0,
  374. TY_PIXEL_FORMAT_MONO = (TY_PIXEL_8BIT | (0x0 << 24)), ///< 0x10000000
  375. TY_PIXEL_FORMAT_BAYER8GB = (TY_PIXEL_8BIT | (0x1 << 24)), ///< 0x11000000
  376. TY_PIXEL_FORMAT_BAYER8BG = (TY_PIXEL_8BIT | (0x2 << 24)), ///< 0x12000000
  377. TY_PIXEL_FORMAT_BAYER8GR = (TY_PIXEL_8BIT | (0x3 << 24)), ///< 0x13000000
  378. TY_PIXEL_FORMAT_BAYER8RG = (TY_PIXEL_8BIT | (0x4 << 24)), ///< 0x14000000
  379. TY_PIXEL_FORMAT_BAYER8GRBG = TY_PIXEL_FORMAT_BAYER8GB,
  380. TY_PIXEL_FORMAT_BAYER8RGGB = TY_PIXEL_FORMAT_BAYER8BG,
  381. TY_PIXEL_FORMAT_BAYER8GBRG = TY_PIXEL_FORMAT_BAYER8GR,
  382. TY_PIXEL_FORMAT_BAYER8BGGR = TY_PIXEL_FORMAT_BAYER8RG,
  383. TY_PIXEL_FORMAT_CSI_MONO10 = (TY_PIXEL_10BIT | (0x0 << 24)), ///< 0x50000000
  384. TY_PIXEL_FORMAT_CSI_BAYER10GRBG = (TY_PIXEL_10BIT | (0x1 << 24)), ///< 0x51000000
  385. TY_PIXEL_FORMAT_CSI_BAYER10RGGB = (TY_PIXEL_10BIT | (0x2 << 24)), ///< 0x52000000
  386. TY_PIXEL_FORMAT_CSI_BAYER10GBRG = (TY_PIXEL_10BIT | (0x3 << 24)), ///< 0x53000000
  387. TY_PIXEL_FORMAT_CSI_BAYER10BGGR = (TY_PIXEL_10BIT | (0x4 << 24)), ///< 0x54000000
  388. TY_PIXEL_FORMAT_CSI_MONO12 = (TY_PIXEL_12BIT | (0x0 << 24)), ///< 0x60000000
  389. TY_PIXEL_FORMAT_CSI_BAYER12GRBG = (TY_PIXEL_12BIT | (0x1 << 24)), ///< 0x61000000
  390. TY_PIXEL_FORMAT_CSI_BAYER12RGGB = (TY_PIXEL_12BIT | (0x2 << 24)), ///< 0x62000000
  391. TY_PIXEL_FORMAT_CSI_BAYER12GBRG = (TY_PIXEL_12BIT | (0x3 << 24)), ///< 0x63000000
  392. TY_PIXEL_FORMAT_CSI_BAYER12BGGR = (TY_PIXEL_12BIT | (0x4 << 24)), ///< 0x64000000
  393. TY_PIXEL_FORMAT_DEPTH16 = (TY_PIXEL_16BIT | (0x0 << 24)), ///< 0x20000000
  394. TY_PIXEL_FORMAT_YVYU = (TY_PIXEL_16BIT | (0x1 << 24)), ///< 0x21000000, yvyu422
  395. TY_PIXEL_FORMAT_YUYV = (TY_PIXEL_16BIT | (0x2 << 24)), ///< 0x22000000, yuyv422
  396. TY_PIXEL_FORMAT_MONO16 = (TY_PIXEL_16BIT | (0x3 << 24)), ///< 0x23000000,
  397. TY_PIXEL_FORMAT_TOF_IR_MONO16 = (TY_PIXEL_64BIT | (0x4 << 24)), ///< 0xa4000000,
  398. TY_PIXEL_FORMAT_RGB = (TY_PIXEL_24BIT | (0x0 << 24)), ///< 0x30000000
  399. TY_PIXEL_FORMAT_BGR = (TY_PIXEL_24BIT | (0x1 << 24)), ///< 0x31000000
  400. TY_PIXEL_FORMAT_JPEG = (TY_PIXEL_24BIT | (0x2 << 24)), ///< 0x32000000
  401. TY_PIXEL_FORMAT_MJPG = (TY_PIXEL_24BIT | (0x3 << 24)), ///< 0x33000000
  402. TY_PIXEL_FORMAT_RGB48 = (TY_PIXEL_48BIT | (0x0 << 24)), ///< 0x80000000
  403. TY_PIXEL_FORMAT_BGR48 = (TY_PIXEL_48BIT | (0x1 << 24)), ///< 0x81000000
  404. TY_PIXEL_FORMAT_XYZ48 = (TY_PIXEL_48BIT | (0x2 << 24)), ///< 0x82000000
  405. }TY_PIXEL_FORMAT_LIST;
  406. typedef uint32_t TY_PIXEL_FORMAT;
  407. ///predefined resolution list
  408. typedef enum TY_RESOLUTION_MODE_LIST :uint32_t
  409. {
  410. TY_RESOLUTION_MODE_160x100 = (160<<12)+100, ///< 0x000a0078
  411. TY_RESOLUTION_MODE_160x120 = (160<<12)+120, ///< 0x000a0078
  412. TY_RESOLUTION_MODE_240x320 = (240<<12)+320, ///< 0x000f0140
  413. TY_RESOLUTION_MODE_320x180 = (320<<12)+180, ///< 0x001400b4
  414. TY_RESOLUTION_MODE_320x200 = (320<<12)+200, ///< 0x001400c8
  415. TY_RESOLUTION_MODE_320x240 = (320<<12)+240, ///< 0x001400f0
  416. TY_RESOLUTION_MODE_480x640 = (480<<12)+640, ///< 0x001e0280
  417. TY_RESOLUTION_MODE_640x360 = (640<<12)+360, ///< 0x00280168
  418. TY_RESOLUTION_MODE_640x400 = (640<<12)+400, ///< 0x00280190
  419. TY_RESOLUTION_MODE_640x480 = (640<<12)+480, ///< 0x002801e0
  420. TY_RESOLUTION_MODE_960x1280 = (960<<12)+1280, ///< 0x003c0500
  421. TY_RESOLUTION_MODE_1280x720 = (1280<<12)+720, ///< 0x005002d0
  422. TY_RESOLUTION_MODE_1280x800 = (1280<<12)+800, ///< 0x00500320
  423. TY_RESOLUTION_MODE_1280x960 = (1280<<12)+960, ///< 0x005003c0
  424. TY_RESOLUTION_MODE_1920x1080 = (1920<<12)+1080, ///< 0x00780438
  425. TY_RESOLUTION_MODE_2560x1920 = (2560<<12)+1920, ///< 0x00a00780
  426. TY_RESOLUTION_MODE_2592x1944 = (2592<<12)+1944, ///< 0x00a20798
  427. TY_RESOLUTION_MODE_1920x1440 = (1920<<12)+1440, ///< 0x007805a0
  428. TY_RESOLUTION_MODE_240x96 = (240<<12)+96, ///< 0x000f0060
  429. }TY_RESOLUTION_MODE_LIST;
  430. typedef int32_t TY_RESOLUTION_MODE;
  431. #define TY_DECLARE_IMAGE_MODE0(pix, res) \
  432. TY_IMAGE_MODE_##pix##_##res = TY_PIXEL_FORMAT_##pix | TY_RESOLUTION_MODE_##res
  433. #define TY_DECLARE_IMAGE_MODE1(pix) \
  434. TY_DECLARE_IMAGE_MODE0(pix, 160x100), \
  435. TY_DECLARE_IMAGE_MODE0(pix, 160x120), \
  436. TY_DECLARE_IMAGE_MODE0(pix, 320x180), \
  437. TY_DECLARE_IMAGE_MODE0(pix, 320x200), \
  438. TY_DECLARE_IMAGE_MODE0(pix, 320x240), \
  439. TY_DECLARE_IMAGE_MODE0(pix, 480x640), \
  440. TY_DECLARE_IMAGE_MODE0(pix, 640x360), \
  441. TY_DECLARE_IMAGE_MODE0(pix, 640x400), \
  442. TY_DECLARE_IMAGE_MODE0(pix, 640x480), \
  443. TY_DECLARE_IMAGE_MODE0(pix, 960x1280), \
  444. TY_DECLARE_IMAGE_MODE0(pix, 1280x720), \
  445. TY_DECLARE_IMAGE_MODE0(pix, 1280x960), \
  446. TY_DECLARE_IMAGE_MODE0(pix, 1280x800), \
  447. TY_DECLARE_IMAGE_MODE0(pix, 1920x1080), \
  448. TY_DECLARE_IMAGE_MODE0(pix, 2560x1920), \
  449. TY_DECLARE_IMAGE_MODE0(pix, 2592x1944), \
  450. TY_DECLARE_IMAGE_MODE0(pix, 1920x1440), \
  451. TY_DECLARE_IMAGE_MODE0(pix, 240x96)
  452. ///@brief Predefined Image Mode List
  453. /// image mode controls image resolution & format
  454. /// predefined image modes named like TY_IMAGE_MODE_MONO_160x120,TY_IMAGE_MODE_RGB_1280x960
  455. typedef enum TY_IMAGE_MODE_LIST:uint32_t
  456. {
  457. TY_DECLARE_IMAGE_MODE1(MONO),
  458. TY_DECLARE_IMAGE_MODE1(MONO16),
  459. TY_DECLARE_IMAGE_MODE1(TOF_IR_MONO16),
  460. TY_DECLARE_IMAGE_MODE1(DEPTH16),
  461. TY_DECLARE_IMAGE_MODE1(YVYU),
  462. TY_DECLARE_IMAGE_MODE1(YUYV),
  463. TY_DECLARE_IMAGE_MODE1(RGB),
  464. TY_DECLARE_IMAGE_MODE1(JPEG),
  465. TY_DECLARE_IMAGE_MODE1(BAYER8GB),
  466. TY_DECLARE_IMAGE_MODE1(BAYER8BG),
  467. TY_DECLARE_IMAGE_MODE1(BAYER8GR),
  468. TY_DECLARE_IMAGE_MODE1(BAYER8RG),
  469. TY_DECLARE_IMAGE_MODE1(BAYER8GRBG),
  470. TY_DECLARE_IMAGE_MODE1(BAYER8RGGB),
  471. TY_DECLARE_IMAGE_MODE1(BAYER8GBRG),
  472. TY_DECLARE_IMAGE_MODE1(BAYER8BGGR),
  473. TY_DECLARE_IMAGE_MODE1(CSI_MONO10),
  474. TY_DECLARE_IMAGE_MODE1(CSI_BAYER10GRBG),
  475. TY_DECLARE_IMAGE_MODE1(CSI_BAYER10RGGB),
  476. TY_DECLARE_IMAGE_MODE1(CSI_BAYER10GBRG),
  477. TY_DECLARE_IMAGE_MODE1(CSI_BAYER10BGGR),
  478. TY_DECLARE_IMAGE_MODE1(CSI_MONO12),
  479. TY_DECLARE_IMAGE_MODE1(CSI_BAYER12GRBG),
  480. TY_DECLARE_IMAGE_MODE1(CSI_BAYER12RGGB),
  481. TY_DECLARE_IMAGE_MODE1(CSI_BAYER12GBRG),
  482. TY_DECLARE_IMAGE_MODE1(CSI_BAYER12BGGR),
  483. TY_DECLARE_IMAGE_MODE1(MJPG),
  484. TY_DECLARE_IMAGE_MODE1(RGB48),
  485. TY_DECLARE_IMAGE_MODE1(BGR48),
  486. TY_DECLARE_IMAGE_MODE1(BGR),
  487. TY_DECLARE_IMAGE_MODE1(XYZ48)
  488. }TY_IMAGE_MODE_LIST;
  489. typedef uint32_t TY_IMAGE_MODE;
  490. #undef TY_DECLARE_IMAGE_MODE0
  491. #undef TY_DECLARE_IMAGE_MODE1
  492. ///@see refer to sample SimpleView_TriggerMode for detail usage
  493. typedef enum TY_TRIGGER_MODE_LIST :uint32_t
  494. {
  495. TY_TRIGGER_MODE_OFF = 0, ///<not trigger mode, continuous mode
  496. TY_TRIGGER_MODE_SLAVE = 1, ///<slave mode, receive soft/hardware triggers
  497. TY_TRIGGER_MODE_M_SIG = 2, ///<master mode 1, sending one trigger signal once received a soft/hardware trigger
  498. TY_TRIGGER_MODE_M_PER = 3, ///<master mode 2, periodic sending one trigger signals, 'fps' param should be set
  499. TY_TRIGGER_MODE_SIG_PASS = 18,
  500. TY_TRIGGER_MODE_PER_PASS = 19,
  501. TY_TRIGGER_MODE_TIMER_LIST = 20,
  502. TY_TRIGGER_MODE_TIMER_PERIOD= 21,
  503. TY_TRIGGER_MODE_PER_PASS2 = 30,///<trigger mode 30,Alternate output depth image/ir image
  504. TY_TRIGGER_WORK_MODE31 = 31,
  505. TY_TRIGGER_MODE_SIG_LASER = 34,
  506. }TY_TRIGGER_MODE_LIST;
  507. typedef int16_t TY_TRIGGER_MODE;
  508. ///@brief type of time sync
  509. typedef enum TY_TIME_SYNC_TYPE_LIST :uint32_t
  510. {
  511. TY_TIME_SYNC_TYPE_NONE = 0,
  512. TY_TIME_SYNC_TYPE_HOST = 1,
  513. TY_TIME_SYNC_TYPE_NTP = 2,
  514. TY_TIME_SYNC_TYPE_PTP = 3,
  515. TY_TIME_SYNC_TYPE_CAN = 4,
  516. TY_TIME_SYNC_TYPE_PTP_MASTER = 5,
  517. }TY_TIME_SYNC_TYPE_LIST;
  518. typedef uint32_t TY_TIME_SYNC_TYPE;
  519. typedef enum: uint32_t{
  520. /* depends on external power supply */
  521. TY_EXT_SUP = 0,
  522. TY_DO_5V = 1,
  523. TY_DO_12V = 2,
  524. } TY_E_VOLT_T_LIST;
  525. typedef uint32_t TY_E_VOLT_T;
  526. typedef enum: uint32_t{
  527. TY_DO_LOW = 0,
  528. TY_DO_HIGH = 1,
  529. TY_DO_PWM = 2,
  530. TY_DO_CAM_TRIG = 3,
  531. }TY_E_DO_MODE_LIST;
  532. typedef uint32_t TY_E_DO_MODE;
  533. typedef enum: uint32_t{
  534. /* DI polling by user, No interrupt */
  535. TY_DI_POLL = 0,
  536. /* DI negative edge interrupt mode */
  537. TY_DI_NE_INT = 1,
  538. /* DI positive edge inerrupt mode */
  539. TY_DI_PE_INT = 2,
  540. }TY_E_DI_MODE_LIST;
  541. typedef uint32_t TY_E_DI_MODE;
  542. typedef enum: uint32_t {
  543. /* DI interrupt No op*/
  544. TY_DI_INT_NO_OP = 0,
  545. /* DI interrupt trig a capture action */
  546. TY_DI_INT_TRIG_CAP = 1,
  547. /* DI interrupt report a event to SDK */
  548. TY_DI_INT_EVENT = 2,
  549. }TY_E_DI_INT_ACTION_LIST;
  550. typedef uint32_t TY_E_DI_INT_ACTION;
  551. #pragma pack(1)
  552. //------------------------------------------------------------------------------
  553. // Struct
  554. //------------------------------------------------------------------------------
  555. typedef struct TY_VERSION_INFO
  556. {
  557. int32_t major;
  558. int32_t minor;
  559. int32_t patch;
  560. int32_t reserved;
  561. }TY_VERSION_INFO;
  562. /// @brief device network information
  563. typedef struct TY_DEVICE_NET_INFO
  564. {
  565. char mac[32];
  566. char ip[32];
  567. char netmask[32];
  568. char gateway[32];
  569. char broadcast[32];
  570. char reserved[96];
  571. }TY_DEVICE_NET_INFO;
  572. typedef struct TY_DEVICE_USB_INFO
  573. {
  574. int bus;
  575. int addr;
  576. char reserved[248];
  577. }TY_DEVICE_USB_INFO;
  578. ///@see TYGetInterfaceList
  579. typedef struct TY_INTERFACE_INFO
  580. {
  581. char name[32];
  582. char id[32];
  583. TY_INTERFACE_TYPE type;
  584. char reserved[4];
  585. TY_DEVICE_NET_INFO netInfo; // only meaningful when TYIsNetworkInterface(type)
  586. }TY_INTERFACE_INFO;
  587. ///@see TYGetDeviceList
  588. typedef struct TY_DEVICE_BASE_INFO
  589. {
  590. TY_INTERFACE_INFO iface;
  591. char id[32];///<device serial number
  592. char vendorName[32];
  593. char userDefinedName[32];
  594. char modelName[32];///<device model name
  595. TY_VERSION_INFO hardwareVersion; ///<deprecated
  596. TY_VERSION_INFO firmwareVersion;///<deprecated
  597. union {
  598. TY_DEVICE_NET_INFO netInfo;
  599. TY_DEVICE_USB_INFO usbInfo;
  600. };
  601. char buildHash[256];
  602. char configVersion[256];
  603. char reserved[256];
  604. }TY_DEVICE_BASE_INFO;
  605. typedef struct TY_FEATURE_INFO
  606. {
  607. bool isValid; ///< true if feature exists, false otherwise
  608. TY_ACCESS_MODE accessMode; ///< feature access privilege
  609. bool writableAtRun; ///< feature can be written while capturing
  610. char reserved0[1];
  611. TY_COMPONENT_ID componentID; ///< owner of this feature
  612. TY_FEATURE_ID featureID; ///< feature unique id
  613. char name[32]; ///< describe string
  614. TY_COMPONENT_ID bindComponentID; ///< component ID current feature bind to
  615. TY_FEATURE_ID bindFeatureID; ///< feature ID current feature bind to
  616. char reserved[252];
  617. }TY_FEATURE_INFO;
  618. typedef struct TY_INT_RANGE
  619. {
  620. int32_t min;
  621. int32_t max;
  622. int32_t inc; ///<increaing step
  623. int32_t reserved[1];
  624. }TY_INT_RANGE;
  625. /// @brief float range data structure
  626. /// @see TYGetFloatRange
  627. typedef struct TY_FLOAT_RANGE
  628. {
  629. float min;
  630. float max;
  631. float inc; ///<increaing step
  632. float reserved[1];
  633. }TY_FLOAT_RANGE;
  634. /// @brief byte array data structure
  635. /// @see TYGetByteArray
  636. typedef struct TY_BYTEARRAY_ATTR
  637. {
  638. int32_t size; ///<Bytes array size in bytes
  639. int32_t unit_size; ///<unit size in bytes for special parse
  640. ///valid size in bytes in case has reserved member,
  641. ///Must be multiple of unit_size, mem_length = valid_size/unit_size
  642. int32_t valid_size;
  643. }TY_BYTEARRAY_ATTR;
  644. ///enum feature entry information
  645. ///@see TYGetEnumEntryInfo
  646. typedef struct TY_ENUM_ENTRY
  647. {
  648. char description[64];
  649. uint32_t value;
  650. uint32_t reserved[3];
  651. }TY_ENUM_ENTRY;
  652. typedef struct TY_VECT_3F
  653. {
  654. float x;
  655. float y;
  656. float z;
  657. }TY_VECT_3F;
  658. /// a 3x3 matrix
  659. /// |.|.|.|
  660. /// | --|---|---|
  661. /// | fx| 0| cx|
  662. /// | 0| fy| cy|
  663. /// | 0| 0| 1|
  664. ///@see TYGetStruct
  665. /// Usage:
  666. ///@code
  667. /// TY_CAMERA_INTRINSIC intrinsic;
  668. /// TYGetStruct(hDevice, some_compoent, TY_STRUCT_CAM_INTRINSIC, &intrinsic, sizeof(intrinsic));
  669. ///@endcode
  670. typedef struct TY_CAMERA_INTRINSIC
  671. {
  672. float data[3*3];
  673. }TY_CAMERA_INTRINSIC;
  674. /// a 4x4 matrix
  675. /// |.|.|.|.|
  676. /// |---|----|----|---|
  677. /// |r11| r12| r13| t1|
  678. /// |r21| r22| r23| t2|
  679. /// |r31| r32| r33| t3|
  680. /// | 0 | 0| 0| 1|
  681. ///@see TYGetStruct
  682. /// Usage:
  683. ///@code
  684. /// TY_CAMERA_EXTRINSIC extrinsic;
  685. /// TYGetStruct(hDevice, some_compoent, TY_STRUCT_EXTRINSIC, &extrinsic, sizeof(extrinsic));
  686. ///@endcode
  687. typedef struct TY_CAMERA_EXTRINSIC
  688. {
  689. float data[4*4];
  690. }TY_CAMERA_EXTRINSIC;
  691. ///camera distortion parameters
  692. /// @see TYGetStruct
  693. /// Usage:
  694. ///@code
  695. /// TY_CAMERA_DISTORTION distortion;
  696. /// TYGetStruct(hDevice, some_compoent, TY_STRUCT_CAM_DISTORTION, &distortion, sizeof(distortion));
  697. ///@endcode
  698. typedef struct TY_CAMERA_DISTORTION
  699. {
  700. float data[12];///<Definition is compatible with opencv3.0+ :k1,k2,p1,p2,k3,k4,k5,k6,s1,s2,s3,s4
  701. }TY_CAMERA_DISTORTION;
  702. ///camera 's cailbration data
  703. ///@see TYGetStruct
  704. typedef struct TY_CAMERA_CALIB_INFO
  705. {
  706. int32_t intrinsicWidth;
  707. int32_t intrinsicHeight;
  708. TY_CAMERA_INTRINSIC intrinsic; // TY_STRUCT_CAM_INTRINSIC
  709. TY_CAMERA_EXTRINSIC extrinsic; // TY_STRUCT_EXTRINSIC_TO_LEFT_IR
  710. TY_CAMERA_DISTORTION distortion; // TY_STRUCT_CAM_DISTORTION
  711. }TY_CAMERA_CALIB_INFO;
  712. //@see sample SimpleView_TriggerMode
  713. typedef struct TY_TRIGGER_PARAM
  714. {
  715. TY_TRIGGER_MODE mode;
  716. int8_t fps;
  717. int8_t rsvd;
  718. }TY_TRIGGER_PARAM;
  719. //@see sample SimpleView_TriggerMode, only for TY_TRIGGER_MODE_SIG_PASS/TY_TRIGGER_MODE_PER_PASS
  720. typedef struct TY_TRIGGER_PARAM_EX
  721. {
  722. TY_TRIGGER_MODE mode;
  723. union
  724. {
  725. struct
  726. {
  727. int8_t fps;
  728. int8_t duty;
  729. int32_t laser_stream;
  730. int32_t led_stream;
  731. int32_t led_expo;
  732. int32_t led_gain;
  733. };
  734. struct
  735. {
  736. int32_t ir_gain[2];
  737. };
  738. int32_t rsvd[32];
  739. };
  740. }TY_TRIGGER_PARAM_EX;
  741. //@see sample SimpleView_TriggerMode, only for TY_TRIGGER_MODE_TIMER_LIST
  742. typedef struct TY_TRIGGER_TIMER_LIST
  743. {
  744. uint64_t start_time_us; // 0 for disable
  745. uint32_t offset_us_count; // length of offset_us_list
  746. uint32_t offset_us_list[50]; // used in TY_TRIGGER_MODE_TIMER_LIST mode
  747. }TY_TRIGGER_TIMER_LIST;
  748. //@see sample SimpleView_TriggerMode, only for TY_TRIGGER_MODE_TIMER_PERIOD
  749. typedef struct TY_TRIGGER_TIMER_PERIOD
  750. {
  751. uint64_t start_time_us; // 0 for disable
  752. uint32_t trigger_count;
  753. uint32_t period_us; // used in TY_TRIGGER_MODE_TIMER_PERIOD mode
  754. }TY_TRIGGER_TIMER_PERIOD;
  755. typedef struct TY_AEC_ROI_PARAM
  756. {
  757. uint32_t x;
  758. uint32_t y;
  759. uint32_t w;
  760. uint32_t h;
  761. }TY_AEC_ROI_PARAM;
  762. typedef struct TY_CAMERA_STATISTICS
  763. {
  764. uint64_t packetReceived;
  765. uint64_t packetLost;
  766. uint64_t imageOutputed;
  767. uint64_t imageDropped;
  768. uint8_t rsvd[1024];
  769. }TY_CAMERA_STATISTICS;
  770. typedef struct TY_IMU_DATA
  771. {
  772. uint64_t timestamp;
  773. float acc_x;
  774. float acc_y;
  775. float acc_z;
  776. float gyro_x;
  777. float gyro_y;
  778. float gyro_z;
  779. float temperature;
  780. float reserved[1];
  781. }TY_IMU_DATA;
  782. /// a 3x3 matrix
  783. /// |.|.|.|
  784. /// | -- | ---- | --- |
  785. /// | BIASx | BIASy | BIASz |
  786. typedef struct TY_ACC_BIAS
  787. {
  788. float data[3];
  789. }TY_ACC_BIAS;
  790. /// a 3x3 matrix
  791. /// |.|.|.|
  792. /// |.|.|.|
  793. /// | -- | ---- | ---- |
  794. /// | 1 | -GAMAyz | GAMAzy |
  795. /// | GAMAxz | 1 | -GAMAzx |
  796. /// | -GAMAxy| GAMAyx | 1 |
  797. typedef struct TY_ACC_MISALIGNMENT
  798. {
  799. float data[3 * 3];
  800. }TY_ACC_MISALIGNMENT;
  801. /// a 3x3 matrix
  802. /// |.|.|.|
  803. /// | ---- |---- |---- |
  804. /// | SCALEx| 0 | 0 |
  805. /// | 0 |SCALEy| 0 |
  806. /// | 0 | 0 | SCALEz|
  807. typedef struct TY_ACC_SCALE
  808. {
  809. float data[3 * 3];
  810. }TY_ACC_SCALE;
  811. /// a 3x3 matrix
  812. /// |.|.|.|
  813. /// | -- | ---- | --- |
  814. /// | BIASx | BIASy | BIASz |
  815. typedef struct TY_GYRO_BIAS
  816. {
  817. float data[3];
  818. }TY_GYRO_BIAS;
  819. /// a 3x3 matrix
  820. /// |.|.|.|
  821. /// | --| ---- | ---- |
  822. /// | 1 | -ALPHAyz| ALPHAzy |
  823. /// | 0 | 1 | -ALPHAzx |
  824. /// | 0 | 0 | 1 |
  825. typedef struct TY_GYRO_MISALIGNMENT
  826. {
  827. float data[3 * 3];
  828. }TY_GYRO_MISALIGNMENT;
  829. /// a 3x3 matrix
  830. /// |.|.|.|
  831. /// | ---- |---- |---- |
  832. /// | SCALEx| 0 | 0 |
  833. /// | 0 |SCALEy| 0 |
  834. /// | 0 | 0 | SCALEz|
  835. typedef struct TY_GYRO_SCALE
  836. {
  837. float data[3 * 3];
  838. }TY_GYRO_SCALE;
  839. /// a 4x4 matrix
  840. /// |.|.|.|.|
  841. /// |---|----|----|---|
  842. /// |r11| r12| r13| t1|
  843. /// |r21| r22| r23| t2|
  844. /// |r31| r32| r33| t3|
  845. /// | 0 | 0| 0| 1|
  846. typedef struct TY_CAMERA_TO_IMU
  847. {
  848. float data[4 * 4];
  849. }TY_CAMERA_TO_IMU;
  850. typedef struct TY_TOF_FREQ
  851. {
  852. uint32_t freq1;
  853. uint32_t freq2;
  854. }TY_TOF_FREQ;
  855. typedef enum TY_IMU_FPS_LIST
  856. {
  857. TY_IMU_FPS_100HZ = 0,
  858. TY_IMU_FPS_200HZ,
  859. TY_IMU_FPS_400HZ,
  860. }TY_IMU_FPS_LIST;
  861. //------------------------------------------------------------------------------
  862. // Buffer & Callback
  863. //------------------------------------------------------------------------------
  864. typedef struct TY_IMAGE_DATA
  865. {
  866. uint64_t timestamp; ///< Timestamp in microseconds
  867. int32_t imageIndex; ///< image index used in trigger mode
  868. int32_t status; ///< Status of this buffer
  869. int32_t componentID; ///< Where current data come from
  870. int32_t size; ///< Buffer size
  871. void* buffer; ///< Pointer to data buffer
  872. int32_t width; ///< Image width in pixels
  873. int32_t height; ///< Image height in pixels
  874. int32_t pixelFormat; ///< Pixel format, see TY_PIXEL_FORMAT_LIST
  875. int32_t reserved[9]; ///< Reserved
  876. }TY_IMAGE_DATA;
  877. typedef struct TY_FRAME_DATA
  878. {
  879. void* userBuffer; ///< Pointer to user enqueued buffer, user should enqueue this buffer in the end of callback
  880. int32_t bufferSize; ///< Size of userBuffer
  881. int32_t validCount; ///< Number of valid data
  882. int32_t reserved[6]; ///< Reserved: reserved[0],laser_val;
  883. TY_IMAGE_DATA image[10]; ///< Buffer data, max to 10 images per frame, each buffer data could be an image or something else.
  884. }TY_FRAME_DATA;
  885. typedef struct TY_EVENT_INFO
  886. {
  887. TY_EVENT eventId;
  888. char message[124];
  889. }TY_EVENT_INFO;
  890. typedef struct TY_DO_WORKMODE {
  891. /* TY_E_DO_MODE type of workmode */
  892. TY_E_DO_MODE mode;
  893. /* TY_E_VOLT_T type, voltage to output */
  894. TY_E_VOLT_T volt;
  895. /*
  896. * frequency of PWM, Only valid when mode == PWM
  897. * unit is Hz, Range is 1~1000
  898. */
  899. uint32_t freq;
  900. /*
  901. * duty of PWM, Only valid when mode == PWM
  902. * unit is %, Range is 1~100
  903. */
  904. uint32_t duty;
  905. /*
  906. * Only valid in read op, write no effect
  907. */
  908. uint32_t mode_supported;
  909. uint32_t volt_supported;
  910. uint32_t reserved[3];
  911. }TY_DO_WORKMODE;
  912. typedef struct TY_DI_WORKMODE {
  913. /* DI workmode in type of TY_E_DI_MODE */
  914. TY_E_DI_MODE mode;
  915. /* interrupt action, valid when mode in TY_DI_NE_INT TY_DI_PE_INT */
  916. TY_E_DI_INT_ACTION int_act;
  917. /* supported mode, Only valid when read */
  918. uint32_t mode_supported;
  919. /* supported action in int mode, Only valid when read */
  920. uint32_t int_act_supported;
  921. /* DI status, 0 low, 1 high, Only read back, can not write */
  922. uint32_t status;
  923. uint32_t reserved[3];
  924. } TY_DI_WORKMODE;
  925. #pragma pack()
  926. typedef void (*TY_EVENT_CALLBACK) (TY_EVENT_INFO*, void* userdata);
  927. typedef void (*TY_IMU_CALLBACK) (TY_IMU_DATA*, void* userdata);
  928. //------------------------------------------------------------------------------
  929. // inlines
  930. //------------------------------------------------------------------------------
  931. static inline bool TYIsNetworkInterface(int32_t interfaceType)
  932. {
  933. return (interfaceType == TY_INTERFACE_ETHERNET) ||
  934. (interfaceType == TY_INTERFACE_IEEE80211);
  935. }
  936. static inline void TYIntToIPv4(uint32_t addr, uint8_t out[4])
  937. {
  938. out[0] = (addr>>24) & 0xff;
  939. out[1] = (addr>>16) & 0xff;
  940. out[2] = (addr>>8) & 0xff;
  941. out[3] = (addr>>0) & 0xff;
  942. }
  943. static inline uint32_t TYIPv4ToInt(uint8_t ip[4])
  944. {
  945. return (ip[0] << 24) | (ip[1] << 16) | (ip[2] << 8) | ip[3];
  946. }
  947. ///init a TY_IMAGE_DATA struct
  948. static inline TY_IMAGE_DATA TYInitImageData(size_t size, void* buffer
  949. , size_t width, size_t height)
  950. {
  951. TY_IMAGE_DATA out;
  952. out.timestamp = 0;
  953. out.imageIndex = 0;
  954. out.status = 0;
  955. out.componentID = 0;
  956. out.size = size;
  957. out.buffer = buffer;
  958. out.width = width;
  959. out.height = height;
  960. out.pixelFormat = 0;
  961. return out;
  962. }
  963. ///get feature format type from feature id
  964. static inline TY_FEATURE_TYPE TYFeatureType(TY_FEATURE_ID id)
  965. {
  966. return id & 0xf000;
  967. }
  968. ///deprecated: get pixel size in byte, Invalid for 10/12/14bit mode
  969. static inline int32_t TYPixelSize(TY_IMAGE_MODE imageMode)
  970. {
  971. return ((imageMode >> 28) & 0xf);
  972. }
  973. ///get pixel size in bits
  974. static inline int32_t TYBitsPerPixel(TY_IMAGE_MODE imageMode)
  975. {
  976. TY_PIXEL_BITS bits = imageMode & (0xf << 28);
  977. switch(bits){
  978. case TY_PIXEL_16BIT:
  979. return 16;
  980. case TY_PIXEL_24BIT:
  981. return 24;
  982. case TY_PIXEL_32BIT:
  983. return 32;
  984. case TY_PIXEL_48BIT:
  985. return 48;
  986. case TY_PIXEL_64BIT:
  987. return 64;
  988. case TY_PIXEL_10BIT:
  989. return 10;
  990. case TY_PIXEL_12BIT:
  991. return 12;
  992. case TY_PIXEL_8BIT:
  993. default:
  994. return 8;
  995. }
  996. }
  997. ///get line size in bytes
  998. static inline int32_t TYPixelLineSize(int width, TY_IMAGE_MODE imageMode)
  999. {
  1000. return (width * TYBitsPerPixel(imageMode)) >> 3;
  1001. }
  1002. ///make a image mode from pixel format & resolution mode
  1003. static inline TY_IMAGE_MODE TYImageMode(TY_PIXEL_FORMAT pix, TY_RESOLUTION_MODE res)
  1004. {
  1005. return pix | res;
  1006. }
  1007. ///get a resoltuion mode from width & height
  1008. static inline TY_RESOLUTION_MODE TYResolutionMode2(int width, int height){
  1009. return (TY_RESOLUTION_MODE)((width << 12) + height);
  1010. }
  1011. ///create a image mode from pixel format , width & height
  1012. static inline TY_IMAGE_MODE TYImageMode2(TY_PIXEL_FORMAT pix, int width,int height)
  1013. {
  1014. return pix | TYResolutionMode2(width, height);
  1015. }
  1016. ///get pixel format from image mode
  1017. static inline TY_PIXEL_FORMAT TYPixelFormat(TY_IMAGE_MODE imageMode)
  1018. {
  1019. return imageMode & 0xff000000;
  1020. }
  1021. ///get a resoltuion mode from image mode
  1022. static inline TY_RESOLUTION_MODE TYResolutionMode(TY_IMAGE_MODE imageMode)
  1023. {
  1024. return imageMode & 0x00ffffff;
  1025. }
  1026. ///get image width from image mode
  1027. static inline int32_t TYImageWidth(TY_IMAGE_MODE imageMode)
  1028. {
  1029. return TYResolutionMode(imageMode) >> 12;
  1030. }
  1031. ///get image height from image mode
  1032. static inline int32_t TYImageHeight(TY_IMAGE_MODE imageMode)
  1033. {
  1034. return TYResolutionMode(imageMode) & 0x0fff;
  1035. }
  1036. //------------------------------------------------------------------------------
  1037. // C API
  1038. //------------------------------------------------------------------------------
  1039. #define TY_CAPI TY_EXTC TY_EXPORT TY_STATUS TY_STDC
  1040. /// @brief Get error information.
  1041. /// @param [in] errorID Error id.
  1042. /// @return Error string.
  1043. TY_EXTC TY_EXPORT const char* TY_STDC TYErrorString (TY_STATUS errorID);
  1044. /// @brief Init this library.
  1045. ///
  1046. /// We make this function to be static inline, because we do a version check here.
  1047. /// Some user may use the mismatched header file and dynamic library, and
  1048. /// that's quite difficult to locate the error.
  1049. ///
  1050. /// @retval TY_STATUS_OK Succeed.
  1051. /// @retval TY_STATUS_ERROR Has been inited.
  1052. static inline TY_STATUS TYInitLib (void);
  1053. /// @brief Deinit this library.
  1054. /// @retval TY_STATUS_OK Succeed.
  1055. TY_CAPI TYDeinitLib (void);
  1056. /// @brief Get current library version.
  1057. /// @param [out] version Version infomation to be filled.
  1058. /// @retval TY_STATUS_OK Succeed.
  1059. /// @retval TY_STATUS_NULL_POINTER buffer is NULL.
  1060. TY_CAPI TYLibVersion (TY_VERSION_INFO* version);
  1061. /// @brief Update current interfaces.
  1062. /// call before TYGetInterfaceList
  1063. /// @retval TY_STATUS_OK Succeed.
  1064. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1065. TY_CAPI TYUpdateInterfaceList ();
  1066. /// @brief Get number of current interfaces.
  1067. /// @param [out] pNumIfaces Number of interfaces.
  1068. /// @retval TY_STATUS_OK Succeed.
  1069. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1070. /// @retval TY_STATUS_NULL_POINTER deviceNumber is NULL.
  1071. TY_CAPI TYGetInterfaceNumber (uint32_t* pNumIfaces);
  1072. /// @brief Get interface info list.
  1073. /// @param [out] pIfaceInfos Array of interface infos to be filled.
  1074. /// @param [in] bufferCount Array size of interface infos.
  1075. /// @param [out] filledCount Number of filled TY_INTERFACE_INFO.
  1076. /// @retval TY_STATUS_OK Succeed.
  1077. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1078. /// @retval TY_STATUS_NULL_POINTER pIfaceInfos or filledCount is NULL.
  1079. TY_CAPI TYGetInterfaceList (TY_INTERFACE_INFO* pIfaceInfos, uint32_t bufferCount, uint32_t* filledCount);
  1080. /// @brief Check if has interface.
  1081. /// @param [in] ifaceID Interface ID string, can be get from TY_INTERFACE_INFO.
  1082. /// @param [out] value True if the interface exists.
  1083. /// @retval TY_STATUS_OK Succeed.
  1084. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1085. /// @retval TY_STATUS_NULL_POINTER ifaceID or outHandle is NULL.
  1086. /// @see TYGetInterfaceList
  1087. TY_CAPI TYHasInterface (const char* ifaceID, bool* value);
  1088. /// @brief Open specified interface.
  1089. /// @param [in] ifaceID Interface ID string, can be get from TY_INTERFACE_INFO.
  1090. /// @param [out] outHandle Handle of opened interface.
  1091. /// @retval TY_STATUS_OK Succeed.
  1092. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1093. /// @retval TY_STATUS_NULL_POINTER ifaceID or outHandle is NULL.
  1094. /// @retval TY_STATUS_INVALID_INTERFACE Interface not found.
  1095. /// @see TYGetInterfaceList
  1096. TY_CAPI TYOpenInterface (const char* ifaceID, TY_INTERFACE_HANDLE* outHandle);
  1097. /// @brief Close interface.
  1098. /// @param [in] ifaceHandle Interface to be closed.
  1099. /// @retval TY_STATUS_OK Succeed.
  1100. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1101. /// @retval TY_STATUS_INVALID_INTERFACE Interface not found.
  1102. TY_CAPI TYCloseInterface (TY_INTERFACE_HANDLE ifaceHandle);
  1103. /// @brief Update current connected devices.
  1104. /// @param [in] ifaceHandle Interface handle.
  1105. /// @retval TY_STATUS_OK Succeed.
  1106. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1107. /// @retval TY_STATUS_INVALID_INTERFACE Invalid interface handle.
  1108. TY_CAPI TYUpdateDeviceList (TY_INTERFACE_HANDLE ifaceHandle);
  1109. /// @brief Update current connected devices.
  1110. /// @retval TY_STATUS_OK Succeed.
  1111. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1112. TY_CAPI TYUpdateAllDeviceList();
  1113. /// @brief Get number of current connected devices.
  1114. /// @param [in] ifaceHandle Interface handle.
  1115. /// @param [out] deviceNumber Number of connected devices.
  1116. /// @retval TY_STATUS_OK Succeed.
  1117. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1118. /// @retval TY_STATUS_INVALID_INTERFACE Invalid interface handle.
  1119. /// @retval TY_STATUS_NULL_POINTER deviceNumber is NULL.
  1120. TY_CAPI TYGetDeviceNumber (TY_INTERFACE_HANDLE ifaceHandle, uint32_t* deviceNumber);
  1121. /// @brief Get device info list.
  1122. /// @param [in] ifaceHandle Interface handle.
  1123. /// @param [out] deviceInfos Device info array to be filled.
  1124. /// @param [in] bufferCount Array size of deviceInfos.
  1125. /// @param [out] filledDeviceCount Number of filled TY_DEVICE_BASE_INFO.
  1126. /// @retval TY_STATUS_OK Succeed.
  1127. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1128. /// @retval TY_STATUS_INVALID_INTERFACE Invalid interface handle.
  1129. /// @retval TY_STATUS_NULL_POINTER deviceInfos or filledDeviceCount is NULL.
  1130. TY_CAPI TYGetDeviceList (TY_INTERFACE_HANDLE ifaceHandle, TY_DEVICE_BASE_INFO* deviceInfos, uint32_t bufferCount, uint32_t* filledDeviceCount);
  1131. /// @brief Check whether the interface has the specified device.
  1132. /// @param [in] ifaceHandle Interface handle.
  1133. /// @param [in] deviceID Device ID string, can be get from TY_DEVICE_BASE_INFO.
  1134. /// @param [out] value True if the device exists.
  1135. /// @retval TY_STATUS_OK Succeed.
  1136. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1137. /// @retval TY_STATUS_INVALID_INTERFACE Invalid interface handle.
  1138. /// @retval TY_STATUS_NULL_POINTER deviceID or value is NULL.
  1139. TY_CAPI TYHasDevice (TY_INTERFACE_HANDLE ifaceHandle, const char* deviceID, bool* value);
  1140. /// @brief Open device by device ID.
  1141. /// @param [in] ifaceHandle Interface handle.
  1142. /// @param [in] deviceID Device ID string, can be get from TY_DEVICE_BASE_INFO.
  1143. /// @param [out] deviceHandle Handle of opened device. Valid only if TY_STATUS_OK or TY_FW_ERRORCODE returned.
  1144. /// @param [out] outFwErrorcode Firmware errorcode. Valid only if TY_FW_ERRORCODE returned.
  1145. /// @retval TY_STATUS_OK Succeed.
  1146. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1147. /// @retval TY_STATUS_INVALID_INTERFACE Invalid interface handle.
  1148. /// @retval TY_STATUS_NULL_POINTER deviceID or deviceHandle is NULL.
  1149. /// @retval TY_STATUS_INVALID_PARAMETER Device not found.
  1150. /// @retval TY_STATUS_BUSY Device has been opened.
  1151. /// @retval TY_STATUS_DEVICE_ERROR Open device failed.
  1152. TY_CAPI TYOpenDevice (TY_INTERFACE_HANDLE ifaceHandle, const char* deviceID, TY_DEV_HANDLE* outDeviceHandle, TY_FW_ERRORCODE* outFwErrorcode=NULL);
  1153. /// @brief Open device by device IP, useful when a device is not listed.
  1154. /// @param [in] ifaceHandle Interface handle.
  1155. /// @param [in] IP Device IP.
  1156. /// @param [out] deviceHandle Handle of opened device.
  1157. /// @retval TY_STATUS_OK Succeed.
  1158. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1159. /// @retval TY_STATUS_INVALID_INTERFACE Invalid interface handle.
  1160. /// @retval TY_STATUS_NULL_POINTER IP or deviceHandle is NULL.
  1161. /// @retval TY_STATUS_INVALID_PARAMETER Device not found.
  1162. /// @retval TY_STATUS_BUSY Device has been opened, may occupied somewhere else.
  1163. /// @retval TY_STATUS_DEVICE_ERROR Open device failed.
  1164. TY_CAPI TYOpenDeviceWithIP (TY_INTERFACE_HANDLE ifaceHandle, const char* IP, TY_DEV_HANDLE* deviceHandle);
  1165. /// @brief Get interface handle by device handle.
  1166. /// @param [in] hDevice Device handle.
  1167. /// @param [out] pIface Interface handle.
  1168. /// @retval TY_STATUS_OK Succeed.
  1169. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1170. /// @retval TY_STATUS_NULL_POINTER pIface is NULL.
  1171. TY_CAPI TYGetDeviceInterface (TY_DEV_HANDLE hDevice, TY_INTERFACE_HANDLE* pIface);
  1172. /// @brief Force a ethernet device to use new IP address, useful when device use persistent IP and cannot be found.
  1173. /// @param [in] ifaceHandle Interface handle.
  1174. /// @param [in] MAC Device MAC, should be "xx:xx:xx:xx:xx:xx".
  1175. /// @param [in] newIP New IP.
  1176. /// @param [in] newNetMask New subnet mask.
  1177. /// @param [in] newGateway New gateway.
  1178. /// @retval TY_STATUS_OK Succeed.
  1179. /// @retval TY_STATUS_NOT_INITED TYInitLib not called.
  1180. /// @retval TY_STATUS_INVALID_INTERFACE Invalid interface handle.
  1181. /// @retval TY_STATUS_WRONG_TYPE Wrong interface type, should be network.
  1182. /// @retval TY_STATUS_NULL_POINTER MAC or newIP/newNetMask/newGateway is NULL.
  1183. /// @retval TY_STATUS_INVALID_PARAMETER MAC is not valid.
  1184. /// @retval TY_STATUS_TIMEOUT No device found.
  1185. /// @retval TY_STATUS_DEVICE_ERROR Set new IP failed.
  1186. TY_CAPI TYForceDeviceIP (TY_INTERFACE_HANDLE ifaceHandle, const char* MAC, const char* newIP, const char* newNetMask, const char* newGateway);
  1187. /// @brief Close device by device handle.
  1188. /// @param [in] hDevice Device handle.
  1189. /// @retval TY_STATUS_OK Succeed.
  1190. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1191. /// @retval TY_STATUS_IDLE Device has been closed.
  1192. TY_CAPI TYCloseDevice (TY_DEV_HANDLE hDevice, bool reboot=false);
  1193. /// @brief Get base info of the open device.
  1194. /// @param [in] hDevice Device handle.
  1195. /// @param [out] info Base info out.
  1196. /// @retval TY_STATUS_OK Succeed.
  1197. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1198. /// @retval TY_STATUS_NULL_POINTER componentIDs is NULL.
  1199. TY_CAPI TYGetDeviceInfo (TY_DEV_HANDLE hDevice, TY_DEVICE_BASE_INFO* info);
  1200. /// @brief Get all components IDs.
  1201. /// @param [in] hDevice Device handle.
  1202. /// @param [out] componentIDs All component IDs this device has. (bit flag).
  1203. /// @retval TY_STATUS_OK Succeed.
  1204. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1205. /// @retval TY_STATUS_NULL_POINTER componentIDs is NULL.
  1206. /// @see TY_DEVICE_COMPONENT_LIST
  1207. TY_CAPI TYGetComponentIDs (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID* componentIDs);
  1208. /// @brief Get all enabled components IDs.
  1209. /// @param [in] hDevice Device handle.
  1210. /// @param [out] componentIDs Enabled component IDs.(bit flag)
  1211. /// @retval TY_STATUS_OK Succeed.
  1212. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1213. /// @retval TY_STATUS_NULL_POINTER componentIDs is NULL.
  1214. /// @see TY_DEVICE_COMPONENT_LIST
  1215. TY_CAPI TYGetEnabledComponents (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID* componentIDs);
  1216. /// @brief Enable components.
  1217. /// @param [in] hDevice Device handle.
  1218. /// @param [in] componentIDs Components to be enabled.
  1219. /// @retval TY_STATUS_OK Succeed.
  1220. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1221. /// @retval TY_STATUS_INVALID_COMPONENT Some components specified by componentIDs are invalid.
  1222. /// @retval TY_STATUS_BUSY Device is capturing.
  1223. TY_CAPI TYEnableComponents (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentIDs);
  1224. /// @brief Disable components.
  1225. /// @param [in] hDevice Device handle.
  1226. /// @param [in] componentIDs Components to be disabled.
  1227. /// @retval TY_STATUS_OK Succeed.
  1228. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1229. /// @retval TY_STATUS_INVALID_COMPONENT Some components specified by componentIDs are invalid.
  1230. /// @retval TY_STATUS_BUSY Device is capturing.
  1231. /// @see TY_DEVICE_COMPONENT_LIST
  1232. TY_CAPI TYDisableComponents (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentIDs);
  1233. /// @brief Get total buffer size of one frame in current configuration.
  1234. /// @param [in] hDevice Device handle.
  1235. /// @param [out] bufferSize Buffer size per frame.
  1236. /// @retval TY_STATUS_OK Succeed.
  1237. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1238. /// @retval TY_STATUS_NULL_POINTER bufferSize is NULL.
  1239. TY_CAPI TYGetFrameBufferSize (TY_DEV_HANDLE hDevice, uint32_t* bufferSize);
  1240. /// @brief Enqueue a user allocated buffer.
  1241. /// @param [in] hDevice Device handle.
  1242. /// @param [in] buffer Buffer to be enqueued.
  1243. /// @param [in] bufferSize Size of the input buffer.
  1244. /// @retval TY_STATUS_OK Succeed.
  1245. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1246. /// @retval TY_STATUS_NULL_POINTER buffer is NULL.
  1247. /// @retval TY_STATUS_WRONG_SIZE The input buffer is not large enough.
  1248. TY_CAPI TYEnqueueBuffer (TY_DEV_HANDLE hDevice, void* buffer, uint32_t bufferSize);
  1249. /// @brief Clear the internal buffer queue, so that user can release all the buffer.
  1250. /// @param [in] hDevice Device handle.
  1251. /// @retval TY_STATUS_OK Succeed.
  1252. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1253. /// @retval TY_STATUS_BUSY Device is capturing.
  1254. TY_CAPI TYClearBufferQueue (TY_DEV_HANDLE hDevice);
  1255. /// @brief Start capture.
  1256. /// @param [in] hDevice Device handle.
  1257. /// @retval TY_STATUS_OK Succeed.
  1258. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1259. /// @retval TY_STATUS_INVALID_COMPONENT No components enabled.
  1260. /// @retval TY_STATUS_BUSY Device has been started.
  1261. /// @retval TY_STATUS_DEVICE_ERROR Start capture failed.
  1262. TY_CAPI TYStartCapture (TY_DEV_HANDLE hDevice);
  1263. /// @brief Stop capture.
  1264. /// @param [in] hDevice Device handle.
  1265. /// @retval TY_STATUS_OK Succeed.
  1266. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1267. /// @retval TY_STATUS_IDLE Device is not capturing.
  1268. /// @retval TY_STATUS_DEVICE_ERROR Stop capture failed.
  1269. TY_CAPI TYStopCapture (TY_DEV_HANDLE hDevice);
  1270. /// @brief Send a software trigger to capture a frame when device works in trigger mode.
  1271. /// @param [in] hDevice Device handle.
  1272. /// @retval TY_STATUS_OK Succeed.
  1273. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1274. /// @retval TY_STATUS_INVALID_FEATURE Not support soft trigger.
  1275. /// @retval TY_STATUS_IDLE Device has not started capture.
  1276. /// @retval TY_STATUS_WRONG_MODE Not in trigger mode.
  1277. TY_CAPI TYSendSoftTrigger (TY_DEV_HANDLE hDevice);
  1278. /// @brief Register device status callback. Register NULL to clean callback.
  1279. /// @param [in] hDevice Device handle.
  1280. /// @param [in] callback Callback function.
  1281. /// @param [in] userdata User private data.
  1282. /// @retval TY_STATUS_OK Succeed.
  1283. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1284. /// @retval TY_STATUS_BUSY Device is capturing.
  1285. TY_CAPI TYRegisterEventCallback (TY_DEV_HANDLE hDevice, TY_EVENT_CALLBACK callback, void* userdata);
  1286. /// @brief Register imu callback. Register NULL to clean callback.
  1287. /// @param [in] hDevice Device handle.
  1288. /// @param [in] callback Callback function.
  1289. /// @param [in] userdata User private data.
  1290. /// @retval TY_STATUS_OK Succeed.
  1291. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1292. /// @retval TY_STATUS_BUSY Device is capturing.
  1293. TY_CAPI TYRegisterImuCallback (TY_DEV_HANDLE hDevice, TY_IMU_CALLBACK callback, void* userdata);
  1294. /// @brief Fetch one frame.
  1295. /// @param [in] hDevice Device handle.
  1296. /// @param [out] frame Frame data to be filled.
  1297. /// @param [in] timeout Timeout in milliseconds. <0 for infinite.
  1298. /// @retval TY_STATUS_OK Succeed.
  1299. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1300. /// @retval TY_STATUS_NULL_POINTER frame is NULL.
  1301. /// @retval TY_STATUS_IDLE Device capturing is not started.
  1302. /// @retval TY_STATUS_WRONG_MODE Callback has been registered, this function is disabled.
  1303. /// @retval TY_STATUS_TIMEOUT Timeout.
  1304. TY_CAPI TYFetchFrame (TY_DEV_HANDLE hDevice, TY_FRAME_DATA* frame, int32_t timeout);
  1305. /// @brief Check whether a component has a specific feature.
  1306. /// @param [in] hDevice Device handle.
  1307. /// @param [in] componentID Component ID.
  1308. /// @param [in] featureID Feature ID.
  1309. /// @param [out] value Whether has feature.
  1310. /// @retval TY_STATUS_OK Succeed.
  1311. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1312. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1313. /// @retval TY_STATUS_NULL_POINTER value is NULL.
  1314. TY_CAPI TYHasFeature (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, bool* value);
  1315. /// @brief Get feature info.
  1316. /// @param [in] hDevice Device handle.
  1317. /// @param [in] componentID Component ID.
  1318. /// @param [in] featureID Feature ID.
  1319. /// @param [out] featureInfo Feature info.
  1320. /// @retval TY_STATUS_OK Succeed.
  1321. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1322. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1323. /// @retval TY_STATUS_NULL_POINTER featureInfo is NULL.
  1324. TY_CAPI TYGetFeatureInfo (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_FEATURE_INFO* featureInfo);
  1325. /// @brief Get value range of integer feature.
  1326. /// @param [in] hDevice Device handle.
  1327. /// @param [in] componentID Component ID.
  1328. /// @param [in] featureID Feature ID.
  1329. /// @param [out] intRange Integer range to be filled.
  1330. /// @retval TY_STATUS_OK Succeed.
  1331. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1332. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1333. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1334. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_INT.
  1335. /// @retval TY_STATUS_NULL_POINTER intRange is NULL.
  1336. TY_CAPI TYGetIntRange (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_INT_RANGE* intRange);
  1337. /// @brief Get value of integer feature.
  1338. /// @param [in] hDevice Device handle.
  1339. /// @param [in] componentID Component ID.
  1340. /// @param [in] featureID Feature ID.
  1341. /// @param [out] value Integer value.
  1342. /// @retval TY_STATUS_OK Succeed.
  1343. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1344. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1345. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1346. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_INT.
  1347. /// @retval TY_STATUS_NULL_POINTER value is NULL.
  1348. TY_CAPI TYGetInt (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, int32_t* value);
  1349. /// @brief Set value of integer feature.
  1350. /// @param [in] hDevice Device handle.
  1351. /// @param [in] componentID Component ID.
  1352. /// @param [in] featureID Feature ID.
  1353. /// @param [in] value Integer value.
  1354. /// @retval TY_STATUS_OK Succeed.
  1355. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1356. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1357. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1358. /// @retval TY_STATUS_NOT_PERMITTED The feature is not writable.
  1359. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_INT.
  1360. /// @retval TY_STATUS_OUT_OF_RANGE value is out of range.
  1361. /// @retval TY_STATUS_BUSY Device is capturing, the feature is locked.
  1362. TY_CAPI TYSetInt (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, int32_t value);
  1363. /// @brief Get value range of float feature.
  1364. /// @param [in] hDevice Device handle.
  1365. /// @param [in] componentID Component ID.
  1366. /// @param [in] featureID Feature ID.
  1367. /// @param [out] floatRange Float range to be filled.
  1368. /// @retval TY_STATUS_OK Succeed.
  1369. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1370. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1371. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1372. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_FLOAT.
  1373. /// @retval TY_STATUS_NULL_POINTER floatRange is NULL.
  1374. TY_CAPI TYGetFloatRange (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_FLOAT_RANGE* floatRange);
  1375. /// @brief Get value of float feature.
  1376. /// @param [in] hDevice Device handle.
  1377. /// @param [in] componentID Component ID.
  1378. /// @param [in] featureID Feature ID.
  1379. /// @param [out] value Float value.
  1380. /// @retval TY_STATUS_OK Succeed.
  1381. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1382. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1383. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1384. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_FLOAT.
  1385. /// @retval TY_STATUS_NULL_POINTER value is NULL.
  1386. TY_CAPI TYGetFloat (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, float* value);
  1387. /// @brief Set value of float feature.
  1388. /// @param [in] hDevice Device handle.
  1389. /// @param [in] componentID Component ID.
  1390. /// @param [in] featureID Feature ID.
  1391. /// @param [in] value Float value.
  1392. /// @retval TY_STATUS_OK Succeed.
  1393. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1394. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1395. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1396. /// @retval TY_STATUS_NOT_PERMITTED The feature is not writable.
  1397. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_FLOAT.
  1398. /// @retval TY_STATUS_OUT_OF_RANGE value is out of range.
  1399. /// @retval TY_STATUS_BUSY Device is capturing, the feature is locked.
  1400. TY_CAPI TYSetFloat (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, float value);
  1401. /// @brief Get number of enum entries.
  1402. /// @param [in] hDevice Device handle.
  1403. /// @param [in] componentID Component ID.
  1404. /// @param [in] featureID Feature ID.
  1405. /// @param [out] entryCount Entry count.
  1406. /// @retval TY_STATUS_OK Succeed.
  1407. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1408. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1409. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1410. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_ENUM.
  1411. /// @retval TY_STATUS_NULL_POINTER entryCount is NULL.
  1412. TY_CAPI TYGetEnumEntryCount (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t* entryCount);
  1413. /// @brief Get list of enum entries.
  1414. /// @param [in] hDevice Device handle.
  1415. /// @param [in] componentID Component ID.
  1416. /// @param [in] featureID Feature ID.
  1417. /// @param [out] entries Output entries.
  1418. /// @param [in] entryCount Array size of input parameter "entries".
  1419. /// @param [out] filledEntryCount Number of filled entries.
  1420. /// @retval TY_STATUS_OK Succeed.
  1421. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1422. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1423. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1424. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_ENUM.
  1425. /// @retval TY_STATUS_NULL_POINTER entries or filledEntryCount is NULL.
  1426. TY_CAPI TYGetEnumEntryInfo (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_ENUM_ENTRY* entries, uint32_t entryCount, uint32_t* filledEntryCount);
  1427. /// @brief Get current value of enum feature.
  1428. /// @param [in] hDevice Device handle.
  1429. /// @param [in] componentID Component ID.
  1430. /// @param [in] featureID Feature ID.
  1431. /// @param [out] value Enum value.
  1432. /// @retval TY_STATUS_OK Succeed.
  1433. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1434. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1435. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1436. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_ENUM.
  1437. /// @retval TY_STATUS_NULL_POINTER value is NULL.
  1438. TY_CAPI TYGetEnum (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t* value);
  1439. /// @brief Set value of enum feature.
  1440. /// @param [in] hDevice Device handle.
  1441. /// @param [in] componentID Component ID.
  1442. /// @param [in] featureID Feature ID.
  1443. /// @param [in] value Enum value.
  1444. /// @retval TY_STATUS_OK Succeed.
  1445. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1446. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1447. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1448. /// @retval TY_STATUS_NOT_PERMITTED The feature is not writable.
  1449. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_ENUM.
  1450. /// @retval TY_STATUS_INVALID_PARAMETER value is invalid.
  1451. /// @retval TY_STATUS_BUSY Device is capturing, the feature is locked.
  1452. TY_CAPI TYSetEnum (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t value);
  1453. /// @brief Get value of bool feature.
  1454. /// @param [in] hDevice Device handle.
  1455. /// @param [in] componentID Component ID.
  1456. /// @param [in] featureID Feature ID.
  1457. /// @param [out] value Bool value.
  1458. /// @retval TY_STATUS_OK Succeed.
  1459. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1460. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1461. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1462. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_BOOL.
  1463. /// @retval TY_STATUS_NULL_POINTER value is NULL.
  1464. TY_CAPI TYGetBool (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, bool* value);
  1465. /// @brief Set value of bool feature.
  1466. /// @param [in] hDevice Device handle.
  1467. /// @param [in] componentID Component ID.
  1468. /// @param [in] featureID Feature ID.
  1469. /// @param [in] value Bool value.
  1470. /// @retval TY_STATUS_OK Succeed.
  1471. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1472. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1473. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1474. /// @retval TY_STATUS_NOT_PERMITTED The feature is not writable.
  1475. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_BOOL.
  1476. /// @retval TY_STATUS_BUSY Device is capturing, the feature is locked.
  1477. TY_CAPI TYSetBool (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, bool value);
  1478. /// @brief Get internal buffer size of string feature.
  1479. /// @param [in] hDevice Device handle.
  1480. /// @param [in] componentID Component ID.
  1481. /// @param [in] featureID Feature ID.
  1482. /// @param [out] size String length including '\0'.
  1483. /// @retval TY_STATUS_OK Succeed.
  1484. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1485. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1486. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1487. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_STRING.
  1488. /// @retval TY_STATUS_NULL_POINTER size is NULL.
  1489. /// @see TYGetString
  1490. TY_CAPI TYGetStringLength (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t* size);
  1491. /// @brief Get value of string feature.
  1492. /// @param [in] hDevice Device handle.
  1493. /// @param [in] componentID Component ID.
  1494. /// @param [in] featureID Feature ID.
  1495. /// @param [out] buffer String buffer.
  1496. /// @param [in] bufferSize Size of buffer.
  1497. /// @retval TY_STATUS_OK Succeed.
  1498. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1499. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1500. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1501. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_STRING.
  1502. /// @retval TY_STATUS_NULL_POINTER buffer is NULL.
  1503. /// @see TYGetStringLength
  1504. TY_CAPI TYGetString (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, char* buffer, uint32_t bufferSize);
  1505. /// @brief Set value of string feature.
  1506. /// @param [in] hDevice Device handle.
  1507. /// @param [in] componentID Component ID.
  1508. /// @param [in] featureID Feature ID.
  1509. /// @param [in] buffer String buffer.
  1510. /// @retval TY_STATUS_OK Succeed.
  1511. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1512. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1513. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1514. /// @retval TY_STATUS_NOT_PERMITTED The feature is not writable.
  1515. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_STRING.
  1516. /// @retval TY_STATUS_NULL_POINTER buffer is NULL.
  1517. /// @retval TY_STATUS_OUT_OF_RANGE Input string is too long.
  1518. /// @retval TY_STATUS_BUSY Device is capturing, the feature is locked.
  1519. TY_CAPI TYSetString (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, const char* buffer);
  1520. /// @brief Get value of struct.
  1521. /// @param [in] hDevice Device handle.
  1522. /// @param [in] componentID Component ID.
  1523. /// @param [in] featureID Feature ID.
  1524. /// @param [out] pStruct Pointer of struct.
  1525. /// @param [in] structSize Size of input buffer pStruct..
  1526. /// @retval TY_STATUS_OK Succeed.
  1527. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1528. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1529. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1530. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_STRUCT.
  1531. /// @retval TY_STATUS_NULL_POINTER pStruct is NULL.
  1532. /// @retval TY_STATUS_WRONG_SIZE structSize incorrect.
  1533. TY_CAPI TYGetStruct (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, void* pStruct, uint32_t structSize);
  1534. /// @brief Set value of struct.
  1535. /// @param [in] hDevice Device handle.
  1536. /// @param [in] componentID Component ID.
  1537. /// @param [in] featureID Feature ID.
  1538. /// @param [in] pStruct Pointer of struct.
  1539. /// @param [in] structSize Size of struct.
  1540. /// @retval TY_STATUS_OK Succeed.
  1541. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1542. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1543. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1544. /// @retval TY_STATUS_NOT_PERMITTED The feature is not writable.
  1545. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_STRUCT.
  1546. /// @retval TY_STATUS_NULL_POINTER pStruct is NULL.
  1547. /// @retval TY_STATUS_WRONG_SIZE structSize incorrect.
  1548. /// @retval TY_STATUS_BUSY Device is capturing, the feature is locked.
  1549. TY_CAPI TYSetStruct (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, void* pStruct, uint32_t structSize);
  1550. /// @brief Get the size of specified byte array zone .
  1551. /// @param [in] hDevice Device handle.
  1552. /// @param [in] componentID Component ID.
  1553. /// @param [in] featureID Feature ID.
  1554. /// @param [out] pSize size of specified byte array zone.
  1555. /// @retval TY_STATUS_OK Succeed.
  1556. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1557. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1558. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1559. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_BYTEARRAY.
  1560. /// @retval TY_STATUS_NULL_POINTER pSize is NULL.
  1561. TY_CAPI TYGetByteArraySize (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t* pSize);
  1562. /// @brief Get the size of device features .
  1563. /// @param [in] hDevice Device handle.
  1564. /// @param [in] componentID Component ID.
  1565. /// @param [out] pSize size of all feature cnt.
  1566. /// @retval TY_STATUS_OK Succeed.
  1567. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1568. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1569. /// @retval TY_STATUS_NULL_POINTER pSize is NULL.
  1570. TY_CAPI TYGetDeviceFeatureNumber (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, uint32_t* size);
  1571. /// @brief Get the all features by comp id.
  1572. /// @param [in] hDevice Device handle.
  1573. /// @param [in] componentID Component ID.
  1574. /// @param [out] featureInfo Output feature info.
  1575. /// @param [in] entryCount Array size of input parameter "featureInfo".
  1576. /// @param [out] filledEntryCount Number of filled featureInfo.
  1577. /// @retval TY_STATUS_OK Succeed.
  1578. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1579. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1580. /// @retval TY_STATUS_NULL_POINTER featureInfo or filledEntryCount is NULL.
  1581. TY_CAPI TYGetDeviceFeatureInfo (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID
  1582. , TY_FEATURE_INFO* featureInfo, uint32_t entryCount, uint32_t* filledEntryCount);
  1583. /// @brief Read byte array from device.
  1584. /// @param [in] hDevice Device handle.
  1585. /// @param [in] componentID Component ID.
  1586. /// @param [in] featureID Feature ID.
  1587. /// @param [out] pbuffer byte buffer.
  1588. /// @param [in] bufferSize Size of buffer.
  1589. /// @retval TY_STATUS_OK Succeed.
  1590. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1591. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1592. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1593. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_BYTEARRAY.
  1594. /// @retval TY_STATUS_NULL_POINTER pbuffer is NULL.
  1595. /// @retval TY_STATUS_WRONG_SIZE bufferSize incorrect.
  1596. TY_CAPI TYGetByteArray (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint8_t* pBuffer, uint32_t bufferSize);
  1597. /// @brief Write byte array to device.
  1598. /// @param [in] hDevice Device handle.
  1599. /// @param [in] componentID Component ID.
  1600. /// @param [in] featureID Feature ID.
  1601. /// @param [out] pbuffer byte buffer.
  1602. /// @param [in] bufferSize Size of buffer.
  1603. /// @retval TY_STATUS_OK Succeed.
  1604. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1605. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1606. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1607. /// @retval TY_STATUS_NOT_PERMITTED The feature is not writable.
  1608. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_BYTEARRAY.
  1609. /// @retval TY_STATUS_NULL_POINTER pbuffer is NULL.
  1610. /// @retval TY_STATUS_WRONG_SIZE bufferSize incorrect.
  1611. /// @retval TY_STATUS_BUSY Device is capturing, the feature is locked.
  1612. TY_CAPI TYSetByteArray (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, const uint8_t* pBuffer, uint32_t bufferSize);
  1613. /// @brief Write byte array to device.
  1614. /// @param [in] hDevice Device handle.
  1615. /// @param [in] componentID Component ID.
  1616. /// @param [in] featureID Feature ID.
  1617. /// @param [out] pAttr byte array attribute to be filled.
  1618. /// @retval TY_STATUS_OK Succeed.
  1619. /// @retval TY_STATUS_INVALID_HANDLE Invalid device handle.
  1620. /// @retval TY_STATUS_INVALID_COMPONENT Invalid component ID.
  1621. /// @retval TY_STATUS_INVALID_FEATURE Invalid feature ID.
  1622. /// @retval TY_STATUS_NOT_PERMITTED The feature is not writable.
  1623. /// @retval TY_STATUS_WRONG_TYPE The feature's type is not TY_FEATURE_BYTEARRAY.
  1624. /// @retval TY_STATUS_NULL_POINTER pbuffer is NULL.
  1625. TY_CAPI TYGetByteArrayAttr (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_BYTEARRAY_ATTR* pAttr);
  1626. //------------------------------------------------------------------------------
  1627. // Version check
  1628. //------------------------------------------------------------------------------
  1629. TY_CAPI _TYInitLib(void);
  1630. static inline TY_STATUS TYInitLib(void)
  1631. {
  1632. TY_VERSION_INFO soVersion;
  1633. TYLibVersion(&soVersion);
  1634. if(!(soVersion.major == TY_LIB_VERSION_MAJOR && soVersion.minor >= TY_LIB_VERSION_MINOR)){
  1635. abort(); // generate fault directly
  1636. }
  1637. return _TYInitLib();
  1638. }
  1639. //------------------------------------------------------------------------------
  1640. // Summary
  1641. //------------------------------------------------------------------------------
  1642. TY_EXTC TY_EXPORT const char* TY_STDC TYErrorString (TY_STATUS errorID);
  1643. inline TY_STATUS TYInitLib (void);
  1644. TY_CAPI TYDeinitLib (void);
  1645. TY_CAPI TYLibVersion (TY_VERSION_INFO* version);
  1646. TY_CAPI TYUpdateInterfaceList ();
  1647. TY_CAPI TYGetInterfaceNumber (uint32_t* pNumIfaces);
  1648. TY_CAPI TYGetInterfaceList (TY_INTERFACE_INFO* pIfaceInfos, uint32_t bufferCount, uint32_t* filledCount);
  1649. TY_CAPI TYHasInterface (const char* ifaceID, bool* value);
  1650. TY_CAPI TYOpenInterface (const char* ifaceID, TY_INTERFACE_HANDLE* outHandle);
  1651. TY_CAPI TYCloseInterface (TY_INTERFACE_HANDLE ifaceHandle);
  1652. TY_CAPI TYUpdateDeviceList (TY_INTERFACE_HANDLE ifaceHandle);
  1653. TY_CAPI TYGetDeviceNumber (TY_INTERFACE_HANDLE ifaceHandle, uint32_t* deviceNumber);
  1654. TY_CAPI TYGetDeviceList (TY_INTERFACE_HANDLE ifaceHandle, TY_DEVICE_BASE_INFO* deviceInfos, uint32_t bufferCount, uint32_t* filledDeviceCount);
  1655. TY_CAPI TYHasDevice (TY_INTERFACE_HANDLE ifaceHandle, const char* deviceID, bool* value);
  1656. TY_CAPI TYOpenDevice (TY_INTERFACE_HANDLE ifaceHandle, const char* deviceID, TY_DEV_HANDLE* outDeviceHandle, TY_FW_ERRORCODE* outFwErrorcode);
  1657. TY_CAPI TYOpenDeviceWithIP (TY_INTERFACE_HANDLE ifaceHandle, const char* IP, TY_DEV_HANDLE* deviceHandle);
  1658. TY_CAPI TYGetDeviceInterface (TY_DEV_HANDLE hDevice, TY_INTERFACE_HANDLE* pIface);
  1659. TY_CAPI TYForceDeviceIP (TY_INTERFACE_HANDLE ifaceHandle, const char* MAC, const char* newIP, const char* newNetMask, const char* newGateway);
  1660. TY_CAPI TYCloseDevice (TY_DEV_HANDLE hDevice, bool reboot);
  1661. TY_CAPI TYGetDeviceInfo (TY_DEV_HANDLE hDevice, TY_DEVICE_BASE_INFO* info);
  1662. TY_CAPI TYGetComponentIDs (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID* componentIDs);
  1663. TY_CAPI TYGetEnabledComponents (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID* componentIDs);
  1664. TY_CAPI TYEnableComponents (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentIDs);
  1665. TY_CAPI TYDisableComponents (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentIDs);
  1666. TY_CAPI TYGetFrameBufferSize (TY_DEV_HANDLE hDevice, uint32_t* outSize);
  1667. TY_CAPI TYEnqueueBuffer (TY_DEV_HANDLE hDevice, void* buffer, uint32_t bufferSize);
  1668. TY_CAPI TYClearBufferQueue (TY_DEV_HANDLE hDevice);
  1669. TY_CAPI TYStartCapture (TY_DEV_HANDLE hDevice);
  1670. TY_CAPI TYStopCapture (TY_DEV_HANDLE hDevice);
  1671. TY_CAPI TYSendSoftTrigger (TY_DEV_HANDLE hDevice);
  1672. TY_CAPI TYRegisterEventCallback (TY_DEV_HANDLE hDevice, TY_EVENT_CALLBACK callback, void* userdata);
  1673. TY_CAPI TYRegisterImuCallback (TY_DEV_HANDLE hDevice, TY_IMU_CALLBACK callback, void* userdata);
  1674. TY_CAPI TYFetchFrame (TY_DEV_HANDLE hDevice, TY_FRAME_DATA* frame, int32_t timeout);
  1675. TY_CAPI TYHasFeature (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, bool* value);
  1676. TY_CAPI TYGetFeatureInfo (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_FEATURE_INFO* featureInfo);
  1677. TY_CAPI TYGetIntRange (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_INT_RANGE* intRange);
  1678. TY_CAPI TYGetInt (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, int32_t* value);
  1679. TY_CAPI TYSetInt (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, int32_t value);
  1680. TY_CAPI TYGetFloatRange (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_FLOAT_RANGE* floatRange);
  1681. TY_CAPI TYGetFloat (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, float* value);
  1682. TY_CAPI TYSetFloat (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, float value);
  1683. TY_CAPI TYGetEnumEntryCount (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t* entryCount);
  1684. TY_CAPI TYGetEnumEntryInfo (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_ENUM_ENTRY* entries, uint32_t entryCount, uint32_t* filledEntryCount);
  1685. TY_CAPI TYGetEnum (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t* value);
  1686. TY_CAPI TYSetEnum (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t value);
  1687. TY_CAPI TYGetBool (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, bool* value);
  1688. TY_CAPI TYSetBool (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, bool value);
  1689. TY_CAPI TYGetStringLength (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t* length);
  1690. TY_CAPI TYGetString (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, char* buffer, uint32_t bufferSize);
  1691. TY_CAPI TYSetString (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, const char* buffer);
  1692. TY_CAPI TYGetStruct (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, void* pStruct, uint32_t structSize);
  1693. TY_CAPI TYSetStruct (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, void* pStruct, uint32_t structSize);
  1694. TY_CAPI TYGetByteArraySize (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint32_t* pSize);
  1695. TY_CAPI TYGetByteArray (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, uint8_t* pBuffer, uint32_t bufferSize);
  1696. TY_CAPI TYSetByteArray (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, const uint8_t* pBuffer, uint32_t bufferSize);
  1697. TY_CAPI TYGetByteArrayAttr (TY_DEV_HANDLE hDevice, TY_COMPONENT_ID componentID, TY_FEATURE_ID featureID, TY_BYTEARRAY_ATTR* pAttr);
  1698. #endif // TY_API_H_