Functions
IText *	IUFindText (const ITextVectorProperty tvp, const char name)
	Find an IText member in a vector text property. More...

INumber *	IUFindNumber (const INumberVectorProperty nvp, const char name)
	Find an INumber member in a number text property. More...

ISwitch *	IUFindSwitch (const ISwitchVectorProperty svp, const char name)
	Find an ISwitch member in a vector switch property. More...

ILight *	IUFindLight (const ILightVectorProperty lvp, const char name)
	Find an ILight member in a vector Light property. More...

IBLOB *	IUFindBLOB (const IBLOBVectorProperty bvp, const char name)
	Find an IBLOB member in a vector BLOB property. More...

ISwitch *	IUFindOnSwitch (const ISwitchVectorProperty *sp)
	Returns the first ON switch it finds in the vector switch property. More...

int	IUFindIndex (const char needle, char *hay, unsigned int n)
	Returns the index of the string in a string array. More...

int	IUFindOnSwitchIndex (const ISwitchVectorProperty *sp)
	Returns the index of first ON switch it finds in the vector switch property. More...

const char *	IUFindOnSwitchName (ISState states, char names[], int n)
	Returns the name of the first ON switch it finds in the supplied arguments. More...

void	IUResetSwitch (ISwitchVectorProperty *svp)
	Reset all switches in a switch vector property to OFF. More...

int	IUUpdateSwitch (ISwitchVectorProperty svp, ISState states, char *names[], int n)
	Update all switches in a switch vector property. More...

int	IUUpdateNumber (INumberVectorProperty nvp, double values[], char names[], int n)
	Update all numbers in a number vector property. More...

int	IUUpdateText (ITextVectorProperty tvp, char texts[], char *names[], int n)
	Update all text members in a text vector property. More...

int	IUUpdateBLOB (IBLOBVectorProperty bvp, int sizes[], int blobsizes[], char blobs[], char formats[], char names[], int n)
	Update all BLOB members in a BLOB vector property. More...

int	IUSaveBLOB (IBLOB bp, int size, int blobsize, char blob, char *format)
	Function to save blob metadata in the corresponding blob. More...

void	IUUpdateMinMax (const INumberVectorProperty *nvp)
	Function to update the min and max elements of a number in the client. More...

void	IUSaveText (IText tp, const char newtext)
	Function to reliably save new text in a IText. More...

void	IUFillSwitch (ISwitch sp, const char name, const char *label, ISState s)
	Assign attributes for a switch property. More...

void	IUFillLight (ILight lp, const char name, const char *label, IPState s)
	Assign attributes for a light property. More...

void	IUFillNumber (INumber np, const char name, const char label, const char format, double min, double max, double step, double value)
	Assign attributes for a number property. More...

void	IUFillText (IText tp, const char name, const char label, const char initialText)
	Assign attributes for a text property. More...

void	IUFillBLOB (IBLOB bp, const char name, const char label, const char format)
	Assign attributes for a BLOB property. More...

void	IUFillSwitchVector (ISwitchVectorProperty svp, ISwitch sp, int nsp, const char dev, const char name, const char label, const char group, IPerm p, ISRule r, double timeout, IPState s)
	Assign attributes for a switch vector property. More...

void	IUFillLightVector (ILightVectorProperty lvp, ILight lp, int nlp, const char dev, const char name, const char label, const char group, IPState s)
	Assign attributes for a light vector property. More...

void	IUFillNumberVector (INumberVectorProperty nvp, INumber np, int nnp, const char dev, const char name, const char label, const char group, IPerm p, double timeout, IPState s)
	Assign attributes for a number vector property. More...

void	IUFillTextVector (ITextVectorProperty tvp, IText tp, int ntp, const char dev, const char name, const char label, const char group, IPerm p, double timeout, IPState s)
	Assign attributes for a text vector property. More...

void	IUFillBLOBVector (IBLOBVectorProperty bvp, IBLOB bp, int nbp, const char dev, const char name, const char label, const char group, IPerm p, double timeout, IPState s)
	Assign attributes for a BLOB vector property. More...

int	IUSnoopNumber (XMLEle root, INumberVectorProperty nvp)
	Update a snooped number vector property from the given XML root element. More...

