fwPeriphAddress.ctl File Reference

Functions

Basic Functions



 fwPeriphAddress_get (string dpe, bool &configExists, dyn_anytype &config, bool &isActive, dyn_string &exceptionInfo)
 Get the address config of a datapoint element.
 fwPeriphAddress_getMany (dyn_string &dpes, dyn_bool &configExists, dyn_dyn_anytype &config, dyn_bool &isActive, dyn_string &exceptionInfo)
 Get the address config of a datapoint element.
 fwPeriphAddress_set (string dpe, dyn_anytype configParameters, dyn_string &exceptionInfo, bool runDriverCheck=FALSE)
 Set the address config for a given data point element.
 fwPeriphAddress_setMany (dyn_string &dpes, dyn_dyn_anytype &configParameters, dyn_string &exceptionInfo, bool runDriverCheck=FALSE)
 Sets the address config for a given set of data point elements See fwPeriphAddress_set() for an example.
Other Functions



 fwPeriphAddress_setOPC (string dpe, string opcServerName, int driverNum, string OPCItemName, string OPCGroup, int datatype, int mode, unsigned subindex, dyn_string &exceptionInfo)
 fwPeriphAddress_setOPCUA (string dpe, string opcServerName, int driverNum, string opcItemName, string opcSubscription, string opcKind, string opcVariant, int datatype, int mode, string pollGroup, dyn_string &exceptionInfo)
 fwPeriphAddress_deleteMultiple (dyn_string dpes, dyn_string &exceptionInfo)
 fwPeriphAddress_delete (string dpe, dyn_string &exceptionInfo)
 _fwPeriphAddress_deleteDIPMultiple (dyn_string dpe, dyn_string &exceptionInfo)
 fwPeriphAddress_getDataType (int &dataType, string dpe, string addressType)
 fwPeriphAddress_readSettings (string referencePanel, dyn_string &addressParam, dyn_string &exceptionInfo)
 fwPeriphAddress_checkModbusParameters (dyn_string dsParameters, dyn_string &exceptionInfo)
 fwPeriphAddress_setIEC (string dpe, dyn_string dsParameters, dyn_string &exceptionInfo)
 fwPeriphAddress_setModbus (string dpe, dyn_string dsParameters, dyn_string &exceptionInfo)
 fwPeriphAddress_getUnicosAddressReference (dyn_string dsParameters, string &addressReference)
 fwPeriphAddress_checkIsDriverRunning (int driverNumber, bool &isRunning, dyn_string &exceptionInfo, string systemName="LOCAL")
 fwPeriphAddress_checkAreDriversRunning (dyn_int driverNumbers, dyn_bool &areRunning, dyn_string &exceptionInfo, string systemName="LOCAL")
 fwPeriphAddress_createPvssInternalDpsForDriver (unsigned driverNumber, dyn_string &exceptionInfo)
 fwPeriphAddress_changeOpcGroups (dyn_string dpes, string newGroupName, dyn_string &exceptionInfo)

Variables

const unsigned fwPeriphAddress_ROOT_NAME = 3
 replaced by _REFERENCE but kept for compatibility
const int PVSS_ADDRESS_LOWLEVEL_TO_MODE = 64
const int PVSS_MODBUS_INT16 = 561
const int PVSS_MODBUS_INT32 = 562
const int PVSS_MODBUS_UINT16 = 563
const int PVSS_MODBUS_BOOL = 567
const int PVSS_MODBUS_FLOAT = 566
const int fwPeriphAddress_PANEL_MODE_OBJECT = 1
const int fwPeriphAddress_PANEL_MODE_SINGLE_DPE = 2
const int fwPeriphAddress_PANEL_MODE_MULTIPLE_DPES = 3
Types of periphery addresses



