Class to provide general functionality of CCD cameras with a single CCD sensor, or a primary CCD sensor in addition to a secondary CCD guide head. More...

#include <indiccd.h>

Inheritance diagram for INDI::CCD:

Collaboration diagram for INDI::CCD:

Public Types
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 Member Functions
	CCD ()

virtual	~CCD ()

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

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

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

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	initProperties ()
	Initilize properties initial state and value. More...

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

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

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 void	TimerHit ()
	Callback function to be called once SetTimer duration elapses. 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 void	TimerHit ()
	Callback function to be called once SetTimer duration elapses. 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 ()

Public Attributes
enum INDI::CCD:: { ... }	CCDCapability

enum INDI::CCD:: { ... }	CCDCapability

Protected Types
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 Member Functions
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 int	SetTemperature (double temperature)
	Set CCD temperature. More...

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

virtual bool	ExposureComplete (CCDChip *targetChip)
	Uploads target Chip exposed buffer as FITS to the client. More...

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

virtual bool	StartGuideExposure (float duration)
	Start exposing guide CCD chip. More...

virtual bool	AbortGuideExposure ()
	Abort ongoing exposure. 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	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	UpdateCCDBin (int hor, int ver)
	CCD calls this function when CCD Binning needs to be updated in the hardware. 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 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...

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 int	SetTemperature (double temperature)
	Set CCD temperature. More...

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

virtual bool	ExposureComplete (CCDChip *targetChip)
	Uploads target Chip exposed buffer as FITS to the client. More...

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

virtual bool	StartGuideExposure (float duration)
	Start exposing guide CCD chip. More...

virtual bool	AbortGuideExposure ()
	Abort ongoing exposure. 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	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	UpdateCCDBin (int hor, int ver)
	CCD calls this function when CCD Binning needs to be updated in the hardware. 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 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...

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

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

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

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

virtual const char *	getDefaultName ()=0

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

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

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

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

virtual const char *	getDefaultName ()=0

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

Private Member Functions
bool	uploadFile (CCDChip targetChip, const void fitsData, size_t totalBytes, bool sendImage, bool saveImage)

void	getMinMax (double min, double max, CCDChip *targetChip)

int	getFileIndex (const char dir, const char prefix, const char *ext)

bool	uploadFile (CCDChip targetChip, const void fitsData, size_t totalBytes, bool sendImage, bool saveImage)

void	getMinMax (double min, double max, CCDChip *targetChip)

int	getFileIndex (const char dir, const char prefix, const char *ext)

	GuiderInterface ()

	~GuiderInterface ()

void	initGuiderProperties (const char deviceName, const char groupName)
	Initilize guider properties. More...

void	processGuiderProperties (const char name, double values[], char names[], int n)
	Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. More...

	GuiderInterface ()

	~GuiderInterface ()

void	initGuiderProperties (const char deviceName, const char groupName)
	Initilize guider properties. More...

void	processGuiderProperties (const char name, double values[], char names[], int n)
	Call this function whenever client updates GuideNSNP or GuideWSP properties in the primary device. More...

Private Attributes
uint32_t	capability

bool	ValidCCDRotation

Private Attributes inherited from INDI::GuiderInterface
INumber	GuideNSN [2]

INumberVectorProperty	GuideNSNP

INumber	GuideWEN [2]

INumberVectorProperty	GuideWENP

Friends
class	StreamManager

Detailed Description

Class to provide general functionality of CCD cameras with a single CCD sensor, or a primary CCD sensor in addition to a secondary CCD guide head.

The CCD capabilities must be set to select which features are exposed to the clients. SetCCDCapability() is typically set in the constructor or initProperties(), but can also be called after connection is established with the CCD, but must be called /em before returning true in Connect().

It also implements the interface to perform guiding. The class enable the ability to snoop on telescope equatorial coordinates and record them in the FITS file before upload. It also snoops Sky-Quality-Meter devices to record sky quality in units of Magnitudes-Per-Arcsecond-Squared (MPASS) in the FITS header.

Support for streaming is available (Linux only) and is handled by the StreamRecorder class.

Developers need to subclass INDI::CCD to implement any driver for CCD cameras within INDI.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
CCD_CAN_BIN	Does the CCD support binning?
CCD_CAN_SUBFRAME	Does the CCD support setting ROI?
CCD_CAN_ABORT	Can the CCD exposure be aborted?
CCD_HAS_GUIDE_HEAD	Does the CCD have a guide head?
CCD_HAS_ST4_PORT	Does the CCD have an ST4 port?
CCD_HAS_SHUTTER	Does the CCD have a mechanical shutter?
CCD_HAS_COOLER	Does the CCD have a cooler and temperature control?
CCD_HAS_BAYER	Does the CCD send color data in bayer format?
CCD_HAS_STREAMING	Does the CCD support live video streaming?

◆ anonymous enum

anonymous enum

protected

Enumerator
SNOOP_MOUNT
SNOOP_ROTATOR
SNOOP_FILTER_WHEEL
SNOOP_SQM

◆ anonymous enum

anonymous enum

protected

Enumerator
UPLOAD_DIR
UPLOAD_PREFIX

◆ anonymous enum

anonymous enum

protected

Enumerator
TELESCOPE_PRIMARY
TELESCOPE_GUIDE

◆ anonymous enum

anonymous enum

protected

Enumerator
EXPOSURE_LOOP_ON
EXPOSURE_LOOP_OFF

◆ anonymous enum

anonymous enum

protected

Enumerator
FITS_OBSERVER
FITS_OBJECT

◆ anonymous enum

anonymous enum

