TwiceAsNice  2019-02-18
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
QHYCCD Class Reference

#include <qhy_ccd.h>

Inheritance diagram for QHYCCD:
Inheritance graph
Collaboration diagram for QHYCCD:
Collaboration graph

Public Member Functions

 QHYCCD (const char *name)
 
virtual ~QHYCCD ()=default
 
virtual const char * getDefaultName () override
 
virtual bool initProperties () override
 Initilize properties initial state and value. More...
 
virtual void ISGetProperties (const char *dev) override
 define the driver's properties to the client. More...
 
virtual bool updateProperties () override
 updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...
 
virtual bool Connect () override
 Connect to the device. More...
 
virtual bool Disconnect () override
 Disconnect from device. More...
 
virtual int SetTemperature (double temperature) override
 Set CCD temperature. More...
 
virtual bool StartExposure (float duration) override
 Start exposing primary CCD chip. More...
 
virtual bool AbortExposure () override
 Abort ongoing exposure. More...
 
virtual void debugTriggered (bool enable) override
 Inform driver that the debug option was triggered. More...
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int num) override
 Process the client newSwitch command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override
 Process the client newSwitch command. More...
 
void * streamVideo ()
 
- Public Member Functions inherited from INDI::CCD
 CCD ()
 
virtual ~CCD ()
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
 CCD ()
 
virtual ~CCD ()
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. More...
 
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. More...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 
- Public Member Functions inherited from INDI::FilterInterface
virtual bool SetFilterNames ()
 Set filter names as defined by the client for each filter position. More...
 
virtual bool GetFilterNames ()
 Obtains a list of filter names from the hardware and initializes the FilterNameTP property. More...
 
void SelectFilterDone (int newpos)
 The child class calls this function when the hardware successfully finished selecting a new filter wheel position. More...
 
virtual bool SetFilterNames ()
 Set filter names as defined by the client for each filter position. More...
 
virtual bool GetFilterNames ()
 Obtains a list of filter names from the hardware and initializes the FilterNameTP property. More...
 
void SelectFilterDone (int newpos)
 The child class calls this function when the hardware successfully finished selecting a new filter wheel position. More...
 

Static Public Member Functions

static void * streamVideoHelper (void *context)
 

Protected Member Functions

virtual void TimerHit () override
 Callback function to be called once SetTimer duration elapses. More...
 
virtual bool saveConfigItems (FILE *fp) override
 saveConfigItems Save configuration items in XML file. More...
 
virtual bool UpdateCCDFrame (int x, int y, int w, int h) override
 CCD calls this function when CCD Frame dimension needs to be updated in the hardware. More...
 
virtual bool UpdateCCDBin (int binx, int biny) override
 CCD calls this function when CCD Binning needs to be updated in the hardware. More...
 
virtual IPState GuideNorth (uint32_t ms) override
 Guide northward for ms milliseconds. More...
 
virtual IPState GuideSouth (uint32_t ms) override
 Guide southward for ms milliseconds. More...
 
virtual IPState GuideEast (uint32_t ms) override
 Guide easward for ms milliseconds. More...
 
virtual IPState GuideWest (uint32_t ms) override
 Guide westward for ms milliseconds. More...
 
virtual int QueryFilter () override
 Return current filter position. More...
 
virtual bool SelectFilter (int position) override
 Select a new filter position. More...
 
virtual bool StartStreaming () override
 StartStreaming Start live video streaming. More...
 
virtual bool StopStreaming () override
 StopStreaming Stop live video streaming. More...
 
- Protected Member Functions inherited from INDI::CCD
uint32_t GetCCDCapability () const
 GetCCDCapability returns the CCD capabilities. More...
 
void SetCCDCapability (uint32_t cap)
 SetCCDCapability Set the CCD capabilities. More...
 
bool CanAbort ()
 
bool CanBin ()
 
bool CanSubFrame ()
 
bool HasGuideHead ()
 
bool HasShutter ()
 