const string fwPeriphAddress_TYPE_OPC = "OPC"
const string fwPeriphAddress_TYPE_OPCCLIENT = "OPCCLIENT"
const string fwPeriphAddress_TYPE_OPCSERVER = "OPCSERVER"
const string fwPeriphAddress_TYPE_OPCUA = "OPCUA"
const string fwPeriphAddress_TYPE_OPCUACLIENT = "OPCUA"
const string fwPeriphAddress_TYPE_DIM = "DIM"
const string fwPeriphAddress_TYPE_DIMCLIENT = "DIMCLIENT"
const string fwPeriphAddress_TYPE_DIMSERVER = "DIMSERVER"
const string fwPeriphAddress_TYPE_MODBUS = "MODBUS"
const string fwPeriphAddress_TYPE_DIP = "DIP"
const string fwPeriphAddress_TYPE_NONE = "None"
const string fwPeriphAddress_TYPE_IEC = "IEC"
Common address object



const unsigned fwPeriphAddress_TYPE = 1
const unsigned fwPeriphAddress_DRIVER_NUMBER = 2
const unsigned fwPeriphAddress_REFERENCE = 3
const unsigned fwPeriphAddress_DIRECTION = 4
const unsigned fwPeriphAddress_DATATYPE = 5
const unsigned fwPeriphAddress_ACTIVE = 6
JCOP fw Address reference



const unsigned FW_PARAMETER_FIELD_COMMUNICATION = 1
 Type of communication. ex : "MODBUS".
const unsigned FW_PARAMETER_FIELD_DRIVER = 2
 Driver number.
const unsigned FW_PARAMETER_FIELD_ADDRESS = 3
 Address reference.
const unsigned FW_PARAMETER_FIELD_MODE = 4
 Mode.
const unsigned FW_PARAMETER_FIELD_DATATYPE = 5
 Type of data (see constants below).
const unsigned FW_PARAMETER_FIELD_ACTIVE = 6
 Is address active.
const unsigned FW_PARAMETER_FIELD_LOWLEVEL = 11
 Is low level config used.
const unsigned FW_PARAMETER_FIELD_SUBINDEX = 12
 Address subindex.
const unsigned FW_PARAMETER_FIELD_START = 13
 Starting time.
const unsigned FW_PARAMETER_FIELD_INTERVAL = 14
 Interval time.
const unsigned FW_PARAMETER_FIELD_NUMBER = 15
 Number of parameters.
IEC address object



const unsigned fwPeriphAddress_IEC_SUBINDEX = 12
MODBUS address object



const unsigned fwPeriphAddress_MODBUS_LOWLEVEL = 11
const unsigned fwPeriphAddress_MODBUS_SUBINDEX = 12
const unsigned fwPeriphAddress_MODBUS_START = 13
const unsigned fwPeriphAddress_MODBUS_INTERVAL = 14
const unsigned fwPeriphAddress_MODBUS_POLL_GROUP = 15
const unsigned fwPeriphAddress_MODBUS_OBJECT_SIZE = 15
OPC DA address object



const unsigned fwPeriphAddress_OPC_LOWLEVEL = 11
const unsigned fwPeriphAddress_OPC_SUBINDEX = 12
const unsigned fwPeriphAddress_OPC_SERVER_NAME = 13
const unsigned fwPeriphAddress_OPC_GROUP_IN = 14
const unsigned fwPeriphAddress_OPC_GROUP_OUT = 15
const unsigned fwPeriphAddress_OPC_OBJECT_SIZE = 15
OPC UA address object



const unsigned fwPeriphAddress_OPCUA_LOWLEVEL = 11
 Low level comparison.
const unsigned fwPeriphAddress_OPCUA_SERVER_NAME = 12
 OPC UA Server name.
const unsigned fwPeriphAddress_OPCUA_SUBSCRIPTION = 13
 Subscription name.
const unsigned fwPeriphAddress_OPCUA_KIND = 14
 Kind (1=Value; 2=Event; 3=Alarm).
const unsigned fwPeriphAddress_OPCUA_VARIANT = 15
 Variant (1=Node ID; 2=Browse Path).
const unsigned fwPeriphAddress_OPCUA_POLL_GROUP = 16
 Polling group name.
