ADTimePix.h

Go to the documentation of this file.

/*
 * Header file for the ADTimePix3 EPICS driver
 *
 * This file contains the definitions of PV params, and the definition of the ADTimePix3 class and functions.
 *
 * Author:  Kazimierz Gofron
 * Created: June, 2022
 * Last edited: July 20, 2025
 * Copyright (c) : Oak Ridge National Laboratory
 *
 */
 
// header guard
#ifndef ADTIMEPIX_H
#define ADTIMEPIX_H
 
// version numbers
#define ADTIMEPIX_VERSION      1
#define ADTIMEPIX_REVISION     4
#define ADTIMEPIX_MODIFICATION 0
 
 
#include "ADDriver.h"
#include "cpr/cpr.h"
#include <Magick++.h>
#include <json.hpp>
 
// Driver-specific PV string definitions here
/*                                         String                        asyn interface         access  Description  */
#define ADTimePixServalConnectedString     "TPX3_SERVAL_CONNECTED"       // (asynInt32,         r)      Serval Connected,
#define ADTimePixServerNameString          "TPX3_SERVER_NAME"            // (asynOctet,         r)      Server Name
#define ADTimePixDetTypeString             "TPX3_DETECTOR_TYPE"          // (asynOctet,         r)      Detector Type, should be binary DetConnected
#define ADTimePixFWTimeStampString         "TPX3_FW_TIMESTAMP"           // (asynOctet,         r)      Firmware TimeStamp
#define ADTimePixDetConnectedString        "TPX3_DETECTOR_CONNECTED"     // (asynInt32,         r)      Detector Connected,
#define ADTimePixFreeSpaceString           "TPX3_FREE_SPACE"             // (asynInt64          r)      Free Space [Bytes]
#define ADTimePixWriteSpeedString          "TPX3_WRITE_SPEED"            // (asynFloat64,       r)      Hits? [320 Mhits/s]
#define ADTimePixLowerLimitString          "TPX3_LLIM_SPACE"             // (asynInt64,         w)      Lower limit on available disk space [Bytes]
#define ADTimePixLLimReachedString         "TPX3_LLIM_REACH"             // (asynInt32,         r)      Reached Lower disk limit
#define ADTimePixHttpCodeString            "TPX3_HTTP_CODE"              // (asynInt32,         r)      200/OK, 204/NoContent, 302/MovedTemporarily, 400/BadRequest, 404/NotFound, 409/Conflict, 500/InternalError, 503/ServiceUnavailable
 
// Detector Health
#define ADTimePixLocalTempString            "TPX3_LOCAL_TEMP"            // (asynFloat64,       r)      Local Temperature
#define ADTimePixFPGATempString             "TPX3_FPGA_TEMP"             // (asynFloat64,       r)      FPGA Temperature
#define ADTimePixFan1SpeedString            "TPX3_FAN1_SPEED"            // (asynFloat64,       r)      Fan1 Speed
#define ADTimePixFan2SpeedString            "TPX3_FAN2_SPEED"            // (asynFloat64,       r)      Fan Speed
#define ADTimePixBiasVoltageString          "TPX3_BIAS_VOLT_H"           // (asynFloat64,       r)      Bias Voltage
#define ADTimePixHumidityString             "TPX3_HUMIDITY"              // (asynInt32,         r)      Humidity
#define ADTimePixChipTemperatureString      "TPX3_CHIP_TEMPS"            // (asynOctet,         r)      Chip temperature list
#define ADTimePixVDDString                  "TPX3_VDD"                   // (asynOctet,         r)      VDD list
#define ADTimePixAVDDString                 "TPX3_AVDD"                  // (asynOctet,         r)      AVDD list
#define ADTimePixHealthString               "TPX3_HEALTH"                // (asynInt32,         r)      Scan detector/health
 
    // Detector Info
#define ADTimePixIfaceNameString            "TPX3_IFACE"            // (asynOctet,         r)      IfaceName
#define ADTimePixSW_versionString           "TPX3_SW_VER"           // (asynOctet,         r)      SW_version
#define ADTimePixFW_versionString           "TPX3_FW_VER"           // (asynOctet,         r)      FW_version
#define ADTimePixPixCountString             "TPX3_PEL_CNT"          // (asynInt32,         r)      PixCount
#define ADTimePixRowLenString               "TPX3_ROWLEN"           // (asynInt32,         r)      RowLen
#define ADTimePixNumberOfChipsString        "TPX3_NUM_CHIPS"        // (asynInt32,         r)      NumberOfChip
#define ADTimePixNumberOfRowsString         "TPX3_NUM_ROWS"         // (asynInt32,         r)      NumberOfRows
#define ADTimePixMpxTypeString              "TPX3_MPX_TYPE"         // (asynInt32,         r)      MpxType
 
#define ADTimePixBoardsIDString             "TPX3_BOARDS_ID"        // (asynOctet,         r)      Boards->ChipboardId
#define ADTimePixBoardsIPString             "TPX3_BOARDS_IP"        // (asynOctet,         r)      Boards->IpAddress
#define ADTimePixBoardsCh1String            "TPX3_BOARDS_CH1"       // (asynOctet,         r)      Boards->Chip1{Id,Name}
#define ADTimePixBoardsCh2String            "TPX3_BOARDS_CH2"       // (asynOctet,         r)      Boards->Chip2{Id,Name}
#define ADTimePixBoardsCh3String            "TPX3_BOARDS_CH3"       // (asynOctet,         r)      Boards->Chip3{Id,Name}
#define ADTimePixBoardsCh4String            "TPX3_BOARDS_CH4"       // (asynOctet,         r)      Boards->Chip4{Id,Name}
 
