MC Get Property.vi
- Updated2023-02-21
- 37 minute(s) read
MC Get Property.vi
Purpose
Gets a property for the object referenced by the reference in terminal. The poly VI selection determines the property to get.
Format
Input
 |
Name specifies an individual channel within the task defined by reference in. The default (unwired) value of name is empty, which means the property applies to the entire task, not a specific channel. If a property relates to Measurement or Characteristic channels and does not apply to the entire task, but an individual channel or message within the task, you must wire the name of a Measurement or Characteristic channel from channel list into the name input. For other properties you must leave name unwired (empty). | ||||||
 |
Reference in is the reference to any opened A2L database, a selected ECU, or an ECU which is already connected (with MC Database Open.vi, MC ECU Select.vi, MC ECU Open.vi, or MC ECU Connect.vi). The type of this reference depends on the property you want to get. | ||||||
 |
Error in is a cluster which describes error conditions occurring before the VI executes. If an error has already occurred, the VI returns the value of the error in cluster to error out.
|
Output
 |
Reference out contains an ECU M&C task reference which can be wired through subsequent ECU M&C VIs. | ||||||
 |
Value is a poly output value that returns the property value. You select the property returned in value by selecting the poly VI type. The data type of value is also determined by the poly VI selection. For information about the different properties provided by MC Get Property.vi, refer to the Poly VI Types table in the Description section. To select the property, right-click the VI, go to Select Type, and select the property by name. | ||||||
 |
Error out describes error conditions. If the Error in cluster indicated an error, the Error out cluster contains the same information. Otherwise, Error out describes the error status of this VI.
|
Description
Poly VI Types
| Type | Hierarchy | Sub-Hierarchy | Parameter | Description | |||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Sub 1 | Sub 2 | ||||||||||||||||||||||||||||||||
 | — | — | — | DB File Name | Returns the A2L Database file name with which the task has been opened. The value of this property cannot be changed using MC Set Property.vi. | ||||||||||||||||||||||||||||
| ECU | — | — | Name | Returns the Name of the selected ECU opened by MC ECU Open.vi or MC ECU Select.vi. | ||||||||||||||||||||||||||||
| ECU | — | — | Comment | Returns the Comment string of the selected ECU. | ||||||||||||||||||||||||||||
 | ECU | — | — | DAQ List Numbers | Returns an array of DAQ list numbers for all DAQ lists defined in the A2L file. | ||||||||||||||||||||||||||||
| ECU | CCP | — | DTO Id | Returns the DTO ID, which is used by the ECU to respond to CCP commands and to send data and status information to the CCP master. If bit 31 (hex 0x80000000) of the value is set, the value is considered an extended CAN identifier (29-bit). | ||||||||||||||||||||||||||||
| ECU | CCP | — | CRO Id | Returns the CRO ID, which is used to send commands and data from the host to the slave device. If bit 31 (hex 0x80000000) of the value is set, the value is considered an extended CAN identifier (29-bit). | ||||||||||||||||||||||||||||
 | ECU | CCP | — | Interface | Returns the interface initialized for the task, such as with MC DAQ Initialize.vi. | ||||||||||||||||||||||||||||
| ECU | CCP | — | Baud Rate | Returns the Baud Rate used by the CAN interface with CCP protocol. Basic baud rates such as 125000 and 500000 are specified as the numeric value. Advanced (custom) baud rates are specific to the CAN interface type and can be found within NI-XNET or NI-CAN documentation. The default value of the property is the baud rate value defined by the A2L database file. You can change that value using MC Set Property.vi. | ||||||||||||||||||||||||||||
 | ECU | CCP | — | Termination | For all XNET devices, the termination is software selectable. XNET provides the option of 120 Ω between Bus Plus and Bus Minus or no termination. The Termination property configures the onboard termination of the NI-XNET interface CAN connector (port). The Boolean property supports two values: TRUE = Termination ON and FALSE = Termination Off. However, different CAN or LIN hardware has different termination requirements, and the termination values have different meanings. Refer to the Termination attribute in the XNET API for more details. (This property is supported for NI-XNET devices only.) | ||||||||||||||||||||||||||||
