Instrument Neutral Distributed Interface INDI  1.9.2
Public Types | Public Member Functions | Protected Member Functions | List of all members
SkySafariClient Class Reference

#include <skysafariclient.h>

Inheritance diagram for SkySafariClient:
INDI::BaseClient INDI::BaseMediator

Public Types

enum  GotoMode { SLEW, TRACK, SYNC }
 

Public Member Functions

 SkySafariClient ()
 
 ~SkySafariClient ()
 
bool isConnected ()
 
void setMount (const std::string &value)
 
INumberVectorPropertygetEquatorialCoords ()
 
bool sendEquatorialCoords ()
 
INumberVectorPropertygetGeographiCoords ()
 
bool sendGeographicCoords ()
 
ISwitchVectorPropertygetGotoMode ()
 
bool sendGotoMode ()
 
ISwitchVectorPropertygetMotionNS ()
 
bool setMotionNS ()
 
ISwitchVectorPropertygetMotionWE ()
 
bool setMotionWE ()
 
bool parkMount ()
 
IPState getMountParkState ()
 
bool setSlewRate (int slewRate)
 
bool abort ()
 
ITextVectorPropertygetTimeUTC ()
 
bool setTimeUTC ()
 
- Public Member Functions inherited from INDI::BaseClient
 BaseClient ()
 
virtual ~BaseClient ()
 
void setServer (const char *hostname, unsigned int port)
 Set the server host name and port. More...
 
const char * getHost () const
 Get the server host name. More...
 
int getPort () const
 Get the port number. More...
 
bool connectServer ()
 Connect to INDI server. More...
 
bool disconnectServer (int exit_code=0)
 Disconnect from INDI server. More...
 
bool isServerConnected () const
 Get status of the connection. More...
 
void setConnectionTimeout (uint32_t seconds, uint32_t microseconds)
 setConnectionTimeout Set connection timeout. By default it is 3 seconds. More...
 
void serverDisconnected (int exit_code) override
 Emmited when the server gets disconnected. More...
 
void setVerbose (bool enable)
 setVerbose Set verbose mode More...
 
bool isVerbose () const
 isVerbose Is client in verbose mode? More...
 
void watchProperty (const char *deviceName, const char *propertyName)
 watchProperties Add a property to the watch list. When communicating with INDI server. More...
 
void watchDevice (const char *deviceName)
 Add a device to the watch list. More...
 
void connectDevice (const char *deviceName)
 Connect to INDI driver. More...
 
void disconnectDevice (const char *deviceName)
 Disconnect INDI driver. More...
 
INDI::BaseDevicegetDevice (const char *deviceName)
 
const std::vector< INDI::BaseDevice * > & getDevices () const
 
bool getDevices (std::vector< INDI::BaseDevice * > &deviceList, uint16_t driverInterface)
 getDevices Returns list of devices that belong to a particular DRIVER_INTERFACE class. More...
 
void setBLOBMode (BLOBHandling blobH, const char *dev, const char *prop=nullptr)
 Set Binary Large Object policy mode. More...
 
BLOBHandling getBLOBMode (const char *dev, const char *prop=nullptr)
 getBLOBMode Get Binary Large Object policy mode IF set previously by setBLOBMode More...
 
void sendNewText (ITextVectorProperty *pp)
 Send new Text command to server. More...
 
void sendNewText (const char *deviceName, const char *propertyName, const char *elementName, const char *text)
 Send new Text command to server. More...
 
void sendNewNumber (INumberVectorProperty *pp)
 Send new Number command to server. More...
 
void sendNewNumber (const char *deviceName, const char *propertyName, const char *elementName, double value)
 Send new Number command to server. More...
 
void sendNewSwitch (ISwitchVectorProperty *pp)
 Send new Switch command to server. More...
 
void sendNewSwitch (const char *deviceName, const char *propertyName, const char *elementName)
 Send new Switch command to server. More...
 
void startBlob (const char *devName, const char *propName, const char *timestamp)
 Send opening tag for BLOB command to server. More...
 
void sendOneBlob (IBLOB *bp)
 Send ONE blob content to server. The BLOB data in raw binary format and will be converted to base64 and sent to server. More...
 
void sendOneBlob (const char *blobName, unsigned int blobSize, const char *blobFormat, void *blobBuffer)
 Send ONE blob content to server. The BLOB data in raw binary format and will be converted to base64 and sent to server. More...
 
