The GuideSim class provides a simple Guide CCD simulator driver. More...

#include <guide_simulator.h>

Inheritance diagram for GuideSim:

Collaboration diagram for GuideSim:

Classes
struct	ExpStart

Public Member Functions
	GuideSim ()

virtual	~GuideSim ()=default

const char *	getDefaultName () override

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

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

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

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

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

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

void *	streamVideo ()

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

virtual	~CCD ()

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

	CCD ()

virtual	~CCD ()

virtual bool	ISNewText (const char dev, const char name, char texts[], char names[], int n)
	Process the client newSwitch command. 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 ()

Static Public Member Functions
static void *	streamVideoHelper (void *context)

Protected Member Functions
bool	Connect () override
	Connect to the device. More...

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

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

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

void	TimerHit () override
	Callback function to be called once SetTimer duration elapses. More...

int	DrawCcdFrame (INDI::CCDChip *targetChip)

int	DrawImageStar (INDI::CCDChip *targetChip, float, float, float, float ExposureTime)

int	AddToPixel (INDI::CCDChip *targetChip, int, int, int)

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

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

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

IPState	GuideWest (uint32_t) override
	Guide westward for ms milliseconds. More...

virtual bool	saveConfigItems (FILE *fp) override
	saveConfigItems Save configuration items in XML file. More...

virtual void	activeDevicesUpdated () override
	activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...

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

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

virtual bool	StartStreaming () override
	StartStreaming Start live video streaming. More...

virtual bool	StopStreaming () override
	StopStreaming Stop live video streaming. More...

Protected Member Functions inherited from INDI::CCD
uint32_t	GetCCDCapability () const
	GetCCDCapability returns the CCD capabilities. More...

void	SetCCDCapability (uint32_t cap)
	SetCCDCapability Set the CCD capabilities. More...

bool	CanAbort ()

bool	CanBin ()

bool	CanSubFrame ()

bool	HasGuideHead ()

bool	HasShutter ()

bool	HasST4Port ()

bool	HasCooler ()

bool	HasBayer ()

bool	HasStreaming ()

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

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

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

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

virtual bool	UpdateGuiderFrame (int x, int y, int w, int h)
	CCD calls this function when Guide head frame dimension is updated by the client. More...

virtual bool	UpdateGuiderBin (int hor, int ver)
	CCD calls this function when Guide head binning is updated by the client. More...

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

virtual bool	UpdateCCDUploadMode (CCD_UPLOAD_MODE mode)
	CCD calls this function when client upload mode switch is updated. More...

virtual bool	UpdateGuiderFrameType (CCDChip::CCD_FRAME fType)
	CCD calls this function when Guide frame type is updated by the client. More...

virtual void	SetCCDParams (int x, int y, int bpp, float xf, float yf)
	Setup CCD paramters for primary CCD. More...

virtual void	SetGuiderParams (int x, int y, int bpp, float xf, float yf)
	Setup CCD paramters for guide head CCD. More...

virtual void	addFITSKeywords (fitsfile fptr, CCDChip targetChip)
	Add FITS keywords to a fits file. More...

void	fits_update_key_s (fitsfile fptr, int type, std::string name, void p, std::string explanation, int *status)
	A function to just remove GCC warnings about deprecated conversion. More...

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	ExposureComplete (CCDChip *targetChip)
	Uploads target Chip exposed buffer as FITS to the client. More...

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

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

virtual bool	UpdateGuiderFrame (int x, int y, int w, int h)
	CCD calls this function when Guide head frame dimension is updated by the client. More...

virtual bool	UpdateGuiderBin (int hor, int ver)
	CCD calls this function when Guide head binning is updated by the client. More...

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

virtual bool	UpdateCCDUploadMode (CCD_UPLOAD_MODE mode)
	CCD calls this function when client upload mode switch is updated. More...

virtual bool	UpdateGuiderFrameType (CCDChip::CCD_FRAME fType)
	CCD calls this function when Guide frame type is updated by the client. More...

