GPSD Class Reference

#include <gps_driver.h>

Inheritance diagram for GPSD:

Collaboration diagram for GPSD:

Public Member Functions
	GPSD ()
virtual	~GPSD ()=default
Public Member Functions inherited from INDI::GPS
	GPS ()=default
virtual	~GPS ()=default
virtual bool	ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
	Process the client newSwitch command. More...
virtual bool	ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
	Process the client newNumber command. More...
	GPS ()=default
virtual	~GPS ()=default
virtual bool	ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n)
	Process the client newSwitch command. More...
virtual bool	ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n)
	Process the client newNumber 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 void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...
virtual bool	ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
	Process the client newSwitch command. More...
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 bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. 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 void	ISGetProperties (const char *dev)
	define the driver's properties to the client. More...
virtual bool	ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n)
	Process the client newSwitch command. More...
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 bool	ISSnoopDevice (XMLEle *root)
	Process a snoop event from INDI server. 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
IText	GPSstatusT [1] {}
ITextVectorProperty	GPSstatusTP
INumber	PolarisN [1]
INumberVectorProperty	PolarisNP

Protected Member Functions
virtual bool	Connect () override
	Connect to the device. More...
virtual bool	Disconnect () override
	Disconnect from device. More...
virtual const char *	getDefaultName () override
virtual bool	initProperties () override
	Initilize properties initial state and value. More...
virtual bool	updateProperties () override
	updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...
virtual IPState	updateGPS () override
	updateGPS Retrieve Location & Time from GPS. More...
Protected Member Functions inherited from INDI::GPS
virtual void	TimerHit ()
	TimerHit Keep calling updateGPS() until it is successfull, if it fails upon first connection. More...
virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save refresh period More...
virtual void	TimerHit ()
	TimerHit Keep calling updateGPS() until it is successfull, if it fails upon first connection. More...
virtual bool	saveConfigItems (FILE *fp)
	saveConfigItems Save refresh period 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...

Protected Attributes
gpsmm *	gps = nullptr
Protected Attributes inherited from INDI::GPS
INumberVectorProperty	LocationNP
INumber	LocationN [3]
IText	TimeT [2] {}
ITextVectorProperty	TimeTP
ISwitch	RefreshS [1]
ISwitchVectorProperty	RefreshSP
INumber	PeriodN [1]
INumberVectorProperty	PeriodNP
int	timerID = -1
Protected Attributes inherited from INDI::DefaultDevice
uint32_t	POLLMS = 1000
	Period in milliseconds to call TimerHit(). Default 1000 ms. More...

Additional Inherited Members
Public Types inherited from INDI::GPS
enum	GPSLocation {   LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION, LOCATION_LATITUDE,   LOCATION_LONGITUDE, LOCATION_ELEVATION }
enum	GPSLocation {   LOCATION_LATITUDE, LOCATION_LONGITUDE, LOCATION_ELEVATION, LOCATION_LATITUDE,   LOCATION_LONGITUDE, LOCATION_ELEVATION }
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...

Constructor & Destructor Documentation

GPSD()

GPSD::GPSD

(

)

~GPSD()

virtual GPSD::~GPSD ( )

virtualdefault

Member Function Documentation

Connect()

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

overrideprotectedvirtual

Disconnect from device.

Returns

True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

getDefaultName()

const char * GPSD::getDefaultName ( )

overrideprotectedvirtual

Returns

Default name of the device.

Implements INDI::DefaultDevice.

initProperties()

bool GPSD::initProperties ( )

overrideprotectedvirtual

Initilize properties initial state and value.

The child class must implement this function.

Returns

True if initilization is successful, false otherwise.

Reimplemented from INDI::GPS.

updateGPS()

IPState GPSD::updateGPS ( )

overrideprotectedvirtual

updateGPS Retrieve Location & Time from GPS.

Update LocationNP & TimeTP properties (value and state) without sending them to the client (i.e. IDSetXXX).

Returns

Return overall state. The state should be IPS_OK if data is valid. IPS_BUSY if GPS fix is in progress. IPS_ALERT is there is an error. The clients will only accept values with IPS_OK state.

Reimplemented from INDI::GPS.

updateProperties()

bool GPSD::updateProperties ( )

overrideprotectedvirtual

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

Member Data Documentation

gps

gpsmm* GPSD::gps = nullptr

protected

GPSstatusT

IText GPSD::GPSstatusT[1] {}

GPSstatusTP

ITextVectorProperty GPSD::GPSstatusTP

PolarisN

INumber GPSD::PolarisN[1]

PolarisNP

INumberVectorProperty GPSD::PolarisNP

---

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

• ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/indi-gpsd/gps_driver.h
• ln/3rdparty/src/indilib/indi-1.7.4/3rdparty/indi-gpsd/gps_driver.cpp