void finishBlob ()
 Send closing tag for BLOB command to server. More...
 
- Public Member Functions inherited from INDI::BaseMediator
virtual ~BaseMediator ()=default
 

Protected Member Functions

virtual void newDevice (INDI::BaseDevice *dp)
 Emmited when a new device is created from INDI server. More...
 
virtual void removeDevice (INDI::BaseDevice *)
 Emmited when a device is deleted from INDI server. More...
 
virtual void newProperty (INDI::Property *property)
 Emmited when a new property is created for an INDI driver. More...
 
virtual void removeProperty (INDI::Property *)
 Emmited when a property is deleted for an INDI driver. More...
 
virtual void newBLOB (IBLOB *)
 Emmited when a new BLOB value arrives from INDI server. More...
 
virtual void newSwitch (ISwitchVectorProperty *)
 Emmited when a new switch value arrives from INDI server. More...
 
virtual void newNumber (INumberVectorProperty *)
 Emmited when a new number value arrives from INDI server. More...
 
virtual void newMessage (INDI::BaseDevice *, int)
 Emmited when a new message arrives from INDI server. More...
 
virtual void newText (ITextVectorProperty *)
 Emmited when a new text value arrives from INDI server. More...
 
virtual void newLight (ILightVectorProperty *)
 Emmited when a new light value arrives from INDI server. More...
 
virtual void serverConnected ()
 Emmited when the server is connected. More...
 
virtual void serverDisconnected (int)
 Emmited when the server gets disconnected. More...
 
- Protected Member Functions inherited from INDI::BaseClient
virtual void newUniversalMessage (std::string message)
 newUniversalMessage Universal messages are sent from INDI server without a specific device. It is addressed to the client overall. More...
 

Additional Inherited Members

- Protected Attributes inherited from INDI::BaseClient
std::unique_ptr< INDI::BaseClientPrivated_ptr
 

Detailed Description

Definition at line 32 of file skysafariclient.h.

Member Enumeration Documentation

◆ GotoMode

Enumerator
SLEW 
TRACK 
SYNC 

Definition at line 59 of file skysafariclient.h.

Constructor & Destructor Documentation

◆ SkySafariClient()

SkySafariClient::SkySafariClient ( )

Definition at line 35 of file skysafariclient.cpp.

◆ ~SkySafariClient()

SkySafariClient::~SkySafariClient ( )

Definition at line 43 of file skysafariclient.cpp.

Member Function Documentation

◆ abort()

bool SkySafariClient::abort ( )

Definition at line 167 of file skysafariclient.cpp.

◆ getEquatorialCoords()

INumberVectorProperty* SkySafariClient::getEquatorialCoords ( )
inline

Definition at line 68 of file skysafariclient.h.

◆ getGeographiCoords()

INumberVectorProperty* SkySafariClient::getGeographiCoords ( )
inline

Definition at line 71 of file skysafariclient.h.

◆ getGotoMode()

ISwitchVectorProperty* SkySafariClient::getGotoMode ( )
inline

Definition at line 74 of file skysafariclient.h.

◆ getMotionNS()

ISwitchVectorProperty* SkySafariClient::getMotionNS ( )
inline

Definition at line 77 of file skysafariclient.h.

◆ getMotionWE()

ISwitchVectorProperty* SkySafariClient::getMotionWE ( )
inline

Definition at line 80 of file skysafariclient.h.

◆ getMountParkState()

IPState SkySafariClient::getMountParkState ( )

Definition at line 121 of file skysafariclient.cpp.

◆ getTimeUTC()

ITextVectorProperty* SkySafariClient::getTimeUTC ( )
inline

Definition at line 90 of file skysafariclient.h.

◆ isConnected()

bool SkySafariClient::isConnected ( )
inline

Definition at line 64 of file skysafariclient.h.

◆ newBLOB()

virtual void SkySafariClient::newBLOB ( IBLOB bp)
inlineprotectedvirtual

Emmited when a new BLOB value arrives from INDI server.

Parameters
bpPointer to filled and process BLOB.

Implements INDI::BaseMediator.

Definition at line 98 of file skysafariclient.h.

◆ newDevice()

void SkySafariClient::newDevice ( INDI::BaseDevice dp)
protectedvirtual

Emmited when a new device is created from INDI server.

Parameters
dpPointer to the base device instance

Implements INDI::BaseMediator.

Definition at line 50 of file skysafariclient.cpp.

◆ newLight()

