Appendix U – J1939 Import/Export description template specifiers and variables
specifier name | category | description |
${pgn.address} | description: | numerical number of the PGN. |
category: | mandatory | |
value range: | 0x0 - 0xFFFFFFFF | |
${pgn.name} | description: | name of the object for the documentation in exported documents. If no name is specified the Communication Creator builds own names: · PGN_<address> |
category: | Optional | |
value range: | String | |
${pgn.description} | description: | documentation of the object. |
category: | optional | |
value range: | String | |
${pgn.multipacket} | description: | defines if pgn uses multipacket messaging |
category: | optional | |
value range: | false – multipacket messages are not used true – multipacket messages are used
Default: false | |
${pgn.packetLength} | description: | defines the PGN message length |
category: | optional | |
value range: | Integer
Default: 8 | |
${pgn.dataHandlingCtrl} | description: | defines the active direction in which the stack is handling this PGN |
category: | optional | |
value range: | DHC_NONE - no direction specified DHC_RECEIVE - sets active direction to receive DHC_SEND - sets active direction to send DHC_RECEIVE_SEND - sets active direction to receive and send
Default: DHC_NONE | |
${pgn.receiveFctName} | description: | defines a function stub for receiving this PGN |
category: | optional | |
value range: | String
Default: <empty> | |
${pgn. onlyGenReceiveFctName} | description: | defines if only an entry with the name of the receive function is generated. |
category: | optional | |
value range: | false – complete function is generated true – only function name without any content is generated
Default: false | |
${pgn.sendFctName} | description: | defines a function stub for send this PGN |
category: | optional | |
value range: | String | |
${pgn.onlyGenSendFctName} | description: | defines if only an entry with the name of the send function is generated. |
category: | optional | |
value range: | false – complete function is generated true – only function name without any content is generated
Default: false | |
${pgn.CName} | description: | Defines a compiler-define for the PGN number of the object in decimal format. |
category: | optional | |
value range: | String with C-syntax | |
${pgn .suffixForFunctionNames} | description: | The text from this settin will be used as suffix for the function names of this PGN when selecting a data direction of this PGN via the GUI. |
category: | optional | |
value range: | String with C-syntax |
Table 54: Specifiers for import/export description templates
name in code | type | description |
${projectName} | var | project file name without file extension |
${exampleJ1939LogoFilePath} | var | file path for CC-Link IE TSN logo |
${enableIndRange1} | var | value of setting: Exported document > Enable 1st PGN range |
${enableIndRange2} | var | value of setting: Exported document > Enable 2nd PGN range |
${allPgns} | list | list that contains a list that contains all documented PGNs |
${modDate} | var | date of generation with format: yyyy/MM/dd |
${modTime} | var | time of generation with format: HH:mm:ss |
${projectFilePath} | var | full path of project |
Table 55: J1939 Variables and lists for use in export description templates