#define ADTimePixSuppAcqModesString         "TPX3_ACQ_MODES"        // (asynInt32,         r)      SuppAcqModes
#define ADTimePixClockReadoutString         "TPX3_CLOCK_READ"       // (asynFloat64,       r)      ClockReadout
#define ADTimePixMaxPulseCountString        "TPX3_PULSE_CNT"        // (asynInt32,         r)      MaxPulseCount
#define ADTimePixMaxPulseHeightString       "TPX3_PULSE_HEIGHT"     // (asynFloat64,       r)      MaxPulseHeight
#define ADTimePixMaxPulsePeriodString       "TPX3_PULSE_PERIOD"     // (asynFloat64,       r)      MaxPulsePeriod
#define ADTimePixTimerMaxValString          "TPX3_TIME_MAX"         // (asynFloat64,       r)      TimerMaxVal
#define ADTimePixTimerMinValString          "TPX3_TIME_MIN"         // (asynFloat64,       r)      TimerMinVal
#define ADTimePixTimerStepString            "TPX3_TIME_STEP"        // (asynFloat64,       r)      TimerStep
#define ADTimePixClockTimepixString         "TPX3_CLOCK"            // (asynFloat64,       r)      ClockTimepix
 
    // Detector Config
#define ADTimePixFan1PWMString                  "TPX3_FAN1PWM"           // (asynInt32,         r)   Fan1PWM   
#define ADTimePixFan2PWMString                  "TPX3_FAN2PWM"           // (asynInt32,         r)   Fan2PWM   
#define ADTimePixBiasVoltString                 "TPX3_BIAS_VOLT_R"       // (asynInt32,         r)   BiasVoltage
#define ADTimePixBiasEnableString               "TPX3_BIAS_ENBL"         // (asynInt32,         r)   BiasEnabled
#define ADTimePixChainModeString                "TPX3_CHAIN_MODE"        // (asynInt32,         r)   ChainMode
#define ADTimePixTriggerInString                "TPX3_TRIGGER_IN"        // (asynInt32,         r)   TriggerIn
#define ADTimePixTriggerOutString               "TPX3_TRIGGER_OUT"       // (asynInt32,         r)   TriggerOut
#define ADTimePixPolarityString                 "TPX3_POLARITY"          // (asynInt32,         r)   Polarity
#define ADTimePixTriggerModeString              "TPX3_TRIGGER_MODE"      // (asynOctet,         r)   TriggerMode
#define ADTimePixExposureTimeString             "TPX3_EXPOSURE_TIME"     // (asynFloat64,       r)   ExposureTime
#define ADTimePixTriggerPeriodString            "TPX3_TRIGGER_PERIOD"    // (asynFloat64,       r)   TriggerPeriod
#define ADTimePixnTriggersString                "TPX3_NTRIGGERS"         // (asynInt32,         r)   nTriggers
#define ADTimePixPeriphClk80String              "TPX3_PERIPH_CLK80"      // (asynInt32,         r)   PeriphClk80
#define ADTimePixTriggerDelayString             "TPX3_TRIG_DELAY"        // (asynFloat64,       r)   TriggerDelay
#define ADTimePixTdcString                      "TPX3_TDC"               // (asynOctet,         r)   Tdc
#define ADTimePixTdc0String                      "TPX3_TDC0"             // (asynInt32,         r)   Tdc0
#define ADTimePixTdc1String                      "TPX3_TDC1"             // (asynInt32,         r)   Tdc1
#define ADTimePixGlobalTimestampIntervalString  "TPX3_GL_TIMESTAMP_INT"  // (asynFloat64,       r)   GlobalTimestampInterval
#define ADTimePixExternalReferenceClockString   "TPX3_EXT_REF_CLOCK"     // (asynInt32,         r)   ExternalReferenceClock
#define ADTimePixLogLevelString                 "TPX3_LOG_LEVEL"         // (asynInt32,         r)   LogLevel
 