int	IUSnoopText (XMLEle root, ITextVectorProperty tvp)
	Update a snooped text vector property from the given XML root element. More...

int	IUSnoopLight (XMLEle root, ILightVectorProperty lvp)
	Update a snooped light vector property from the given XML root element. More...

int	IUSnoopSwitch (XMLEle root, ISwitchVectorProperty svp)
	Update a snooped switch vector property from the given XML root element. More...

int	IUSnoopBLOB (XMLEle root, IBLOBVectorProperty bvp)
	Update a snooped BLOB vector property from the given XML root element. More...

Detailed Description

This section describes handy utility functions that are provided by the framework for tasks commonly required in the processing of client messages. It is not strictly necessary to use these functions, but it both prudent and efficient to do so.

These do not communicate with the Client in any way.

Function Documentation

◆ IUFillBLOB()

void IUFillBLOB	(	IBLOB *	bp,
		const char *	name,
		const char *	label,
		const char *	format
	)

Assign attributes for a BLOB property.

The BLOB's data and auxiliary elements will be set to NULL.

Parameters

bp	pointer a BLOB property to fill
name	the BLOB name
label	the BLOB label
format	the BLOB format.

◆ IUFillBLOBVector()

void IUFillBLOBVector	(	IBLOBVectorProperty *	bvp,
		IBLOB *	bp,
		int	nbp,
		const char *	dev,
		const char *	name,
		const char *	label,
		const char *	group,
		IPerm	p,
		double	timeout,
		IPState	s
	)

Assign attributes for a BLOB vector property.

The vector's auxiliary elements will be set to NULL.

Parameters

bvp	pointer a BLOB vector property to fill
bp	pointer to an array of BLOBs
nbp	the dimension of bp
dev	the device name this vector property belongs to
name	the vector property name
label	the vector property label
group	the vector property group
p	the vector property permission
timeout	vector property timeout in seconds
s	the vector property initial state.

◆ IUFillLight()

void IUFillLight	(	ILight *	lp,
		const char *	name,
		const char *	label,
		IPState	s
	)

Assign attributes for a light property.

The light's auxiliary elements will be set to NULL.

Parameters

lp	pointer a light property to fill
name	the light name
label	the light label
s	the light state (IDLE, WARNING, OK, ALERT)

◆ IUFillLightVector()

void IUFillLightVector	(	ILightVectorProperty *	lvp,
		ILight *	lp,
		int	nlp,
		const char *	dev,
		const char *	name,
		const char *	label,
		const char *	group,
		IPState	s
	)

Assign attributes for a light vector property.

The vector's auxiliary elements will be set to NULL.

Parameters

lvp	pointer a light vector property to fill
lp	pointer to an array of lights
nlp	the dimension of lp
dev	the device name this vector property belongs to
name	the vector property name
label	the vector property label
group	the vector property group
s	the vector property initial state.

◆ IUFillNumber()

void IUFillNumber	(	INumber *	np,
		const char *	name,
		const char *	label,
		const char *	format,
		double	min,
		double	max,
		double	step,
		double	value
	)

Assign attributes for a number property.

The number's auxiliary elements will be set to NULL.

Parameters

np	pointer a number property to fill
name	the number name
label	the number label
format	the number format in printf style (e.g. "%02d")
min	the minimum possible value
max	the maximum possible value
step	the step used to climb from minimum value to maximum value
value	the number's current value

◆ IUFillNumberVector()

void IUFillNumberVector	(	INumberVectorProperty *	nvp,
		INumber *	np,
		int	nnp,
		const char *	dev,
		const char *	name,
		const char *	label,
		const char *	group,
		IPerm	p,
		double	timeout,
		IPState	s
	)

Assign attributes for a number vector property.

The vector's auxiliary elements will be set to NULL.

Parameters

nvp	pointer a number vector property to fill
np	pointer to an array of numbers
nnp	the dimension of np
dev	the device name this vector property belongs to
name	the vector property name
label	the vector property label
group	the vector property group
p	the vector property permission
timeout	vector property timeout in seconds
s	the vector property initial state.

◆ IUFillSwitch()