Enumerator
CCD_CAN_BIN	Does the CCD support binning?
CCD_CAN_SUBFRAME	Does the CCD support setting ROI?
CCD_CAN_ABORT	Can the CCD exposure be aborted?
CCD_HAS_GUIDE_HEAD	Does the CCD have a guide head?
CCD_HAS_ST4_PORT	Does the CCD have an ST4 port?
CCD_HAS_SHUTTER	Does the CCD have a mechanical shutter?
CCD_HAS_COOLER	Does the CCD have a cooler and temperature control?
CCD_HAS_BAYER	Does the CCD send color data in bayer format?
CCD_HAS_STREAMING	Does the CCD support live video streaming?

◆ anonymous enum

anonymous enum

protected

Enumerator
SNOOP_MOUNT
SNOOP_ROTATOR
SNOOP_FILTER_WHEEL
SNOOP_SQM

◆ anonymous enum

anonymous enum

protected

Enumerator
UPLOAD_DIR
UPLOAD_PREFIX

◆ anonymous enum

anonymous enum

protected

Enumerator
TELESCOPE_PRIMARY
TELESCOPE_GUIDE

◆ anonymous enum

anonymous enum

protected

Enumerator
EXPOSURE_LOOP_ON
EXPOSURE_LOOP_OFF

◆ anonymous enum

anonymous enum

protected

Enumerator
FITS_OBSERVER
FITS_OBJECT

◆ CCD_UPLOAD_MODE [1/2]

enum INDI::CCD::CCD_UPLOAD_MODE

Enumerator
UPLOAD_CLIENT
UPLOAD_LOCAL
UPLOAD_BOTH
UPLOAD_CLIENT
UPLOAD_LOCAL
UPLOAD_BOTH

◆ CCD_UPLOAD_MODE [2/2]

enum INDI::CCD::CCD_UPLOAD_MODE

Enumerator
UPLOAD_CLIENT
UPLOAD_LOCAL
UPLOAD_BOTH
UPLOAD_CLIENT
UPLOAD_LOCAL
UPLOAD_BOTH

Constructor & Destructor Documentation

◆ CCD() [1/2]

INDI::CCD::CCD ( )

◆ ~CCD() [1/2]

INDI::CCD::~CCD ( )

virtual

◆ CCD() [2/2]

INDI::CCD::CCD ( )

◆ ~CCD() [2/2]

virtual INDI::CCD::~CCD ( )

virtual

Member Function Documentation

◆ AbortExposure() [1/2]

bool INDI::CCD::AbortExposure ( )

protectedvirtual

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 in SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, CCDSim, V4L2_Driver, QSICCD, SSAGCCD, GuideSim, ApogeeCCD, NightscapeCCD, GenericCCD, QHYCCD, DSICCD, FishCampCCD, FLICCD, MICCD, ASICCD, FFMVCCD, GigECCD, SimpleCCD, and INovaCCD.

◆ AbortExposure() [2/2]

virtual bool INDI::CCD::AbortExposure ( )

protectedvirtual

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 in SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, CCDSim, V4L2_Driver, QSICCD, SSAGCCD, GuideSim, ApogeeCCD, NightscapeCCD, GenericCCD, QHYCCD, DSICCD, FishCampCCD, FLICCD, MICCD, ASICCD, FFMVCCD, GigECCD, SimpleCCD, and INovaCCD.

◆ AbortGuideExposure() [1/2]

virtual bool INDI::CCD::AbortGuideExposure ( )

protectedvirtual

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 in SBIGCCD, SXCCD, and CCDSim.

◆ AbortGuideExposure() [2/2]

bool INDI::CCD::AbortGuideExposure ( )

protectedvirtual

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 in SBIGCCD, SXCCD, and CCDSim.

◆ activeDevicesUpdated() [1/2]

virtual void INDI::CCD::activeDevicesUpdated ( )

inlineprotectedvirtual

activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired.

Reimplemented in CCDSim, and GuideSim.

◆ activeDevicesUpdated() [2/2]

virtual void INDI::CCD::activeDevicesUpdated ( )

inlineprotectedvirtual

activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired.

Reimplemented in CCDSim, and GuideSim.

◆ addFITSKeywords() [1/2]

virtual void INDI::CCD::addFITSKeywords	(	fitsfile *	fptr,
		CCDChip *	targetChip
	)

protectedvirtual

Add FITS keywords to a fits file.

Parameters

fptr	pointer to a valid FITS file.
targetChip	The target chip to extract the keywords from.

Note

In additional to the standard FITS keywords, this function write the following keywords the FITS file:

EXPTIME: Total Exposure Time (s)
DARKTIME (if applicable): Total Exposure Time (s)
PIXSIZE1: Pixel Size 1 (microns)
PIXSIZE2: Pixel Size 2 (microns)
BINNING: Binning HOR x VER
FRAME: Frame Type
DATAMIN: Minimum value
DATAMAX: Maximum value
INSTRUME: CCD Name
DATE-OBS: UTC start date of observation

To add additional information, override this function in the child class and ensure to call CCD::addFITSKeywords.

Reimplemented in GPhotoCCD, QSICCD, SSAGCCD, ASICCD, and INovaCCD.

◆ addFITSKeywords() [2/2]

void INDI::CCD::addFITSKeywords	(	fitsfile *	fptr,
		CCDChip *	targetChip
	)

protectedvirtual

Add FITS keywords to a fits file.

Parameters

fptr	pointer to a valid FITS file.
targetChip	The target chip to extract the keywords from.

Note

In additional to the standard FITS keywords, this function write the following keywords the FITS file:

EXPTIME: Total Exposure Time (s)
DARKTIME (if applicable): Total Exposure Time (s)
PIXSIZE1: Pixel Size 1 (microns)
PIXSIZE2: Pixel Size 2 (microns)
BINNING: Binning HOR x VER
FRAME: Frame Type
DATAMIN: Minimum value
DATAMAX: Maximum value
INSTRUME: CCD Name
DATE-OBS: UTC start date of observation