bool HasST4Port ()
 
bool HasCooler ()
 
bool HasBayer ()
 
bool HasStreaming ()
 
virtual bool ExposureComplete (CCDChip *targetChip)
 Uploads target Chip exposed buffer as FITS to the client. More...
 
virtual bool StartGuideExposure (float duration)
 Start exposing guide CCD chip. More...
 
virtual bool AbortGuideExposure ()
 Abort ongoing exposure. More...
 
virtual bool UpdateGuiderFrame (int x, int y, int w, int h)
 CCD calls this function when Guide head frame dimension is updated by the client. More...
 
virtual bool UpdateGuiderBin (int hor, int ver)
 CCD calls this function when Guide head binning is updated by the client. More...
 
virtual bool UpdateCCDFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when CCD frame type needs to be updated in the hardware. More...
 
virtual bool UpdateCCDUploadMode (CCD_UPLOAD_MODE mode)
 CCD calls this function when client upload mode switch is updated. More...
 
virtual bool UpdateGuiderFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when Guide frame type is updated by the client. More...
 
virtual void SetCCDParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for primary CCD. More...
 
virtual void SetGuiderParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for guide head CCD. More...
 
virtual void addFITSKeywords (fitsfile *fptr, CCDChip *targetChip)
 Add FITS keywords to a fits file. More...
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 A function to just remove GCC warnings about deprecated conversion. More...
 
virtual void activeDevicesUpdated ()
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 
uint32_t GetCCDCapability () const
 GetCCDCapability returns the CCD capabilities. More...
 
void SetCCDCapability (uint32_t cap)
 SetCCDCapability Set the CCD capabilities. More...
 
bool CanAbort ()
 
bool CanBin ()
 
bool CanSubFrame ()
 
bool HasGuideHead ()
 
bool HasShutter ()
 
bool HasST4Port ()
 
bool HasCooler ()
 
bool HasBayer ()
 
bool HasStreaming ()
 
virtual bool ExposureComplete (CCDChip *targetChip)
 Uploads target Chip exposed buffer as FITS to the client. More...
 
virtual bool StartGuideExposure (float duration)
 Start exposing guide CCD chip. More...
 
virtual bool AbortGuideExposure ()
 Abort ongoing exposure. More...
 
virtual bool UpdateGuiderFrame (int x, int y, int w, int h)
 CCD calls this function when Guide head frame dimension is updated by the client. More...
 
virtual bool UpdateGuiderBin (int hor, int ver)
 CCD calls this function when Guide head binning is updated by the client. More...
 
virtual bool UpdateCCDFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when CCD frame type needs to be updated in the hardware. More...
 
virtual bool UpdateCCDUploadMode (CCD_UPLOAD_MODE mode)
 CCD calls this function when client upload mode switch is updated. More...
 
virtual bool UpdateGuiderFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when Guide frame type is updated by the client. More...
 
virtual void SetCCDParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for primary CCD. More...
 
virtual void SetGuiderParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for guide head CCD. More...
 
virtual void addFITSKeywords (fitsfile *fptr, CCDChip *targetChip)
 Add FITS keywords to a fits file. More...
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 A function to just remove GCC warnings about deprecated conversion. More...
 
virtual void activeDevicesUpdated ()
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 
- Protected Member Functions inherited from INDI::DefaultDevice
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. More...
 
bool isDebug ()
 
bool isSimulation ()
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. More...
 
bool isDebug ()
 
bool isSimulation ()
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
- Protected Member Functions inherited from INDI::BaseDevice
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
- Protected Member Functions inherited from INDI::FilterInterface
 FilterInterface (DefaultDevice *defaultDevice)
 FilterInterface Initiailize Filter Interface. More...
 
 ~FilterInterface ()
 
void initProperties (const char *groupName)
 Initilize filter wheel properties. More...
 
bool updateProperties ()
 updateProperties Defines or Delete proprties based on default device connection status More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process number properties. More...
 