| ECU | CCP | — | Station Address | Returns the Station Address of the slave device. CCP is based on the idea, that several ECUs can share the same CAN Arbitration IDs for CCP communication. To avoid communication conflicts CCP defines a Station Address that has to be unique for all ECUs sharing the same CAN Arbitration IDs. Unless an ECU has been addressed by its Station Address, the ECU must not react to CCP commands sent by the CCP master. | ||||||||||||||||||||||||||||
| ECU | CCP | — | SeedKey Cal Name | Returns the file name of the SeedKey DLL used for Calibration purposes. If SeedKey is configured for remote access, the output is RSK:<server ip address>,<port>. | ||||||||||||||||||||||||||||
| ECU | CCP | — | SeedKey DAQ Name | Returns the file name of the SeedKey DLL used for DAQ purposes. If SeedKey is configured for remote access, the output is RSK:<server ip address>,<port>. | ||||||||||||||||||||||||||||
| ECU | CCP | — | SeedKey Prog Name | Returns the file name of the SeedKey DLL used for programming purposes. If SeedKey is configured for remote access, the output is RSK:<server ip address>,<port>. | ||||||||||||||||||||||||||||
 | ECU | CCP | — | Master Id | Returns CCP Master ID information. This ID information is optional and specific to the ECU implementation. For more information about the CCP master ID, refer to the documentation for the ECU. | ||||||||||||||||||||||||||||
| ECU | CCP | — | Id | Returns the slave device identifier. This ID information is optional and specific to the ECU implementation. For more information about the CCP slave ID, refer to the documentation for the ECU. | ||||||||||||||||||||||||||||
| ECU | CCP | — | Id Data Byte | Returns a data type qualifier of the slave device identifier. This ID information is optional and specific to the ECU implementation. For more information about the CCP slave ID, refer to the documentation for the ECU. | ||||||||||||||||||||||||||||
 | ECU | CCP | — | Single Byte DAQ List? | Determines if an ECU supports single-byte or multi-byte DAQ list entries. | ||||||||||||||||||||||||||||
| ECU | CCP | — | DTO Task | Returns the NI-CAN task reference for the Data Transmission Object (the CAN task reading frames from the slave device). For example, you might use this to set CAN properties for this task. Handle with extreme care, as those properties are usually set correctly by the ECU M&C Toolkit itself. | ||||||||||||||||||||||||||||
| ECU | CCP | — | CRO Task | Returns the NI-CAN task reference for the Command Receive Object (the CAN task writing frames to the slave device). For example, you might use this to set CAN properties for this task. Handle with extreme care, as those properties are usually set correctly by the ECU M&C Toolkit itself. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | CLEAR MEMORY | Returns a Boolean value that indicates whether the ECU supports the optional ASAM CCP Command CLEAR_MEMORY. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | DNLOAD 6 | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command DNLOAD_6. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | SHORT UP | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command SHORT_UP. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | PROGRAM | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command PROGRAM. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | PROGRAM 6 | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command PROGRAM_6. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | MOVE | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command MOVE. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | BUILD CHKSUM | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command BUILD_CHKSUM. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | GET ACTIVE CAL PAGE | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command GET_ACTIVE_CAL_PAGE. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | SELECT CAL PAGE | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command SELECT_CAL_PAGE. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | GET S STATUS | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command GET_S_STATUS. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | SET S STATUS | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command SET_S_STATUS. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | GET SEED | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command GET_SEED. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | UNLOCK | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command UNLOCK. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | START STOP ALL | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command START_STOP_ALL. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | TEST | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command TEST. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | ACTION SERVICE | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command ACTION_SERVICE. | ||||||||||||||||||||||||||||
| ECU | CCP | Optional Commands | DIAG SERVICE | Returns a Boolean value that indicates whether the ECU supports the optional CCP Command DIAG_SERVICE. | ||||||||||||||||||||||||||||
| ECU | CCP | Misc | Skip EXCHANGE ID | Returns a Boolean value that indicates whether or not the EXCHANGE_ID command should be suppressed during connection to the ECU. | ||||||||||||||||||||||||||||
| ECU | CCP | Timeout | T_std | Returns the timeout value (in milliseconds) for most of the CCP commands. For details of which timeout applies to a specific command, refer to the CCP standard. Default: 40. Standard: 25. The default is chosen slightly higher to allow for slower ECUs. Note that the Timing Factor property might modify this value. |
||||||||||||||||||||||||||||
| ECU | CCP | Timeout | T_pgm | Returns the timeout value (in milliseconds) for the CCP programming commands. For details of which timeout applies to a specific command, refer to the CCP standard. Default: 120. Standard: 100. The default is chosen slightly higher to allow for slower ECUs. Note that the Timing Factor property might modify this value. |
||||||||||||||||||||||||||||
| ECU | CCP | Timeout | T_mem | Returns the timeout value (in milliseconds) for the CCP memory commands. For details of which timeout applies to a specific command, refer to the CCP standard. Default and Standard: 30000. Note that the Timing Factor property might modify this value. |
||||||||||||||||||||||||||||
| ECU | CCP | Timeout | T_diag | Returns the timeout value (in milliseconds) for the CCP DIAG_SERVICE command. Default and Standard: 500. Note that the Timing Factor property might modify this value. |
||||||||||||||||||||||||||||
| ECU | CCP | Timeout | T_act | Returns the timeout value (in milliseconds) for the CCP ACTION_SERVICE command. Default: 500. Standard: 5000. Note that the Timing Factor property might modify this value. |
||||||||||||||||||||||||||||
| ECU | CCP | Cal Pages | Number of Pages | Returns the number of DEFINED_PAGES structures for this ECU in the A2L file. | ||||||||||||||||||||||||||||
| ECU | CCP | Cal Pages | Page Number | Returns the page number of the page selected with the name input. | ||||||||||||||||||||||||||||
| ECU | CCP | Cal Pages | Page Flags | Returns the page flags of the page selected with the name input. The value returned is a bitmask ored from the following values:
|
||||||||||||||||||||||||||||
| ECU | CCP | Cal Pages | Page Address | Returns the memory address (and extension) of the page selected with the name input. | ||||||||||||||||||||||||||||
| ECU | XCP | CAN | DTO Id | Returns the DTO ID, which is used by the ECU to respond to XCP commands and send data and status information to the XCP master. If bit 31 (hex 0x80000000) of the value is set, the value is considered an extended CAN identifier (29-bit). | ||||||||||||||||||||||||||||
| ECU | XCP | CAN | CRO Id | Returns the CRO ID, which is used to send commands and data from the host to the slave device. If bit 31 (hex 0x80000000) of the value is set, the value is considered an extended CAN identifier (29-bit). | ||||||||||||||||||||||||||||
| ECU | XCP | CAN | Baud Rate | This is a legacy property and should no longer be used. Use the ECU:XCP:CAN:Baud Rate 64 instead. | ||||||||||||||||||||||||||||
 | ECU | XCP | CAN | Baud Rate 64 | Indicates the Baud Rate in use by the CAN Interface with XCP protocol. Basic baud rates such as 125000 and 500000 are specified as numeric values. Advanced (or custom) baud rates are specific to the CAN interface in use and the description can be found in the NI-XNET or NI-CAN documentation. The default value for the property is the baud rate set in the A2L database used for the application.