virtual void SkySafariClient::newLight ( ILightVectorProperty lvp)
inlineprotectedvirtual

Emmited when a new light value arrives from INDI server.

Parameters
lvpPointer to a light vector property.

Implements INDI::BaseMediator.

Definition at line 103 of file skysafariclient.h.

◆ newMessage()

virtual void SkySafariClient::newMessage ( INDI::BaseDevice dp,
int  messageID 
)
inlineprotectedvirtual

Emmited when a new message arrives from INDI server.

Parameters
dppointer to the INDI device the message is sent to.
messageIDID of the message that can be used to retrieve the message from the device's messageQueue() function.

Implements INDI::BaseMediator.

Definition at line 101 of file skysafariclient.h.

◆ newNumber()

virtual void SkySafariClient::newNumber ( INumberVectorProperty nvp)
inlineprotectedvirtual

Emmited when a new number value arrives from INDI server.

Parameters
nvpPointer to a number vector property.

Implements INDI::BaseMediator.

Definition at line 100 of file skysafariclient.h.

◆ newProperty()

void SkySafariClient::newProperty ( INDI::Property property)
protectedvirtual

Emmited when a new property is created for an INDI driver.

Parameters
propertyPointer to the Property Container

Implements INDI::BaseMediator.

Definition at line 64 of file skysafariclient.cpp.

◆ newSwitch()

virtual void SkySafariClient::newSwitch ( ISwitchVectorProperty svp)
inlineprotectedvirtual

Emmited when a new switch value arrives from INDI server.

Parameters
svpPointer to a switch vector property.

Implements INDI::BaseMediator.

Definition at line 99 of file skysafariclient.h.

◆ newText()

virtual void SkySafariClient::newText ( ITextVectorProperty tvp)
inlineprotectedvirtual

Emmited when a new text value arrives from INDI server.

Parameters
tvpPointer to a text vector property.

Implements INDI::BaseMediator.

Definition at line 102 of file skysafariclient.h.

◆ parkMount()

bool SkySafariClient::parkMount ( )

Definition at line 98 of file skysafariclient.cpp.

◆ removeDevice()

virtual void SkySafariClient::removeDevice ( INDI::BaseDevice dp)
inlineprotectedvirtual

Emmited when a device is deleted from INDI server.

Parameters
dpPointer to the base device instance.

Implements INDI::BaseMediator.

Definition at line 95 of file skysafariclient.h.

◆ removeProperty()

virtual void SkySafariClient::removeProperty ( INDI::Property property)
inlineprotectedvirtual

Emmited when a property is deleted for an INDI driver.

Parameters
propertyPointer to the Property Container to remove.

Implements INDI::BaseMediator.

Definition at line 97 of file skysafariclient.h.

◆ sendEquatorialCoords()

bool SkySafariClient::sendEquatorialCoords ( )

Definition at line 129 of file skysafariclient.cpp.

◆ sendGeographicCoords()

bool SkySafariClient::sendGeographicCoords ( )

Definition at line 142 of file skysafariclient.cpp.

◆ sendGotoMode()

bool SkySafariClient::sendGotoMode ( )

Definition at line 155 of file skysafariclient.cpp.

◆ serverConnected()

virtual void SkySafariClient::serverConnected ( )
inlineprotectedvirtual

Emmited when the server is connected.

Implements INDI::BaseMediator.

Definition at line 104 of file skysafariclient.h.

◆ serverDisconnected()

virtual void SkySafariClient::serverDisconnected ( int  exit_code)
inlineprotectedvirtual

Emmited when the server gets disconnected.

Parameters
exit_code0 if client was requested to disconnect from server. -1 if connection to server is terminated due to remote server disconnection.

Implements INDI::BaseMediator.

Definition at line 105 of file skysafariclient.h.

◆ setMotionNS()

bool SkySafariClient::setMotionNS ( )

Definition at line 205 of file skysafariclient.cpp.

◆ setMotionWE()

bool SkySafariClient::setMotionWE ( )

Definition at line 218 of file skysafariclient.cpp.

◆ setMount()

void SkySafariClient::setMount ( const std::string &  value)

Definition at line 89 of file skysafariclient.cpp.

◆ setSlewRate()

bool SkySafariClient::setSlewRate ( int  slewRate)

Definition at line 181 of file skysafariclient.cpp.

◆ setTimeUTC()

bool SkySafariClient::setTimeUTC ( )

Definition at line 231 of file skysafariclient.cpp.


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