bool processText (const char *dev, const char *name, char *texts[], char *names[], int n)
 Process text properties. More...
 
void generateSampleFilters ()
 generateSampleFilters Generate sample 8-filter wheel and fill it sample filters More...
 
bool saveConfigItems (FILE *fp)
 saveConfigItems save Filter Names in config file More...
 
 FilterInterface (DefaultDevice *defaultDevice)
 FilterInterface Initiailize Filter Interface. More...
 
 ~FilterInterface ()
 
void initProperties (const char *groupName)
 Initilize filter wheel properties. More...
 
bool updateProperties ()
 updateProperties Defines or Delete proprties based on default device connection status More...
 
bool processNumber (const char *dev, const char *name, double values[], char *names[], int n)
 Process number properties. More...
 
bool processText (const char *dev, const char *name, char *texts[], char *names[], int n)
 Process text properties. More...
 
void generateSampleFilters ()
 generateSampleFilters Generate sample 8-filter wheel and fill it sample filters More...
 
bool saveConfigItems (FILE *fp)
 saveConfigItems save Filter Names in config file More...
 

Protected Attributes

ISwitch CoolerS [2]
 
ISwitchVectorProperty CoolerSP
 
INumber CoolerN [1]
 
INumberVectorProperty CoolerNP
 
INumber GainN [1]
 
INumberVectorProperty GainNP
 
INumber OffsetN [1]
 
INumberVectorProperty OffsetNP
 
INumber SpeedN [1]
 
INumberVectorProperty SpeedNP
 
INumber USBTrafficN [1]
 
INumberVectorProperty USBTrafficNP
 
- Protected Attributes inherited from INDI::CCD
double RA
 
double Dec
 
double J2000RA
 
double J2000DE
 
double primaryFocalLength
 
double primaryAperture
 
double guiderFocalLength
 
double guiderAperture
 
bool InExposure
 
bool InGuideExposure
 
bool RapidGuideEnabled
 
bool GuiderRapidGuideEnabled
 
bool AutoLoop
 
bool GuiderAutoLoop
 
bool SendImage
 
bool GuiderSendImage
 
bool ShowMarker
 
bool GuiderShowMarker
 
float ExposureTime
 
float GuiderExposureTime
 
double MPSAS
 
double RotatorAngle
 
double Airmass
 
double Latitude
 
double Longitude
 
std::vector< std::string > FilterNames
 
int CurrentFilterSlot
 
std::unique_ptr< StreamManagerStreamer
 
CCDChip PrimaryCCD
 
CCDChip GuideCCD
 
INumberVectorProperty EqNP
 
INumber EqN [2]
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [4] {}
 
INumber TemperatureN [1]
 
INumberVectorProperty TemperatureNP
 
IText BayerT [3] {}
 
ITextVectorProperty BayerTP
 
IText FileNameT [1] {}
 
ITextVectorProperty FileNameTP
 
ISwitch UploadS [3]
 
ISwitchVectorProperty UploadSP
 
IText UploadSettingsT [2] {}
 
ITextVectorProperty UploadSettingsTP
 
ISwitch TelescopeTypeS [2]
 
ISwitchVectorProperty TelescopeTypeSP
 
ISwitch WorldCoordS [2]
 
ISwitchVectorProperty WorldCoordSP
 
INumber CCDRotationN [1]
 
INumberVectorProperty CCDRotationNP
 
ISwitch ExposureLoopS [2]
 
ISwitchVectorProperty ExposureLoopSP
 
INumber ExposureLoopCountN [1]
 
INumberVectorProperty ExposureLoopCountNP
 
double uploadTime = { 0 }
 
std::chrono::system_clock::time_point exposureLoopStartup
 
IText FITSHeaderT [2] {}
 
ITextVectorProperty FITSHeaderTP
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t POLLMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 
- Protected Attributes inherited from INDI::FilterInterface
INumberVectorProperty FilterSlotNP
 
INumber FilterSlotN [1]
 
