Instrument Neutral Distributed Interface INDI  2.0.0
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
INDI::BaseDevice Class Reference

Class to provide basic INDI device functionality. More...

#include <basedevice.h>

Inheritance diagram for INDI::BaseDevice:
INDI::ParentDevice INDI::DefaultDevice ArduinoST4 AstrometryDriver DeepSkyDadFP1 DeltaT Dome Excalibur FlipFlat GIOTTO GPUSB INDI::CCD INDI::Dome INDI::FilterWheel INDI::Focuser INDI::GPS INDI::Rotator INDI::SensorInterface INDI::Telescope INDI::Weather Imager JoyStick LPM LightPanelSimulator PegasusFlatMaster PegasusPPB PegasusPPBA PegasusUCH PegasusUPB RainDetector SQM SQMSimulator STAR2000 ShelyakDriver SimpleDevice SimpleSkeleton SkySafari SnapCap USBDewpoint WandererCover WatchDog WeatherMeta

Public Types

enum  INDI_ERROR { INDI_DEVICE_NOT_FOUND = -1 , INDI_PROPERTY_INVALID = -2 , INDI_PROPERTY_DUPLICATED = -3 , INDI_DISPATCH_ERROR = -4 }
 
enum  { INDI_ENABLED , INDI_DISABLED }
 
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) , CORRELATOR_INTERFACE = (1 << 14) ,
  AUX_INTERFACE = (1 << 15) , SENSOR_INTERFACE = SPECTROGRAPH_INTERFACE | DETECTOR_INTERFACE | CORRELATOR_INTERFACE
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces. More...
 
typedef INDI::Properties Properties
 

Public Member Functions

 BaseDevice ()
 
virtual ~BaseDevice ()
 
void registerProperty (const INDI::Property &property)
 Register the property to be able to observe and update. More...
 
void registerProperty (const INDI::Property &property, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void watchProperty (const char *name, const std::function< void(INDI::Property)> &callback)
 Call the callback function if property is available. More...
 
Property getProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
Properties getProperties ()
 Return a list of all properties in the device. More...
 
const Properties getProperties () const
 
INDI::PropertyNumber getNumber (const char *name) const
 
INDI::PropertyText getText (const char *name) const
 
INDI::PropertySwitch getSwitch (const char *name) const
 
INDI::PropertyLight getLight (const char *name) const
 
INDI::PropertyBlob getBLOB (const char *name) const
 
IPState getPropertyState (const char *name) const
 
IPerm getPropertyPermission (const char *name) const
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN) const
 Return a property and its type given its name. More...
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
const std::string & messageQueue (size_t index) const
 
const std::string & lastMessage () const
 
bool isValid () const
 
bool isConnected () const
 
void attach ()
 indicates that the device is ready More...
 
void detach ()
 indicates that the device is being removed More...
 
void setMediator (INDI::BaseMediator *mediator)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator () const
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName () const
 
bool isDeviceNameMatch (const char *otherName) const
 Check that the device name matches the argument. More...
 
bool isDeviceNameMatch (const std::string &otherName) const
 Check that the device name matches the argument. More...
 
const char * getDriverName () const
 
const char * getDriverExec () const
 
const char * getDriverVersion () const
 
uint16_t getDriverInterface () const
 getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
int buildProp (const INDI::LilXmlElement &root, char *errmsg, bool isDynamic=false)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (const INDI::LilXmlElement &root, char *errmsg)
 handle SetXXX commands from client More...
 
 operator BaseDevice * ()
 
BaseDeviceoperator-> ()
 
bool operator!= (std::nullptr_t) const
 
bool operator== (std::nullptr_t) const
 
 operator bool () const
 
 operator bool ()
 

Static Public Member Functions

static std::string getSharedFilePath (std::string fileName)
 

Protected Member Functions

BaseDeviceoperator& ()
 
 BaseDevice (BaseDevicePrivate &dd)
 
 BaseDevice (const std::shared_ptr< BaseDevicePrivate > &dd)
 

Protected Attributes

std::shared_ptr< BaseDevicePrivated_ptr
 

Friends

class AbstractBaseClientPrivate
 

Detailed Description

Class to provide basic INDI device functionality.

INDI::BaseDevice is the base device for all INDI devices and contains a list of all properties defined by the device either explicity or via a skeleton file. You don't need to subclass INDI::BaseDevice class directly, it is inheritied by INDI::DefaultDevice which takes care of building a standard INDI device. Moreover, INDI::BaseClient maintains a list of INDI::BaseDevice objects as they get defined from the INDI server, and those objects may be accessed to retrieve information on the object properties or message log.

Author
Jasem Mutlaq
Examples
dome.cpp, tutorial_client.cpp, and tutorial_client.h.

Definition at line 51 of file basedevice.h.