virtual void	SetCCDParams (int x, int y, int bpp, float xf, float yf)
	Setup CCD paramters for primary CCD. More...

virtual void	SetGuiderParams (int x, int y, int bpp, float xf, float yf)
	Setup CCD paramters for guide head CCD. More...

virtual void	addFITSKeywords (fitsfile fptr, CCDChip targetChip)
	Add FITS keywords to a fits file. More...

void	fits_update_key_s (fitsfile fptr, int type, std::string name, void p, std::string explanation, int *status)
	A function to just remove GCC warnings about deprecated conversion. More...

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 (timeval, float)

bool	SetupParms ()

Private Attributes
float	ExposureRequest { 0 }

int	testvalue { 0 }

bool	ShowStarField { true }

int	bias { 1500 }

int	maxnoise { 20 }

int	maxval { 65000 }

int	maxpix { 0 }

int	minpix { 65000 }

float	skyglow { 40 }

float	limitingmag { 11.5 }

float	saturationmag { 2 }

float	seeing { 3.5 }

float	ImageScalex { 1.0 }

float	ImageScaley { 1.0 }

float	OAGoffset { 0 }

float	rotationCW { 0 }

float	TimeFactor { 1 }

float	k { 0 }

float	z { 0 }

float	guideNSOffset {0}

float	guideWEOffset {0}

bool	AbortPrimaryFrame { false }

float	GuideRate { 7 }
	Guide rate is 7 arcseconds per second. More...

float	PEPeriod { 8*60 }
	Our PEPeriod is 8 minutes and we have a 22 arcsecond swing. More...

float	PEMax { 11 }

double	currentRA { 0 }

double	currentDE { 0 }

bool	usePE { false }

time_t	RunStart

float	polarError { 0 }

float	polarDrift { 0 }

int	streamPredicate

pthread_t	primary_thread

bool	terminateThread

INumberVectorProperty *	SimulatorSettingsNV

INumber	SimulatorSettingsN [14]

ISwitch	TimeFactorS [3]

ISwitchVectorProperty *	TimeFactorSV

INumberVectorProperty	FWHMNP

INumber	FWHMN [1]

INumberVectorProperty	EqPENP

INumber	EqPEN [2]

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

Detailed Description

The GuideSim class provides a simple Guide CCD simulator driver.

It can stream video and generate images based on General-Star-Catalog tool (gsc). It simulates guiding pulses.

Constructor & Destructor Documentation

◆ GuideSim()

GuideSim::GuideSim ( )

◆ ~GuideSim()

virtual GuideSim::~GuideSim ( )

virtualdefault

Member Function Documentation

◆ AbortExposure()

bool GuideSim::AbortExposure ( )

overrideprotectedvirtual

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.

◆ activeDevicesUpdated()

void GuideSim::activeDevicesUpdated ( )

overrideprotectedvirtual

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

Reimplemented from INDI::CCD.

◆ AddToPixel()

int GuideSim::AddToPixel	(	INDI::CCDChip *	targetChip,
		int	x,
		int	y,
		int	val
	)

protected

◆ CalcTimeLeft()

float GuideSim::CalcTimeLeft	(	timeval	start,
		float	req
	)

private

◆ Connect()

bool GuideSim::Connect ( )

overrideprotectedvirtual

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 GuideSim::Disconnect ( )

overrideprotectedvirtual

Disconnect from device.

Returns: True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ DrawCcdFrame()

int GuideSim::DrawCcdFrame ( INDI::CCDChip * targetChip )

protected

◆ DrawImageStar()

int GuideSim::DrawImageStar	(	INDI::CCDChip *	targetChip,
		float	mag,
		float	x,
		float	y,
		float	ExposureTime
	)

protected

◆ getDefaultName()

const char * GuideSim::getDefaultName ( )

overridevirtual

Returns: Default name of the device.

Implements INDI::DefaultDevice.

◆ GuideEast()

IPState GuideSim::GuideEast ( uint32_t ms )