ITextVectorPropertyFilterNameTP { nullptr }
 
ITextFilterNameT
 
int CurrentFilter
 
int TargetFilter
 
bool loadingFromConfig = false
 
DefaultDevicem_defaultDevice { nullptr }
 

Private Member Functions

float calcTimeLeft ()
 
int grabImage ()
 
bool setupParams ()
 
void setCooler (bool enable)
 
bool isQHY5PIIC ()
 
void updateTemperature ()
 
friend void ::ISGetProperties (const char *dev)
 
friend void ::ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int num)
 
friend void ::ISNewText (const char *dev, const char *name, char *texts[], char *names[], int num)
 
friend void ::ISNewNumber (const char *dev, const char *name, double values[], char *names[], int num)
 
friend void ::ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 
friend void ::ISSnoopDevice (XMLEle *root)
 

Static Private Member Functions

static void updateTemperatureHelper (void *)
 

Private Attributes

char name [MAXINDIDEVICE]
 
char camid [MAXINDIDEVICE]
 
int camxbin
 
int camybin
 
int camroix
 
int camroiy
 
int camroiwidth
 
int camroiheight
 
bool HasUSBTraffic
 
bool HasUSBSpeed
 
bool HasGain
 
bool HasOffset
 
bool HasFilters
 
qhyccd_handlecamhandle
 
INDI::CCDChip::CCD_FRAME imageFrameType
 
bool sim
 
float TemperatureRequest
 
int temperatureID
 
bool coolerEnabled
 
float ExposureRequest
 
float LastExposureRequest
 
struct timeval ExpStart
 
int timerID
 
float GainRequest
 
float LastGainRequest
 
int streamPredicate =0
 
pthread_t primary_thread
 
bool terminateThread
 
pthread_cond_t cv = PTHREAD_COND_INITIALIZER
 
pthread_mutex_t condMutex = PTHREAD_MUTEX_INITIALIZER
 

Additional Inherited Members

- Public Types inherited from INDI::CCD
enum  {
  CCD_CAN_BIN = 1 << 0, CCD_CAN_SUBFRAME = 1 << 1, CCD_CAN_ABORT = 1 << 2, CCD_HAS_GUIDE_HEAD = 1 << 3,
  CCD_HAS_ST4_PORT = 1 << 4, CCD_HAS_SHUTTER = 1 << 5, CCD_HAS_COOLER = 1 << 6, CCD_HAS_BAYER = 1 << 7,
  CCD_HAS_STREAMING = 1 << 8
}
 
enum  CCD_UPLOAD_MODE {
  UPLOAD_CLIENT, UPLOAD_LOCAL, UPLOAD_BOTH, UPLOAD_CLIENT,
  UPLOAD_LOCAL, UPLOAD_BOTH
}
 
enum  {
  CCD_CAN_BIN = 1 << 0, CCD_CAN_SUBFRAME = 1 << 1, CCD_CAN_ABORT = 1 << 2, CCD_HAS_GUIDE_HEAD = 1 << 3,
  CCD_HAS_ST4_PORT = 1 << 4, CCD_HAS_SHUTTER = 1 << 5, CCD_HAS_COOLER = 1 << 6, CCD_HAS_BAYER = 1 << 7,
  CCD_HAS_STREAMING = 1 << 8
}
 
enum  CCD_UPLOAD_MODE {
  UPLOAD_CLIENT, UPLOAD_LOCAL, UPLOAD_BOTH, UPLOAD_CLIENT,
  UPLOAD_LOCAL, UPLOAD_BOTH
}
 
- Public Types inherited from INDI::BaseDevice
enum  INDI_ERROR {
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4
}
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15),
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
 
enum  INDI_ERROR {
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4
}
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15),
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
 
- Public Attributes inherited from INDI::CCD
enum INDI::CCD:: { ... }  CCDCapability
 
enum INDI::CCD:: { ... }  CCDCapability
 