Member Typedef Documentation

◆ Properties

Definition at line 55 of file basedevice.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Used for switch Enabled/Disabled or On/Off type properties

Enumerator
INDI_ENABLED 
INDI_DISABLED 

Definition at line 68 of file basedevice.h.

◆ DRIVER_INTERFACE

The DRIVER_INTERFACE enum defines the class of devices the driver implements. A driver may implement one or more interfaces.

Enumerator
GENERAL_INTERFACE 

Default interface for all INDI devices

TELESCOPE_INTERFACE 

Telescope interface, must subclass INDI::Telescope

CCD_INTERFACE 

CCD interface, must subclass INDI::CCD

GUIDER_INTERFACE 

Guider interface, must subclass INDI::GuiderInterface

FOCUSER_INTERFACE 

Focuser interface, must subclass INDI::FocuserInterface

FILTER_INTERFACE 

Filter interface, must subclass INDI::FilterInterface

DOME_INTERFACE 

Dome interface, must subclass INDI::Dome

GPS_INTERFACE 

GPS interface, must subclass INDI::GPS

WEATHER_INTERFACE 

Weather interface, must subclass INDI::Weather

AO_INTERFACE 

Adaptive Optics Interface

DUSTCAP_INTERFACE 

Dust Cap Interface

LIGHTBOX_INTERFACE 

Light Box Interface

DETECTOR_INTERFACE 

Detector interface, must subclass INDI::Detector

ROTATOR_INTERFACE 

Rotator interface, must subclass INDI::RotatorInterface

SPECTROGRAPH_INTERFACE 

Spectrograph interface

CORRELATOR_INTERFACE 

Correlators (interferometers) interface

AUX_INTERFACE 

Auxiliary interface

SENSOR_INTERFACE 

Definition at line 75 of file basedevice.h.

◆ INDI_ERROR

INDI error codes.

Enumerator
INDI_DEVICE_NOT_FOUND 

INDI Device was not found.

INDI_PROPERTY_INVALID 

Property has an invalid syntax or attribute.

INDI_PROPERTY_DUPLICATED 

INDI Device was not found.

INDI_DISPATCH_ERROR 

Dispatching command to driver failed.

Definition at line 59 of file basedevice.h.

Constructor & Destructor Documentation

◆ BaseDevice() [1/3]

INDI::BaseDevice::BaseDevice ( )

Definition at line 74 of file basedevice.cpp.

◆ ~BaseDevice()

INDI::BaseDevice::~BaseDevice ( )
virtual

Definition at line 78 of file basedevice.cpp.

◆ BaseDevice() [2/3]

INDI::BaseDevice::BaseDevice ( BaseDevicePrivate dd)
protected

Definition at line 81 of file basedevice.cpp.

◆ BaseDevice() [3/3]

INDI::BaseDevice::BaseDevice ( const std::shared_ptr< BaseDevicePrivate > &  dd)
protected

Definition at line 85 of file basedevice.cpp.

Member Function Documentation

◆ addMessage()

void INDI::BaseDevice::addMessage ( const std::string &  msg)

Add message to the driver's message queue.

Parameters
msgMessage to add.

Definition at line 878 of file basedevice.cpp.

◆ attach()

void INDI::BaseDevice::attach ( )

indicates that the device is ready

Note
the BaseMediator::newDevice method will be called

Definition at line 531 of file basedevice.cpp.

◆ buildProp()

int INDI::BaseDevice::buildProp ( const INDI::LilXmlElement root,
char *  errmsg,
bool  isDynamic = false 
)

Build a property given the supplied XML element (defXXX)

Parameters
rootXML element to parse and build.
errmsgbuffer to store error message in parsing fails.
isDynamicset to true if property is loaded from an XML file.
Returns
0 if parsing is successful, -1 otherwise and errmsg is set

Definition at line 324 of file basedevice.cpp.

◆ buildSkeleton()

bool INDI::BaseDevice::buildSkeleton ( const char *  filename)

Build driver properties from a skeleton file.

Parameters
filenamefull path name of the file.
Returns
true if successful, false otherwise.

A skeloton file defines the properties supported by this driver. It is a list of defXXX elements enclosed by <INDIDriver>@ and </INDIDriver>@ opening and closing tags. After the properties are created, they can be rerieved, manipulated, and defined to other clients.

See also
An example skeleton file can be found under examples/tutorial_four_sk.xml
Examples
simpleskeleton.cpp.

Definition at line 302 of file basedevice.cpp.

◆ checkMessage()

void INDI::BaseDevice::checkMessage ( XMLEle root)

Definition at line 842 of file basedevice.cpp.

◆ detach()

void INDI::BaseDevice::detach ( )

indicates that the device is being removed

Note
the BaseMediator::removeDevice method will be called

Definition at line 537 of file basedevice.cpp.