const unsigned fwPeriphAddress_OPCUA_OBJECT_SIZE = 16
DIM address object



const unsigned fwPeriphAddress_DIM_CONFIG_DP = 11
const unsigned fwPeriphAddress_DIM_DEFAULT_VALUE = 12
const unsigned fwPeriphAddress_DIM_TIMEOUT = 13
const unsigned fwPeriphAddress_DIM_FLAG = 14
const unsigned fwPeriphAddress_DIM_IMMEDIATE_UPDATE = 15
const unsigned fwPeriphAddress_DIM_OBJECT_SIZE = 15
const unsigned fwPeriphAddress_DIM_DRIVER_NUMBER = 1
DIP address object



const unsigned fwPeriphAddress_DIP_CONFIG_DP = 11
const unsigned fwPeriphAddress_DIP_BUFFER_TIME = 12
UNICOS address reference



const unsigned UN_ADDRESS_PARAMETER_FIELD_NUMBER = 5
 Number of parameters.
const unsigned UN_ADDRESS_PARAMETER_FIELD_MODE = 1
 Mode.
const unsigned UN_ADDRESS_PARAMETER_FIELD_PLCTYPE = 2
 PLC type ie "QUANTUM" or "PREMIUM".
const unsigned UN_ADDRESS_PARAMETER_FIELD_PLCNUMBER = 3
 PLC number.
const unsigned UN_ADDRESS_PARAMETER_FIELD_EVENT = 4
 Is event.
const unsigned UN_ADDRESS_PARAMETER_FIELD_ADDRESS = 5
 Address in PLC.
const char UN_PREMIUM_INPUT_LETTER_EVENT = "U"
const char UN_PREMIUM_INPUT_LETTER_MISC = "U"
const char UN_QUANTUM_INPUT_LETTER_EVENT = "U"
const char UN_QUANTUM_INPUT_LETTER_MISC = "M"
const int UN_PREMIUM_INPUT_NB_EVENT = 18
const int UN_PREMIUM_INPUT_NB_MISC = 1
const int UN_QUANTUM_INPUT_NB_EVENT = 18
const int UN_QUANTUM_INPUT_NB_MISC = 16
const int UN_PREMIUM_QUANTUM_OUTPUT_NB_ALL = 16
const char UN_PREMIUM_QUANTUM_OUTPUT_LETTER_ALL = "M"

Detailed Description

