Namespace to encapsulate INDI client, drivers, and mediator classes. More...

Namespaces
namespace	AlignmentSubsystem
	Namespace to encapsulate the INDI Alignment Subsystem classes. For more information see "INDI Alignment Subsystem" in "Related Pages" accessible via the banner at the top of this page.

namespace	SP
	INDI Standard Properties are common properties standardized across drivers and clients alike.

Classes
class	AbstractBaseClient

class	AbstractBaseClientPrivate

class	BaseClient
	Class to provide basic client functionality. More...

class	BaseClientPrivate

class	BaseClientQt
	Class to provide basic client functionality based on Qt5 toolkit and is therefore suitable for cross-platform development. More...

class	BaseClientQtPrivate

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

class	BaseDevicePrivate

class	BaseMediator
	Meditates event notification as generated by driver and passed to clients. More...

struct	BLOBMode

class	CCD
	Class to provide general functionality of CCD cameras with a single CCD sensor, or a primary CCD sensor in addition to a secondary CCD guide head. More...

class	CCDChip
	The CCDChip class provides functionality of a CCD Chip within a CCD. More...

class	Controller
	The Controller class provides functionality to access a controller (e.g. joystick) input and send it to the requesting driver. More...

class	Correlator
	Class to provide general functionality of Monodimensional Correlator. More...

class	DefaultDevice
	Class to provide extended functionality for devices in addition to the functionality provided by INDI::BaseDevice. This class should only be subclassed by drivers directly as it is linked with main(). Virtual drivers cannot employ INDI::DefaultDevice. More...

class	DefaultDevicePrivate

class	Detector
	Class to provide general functionality of Monodimensional Detector. More...

class	Dome
	Class to provide general functionality of a Dome device. More...

class	DustCapInterface

class	ElapsedTimer
	The ElapsedTimer class provides a fast way to calculate elapsed times. More...

class	ElapsedTimerPrivate

class	EncoderInterface
	The EncoderInterface class is the base class for video streaming encoders. More...

class	EncoderManager
	The EncoderManager class contains a list of active supported encoders. More...

class	FilterInterface

class	FilterWheel

class	FITSRecord

class	Focuser

class	FocuserInterface
	Provides interface to implement focuser functionality. More...

class	FPSMeter

class	GPS

class	GPSInterface
	Provides interface to implement GPS functionality. More...

class	GuiderInterface

class	HotPlugCapableDevice

class	HotPlugManager

struct	IEquatorialCoordinates

struct	IGeographicCoordinates

struct	IHorizontalCoordinates

class	IMU

class	IMUInterface

class	IMUSensorFusion
	Abstract base class for IMU sensor fusion algorithms. More...

class	InputInterface

class	LightBoxInterface

class	LilXmlAttribute

class	LilXmlDocument

class	LilXmlElement

class	LilXmlParser

class	LilXmlValue

class	Logger
	The Logger class is a simple logger to log messages to file and INDI clients. This is the implementation of a simple logger in C++. It is implemented as a Singleton, so it can be easily called through two DEBUG macros. It is Pthread-safe. It allows to log on both file and screen, and to specify a verbosity threshold for both of them. More...

class	MadgwickFilter
	Madgwick AHRS filter (9-DOF and 6-DOF). More...

class	MahonyFilter
	Mahony AHRS filter (9-DOF and 6-DOF). More...

class	MJPEGEncoder
	The MJPEGEncoder class encodes frames in JPEG format before transmitting them to the client. More...

class	OutputInterface

class	PACInterface

class	ParentDevice
	The class is used to create device instances. Class copying is not allowed. When an object is destroyed, the property list (INDI::Property) is cleared to prevent a circular reference along with the properties. The base INDI::BaseDevice class and its INDI::Properties exist as long as they are used by other objects. More...

class	ParentDevicePrivate

class	PowerInterface

class	Properties

class	PropertiesPrivate

class	Property
	Provides generic container for INDI properties. More...

class	PropertyBasic

class	PropertyBasicPrivateTemplate

class	PropertyBlob

class	PropertyBlobPrivate

struct	PropertyContainer

class	PropertyLight

class	PropertyLightPrivate

class	PropertyNumber