To add additional information, override this function in the child class and ensure to call CCD::addFITSKeywords.

Reimplemented in GPhotoCCD, QSICCD, SSAGCCD, ASICCD, and INovaCCD.

◆ CanAbort() [1/2]

bool INDI::CCD::CanAbort ( )

inlineprotected

Returns: True if CCD can abort exposure. False otherwise.

◆ CanAbort() [2/2]

bool INDI::CCD::CanAbort ( )

inlineprotected

Returns: True if CCD can abort exposure. False otherwise.

◆ CanBin() [1/2]

bool INDI::CCD::CanBin ( )

inlineprotected

Returns: True if CCD supports binning. False otherwise.

◆ CanBin() [2/2]

bool INDI::CCD::CanBin ( )

inlineprotected

Returns: True if CCD supports binning. False otherwise.

◆ CanSubFrame() [1/2]

bool INDI::CCD::CanSubFrame ( )

inlineprotected

Returns: True if CCD supports subframing. False otherwise.

◆ CanSubFrame() [2/2]

bool INDI::CCD::CanSubFrame ( )

inlineprotected

Returns: True if CCD supports subframing. False otherwise.

◆ ExposureComplete() [1/2]

virtual bool INDI::CCD::ExposureComplete ( CCDChip * targetChip )

protectedvirtual

Uploads target Chip exposed buffer as FITS to the client.

Dervied classes should class this function when an exposure is complete.

Parameters

targetChip chip that contains upload image data

Note: This function is not implemented in CCD, it must be implemented in the child class

◆ ExposureComplete() [2/2]

bool INDI::CCD::ExposureComplete ( CCDChip * targetChip )

protectedvirtual

Uploads target Chip exposed buffer as FITS to the client.

Dervied classes should class this function when an exposure is complete.

Parameters

targetChip chip that contains upload image data

Note: This function is not implemented in CCD, it must be implemented in the child class

◆ fits_update_key_s() [1/2]

void INDI::CCD::fits_update_key_s	(	fitsfile *	fptr,
		int	type,
		std::string	name,
		void *	p,
		std::string	explanation,
		int *	status
	)

protected

A function to just remove GCC warnings about deprecated conversion.

◆ fits_update_key_s() [2/2]

void INDI::CCD::fits_update_key_s	(	fitsfile *	fptr,
		int	type,
		std::string	name,
		void *	p,
		std::string	explanation,
		int *	status
	)

protected

A function to just remove GCC warnings about deprecated conversion.

◆ GetCCDCapability() [1/2]

uint32_t INDI::CCD::GetCCDCapability ( ) const

inlineprotected

GetCCDCapability returns the CCD capabilities.

◆ GetCCDCapability() [2/2]

uint32_t INDI::CCD::GetCCDCapability ( ) const

inlineprotected

GetCCDCapability returns the CCD capabilities.

◆ getFileIndex() [1/2]

int INDI::CCD::getFileIndex	(	const char *	dir,
		const char *	prefix,
		const char *	ext
	)

private

◆ getFileIndex() [2/2]

int INDI::CCD::getFileIndex	(	const char *	dir,
		const char *	prefix,
		const char *	ext
	)

private

◆ getMinMax() [1/2]

void INDI::CCD::getMinMax	(	double *	min,
		double *	max,
		CCDChip *	targetChip
	)

private

◆ getMinMax() [2/2]

void INDI::CCD::getMinMax	(	double *	min,
		double *	max,
		CCDChip *	targetChip
	)

private

◆ GuideComplete() [1/2]

void INDI::CCD::GuideComplete ( INDI_EQ_AXIS axis )

protectedvirtual

Call GuideComplete once the guiding pulse is complete.

Parameters

axis	Axis of completed guiding operation.

Reimplemented from INDI::GuiderInterface.

◆ GuideComplete() [2/2]

void INDI::CCD::GuideComplete ( INDI_EQ_AXIS axis )

protectedvirtual

Call GuideComplete once the guiding pulse is complete.

Parameters

axis	Axis of completed guiding operation.

Reimplemented from INDI::GuiderInterface.

◆ GuideEast() [1/2]

IPState INDI::CCD::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.

Implements INDI::GuiderInterface.

Reimplemented in SBIGCCD, SXCCD, CCDSim, QSICCD, QHYCCD, GuideSim, SSAGCCD, FishCampCCD, GenericCCD, ASICCD, MICCD, and INovaCCD.

◆ GuideEast() [2/2]

virtual IPState INDI::CCD::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.

Implements INDI::GuiderInterface.

Reimplemented in SBIGCCD, SXCCD, CCDSim, QSICCD, QHYCCD, GuideSim, SSAGCCD, FishCampCCD, GenericCCD, ASICCD, MICCD, and INovaCCD.

◆ GuideNorth() [1/2]

IPState INDI::CCD::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.

Implements INDI::GuiderInterface.

Reimplemented in SBIGCCD, SXCCD, CCDSim, QSICCD, QHYCCD, SSAGCCD, GuideSim, FishCampCCD, GenericCCD, ASICCD, MICCD, and INovaCCD.

◆ GuideNorth() [2/2]

virtual IPState INDI::CCD::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.

Implements INDI::GuiderInterface.

Reimplemented in SBIGCCD, SXCCD, CCDSim, QSICCD, QHYCCD, SSAGCCD, GuideSim, FishCampCCD, GenericCCD, ASICCD, MICCD, and INovaCCD.

◆ GuideSouth() [1/2]

IPState INDI::CCD::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.

Implements INDI::GuiderInterface.

Reimplemented in SBIGCCD, SXCCD, CCDSim, QSICCD, QHYCCD, SSAGCCD, GuideSim, FishCampCCD, GenericCCD, ASICCD, MICCD, and INovaCCD.