// Detector Chips: Chip0; Chips count from 0-3. The index come from ADDR parameter
#define ADTimePixCP_PLLString              "TPX3_CP_PLL"           // (asynInt32,         r)      DACs->Ibias_CP_PLL
#define ADTimePixDiscS1OFFString           "TPX3_DISCS1OFF"        // (asynInt32,         r)      DACs->Ibias_DiscS1_OFF
#define ADTimePixDiscS1ONString            "TPX3_DISCS1ON"         // (asynInt32,         r)      DACs->Ibias_DiscS1_ON
#define ADTimePixDiscS2OFFString           "TPX3_DISCS2OFF"        // (asynInt32,         r)      DACs->Ibias_DiscS2_OFF
#define ADTimePixDiscS2ONString            "TPX3_DISCS2ON"         // (asynInt32,         r)      DACs->Ibias_DiscS2_ON
#define ADTimePixIkrumString               "TPX3_IKRUM"            // (asynInt32,         r)      DACs->Ibias_Ikrum
#define ADTimePixPixelDACString            "TPX3_PIXELDAC"         // (asynInt32,         r)      DACs->Ibias_PixelDAC
#define ADTimePixPreampOFFString           "TPX3_PREAMPOFF"        // (asynInt32,         r)      DACs->Ibias_Preamp_OFF
#define ADTimePixPreampONString            "TPX3_PREAMPON"         // (asynInt32,         r)      DACs->Ibias_Preamp_ON
#define ADTimePixTPbufferInString          "TPX3_TPBUFFERIN"       // (asynInt32,         r)      DACs->Ibias_TPbufferIn
#define ADTimePixTPbufferOutString         "TPX3_TPBUFFEROUT"      // (asynInt32,         r)      DACs->Ibias_TPbufferOut
#define ADTimePixPLL_VcntrlString          "TPX3_PLL_VCNTRL"       // (asynInt32,         r)      DACs->PLL_Vcntrl
#define ADTimePixVPreampNCASString         "TPX3_VPREAMPNCAS"      // (asynInt32,         r)      DACs->VPreamp_NCAS
#define ADTimePixVTPcoarseString           "TPX3_VTP_COARSE"       // (asynInt32,         r)      DACs->VTP_coarse
#define ADTimePixVTPfineString             "TPX3_VTP_FINE"         // (asynInt32,         r)      DACs->VTP_fine
#define ADTimePixVfbkString                "TPX3_VFBK"             // (asynInt32,         r)      DACs->Vfbk
#define ADTimePixVthresholdCoarseString    "TPX3_VTH_COARSE"       // (asynInt32,         r)      DACs->Vthreshold_coarse
#define ADTimePixVthresholdFineString      "TPX3_VTH_FINE"         // (asynInt32,         r)      DACs->Vthreshold_fine
#define ADTimePixAdjustString              "TPX3_ADJUST"           // (asynInt32,         r)      DACs->Adjust
// Chip Layout
#define ADTimePixDetectorOrientationString  "TPX3_DET_ORIENTATION"     // (asynInt32,         r)      DetectorOrientation, in Detector/Layout since 3.0.0
#define ADTimePixLayoutString               "TPX3_LAYOUT"              // (asynOctet,         r)      Chip layout
// Chip Temperature
#define ADTimePixChipNTemperatureString     "TPX3_CHIP_TEMP"           // (asynInt32,         r)      Chip N temperature
// Chip VDD, AVDD
#define ADTimePixChipN_VDDString     "TPX3_CHIP_VDD"           // (asynFloat64,         r)      Chip N VDD
#define ADTimePixChipN_AVDDString     "TPX3_CHIP_AVDD"          // (asynFloat64,         r)      Chip N AVDD
 
    // Absolute path to the binary pixel configuration, absolute path to the text chips configuration
#define ADTimePixBPCFilePathString          "BPC_FILE_PATH"             
#define ADTimePixBPCFilePathExistsString    "BPC_FILE_PATH_EXISTS"      
#define ADTimePixBPCFileNameString          "BPC_FILE_NAME"             
#define ADTimePixDACSFilePathString         "DACS_FILE_PATH"            
#define ADTimePixDACSFilePathExistsString   "DACS_FILE_PATH_EXISTS"     
#define ADTimePixDACSFileNameString         "DACS_FILE_NAME"            
#define ADTimePixWriteMsgString             "WRITE_FILE_MESSAGE"        
#define ADTimePixWriteBPCFileString         "WRITE_BPC_FILE"            
#define ADTimePixWriteDACSFileString        "WRITE_DACS_FILE"           
    // Server, write data channels
#define ADTimePixWriteDataString           "TPX3_WRITE_DATA"          // (asynInt32,         w)      Write Data output channels (raw,img,preview)
#define ADTimePixWriteRawString            "TPX3_WRITE_RAW"           // (asynInt32,         w)      Write Data output channels (raw)
#define ADTimePixWriteRaw1String           "TPX3_WRITE_RAW1"          // (asynInt32,         w)      Write Data output channels (raw), Serval 3.3.0
#define ADTimePixWriteImgString            "TPX3_WRITE_IMG"           // (asynInt32,         w)      Write Data output channels (img)
#define ADTimePixWritePrvImgString         "TPX3_WRITE_PRVIMG"        // (asynInt32,         w)      Write Data output channels (preview->img)
#define ADTimePixWritePrvImg1String        "TPX3_WRITE_PRVIMG1"       // (asynInt32,         w)      Write Data output channels (preview->img1)
#define ADTimePixWritePrvHstString         "TPX3_WRITE_PRVHST"        // (asynInt32,         w)      Write Data output channels (preview->hst)
    // Server, read data channels from Serval
#define ADTimePixWriteRawReadString            "TPX3_WRITE_RAW_RBV"           // (asynInt32,         w)      Write Data output channels (raw)
#define ADTimePixWriteRaw1ReadString           "TPX3_WRITE_RAW1_RBV"          // (asynInt32,         w)      Write Data output channels (raw), Serval 3.3.0
#define ADTimePixWriteImgReadString            "TPX3_WRITE_IMG_RBV"           // (asynInt32,         w)      Write Data output channels (img)
#define ADTimePixWritePrvImgReadString         "TPX3_WRITE_PRVIMG_RBV"        // (asynInt32,         w)      Write Data output channels (preview->img)
#define ADTimePixWritePrvImg1ReadString        "TPX3_WRITE_PRVIMG1_RBV"       // (asynInt32,         w)      Write Data output channels (preview->img1)
#define ADTimePixWritePrvHstReadString         "TPX3_WRITE_PRVHST_RBV"        // (asynInt32,         w)      Write Data output channels (preview->hst)
 
    // Server, raw