◆ doMessage()

void INDI::BaseDevice::doMessage ( XMLEle msg)

Definition at line 852 of file basedevice.cpp.

◆ getBLOB()

INDI::PropertyBlob INDI::BaseDevice::getBLOB ( const char *  name) const
Returns
Return vector BLOB property given its name
Examples
simpleskeleton.cpp.

Definition at line 109 of file basedevice.cpp.

◆ getDeviceName()

const char * INDI::BaseDevice::getDeviceName ( ) const
Returns
Returns the device name
Examples
dome.cpp, simpleccd.cpp, and simpledevice.cpp.

Definition at line 821 of file basedevice.cpp.

◆ getDriverExec()

const char * INDI::BaseDevice::getDriverExec ( ) const
Returns
driver executable name
Note
This can only be valid if DRIVER_INFO is defined by the driver.

Definition at line 944 of file basedevice.cpp.

◆ getDriverInterface()

uint16_t INDI::BaseDevice::getDriverInterface ( ) const

getDriverInterface returns ORed values of DRIVER_INTERFACE. It presents the device classes supported by the driver.

Returns
driver device interface descriptor.
Note
For example, to know if the driver supports CCD interface, check the retruned value:
if (device.getDriverInterface() & CCD_INTERFACE)
cout << "We received a camera!" << endl;
hid_device * device

Definition at line 956 of file basedevice.cpp.

◆ getDriverName()

const char * INDI::BaseDevice::getDriverName ( ) const
Returns
driver name
Note
This can only be valid if DRIVER_INFO is defined by the driver.

Definition at line 937 of file basedevice.cpp.

◆ getDriverVersion()

const char * INDI::BaseDevice::getDriverVersion ( ) const
Returns
driver version
Note
This can only be valid if DRIVER_INFO is defined by the driver.

Definition at line 950 of file basedevice.cpp.

◆ getLight()

INDI::PropertyLight INDI::BaseDevice::getLight ( const char *  name) const
Returns
Return vector light property given its name
Examples
simpleskeleton.cpp.

Definition at line 104 of file basedevice.cpp.

◆ getMediator()

INDI::BaseMediator * INDI::BaseDevice::getMediator ( ) const
Returns
Get the meditator assigned to this driver

Definition at line 968 of file basedevice.cpp.

◆ getNumber()

INDI::PropertyNumber INDI::BaseDevice::getNumber ( const char *  name) const
Returns
Return vector number property given its name
Examples
simpleskeleton.cpp.

Definition at line 89 of file basedevice.cpp.

◆ getProperties() [1/2]

BaseDevice::Properties INDI::BaseDevice::getProperties ( )

Return a list of all properties in the device.

Examples
simpleskeleton.cpp.

Definition at line 158 of file basedevice.cpp.

◆ getProperties() [2/2]

const BaseDevice::Properties INDI::BaseDevice::getProperties ( ) const

Definition at line 164 of file basedevice.cpp.

◆ getProperty()

INDI::Property INDI::BaseDevice::getProperty ( const char *  name,
INDI_PROPERTY_TYPE  type = INDI_UNKNOWN 
) const

Return a property and its type given its name.

Parameters
nameof property to be found.
typeof property found.
Returns
If property is found, it is returned. To be used you must use static_cast with given the type of property returned.
Examples
tutorial_client.cpp.

Definition at line 138 of file basedevice.cpp.

◆ getPropertyPermission()

IPerm INDI::BaseDevice::getPropertyPermission ( const char *  name) const
Returns
Return property permission

Definition at line 123 of file basedevice.cpp.

◆ getPropertyState()

IPState INDI::BaseDevice::getPropertyState ( const char *  name) const
Returns
Return property state

Definition at line 114 of file basedevice.cpp.

◆ getRawProperty()

void * INDI::BaseDevice::getRawProperty ( const char *  name,
INDI_PROPERTY_TYPE  type = INDI_UNKNOWN 
) const

Return a property and its type given its name.

Parameters
nameof property to be found.
typeof property found.
Returns
If property is found, the raw void * pointer to the IXXXVectorProperty is returned. To be used you must use static_cast with given the type of property returned. For example, INumberVectorProperty *num = static_cast<INumberVectorProperty> getRawProperty("FOO", INDI_NUMBER);
Note
This is a low-level function and should not be called directly unless necessary. Use getXXX instead where XXX is the property type (Number, Text, Switch..etc).

Definition at line 132 of file basedevice.cpp.

◆ getSharedFilePath()

std::string INDI::BaseDevice::getSharedFilePath ( std::string  fileName)
static

Definition at line 213 of file basedevice.cpp.

◆ getSwitch()

INDI::PropertySwitch INDI::BaseDevice::getSwitch ( const char *  name) const
Returns
Return vector switch property given its name
Examples
simpleskeleton.cpp.