overrideprotectedvirtual

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

overrideprotectedvirtual

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

overrideprotectedvirtual

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

overrideprotectedvirtual

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 GuideSim::initProperties ( )

overridevirtual

Initilize properties initial state and value.

The child class must implement this function.

Returns: True if initilization is successful, false otherwise.

Reimplemented from INDI::CCD.

◆ ISGetProperties()

void GuideSim::ISGetProperties ( const char * dev )

overridevirtual

define the driver's properties to the client.

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

Parameters

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.

◆ ISNewNumber()

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

overridevirtual

Process the client newNumber command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::CCD.

◆ ISNewSwitch()

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

overridevirtual

Process the client newSwitch command.

Note: This function is called by the INDI framework, do not call it directly.

Returns: True if any property was successfully processed, false otherwise.

Reimplemented from INDI::CCD.

◆ ISSnoopDevice()

bool GuideSim::ISSnoopDevice ( XMLEle * root )

overridevirtual

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

◆ saveConfigItems()

bool GuideSim::saveConfigItems ( FILE * fp )

overrideprotectedvirtual

saveConfigItems Save configuration items in XML file.

Parameters

fp	pointer to file to write to

Returns: True if successful, false otherwise

Reimplemented from INDI::CCD.

◆ SetupParms()

bool GuideSim::SetupParms ( )

private

◆ StartExposure()

bool GuideSim::StartExposure ( float duration )

overrideprotectedvirtual

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.

◆ StartStreaming()

bool GuideSim::StartStreaming ( )

overrideprotectedvirtual

StartStreaming Start live video streaming.

Returns: True if successful, false otherwise.

Reimplemented from INDI::CCD.

◆ StopStreaming()

bool GuideSim::StopStreaming ( )

overrideprotectedvirtual

StopStreaming Stop live video streaming.

Returns: True if successful, false otherwise.

Reimplemented from INDI::CCD.

◆ streamVideo()

void * GuideSim::streamVideo ( )

◆ streamVideoHelper()

void * GuideSim::streamVideoHelper ( void * context )

static

◆ TimerHit()

void GuideSim::TimerHit ( )

overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ UpdateCCDBin()

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

overrideprotectedvirtual

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

Derived classes should implement this function

Parameters

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 GuideSim::UpdateCCDFrame	(	int	x,
		int	y,
		int	w,
		int	h
	)

overrideprotectedvirtual

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

Derived classes should implement this function

Parameters

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.

◆ updateProperties()

bool GuideSim::updateProperties ( )

overridevirtual

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

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

Returns: True if update is successful, false otherwise.

Reimplemented from INDI::CCD.

Member Data Documentation

◆ AbortPrimaryFrame

bool GuideSim::AbortPrimaryFrame { false }

private

◆ bias

int GuideSim::bias { 1500 }

private

◆ currentDE

double GuideSim::currentDE { 0 }

private

◆ currentRA

double GuideSim::currentRA { 0 }

private

◆ EqPEN

INumber GuideSim::EqPEN[2]

private

◆ EqPENP

INumberVectorProperty GuideSim::EqPENP

private

◆ ExposureRequest

float GuideSim::ExposureRequest { 0 }

private

◆ FWHMN

INumber GuideSim::FWHMN[1]

private

◆ FWHMNP

INumberVectorProperty GuideSim::FWHMNP

private

◆ guideNSOffset

float GuideSim::guideNSOffset {0}

private

◆ GuideRate

float GuideSim::GuideRate { 7 }

private

Guide rate is 7 arcseconds per second.

◆ guideWEOffset

float GuideSim::guideWEOffset {0}

private

◆ ImageScalex

float GuideSim::ImageScalex { 1.0 }

private

◆ ImageScaley

float GuideSim::ImageScaley { 1.0 }

private

◆ k

float GuideSim::k { 0 }

private

◆ limitingmag

float GuideSim::limitingmag { 11.5 }

private

◆ maxnoise