void IUFillSwitch	(	ISwitch *	sp,
		const char *	name,
		const char *	label,
		ISState	s
	)

Assign attributes for a switch property.

The switch's auxiliary elements will be set to NULL.

Parameters

sp	pointer a switch property to fill
name	the switch name
label	the switch label
s	the switch state (ISS_ON or ISS_OFF)

◆ IUFillSwitchVector()

void IUFillSwitchVector	(	ISwitchVectorProperty *	svp,
		ISwitch *	sp,
		int	nsp,
		const char *	dev,
		const char *	name,
		const char *	label,
		const char *	group,
		IPerm	p,
		ISRule	r,
		double	timeout,
		IPState	s
	)

Assign attributes for a switch vector property.

The vector's auxiliary elements will be set to NULL.

Parameters

svp	pointer a switch vector property to fill
sp	pointer to an array of switches
nsp	the dimension of sp
dev	the device name this vector property belongs to
name	the vector property name
label	the vector property label
group	the vector property group
p	the vector property permission
r	the switches behavior
timeout	vector property timeout in seconds
s	the vector property initial state.

◆ IUFillText()

void IUFillText	(	IText *	tp,
		const char *	name,
		const char *	label,
		const char *	initialText
	)

Assign attributes for a text property.

The text's auxiliary elements will be set to NULL.

Parameters

tp	pointer a text property to fill
name	the text name
label	the text label
initialText	the initial text

◆ IUFillTextVector()

void IUFillTextVector	(	ITextVectorProperty *	tvp,
		IText *	tp,
		int	ntp,
		const char *	dev,
		const char *	name,
		const char *	label,
		const char *	group,
		IPerm	p,
		double	timeout,
		IPState	s
	)

Assign attributes for a text vector property.

The vector's auxiliary elements will be set to NULL.

Parameters

tvp	pointer a text vector property to fill
tp	pointer to an array of texts
ntp	the dimension of tp
dev	the device name this vector property belongs to
name	the vector property name
label	the vector property label
group	the vector property group
p	the vector property permission
timeout	vector property timeout in seconds
s	the vector property initial state.

◆ IUFindBLOB()

IBLOB * IUFindBLOB	(	const IBLOBVectorProperty *	bvp,
		const char *	name
	)

Find an IBLOB member in a vector BLOB property.

Parameters

bvp	a pointer to a BLOB vector property.
name	the name of the member to search for.

Returns: a pointer to an IBLOB member on match, or NULL if nothing is found.

◆ IUFindIndex()

int IUFindIndex	(	const char *	needle,
		char **	hay,
		unsigned int	n
	)

Returns the index of the string in a string array.

Parameters

needle	the string to match against each element in the hay
hay	a pointer to a string array to search in
n	the size of hay

Returns: index of needle if found in the hay. Otherwise -1 if not found.

◆ IUFindLight()

ILight * IUFindLight	(	const ILightVectorProperty *	lvp,
		const char *	name
	)

Find an ILight member in a vector Light property.

Parameters

lvp	a pointer to a Light vector property.
name	the name of the member to search for.

Returns: a pointer to an ILight member on match, or NULL if nothing is found.

◆ IUFindNumber()

INumber * IUFindNumber	(	const INumberVectorProperty *	nvp,
		const char *	name
	)

Find an INumber member in a number text property.

Parameters

nvp	a pointer to a number vector property.
name	the name of the member to search for.

Returns: a pointer to an INumber member on match, or NULL if nothing is found.

◆ IUFindOnSwitch()

ISwitch * IUFindOnSwitch ( const ISwitchVectorProperty * sp )

Returns the first ON switch it finds in the vector switch property.

Note: This is only valid for ISR_1OFMANY mode. That is, when only one switch out of many is allowed to be ON. Do not use this function if you can have multiple ON switches in the same vector property.

Parameters

sp	a pointer to a switch vector property.

Returns: a pointer to the first ON ISwitch member if found. If all switches are off, NULL is returned.

◆ IUFindOnSwitchIndex()

int IUFindOnSwitchIndex ( const ISwitchVectorProperty * sp )

Returns the index of first ON switch it finds in the vector switch property.

Note: This is only valid for ISR_1OFMANY mode. That is, when only one switch out of many is allowed to be ON. Do not use this function if you can have multiple ON switches in the same vector property.