◆ GuideSouth() [2/2]

virtual IPState INDI::CCD::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.

Implements INDI::GuiderInterface.

Reimplemented in SBIGCCD, SXCCD, CCDSim, QSICCD, QHYCCD, SSAGCCD, GuideSim, FishCampCCD, GenericCCD, ASICCD, MICCD, and INovaCCD.

◆ GuideWest() [1/2]

IPState INDI::CCD::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.

Implements INDI::GuiderInterface.

Reimplemented in SBIGCCD, SXCCD, CCDSim, QSICCD, QHYCCD, GuideSim, FishCampCCD, SSAGCCD, GenericCCD, ASICCD, MICCD, and INovaCCD.

◆ GuideWest() [2/2]

virtual IPState INDI::CCD::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.

Implements INDI::GuiderInterface.

Reimplemented in SBIGCCD, SXCCD, CCDSim, QSICCD, QHYCCD, GuideSim, FishCampCCD, SSAGCCD, GenericCCD, ASICCD, MICCD, and INovaCCD.

◆ HasBayer() [1/2]

bool INDI::CCD::HasBayer ( )

inlineprotected

Returns: True if CCD sends image data in bayer format. False otherwise.

◆ HasBayer() [2/2]

bool INDI::CCD::HasBayer ( )

inlineprotected

Returns: True if CCD sends image data in bayer format. False otherwise.

◆ HasCooler() [1/2]

bool INDI::CCD::HasCooler ( )

inlineprotected

Returns: True if CCD has cooler and temperature can be controlled. False otherwise.

◆ HasCooler() [2/2]

bool INDI::CCD::HasCooler ( )

inlineprotected

Returns: True if CCD has cooler and temperature can be controlled. False otherwise.

◆ HasGuideHead() [1/2]

bool INDI::CCD::HasGuideHead ( )

inlineprotected

Returns: True if CCD has guide head. False otherwise.

◆ HasGuideHead() [2/2]

bool INDI::CCD::HasGuideHead ( )

inlineprotected

Returns: True if CCD has guide head. False otherwise.

◆ HasShutter() [1/2]

bool INDI::CCD::HasShutter ( )

inlineprotected

Returns: True if CCD has mechanical or electronic shutter. False otherwise.

◆ HasShutter() [2/2]

bool INDI::CCD::HasShutter ( )

inlineprotected

Returns: True if CCD has mechanical or electronic shutter. False otherwise.

◆ HasST4Port() [1/2]

bool INDI::CCD::HasST4Port ( )

inlineprotected

Returns: True if CCD has ST4 port for guiding. False otherwise.

◆ HasST4Port() [2/2]

bool INDI::CCD::HasST4Port ( )

inlineprotected

Returns: True if CCD has ST4 port for guiding. False otherwise.

◆ HasStreaming() [1/2]

bool INDI::CCD::HasStreaming ( )

inlineprotected

Returns: True if the CCD supports live video streaming. False otherwise.

◆ HasStreaming() [2/2]

bool INDI::CCD::HasStreaming ( )

inlineprotected

Returns: True if the CCD supports live video streaming. False otherwise.

◆ initProperties() [1/2]

bool INDI::CCD::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::DefaultDevice.

Reimplemented in MGenAutoguider, SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, QSICCD, SSAGCCD, V4L2_Driver, NightscapeCCD, CCDSim, ApogeeCCD, DSICCD, GenericCCD, QHYCCD, FFMVCCD, FishCampCCD, FLICCD, GigECCD, GuideSim, ASICCD, MICCD, SimpleCCD, and INovaCCD.

◆ initProperties() [2/2]

virtual bool INDI::CCD::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::DefaultDevice.

Reimplemented in MGenAutoguider, SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, QSICCD, SSAGCCD, V4L2_Driver, NightscapeCCD, CCDSim, ApogeeCCD, DSICCD, GenericCCD, QHYCCD, FFMVCCD, FishCampCCD, FLICCD, GigECCD, GuideSim, ASICCD, MICCD, SimpleCCD, and INovaCCD.

◆ ISGetProperties() [1/2]

virtual void INDI::CCD::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::DefaultDevice.

Reimplemented in SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, CCDSim, V4L2_Driver, ApogeeCCD, GenericCCD, QHYCCD, FishCampCCD, FLICCD, GuideSim, MICCD, and INovaCCD.

◆ ISGetProperties() [2/2]

void INDI::CCD::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::DefaultDevice.

Reimplemented in SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, CCDSim, V4L2_Driver, ApogeeCCD, GenericCCD, QHYCCD, FishCampCCD, FLICCD, GuideSim, MICCD, and INovaCCD.

◆ ISNewNumber() [1/2]

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

virtual

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

Reimplemented in SBIGCCD, MGenAutoguider, GPhotoCCD, GigECCD, ApogeeCCD, SSAGCCD, indi_webcam, CCDSim, QHYCCD, V4L2_Driver, MICCD, FishCampCCD, FLICCD, ASICCD, QSICCD, NightscapeCCD, GuideSim, DSICCD, and INovaCCD.

◆ ISNewNumber() [2/2]

virtual bool INDI::CCD::ISNewNumber	(	const char *	dev,
		const char *	name,
		double	values[],
		char *	names[],
		int	n
	)

virtual

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

Reimplemented in SBIGCCD, MGenAutoguider, GPhotoCCD, GigECCD, ApogeeCCD, SSAGCCD, indi_webcam, CCDSim, QHYCCD, V4L2_Driver, MICCD, FishCampCCD, FLICCD, ASICCD, QSICCD, NightscapeCCD, GuideSim, DSICCD, and INovaCCD.

◆ ISNewSwitch() [1/2]

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