- Protected Types inherited from INDI::CCD
enum  { SNOOP_MOUNT, SNOOP_ROTATOR, SNOOP_FILTER_WHEEL, SNOOP_SQM }
 
enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { TELESCOPE_PRIMARY, TELESCOPE_GUIDE }
 
enum  { EXPOSURE_LOOP_ON, EXPOSURE_LOOP_OFF }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 
enum  { SNOOP_MOUNT, SNOOP_ROTATOR, SNOOP_FILTER_WHEEL, SNOOP_SQM }
 
enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { TELESCOPE_PRIMARY, TELESCOPE_GUIDE }
 
enum  { EXPOSURE_LOOP_ON, EXPOSURE_LOOP_OFF }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 

Constructor & Destructor Documentation

◆ QHYCCD()

QHYCCD::QHYCCD ( const char *  name)

◆ ~QHYCCD()

virtual QHYCCD::~QHYCCD ( )
virtualdefault

Member Function Documentation

◆ AbortExposure()

bool QHYCCD::AbortExposure ( )
overridevirtual

Abort ongoing exposure.

Returns
true is abort is successful, false otherwise.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

◆ calcTimeLeft()

float QHYCCD::calcTimeLeft ( )
private

◆ Connect()

bool QHYCCD::Connect ( )
overridevirtual

Connect to the device.

INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation

Returns
True if connection is successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ debugTriggered()

void QHYCCD::debugTriggered ( bool  enable)
overridevirtual

Inform driver that the debug option was triggered.

This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled.

Parameters
enableIf true, the debug option is set to ON.

Reimplemented from INDI::DefaultDevice.

◆ Disconnect()

bool QHYCCD::Disconnect ( )
overridevirtual

Disconnect from device.

Returns
True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ getDefaultName()

const char * QHYCCD::getDefaultName ( )
overridevirtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

◆ grabImage()

int QHYCCD::grabImage ( )
private

◆ GuideEast()

IPState QHYCCD::GuideEast ( uint32_t  ms)
overrideprotectedvirtual

Guide easward for ms milliseconds.

Parameters
msDuration in milliseconds.
Note
This function is not implemented in CCD, it must be implemented in the child class
Returns
0 if successful, -1 otherwise.

Reimplemented from INDI::CCD.

◆ GuideNorth()

IPState QHYCCD::GuideNorth ( uint32_t  ms)
overrideprotectedvirtual

Guide northward for ms milliseconds.

Parameters
msDuration in milliseconds.
Note
This function is not implemented in CCD, it must be implemented in the child class
Returns
True if successful, false otherwise.

Reimplemented from INDI::CCD.

◆ GuideSouth()

IPState QHYCCD::GuideSouth ( uint32_t  ms)
overrideprotectedvirtual

Guide southward for ms milliseconds.

Parameters
msDuration in milliseconds.
Note
This function is not implemented in CCD, it must be implemented in the child class
Returns
0 if successful, -1 otherwise.

Reimplemented from INDI::CCD.

◆ GuideWest()

IPState QHYCCD::GuideWest ( uint32_t  ms)
overrideprotectedvirtual

Guide westward for ms milliseconds.

Parameters
msDuration in milliseconds.
Note
This function is not implemented in CCD, it must be implemented in the child class
Returns
0 if successful, -1 otherwise.

Reimplemented from INDI::CCD.

◆ initProperties()

bool QHYCCD::initProperties ( )
overridevirtual

Initilize properties initial state and value.

The child class must implement this function.

Returns
True if initilization is successful, false otherwise.

Reimplemented from INDI::CCD.

◆ ISGetProperties()

void QHYCCD::ISGetProperties ( const char *  dev)
overridevirtual

define the driver's properties to the client.

Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device.

Parameters
devname of the device
Note
This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::CCD.

◆ ISNewNumber()

bool QHYCCD::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
overridevirtual

Process the client newNumber command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::CCD.

◆ ISNewSwitch()

bool QHYCCD::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::CCD.

◆ ISNewText()