#define ADTimePixRawBaseString              "TPX3_RAW_BASE"             // (asynOctet,         w)      Raw Destination Base
#define ADTimePixRawFilePatString           "TPX3_RAW_FILEPAT"          // (asynOctet,         w)      Raw Destination File Pattern
#define ADTimePixRawSplitStrategyString     "TPX3_RAW_SPLITSTG"         // (asynInt32,         w)      Raw Destination Split Strategy
#define ADTimePixRawQueueSizeString         "TPX3_RAW_QUEUESIZE"        // (asynInt32,         w)      Raw Destination Queue Size
#define ADTimePixRawFilePathExistsString    "RAW_FILE_PATH_EXISTS"      // (asynInt32,       r/w) File path exists? */
 
    // Server, raw stream or .tpx3 file (Serval 3.3.0)
#define ADTimePixRaw1BaseString              "TPX3_RAW1_BASE"            // (asynOctet,         w)      Raw Destination Base
#define ADTimePixRaw1FilePatString           "TPX3_RAW1_FILEPAT"         // (asynOctet,         w)      Raw Destination File Pattern
#define ADTimePixRaw1SplitStrategyString     "TPX3_RAW1_SPLITSTG"        // (asynInt32,         w)      Raw Destination Split Strategy
#define ADTimePixRaw1QueueSizeString         "TPX3_RAW1_QUEUESIZE"       // (asynInt32,         w)      Raw Destination Queue Size
#define ADTimePixRaw1FilePathExistsString    "RAW1_FILE_PATH_EXISTS"     // (asynInt32,       r/w) File path exists? */
 
    // Server, Image, ImageChannels[0]
#define ADTimePixImgBaseString               "TPX3_IMG_IMGBASE"          // (asynOctet,         w)      ImageChannels Base file (Place raw files) 
#define ADTimePixImgFilePatString            "TPX3_IMG_IMGPAT"           // (asynOctet,         w)      ImageChannels FilePattern 
#define ADTimePixImgFormatString             "TPX3_IMG_IMGFORMAT"        // (asynInt32,         w)      ImageChannels Format
#define ADTimePixImgModeString               "TPX3_IMG_IMGMODE"          // (asynInt32,         w)      ImageChannels Mode
#define ADTimePixImgThsString                "TPX3_IMG_IMGTHS"           // (asynOctet,         w)      ImageChannels Thresholds (used by MPX3, not used for TPX3)
#define ADTimePixImgIntSizeString            "TPX3_IMG_INTSIZE"          // (asynInt32,         w)      ImageChannels IntegrationSize
#define ADTimePixImgIntModeString            "TPX3_IMG_INTMODE"          // (asynInt32,         w)      ImageChannels IntegrationMode
#define ADTimePixImgStpOnDskLimString        "TPX3_IMG_STPONDSK"         // (asynInt32,         w)      ImageChannels StopMeasurementOnDiskLimit
#define ADTimePixImgQueueSizeString          "TPX3_IMG_QUEUESIZE"        // (asynInt32,         w)      ImageChannels QueueSize
#define ADTimePixImgFilePathExistsString     "IMG_FILE_PATH_EXISTS"      // (asynInt32,       r/w)      File path exists? */
 
    // Server, Preview
#define ADTimePixPrvPeriodString            "TPX3_PRV_PERIOD"           // (asynFloat64,       w)      Preview Period
#define ADTimePixPrvSamplingModeString      "TPX3_PRV_SAMPLMODE"        // (asynOctet,         w)      Preview Sampling Mode
    // Server, Preview, ImageChannels[0]
#define ADTimePixPrvImgBaseString               "TPX3_PRV_IMGBASE"          // (asynOctet,         w)      Preview ImageChannels Base file (Place raw files) 
#define ADTimePixPrvImgFilePatString            "TPX3_PRV_IMGPAT"           // (asynOctet,         w)      Preview ImageChannels FilePattern 
#define ADTimePixPrvImgFormatString             "TPX3_PRV_IMGFORMAT"        // (asynInt32,         w)      Preview ImageChannels Format
#define ADTimePixPrvImgModeString               "TPX3_PRV_IMGMODE"          // (asynInt32,         w)      Preview ImageChannels Mode
#define ADTimePixPrvImgThsString                "TPX3_PRV_IMGTHS"           // (asynOctet,         w)      Preview ImageChannels Thresholds
#define ADTimePixPrvImgIntSizeString            "TPX3_PRV_INTSIZE"          // (asynInt32,         w)      Preview ImageChannels IntegrationSize
#define ADTimePixPrvImgIntModeString            "TPX3_PRV_INTMODE"          // (asynInt32,         w)      Preview ImageChannels IntegrationMode
#define ADTimePixPrvImgStpOnDskLimString        "TPX3_PRV_STPONDSK"         // (asynInt32,         w)      Preview ImageChannels StopMeasurementOnDiskLimit
#define ADTimePixPrvImgQueueSizeString          "TPX3_PRV_QUEUESIZE"        // (asynInt32,         w)      Preview ImageChannels QueueSize
#define ADTimePixPrvImgFilePathExistsString     "PRV_IMG_FILE_PATH_EXISTS"  // (asynInt32,       r/w)      File path exists? */
    // Server, Preview, ImageChannels[1]
