| PDM-IR SDK 3.2.8 PDM-IR_SDK

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

Data Structures | Macros | Typedefs | Enumerations | Functions
PDM-IR_SDK.h File Reference

Go to the source code of this file.

## Data Structures
struct | MODULECONFIG
struct | MODULEINFO

## Macros
#define | WIN32_LEAN_AND_MEAN

## Typedefs
typedef unsigned char | UINT8
typedef signed char | INT8
typedef signed short | INT16
typedef unsigned short | UINT16
typedef unsigned int | UINT32
typedef signed int | INT32

## Enumerations
enum | RESULT { RESULT_OK, RESULT_DATA_OUT_LIMIT_HIGH, RESULT_DATA_OUT_LIMIT_LOW, RESULT_DATA_ERROR, RESULT_ERROR_COMMUNICATION, RESULT_DATA_NOTCOMPATIBLE }
enum | TEMP_VALUES { THIGH = 0, TMEDIUM = 1, TLOW = 2, TLOWEST = 3 }
enum | HOLDOFFTYPE { HOLDOFFTYPE_EDGE = 0, HOLDOFFTYPE_LEVEL = 1 }
enum | GATEMODE { GATEMODE_INTERNAL = 0, GATEMODE_EXTERNAL = 1 }
enum | GATESHAPE { GATESHAPE_FIXEDGATE = 0, GATESHAPE_FREEGATE = 1, GATESHAPE_FREERUNNING = 2 }
enum | TREDGE { TREDGE_LH = 0, TREDGE_HL = 1 }
enum | TRFUNCT { In_AND_Aux = 0, In_OR_Aux = 1, In_XOR_Aux = 2, notIn_AND_Aux = 3, notIn_OR_Aux = 4, notIn_XOR_Aux = 5, In_AND_notAux = 6, In_OR_notAux = 7, In_XOR_notAux = 8, notIn_AND_notAux = 9, notIn_OR_notAux = 10, notIn_XOR_notAux = 11, In_NAND_Aux = 12, In_NOR_Aux = 13, In_XNOR_Aux = 14, notIn_NAND_Aux = 15, notIn_NOR_Aux = 16, notIn_XNOR_Aux = 17, In_NAND_notAux = 18, In_NOR_notAux = 19, In_XNOR_notAux = 20, notIn_NAND_notAux = 21, notIn_NOR_notAux = 22, notIn_XNOR_notAux = 23, only_notIN = 24, only_IN = 25 }
enum | OUTMODE { OUTMODE_TRIGGERGATE = 0, OUTMODE_PHOTONOUT = 1, OUTMODE_HOLDOFF = 2, OUTMODE_VALIDGATE = 3, OUTMODE_INTERNALTRIGGER = 4, OUTMODE_MODULESTATUS = 5 }
enum | COUNTERSTATUS { COUNTERSTATUS_OFF = 0, COUNTERSTATUS_ON = 1, COUNTERSTATUS_Continuous = 2 }
enum | SPAD_TYPE { TYPE_1 = 0x1, TYPE_2 = 0x2, TYPE_3 = 0x3, TYPE_4 = 0x4, TYPE_5 = 0x5, TYPE_6 = 0x6, TYPE_7 = 0x7 }
enum | STATUSBITS { STATUSBITS_OFF = 0, STATUSBITS_ON = 1, STATUSBITS_Updating = 2, STATUSBITS_SafeValue = 3, STATUSBITS_ToBeUpdated = 4, STATUSBITS_Updated = 5 }
enum | STATUSWARMUP { STATUSWARMUP_isWarmingUp = 0, STATUSWARMUP_isSteadyState = 1 }