bool QHYCCD::ISNewText ( const char *  dev,
const char *  name,
char *  texts[],
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::CCD.

◆ isQHY5PIIC()

bool QHYCCD::isQHY5PIIC ( )
private

◆ QueryFilter()

int QHYCCD::QueryFilter ( )
overrideprotectedvirtual

Return current filter position.

Implements INDI::FilterInterface.

◆ saveConfigItems()

bool QHYCCD::saveConfigItems ( FILE *  fp)
overrideprotectedvirtual

saveConfigItems Save configuration items in XML file.

Parameters
fppointer to file to write to
Returns
True if successful, false otherwise

Reimplemented from INDI::CCD.

◆ SelectFilter()

bool QHYCCD::SelectFilter ( int  position)
overrideprotectedvirtual

Select a new filter position.

Returns
True if operation is successful, false otherwise

Implements INDI::FilterInterface.

◆ setCooler()

void QHYCCD::setCooler ( bool  enable)
private

◆ SetTemperature()

int QHYCCD::SetTemperature ( double  temperature)
overridevirtual

Set CCD temperature.

Parameters
temperatureCCD temperature in degrees celcius.
Returns
0 or 1 if setting the temperature call to the hardware is successful. -1 if an error is encountered. Return 0 if setting the temperature to the requested value takes time. Return 1 if setting the temperature to the requested value is complete.
Note
Upon returning 0, the property becomes BUSY. Once the temperature reaches the requested value, change the state to OK.
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

◆ setupParams()

bool QHYCCD::setupParams ( )
private

◆ StartExposure()

bool QHYCCD::StartExposure ( float  duration)
overridevirtual

Start exposing primary CCD chip.

Parameters
durationDuration in seconds
Returns
true if OK and exposure will take some time to complete, false on error.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

◆ StartStreaming()

bool QHYCCD::StartStreaming ( )
overrideprotectedvirtual

StartStreaming Start live video streaming.

Returns
True if successful, false otherwise.

Reimplemented from INDI::CCD.

◆ StopStreaming()

bool QHYCCD::StopStreaming ( )
overrideprotectedvirtual

StopStreaming Stop live video streaming.

Returns
True if successful, false otherwise.

Reimplemented from INDI::CCD.

◆ streamVideo()

void * QHYCCD::streamVideo ( )

◆ streamVideoHelper()

void * QHYCCD::streamVideoHelper ( void *  context)
static

◆ TimerHit()

void QHYCCD::TimerHit ( )
overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ UpdateCCDBin()

bool QHYCCD::UpdateCCDBin ( int  hor,
int  ver 
)
overrideprotectedvirtual

CCD calls this function when CCD Binning needs to be updated in the hardware.

Derived classes should implement this function

Parameters
horHorizontal binning.
verVertical binning.
Returns
true is CCD chip update is successful, false otherwise.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

◆ UpdateCCDFrame()

bool QHYCCD::UpdateCCDFrame ( int  x,
int  y,
int  w,
int  h 
)
overrideprotectedvirtual

CCD calls this function when CCD Frame dimension needs to be updated in the hardware.

Derived classes should implement this function

Parameters
xSubframe X coordinate in pixels.
ySubframe Y coordinate in pixels.
wSubframe width in pixels.
hSubframe height in pixels.
Note
(0,0) is defined as most left, top pixel in the subframe.
Returns
true is CCD chip update is successful, false otherwise.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

◆ updateProperties()

bool QHYCCD::updateProperties ( )
overridevirtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver.

This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns
True if update is successful, false otherwise.

Reimplemented from INDI::CCD.

◆ updateTemperature()

void QHYCCD::updateTemperature ( )
private

◆ updateTemperatureHelper()

void QHYCCD::updateTemperatureHelper ( void *  p)
staticprivate

◆ void ::ISGetProperties()

QHYCCD::void ::ISGetProperties ( const char *  dev)
private

◆ void ::ISNewBLOB()

QHYCCD::void ::ISNewBLOB ( const char *  dev,
const char *  name,
int  sizes[],
int  blobsizes[],
char *  blobs[],
char *  formats[],
char *  names[],
int  n 
)
private

◆ void ::ISNewNumber()

QHYCCD::void ::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  num 
)
private

