PS1080.h
Go to the documentation of this file.
1 /*****************************************************************************
2 * *
3 * OpenNI 2.x Alpha *
4 * Copyright (C) 2012 PrimeSense Ltd. *
5 * *
6 * This file is part of OpenNI. *
7 * *
8 * Licensed under the Apache License, Version 2.0 (the "License"); *
9 * you may not use this file except in compliance with the License. *
10 * You may obtain a copy of the License at *
11 * *
12 * http://www.apache.org/licenses/LICENSE-2.0 *
13 * *
14 * Unless required by applicable law or agreed to in writing, software *
15 * distributed under the License is distributed on an "AS IS" BASIS, *
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. *
17 * See the License for the specific language governing permissions and *
18 * limitations under the License. *
19 * *
20 *****************************************************************************/
21 #ifndef _PS1080_H_
22 #define _PS1080_H_
23 
24 #include <OniCTypes.h>
25 
27 #define XN_DEVICE_MAX_STRING_LENGTH 200
28 
29 /*
30  * private properties of PS1080 devices.
31  *
32  * @remarks
33  * properties structure is 0x1080XXYY where XX is range and YY is code.
34  * range values:
35  * F0 - device properties
36  * E0 - device commands
37  * 00 - common stream properties
38  * 10 - depth stream properties
39  * 20 - color stream properties
40  */
41 enum
42 {
43  /*******************************************************************/
44  /* Device properties */
45  /*******************************************************************/
46 
48  XN_MODULE_PROPERTY_USB_INTERFACE = 0x1080F001, // "UsbInterface"
50  XN_MODULE_PROPERTY_MIRROR = 0x1080F002, // "Mirror"
52  XN_MODULE_PROPERTY_RESET_SENSOR_ON_STARTUP = 0x1080F004, // "ResetSensorOnStartup"
54  XN_MODULE_PROPERTY_LEAN_INIT = 0x1080F005, // "LeanInit"
56  XN_MODULE_PROPERTY_SERIAL_NUMBER = 0x1080F006, // "ID"
58  XN_MODULE_PROPERTY_VERSION = 0x1080F007, // "Version"
62  XN_MODULE_PROPERTY_HOST_TIMESTAMPS = 0x1080FF77, // "HostTimestamps"
64  XN_MODULE_PROPERTY_CLOSE_STREAMS_ON_SHUTDOWN = 0x1080FF78, // "CloseStreamsOnShutdown"
66  XN_MODULE_PROPERTY_FIRMWARE_LOG_INTERVAL = 0x1080FF7F, // "FirmwareLogInterval"
68  XN_MODULE_PROPERTY_PRINT_FIRMWARE_LOG = 0x1080FF80, // "FirmwareLogPrint"
70  XN_MODULE_PROPERTY_FIRMWARE_LOG_FILTER = 0x1080FF81, // "FirmwareLogFilter"
72  XN_MODULE_PROPERTY_FIRMWARE_LOG = 0x1080FF82, // "FirmwareLog"
74  XN_MODULE_PROPERTY_FIRMWARE_CPU_INTERVAL = 0x1080FF83, // "FirmwareCPUInterval"
76  XN_MODULE_PROPERTY_PHYSICAL_DEVICE_NAME = 0x1080FF7A, // "PhysicalDeviceName"
78  XN_MODULE_PROPERTY_VENDOR_SPECIFIC_DATA = 0x1080FF7B, // "VendorSpecificData"
80  XN_MODULE_PROPERTY_SENSOR_PLATFORM_STRING = 0x1080FF7C, // "SensorPlatformString"
81 
82  /*******************************************************************/
83  /* Device commands (activated via SetProperty/GetProperty) */
84  /*******************************************************************/
85 
87  XN_MODULE_PROPERTY_FIRMWARE_PARAM = 0x1080E001, // "FirmwareParam"
89  XN_MODULE_PROPERTY_RESET = 0x1080E002, // "Reset"
91  XN_MODULE_PROPERTY_IMAGE_CONTROL = 0x1080E003, // "ImageControl"
93  XN_MODULE_PROPERTY_DEPTH_CONTROL = 0x1080E004, // "DepthControl"
95  XN_MODULE_PROPERTY_AHB = 0x1080E005, // "AHB"
97  XN_MODULE_PROPERTY_LED_STATE = 0x1080E006, // "LedState"
99  XN_MODULE_PROPERTY_EMITTER_STATE = 0x1080E007, // "EmitterState"
100 
102  XN_MODULE_PROPERTY_CMOS_BLANKING_UNITS = 0x1080FF74, // "CmosBlankingUnits"
104  XN_MODULE_PROPERTY_CMOS_BLANKING_TIME = 0x1080FF75, // "CmosBlankingTime"
106  XN_MODULE_PROPERTY_FILE_LIST = 0x1080FF84, // "FileList"
108  XN_MODULE_PROPERTY_FLASH_CHUNK = 0x1080FF85, // "FlashChunk"
109  XN_MODULE_PROPERTY_FILE = 0x1080FF86, // "FlashFile"
111  XN_MODULE_PROPERTY_DELETE_FILE = 0x1080FF87, // "DeleteFile"
112  XN_MODULE_PROPERTY_FILE_ATTRIBUTES = 0x1080FF88, // "FileAttributes"
113  XN_MODULE_PROPERTY_TEC_SET_POINT = 0x1080FF89, // "TecSetPoint"
115  XN_MODULE_PROPERTY_TEC_STATUS = 0x1080FF8A, // "TecStatus"
117  XN_MODULE_PROPERTY_TEC_FAST_CONVERGENCE_STATUS = 0x1080FF8B, // "TecFastConvergenceStatus"
118  XN_MODULE_PROPERTY_EMITTER_SET_POINT = 0x1080FF8C, // "EmitterSetPoint"
120  XN_MODULE_PROPERTY_EMITTER_STATUS = 0x1080FF8D, // "EmitterStatus"
121  XN_MODULE_PROPERTY_I2C = 0x1080FF8E, // "I2C"
123  XN_MODULE_PROPERTY_BIST = 0x1080FF8F, // "BIST"
125  XN_MODULE_PROPERTY_PROJECTOR_FAULT = 0x1080FF90, // "ProjectorFault"
127  XN_MODULE_PROPERTY_APC_ENABLED = 0x1080FF91, // "APCEnabled"
129  XN_MODULE_PROPERTY_FIRMWARE_TEC_DEBUG_PRINT = 0x1080FF92, // "TecDebugPrint"
130 
131  /*******************************************************************/
132  /* Common stream properties */
133  /*******************************************************************/
134 
136  XN_STREAM_PROPERTY_INPUT_FORMAT = 0x10800001, // "InputFormat"
138  XN_STREAM_PROPERTY_CROPPING_MODE = 0x10800002, // "CroppingMode"
139 
140  /*******************************************************************/
141  /* Depth stream properties */
142  /*******************************************************************/
143 
145  XN_STREAM_PROPERTY_CLOSE_RANGE = 0x1080F003, // "CloseRange"
147  XN_STREAM_PROPERTY_PIXEL_REGISTRATION = 0x10801001, // "PixelRegistration"
149  XN_STREAM_PROPERTY_WHITE_BALANCE_ENABLED = 0x10801002, // "WhiteBalancedEnabled"
151  XN_STREAM_PROPERTY_GAIN = 0x10801003, // "Gain"
153  XN_STREAM_PROPERTY_HOLE_FILTER = 0x10801004, // "HoleFilter"
155  XN_STREAM_PROPERTY_REGISTRATION_TYPE = 0x10801005, // "RegistrationType"
157  XN_STREAM_PROPERTY_AGC_BIN = 0x10801006, // "AGCBin"
159  XN_STREAM_PROPERTY_CONST_SHIFT = 0x10801007, // "ConstShift"
161  XN_STREAM_PROPERTY_PIXEL_SIZE_FACTOR = 0x10801008, // "PixelSizeFactor"
163  XN_STREAM_PROPERTY_MAX_SHIFT = 0x10801009, // "MaxShift"
165  XN_STREAM_PROPERTY_PARAM_COEFF = 0x1080100A, // "ParamCoeff"
167  XN_STREAM_PROPERTY_SHIFT_SCALE = 0x1080100B, // "ShiftScale"
175  XN_STREAM_PROPERTY_DCMOS_RCMOS_DISTANCE = 0x1080100F, // "DCRCDIS"
177  XN_STREAM_PROPERTY_S2D_TABLE = 0x10801010, // "S2D"
179  XN_STREAM_PROPERTY_D2S_TABLE = 0x10801011, // "D2S"
183  XN_STREAM_PROPERTY_GMC_MODE = 0x1080FF44, // "GmcMode"
185  XN_STREAM_PROPERTY_GMC_DEBUG = 0x1080FF45, // "GmcDebug"
187  XN_STREAM_PROPERTY_WAVELENGTH_CORRECTION = 0x1080FF46, // "WavelengthCorrection"
189  XN_STREAM_PROPERTY_WAVELENGTH_CORRECTION_DEBUG = 0x1080FF47, // "WavelengthCorrectionDebug"
190 
191  /*******************************************************************/
192  /* Color stream properties */
193  /*******************************************************************/
195  XN_STREAM_PROPERTY_FLICKER = 0x10802001, // "Flicker"
196 };
197 
198 typedef enum
199 {
215 } XnFWVer;
216 
217 typedef enum {
223 } XnSensorVer;
224 
225 typedef enum {
234 } XnHWVer;
235 
236 typedef enum {
241 } XnChipVer;
242 
243 typedef enum
244 {
247 
249 } XnCMOSType;
250 
251 typedef enum
252 {
262 
263 typedef enum
264 {
271 
272 typedef enum
273 {
278 
280 {
286 
287 typedef enum XnProcessingType
288 {
293 
294 typedef enum XnCroppingMode
295 {
300 
301 enum
302 {
306 };
307 
309 {
314 
315 typedef enum
316 {
318  XnLogFilterInfo = 0x0002,
324  XnLogFilterAGC = 0x0080,
326 
327  XnLogFilterAll = 0xFFFF
328 } XnLogFilter;
329 
330 typedef enum
331 {
334 
335 typedef enum
336 {
369 
370 typedef enum XnBistType
371 {
372  //Auto tests
374  XN_BIST_IR_CMOS = 1 << 1,
376  XN_BIST_FLASH = 1 << 3,
380 
381  // Manual tests
384 
385  // Mask of all the auto tests
387 
388 } XnBistType;
389 
390 typedef enum XnBistError
391 {
416 } XnBistError;
417 
418 typedef enum XnDepthCMOSType
419 {
424 
425 typedef enum XnImageCMOSType
426 {
432 
433 #define XN_IO_MAX_I2C_BUFFER_SIZE 10
434 #define XN_MAX_LOG_SIZE (6*1024)
435 
436 #pragma pack (push, 1)
437 
438 typedef struct XnSDKVersion
439 {
440  unsigned char nMajor;
441  unsigned char nMinor;
442  unsigned char nMaintenance;
443  unsigned short nBuild;
444 } XnSDKVersion;
445 
446 typedef struct {
447  unsigned char nMajor;
448  unsigned char nMinor;
449  unsigned short nBuild;
450  unsigned int nChip;
451  unsigned short nFPGA;
452  unsigned short nSystemVersion;
453 
455 
460 } XnVersions;
461 
462 typedef struct
463 {
464  unsigned short nParam;
465  unsigned short nValue;
467 
468 typedef struct XnDepthAGCBin
469 {
470  unsigned short nBin;
471  unsigned short nMin;
472  unsigned short nMax;
473 } XnDepthAGCBin;
474 
476 {
477  unsigned short nRegister;
478  unsigned short nValue;
480 
481 typedef struct XnAHBData
482 {
483  unsigned int nRegister;
484  unsigned int nValue;
485  unsigned int nMask;
486 } XnAHBData;
487 
488 typedef struct XnPixelRegistration
489 {
490  unsigned int nDepthX;
491  unsigned int nDepthY;
493  unsigned int nImageXRes;
494  unsigned int nImageYRes;
495  unsigned int nImageX; // out
496  unsigned int nImageY; // out
498 
499 typedef struct XnLedState
500 {
503 } XnLedState;
504 
505 typedef struct XnCmosBlankingTime
506 {
511 
512 typedef struct XnCmosBlankingUnits
513 {
518 
519 typedef struct XnI2CWriteData
520 {
526 
527 typedef struct XnI2CReadData
528 {
535 } XnI2CReadData;
536 
537 typedef struct XnTecData
538 {
541  uint16_t m_TecDutyCycle; //duty cycle on heater/cooler
542  uint16_t m_HeatMode; //TRUE - heat, FALSE - cool
546  uint16_t m_ScanMode; //0 - crude, 1 - precise
547 } XnTecData;
548 
550 {
551  int16_t m_SetPointTemperature; // set point temperature in celsius,
552  // scaled by factor of 100 (extra precision)
553  int16_t m_MeasuredTemperature; // measured temperature in celsius,
554  // scaled by factor of 100 (extra precision)
555  int32_t m_ProportionalError; // proportional error in system clocks
556  int32_t m_IntegralError; // integral error in system clocks
557  int32_t m_DerivativeError; // derivative error in system clocks
558  uint16_t m_ScanMode; // 0 - initial, 1 - crude, 2 - precise
559  uint16_t m_HeatMode; // 0 - idle, 1 - heat, 2 - cool
560  uint16_t m_TecDutyCycle; // duty cycle on heater/cooler in percents
561  uint16_t m_TemperatureRange; // 0 - cool, 1 - room, 2 - warm
563 
564 typedef struct XnEmitterData
565 {
566  uint16_t m_State; //idle, calibrating
567  uint16_t m_SetPointVoltage; //this is what should be written to the XML
568  uint16_t m_SetPointClocks; //target cross duty cycle
569  uint16_t m_PD_Reading; //current cross duty cycle in system clocks(high time)
570  uint16_t m_EmitterSet; //duty cycle on emitter set in system clocks (high time).
571  uint16_t m_EmitterSettingLogic; //TRUE = positive logic, FALSE = negative logic
572  uint16_t m_LightMeasureLogic; //TRUE - positive logic, FALSE - negative logic
574  uint16_t m_EmitterSetStepSize; // in MilliVolts
575  uint16_t m_ApcTolerance; // in system clocks (only valid up till v5.2)
576  uint16_t m_SubClocking; //in system clocks (only valid from v5.3)
577  uint16_t m_Precision; // (only valid from v5.3)
578 } XnEmitterData;
579 
580 typedef struct
581 {
585 
586 typedef struct
587 {
589  const char* strFileName;
592 
593 typedef struct
594 {
597  unsigned char* pData;
599 
600 typedef struct {
609 } XnFlashFile;
610 
611 typedef struct
612 {
616 
617 typedef struct XnProjectorFaultData
618 {
623 
624 typedef struct XnBist
625 {
628 } XnBist;
629 
630 #pragma pack (pop)
631 
632 #endif //_PS1080_H_
uint16_t nSlaveAddress
Definition: PS1080.h:530
unsigned short nBuild
Definition: PS1080.h:443
struct XnSDKVersion XnSDKVersion
unsigned short nMin
Definition: PS1080.h:471
int32_t m_ProportionalError
Definition: PS1080.h:543
struct XnAHBData XnAHBData
uint16_t m_HeatMode
Definition: PS1080.h:542
unsigned int nRegister
Definition: PS1080.h:483
unsigned char nMinor
Definition: PS1080.h:448
unsigned char nMajor
Definition: PS1080.h:440
XnBistError
Definition: PS1080.h:390
unsigned int nImageY
Definition: PS1080.h:496
XnHWVer
Definition: PS1080.h:225
XnCMOSType nCmosID
Definition: PS1080.h:514
XnFlashFileType
Definition: PS1080.h:335
#define XN_IO_MAX_I2C_BUFFER_SIZE
Definition: PS1080.h:433
struct XnTecData XnTecData
struct XnControlProcessingData XnControlProcessingData
short int16_t
XnFlashFile * pFiles
Definition: PS1080.h:613
XnIODepthFormats
Definition: PS1080.h:263
struct XnLedState XnLedState
uint16_t nWriteSize
Definition: PS1080.h:534
uint16_t nNumberOfFrames
Definition: PS1080.h:509
uint32_t nSize
Definition: PS1080.h:605
unsigned char * pData
Definition: PS1080.h:597
unsigned short uint16_t
uint16_t m_PD_Reading
Definition: PS1080.h:569
struct XnEmitterData XnEmitterData
XnCMOSType
Definition: PS1080.h:243
uint16_t nMaxThreshold
Definition: PS1080.h:620
uint16_t nBus
Definition: PS1080.h:529
int32_t m_DerivativeError
Definition: PS1080.h:545
uint32_t nVersion
Definition: PS1080.h:603
int32_t m_IntegralError
Definition: PS1080.h:544
XnParamResetType
Definition: PS1080.h:272
XnCroppingMode
Definition: PS1080.h:294
int16_t m_MeasuredTemperature
Definition: PS1080.h:553
uint32_t nOffset
Definition: PS1080.h:588
unsigned int nImageXRes
Definition: PS1080.h:493
uint16_t nWriteSize
Definition: PS1080.h:524
XnSDKVersion SDK
Definition: PS1080.h:454
XnChipVer ChipVer
Definition: PS1080.h:459
uint32_t nFailures
Definition: PS1080.h:627
uint16_t nNumberOfFrames
Definition: PS1080.h:516
uint16_t m_ScanMode
Definition: PS1080.h:546
unsigned short nValue
Definition: PS1080.h:478
uint16_t nId
Definition: PS1080.h:601
int16_t m_SetPointTemperature
Definition: PS1080.h:551
XnSensorUsbInterface
Definition: PS1080.h:279
XnProcessingType
Definition: PS1080.h:287
unsigned int nMask
Definition: PS1080.h:485
uint16_t m_IsAPCEnabled
Definition: PS1080.h:573
unsigned short nRegister
Definition: PS1080.h:477
uint16_t m_SetPointVoltage
Definition: PS1080.h:567
struct XnTecFastConvergenceData XnTecFastConvergenceData
unsigned int nValue
Definition: PS1080.h:484
XnCMOSType nCmosID
Definition: PS1080.h:507
struct XnI2CReadData XnI2CReadData
struct XnCmosBlankingUnits XnCmosBlankingUnits
int32_t bProjectorFaultEvent
Definition: PS1080.h:621
float nTimeInMilliseconds
Definition: PS1080.h:508
unsigned short nMax
Definition: PS1080.h:472
unsigned int nChip
Definition: PS1080.h:450
uint16_t m_TemperatureRange
Definition: PS1080.h:561
XnFirmwareCroppingMode
Definition: PS1080.h:308
XnFWVer
Definition: PS1080.h:198
const char * strFileName
Definition: PS1080.h:589
int32_t m_DerivativeError
Definition: PS1080.h:557
uint16_t nAttributes
Definition: PS1080.h:607
uint16_t nSlaveAddress
Definition: PS1080.h:522
uint16_t m_Precision
Definition: PS1080.h:577
uint32_t nOffset
Definition: PS1080.h:595
XnLogFilter
Definition: PS1080.h:315
uint16_t nAttributes
Definition: PS1080.h:590
uint16_t nId
Definition: PS1080.h:582
int int32_t
uint16_t m_State
Definition: PS1080.h:566
uint16_t nType
Definition: PS1080.h:602
uint16_t m_CompensationVoltage
Definition: PS1080.h:540
unsigned short nValue
Definition: PS1080.h:465
uint16_t m_TecDutyCycle
Definition: PS1080.h:541
unsigned short nBin
Definition: PS1080.h:470
uint16_t nMinThreshold
Definition: PS1080.h:619
uint16_t m_SetPointVoltage
Definition: PS1080.h:539
uint16_t m_SubClocking
Definition: PS1080.h:576
uint16_t nFiles
Definition: PS1080.h:614
struct XnPixelRegistration XnPixelRegistration
XnIOImageFormats
Definition: PS1080.h:251
XnHWVer HWVer
Definition: PS1080.h:456
struct XnCmosBlankingTime XnCmosBlankingTime
unsigned short nBuild
Definition: PS1080.h:449
XnBistType
Definition: PS1080.h:370
unsigned int nImageX
Definition: PS1080.h:495
uint16_t nReadSize
Definition: PS1080.h:533
unsigned int nDepthX
Definition: PS1080.h:490
XnFilePossibleAttributes
Definition: PS1080.h:330
uint16_t nReserve
Definition: PS1080.h:608
unsigned char nMinor
Definition: PS1080.h:441
uint32_t nOffset
Definition: PS1080.h:604
struct XnProjectorFaultData XnProjectorFaultData
unsigned int nImageYRes
Definition: PS1080.h:494
XnImageCMOSType
Definition: PS1080.h:425
struct XnDepthAGCBin XnDepthAGCBin
uint16_t m_TecDutyCycle
Definition: PS1080.h:560
unsigned short nSystemVersion
Definition: PS1080.h:452
uint16_t m_EmitterSettingLogic
Definition: PS1080.h:571
uint16_t nCrc
Definition: PS1080.h:606
unsigned int uint32_t
uint16_t nAttribs
Definition: PS1080.h:583
XnDepthCMOSType
Definition: PS1080.h:418
uint16_t nLedID
Definition: PS1080.h:501
uint16_t nState
Definition: PS1080.h:502
uint32_t nTestsMask
Definition: PS1080.h:626
struct XnI2CWriteData XnI2CWriteData
struct XnBist XnBist
XnSensorVer
Definition: PS1080.h:217
unsigned short nParam
Definition: PS1080.h:464
uint16_t m_LightMeasureLogic
Definition: PS1080.h:572
uint16_t nUnits
Definition: PS1080.h:515
int32_t m_ProportionalError
Definition: PS1080.h:555
unsigned char nMaintenance
Definition: PS1080.h:442
XnSensorVer SensorVer
Definition: PS1080.h:458
unsigned char nMajor
Definition: PS1080.h:447
uint16_t m_EmitterSet
Definition: PS1080.h:570
uint16_t m_ApcTolerance
Definition: PS1080.h:575
XnChipVer
Definition: PS1080.h:236
unsigned int nDepthY
Definition: PS1080.h:491
uint32_t nSize
Definition: PS1080.h:596
uint16_t m_SetPointClocks
Definition: PS1080.h:568
XnFWVer FWVer
Definition: PS1080.h:457
uint16_t nDepthValue
Definition: PS1080.h:492
uint16_t nBus
Definition: PS1080.h:521
unsigned short nFPGA
Definition: PS1080.h:451
Definition: PS1080.h:624
uint16_t m_EmitterSetStepSize
Definition: PS1080.h:574


libfreenect
Author(s): Hector Martin, Josh Blake, Kyle Machulis, OpenKinect community
autogenerated on Mon Jun 10 2019 13:46:42