If NI-XNET is used and the A2L file specifies a sampling point for the baud rate which differs from the sampling point used internally in NI-XNET, ECUMC replaces the standard baud rate value by a custom 64-bit baud rate which uses the sampling point as close as possible to the sampling point in A2L database. You can find the documentation for the NI-XNET custom baud rate in NI-XNET Hardware and Software Help under Interface:64bit Baud Rate. You can change that value using MC Set Property.vi. |
||||||||||||||||||||||||||||
| ECU | XCP | CAN | FD Baud Rate 64 | Reads the CAN FD baud rate value (used for the data part of the transmission).
If CAN FD is used, Baud Rate 64 specifies the baud rate for the arbitration part of the CAN message, while FD Baud Rate 64 specifies the baud rate for the data part of the CAN message. CAN FD is only supported by NI-XNET interfaces for XCP protocol. Basic baud rates such as 500000 and 2000000 are specified as numeric values. Information about the advanced (or custom) baud rates can be found in the NI-XNET Hardware and Software Help under Interface:CAN:64bit FD Baud Rate. The default value for the property is the baud rate set in the CAN_FD section of the A2L database used for the application. You can set the property to use any other baud rate or custom baud rate according to NI-XNET specification. If the A2L file specifies a sampling point for the CAN FD baud rate which differs from the sampling point used internally in NI-XNET, ECUMC replaces the standard baud rate value by a custom 64-bit baud rate which uses the sampling point as close as possible to the sampling point in A2L database. Refer to the information about the custom baud rates in the NI-XNET Hardware and Software Help under Interface:64bit FD Baud Rate. Transceiver Delay Compensation defined by the A2L database is not used while calculating the custom baud rate value, as the value is hardware implementation specific and the value found in the database may not match the NI-XNET specification. If you need very specific values for the CAN FD baud rate, you need to follow the NI-XNET documentation and set a custom baud rate using MC Set Property.vi. |
||||||||||||||||||||||||||||
| ECU | XCP | CAN | CAN I/O Mode | Determines whether an XNET interface is running in CAN 2.0 mode (supports frames with payload up to 8 bytes), CAN FD mode (supports frames up to 64 bytes), or CAN FD+BRS mode (CAN FD with baud rate switching). CAN I/O Mode is only supported with XNET interfaces.
The default value is determined by the A2L database used by the application. The user can change the mode using this property to overwrite the mode set in the A2L database. Valid values are CAN, CAN_FD, CAN_FD+BRS, and ECU Determined. The A2L database supports only CAN and CAN FD+BRS modes. The user can also set the mode to CAN_FD (without baud rate switching) using MC Set Property.vi. In ECU Determined mode, the master can communicate with ECUs using either traditional CAN or CAN FD frames. The master starts the communication with a traditional CAN 2.0 frame; if the ECU responds in any mode, this mode is selected for further communication. If the ECU does not respond to the CAN 2.0 frame, the master repeats (after timeout) the first command using a CAN FD frame. In ECU Determined mode, the NI-XNET interface runs in CAN FD BRS mode, so the CAN FD baud rate must be set before using this mode. In CAN FD+BRS mode, the NI-XNET interface can receive and transmit CAN 2.0, CAN FD, and CAN FD+BRS frames.
|
||||||||||||||||||||||||||||
 | ECU | XCP | CAN | Act CAN I/O Mode | This read-only property allows querying the CAN I/O mode that is actually used when the CAN I/O mode is set to ECU Determined. As long as the mode has not been determined, the value is ECU Determined (refer to the CAN I/O Mode description for possible values). When the communication with the ECU has been established, the value changes to CAN 2.0, CAN FD, or CAN FD+BRS mode. | ||||||||||||||||||||||||||||