class	PropertyNumberPrivate

class	PropertyPrivate

class	PropertySwitch

class	PropertySwitchPrivate

class	PropertyText

class	PropertyTextPrivate

class	PropertyView
	Provides decorator for Low-Level IXXXVectorProperty/IXXX. More...

struct	pulse_t

class	RawEncoder
	The RawEncoder class sends the image as-is (lossless) to the client. More...

class	Receiver
	Class to provide general functionality of Monodimensional Receiver. More...

class	RecorderInterface
	The RecorderInterface class is the base class for recorders. More...

class	RecorderManager
	The RecorderManager class contains a list of active supported recorders. More...

class	Rotator

class	RotatorInterface

class	safe_ptr

class	SensorInterface
	The SensorDevice class provides functionality of a Sensor Device within a Sensor. More...

class	SER_Recorder
	The SER_Recorder class implements recording of video streams in SER format. More...

class	SingleThreadPool

class	SingleThreadPoolPrivate

class	Spectrograph
	Class to provide general functionality of Monodimensional Spectrograph. More...

class	StreamManager

class	StreamManagerPrivate

class	Telescope

class	TheoraRecorder
	The TheoraRecorder class implemented recording of video streaming data in a libtheora OGV file. More...

class	Timer
	The Timer class provides repetitive and single-shot timers. More...

class	TimerPrivate

class	USBDevice

class	V4L2_Base

class	WatchDeviceProperty

class	Weather

class	WeatherInterface
	Provides interface to implement weather reporting and safety monitoring functionality. More...

struct	WidgetTraits

struct	WidgetTraits< IBLOB >

struct	WidgetTraits< ILight >

struct	WidgetTraits< INumber >

struct	WidgetTraits< ISwitch >

struct	WidgetTraits< IText >

struct	WidgetView

struct	WidgetView< IBLOB >

struct	WidgetView< ILight >

struct	WidgetView< INumber >

struct	WidgetView< ISwitch >

struct	WidgetView< IText >

Typedefs
using	WidgetText = INDI::WidgetViewText

using	WidgetNumber = INDI::WidgetViewNumber

using	WidgetSwitch = INDI::WidgetViewSwitch

using	WidgetLight = INDI::WidgetViewLight

using	WidgetBlob = INDI::WidgetViewBlob

typedef PropertyView< IText >	PropertyViewText

typedef PropertyView< INumber >	PropertyViewNumber

typedef PropertyView< ISwitch >	PropertyViewSwitch

typedef PropertyView< ILight >	PropertyViewLight

typedef PropertyView< IBLOB >	PropertyViewBlob

typedef WidgetView< IText >	WidgetViewText

typedef WidgetView< INumber >	WidgetViewNumber

typedef WidgetView< ISwitch >	WidgetViewSwitch

typedef WidgetView< ILight >	WidgetViewLight

typedef WidgetView< IBLOB >	WidgetViewBlob

Functions
std::string	regex_replace_compat (const std::string &input, const std::string &pattern, const std::string &replace)

Logger::loggerConf	operator\| (Logger::loggerConf __a, Logger::loggerConf __b)

Logger::loggerConf	operator& (Logger::loggerConf __a, Logger::loggerConf __b)

std::string	regex_replace_compat2 (const std::string &input, const std::string &pattern, const std::string &replace)

int	mkdir (const char *path, mode_t mode)

int	mkpath (std::string s, mode_t mode)

std::string	format_time (const std::tm &tm, const char *format)

void	replace_all (std::string &subject, const std::string &search, const std::string &replace)

void	ObservedToJ2000 (IEquatorialCoordinates observed, double jd, IEquatorialCoordinates J2000pos)
	ObservedToJ2000 converts an observed position to a J2000 catalogue position removes aberration, nutation and precession.

void	J2000toObserved (IEquatorialCoordinates J2000pos, double jd, IEquatorialCoordinates observed)
	*J2000toObserved converts catalogue to observed

void	ln_get_equ_nut (ln_equ_posn *posn, double jd, bool reverse)
	apply or remove nutation

void	EquatorialToHorizontal (IEquatorialCoordinates object, IGeographicCoordinates observer, double JD, IHorizontalCoordinates *position)
	EquatorialToHorizontal Calculate horizontal coordinates from equatorial coordinates.