Definition at line 99 of file basedevice.cpp.

◆ getText()

INDI::PropertyText INDI::BaseDevice::getText ( const char *  name) const
Returns
Return vector text property given its name

Definition at line 94 of file basedevice.cpp.

◆ isConnected()

bool INDI::BaseDevice::isConnected ( ) const
Returns
True if the device is connected (CONNECT=ON), False otherwise
Examples
dome.cpp, simpleccd.cpp, simpleskeleton.cpp, and tutorial_client.cpp.

Definition at line 520 of file basedevice.cpp.

◆ isDeviceNameMatch() [1/2]

bool INDI::BaseDevice::isDeviceNameMatch ( const char *  otherName) const

Check that the device name matches the argument.

Examples
tutorial_client.cpp.

Definition at line 827 of file basedevice.cpp.

◆ isDeviceNameMatch() [2/2]

bool INDI::BaseDevice::isDeviceNameMatch ( const std::string &  otherName) const

Check that the device name matches the argument.

Definition at line 833 of file basedevice.cpp.

◆ isValid()

bool INDI::BaseDevice::isValid ( ) const
Returns
True if the device exists

Definition at line 904 of file basedevice.cpp.

◆ lastMessage()

const std::string & INDI::BaseDevice::lastMessage ( ) const
Returns
Returns last message message.

Definition at line 896 of file basedevice.cpp.

◆ messageQueue()

const std::string & INDI::BaseDevice::messageQueue ( size_t  index) const
Returns
Returns a specific message.
Examples
tutorial_client.cpp.

Definition at line 888 of file basedevice.cpp.

◆ operator BaseDevice *()

INDI::BaseDevice::operator BaseDevice * ( )

Definition at line 980 of file basedevice.cpp.

◆ operator bool() [1/2]

INDI::BaseDevice::operator bool ( )
inline

Definition at line 290 of file basedevice.h.

◆ operator bool() [2/2]

INDI::BaseDevice::operator bool ( ) const
inline

Definition at line 286 of file basedevice.h.

◆ operator!=()

bool INDI::BaseDevice::operator!= ( std::nullptr_t  ) const
inline

Definition at line 275 of file basedevice.h.

◆ operator&()

BaseDevice* INDI::BaseDevice::operator& ( )
inlineprotected

Definition at line 296 of file basedevice.h.

◆ operator->()

BaseDevice * INDI::BaseDevice::operator-> ( )

Definition at line 974 of file basedevice.cpp.

◆ operator==()

bool INDI::BaseDevice::operator== ( std::nullptr_t  ) const
inline

Definition at line 281 of file basedevice.h.

◆ registerProperty() [1/2]

void INDI::BaseDevice::registerProperty ( const INDI::Property property)

Register the property to be able to observe and update.

Parameters
propertyany property from the INDI::PropertyXXX family.

Definition at line 916 of file basedevice.cpp.

◆ registerProperty() [2/2]

void INDI::BaseDevice::registerProperty ( const INDI::Property property,
INDI_PROPERTY_TYPE  type 
)

Definition at line 932 of file basedevice.cpp.

◆ removeProperty()

int INDI::BaseDevice::removeProperty ( const char *  name,
char *  errmsg 
)

Remove a property.

Parameters
namename of property to be removed. Pass NULL to remove the whole device.
errmsgbuffer to store error message.
Returns
0 if successul, -1 otherwise.

Definition at line 170 of file basedevice.cpp.

◆ setDeviceName()

void INDI::BaseDevice::setDeviceName ( const char *  dev)

Set the device name.

Parameters
devnew device name

Definition at line 815 of file basedevice.cpp.

◆ setMediator()

void INDI::BaseDevice::setMediator ( INDI::BaseMediator mediator)

Set the driver's mediator to receive notification of news devices and updated property values.

Definition at line 962 of file basedevice.cpp.

◆ setValue()

int INDI::BaseDevice::setValue ( const INDI::LilXmlElement root,
char *  errmsg 
)

handle SetXXX commands from client

Definition at line 567 of file basedevice.cpp.

◆ watchProperty()

void INDI::BaseDevice::watchProperty ( const char *  name,
const std::function< void(INDI::Property)> &  callback 
)

Call the callback function if property is available.

Parameters
nameof property.
callbackas an argument of the function you can use INDI::PropertyNumber, INDI::PropertySwitch etc.

Definition at line 910 of file basedevice.cpp.

Friends And Related Function Documentation

◆ AbstractBaseClientPrivate

friend class AbstractBaseClientPrivate
friend

Definition at line 301 of file basedevice.h.

Member Data Documentation

◆ d_ptr

std::shared_ptr<BaseDevicePrivate> INDI::BaseDevice::d_ptr
protected

Definition at line 302 of file basedevice.h.


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