| ECU | XCP | CAN | Use CAN Max DLC | Determines if the master in CAN 2.0 mode transmits frames with the actual used payload length or always transmits the maximum number of bytes (8 bytes).
The default value of this property is retrieved from the A2L database based on the MAX_DLC_REQUIRED keyword within the XCP_ON_CAN section. |
||||||||||||||||||||||||||||
 | ECU | XCP | CAN | CAN FD Max DLC | Determines the number of bytes transmitted by the master when the property ECU:XCP:CAN:Use CAN FD Max DLC is set to TRUE.
The default value of this property is retrieved from the A2L database based on the MAX_DLC keyword within the CAN_FD section. |
||||||||||||||||||||||||||||
| ECU | XCP | CAN | Use CAN FD Max DLC | Determines if the master in CAN FD mode transmits frames with the actual used payload length or if it always transmits the maximum number of bytes, defined by the ECU:XCP:CAN FD Max DLC setting (8…64 bytes).
The default value of this property is retrieved from the A2L database based on the MAX_DLC_REQUIRED keyword within the CAN_FD section. |
||||||||||||||||||||||||||||
| ECU | XCP | CAN | Termination | For all XNET devices, the termination is software selectable. XNET provides the option of 120 Ω between Bus Plus and Bus Minus or no termination. The Termination property configures the onboard termination of the NI-XNET interface CAN or LIN connector (port). The Boolean property supports two values: TRUE = Termination ON and FALSE = Termination Off. However, different CAN or LIN hardware has different termination requirements, and the termination values have different meanings. Refer to the Termination attribute in the XNET API for more details. (This property is supported for NI-XNET devices only.) | ||||||||||||||||||||||||||||
| ECU | XCP | Ethernet | IP Address | Returns the IP address of the slave device. A slave device connected by Ethernet and TCP/IP or UDP/IP protocol is addressed by its IP Address and Port number. | ||||||||||||||||||||||||||||
| ECU | XCP | Ethernet | IP Port | Returns the IP Port number of the slave device. A slave device connected by Ethernet and TCP/IP or UDP/IP protocol is addressed by its IP Address and Port number. | ||||||||||||||||||||||||||||
| ECU | XCP | Ethernet | IP Source Address | Returns the IP address of the host Ethernet interface. Empty string (default) indicates the using of the host primary Ethernet interface. | ||||||||||||||||||||||||||||
| ECU | XCP | Ethernet | IP Source Port | Returns the source port (XCP master port) used for Ethernet communication. The default value is -1, which indicates that the source port will be chosen by the operating system. Valid port values are 0 to 65535. Note that port 0 is reserved and typically should not be used. | ||||||||||||||||||||||||||||
| ECU | XCP | Ethernet | IP XNET Stack Name | Returns the name of the XNET IP Stack to be used. If this parameter is empty string (default), the native operating system IP stack will be used. | ||||||||||||||||||||||||||||
| ECU | XCP | Ethernet | IP XNET Local Interface | Returns the name of the local interface that is used with the specified XNET IP Stack for this session. This property is ignored for the native operating system IP stack. | ||||||||||||||||||||||||||||
| ECU | XCP | — | Transport Layer Instance | Returns the Transport Layer Instance name of the selected transport protocol instance. Empty string (default) indicates that no named instance is selected. The fallbacks, in order, are a single unnamed instance of the transport protocol in the IF_DATA XCPplus block or the IF_DATA XCP block. Otherwise, no transport protocol related properties can be read from the database. | ||||||||||||||||||||||||||||
 | ECU | XCP | — | SeedKey Dll | Returns the file name of the SeedKey DLL. If SeedKey is configured for remote access, the output is RSK:<server ip address>,<port>. | ||||||||||||||||||||||||||||