void	HorizontalToEquatorial (IHorizontalCoordinates object, IGeographicCoordinates observer, double JD, IEquatorialCoordinates *position)
	HorizontalToEquatorial Calculate Equatorial EOD Coordinates from horizontal coordinates.

std::string	allocateBlobUid (int fd)

void *	attachBlobByUid (const std::string &identifier, size_t size)

void	releaseBlobUids (const std::vector< std::string > &blobs)

	Properties::operator std::vector< INDI::Property * > * ()

	Properties::operator const std::vector< INDI::Property * > * () const

Variables
const int	MAX_INITIAL_POLL = 5

const int	MAX_NON_UDEV_POLL_DURATION_SECONDS = 60

const int	NON_UDEV_POLL_INTERVAL_MS

Detailed Description

Namespace to encapsulate INDI client, drivers, and mediator classes.

This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA

Developers can subclass the base devices class to implement device specific functionality. This ensures interoperability and consistency among devices within the same family and reduces code overhead.

BaseClient: Base class for INDI clients. By subclassing BaseClient, client can easily connect to INDI server and handle device communication, command, and notification.
BaseClientQt: Qt5 based class for INDI clients. By subclassing BaseClientQt, client can easily connect to INDI server and handle device communication, command, and notification.
BaseMediator: Abstract class to provide interface for event notifications in INDI::BaseClient.
BaseDevice: Base class for all INDI virtual devices as handled and stored in INDI::BaseClient. It is also the parent for all drivers.
DefaultDevice: INDI::BaseDevice with extended functionality such as debug, simulation, and configuration support. It is the base class for all drivers and may only used by drivers directly, it cannot be used by clients.
FilterInterface: Basic interface for filter wheels functions.
GuiderInterface: Basic interface for guider (ST4) port functions.
GPSInterface: Basic interface for GPS functions.
RotatorInterface: Basic interface for Rotator functions.
DustCapInterface: Basic interface remotely controlled dust covers.
LightBoxInterface: Basic interface for remotely controlled light boxes/switches.
InputInterface: Basic interface for generic digital & analog inputs.
OutputInterface: Basic interface for generic digital outputs.
PowerInterface: Basic interface for generic power boxes.
CCD: Base class for CCD drivers. Provides basic support for single chip CCD and CCDs with a guide head as well.
Telescope: Base class for telescope drivers.
FilterWheel: Base class for Filter Wheels. It implements the FilterInterface.
Focuser: Base class for focusers.
Rotator: Base class for rotators.
Dome: Base class for domes.
GPS: Base class for GPS devices.
Weather: Base class for Weather devices.
USBDevice: Base class for USB devices for direct read/write/control over USB.
Controller: Class to handle controller inputs like joysticks and gamepads.
Logger: Class to handle debugging and logging of drivers.

Author: Jasem Mutlaq; Gerry Rozema

Typedef Documentation

◆ PropertyViewBlob

typedef PropertyView<IBLOB> INDI::PropertyViewBlob

Definition at line 42 of file indipropertyview.h.

◆ PropertyViewLight

typedef PropertyView<ILight> INDI::PropertyViewLight

Definition at line 41 of file indipropertyview.h.

◆ PropertyViewNumber

typedef PropertyView<INumber> INDI::PropertyViewNumber

Definition at line 39 of file indipropertyview.h.

◆ PropertyViewSwitch

typedef PropertyView<ISwitch> INDI::PropertyViewSwitch

Definition at line 40 of file indipropertyview.h.

◆ PropertyViewText

typedef PropertyView<IText> INDI::PropertyViewText

Definition at line 38 of file indipropertyview.h.

◆ WidgetBlob

using INDI::WidgetBlob = typedef INDI::WidgetViewBlob

Definition at line 32 of file indipropertybasic.h.

◆ WidgetLight

using INDI::WidgetLight = typedef INDI::WidgetViewLight

Definition at line 31 of file indipropertybasic.h.

◆ WidgetNumber

using INDI::WidgetNumber = typedef INDI::WidgetViewNumber

Definition at line 29 of file indipropertybasic.h.