◆ void ::ISNewSwitch()

QHYCCD::void ::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  num 
)
private

◆ void ::ISNewText()

QHYCCD::void ::ISNewText ( const char *  dev,
const char *  name,
char *  texts[],
char *  names[],
int  num 
)
private

◆ void ::ISSnoopDevice()

QHYCCD::void ::ISSnoopDevice ( XMLEle root)
private

Member Data Documentation

◆ camhandle

qhyccd_handle* QHYCCD::camhandle
private

◆ camid

char QHYCCD::camid[MAXINDIDEVICE]
private

◆ camroiheight

int QHYCCD::camroiheight
private

◆ camroiwidth

int QHYCCD::camroiwidth
private

◆ camroix

int QHYCCD::camroix
private

◆ camroiy

int QHYCCD::camroiy
private

◆ camxbin

int QHYCCD::camxbin
private

◆ camybin

int QHYCCD::camybin
private

◆ condMutex

pthread_mutex_t QHYCCD::condMutex = PTHREAD_MUTEX_INITIALIZER
private

◆ coolerEnabled

bool QHYCCD::coolerEnabled
private

◆ CoolerN

INumber QHYCCD::CoolerN[1]
protected

◆ CoolerNP

INumberVectorProperty QHYCCD::CoolerNP
protected

◆ CoolerS

ISwitch QHYCCD::CoolerS[2]
protected

◆ CoolerSP

ISwitchVectorProperty QHYCCD::CoolerSP
protected

◆ cv

pthread_cond_t QHYCCD::cv = PTHREAD_COND_INITIALIZER
private

◆ ExposureRequest

float QHYCCD::ExposureRequest
private

◆ ExpStart

struct timeval QHYCCD::ExpStart
private

◆ GainN

INumber QHYCCD::GainN[1]
protected

◆ GainNP

INumberVectorProperty QHYCCD::GainNP
protected

◆ GainRequest

float QHYCCD::GainRequest
private

◆ HasFilters

bool QHYCCD::HasFilters
private

◆ HasGain

bool QHYCCD::HasGain
private

◆ HasOffset

bool QHYCCD::HasOffset
private

◆ HasUSBSpeed

bool QHYCCD::HasUSBSpeed
private

◆ HasUSBTraffic

bool QHYCCD::HasUSBTraffic
private

◆ imageFrameType

INDI::CCDChip::CCD_FRAME QHYCCD::imageFrameType
private

◆ LastExposureRequest

float QHYCCD::LastExposureRequest
private

◆ LastGainRequest

float QHYCCD::LastGainRequest
private

◆ name

char QHYCCD::name[MAXINDIDEVICE]
private

◆ OffsetN

INumber QHYCCD::OffsetN[1]
protected

◆ OffsetNP

INumberVectorProperty QHYCCD::OffsetNP
protected

◆ primary_thread

pthread_t QHYCCD::primary_thread
private

◆ sim

bool QHYCCD::sim
private

◆ SpeedN

INumber QHYCCD::SpeedN[1]
protected

◆ SpeedNP

INumberVectorProperty QHYCCD::SpeedNP
protected

◆ streamPredicate

int QHYCCD::streamPredicate =0
private

◆ temperatureID

int QHYCCD::temperatureID
private

◆ TemperatureRequest

float QHYCCD::TemperatureRequest
private

◆ terminateThread

bool QHYCCD::terminateThread
private

◆ timerID

int QHYCCD::timerID
private

◆ USBTrafficN

INumber QHYCCD::USBTrafficN[1]
protected

◆ USBTrafficNP

INumberVectorProperty QHYCCD::USBTrafficNP
protected

The documentation for this class was generated from the following files: