#include <generic_ccd.h>

Inheritance diagram for GenericCCD:

Collaboration diagram for GenericCCD:

Public Member Functions
	GenericCCD (DEVICE device, const char *name)

virtual	~GenericCCD ()

const char *	getDefaultName ()

bool	initProperties ()
	Initilize properties initial state and value. More...

void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...

bool	updateProperties ()
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...

bool	Connect ()
	Connect to the device. More...

bool	Disconnect ()
	Disconnect from device. More...

int	SetTemperature (double temperature)
	Set CCD temperature. More...

bool	StartExposure (float duration)
	Start exposing primary CCD chip. More...

bool	AbortExposure ()
	Abort ongoing exposure. More...

Public Member Functions inherited from INDI::CCD
	CCD ()

virtual	~CCD ()

virtual bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n)
	Process the client newNumber command. More...

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process the client newSwitch command. More...

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n)
	Process the client newSwitch command. More...

virtual bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. More...

	CCD ()

virtual	~CCD ()

virtual bool	ISNewNumber (const char dev, const char name, double values[], char *names[], int n)
	Process the client newNumber command. More...

virtual bool	ISNewSwitch (const char dev, const char name, ISState states, char names[], int n)
	Process the client newSwitch command. More...

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n)
	Process the client newSwitch command. More...

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 ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (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::Property *	getProperty (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::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

	BaseDevice ()

virtual	~BaseDevice ()

INumberVectorProperty *	getNumber (const char *name)

ITextVectorProperty *	getText (const char *name)

ISwitchVectorProperty *	getSwitch (const char *name)

ILightVectorProperty *	getLight (const char *name)

IBLOBVectorProperty *	getBLOB (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::Property *	getProperty (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::BaseMediator *	getMediator ()

const char *	getDriverName ()

const char *	getDriverExec ()

const char *	getDriverVersion ()

Protected Member Functions
void	TimerHit ()
	Callback function to be called once SetTimer duration elapses. More...

virtual bool	UpdateCCDFrame (int x, int y, int w, int h)
	CCD calls this function when CCD Frame dimension needs to be updated in the hardware. More...

virtual bool	UpdateCCDBin (int binx, int biny)
	CCD calls this function when CCD Binning needs to be updated in the hardware. More...

virtual bool	UpdateCCDFrameType (INDI::CCDChip::CCD_FRAME fType)
	CCD calls this function when CCD frame type needs to be updated in the hardware. More...

virtual IPState	GuideNorth (uint32_t ms)
	Guide northward for ms milliseconds. More...

virtual IPState	GuideSouth (uint32_t ms)
	Guide southward for ms milliseconds. More...

virtual IPState	GuideEast (uint32_t ms)
	Guide easward for ms milliseconds. More...

virtual IPState	GuideWest (uint32_t ms)
	Guide westward for ms milliseconds. 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	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 bool	StartStreaming ()
	StartStreaming Start live video streaming. More...

virtual bool	StopStreaming ()
	StopStreaming Stop live video streaming. 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...

virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save configuration items in XML file. 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	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 bool	StartStreaming ()
	StartStreaming Start live video streaming. More...

virtual bool	StopStreaming ()
	StopStreaming Stop live video streaming. 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...

virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save configuration items in XML file. 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	debugTriggered (bool enable)
	Inform driver that the debug option was triggered. 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::Interface *	getActiveConnection ()

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	debugTriggered (bool enable)
	Inform driver that the debug option was triggered. 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::Interface *	getActiveConnection ()

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...

Private Member Functions
float	CalcTimeLeft ()

int	grabImage ()

bool	setupParams ()

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)

Private Attributes
DEVICE	device

char	name [32]

double	ccdTemp

double	minDuration

unsigned short *	imageBuffer

int	timerID

INDI::CCDChip::CCD_FRAME	imageFrameType

struct timeval	ExpStart

float	ExposureRequest

float	TemperatureRequest

bool	sim

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 }

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< StreamManager >	Streamer

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...

Constructor & Destructor Documentation

◆ GenericCCD()

GenericCCD::GenericCCD	(	DEVICE	device,
		const char *	name
	)

◆ ~GenericCCD()

GenericCCD::~GenericCCD ( )

virtual

Member Function Documentation

◆ AbortExposure()

bool GenericCCD::AbortExposure ( )

virtual

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 GenericCCD::CalcTimeLeft ( )

private

◆ Connect()

bool GenericCCD::Connect ( )

virtual

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.

◆ Disconnect()

bool GenericCCD::Disconnect ( )

virtual

Disconnect from device.

Returns: True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ getDefaultName()

const char * GenericCCD::getDefaultName ( )

virtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

◆ grabImage()

int GenericCCD::grabImage ( )

private

◆ GuideEast()

IPState GenericCCD::GuideEast ( uint32_t ms )

protectedvirtual

Guide easward for ms milliseconds.

Parameters

ms	Duration 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 GenericCCD::GuideNorth ( uint32_t ms )

protectedvirtual

Guide northward for ms milliseconds.

Parameters

ms	Duration 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 GenericCCD::GuideSouth ( uint32_t ms )

protectedvirtual

Guide southward for ms milliseconds.

Parameters

ms	Duration 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 GenericCCD::GuideWest ( uint32_t ms )

protectedvirtual

Guide westward for ms milliseconds.

Parameters

ms	Duration 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 GenericCCD::initProperties ( )

virtual

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 GenericCCD::ISGetProperties ( const char * dev )

virtual

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

dev	name 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.

◆ SetTemperature()

int GenericCCD::SetTemperature ( double temperature )

virtual

Set CCD temperature.

Parameters

temperature CCD 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 GenericCCD::setupParams ( )

private

◆ StartExposure()

bool GenericCCD::StartExposure ( float duration )

virtual

Start exposing primary CCD chip.

Parameters

duration Duration 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.

◆ TimerHit()

void GenericCCD::TimerHit ( )

protectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ UpdateCCDBin()

bool GenericCCD::UpdateCCDBin	(	int	hor,
		int	ver
	)

protectedvirtual

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

Derived classes should implement this function

Parameters

hor	Horizontal binning.
ver	Vertical 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 GenericCCD::UpdateCCDFrame	(	int	x,
		int	y,
		int	w,
		int	h
	)

protectedvirtual

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

Derived classes should implement this function

Parameters

x	Subframe X coordinate in pixels.
y	Subframe Y coordinate in pixels.
w	Subframe width in pixels.
h	Subframe 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.

◆ UpdateCCDFrameType()

bool GenericCCD::UpdateCCDFrameType ( INDI::CCDChip::CCD_FRAME fType )

protectedvirtual

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

Parameters

fType Frame type

Returns: true is CCD chip update is successful, false otherwise.

Note: It is not mandatory to implement this function in the child class. The CCD hardware layer may either set the frame type when this function is called, or (optionally) before an exposure is started.

Reimplemented from INDI::CCD.

◆ updateProperties()

bool GenericCCD::updateProperties ( )

virtual

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.

◆ void ::ISGetProperties()

GenericCCD::void ::ISGetProperties ( const char * dev )

private

◆ void ::ISNewBLOB()

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

private

◆ void ::ISNewNumber()

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

private

◆ void ::ISNewSwitch()

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

private

◆ void ::ISNewText()

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

private

Member Data Documentation

◆ ccdTemp

double GenericCCD::ccdTemp

private

◆ device

DEVICE GenericCCD::device

private

◆ ExposureRequest

float GenericCCD::ExposureRequest

private

◆ ExpStart

struct timeval GenericCCD::ExpStart

private

◆ imageBuffer

unsigned short* GenericCCD::imageBuffer

private

◆ imageFrameType

INDI::CCDChip::CCD_FRAME GenericCCD::imageFrameType

private

◆ minDuration

double GenericCCD::minDuration

private

◆ name

char GenericCCD::name[32]

private

◆ sim

bool GenericCCD::sim

private

◆ TemperatureRequest

float GenericCCD::TemperatureRequest

private

◆ timerID

int GenericCCD::timerID

private

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

ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/generic-ccd/generic_ccd.h
ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/generic-ccd/generic_ccd.cpp

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ GenericCCD()

◆ ~GenericCCD()

Member Function Documentation

◆ AbortExposure()

◆ CalcTimeLeft()

◆ Connect()

◆ Disconnect()

◆ getDefaultName()

◆ grabImage()

◆ GuideEast()

◆ GuideNorth()

◆ GuideSouth()

◆ GuideWest()

◆ initProperties()

◆ ISGetProperties()

◆ SetTemperature()

◆ setupParams()

◆ StartExposure()

◆ TimerHit()

◆ UpdateCCDBin()

◆ UpdateCCDFrame()

◆ UpdateCCDFrameType()

◆ updateProperties()

◆ void ::ISGetProperties()

◆ void ::ISNewBLOB()

◆ void ::ISNewNumber()

◆ void ::ISNewSwitch()

◆ void ::ISNewText()

Member Data Documentation

◆ ccdTemp

◆ device

◆ ExposureRequest

◆ ExpStart

◆ imageBuffer

◆ imageFrameType

◆ minDuration

◆ name

◆ sim

◆ TemperatureRequest

◆ timerID