◆ WidgetSwitch

using INDI::WidgetSwitch = typedef INDI::WidgetViewSwitch

Definition at line 30 of file indipropertybasic.h.

◆ WidgetText

using INDI::WidgetText = typedef INDI::WidgetViewText

Definition at line 28 of file indipropertybasic.h.

◆ WidgetViewBlob

typedef WidgetView<IBLOB> INDI::WidgetViewBlob

Definition at line 48 of file indipropertyview.h.

◆ WidgetViewLight

typedef WidgetView<ILight> INDI::WidgetViewLight

Definition at line 47 of file indipropertyview.h.

◆ WidgetViewNumber

typedef WidgetView<INumber> INDI::WidgetViewNumber

Definition at line 45 of file indipropertyview.h.

◆ WidgetViewSwitch

typedef WidgetView<ISwitch> INDI::WidgetViewSwitch

Definition at line 46 of file indipropertyview.h.

◆ WidgetViewText

typedef WidgetView<IText> INDI::WidgetViewText

Definition at line 44 of file indipropertyview.h.

Function Documentation

◆ allocateBlobUid()

std::string INDI::allocateBlobUid ( int fd )

Definition at line 39 of file sharedblob_parse.cpp.

◆ attachBlobByUid()

void * INDI::attachBlobByUid	(	const std::string &	identifier,
		size_t	size
	)

Definition at line 52 of file sharedblob_parse.cpp.

◆ EquatorialToHorizontal()

void INDI::EquatorialToHorizontal	(	IEquatorialCoordinates *	object,
		IGeographicCoordinates *	observer,
		double	JD,
		IHorizontalCoordinates *	position
	)

EquatorialToHorizontal Calculate horizontal coordinates from equatorial coordinates.

Parameters

object	Equatorial Object Coordinates in INDI standaard (RA Hours, DE degrees).
observer	Observer Location in INDI Standard (Longitude 0 to 360 Increasing Eastward)
JD	Julian Date
position	Calculated Horizontal Coordinates.

Note: Use this instead of libnova ln_get_hrz_from_equ since it corrects libnova Azimuth (0 = North and not South).

Definition at line 141 of file libastro.cpp.

◆ format_time()

std::string INDI::format_time	(	const std::tm &	tm,
		const char *	format
	)

Definition at line 89 of file indiutility.cpp.

◆ HorizontalToEquatorial()

void INDI::HorizontalToEquatorial	(	IHorizontalCoordinates *	object,
		IGeographicCoordinates *	observer,
		double	JD,
		IEquatorialCoordinates *	position
	)

HorizontalToEquatorial Calculate Equatorial EOD Coordinates from horizontal coordinates.

Parameters

object	Horizontal Object Coordinates
observer	Observer Location in INDI Standard (Longitude 0 to 360 Increasing Eastward)
JD	Julian Date
position	Calculated Equatorial Coordinates in INDI standards (RA hours, DE degrees).

Note: Use this instead of libnova ln_get_equ_from_hrz since it corrects libnova Azimuth (0 = North and not South).

Definition at line 161 of file libastro.cpp.

◆ J2000toObserved()

void INDI::J2000toObserved	(	IEquatorialCoordinates *	J2000pos,
		double	jd,
		IEquatorialCoordinates *	observed
	)

*J2000toObserved converts catalogue to observed

J2000toObserved converts a J2000 catalogue position to an observed position for the epoch jd applies precession, nutation and aberration.

Parameters

J2000pos	catalogue position
jd	julian day for the observed epoch
observed	returns observed position
J2000pos	J2000 catalogue position
jd	Julian day epoch of observed position
observed	returns observed position for the JD epoch

Definition at line 81 of file libastro.cpp.

◆ ln_get_equ_nut()

void INDI::ln_get_equ_nut	(	ln_equ_posn *	posn,
		double	jd,
		bool	reverse = `false`
	)

apply or remove nutation

ln_get_equ_nut applies or removes nutation in place for the epoch JD

Parameters

posn	position, nutation is applied or removed in place
jd
reverse	set to true to remove nutation

Definition at line 103 of file libastro.cpp.

◆ mkdir()

int INDI::mkdir	(	const char *	path,
		mode_t	mode
	)

