indiapi.h File Reference

Constants and Data structure definitions for the interface to the reference INDI C API implementation. More...

Go to the source code of this file.

Classes
struct	IText
	One text descriptor. More...
struct	_ITextVectorProperty
	Text vector property descriptor. More...
struct	INumber
	One number descriptor. More...
struct	_INumberVectorProperty
	Number vector property descriptor. More...
struct	ISwitch
	One switch descriptor. More...
struct	_ISwitchVectorProperty
	Switch vector property descriptor. More...
struct	ILight
	One light descriptor. More...
struct	_ILightVectorProperty
	Light vector property descriptor. More...
struct	IBLOB
	One Blob (Binary Large Object) descriptor. More...
struct	_IBLOBVectorProperty
	BLOB (Binary Large Object) vector property descriptor. More...

Macros
#define	INDIV   1.7
#define	INDI_VERSION_MAJOR   1
#define	INDI_VERSION_MINOR   5
#define	INDI_VERSION_RELEASE   0
#define	MAXINDINAME   64
#define	MAXINDILABEL   64
#define	MAXINDIDEVICE   64
#define	MAXINDIGROUP   64
#define	MAXINDIFORMAT   64
#define	MAXINDIBLOBFMT   64
#define	MAXINDITSTAMP   64
#define	MAXINDIMESSAGE   255
#define	NARRAY(a)   (sizeof(a) / sizeof(a[0]))
	Handy macro to find the number of elements in array a[]. Must be used with actual array, not pointer. More...

Typedefs
typedef struct _ITextVectorProperty	ITextVectorProperty
typedef struct _INumberVectorProperty	INumberVectorProperty
typedef struct _ISwitchVectorProperty	ISwitchVectorProperty
typedef struct _ILightVectorProperty	ILightVectorProperty
typedef struct _IBLOBVectorProperty	IBLOBVectorProperty

Enumerations

Detailed Description

Constants and Data structure definitions for the interface to the reference INDI C API implementation.

Author

Elwood C. Downey

Definition in file indiapi.h.

Macro Definition Documentation

#define INDI_VERSION_MAJOR   1

Definition at line 122 of file indiapi.h.

#define INDI_VERSION_MINOR   5

Definition at line 123 of file indiapi.h.

#define INDI_VERSION_RELEASE   0

Definition at line 124 of file indiapi.h.

#define INDIV   1.7

Definition at line 119 of file indiapi.h.

#define MAXINDIBLOBFMT   64

Definition at line 177 of file indiapi.h.

#define MAXINDIDEVICE   64

Definition at line 174 of file indiapi.h.

#define MAXINDIFORMAT   64

Definition at line 176 of file indiapi.h.

#define MAXINDIGROUP   64

Definition at line 175 of file indiapi.h.

#define MAXINDILABEL   64

Definition at line 173 of file indiapi.h.

#define MAXINDIMESSAGE   255

Definition at line 179 of file indiapi.h.

#define MAXINDINAME   64

Definition at line 172 of file indiapi.h.

#define MAXINDITSTAMP   64

Definition at line 178 of file indiapi.h.

#define NARRAY

(

a

)

(sizeof(a) / sizeof(a[0]))

Handy macro to find the number of elements in array a[]. Must be used with actual array, not pointer.

Definition at line 481 of file indiapi.h.

Typedef Documentation

typedef struct _IBLOBVectorProperty IBLOBVectorProperty

typedef struct _ILightVectorProperty ILightVectorProperty

typedef struct _INumberVectorProperty INumberVectorProperty

typedef struct _ISwitchVectorProperty ISwitchVectorProperty

typedef struct _ITextVectorProperty ITextVectorProperty

Enumeration Type Documentation

enum IPerm

Permission hint, with respect to client.

Enumerator
IP_RO	Read Only
IP_WO	Write Only
IP_RW	Read & Write

Definition at line 164 of file indiapi.h.

enum IPState

Property state.

Enumerator
IPS_IDLE	State is idle
IPS_OK	State is ok
IPS_BUSY	State is busy
IPS_ALERT	State is alert

Examples:

simpleskeleton.cpp.

Definition at line 143 of file indiapi.h.

enum ISRule

Switch vector rule hint.

Enumerator
ISR_1OFMANY	Only 1 switch of many can be ON (e.g. radio buttons)
ISR_ATMOST1	At most one switch can be ON, but all switches can be off. It is similar to ISR_1OFMANY with the exception that all switches can be off.
ISR_NOFMANY	Any number of switches can be ON (e.g. check boxes)

Definition at line 154 of file indiapi.h.

enum ISState

Switch state.

Enumerator
ISS_OFF	Switch is OFF
ISS_ON	Switch is ON

Definition at line 134 of file indiapi.h.