#define ADTimePixPrvImg1BaseString            "TPX3_PRV_IMG1BASE"          // (asynOctet,         w)      Preview ImageChannels Preview files Base
#define ADTimePixPrvImg1FilePatString         "TPX3_PRV_IMG1PAT"            // (asynOctet,        w)      Preview ImageChannels FilePattern 
#define ADTimePixPrvImg1FormatString          "TPX3_PRV_IMG1FORMAT"        // (asynInt32,         w)      Preview ImageChannels Preview files Format
#define ADTimePixPrvImg1ModeString            "TPX3_PRV_IMG1MODE"          // (asynInt32,         w)      Preview ImageChannels Preview files Mode
#define ADTimePixPrvImg1ThsString             "TPX3_PRV_IMG1THS"           // (asynOctet,         w)      Preview ImageChannels Preview files Thresholds
#define ADTimePixPrvImg1IntSizeString         "TPX3_PRV_IMG1INTSIZE"       // (asynInt32,         w)      Preview ImageChannels Preview files IntegrationSize
#define ADTimePixPrvImg1IntModeString         "TPX3_PRV_IMG1INTMODE"       // (asynInt32,         w)      Preview ImageChannels IntegrationMode
#define ADTimePixPrvImg1StpOnDskLimString     "TPX3_PRV_IMG1STPONDSK"      // (asynInt32,         w)      Preview ImageChannels Preview files StopMeasurementOnDiskLimit
#define ADTimePixPrvImg1QueueSizeString       "TPX3_PRV_IMG1QUEUESIZE"     // (asynInt32,         w)      Preview ImageChannels Preview files QueueSize
#define ADTimePixPrvImg1FilePathExistsString  "PRV_IMG1_FILE_PATH_EXISTS"  // (asynInt32,       r/w)      File path exists? */
 
    // Server, Preview, HistogramChannels[0]
#define ADTimePixPrvHstBaseString               "TPX3_PRV_HSTBASE"          // (asynOctet,         w)      Preview HistogramChannels Base file (Place raw files) 
#define ADTimePixPrvHstFilePatString            "TPX3_PRV_HSTPAT"           // (asynOctet,         w)      Preview HistogramChannels FilePattern 
#define ADTimePixPrvHstFormatString             "TPX3_PRV_HSTFORMAT"        // (asynInt32,         w)      Preview HistogramChannels Format
#define ADTimePixPrvHstModeString               "TPX3_PRV_HSTMODE"          // (asynInt32,         w)      Preview HistogramChannels Mode
#define ADTimePixPrvHstThsString                "TPX3_PRV_HSTTHS"           // (asynOctet,         w)      Preview HistogramChannels Thresholds
#define ADTimePixPrvHstIntSizeString            "TPX3_PRV_HSTINTSIZE"       // (asynInt32,         w)      Preview HistogramChannels IntegrationSize
#define ADTimePixPrvHstIntModeString            "TPX3_PRV_HSTINTMODE"       // (asynInt32,         w)      Preview HistogramChannels IntegrationMode
#define ADTimePixPrvHstStpOnDskLimString        "TPX3_PRV_HSTSTPONDSK"      // (asynInt32,         w)      Preview HistogramChannels StopMeasurementOnDiskLimit
#define ADTimePixPrvHstQueueSizeString          "TPX3_PRV_HSTQUEUESIZE"     // (asynInt32,         w)      Preview HistogramChannels QueueSize
#define ADTimePixPrvHstNumBinsString            "TPX3_PRV_HSTNBINS"         // (asynInt32,         w)      Preview HistogramChannels NumberOfBins
#define ADTimePixPrvHstBinWidthString           "TPX3_PRV_HSTBINWIDTH"      // (asynFloat64,       w)      Preview HistogramChannels BinWidth
#define ADTimePixPrvHstOffsetString             "TPX3_PRV_HSTOFFSET"        // (asynFloat64,       w)      Preview HistogramChannels Offset
#define ADTimePixPrvHstFilePathExistsString     "PRV_HST_FILE_PATH_EXISTS"  // (asynInt32,       r/w)      File path exists? */
 
    // Measurement
#define ADTimePixPelRateString               "TPX3_PEL_RATE"          // (asynInt32,         w)      PixelEventRate
#define ADTimePixTdc1RateString              "TPX3_TDC1_RATE"         // (asynInt32,         w)      Tdc1EventRate
#define ADTimePixTdc2RateString              "TPX3_TDC2_RATE"         // (asynInt32,         w)      Tdc2EventRate
#define ADTimePixStartTimeString             "TPX3_START_TIME"        // (asynInt64,         w)      StartDateTime
#define ADTimePixElapsedTimeString           "TPX3_ELAPSED_TIME"      // (asynFloat64,       w)      ElapsedTime
#define ADTimePixTimeLeftString              "TPX3_TIME_LEFT"         // (asynFloat64,       w)      TimeLeft
#define ADTimePixFrameCountString            "TPX3_FRAME_COUNT"       // (asynInt32,         w)      FrameCount
#define ADTimePixDroppedFramesString         "TPX3_DROPPED_FRAMES"    // (asynInt32,         w)      DroppedFrames
#define ADTimePixStatusString                "TPX3_MSMT_STATUS"       // (asynOctet,         w)      Status
 