Parameters

sp	a pointer to a switch vector property.

Returns: index to the first ON ISwitch member if found. If all switches are off, -1 is returned.

◆ IUFindOnSwitchName()

const char * IUFindOnSwitchName	(	ISState *	states,
		char *	names[],
		int	n
	)

Returns the name of the first ON switch it finds in the supplied arguments.

Note: This is only valid for ISR_1OFMANY mode. That is, when only one switch out of many is allowed to be ON. Do not use this function if you can have multiple ON switches in the same vector property.; This is a convience function intended to be used in ISNewSwitch(...) function to find out ON switch name without having to change actual switch state via IUUpdateSwitch(..)

Parameters

states	list of switch states passed by ISNewSwitch()
names	list of switch names passed by ISNewSwitch()
n	number of switches passed by ISNewSwitch()

Returns: name of the first ON ISwitch member if found. If all switches are off, NULL is returned.

◆ IUFindSwitch()

ISwitch * IUFindSwitch	(	const ISwitchVectorProperty *	svp,
		const char *	name
	)

Find an ISwitch member in a vector switch property.

Parameters

svp	a pointer to a switch vector property.
name	the name of the member to search for.

Returns: a pointer to an ISwitch member on match, or NULL if nothing is found.

◆ IUFindText()

IText * IUFindText	(	const ITextVectorProperty *	tvp,
		const char *	name
	)

Find an IText member in a vector text property.

Parameters

tvp	a pointer to a text vector property.
name	the name of the member to search for.

Returns: a pointer to an IText member on match, or NULL if nothing is found.

◆ IUResetSwitch()

void IUResetSwitch ( ISwitchVectorProperty * svp )

Reset all switches in a switch vector property to OFF.

Parameters

svp	a pointer to a switch vector property.

◆ IUSaveBLOB()

int IUSaveBLOB	(	IBLOB *	bp,
		int	size,
		int	blobsize,
		char *	blob,
		char *	format
	)

Function to save blob metadata in the corresponding blob.

Parameters

bp	pointer to an IBLOB member.
size	size of the blob buffer encoded in base64
blobsize	actual size of the buffer after base64 decoding. This is the actual byte count used in drivers.
blob	pointer to the blob buffer
format	format of the blob buffer

Note: Do not call this function directly, it is called internally by IUUpdateBLOB.

◆ IUSaveText()

void IUSaveText	(	IText *	tp,
		const char *	newtext
	)

Function to reliably save new text in a IText.

Parameters

tp	pointer to an IText member.
newtext	the new text to be saved

◆ IUSnoopBLOB()

int IUSnoopBLOB	(	XMLEle *	root,
		IBLOBVectorProperty *	bvp
	)

Update a snooped BLOB vector property from the given XML root element.

Parameters

root	XML root elememnt containing the snopped property content
bvp	a pointer to the BLOB vector property to be updated.

Returns: 0 if cracking the XML element and updating the property proceeded without errors, -1 if trouble.

◆ IUSnoopLight()

int IUSnoopLight	(	XMLEle *	root,
		ILightVectorProperty *	lvp
	)

Update a snooped light vector property from the given XML root element.

Parameters

root	XML root elememnt containing the snopped property content
lvp	a pointer to the light vector property to be updated.

Returns: 0 if cracking the XML element and updating the property proceeded without errors, -1 if trouble.

◆ IUSnoopNumber()

int IUSnoopNumber	(	XMLEle *	root,
		INumberVectorProperty *	nvp
	)

Update a snooped number vector property from the given XML root element.

Parameters

root	XML root elememnt containing the snopped property content
nvp	a pointer to the number vector property to be updated.

Returns: 0 if cracking the XML element and updating the property proceeded without errors, -1 if trouble.

◆ IUSnoopSwitch()

int IUSnoopSwitch	(	XMLEle *	root,
		ISwitchVectorProperty *	svp
	)

Update a snooped switch vector property from the given XML root element.

Parameters

root	XML root elememnt containing the snopped property content
svp	a pointer to the switch vector property to be updated.

Returns: 0 if cracking the XML element and updating the property proceeded without errors, -1 if trouble.