virtual

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

Reimplemented in SBIGCCD, MGenAutoguider, SXCCD, GPhotoCCD, ApogeeCCD, indi_webcam, QHYCCD, CCDSim, MICCD, V4L2_Driver, FLICCD, ASICCD, QSICCD, GuideSim, NightscapeCCD, DSICCD, and FFMVCCD.

◆ ISNewSwitch() [2/2]

virtual bool INDI::CCD::ISNewSwitch	(	const char *	dev,
		const char *	name,
		ISState *	states,
		char *	names[],
		int	n
	)

virtual

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

Reimplemented in SBIGCCD, MGenAutoguider, SXCCD, GPhotoCCD, ApogeeCCD, indi_webcam, QHYCCD, CCDSim, MICCD, V4L2_Driver, FLICCD, ASICCD, QSICCD, GuideSim, NightscapeCCD, DSICCD, and FFMVCCD.

◆ ISNewText() [1/2]

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

virtual

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

Reimplemented in SBIGCCD, GPhotoCCD, ApogeeCCD, indi_webcam, CCDSim, QHYCCD, MICCD, V4L2_Driver, and QSICCD.

◆ ISNewText() [2/2]

virtual bool INDI::CCD::ISNewText	(	const char *	dev,
		const char *	name,
		char *	texts[],
		char *	names[],
		int	n
	)

virtual

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

Reimplemented in SBIGCCD, GPhotoCCD, ApogeeCCD, indi_webcam, CCDSim, QHYCCD, MICCD, V4L2_Driver, and QSICCD.

◆ ISSnoopDevice() [1/2]

virtual bool INDI::CCD::ISSnoopDevice ( XMLEle * root )

virtual

Process a snoop event from INDI server.

This function is called when a snooped property is updated in a snooped driver.

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

Reimplemented in CCDSim, and GuideSim.

◆ ISSnoopDevice() [2/2]

bool INDI::CCD::ISSnoopDevice ( XMLEle * root )

virtual

Process a snoop event from INDI server.

This function is called when a snooped property is updated in a snooped driver.

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

Reimplemented in CCDSim, and GuideSim.

◆ saveConfigItems() [1/2]

virtual bool INDI::CCD::saveConfigItems ( FILE * fp )

protectedvirtual

saveConfigItems Save configuration items in XML file.

Parameters

fp	pointer to file to write to

Returns: True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Reimplemented in SBIGCCD, GPhotoCCD, indi_webcam, CCDSim, V4L2_Driver, GuideSim, SSAGCCD, ApogeeCCD, ASICCD, QSICCD, QHYCCD, FLICCD, MICCD, NightscapeCCD, and DSICCD.

◆ saveConfigItems() [2/2]

bool INDI::CCD::saveConfigItems ( FILE * fp )

protectedvirtual

saveConfigItems Save configuration items in XML file.

Parameters

fp	pointer to file to write to

Returns: True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

Reimplemented in SBIGCCD, GPhotoCCD, indi_webcam, CCDSim, V4L2_Driver, GuideSim, SSAGCCD, ApogeeCCD, ASICCD, QSICCD, QHYCCD, FLICCD, MICCD, NightscapeCCD, and DSICCD.

◆ SetCCDCapability() [1/2]

void INDI::CCD::SetCCDCapability ( uint32_t cap )

protected

SetCCDCapability Set the CCD capabilities.

Al fields must be initilized.

Parameters

cap	pointer to CCDCapability struct.

◆ SetCCDCapability() [2/2]

void INDI::CCD::SetCCDCapability ( uint32_t cap )

protected

SetCCDCapability Set the CCD capabilities.

Al fields must be initilized.

Parameters

cap	pointer to CCDCapability struct.

◆ SetCCDParams() [1/2]

void INDI::CCD::SetCCDParams	(	int	x,
		int	y,
		int	bpp,
		float	xf,
		float	yf
	)

protectedvirtual

Setup CCD paramters for primary CCD.

Child classes call this function to update CCD parameters

Parameters

x	Frame X coordinates in pixels.
y	Frame Y coordinates in pixels.
bpp	Bits Per Pixels.
xf	X pixel size in microns.
yf	Y pixel size in microns.

◆ SetCCDParams() [2/2]

virtual void INDI::CCD::SetCCDParams	(	int	x,
		int	y,
		int	bpp,
		float	xf,
		float	yf
	)

protectedvirtual

Setup CCD paramters for primary CCD.

Child classes call this function to update CCD parameters

Parameters

x	Frame X coordinates in pixels.
y	Frame Y coordinates in pixels.
bpp	Bits Per Pixels.
xf	X pixel size in microns.
yf	Y pixel size in microns.

◆ SetGuiderParams() [1/2]

void INDI::CCD::SetGuiderParams	(	int	x,
		int	y,
		int	bpp,
		float	xf,
		float	yf
	)

protectedvirtual

Setup CCD paramters for guide head CCD.

Child classes call this function to update CCD parameters

Parameters

x	Frame X coordinates in pixels.
y	Frame Y coordinates in pixels.
bpp	Bits Per Pixels.
xf	X pixel size in microns.
yf	Y pixel size in microns.

◆ SetGuiderParams() [2/2]

virtual void INDI::CCD::SetGuiderParams	(	int	x,
		int	y,
		int	bpp,
		float	xf,
		float	yf
	)

protectedvirtual

Setup CCD paramters for guide head CCD.

Child classes call this function to update CCD parameters

Parameters

x	Frame X coordinates in pixels.
y	Frame Y coordinates in pixels.
bpp	Bits Per Pixels.
xf	X pixel size in microns.
yf	Y pixel size in microns.

◆ SetTemperature() [1/2]

virtual int INDI::CCD::SetTemperature ( double temperature )