// BPC Mask
#define ADTimePixBPCString               "TPX3_BPC_PEL"               // (asynInt32,         w)      BPC pel for each pixel, read from .bpc file
#define ADTimePixBPCnString              "TPX3_BPC_PEL_N"             // (asynInt32,         w)      BPC pel number of masked pel from .bpc file
#define ADTimePixBPCmaskedString         "TPX3_BPC_PEL_MASKED"        // (asynInt32,         w)      BPC array of pel masked in .bpc file (typically 36-44 values)
#define ADTimePixMaskBPCString           "TPX3_MASK_ARRAY_BPC"        // (asynInt32,         w)      BPC mask to enable/disable pixel counting, AD mask image
#define ADTimePixMaskOnOffPelString      "TPX3_MASK_ONOFF_PEL"        // (asynInt32,         w)      BPC mask positive/negative mask (count/not count)
#define ADTimePixMaskResetString         "TPX3_MASK_RESET"            // (asynInt32,         w)      BPC mask initialize to 0 or 1 OnOffPel value
#define ADTimePixMaskMinXString          "TPX3_MASK_MINX"             // (asynInt32,         w)      BPC mask rectangular/circular X
#define ADTimePixMaskSizeXString         "TPX3_MASK_SIZEX"            // (asynInt32,         w)      BPC mask rectangular SizeX
#define ADTimePixMaskMinYString          "TPX3_MASK_MINY"             // (asynInt32,         w)      BPC mask rectangular/circular Y
#define ADTimePixMaskSizeYString         "TPX3_MASK_SIZEY"            // (asynInt32,         w)      BPC mask rectangular SizeY
#define ADTimePixMaskRadiusString        "TPX3_MASK_RADIUS"           // (asynInt32,         w)      BPC mask circular Radius
#define ADTimePixMaskRectangleString     "TPX3_MASK_RECTANGLE"        // (asynInt32,         w)      BPC mask rectangle mask write to array
#define ADTimePixMaskCircleString        "TPX3_MASK_CIRCLE"           // (asynInt32,         w)      BPC mask circular mask write to array
#define ADTimePixMaskFileNameString      "TPX3_MASK_FILENAME"         // (asynOctet,         w)      BPC mask FileName, file written to original location of .bpc
#define ADTimePixMaskPelString           "TPX3_MASK_PEL"              // (asynInt32,         w)      BPC extract masked pel in vendor calibration .bpc File
#define ADTimePixMaskWriteString         "TPX3_MASK_WRITE"            // (asynInt32,         w)      BPC write mask to new calibration .bpc File and push to TimePix3 FPGA
 
// Control
#define ADTimePixRawStreamString              "TPX3_RAW_STREAM"        // (asynInt32,         w)      file:/, http://, tcp://
#define ADTimePixRaw1StreamString             "TPX3_RAW1_STREAM"       // (asynInt32,         w)      file:/, http://, tcp://; Serval 3.3.0
#define ADTimePixPrvHstStreamString           "TPX3_PRV_HST_STREAM"    // (asynInt32,         w)      file:/, http://, tcp://
 
 
using namespace Magick;
using json = nlohmann::json;
 
 
 
// ----------------------------------------
// ADTimePix3 Data Structures
//-----------------------------------------
 
// Place any in use Data structures here
 
 
 
/*
 * Class definition of the ADTimePix driver. It inherits from the base ADDriver class
 *
 * Includes constructor/destructor, PV params, function definitions and variable definitions
 *
 */
class ADTimePix : public ADDriver{
 
    public:
 
        // Constructor - NOTE THERE IS A CHANCE THAT YOUR CAMERA DOES NOT CONNECT WITH SERVAL # AND THIS MUST BE CHANGED
        ADTimePix(const char* portName, const char* serial, int maxBuffers, size_t maxMemory, int priority, int stackSize);
 
 
        // ADDriver overrides
        virtual asynStatus writeOctet(asynUser *pasynUser, const char *value, size_t nChars, size_t *nActual);
        virtual asynStatus writeInt32(asynUser* pasynUser, epicsInt32 value);
        virtual asynStatus writeFloat64(asynUser* pasynUser, epicsFloat64 value);
 
        asynStatus rotateLayout();
 
        // Declaration for the new function in the driver class
        virtual asynStatus readInt32Array(asynUser *pasynUser, epicsInt32 *value, size_t nElements, size_t *nIn);
 
        asynStatus maskReset(epicsInt32 *buf, int OnOff);
        asynStatus maskRectangle(epicsInt32 *buf, int nX,int nXsize, int nY, int nYsize, int OnOff);
        asynStatus maskCircle(epicsInt32 *buf, int nX,int nY, int nRadius, int OnOff);
        asynStatus readBPCfile(char **buf, int *bufSize);
        asynStatus writeBPCfile(char **buf, int *bufSize);
        asynStatus mask2DtoBPC(int *buf, char *bufBPC);
 
        void timePixCallback();
 
        // destructor. Disconnects from camera, deletes the object
        ~ADTimePix();
 
    protected:
        int ADTimePixHttpCode;
        #define ADTIMEPIX_FIRST_PARAM ADTimePixHttpCode
    
    //  Dashboard
        int ADTimePixFreeSpace;
        int ADTimePixWriteSpeed;
        int ADTimePixLowerLimit; 
        int ADTimePixLLimReached;
 
        int ADTimePixDetType;
        int ADTimePixFWTimeStamp;
        int ADTimePixDetConnected;
        int ADTimePixServalConnected;
 
        int ADTimePixServerName;
 
    // Health
        int ADTimePixLocalTemp;
        int ADTimePixFPGATemp;
        int ADTimePixFan1Speed;
        int ADTimePixFan2Speed;
        int ADTimePixBiasVoltage;
        int ADTimePixHumidity;
        int ADTimePixChipTemperature;
        int ADTimePixVDD;
        int ADTimePixAVDD;
        int ADTimePixHealth;
 
        // Detector Info
        int ADTimePixIfaceName;            
        int ADTimePixSW_version;           
        int ADTimePixFW_version;           
        int ADTimePixPixCount;             
        int ADTimePixRowLen;               
        int ADTimePixNumberOfChips;        
        int ADTimePixNumberOfRows;         
        int ADTimePixMpxType;
        
        int ADTimePixBoardsID;             
        int ADTimePixBoardsIP;
        int ADTimePixBoardsCh1;            
        int ADTimePixBoardsCh2;            
        int ADTimePixBoardsCh3;           
        int ADTimePixBoardsCh4;            
         