◆ IUSnoopText()

int IUSnoopText	(	XMLEle *	root,
		ITextVectorProperty *	tvp
	)

Update a snooped text vector property from the given XML root element.

Parameters

root	XML root elememnt containing the snopped property content
tvp	a pointer to the text vector property to be updated.

Returns: 0 if cracking the XML element and updating the property proceeded without errors, -1 if trouble.

◆ IUUpdateBLOB()

int IUUpdateBLOB	(	IBLOBVectorProperty *	bvp,
		int	sizes[],
		int	blobsizes[],
		char *	blobs[],
		char *	formats[],
		char *	names[],
		int	n
	)

Update all BLOB members in a BLOB vector property.

Parameters

bvp	a pointer to a BLOB vector property.
sizes	sizes of the blobs.
blobsizes	size of the blobs, raw without compression.
blobs	a pointer to the BLOB members
names	the names of the IBLOB members to update.
formats	The blob format or extension.
n	the number of IBLOB members to update.

Returns: 0 if update successful, -1 otherwise. Update will fail in case of property name mismatch.

◆ IUUpdateMinMax()

void IUUpdateMinMax ( const INumberVectorProperty * nvp )

Function to update the min and max elements of a number in the client.

Parameters

nvp	pointer to an INumberVectorProperty.

Warning: This call is not INDI protocol compliant. It sends setNumberVector along with updated Min/Max/Step values so that the client updates the range accordingly for this property. In the INDI-compliant paradigm, it is NOT possible to update min/max/step step of an existing number property and the only way is to do so is to delete and redefine the number property again. However, due to the many problems with approach in device drivers, INDI Library defines this function to simplify the update process without requiring a complete delete/define cycle.

◆ IUUpdateNumber()

int IUUpdateNumber	(	INumberVectorProperty *	nvp,
		double	values[],
		char *	names[],
		int	n
	)

Update all numbers in a number vector property.

Parameters

nvp	a pointer to a number vector property.
values	the states of the new INumber members.
names	the names of the INumber members to update.
n	the number of INumber members to update.

Returns: 0 if update successful, -1 otherwise. Update will fail if values are out of scope, or in case of property name mismatch.

◆ IUUpdateSwitch()

int IUUpdateSwitch	(	ISwitchVectorProperty *	svp,
		ISState *	states,
		char *	names[],
		int	n
	)

Update all switches in a switch vector property.

Parameters

svp	a pointer to a switch vector property.
states	the states of the new ISwitch members.
names	the names of the ISwtich members to update.
n	the number of ISwitch members to update.

Returns: 0 if update successful, -1 otherwise.

◆ IUUpdateText()

int IUUpdateText	(	ITextVectorProperty *	tvp,
		char *	texts[],
		char *	names[],
		int	n
	)

Update all text members in a text vector property.

Parameters

tvp	a pointer to a text vector property.
texts	a pointer to the text members
names	the names of the IText members to update.
n	the number of IText members to update.

Returns: 0 if update successful, -1 otherwise. Update will fail in case of property name mismatch.

Functions

Detailed Description

Function Documentation

◆ IUFillBLOB()

◆ IUFillBLOBVector()

◆ IUFillLight()

◆ IUFillLightVector()

◆ IUFillNumber()

◆ IUFillNumberVector()

◆ IUFillSwitch()

◆ IUFillSwitchVector()

◆ IUFillText()

◆ IUFillTextVector()

◆ IUFindBLOB()

◆ IUFindIndex()

◆ IUFindLight()

◆ IUFindNumber()

◆ IUFindOnSwitch()

◆ IUFindOnSwitchIndex()

◆ IUFindOnSwitchName()

◆ IUFindSwitch()

◆ IUFindText()

◆ IUResetSwitch()

◆ IUSaveBLOB()

◆ IUSaveText()

◆ IUSnoopBLOB()

◆ IUSnoopLight()

◆ IUSnoopNumber()

◆ IUSnoopSwitch()

◆ IUSnoopText()

◆ IUUpdateBLOB()

◆ IUUpdateMinMax()

◆ IUUpdateNumber()

◆ IUUpdateSwitch()

◆ IUUpdateText()