| ECU | XCP | — | Compression Method | Returns the selected compression method used for MC Program.vi.
0—data is uncompressed. 0x80...0xFF—User defined. |
||||||||||||||||||||||||||||
| ECU | XCP | — | Encryption Method | Returns the selected encryption method used for MC Program.vi.
0—data is not encrypted. 0x80...0xFF—User defined. |
||||||||||||||||||||||||||||
| ECU | XCP | — | Programming Method | Returns the selected programming method used for MC Program.vi.
0—Sequential programming. 0x80...0xFF—User defined. |
||||||||||||||||||||||||||||
| ECU | XCP | — | Access Method | Returns the selected access mode:
0x00—Absolute Access Mode (default). The MTA uses physical addresses. 0x01—Functional Access Mode. The MTA functions as a block sequence number of the new flash content file. 0x80...0xFF—User defined. It is possible to use different access modes for clearing and programming. |
||||||||||||||||||||||||||||
| ECU | XCP | — | Meas Split Allowed | Reads the Meas Split Allowed property value.
For measurements in DAQ List mode, the master creates DAQ lists which determines frames with data transmitted by the ECU. The first byte in this frame (ODT) is a PID identifier, the remaining bytes in the frames are used for measurement data (e.g., with CAN 2.0, seven bytes can be used for data). Depending on the type of measurement data, not all bytes of frames can be used. For example, measuring seven 32-bit values in the ECU requires transmitting seven frames per sampling point as only one 4-byte value can be placed in one frame. The remaining three bytes are unused. The Meas Split Allowed property allows splitting the measurements across CAN frames, so the seven values can be packed into only four frames (4 frames * 7 bytes = 28 data bytes for DAQ data). The default value for the property is read from the A2L database (keyword MEASUREMENT_SPLIT_ALLOWED within the XCP_ON_CAN block).
|
||||||||||||||||||||||||||||
| ECU | XCP | Timeout |
T1, T2, T3, T4, T5, T6, T7 |
Returns one of the seven timeout values (in milliseconds) defined in the XCP standard for the various XCP commands. For details of which timeout applies to a specific command, refer to the XCP standard. The values typically are read from an A2L file but may be overridden manually. Note that the Timing Factor property might modify this value. |
||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | Number of Segments | Returns the number of XCP memory segments found for this ECU. | ||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | Number of Pages | Returns the number of memory pages defined for the memory segment specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property). | ||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | Address Extension | Returns the address extension for the memory segment specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property). | ||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | Compression Method | Returns the compression method for the memory segment specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property). A value of 0 means no compression. Other values are user defined. |
||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | Encryption Method | Returns the encryption method for the memory segment specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property). A value of 0 means no encryption. Other values are user defined. |
||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | Page Number | Returns the logical page number for the memory segment page specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property) and page input (0..M-1, where M is the value returned from the Number of Pages property). | ||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | ECU Access | Returns a flag indicating ECU access rights for the memory segment page specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property) and page input (0..M-1, where M is the value returned from the Number of Pages property). Defined values are:
|
||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | XCP Read Access | Returns a flag indicating XCP Read access rights for the memory segment page specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property) and page input (0..M-1, where M is the value returned from the Number of Pages property). Defined values are:
|
||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | XCP Write Access | Returns a flag indicating XCP Write access rights for the memory segment page specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property) and page input (0..M-1, where M is the value returned from the Number of Pages property). Defined values are:
|
||||||||||||||||||||||||||||
| ECU | XCP | Cal Pages | Page InitSegment | Returns the number of the segment that initializes the memory segment page specified in the segment input (0..N-1, where N is the value returned from the Number of Segments property) and page input (0..M-1, where M is the value returned from the Number of Pages property). | ||||||||||||||||||||||||||||
| ECU | — | — | Byte Order | Returns the byte order of the CCP slave device.
0—MSB_LAST The CCP Slave device uses the MSB_LAST (Intel) byte ordering. 1—MSB_FIRST The CCP Slave device uses the MSB_FIRST (Motorola) byte ordering. |
||||||||||||||||||||||||||||
| ECU | — | — | Command Byte Order | Returns the byte order for the defined Measurement or Characteristic.
0—MSB_LAST The CCP Slave device uses the MSB_LAST (Intel) byte ordering. 1—MSB_FIRST The CCP Slave device uses the MSB_FIRST (Motorola) byte ordering. |
||||||||||||||||||||||||||||
| ECU | — | — | Seedkey/Checksum DLL Path | This property determines the directory where the ECU M&C Toolkit expects to find the Seedkey or Checksum DLL. If the property is an empty string (default), the ECU M&C Toolkit expects the DLLs in the same directory as the A2L file. If your DLLs are in a different directory, set this property pointing to this directory. | ||||||||||||||||||||||||||||
| ECU | — | — | Checksum DLL Name | Returns the file name of the Checksum DLL used for verifying the checksum. | ||||||||||||||||||||||||||||
 | ECU | — | — | LogFile Path | Returns the filename (full path) where the XCP or CCP protocol traffic is logged in ASCII format for debugging purposes. An empty path indicates no logging (default). Note that on RT and cRIO systems, the logfile is created on the target system and must be transferred to the host after logging has been completed. Note that no additional CAN port is used for the logging, which makes this method superior to any other method such as running a bus monitor parallel. |
