Cogent SST-DVN Driver for SST DeviceNet Cards : Version 5.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

Within each byte (card), each bit indicates the following information (see dvn_api.h):

Bit	Value	Meaning
0	`0x01 DVN_STATUS_CAN_OFFLINE`	CAN bus offline.
1	`0x02 DVN_STATUS_CAN_BUSERROR`	CAN bus error.
2	`0x04 DVN_STATUS_CAN_IDLE`	CAN bus scan inactive.
3	`0x08 DVN_STATUS_IO_ERROR`	IO exchange error.
4	`0x10 DVN_STATUS_Q_FAULT`	Event queue overflow.
5	`0x20 DVN_STATUS_SCANNER_IDLE`	Scanner not active.
6	`0x40 DVN_STATUS_DEV_FAULT`	At least one device not scanned.
7	`0x80`	Reserved.

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