CCAux  2.15.2.0
CCAux API reference
CCAuxTypes.h
Go to the documentation of this file.
1 /************************************************
2  *
3  * CROSSCONTROL AUX API
4  *
5  * CCAuxTypes.h
6  *
7  * Version 2.15.2.0, 2020-07-08
8  *
9  * (c) CrossControl 2010-2020
10  *
11 
12  * File description: Common types
13  *
14  ************************************************/
15 
16 #ifndef CCAUXTYPES_H_
17 #define CCAUXTYPES_H_
18 
19 // CCAux API uses default integer types based on stdint.h with addition of float, double and character types.
20 // stdint.h is not available on all platforms/systems (e.g. Visual Studio for Windows).
21 // Define CCAUX_USE_STDINT_H to use the stdint.h from your build system instead of these defaults.
22 // Define CCAUX_USER_TYPEDEFS to use your own header file entirely.
23 #ifdef CCAUX_USE_STDINT_H
24 #include <stdint.h>
25 typedef float float32_t;
26 typedef double float64_t;
27 typedef char char_t;
28 #else
29 // You can also include your own typedef file.
30 #ifdef CCAUX_USER_TYPEDEFS
31 // This file is not part of CCAux, you must provide it yourself.
32 #include <ccaux_ext_typedefs.h>
33 #else
34 
35 // CCAux default typdefs
36 typedef float float32_t;
37 typedef double float64_t;
38 typedef char char_t;
39 
40 #ifdef _MSC_VER
41 // Microsoft Visual Studio
42 #if (_MSC_VER < 1300)
43 // Visual Studio 6 and Embedded Visual C++ 4
44 typedef signed char int8_t;
45 typedef signed short int16_t;
46 typedef signed int int32_t;
47 typedef unsigned char uint8_t;
48 typedef unsigned short uint16_t;
49 typedef unsigned int uint32_t;
50 #else
51 // VS2003+
52 typedef signed __int8 int8_t;
53 typedef signed __int16 int16_t;
54 typedef signed __int32 int32_t;
55 typedef unsigned __int8 uint8_t;
56 typedef unsigned __int16 uint16_t;
57 typedef unsigned __int32 uint32_t;
58 #endif
59 typedef signed __int64 int64_t;
60 typedef unsigned __int64 uint64_t;
61 
62 #else // _MSC_VER
63 // Other compilers (e.g gcc)
64 typedef signed char int8_t;
65 typedef signed short int16_t;
66 typedef signed int int32_t;
67 typedef unsigned char uint8_t;
68 typedef unsigned short uint16_t;
69 typedef unsigned int uint32_t;
70 #ifdef X64
71 typedef long int int64_t;
72 #else
73 //typedef long long int int64_t;
74 #endif
75 #ifdef X64
76 typedef unsigned long int uint64_t;
77 #else
78 //typedef unsigned long long int uint64_t;
79 #endif
80 
81 #endif // _MSC_VER
82 #endif // CCAUX_USER_TYPEDEFS
83 #endif // CCAUX_USE_STDINT
84 
85 
86 #ifdef __cplusplus
87 namespace CrossControl
88 {
89 #endif
90 
91 #ifndef __cplusplus
92 #define bool int
93 #endif
94 
98 typedef enum
99 {
129 }VoltageEnum;
130 
132 typedef enum
133 {
137 
139 typedef enum
140 {
146 
150 typedef enum
151 {
152  Disabled = 0,
153  Enabled = 1
154 } CCStatus;
155 
159 typedef enum
160 {
179  ERR_EEPROM = 18,
197 } eErr;
198 
202 typedef enum
203 {
208 
212 typedef enum
213 {
214  Analog_Channel_1 = 0, /* Analog video channel 1 */
215  Analog_Channel_2 = 1, /* Analog video channel 2 */
216  Analog_Channel_3 = 2, /* Analog video channel 3 */
217  Analog_Channel_4 = 3, /* Analog video channel 4 */
218  Analog_channel_END /* Marks end of analog channel - list */
219 } VideoChannel;
220 
221 /* Struct used for received video */
223 {
227 };
228 
229 /* Struct used for I2c-accesses to decoder */
231 {
234 };
235 
236 /* Version info struct */
238 {
243 };
244 
245 /* Video standard */
246 /* The video decoder auto detect the video standard */
247 typedef enum
248 {
251  STD_M_PAL = 2,
252  STD_PAL = 3,
253  STD_NTSC = 4,
255 } videoStandard;
256 
257 /* Available video rotation */
258 typedef enum
259 {
260  RotNone = 0,
264 } VideoRotation;
265 
266 typedef struct version_info VersionType;
267 
268 /* Buzzer setup struct */
269 typedef struct
270 {
273 } BuzzerSetup;
274 
275 /* Led timing setup struct */
276 typedef struct
277 {
282 } LedTimingType;
283 
284 /* For FPGA leds */
285 typedef struct
286 {
293 
294 /* Led color struct */
295 typedef struct
296 {
301 
305 typedef enum
306 {
310 } CanFrameType;
311 
326 typedef enum
327 {
339  All_Events = 15,
341 } TriggerConf;
342 
346 typedef enum
347 {
348  NoAction = 0,
351 } PowerAction;
352 
359 typedef enum
360 {
370 
374 typedef enum
375 {
376  OCD_OK = 0,
377  OCD_OC = 1,
379 } OCDStatus;
380 
384 typedef struct
385 {
393 } TimerType;
394 
398 typedef enum
399 {
400  TEMP_CPU = 0,
401  TEMP_BOX = 1,
402  TEMP_ENV = 2,
409 
414 {
423 };
424 
428 typedef struct
429 {
430  enum UpgradeAction currentAction;
433 } UpgradeStatus;
434 
438 typedef enum
439 {
440  RED = 0,
447 } CCAuxColor;
448 
452 typedef enum
453 {
458 } RS4XXPort;
459 
463 typedef enum
464 {
501 } CfgInModeEnum;
502 
506 #define CFGIN_VOLTAGE_3V3 CFGIN_VOLTAGE_2V5
507 #define CFGIN_VOLTAGE_5VPD CFGIN_VOLTAGE_5V
508 
512 typedef enum
513 {
523 
527 typedef enum
528 {
534 } BootModeEnum;
535 
539 typedef enum
540 {
544 
545 
546 typedef enum
547 {
555 } PowerOutput;
556 
560 typedef enum
561 {
569 } SystemMode;
570 
571 
572 #define MAX_BEEP_VOLUME 2000
573 
574 #ifdef __cplusplus
575 }
576 #endif
577 
578 #endif /*CCAUXTYPES_H_*/
579 
Definition: CCAuxTypes.h:127
Definition: CCAuxTypes.h:113
Definition: CCAuxTypes.h:110
uint8_t nrOfPulses
Definition: CCAuxTypes.h:291
Definition: CCAuxTypes.h:193
Definition: CCAuxTypes.h:518
Definition: CCAuxTypes.h:276
uint32_t RunTime60_70
Definition: CCAuxTypes.h:390
uint8_t blue
Definition: CCAuxTypes.h:299
Definition: CCAuxTypes.h:475
Definition: CCAuxTypes.h:401
eErr
Definition: CCAuxTypes.h:159
Definition: CCAuxTypes.h:478
Definition: CCAuxTypes.h:552
Definition: CCAuxTypes.h:514
Definition: CCAuxTypes.h:474
Definition: CCAuxTypes.h:329
Definition: CCAuxTypes.h:493
Definition: CCAuxTypes.h:166
Definition: CCAuxTypes.h:162
SystemMode
Definition: CCAuxTypes.h:560
Definition: CCAuxTypes.h:142
Definition: CCAuxTypes.h:308
Definition: CCAuxTypes.h:141
Definition: CCAuxTypes.h:361
Definition: CCAuxTypes.h:222
Definition: CCAuxTypes.h:169
Definition: CCAuxTypes.h:483
Definition: CCAuxTypes.h:402
Definition: CCAuxTypes.h:204
Definition: CCAuxTypes.h:338
Definition: CCAuxTypes.h:568
double float64_t
Definition: CCAuxTypes.h:26
Definition: CCAuxTypes.h:161
Definition: CCAuxTypes.h:378
uint8_t onTime
Definition: CCAuxTypes.h:288
Definition: CCAuxTypes.h:469
Definition: CCAuxTypes.h:121
Definition: CCAuxTypes.h:454
Definition: CCAuxTypes.h:500
Definition: CCAuxTypes.h:178
Definition: CCAuxTypes.h:529
uint32_t TotHeatTime
Definition: CCAuxTypes.h:388
uint16_t frequency
Definition: CCAuxTypes.h:271
CCStatus
Definition: CCAuxTypes.h:150
Definition: CCAuxTypes.h:348
float float32_t
Definition: CCAuxTypes.h:25
Definition: CCAuxTypes.h:218
Definition: CCAuxTypes.h:120
uint8_t offTime
Definition: CCAuxTypes.h:279
Definition: CCAuxTypes.h:109
Definition: CCAuxTypes.h:565
Definition: CCAuxTypes.h:237
Definition: CCAuxTypes.h:488
uint8_t percent
Definition: CCAuxTypes.h:431
PowerOutput
Definition: CCAuxTypes.h:546
ButtonPowerTransitionStatus
Definition: CCAuxTypes.h:359
Definition: CCAuxTypes.h:520
Definition: CCAuxTypes.h:457
uint8_t register_value
Definition: CCAuxTypes.h:233
Definition: CCAuxTypes.h:362
LightSensorSamplingMode
Definition: CCAuxTypes.h:139
Definition: CCAuxTypes.h:262
Definition: CCAuxTypes.h:182
Definition: CCAuxTypes.h:171
Definition: CCAuxTypes.h:332
Definition: CCAuxTypes.h:484
unsigned __int64 uint64_t
Definition: CCAuxTypes.h:60
Definition: CCAuxTypes.h:172
Definition: CCAuxTypes.h:333
Definition: CCAuxTypes.h:117
Definition: CCAuxTypes.h:445
JidaSensorType
Definition: CCAuxTypes.h:398
Definition: CCAuxTypes.h:444
Definition: CCAuxTypes.h:101
Definition: CCAuxTypes.h:420
Definition: CCAuxTypes.h:442
UpgradeAction
Definition: CCAuxTypes.h:413
Definition: CCAuxTypes.h:553
Definition: CCAuxTypes.h:377
uint32_t RunTime70_80
Definition: CCAuxTypes.h:391
Definition: CCAuxTypes.h:428
Definition: CCAuxTypes.h:177
Definition: CCAuxTypes.h:465
Definition: CCAuxTypes.h:541
Definition: CCAuxTypes.h:551
Definition: CCAuxTypes.h:403
Definition: CCAuxTypes.h:404
Definition: About.h:30
Definition: CCAuxTypes.h:562
Definition: CCAuxTypes.h:563
Definition: CCAuxTypes.h:106
Definition: CCAuxTypes.h:123
Definition: CCAuxTypes.h:104
uint32_t TotSuspTime
Definition: CCAuxTypes.h:387
Definition: CCAuxTypes.h:167
LightSensorOperationRange
Definition: CCAuxTypes.h:132
Definition: CCAuxTypes.h:516
Definition: CCAuxTypes.h:530
Definition: CCAuxTypes.h:173
unsigned short uint16_t
Definition: CCAuxTypes.h:48
Definition: CCAuxTypes.h:215
CCAuxColor
Definition: CCAuxTypes.h:438
Definition: CCAuxTypes.h:532
Definition: CCAuxTypes.h:365
Definition: CCAuxTypes.h:417
Definition: CCAuxTypes.h:486
Definition: CCAuxTypes.h:421
Definition: CCAuxTypes.h:183
unsigned int uint32_t
Definition: CCAuxTypes.h:49
DeInterlaceMode
Definition: CCAuxTypes.h:202
TriggerConf
Definition: CCAuxTypes.h:326
Definition: CCAuxTypes.h:111
Definition: CCAuxTypes.h:422
Definition: CCAuxTypes.h:108
uint8_t onTime
Definition: CCAuxTypes.h:278
PowerAction
Definition: CCAuxTypes.h:346
Definition: CCAuxTypes.h:337
Definition: CCAuxTypes.h:497
Definition: CCAuxTypes.h:185
Definition: CCAuxTypes.h:115
Definition: CCAuxTypes.h:328
Definition: CCAuxTypes.h:533
Definition: CCAuxTypes.h:205
RS4XXPort
Definition: CCAuxTypes.h:452
Definition: CCAuxTypes.h:307
Definition: CCAuxTypes.h:400
Definition: CCAuxTypes.h:367
unsigned char uint8_t
Definition: CCAuxTypes.h:47
Definition: CCAuxTypes.h:415
Definition: CCAuxTypes.h:134
Definition: CCAuxTypes.h:542
Definition: CCAuxTypes.h:112
signed int int32_t
Definition: CCAuxTypes.h:46
Definition: CCAuxTypes.h:107
Definition: CCAuxTypes.h:335
Definition: CCAuxTypes.h:206
Definition: CCAuxTypes.h:366
Definition: CCAuxTypes.h:477
Definition: CCAuxTypes.h:214
Definition: CCAuxTypes.h:490
Definition: CCAuxTypes.h:331
Definition: CCAuxTypes.h:495
Definition: CCAuxTypes.h:492
Definition: CCAuxTypes.h:269
signed __int64 int64_t
Definition: CCAuxTypes.h:59
Definition: CCAuxTypes.h:416
uint8_t decoder_register
Definition: CCAuxTypes.h:232
Definition: CCAuxTypes.h:479
Definition: CCAuxTypes.h:368
Definition: CCAuxTypes.h:384
Definition: CCAuxTypes.h:252
VideoChannel
Definition: CCAuxTypes.h:212
Definition: CCAuxTypes.h:153
Definition: CCAuxTypes.h:440
Definition: CCAuxTypes.h:181
Definition: CCAuxTypes.h:443
uint8_t major
Definition: CCAuxTypes.h:239
Definition: CCAuxTypes.h:119
Definition: CCAuxTypes.h:263
Definition: CCAuxTypes.h:491
Definition: CCAuxTypes.h:376
Definition: CCAuxTypes.h:473
uint8_t build
Definition: CCAuxTypes.h:242
uint8_t offTime
Definition: CCAuxTypes.h:289
VoltageEnum
Definition: CCAuxTypes.h:98
Definition: CCAuxTypes.h:105
uint8_t green
Definition: CCAuxTypes.h:298
Definition: CCAuxTypes.h:481
Definition: CCAuxTypes.h:179
Definition: CCAuxTypes.h:549
Definition: CCAuxTypes.h:295
uint8_t nrOfPulses
Definition: CCAuxTypes.h:281
Definition: CCAuxTypes.h:152
Definition: CCAuxTypes.h:334
Definition: CCAuxTypes.h:180
Definition: CCAuxTypes.h:230
Definition: CCAuxTypes.h:251
Definition: CCAuxTypes.h:118
Definition: CCAuxTypes.h:482
Definition: CCAuxTypes.h:441
Definition: CCAuxTypes.h:406
signed short int16_t
Definition: CCAuxTypes.h:45
Definition: CCAuxTypes.h:468
Definition: CCAuxTypes.h:253
Definition: CCAuxTypes.h:485
Definition: CCAuxTypes.h:174
CanFrameType
Definition: CCAuxTypes.h:305
uint32_t Above80RunTime
Definition: CCAuxTypes.h:392
Definition: CCAuxTypes.h:254
Definition: CCAuxTypes.h:489
Definition: CCAuxTypes.h:126
Definition: CCAuxTypes.h:164
uint32_t RunTime40_60
Definition: CCAuxTypes.h:389
Definition: CCAuxTypes.h:554
Definition: CCAuxTypes.h:194
Definition: CCAuxTypes.h:487
Definition: CCAuxTypes.h:100
Definition: CCAuxTypes.h:125
Definition: CCAuxTypes.h:114
Definition: CCAuxTypes.h:466
Definition: CCAuxTypes.h:195
uint8_t red
Definition: CCAuxTypes.h:297
Definition: CCAuxTypes.h:418
Definition: CCAuxTypes.h:350
signed char int8_t
Definition: CCAuxTypes.h:44
Definition: CCAuxTypes.h:456
Definition: CCAuxTypes.h:217
Definition: CCAuxTypes.h:480
Definition: CCAuxTypes.h:407
uint16_t volume
Definition: CCAuxTypes.h:272
Definition: CCAuxTypes.h:531
Definition: CCAuxTypes.h:128
Definition: CCAuxTypes.h:216
Definition: CCAuxTypes.h:143
Definition: CCAuxTypes.h:550
Definition: CCAuxTypes.h:285
Definition: CCAuxTypes.h:260
Definition: CCAuxTypes.h:446
Definition: CCAuxTypes.h:168
uint8_t idleTime
Definition: CCAuxTypes.h:280
Definition: CCAuxTypes.h:499
CfgInModeEnum
Definition: CCAuxTypes.h:463
OCDStatus
Definition: CCAuxTypes.h:374
Definition: CCAuxTypes.h:340
uint16_t received_width
Definition: CCAuxTypes.h:224
Definition: CCAuxTypes.h:494
uint8_t idleTime
Definition: CCAuxTypes.h:290
videoStandard
Definition: CCAuxTypes.h:247
uint8_t minor
Definition: CCAuxTypes.h:240
Definition: CCAuxTypes.h:566
Definition: CCAuxTypes.h:476
uint32_t TotRunTime
Definition: CCAuxTypes.h:386
Definition: CCAuxTypes.h:467
Definition: CCAuxTypes.h:364
BootModeEnum
Definition: CCAuxTypes.h:527
Definition: CCAuxTypes.h:419
Definition: CCAuxTypes.h:249
Definition: CCAuxTypes.h:309
Definition: CCAuxTypes.h:261
Definition: CCAuxTypes.h:176
Definition: CCAuxTypes.h:471
Definition: CCAuxTypes.h:349
Definition: CCAuxTypes.h:515
Definition: CCAuxTypes.h:336
Definition: CCAuxTypes.h:496
Definition: CCAuxTypes.h:124
Definition: CCAuxTypes.h:470
uint16_t received_height
Definition: CCAuxTypes.h:225
Definition: CCAuxTypes.h:165
Definition: CCAuxTypes.h:363
Definition: CCAuxTypes.h:455
Definition: CCAuxTypes.h:102
Definition: CCAuxTypes.h:175
ButtonConfigEnum
Definition: CCAuxTypes.h:512
Definition: CCAuxTypes.h:548
VideoRotation
Definition: CCAuxTypes.h:258
uint8_t ledNbr
Definition: CCAuxTypes.h:287
eErr errorCode
Definition: CCAuxTypes.h:432
Definition: CCAuxTypes.h:339
Definition: CCAuxTypes.h:196
Definition: CCAuxTypes.h:405
Definition: CCAuxTypes.h:498
char char_t
Definition: CCAuxTypes.h:27
Definition: CCAuxTypes.h:170
Definition: CCAuxTypes.h:135
uint8_t received_framerate
Definition: CCAuxTypes.h:226
uint8_t release
Definition: CCAuxTypes.h:241
Definition: CCAuxTypes.h:103
Definition: CCAuxTypes.h:116
Definition: CCAuxTypes.h:122
Definition: CCAuxTypes.h:472
Definition: CCAuxTypes.h:250
ConfigOnOffTriggerMode
Definition: CCAuxTypes.h:539
Definition: CCAuxTypes.h:163