Cogent CIF Driver for Hilscher Fieldbus CIF Cards : Version 6.4
	Command Reference

`statusPointDefine`

statusPointDefine — names a driver status point.

Synopsis

       
(statusPointDefine [point_name])

Parameters

point_name: The name of the status point created. The default is task_name/status.

Returns

OK or (error)

Description

This command names a special point that the driver publishes to the Cascade DataHub containing the overall status of the driver. Clients may monitor this point to determine the overall health of the driver. A value of 0 indicates no errors are being detected.

The status point is a 32-bit integer, segmented as 1 byte for each of the cards that have been initialized (up to 4, see cardInit). Card 0 corresponds to the low byte; card 3 to the high byte.

card3	card2	card1	card0
high byte			low byte

Bit	Value	Meaning
0	`0x01 CIF_STATUS_NOTREADY`	Power-up initialization unsuccessful.
1	`0x02 CIF_STATUS_NOTRUNNING`	Card not fully operational.
2	`0x04 CIF_STATUS_NOCOMM`	Fieldbus exchange inactive/error.
3	`0x08 CIF_STATUS_ERROR`	Error detected.
4	none	none
5	none	none
6	none	none
7	none	none

If this command is specified more than once, the name of the status point will be the one provided by the last command. Previous status point names will not be deleted from the datahub, but they will not be updated when the status data changes.

Example

(statusPointDefine drv_status)


segmentDescribe		statusPointValue