||||||||||||||||||||||||||||
| ECU | — | — | Event Channel | Translates the event channel name to the event channel number. Pass the event channel name in the Name parameter of Get Property. | ||||||||||||||||||||||||||||
| ECU | Mapping | — | Mode | Address mapping mode to be used when accessing the ECU memory by addresses.
|
||||||||||||||||||||||||||||
| ECU | Mapping | — | Source Name | Name of the source page to be used for the address mapping in Defined Pages mode. | ||||||||||||||||||||||||||||
| ECU | Mapping | — | Source | Logical page number of the source page to be used for the address mapping in Defined Pages mode. | ||||||||||||||||||||||||||||
| ECU | Mapping | — | Target | Logical page number of the target page to be used for the address mapping in Defined Pages mode. | ||||||||||||||||||||||||||||
| ECU | Mapping | — | Target Name | Name of the target page to be used for the address mapping in Defined Pages mode. | ||||||||||||||||||||||||||||
| ECU | Misc | — | Timing Factor | Returns the used timing factor, which you can use to increase XCP or CCP command timeout values. For details on the default Command Timeout values, refer to the XCP or CCP Protocol Specification. | ||||||||||||||||||||||||||||
| Measurement | — | — | Address | Returns the address part of the address of the selected Measurement in the memory of the control unit. | ||||||||||||||||||||||||||||
| Measurement | — | — | Extension | Returns the extension part of the address. This optional parameter may contain additional address information defined in the A2L database. For instance, it can be used to distinguish different address spaces of an ECU (multi-microcontroller devices). | ||||||||||||||||||||||||||||
| Measurement | — | — | Data Type | Returns the data type of the Measurement task. | ||||||||||||||||||||||||||||
| Measurement | — | — | Byte Order | Returns the specified byte order:
0—Intel format Bytes are in little-endian order, with least-significant bit first. 1—Motorola format Bytes are in big-endian order, with most-significant bit first. |
||||||||||||||||||||||||||||
 | Measurement | — | — | Maximum | Returns the maximum value of the Measurement. | ||||||||||||||||||||||||||||
| Measurement | — | — | Minimum | Returns the minimum value of the Measurement. | ||||||||||||||||||||||||||||
| Measurement | — | — | Read Only? | Returns TRUE if the selected Measurement is read only and can only be accessed through MC DAQ Read.vi, or returns FALSE if the Measurement can be accessed through MC Measurement Write.vi as well. | ||||||||||||||||||||||||||||
| Measurement | Scaling | — | Factor | Returns the scaling factor defined for this Measurement in the A2L database. | ||||||||||||||||||||||||||||
| Measurement | Scaling | — | Offset | Returns the scaling offset defined for this Measurement in the A2L database. | ||||||||||||||||||||||||||||
| Measurement | Scaling | — | Type | Returns the scaling type defined for this Measurement in the A2L database.
0: Unknown The type of the scaling could not be derived from the A2L file content. 1: Rational Function The related scaling is based on a rational function of second order. This also covers the linear scaling, given by factor and offset. 2: Enumeration Text The related scaling is based on the COMPU_VTAB keyword within the A2L file.
3: Range Text The related scaling is based on the COMPU_VTAB_RANGE keyword within the A2L file.
4: Formula The related scaling is based on the FORMULA keyword within the A2L file, using a free formula to calculate the values. 5: Table (Using Interpolation) The related scaling is based on the TAB_INTP keyword within the A2L file, using interpolation between x-y pairs. 6: Table (Without Interpolation) The related scaling is based on the TAB_NOINTP keyword within the A2L file, using x-y pairs without interpolation. |
||||||||||||||||||||||||||||
 | Measurement | Scaling | — | Text Values | If the scaling type is 2 = Enumeration Text or 3 = Range Text, you can use this property to request the list of text values that can be converted into raw values. | ||||||||||||||||||||||||||||