## Functions
DllSDKExport void | PDMIR_GetVersion (UINT16 *major, UINT16 *minor, UINT16 *revision)
DllSDKExport RESULT | PDMIR_SearchDevices (UINT16 *arrayDataSN, UINT16 *numDevsFound)
DllSDKExport RESULT | PDMIR_OpenCommunication (UINT16 serialNumber)
DllSDKExport RESULT | PDMIR_CloseCommunication (UINT16 serialNumber)
DllSDKExport RESULT | PDMIR_SetAmplitude (UINT16 serialNumber, UINT16 AmplimV)
DllSDKExport RESULT | PDMIR_SetTemperature (UINT16 serialNumber, TEMP_VALUES temp)
DllSDKExport RESULT | PDMIR_SetHoldOff (UINT16 serialNumber, UINT32 holdOff, HOLDOFFTYPE type)
DllSDKExport RESULT | PDMIR_SetGateMode (UINT16 serialNumber, GATEMODE gm)
DllSDKExport RESULT | PDMIR_SetGateShape (UINT16 serialNumber, GATESHAPE gs)
DllSDKExport RESULT | PDMIR_SetTriggerEdge (UINT16 serialNumber, TREDGE TriggerEdge)
DllSDKExport RESULT | PDMIR_SetTriggerInTh (UINT16 serialNumber, INT16 TriggerTh)
DllSDKExport RESULT | PDMIR_SetAuxInTh (UINT16 serialNumber, INT16 TriggerTh)
DllSDKExport RESULT | PDMIR_SetTriggerFunction (UINT16 serialNumber, TRFUNCT TriggerFunction)
DllSDKExport RESULT | PDMIR_SetFrequency (UINT16 serialNumber, UINT32 frequency)
DllSDKExport RESULT | PDMIR_SetTon (UINT16 serialNumber, UINT32 tOn)
DllSDKExport RESULT | PDMIR_SetTTLOut (UINT16 serialNumber, OUTMODE TTLOut)
DllSDKExport RESULT | PDMIR_SetNIMOut (UINT16 serialNumber, OUTMODE NIMOut)
DllSDKExport RESULT | PDMIR_SetDelayTriggerIn (UINT16 serialNumber, UINT8 delay)
DllSDKExport RESULT | PDMIR_SetDelayTriggerInternal (UINT16 serialNumber, UINT8 delay)
DllSDKExport RESULT | PDMIR_SetDelayAuxIn (UINT16 serialNumber, UINT8 delay)
DllSDKExport RESULT | PDMIR_SetDelayGate (UINT16 serialNumber, UINT8 delay)
DllSDKExport RESULT | PDMIR_SetDelayNIMOut (UINT16 serialNumber, UINT8 delay)
DllSDKExport RESULT | PDMIR_SetDelayTTLOut (UINT16 serialNumber, UINT8 delay)
DllSDKExport RESULT | PDMIR_SetCounterIntegrationTime (UINT16 serialNumber, UINT16 integrationTime)
DllSDKExport RESULT | PDMIR_SetCounterAvalancheEnable (UINT16 serialNumber, COUNTERSTATUS Cstatus)
DllSDKExport RESULT | PDMIR_SetCounterValidGateEnable (UINT16 serialNumber, COUNTERSTATUS Cstatus)
DllSDKExport RESULT | PDMIR_SetCounterAuxInEnable (UINT16 serialNumber, COUNTERSTATUS Cstatus)
DllSDKExport RESULT | PDMIR_SetCounterTriggerInEnable (UINT16 serialNumber, COUNTERSTATUS Cstatus)
DllSDKExport RESULT | PDMIR_SetCounterInternalTriggerEnable (UINT16 serialNumber, COUNTERSTATUS Cstatus)
DllSDKExport RESULT | PDMIR_SetModuleOnOff (UINT16 serialNumber, STATUSBITS Mstatus)
DllSDKExport RESULT | PDMIR_GetAmplitude (UINT16 serialNumber, UINT16 *ampi)
DllSDKExport RESULT | PDMIR_GetTemperature (UINT16 serialNumber, TEMP_VALUES *temp)
DllSDKExport RESULT | PDMIR_GetHoldOff (UINT16 serialNumber, UINT32 *holdOff, HOLDOFFTYPE *type)
DllSDKExport RESULT | PDMIR_GetGateMode (UINT16 serialNumber, GATEMODE *gate)
DllSDKExport RESULT | PDMIR_GetGateShape (UINT16 serialNumber, GATESHAPE *shape)
DllSDKExport RESULT | PDMIR_GetTriggerEdge (UINT16 serialNumber, TREDGE *edge)
DllSDKExport RESULT | PDMIR_GetTriggerInTh (UINT16 serialNumber, INT16 *TriggerInTh)
DllSDKExport RESULT | PDMIR_GetAuxInTh (UINT16 serialNumber, INT16 *AuxInTh)
DllSDKExport RESULT | PDMIR_GetTriggerFunction (UINT16 serialNumber, TRFUNCT *function)
DllSDKExport RESULT | PDMIR_GetFrequency (UINT16 serialNumber, UINT32 *freq)
DllSDKExport RESULT | PDMIR_GetTon (UINT16 serialNumber, UINT32 *Ton)
DllSDKExport RESULT | PDMIR_GetTTLOut (UINT16 serialNumber, OUTMODE *TTLOut)
DllSDKExport RESULT | PDMIR_GetNIMOut (UINT16 serialNumber, OUTMODE *NIMOut)
DllSDKExport RESULT | PDMIR_GetDelayTriggerIn (UINT16 serialNumber, UINT8 *delay)
DllSDKExport RESULT | PDMIR_GetDelayTriggerInternal (UINT16 serialNumber, UINT8 *delay)
DllSDKExport RESULT | PDMIR_GetDelayAuxIn (UINT16 serialNumber, UINT8 *delay)
DllSDKExport RESULT | PDMIR_GetDelayGate (UINT16 serialNumber, UINT8 *delay)
DllSDKExport RESULT | PDMIR_GetDelayNIMOut (UINT16 serialNumber, UINT8 *delay)
DllSDKExport RESULT | PDMIR_GetDelayTTLOut (UINT16 serialNumber, UINT8 *delay)
DllSDKExport RESULT | PDMIR_GetCounterIntegrationTime (UINT16 serialNumber, UINT16 *integrationTime)
DllSDKExport RESULT | PDMIR_GetCounterAvalancheStatus (UINT16 serialNumber, COUNTERSTATUS *status)
DllSDKExport RESULT | PDMIR_GetCounterValidGateStatus (UINT16 serialNumber, COUNTERSTATUS *status)
DllSDKExport RESULT | PDMIR_GetCounterAuxInStatus (UINT16 serialNumber, COUNTERSTATUS *status)
DllSDKExport RESULT | PDMIR_GetCounterTriggerInStatus (UINT16 serialNumber, COUNTERSTATUS *status)
DllSDKExport RESULT | PDMIR_GetCounterInternalTriggerStatus (UINT16 serialNumber, COUNTERSTATUS *status)
DllSDKExport RESULT | PDMIR_GetAllCountersStatus (UINT16 serialNumber, COUNTERSTATUS *avalancheStatus, COUNTERSTATUS *validGateStatus, COUNTERSTATUS *auxInStatus, COUNTERSTATUS *triggerInStatus, COUNTERSTATUS *internalTriggerStatus)
DllSDKExport RESULT | PDMIR_GetCounterAvalancheLastValue (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetCounterValidGateLastValue (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetCounterAuxInLastValue (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetCounterTriggerInLastValue (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetCounterInternalTriggerLastValue (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetAllCountersLastValue (UINT16 serialNumber, UINT8 *index, UINT32 *avalancheCounts, UINT32 *validGateCounts, UINT32 *auxInCounts, UINT32 *triggerInCounts, UINT32 *internalTriggerCounts)
DllSDKExport RESULT | PDMIR_GetCounterAvalancheValueAtIndex (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetCounterValidGateValueAtIndex (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetCounterAuxInValueAtIndex (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetCounterTriggerInValueAtIndex (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetCounterInternalTriggerValueAtIndex (UINT16 serialNumber, UINT8 *index, UINT32 *counts)
DllSDKExport RESULT | PDMIR_GetAllCountersValueAtIndex (UINT16 serialNumber, UINT8 *index, UINT32 *avalancheCounts, UINT32 *validGateCounts, UINT32 *auxInCounts, UINT32 *triggerInCounts, UINT32 *internalTriggerCounts)
DllSDKExport RESULT | PDMIR_GetModuleInfo (UINT16 serialNumber, MODULEINFO *info)
DllSDKExport RESULT | PDMIR_GetModuleStatus (UINT16 serialNumber, STATUSBITS *mStatus, STATUSBITS *mTemperature, STATUSBITS *mSpad, STATUSBITS *mGate, STATUSWARMUP *mWarm, UINT32 *errors)
DllSDKExport void | PDMIR_ErrorTranslator (UINT32 error, char *stringOut)
DllSDKExport RESULT | PDMIR_SaveCurrentConfig (UINT16 serialNumber, UINT8 configNumber, char *configName)
DllSDKExport RESULT | PDMIR_SaveCurrentConfigForceOverWrite (UINT16 serialNumber, UINT8 configNumber, char *configName)
DllSDKExport RESULT | PDMIR_DeleteConfig (UINT16 serialNumber, UINT8 configNumber)
DllSDKExport RESULT | PDMIR_SetConfigPowerUp (UINT16 serialNumber, UINT8 configNumber)
DllSDKExport RESULT | PDMIR_LoadConfig (UINT16 serialNumber, UINT8 configNumber)
DllSDKExport RESULT | PDMIR_GetCurrentConfig (UINT16 serialNumber, MODULECONFIG *config)
DllSDKExport RESULT | PDMIR_GetConfigX (UINT16 serialNumber, UINT8 configNumber, MODULECONFIG *config, char *configName)
DllSDKExport RESULT | PDMIR_GetConfigPowerUp (UINT16 serialNumber, UINT8 *configNumber)

## Detailed Description

PDM-IR software development kit.

This C header contains all the functions to operate the PDM-IR in user defined applications.