        int ADTimePixSuppAcqModes;         
        int ADTimePixClockReadout;         
        int ADTimePixMaxPulseCount;        
        int ADTimePixMaxPulseHeight;       
        int ADTimePixMaxPulsePeriod;       
        int ADTimePixTimerMaxVal;          
        int ADTimePixTimerMinVal;          
        int ADTimePixTimerStep;            
        int ADTimePixClockTimepix;         
         
             // Detector Config
        int ADTimePixFan1PWM;                  
        int ADTimePixFan2PWM;                  
        int ADTimePixBiasVolt;                 
        int ADTimePixBiasEnable;               
        int ADTimePixChainMode;                
        int ADTimePixTriggerIn;                
        int ADTimePixTriggerOut;               
        int ADTimePixPolarity;                 
        int ADTimePixTriggerMode;
        int ADTimePixExposureTime;             
        int ADTimePixTriggerPeriod;            
        int ADTimePixnTriggers;
        int ADTimePixPeriphClk80;              
        int ADTimePixTriggerDelay;
        int ADTimePixTdc;           
        int ADTimePixTdc0;
        int ADTimePixTdc1;                     
        int ADTimePixGlobalTimestampInterval;  
        int ADTimePixExternalReferenceClock;   
        int ADTimePixLogLevel;                 
         
        // Detector Chips
        int ADTimePixCP_PLL;
        int ADTimePixDiscS1OFF;
        int ADTimePixDiscS1ON;
        int ADTimePixDiscS2OFF;
        int ADTimePixDiscS2ON;
        int ADTimePixIkrum;
        int ADTimePixPixelDAC;
        int ADTimePixPreampOFF;
        int ADTimePixPreampON;
        int ADTimePixTPbufferIn;
        int ADTimePixTPbufferOut;
        int ADTimePixPLL_Vcntrl;
        int ADTimePixVPreampNCAS;
        int ADTimePixVTPcoarse;
        int ADTimePixVTPfine;
        int ADTimePixVfbk;
        int ADTimePixVthresholdCoarse;
        int ADTimePixVthresholdFine;
        int ADTimePixAdjust;
            
        // Detector Chip layout
        int ADTimePixDetectorOrientation;
        int ADTimePixLayout;
 
        // Detector Health individual Chip Temperature, VDD, AVDD
        int ADTimePixChipNTemperature;
        int ADTimePixChipN_VDD;
        int ADTimePixChipN_AVDD;
 
            // Files BPC, Chip/DACS
        int ADTimePixBPCFilePath;          
        int ADTimePixBPCFilePathExists;    
        int ADTimePixBPCFileName;          
        int ADTimePixDACSFilePath;         
        int ADTimePixDACSFilePathExists;   
        int ADTimePixDACSFileName;
        int ADTimePixWriteMsg; 
        int ADTimePixWriteBPCFile;                
        int ADTimePixWriteDACSFile;
 
            // Server, write output channels/modes
        int ADTimePixWriteData;
        int ADTimePixWriteRaw;
        int ADTimePixWriteRaw1;      // Serval 3.3.0
        int ADTimePixWriteImg;
        int ADTimePixWritePrvImg;
        int ADTimePixWritePrvImg1;
        int ADTimePixWritePrvHst;
            // Read back channels from Serval
        int ADTimePixWriteRawRead;
        int ADTimePixWriteRaw1Read;      // Serval 3.3.0
        int ADTimePixWriteImgRead;
        int ADTimePixWritePrvImgRead;
        int ADTimePixWritePrvImg1Read;
        int ADTimePixWritePrvHstRead;
 
            // Server, raw
        int ADTimePixRawBase;              
        int ADTimePixRawFilePat;           
        int ADTimePixRawSplitStrategy;    
        int ADTimePixRawQueueSize;
        int ADTimePixRawFilePathExists;
 
            // Server, raw; Serval 3.3.0 multiple stream/file
        int ADTimePixRaw1Base;
        int ADTimePixRaw1FilePat;
        int ADTimePixRaw1SplitStrategy;
        int ADTimePixRaw1QueueSize;
        int ADTimePixRaw1FilePathExists;
 
            // Server, Image
        int ADTimePixImgBase;           
        int ADTimePixImgFilePat;        
        int ADTimePixImgFormat;         
        int ADTimePixImgMode;           
        int ADTimePixImgThs;            
        int ADTimePixImgIntSize; 
        int ADTimePixImgIntMode;       
        int ADTimePixImgStpOnDskLim;    
        int ADTimePixImgQueueSize;      
        int ADTimePixImgFilePathExists; 
 