| Measurement | — | — | Is Virtual? | Returns whether the Measurement is virtual. Virtual Measurements are not transmitted by the ECU but are calculated in the application. They return an error when opened in a DAQ list. | ||||||||||||||||||||||||||||
| Measurement | — | — | Unit | Returns the unit string defined for this Measurement in the A2L database. | ||||||||||||||||||||||||||||
| Measurement | — | — | Comment | Returns the Comment string of the selected Measurement. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Address | Returns the address of the selected Characteristic in the memory of the ECU. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Extension | Returns additional address information. For instance it can be used, to distinguish different address spaces of an ECU (multi-microcontroller devices). | ||||||||||||||||||||||||||||
| Characteristic | — | — | Data Type | Returns the data type of the Characteristic. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Byte Order | Returns the specified byte order:
0—Intel format Bytes are in little-endian order, with least-significant bit first. 1—Motorola format Bytes are in big-endian order, with most-significant bit first. |
||||||||||||||||||||||||||||
| Characteristic | — | — | Dimension | Returns the dimension of a Characteristic.
0—0 dimension The Characteristic can be accessed (read/write) through a double value. 1—1 dimension The Characteristic can be accessed (read/write) through a one-dimensional array of double values. 2—2 dimensions The Characteristic can be accessed (read/write) through a two-dimensional array of double values. |
||||||||||||||||||||||||||||
| Characteristic | Scaling | — | Factor | Returns the scaling factor defined for this Characteristic in the A2L database. | ||||||||||||||||||||||||||||
| Characteristic | Scaling | — | Offset | Returns the scaling offset defined for this Characteristic in the A2L database. | ||||||||||||||||||||||||||||
| Characteristic | Scaling | — | Type | Returns the scaling type defined for this Characteristic in the A2L database.
0: Unknown The scaling type could not be derived from the A2L file content. 1: Rational Function The related scaling is based on a rational function of second order. This covers also the linear scaling, given by factor and offset. 2: Enumeration Text The related scaling is based on the COMPU_VTAB keyword within the A2L file.
3: Range Text The related scaling is based on the COMPU_VTAB_RANGE keyword within the A2L file.
4: Formula The related scaling is based on the FORMULA keyword within the A2L file, using a free formula to calculate the values. 5: Table (Using Interpolation) The related scaling is based on the TAB_INTP keyword within the A2L file, using interpolation between x-y pairs. 6: Table (Without Interpolation) The related scaling is based on the TAB_NOINTP keyword within the A2L file, using x-y pairs without interpolation. |
||||||||||||||||||||||||||||
| Characteristic | Scaling | — | Text Values | If the scaling type is 2 = Enumeration Text or 3 = Range Text, you can use this property to request the list of text values that can be converted into raw values. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Sizes | Returns the array Sizes for X and Y direction of the Characteristic. | ||||||||||||||||||||||||||||
| Characteristic | — | — | X Axis | Returns X-Axis values on which the Characteristic is defined. It is valid if the dimension of the selected Characteristic is 1 or 2. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Y Axis | Returns Y-Axis values on which the Characteristic is defined. It is valid if the dimension of the selected Characteristic is 2. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Maximum | Returns the maximum value of the Characteristic. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Minimum | Returns the minimum value of the Characteristic. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Read Only? | Returns if a Characteristic is set to Read Only. In this case it is not allowed to call MC Characteristic Write.vi for this Characteristic. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Unit | Returns the unit string defined for this Characteristic in the A2L database. | ||||||||||||||||||||||||||||
| Characteristic | — | — | Comment | Returns the Comment string of the selected Characteristic. | ||||||||||||||||||||||||||||
| Function | — | — | Comment | Returns the Comment string of the selected Function. | ||||||||||||||||||||||||||||
| Group | — | — | IsRoot | Returns whether the selected Group is a root-level Group entity. | ||||||||||||||||||||||||||||
| Group | — | — | Comment | Returns the Comment string of the selected Group. | ||||||||||||||||||||||||||||
| DAQ | — | — | Mode | Returns the selected I/O mode for the M&C Measurement task.
0—DAQ List The data is transmitted by the ECU based on an event channel, which can be equidistant in time or sporadic. The data can be read back with the MC DAQ Read.vi as Single point data using sample rate = 0, or as a waveform using a sample rate > 0. Input channel data is received from the DAQ messages. Use MC DAQ Read.vi to obtain input samples as single-point, array, or waveform. 1—Polling In this mode the data from the Measurement task is uploaded from the ECU whenever MC DAQ Read.vi is called. |
||||||||||||||||||||||||||||
| DAQ | — | — | Sample Rate | Returns the selected Sample Rate in Hz for the M&C Measurement task, which may be obtained with MC DAQ Initialize.vi. | ||||||||||||||||||||||||||||
| DAQ | — | — | # Channels | Returns the number of (scaled) channels initialized in a DAQ channel list of a M&C Measurement task. # Channels and # Raw Channels provide the number of array entries required when using MC DAQ Read.vi. | ||||||||||||||||||||||||||||
| DAQ | — | — | # Raw Channels | Returns the number of raw channels initialized in a DAQ channel list of a M&C Measurement task. # Channels and # Raw Channels provide the number of array entries required when using MC DAQ Read.vi. | ||||||||||||||||||||||||||||
| DAQ | — | — | Event Channel Name | Returns the selected event channel name to which the Measurement task is assigned. | ||||||||||||||||||||||||||||
| DAQ | — | — | Prescaler | Returns the prescaling factor which is used to reduce the desired transmission frequency of the associated DAQ list. | ||||||||||||||||||||||||||||
| DAQ | — | — | Samples Pending | Returns the number of samples available to be read using MC DAQ Read.vi. If you set the number of samples to read input of MC DAQ Read.vi to this value, DAQ Read returns immediately without waiting. This property applies only to tasks initialized with mode of Input and sample rate greater than zero. For all other configurations, it returns an error. If this property is queried before the DAQ list is started, it always returns zero. Start the DAQ list first with MC DAQ Start Stop.vi before you query this property. | ||||||||||||||||||||||||||||
| DAQ | — | — | Time Since Last Frame | Indicates how much time has passed (in seconds) since the measurement session received the last DAQ frame. You can use this property to restart the measurement when the value increases a threshold (for example, 0.5 seconds), assuming the ECU stopped sending DAQ messages and must be restarted.
This property is read only. |
||||||||||||||||||||||||||||
| DAQ | — | — | Num PIDs | Indicates the number of PIDs (frames) used in the DAQ session. If the session does not use DAQ, the value is 0.
The number of PIDs is only valid after the DAQ list has been transmitted to the ECU, otherwise the returned value is 0. For example, you can call MC DAQ Start Stop.vi with the mode Transmit DAQ List to ECU after MC DAQ Initialize.vi, before reading this property. This property is read only. |
||||||||||||||||||||||||||||
| DAQ | CCP | — | DTO Id | Returns the DTO ID, which is used by the ECU to send DAQ list data to the CCP master. If bit 31 (hex 0x80000000) of the value is set, the value is considered an extended CAN identifier (29-bit). | ||||||||||||||||||||||||||||
| DAQ | CCP | — | DTO Task | Returns the NI-CAN task reference for the Data Transmission Object (the CAN task reading frames from the slave device). For example, you might use this to set CAN properties for this task. Handle with extreme care, as those properties are usually set correctly by the ECU M&C Toolkit itself. | ||||||||||||||||||||||||||||
| DAQ | XCP | — | Timing Source | Reads the DAQ Timing Source property value. The default is Automatic. Values are:
|
||||||||||||||||||||||||||||
| DAQ List | — | — | Name | Name of the DAQ list (measurement source). Pass the DAQ list number converted to a string in the Name parameter of Get Property. The available DAQ list number can be obtained by the ECU DAQ List Numbers property. | ||||||||||||||||||||||||||||
| DAQ List | — | — | Display Identifier | Optional property you can use as a display name as an alternative to the DAQ List Name property. | ||||||||||||||||||||||||||||
| DAQ List | — | — | CAN ID | Returns the CAN ID for the specified DAQ list if mcPropDAQList_CANIdSelectMode == CAN_ID_FIXED. | ||||||||||||||||||||||||||||
| DAQ List | — | — | CAN ID Select Mode |
Returns the condition for selecting the CAN ID for the specified DAQ list.
0—CAN_ID_FIXED The CAN Identifier is a predefined fixed number. 1—CAN_ID_VARIABLE The CAN Identifier is a variable number. 2—CAN_ID_DTO_ID The CAN Identifier is the same as the DTO identifier. |
||||||||||||||||||||||||||||
| DAQ List | — | — | Event Channels | Returns a list of event channel numbers that can be used with the given DAQ list. The DAQ list is determined by the name input containing a string representation of the decimal DAQ list number, e.g., '2.' | ||||||||||||||||||||||||||||
| DAQ List | — | — | Excluded DAQ Lists | Returns an array containing the numbers of DAQ lists not working together with the current DAQ list. | ||||||||||||||||||||||||||||
| DAQ List | — | — | First PID | Returns the first Packet ID for the specified DAQ list. | ||||||||||||||||||||||||||||
| DAQ List | — | — | Max Length | Returns the maximal length of the DAQ list. | ||||||||||||||||||||||||||||
| DAQ List | — | — | Reduction Allowed | Returns whether or not the specified DAQ list allows reduction. | ||||||||||||||||||||||||||||
| Version | — | — | Major | Returns the major version of the ECU M&C software, such as the 1 in version 1.2.5. | ||||||||||||||||||||||||||||
| Version | — | — | Minor | Returns the minor version of the ECU M&C software, such as the 2 in version 1.2.5. | ||||||||||||||||||||||||||||
| Version | — | — | Update | Returns the update version of the ECU M&C software, such as the 5 in version 1.1.5. | ||||||||||||||||||||||||||||
| Version | — | — | Build | Returns the build number of the ECU M&C software. This number applies to the Development, Alpha, and Beta phases only, and should be ignored for the Release phase. | ||||||||||||||||||||||||||||
| Version | — | — | Comment | Returns a comment string for the ECU M&C software. If you received a custom release of ECU M&C from NI, this comment often describes special features of the release. | ||||||||||||||||||||||||||||
