describePntAddr

describePntAddr — describes a point's address.

Synopsis

       
(describePntAddr point_name)
	

Parameters

point_name
The name of an existing point.

Returns

If successful, the complete decoded internal point address is returned in the following format:

(describePntAddr point_name attribute...)

where each attribute is one of the following:

(Card card_id)
(Buffer buffer)
(Device device)*
(Offset offset)
(Bit bit)
(BitWidth bit_width)
(Endian size_bytes SWAP|MIRROR)*
(Signed)*

The attributes are described in detail in Section 2.1.2.1, “Points”. Attributes marked with an * are only listed if applicable to the point.

If the point is not defined, then the following is returned:

(error error_string)

Description

This command requests a description of the address of the named point. The address returned is not the ASCII address provided to create the point, but the decoded and mapped address values. This information can be used to assess the named point directly from the buffers.

This command is typically sent as a command and not used in configuration file.

Examples

  1. The command:
    (describePntAddr volumeRight)
    returns:
    (describePntAddr volumeRight (Card 0) (Buffer 1) (Offset 0) (Bit 1) (BitWidth 16))
    This means that volumeRight is an analog (2-byte) point mapped to the first word in the read buffer.
  2. The command:
    (describePntAddr pushbutton)
    returns:
    (describePntAddr pushbutton (Card 0) (Buffer 1) (Offset 2) (Bit 6) (BitWidth 1))
    This means that pushbutton is a 1-bit digital input point mapped to the 6th bit of the 3rd word in the buffer.