IDDef Functions: Functions drivers call to define their properties to clients.

More...

Functions
void	IDDefText (const ITextVectorProperty *t, const char *msg,...)
	Tell client to create a text vector property. More...
void	IDDefNumber (const INumberVectorProperty *n, const char *msg,...)
	Tell client to create a number number property. More...
void	IDDefSwitch (const ISwitchVectorProperty *s, const char *msg,...)
	Tell client to create a switch vector property. More...
void	IDDefLight (const ILightVectorProperty *l, const char *msg,...)
	Tell client to create a light vector property. More...
void	IDDefBLOB (const IBLOBVectorProperty *b, const char *msg,...)
	Tell client to create a BLOB vector property. More...

Detailed Description

Each of the following functions creates the appropriate XML formatted INDI message from its arguments and writes it to stdout. From there, is it typically read by indiserver which then sends it to the clients that have expressed interest in messages from the Device indicated in the message.

In addition to type-specific arguments, all end with a printf-style format string, and appropriate subsequent arguments, that form the

Parameters

msg	attribute within the INDI message. If the format argument is NULL, no message attribute is included with the message. Note that a timestamp attribute is also always added automatically based on the clock on the computer on which this driver is running.

Function Documentation

IDDefBLOB()

void IDDefBLOB	(	const IBLOBVectorProperty *	b,
		const char *	msg,
			...
	)

Tell client to create a BLOB vector property.

Parameters

b	pointer to the vector BLOB property to be defined.
msg	message in printf style to send to the client. May be NULL.

IDDefLight()

void IDDefLight	(	const ILightVectorProperty *	l,
		const char *	msg,
			...
	)

Tell client to create a light vector property.

Parameters

l	pointer to the vector light property to be defined.
msg	message in printf style to send to the client. May be NULL.

IDDefNumber()

void IDDefNumber	(	const INumberVectorProperty *	n,
		const char *	msg,
			...
	)

Tell client to create a number number property.

Parameters

n	pointer to the vector number property to be defined.
msg	message in printf style to send to the client. May be NULL.

IDDefSwitch()

void IDDefSwitch	(	const ISwitchVectorProperty *	s,
		const char *	msg,
			...
	)

Tell client to create a switch vector property.

Parameters

s	pointer to the vector switch property to be defined.
msg	message in printf style to send to the client. May be NULL.

IDDefText()

void IDDefText	(	const ITextVectorProperty *	t,
		const char *	msg,
			...
	)

Tell client to create a text vector property.

Parameters

t	pointer to the vector text property to be defined.
msg	message in printf style to send to the client. May be NULL.