            // Server, Preview
        int ADTimePixPrvPeriod;            
        int ADTimePixPrvSamplingMode;      
            // Server, Preview, ImageChannels[0]
        int ADTimePixPrvImgBase;           
        int ADTimePixPrvImgFilePat;        
        int ADTimePixPrvImgFormat;         
        int ADTimePixPrvImgMode;           
        int ADTimePixPrvImgThs;           
        int ADTimePixPrvImgIntSize; 
        int ADTimePixPrvImgIntMode;      
        int ADTimePixPrvImgStpOnDskLim;   
        int ADTimePixPrvImgQueueSize;
        int ADTimePixPrvImgFilePathExists;     
            // Server, Preview, ImageChannel[1]
        int ADTimePixPrvImg1Base;    
        int ADTimePixPrvImg1FilePat;   
        int ADTimePixPrvImg1Format;       
        int ADTimePixPrvImg1Mode;         
        int ADTimePixPrvImg1Ths;        
        int ADTimePixPrvImg1IntSize; 
        int ADTimePixPrvImg1IntMode;
        int ADTimePixPrvImg1StpOnDskLim;
        int ADTimePixPrvImg1QueueSize;  
        int ADTimePixPrvImg1FilePathExists;
            // Server, Preview, HistogramChannels[0]
        int ADTimePixPrvHstBase;           
        int ADTimePixPrvHstFilePat;        
        int ADTimePixPrvHstFormat;         
        int ADTimePixPrvHstMode;           
        int ADTimePixPrvHstThs;           
        int ADTimePixPrvHstIntSize;
        int ADTimePixPrvHstIntMode;      
        int ADTimePixPrvHstStpOnDskLim;   
        int ADTimePixPrvHstQueueSize;
        int ADTimePixPrvHstNumBins;
        int ADTimePixPrvHstBinWidth;
        int ADTimePixPrvHstOffset;
        int ADTimePixPrvHstFilePathExists;    
 
            // Measurement
        int ADTimePixPelRate;        
        int ADTimePixTdc1Rate;
        int ADTimePixTdc2Rate;        
        int ADTimePixStartTime;      
        int ADTimePixElapsedTime;    
        int ADTimePixTimeLeft;       
        int ADTimePixFrameCount;     
        int ADTimePixDroppedFrames;  
        int ADTimePixStatus;
 
            // BPC Mask
        int ADTimePixBPC;
        int ADTimePixBPCn;
        int ADTimePixBPCmasked;
        int ADTimePixMaskBPC;
        int ADTimePixMaskOnOffPel;
        int ADTimePixMaskReset;
        int ADTimePixMaskMinX;
        int ADTimePixMaskSizeX;
        int ADTimePixMaskMinY;
        int ADTimePixMaskSizeY;
        int ADTimePixMaskRadius;
        int ADTimePixMaskRectangle;
        int ADTimePixMaskCircle;
        int ADTimePixMaskFileName;
        int ADTimePixMaskPel;
        int ADTimePixMaskWrite;
 
            // Controls
        int ADTimePixRawStream;
        int ADTimePixRaw1Stream;
        int ADTimePixPrvHstStream;
 
        #define ADTIMEPIX_LAST_PARAM ADTimePixPrvHstStream
 
    private:
 
        // Some data variables
        epicsEventId startEventId;
        epicsEventId endEventId;
        
        std::map<std::string, int> mDetOrientationMap;
 
        std::string serverURL;
        Image image;
 
        bool acquiring=false;
 
        epicsThreadId callbackThreadId;
 
        // ----------------------------------------
        // DRIVERNAMESTANDARD Global Variables
 
        // ----------------------------------------
        // DRIVERNAMESTANDARD Functions - Logging/Reporting
        //-----------------------------------------
 
        // reports device and driver info into a log file
        void report(FILE* fp, int details);
 
        // writes to ADStatus PV
        void updateStatus(const char* status);
 
        //function used for connecting to a TimePix3 serval URL device
        // NOTE - THIS MAY ALSO NEED TO CHANGE IF SERIAL # NOT USED
        asynStatus initialServerCheckConnection();
 
        void printConnectedDeviceInfo();
 
        //function that starts image acquisition
        asynStatus acquireStart();
 
        //function that stops image acquisition
        asynStatus acquireStop();
 
        // TimePix3 specific functions
        asynStatus getDashboard();
        asynStatus getServer();
        asynStatus getHealth();
        asynStatus getDetector();
        asynStatus initCamera();
        asynStatus initAcquisition();
        asynStatus checkBPCPath();
        asynStatus checkDACSPath();
        asynStatus checkRawPath();
        asynStatus checkRaw1Path();
        asynStatus checkImgPath();
        asynStatus checkPrvImgPath();
        asynStatus checkPrvImg1Path();
        asynStatus checkPrvHstPath();
        asynStatus checkChannelPath(int baseParam, int streamParam, int filePathExistsParam, 
                                   const std::string& channelName, const std::string& errorMessage);
        bool checkPath(std::string &filePath);
        asynStatus uploadBPC();
        asynStatus uploadDACS();
        asynStatus writeDac(int chip, const std::string &dac, int value);
        asynStatus fetchDacs(json &data, int chip);
        asynStatus readImage();
        asynStatus fileWriter();
        
        // Helper functions for fileWriter optimization
        asynStatus getParameterSafely(int param, int& value);
        asynStatus getParameterSafely(int param, std::string& value);
        asynStatus getParameterSafely(int param, double& value);
        bool validateIntegrationSize(int size);
        bool validateArrayIndex(int index, int maxSize);
        asynStatus configureRawChannel(int channelIndex, json& server_j);
        asynStatus configureImageChannel(const std::string& jsonPath, json& server_j);
        asynStatus configurePreviewSettings(json& server_j);
        asynStatus configureHistogramChannel(json& server_j);
        asynStatus sendConfiguration(const json& config);
        
        int checkFile(std::string &fullFileName);
        asynStatus rowsCols(int *rows, int *cols, int *xChips, int *yChips, int *chipPelWidth);
        asynStatus findChip(int x, int y, int *xChip, int *yChip, int *width);
        int pelIndex(int x, int y);
        int bcp2ImgIndex(int bpcIndexIn, int chipPelWidthIn);
};
 
// Stores number of additional PV parameters are added by the driver
#define NUM_TIMEPIX_PARAMS ((int)(&ADTIMEPIX_LAST_PARAM - &ADTIMEPIX_FIRST_PARAM + 1))
 
#endif