protectedvirtual

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 in SBIGCCD, CCDSim, SXCCD, QSICCD, FishCampCCD, NightscapeCCD, FLICCD, ApogeeCCD, GenericCCD, QHYCCD, MICCD, ASICCD, and SimpleCCD.

◆ SetTemperature() [2/2]

int INDI::CCD::SetTemperature ( double temperature )

protectedvirtual

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 in SBIGCCD, CCDSim, SXCCD, QSICCD, FishCampCCD, NightscapeCCD, FLICCD, ApogeeCCD, GenericCCD, QHYCCD, MICCD, ASICCD, and SimpleCCD.

◆ StartExposure() [1/2]

virtual bool INDI::CCD::StartExposure ( float duration )

protectedvirtual

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 in SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, V4L2_Driver, CCDSim, QSICCD, SSAGCCD, ApogeeCCD, GuideSim, NightscapeCCD, GenericCCD, QHYCCD, DSICCD, FishCampCCD, FLICCD, MICCD, ASICCD, FFMVCCD, GigECCD, SimpleCCD, and INovaCCD.

◆ StartExposure() [2/2]

bool INDI::CCD::StartExposure ( float duration )

protectedvirtual

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 in SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, V4L2_Driver, CCDSim, QSICCD, SSAGCCD, ApogeeCCD, GuideSim, NightscapeCCD, GenericCCD, QHYCCD, DSICCD, FishCampCCD, FLICCD, MICCD, ASICCD, FFMVCCD, GigECCD, SimpleCCD, and INovaCCD.

◆ StartGuideExposure() [1/2]

bool INDI::CCD::StartGuideExposure ( float duration )

protectedvirtual

Start exposing guide 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 in SBIGCCD, SXCCD, and CCDSim.

◆ StartGuideExposure() [2/2]

virtual bool INDI::CCD::StartGuideExposure ( float duration )

protectedvirtual

Start exposing guide 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 in SBIGCCD, SXCCD, and CCDSim.

◆ StartStreaming() [1/2]

virtual bool INDI::CCD::StartStreaming ( )

protectedvirtual

StartStreaming Start live video streaming.

Returns: True if successful, false otherwise.

Reimplemented in GPhotoCCD, CCDSim, indi_webcam, QHYCCD, GuideSim, V4L2_Driver, and ASICCD.

◆ StartStreaming() [2/2]

bool INDI::CCD::StartStreaming ( )

protectedvirtual

StartStreaming Start live video streaming.

Returns: True if successful, false otherwise.

Reimplemented in GPhotoCCD, CCDSim, indi_webcam, QHYCCD, GuideSim, V4L2_Driver, and ASICCD.

◆ StopStreaming() [1/2]

bool INDI::CCD::StopStreaming ( )

protectedvirtual

StopStreaming Stop live video streaming.

Returns: True if successful, false otherwise.

Reimplemented in GPhotoCCD, CCDSim, indi_webcam, QHYCCD, GuideSim, V4L2_Driver, and ASICCD.

◆ StopStreaming() [2/2]

virtual bool INDI::CCD::StopStreaming ( )

protectedvirtual

StopStreaming Stop live video streaming.

Returns: True if successful, false otherwise.

Reimplemented in GPhotoCCD, CCDSim, indi_webcam, QHYCCD, GuideSim, V4L2_Driver, and ASICCD.

◆ UpdateCCDBin() [1/2]

virtual bool INDI::CCD::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 in SBIGCCD, CCDSim, SXCCD, GuideSim, V4L2_Driver, QSICCD, QHYCCD, MICCD, ApogeeCCD, ASICCD, FLICCD, GenericCCD, FishCampCCD, GigECCD, and DSICCD.

◆ UpdateCCDBin() [2/2]

bool INDI::CCD::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 in SBIGCCD, CCDSim, SXCCD, GuideSim, V4L2_Driver, QSICCD, QHYCCD, MICCD, ApogeeCCD, ASICCD, FLICCD, GenericCCD, FishCampCCD, GigECCD, and DSICCD.

◆ UpdateCCDFrame() [1/2]

virtual bool INDI::CCD::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 in SBIGCCD, CCDSim, indi_webcam, GPhotoCCD, SXCCD, GuideSim, V4L2_Driver, QSICCD, QHYCCD, MICCD, ApogeeCCD, ASICCD, FLICCD, GenericCCD, FishCampCCD, and GigECCD.

◆ UpdateCCDFrame() [2/2]

bool INDI::CCD::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 in SBIGCCD, CCDSim, indi_webcam, GPhotoCCD, SXCCD, GuideSim, V4L2_Driver, QSICCD, QHYCCD, MICCD, ApogeeCCD, ASICCD, FLICCD, GenericCCD, FishCampCCD, and GigECCD.

◆ UpdateCCDFrameType() [1/2]