int GuideSim::maxnoise { 20 }

private

◆ maxpix

int GuideSim::maxpix { 0 }

private

◆ maxval

int GuideSim::maxval { 65000 }

private

◆ minpix

int GuideSim::minpix { 65000 }

private

◆ OAGoffset

float GuideSim::OAGoffset { 0 }

private

◆ PEMax

float GuideSim::PEMax { 11 }

private

◆ PEPeriod

float GuideSim::PEPeriod { 8*60 }

private

Our PEPeriod is 8 minutes and we have a 22 arcsecond swing.

◆ polarDrift

float GuideSim::polarDrift { 0 }

private

◆ polarError

float GuideSim::polarError { 0 }

private

◆ primary_thread

pthread_t GuideSim::primary_thread

private

◆ rotationCW

float GuideSim::rotationCW { 0 }

private

◆ RunStart

time_t GuideSim::RunStart

private

◆ saturationmag

float GuideSim::saturationmag { 2 }

private

◆ seeing

float GuideSim::seeing { 3.5 }

private

◆ ShowStarField

bool GuideSim::ShowStarField { true }

private

◆ SimulatorSettingsN

INumber GuideSim::SimulatorSettingsN[14]

private

◆ SimulatorSettingsNV

INumberVectorProperty* GuideSim::SimulatorSettingsNV

private

◆ skyglow

float GuideSim::skyglow { 40 }

private

◆ streamPredicate

int GuideSim::streamPredicate

private

◆ terminateThread

bool GuideSim::terminateThread

private

◆ testvalue

int GuideSim::testvalue { 0 }

private

◆ TimeFactor

float GuideSim::TimeFactor { 1 }

private

◆ TimeFactorS

ISwitch GuideSim::TimeFactorS[3]

private

◆ TimeFactorSV

ISwitchVectorProperty* GuideSim::TimeFactorSV

private

◆ usePE

bool GuideSim::usePE { false }

private

◆ z

float GuideSim::z { 0 }

private

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

ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/ccd/guide_simulator.h
ln/3rdparty/src/indilib/indi-1.7.4/libindi/drivers/ccd/guide_simulator.cpp

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ GuideSim()

◆ ~GuideSim()

Member Function Documentation

◆ AbortExposure()

◆ activeDevicesUpdated()

◆ AddToPixel()

◆ CalcTimeLeft()

◆ Connect()

◆ Disconnect()

◆ DrawCcdFrame()

◆ DrawImageStar()

◆ getDefaultName()

◆ GuideEast()

◆ GuideNorth()

◆ GuideSouth()

◆ GuideWest()

◆ initProperties()

◆ ISGetProperties()

◆ ISNewNumber()

◆ ISNewSwitch()

◆ ISSnoopDevice()

◆ saveConfigItems()

◆ SetupParms()

◆ StartExposure()

◆ StartStreaming()

◆ StopStreaming()

◆ streamVideo()

◆ streamVideoHelper()

◆ TimerHit()

◆ UpdateCCDBin()

◆ UpdateCCDFrame()

◆ updateProperties()

Member Data Documentation

◆ AbortPrimaryFrame

◆ bias

◆ currentDE

◆ currentRA

◆ EqPEN

◆ EqPENP

◆ ExposureRequest

◆ FWHMN

◆ FWHMNP

◆ guideNSOffset

◆ GuideRate

◆ guideWEOffset

◆ ImageScalex

◆ ImageScaley

◆ k

◆ limitingmag

◆ maxnoise

◆ maxpix

◆ maxval

◆ minpix

◆ OAGoffset

◆ PEMax

◆ PEPeriod

◆ polarDrift

◆ polarError

◆ primary_thread

◆ rotationCW

◆ RunStart

◆ saturationmag

◆ seeing

◆ ShowStarField

◆ SimulatorSettingsN

◆ SimulatorSettingsNV

◆ skyglow

◆ streamPredicate

◆ terminateThread

◆ testvalue

◆ TimeFactor