|
| GPS ()=default |
|
virtual | ~GPS ()=default |
|
virtual bool | initProperties () |
| Initilize properties initial state and value. The child class must implement this function. More...
|
|
virtual bool | updateProperties () |
| 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. More...
|
|
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...
|
|
| 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. Alternatively, IDDefNumber can be used but the property will not get registered and the driver will not be able to save configuration files. More...
|
|
void | defineText (ITextVectorProperty *tvp) |
| Define text vector to client & register it. Alternatively, IDDefText can be used but the property will not get registered and the driver will not be able to save configuration files. More...
|
|
void | defineSwitch (ISwitchVectorProperty *svp) |
| Define switch vector to client & register it. Alternatively, IDDefswitch can be used but the property will not get registered and the driver will not be able to save configuration files. More...
|
|
void | defineLight (ILightVectorProperty *lvp) |
| Define light vector to client & register it. Alternatively, IDDeflight can be used but the property will not get registered and the driver will not be able to save configuration files. More...
|
|
void | defineBLOB (IBLOBVectorProperty *bvp) |
| Define BLOB vector to client & register it. Alternatively, IDDefBLOB can be used but the property will not get registered and the driver will not be able to save configuration files. More...
|
|
virtual bool | deleteProperty (const char *propertyName) |
| Delete a property and unregister it. It will also be deleted from all clients. 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. 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. 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. This function is called when a snooped property is updated in a snooped driver. More...
|
|
virtual uint16_t | getDriverInterface () |
|
void | setDriverInterface (uint16_t value) |
| setInterface Set driver interface. By default the driver interface is set to GENERAL_DEVICE. You may send an ORed list of DeviceInterface values. More...
|
|
| 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 () |
|
|
virtual IPState | updateGPS () |
| updateGPS Retrieve Location & Time from GPS. Update LocationNP & TimeTP properties (value and state) without sending them to the client (i.e. IDSetXXX). 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...
|
|
void | setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled) |
| setDynamicPropertiesBehavior controls handling of dynamic properties. Dyanmic properties are those generated from an external skeleton XML file. By default all properties, including dynamic properties, are defined to the client in ISGetProperties(). Furthermore, when űdeleteProperty(properyName) is called, the dynamic property is deleted by default, and can only be restored by calling buildSkeleton(filename) again. However, it is sometimes desirable to skip the definition of the dynamic properties on startup and delegate this task to the child class. To control this behavior, set enabled to false. 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. This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled. More...
|
|
virtual void | simulationTriggered (bool enable) |
| Inform driver that the simulation option was triggered. This function is called after setSimulation is triggered by the client. Reimplement this function if your driver needs to take specific action after simulation is enabled/disabled. Otherwise, you can use isSimulation() to check if simulation is enabled or disabled. More...
|
|
bool | isDebug () |
|
bool | isSimulation () |
|
virtual bool | Connect () |
| 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. More...
|
|
virtual bool | Disconnect () |
| Disconnect from device. More...
|
|
void | registerConnection (Connection::Interface *newConnection) |
| registerConnection Add new connection plugin to the existing connection pool. The connection type shall be defined to the client in ISGetProperties() 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 |
|
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...
|
|
Definition at line 47 of file indigps.h.