bool INDI::CCD::UpdateCCDFrameType ( 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 in SBIGCCD, FLICCD, GenericCCD, FishCampCCD, and GigECCD.

◆ UpdateCCDFrameType() [2/2]

virtual bool INDI::CCD::UpdateCCDFrameType ( 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 in SBIGCCD, FLICCD, GenericCCD, FishCampCCD, and GigECCD.

◆ UpdateCCDUploadMode() [1/2]

virtual bool INDI::CCD::UpdateCCDUploadMode ( CCD_UPLOAD_MODE mode )

inlineprotectedvirtual

CCD calls this function when client upload mode switch is updated.

Parameters

mode	upload mode. UPLOAD_CLIENT only sends the upload the client application. UPLOAD_BOTH saves the frame and uploads it to the client. UPLOAD_LOCAL only saves the frame locally.

Returns: true if mode is changed successfully, false otherwise.

Note: By default this function is implemented in the base class and returns true. Override if necessary.

Reimplemented in GPhotoCCD.

◆ UpdateCCDUploadMode() [2/2]

virtual bool INDI::CCD::UpdateCCDUploadMode ( CCD_UPLOAD_MODE mode )

inlineprotectedvirtual

CCD calls this function when client upload mode switch is updated.

Parameters

mode	upload mode. UPLOAD_CLIENT only sends the upload the client application. UPLOAD_BOTH saves the frame and uploads it to the client. UPLOAD_LOCAL only saves the frame locally.

Returns: true if mode is changed successfully, false otherwise.

Note: By default this function is implemented in the base class and returns true. Override if necessary.

Reimplemented in GPhotoCCD.

◆ UpdateGuiderBin() [1/2]

virtual bool INDI::CCD::UpdateGuiderBin	(	int	hor,
		int	ver
	)

protectedvirtual

CCD calls this function when Guide head binning is updated by the client.

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

◆ UpdateGuiderBin() [2/2]

bool INDI::CCD::UpdateGuiderBin	(	int	hor,
		int	ver
	)

protectedvirtual

CCD calls this function when Guide head binning is updated by the client.

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

◆ UpdateGuiderFrame() [1/2]

virtual bool INDI::CCD::UpdateGuiderFrame	(	int	x,
		int	y,
		int	w,
		int	h
	)

protectedvirtual

CCD calls this function when Guide head frame dimension is updated by the client.

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

◆ UpdateGuiderFrame() [2/2]

bool INDI::CCD::UpdateGuiderFrame	(	int	x,
		int	y,
		int	w,
		int	h
	)

protectedvirtual

CCD calls this function when Guide head frame dimension is updated by the client.

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

◆ UpdateGuiderFrameType() [1/2]

virtual bool INDI::CCD::UpdateGuiderFrameType ( CCDChip::CCD_FRAME fType )

protectedvirtual

CCD calls this function when Guide frame type is updated by the client.

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.

◆ UpdateGuiderFrameType() [2/2]

bool INDI::CCD::UpdateGuiderFrameType ( CCDChip::CCD_FRAME fType )

protectedvirtual

CCD calls this function when Guide frame type is updated by the client.

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.

◆ updateProperties() [1/2]

bool INDI::CCD::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::DefaultDevice.

Reimplemented in MGenAutoguider, SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, QSICCD, SSAGCCD, V4L2_Driver, NightscapeCCD, CCDSim, ApogeeCCD, GenericCCD, DSICCD, QHYCCD, FishCampCCD, FLICCD, FFMVCCD, GigECCD, MICCD, GuideSim, ASICCD, SimpleCCD, and INovaCCD.

◆ updateProperties() [2/2]

virtual bool INDI::CCD::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::DefaultDevice.

Reimplemented in MGenAutoguider, SBIGCCD, SXCCD, GPhotoCCD, indi_webcam, QSICCD, SSAGCCD, V4L2_Driver, NightscapeCCD, CCDSim, ApogeeCCD, GenericCCD, DSICCD, QHYCCD, FishCampCCD, FLICCD, FFMVCCD, GigECCD, MICCD, GuideSim, ASICCD, SimpleCCD, and INovaCCD.

◆ uploadFile() [1/2]

bool INDI::CCD::uploadFile	(	CCDChip *	targetChip,
		const void *	fitsData,
		size_t	totalBytes,
		bool	sendImage,
		bool	saveImage
	)

private

◆ uploadFile() [2/2]

bool INDI::CCD::uploadFile	(	CCDChip *	targetChip,
		const void *	fitsData,
		size_t	totalBytes,
		bool	sendImage,
		bool	saveImage
	)

private

Friends And Related Function Documentation

◆ StreamManager

StreamManager

friend

Member Data Documentation

◆ ActiveDeviceT

IText INDI::CCD::ActiveDeviceT {}

protected

◆ ActiveDeviceTP

ITextVectorProperty INDI::CCD::ActiveDeviceTP

protected

◆ Airmass

double INDI::CCD::Airmass

protected

◆ AutoLoop

bool INDI::CCD::AutoLoop

protected

◆ BayerT

IText INDI::CCD::BayerT {}

protected

◆ BayerTP

ITextVectorProperty INDI::CCD::BayerTP

protected

◆ capability

uint32_t INDI::CCD::capability

private

◆ CCDCapability [1/2]

enum { ... } INDI::CCD::CCDCapability

◆ CCDCapability [2/2]

enum { ... } INDI::CCD::CCDCapability

◆ CCDRotationN

INumber INDI::CCD::CCDRotationN

protected

◆ CCDRotationNP

INumberVectorProperty INDI::CCD::CCDRotationNP

protected

◆ CurrentFilterSlot

int INDI::CCD::CurrentFilterSlot

protected

◆ Dec

double INDI::CCD::Dec

protected

◆ EqN

INumber INDI::CCD::EqN

protected

◆ EqNP

INumberVectorProperty INDI::CCD::EqNP

protected

◆ ExposureLoopCountN

INumber INDI::CCD::ExposureLoopCountN

protected

◆ ExposureLoopCountNP

INumberVectorProperty INDI::CCD::ExposureLoopCountNP

protected

◆ ExposureLoopS

ISwitch INDI::CCD::ExposureLoopS

protected

◆ ExposureLoopSP

ISwitchVectorProperty INDI::CCD::ExposureLoopSP

protected

◆ exposureLoopStartup

std::chrono::system_clock::time_point INDI::CCD::exposureLoopStartup

protected

◆ ExposureTime

float INDI::CCD::ExposureTime

protected

◆ FileNameT

IText INDI::CCD::FileNameT {}

protected

◆ FileNameTP

ITextVectorProperty INDI::CCD::FileNameTP

protected

◆ FilterNames

std::vector< std::string > INDI::CCD::FilterNames

protected

◆ FITSHeaderT

IText INDI::CCD::FITSHeaderT {}

protected

◆ FITSHeaderTP

ITextVectorProperty INDI::CCD::FITSHeaderTP

protected

◆ GuideCCD

CCDChip INDI::CCD::GuideCCD

protected

◆ guiderAperture

double INDI::CCD::guiderAperture

protected

◆ GuiderAutoLoop

bool INDI::CCD::GuiderAutoLoop

protected

◆ GuiderExposureTime

float INDI::CCD::GuiderExposureTime

protected

◆ guiderFocalLength

double INDI::CCD::guiderFocalLength

protected

◆ GuiderRapidGuideEnabled

bool INDI::CCD::GuiderRapidGuideEnabled

protected

◆ GuiderSendImage

bool INDI::CCD::GuiderSendImage

protected

◆ GuiderShowMarker

bool INDI::CCD::GuiderShowMarker

protected

◆ InExposure

bool INDI::CCD::InExposure

protected

◆ InGuideExposure

bool INDI::CCD::InGuideExposure

protected

◆ J2000DE

double INDI::CCD::J2000DE

protected

◆ J2000RA

double INDI::CCD::J2000RA

protected

◆ Latitude

double INDI::CCD::Latitude

protected

◆ Longitude

double INDI::CCD::Longitude

protected

◆ MPSAS

double INDI::CCD::MPSAS

protected

◆ primaryAperture

double INDI::CCD::primaryAperture

protected

◆ PrimaryCCD

CCDChip INDI::CCD::PrimaryCCD

protected

◆ primaryFocalLength

double INDI::CCD::primaryFocalLength

protected

◆ RA

double INDI::CCD::RA

protected

◆ RapidGuideEnabled

bool INDI::CCD::RapidGuideEnabled

protected

◆ RotatorAngle

double INDI::CCD::RotatorAngle

protected

◆ SendImage

bool INDI::CCD::SendImage

protected

◆ ShowMarker

bool INDI::CCD::ShowMarker

protected

◆ Streamer

std::unique_ptr< StreamManager > INDI::CCD::Streamer

protected

◆ TelescopeTypeS

ISwitch INDI::CCD::TelescopeTypeS

protected

◆ TelescopeTypeSP

ISwitchVectorProperty INDI::CCD::TelescopeTypeSP

protected

◆ TemperatureN

INumber INDI::CCD::TemperatureN

protected

◆ TemperatureNP

INumberVectorProperty INDI::CCD::TemperatureNP

protected

◆ UploadS

ISwitch INDI::CCD::UploadS

protected

◆ UploadSettingsT

IText INDI::CCD::UploadSettingsT {}

protected

◆ UploadSettingsTP

ITextVectorProperty INDI::CCD::UploadSettingsTP

protected

◆ UploadSP

ISwitchVectorProperty INDI::CCD::UploadSP

protected

◆ uploadTime

double INDI::CCD::uploadTime = { 0 }

protected

◆ ValidCCDRotation

bool INDI::CCD::ValidCCDRotation

private

◆ WorldCoordS

ISwitch INDI::CCD::WorldCoordS

protected

◆ WorldCoordSP

ISwitchVectorProperty INDI::CCD::WorldCoordSP

protected

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

/home/nirva/insroot/include/libindi/indiccd.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/libs/indibase/indiccd.cpp

Public Types

Public Member Functions

Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ anonymous enum

◆ CCD_UPLOAD_MODE [1/2]

◆ CCD_UPLOAD_MODE [2/2]

Constructor & Destructor Documentation

◆ CCD() [1/2]

◆ ~CCD() [1/2]

◆ CCD() [2/2]

◆ ~CCD() [2/2]

Member Function Documentation

◆ AbortExposure() [1/2]

◆ AbortExposure() [2/2]

◆ AbortGuideExposure() [1/2]

◆ AbortGuideExposure() [2/2]

◆ activeDevicesUpdated() [1/2]

◆ activeDevicesUpdated() [2/2]

◆ addFITSKeywords() [1/2]

◆ addFITSKeywords() [2/2]

◆ CanAbort() [1/2]

◆ CanAbort() [2/2]

◆ CanBin() [1/2]

◆ CanBin() [2/2]

◆ CanSubFrame() [1/2]

◆ CanSubFrame() [2/2]

◆ ExposureComplete() [1/2]

◆ ExposureComplete() [2/2]

◆ fits_update_key_s() [1/2]

◆ fits_update_key_s() [2/2]

◆ GetCCDCapability() [1/2]

◆ GetCCDCapability() [2/2]

◆ getFileIndex() [1/2]

◆ getFileIndex() [2/2]

◆ getMinMax() [1/2]

◆ getMinMax() [2/2]

◆ GuideComplete() [1/2]

◆ GuideComplete() [2/2]

◆ GuideEast() [1/2]

◆ GuideEast() [2/2]

◆ GuideNorth() [1/2]

◆ GuideNorth() [2/2]

◆ GuideSouth() [1/2]

◆ GuideSouth() [2/2]

◆ GuideWest() [1/2]

◆ GuideWest() [2/2]

◆ HasBayer() [1/2]

◆ HasBayer() [2/2]

◆ HasCooler() [1/2]

◆ HasCooler() [2/2]

◆ HasGuideHead() [1/2]

◆ HasGuideHead() [2/2]

◆ HasShutter() [1/2]

◆ HasShutter() [2/2]

◆ HasST4Port() [1/2]

◆ HasST4Port() [2/2]

◆ HasStreaming() [1/2]

◆ HasStreaming() [2/2]

◆ initProperties() [1/2]

◆ initProperties() [2/2]

◆ ISGetProperties() [1/2]