Definition at line 41 of file indiutility.cpp.

◆ mkpath()

int INDI::mkpath	(	std::string	s,
		mode_t	mode
	)

Definition at line 51 of file indiutility.cpp.

◆ ObservedToJ2000()

void INDI::ObservedToJ2000	(	IEquatorialCoordinates *	observed,
		double	jd,
		IEquatorialCoordinates *	J2000pos
	)

ObservedToJ2000 converts an observed position to a J2000 catalogue position removes aberration, nutation and precession.

Parameters

observed	position
jd	Julian day epoch of observed position
J2000pos	returns catalogue position

Definition at line 51 of file libastro.cpp.

◆ operator&()

Logger::loggerConf INDI::operator&	(	Logger::loggerConf	__a,
		Logger::loggerConf	__b
	)

inline

Definition at line 291 of file indilogger.h.

◆ operator|()

Logger::loggerConf INDI::operator\|	(	Logger::loggerConf	__a,
		Logger::loggerConf	__b
	)

inline

Definition at line 286 of file indilogger.h.

◆ Properties::operator const std::vector< INDI::Property * > *()

INDI::Properties::operator const std::vector< INDI::Property * > * ( ) const

Definition at line 205 of file indiproperties.cpp.

◆ Properties::operator std::vector< INDI::Property * > *()

INDI::Properties::operator std::vector< INDI::Property * > * ( )

Definition at line 194 of file indiproperties.cpp.

◆ regex_replace_compat()

std::string INDI::regex_replace_compat	(	const std::string &	input,
		const std::string &	pattern,
		const std::string &	replace
	)

Definition at line 3072 of file indiccd.cpp.

◆ regex_replace_compat2()

std::string INDI::regex_replace_compat2	(	const std::string &	input,
		const std::string &	pattern,
		const std::string &	replace
	)

Definition at line 1213 of file indisensorinterface.cpp.

◆ releaseBlobUids()

void INDI::releaseBlobUids ( const std::vector< std::string > & blobs )

Definition at line 69 of file sharedblob_parse.cpp.

◆ replace_all()

void INDI::replace_all	(	std::string &	subject,
		const std::string &	search,
		const std::string &	replace
	)

Definition at line 98 of file indiutility.cpp.

Variable Documentation

◆ MAX_INITIAL_POLL

const int INDI::MAX_INITIAL_POLL = 5

Definition at line 41 of file hotplugmanager.cpp.

◆ MAX_NON_UDEV_POLL_DURATION_SECONDS

const int INDI::MAX_NON_UDEV_POLL_DURATION_SECONDS = 60

Definition at line 42 of file hotplugmanager.cpp.

◆ NON_UDEV_POLL_INTERVAL_MS

const int INDI::NON_UDEV_POLL_INTERVAL_MS

Initial value:

=

1000

Definition at line 43 of file hotplugmanager.cpp.

Namespaces

Classes

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ PropertyViewBlob

◆ PropertyViewLight

◆ PropertyViewNumber

◆ PropertyViewSwitch

◆ PropertyViewText

◆ WidgetBlob

◆ WidgetLight

◆ WidgetNumber

◆ WidgetSwitch

◆ WidgetText

◆ WidgetViewBlob

◆ WidgetViewLight

◆ WidgetViewNumber

◆ WidgetViewSwitch

◆ WidgetViewText

Function Documentation

◆ allocateBlobUid()

◆ attachBlobByUid()

◆ EquatorialToHorizontal()

◆ format_time()

◆ HorizontalToEquatorial()

◆ J2000toObserved()

◆ ln_get_equ_nut()

◆ mkdir()

◆ mkpath()

◆ ObservedToJ2000()

◆ operator&()

◆ operator|()

◆ Properties::operator const std::vector< INDI::Property * > *()

◆ Properties::operator std::vector< INDI::Property * > *()

◆ regex_replace_compat()

◆ regex_replace_compat2()

◆ releaseBlobUids()

◆ replace_all()

Variable Documentation

◆ MAX_INITIAL_POLL

◆ MAX_NON_UDEV_POLL_DURATION_SECONDS

◆ NON_UDEV_POLL_INTERVAL_MS