/**


Function Documentation

fwPeriphAddress_setOPC ( string  dpe,
string  opcServerName,
int  driverNum,
string  OPCItemName,
string  OPCGroup,
int  datatype,
int  mode,
unsigned  subindex,
dyn_string &  exceptionInfo 
)

Add an address config for an OPC Item

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpe data point element
opcServerName data point name of the OPC Server wihtout system name and "_"
driverNum driver number
OPCItemName opc item name
OPCGroup opc group name
datatype translation datatype for address (0 gives automatic translation)
mode DPATTR_ADDR_MODE_INPUT_SPONT: spontaneous input DPATTR_ADDR_MODE_INPUT_SPONT+64: spontaneous input and old/new comparison DPATTR_ADDR_MODE_OUTPUT_SINGLE: output DPATTR_ADDR_MODE_OUTPUT_SINGLE+64: output and old/new comparison
subindex used where datatype is set to 'bitstring'. Subindex gives the position of the desired bit.
exceptionInfo details of any errors are returned here
fwPeriphAddress_setOPCUA ( string  dpe,
string  opcServerName,
int  driverNum,
string  opcItemName,
string  opcSubscription,
string  opcKind,
string  opcVariant,
int  datatype,
int  mode,
string  pollGroup,
dyn_string &  exceptionInfo 
)

Add an address config for an OPC UA Item.

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpe data point element
opcServerName data point name of the OPC Server wihtout system name and "_"
driverNum driver number
opcItemName opc item name
opcSubscription opc subscription name
opcKind opc kind
opcVariant opc variant
datatype translation datatype for address (0 gives automatic translation). See WinCC OA help on _address for a list of data type translations
mode DPATTR_ADDR_MODE_INPUT_SPONT: spontaneous input DPATTR_ADDR_MODE_INPUT_SPONT+64: spontaneous input and old/new comparison DPATTR_ADDR_MODE_OUTPUT_SINGLE: output DPATTR_ADDR_MODE_OUTPUT_SINGLE+64: output and old/new comparison DPATTR_ADDR_MODE_IO_POLL: in/out with polling mode DPATTR_ADDR_MODE_IO_SQUERY: in/out with single query DPATTR_ADDR_MODE_INPUT_POLL: input with polling mode DPATTR_ADDR_MODE_INPUT_SQUERY: input with single query
pollGroup polling group name (used only if no subscription name is specified)
exceptionInfo details of any errors are returned here
fwPeriphAddress_deleteMultiple ( dyn_string  dpes,
dyn_string &  exceptionInfo 
)

Deletes the address config of the given dp elements

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpes list of data point elements
exceptionInfo details of any errors are returned here
fwPeriphAddress_delete ( string  dpe,
dyn_string &  exceptionInfo 
)

Deletes the address config of the given dp element

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpe data point element
exceptionInfo details of any errors are returned here
_fwPeriphAddress_deleteDIPMultiple ( dyn_string  dpe,
dyn_string &  exceptionInfo 
)

Deletes the DIP address config of the given dp elements

Constraints
all dpes passed must have a periphery address of type DIP
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpe data point element
exceptionInfo details of any errors are returned here
fwPeriphAddress_getDataType ( int &  dataType,
string  dpe,
string  addressType 
)

Checks the type of a data point element and returns the integer used to represent this data type depending on the required type of peripheral address.

NOTE: this function is mostly redundant now as OPC supports the default data transformation now. The results for address type DIM are also redundant now.

Constraints
None
Usage
Internal
PVSS managers
VISION, CTRL
Parameters:
dataType The integer representing the data type is returned here (returns -1 if dpe type is unsupported)
dpe The data point element to check
addressType The type of peripheral address (DIM or OPC)
fwPeriphAddress_readSettings ( string  referencePanel,
dyn_string &  addressParam,
dyn_string &  exceptionInfo 
)

This function is used to read the address configuration parameters that can be entered in the panels fwPeriphAddressDIM.pnl and fwPeriphAddressOPC.pnl. It can be extended to support other address formats.

Constraints
None
Usage
Internal
PVSS managers
VISION
Parameters:
referencePanel the name of the reference panel to read from
addressParam the address parameterization that was entered in the panel
exceptionInfo details of any exceptions are returned here
fwPeriphAddress_checkModbusParameters ( dyn_string  dsParameters,
dyn_string &  exceptionInfo 
)

Check if data is Ok to set a MODBUS address

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dsParameters parameters used to set the _address config (see constants definition)
exceptionInfo for any error. If a parameter is incorrect, exceptionInfo is not empty !
fwPeriphAddress_setIEC ( string  dpe,
dyn_string  dsParameters,
dyn_string &  exceptionInfo 
)

Set IEC address

Constraints
In this function, we suppose that variable dsParameters is well formatted.
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpe datapoint element whose address have to be set
dsParameters parameters used to set the _address config (see constants definition)
exceptionInfo for any error...
fwPeriphAddress_setModbus ( string  dpe,
dyn_string  dsParameters,
dyn_string &  exceptionInfo 
)

Set MODBUS address

Constraints
. In this function, we suppose that variable dsParameters is well formatted. Before calling this function, it is recommended to check the parameters using the fwPeriphAddress_checkModbusParameters function. . In the parameters, the field addressReference could be obtain using fwPeriphAddress_getUnicosAddressReference
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpe datapoint element whose address have to be set
dsParameters parameters used to set the _address config (see constants definition)
exceptionInfo for any error...
fwPeriphAddress_getUnicosAddressReference ( dyn_string  dsParameters,
string &  addressReference 
)

Get formatted address for Unicos using given parameters

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dsParameters parameters used to build the address reference (see constants definition)
addressReference address reference (empty string in case of error)
fwPeriphAddress_checkIsDriverRunning ( int  driverNumber,
bool &  isRunning,
dyn_string &  exceptionInfo,
string  systemName = "LOCAL" 
)

Checks to see if a given driver manager is running or not

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
driverNumber the number of the driver to check
isRunning Driver state is returned here - TRUE if manager is running, else FALSE
exceptionInfo if the driver is not running, an exception is returned
systemName OPTIONAL PARAMETER: System name on which to check if the driver is running (e.g. dist_1:). If not passed, the local system is checked.
fwPeriphAddress_checkAreDriversRunning ( dyn_int  driverNumbers,
dyn_bool &  areRunning,
dyn_string &  exceptionInfo,
string  systemName = "LOCAL" 
)

Checks to see if a given list of driver managers are running or not

Constraints
None
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
driverNumbers the numbers of the drivers to check
areRunning A list of the driver states is returned here - TRUE if manager is running, else FALSE
exceptionInfo if the driver is not running, an exception is returned
systemName OPTIONAL PARAMETER: System name on which to check if the drivers are running (e.g. dist_1:). If not passed, the local system is checked.
fwPeriphAddress_createPvssInternalDpsForDriver ( unsigned  driverNumber,
dyn_string &  exceptionInfo 
)

Creates the necessary PVSS internal data for a given driver number. These are "_DriverX" and "_Stat_Configs_driver_X" where X is the driver number.

Constraints
The driver number must be between 1 and 254 (PVSS limitation on driver numbers)
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
driverNumber The driver number for which you wish to create the internal PVSS dps
exceptionInfo Details of any exceptions are returned here
fwPeriphAddress_changeOpcGroups ( dyn_string  dpes,
string  newGroupName,
dyn_string &  exceptionInfo 
)

Changes the OPC group in the address config for the given list of dpes

Constraints
The relevant SIM Manager or Driver must be running to access the address configs
Usage
Public
PVSS managers
VISION, CTRL
Parameters:
dpes The list of dpes to act on
newGroupName The new OPC server group name
exceptionInfo Details of any exceptions are returned here

Variable Documentation

const string fwPeriphAddress_TYPE_OPC = "OPC"
const string fwPeriphAddress_TYPE_OPCCLIENT = "OPCCLIENT"
const string fwPeriphAddress_TYPE_OPCSERVER = "OPCSERVER"
const string fwPeriphAddress_TYPE_OPCUA = "OPCUA"
const string fwPeriphAddress_TYPE_OPCUACLIENT = "OPCUA"
const string fwPeriphAddress_TYPE_DIM = "DIM"
const string fwPeriphAddress_TYPE_DIMCLIENT = "DIMCLIENT"
const string fwPeriphAddress_TYPE_DIMSERVER = "DIMSERVER"
const string fwPeriphAddress_TYPE_MODBUS = "MODBUS"
const string fwPeriphAddress_TYPE_DIP = "DIP"
const string fwPeriphAddress_TYPE_NONE = "None"
const string fwPeriphAddress_TYPE_IEC = "IEC"
const unsigned fwPeriphAddress_TYPE = 1
const unsigned fwPeriphAddress_DRIVER_NUMBER = 2
const unsigned fwPeriphAddress_REFERENCE = 3
const unsigned fwPeriphAddress_DIRECTION = 4
const unsigned fwPeriphAddress_DATATYPE = 5
const unsigned fwPeriphAddress_ACTIVE = 6
const unsigned fwPeriphAddress_ROOT_NAME = 3

replaced by _REFERENCE but kept for compatibility

Type of communication. ex : "MODBUS".

const unsigned FW_PARAMETER_FIELD_DRIVER = 2

Driver number.

const unsigned FW_PARAMETER_FIELD_ADDRESS = 3

Address reference.

const unsigned FW_PARAMETER_FIELD_MODE = 4

Mode.

const unsigned FW_PARAMETER_FIELD_DATATYPE = 5

Type of data (see constants below).

const unsigned FW_PARAMETER_FIELD_ACTIVE = 6

Is address active.

const unsigned FW_PARAMETER_FIELD_LOWLEVEL = 11

Is low level config used.

const unsigned FW_PARAMETER_FIELD_SUBINDEX = 12

Address subindex.

const unsigned FW_PARAMETER_FIELD_START = 13

Starting time.

const unsigned FW_PARAMETER_FIELD_INTERVAL = 14

Interval time.

const unsigned FW_PARAMETER_FIELD_NUMBER = 15

Number of parameters.

const unsigned fwPeriphAddress_IEC_SUBINDEX = 12
const unsigned fwPeriphAddress_MODBUS_LOWLEVEL = 11
const unsigned fwPeriphAddress_MODBUS_SUBINDEX = 12
const unsigned fwPeriphAddress_MODBUS_START = 13
const unsigned fwPeriphAddress_MODBUS_INTERVAL = 14
const unsigned fwPeriphAddress_MODBUS_POLL_GROUP = 15
const unsigned fwPeriphAddress_OPC_LOWLEVEL = 11
const unsigned fwPeriphAddress_OPC_SUBINDEX = 12
const unsigned fwPeriphAddress_OPC_SERVER_NAME = 13
const unsigned fwPeriphAddress_OPC_GROUP_IN = 14
const unsigned fwPeriphAddress_OPC_GROUP_OUT = 15
const unsigned fwPeriphAddress_OPC_OBJECT_SIZE = 15
const unsigned fwPeriphAddress_OPCUA_LOWLEVEL = 11

Low level comparison.

const unsigned fwPeriphAddress_OPCUA_SERVER_NAME = 12

OPC UA Server name.

Subscription name.

const unsigned fwPeriphAddress_OPCUA_KIND = 14

Kind (1=Value; 2=Event; 3=Alarm).

const unsigned fwPeriphAddress_OPCUA_VARIANT = 15

Variant (1=Node ID; 2=Browse Path).

const unsigned fwPeriphAddress_OPCUA_POLL_GROUP = 16

Polling group name.

const unsigned fwPeriphAddress_OPCUA_OBJECT_SIZE = 16
const unsigned fwPeriphAddress_DIM_CONFIG_DP = 11
const unsigned fwPeriphAddress_DIM_DEFAULT_VALUE = 12
const unsigned fwPeriphAddress_DIM_TIMEOUT = 13
const unsigned fwPeriphAddress_DIM_FLAG = 14
const unsigned fwPeriphAddress_DIM_OBJECT_SIZE = 15
const unsigned fwPeriphAddress_DIP_CONFIG_DP = 11
const unsigned fwPeriphAddress_DIP_BUFFER_TIME = 12
const int PVSS_MODBUS_INT16 = 561
const int PVSS_MODBUS_INT32 = 562
const int PVSS_MODBUS_UINT16 = 563
const int PVSS_MODBUS_BOOL = 567
const int PVSS_MODBUS_FLOAT = 566

Number of parameters.

const unsigned UN_ADDRESS_PARAMETER_FIELD_MODE = 1

Mode.

PLC type ie "QUANTUM" or "PREMIUM".

PLC number.

Is event.

Address in PLC.

const char UN_PREMIUM_INPUT_LETTER_MISC = "U"
const char UN_QUANTUM_INPUT_LETTER_MISC = "M"
const int UN_PREMIUM_INPUT_NB_EVENT = 18
const int UN_PREMIUM_INPUT_NB_MISC = 1
const int UN_QUANTUM_INPUT_NB_EVENT = 18
const int UN_QUANTUM_INPUT_NB_MISC = 16

Generated on 10 Dec 2015 for fwConfigs by  doxygen 1.6.1