Cogent SST-PFB Driver for SST Profibus 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 pfb_api.h):

Bit	Value	Meaning
0	`0x01 PFB_STATUS_MASTER_RUN_MODE`	Master is scanning I/O (RUN Mode)
1	`0x02 PFB_STATUS_MASTER_SCANNING_OK`	No errors while scanning configured I/O
2	`0x04 PFB_STATUS_SLAVE_RUN_MODE`	Slave being scanned (RUN mode)
3	`0x08 PFB_STATUS_SLAVE_OK`	Slave status: No errors
4	`0x10`	reserved
5	`0x20`	reserved
6	`0x40`	reserved
7	`0x80 PFB_STATUS_OK`	Card status: No errors

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