0
edits
Changes
Created page with "__TOC__ ==Manual CAN Settings (For '''Manual CAN''' functionality)== ---- right To use Manual CAN protocol user should '''select Manual CAN p..."
__TOC__
==Manual CAN Settings (For '''Manual CAN''' functionality)==
----
[[Image:Manual CAN protocol.gif|right]]
To use Manual CAN protocol user should '''select Manual CAN protocol in CAN I/O tab'''. Then user can configure CAN parameters in Manual CAN settings tab.
{| class="wikitable" style="border-style: solid; border-width: 0px;"
|+
| style="width: auto; text-align: left; background: #F6F6FB;" |'''NOTE!'''
| style="width: auto; text-align: left; background: #F6F6FB;" |''Manual CAN'' can be tested on FW 55.00.09.rev.04 or newer
|}
The main benefit, of using Manual CAN functionality is that user is able to read data via CAN BUS without requiring additional CAN protocol development from the device's firmware side. To read data with this functionality, the user must have:
*<font color="red">'''TFT100 device with CAN interface''';</font>
*<font color="red">'''55.00.09.Rev.04 or newer firmware''';</font>
*<font color="red">'''Transport with CAN interface''';</font>
*<font color="red">'''Transport's CAN communication protocol (with information about frames, parameters, ID's, baud rate)'''.</font>
===Manual CAN Baudrate settings===
----
{| style="width: 100%"
|[[Image:Manual CAN Baudrate.png|right]]
User can select Manual CAN baud rate. The baud rate is the rate at which information is transferred in a communication channel. Selecting incorrect baud rate may lead to:
* Receiving inaccurate data;
* Not receiving any data at all.
|}
===Manual CAN I/O Settings===
----
User can configure 30 Manual CAN I/O element by setting CAN Type, Data Mask, CAN ID, Request ID, Request Period, Request Data Length parameters. Each CAN I/O has its own parameters and can be configured independently.
[[Image:Manual CAN IO Settings.png]]
*<b>Manual CAN Type parameter</b> - defines which CAN ID type will be received and requested (Standard - 11bit, Extended - 29bit).
*<b>CAN ID/PGN</b> - depends on CAN Type parameter and defines which CAN ID will be received by device.
*<b>Data Mask</b> - defines which data mask will be applied to received CAN data. CAN Data mask parameter is 8byte hex value. Displayed data value will be Received Data Value AND Data Mask. For example, if received data is 0x1122334455667788 and data mask is FFFF00000000FFFF displayed value will be 0x1122000000007788. In other words - Data Mask parameter defines which data will be taken from the specific frame.
*<b>Endianess</b> - Little or Big depends on CAN communication protocol. The value should be provided in the protocol description. In most cases the the standard value is Little.
*<b>Request ID/PGN</b> - depends on CAN Type parameter and defines which CAN ID will be requested by device.
*<b>RTR</b> - Remote Transmission Request,is the choice if data frame needs to be send (if disabled) and if data frame needs to be requested (if enabled).
*<b>Payload</b> - defines data bytes, which are send if RTR disabled.
*<b>Request Period</b> - defines how often request will be send. If 0 is selected - ID will not be requested.
*<b>Request data length</b> - defines data length of requested ID.<br></br>
[[File:Alert.png|30px]]<b>Note:</b> from the FW 55.01.02.Rev.01 it is possible to configure Speed source and Ignition source separately from other Manual CAN parameters so that the values can be used in other features, for example Speed from the Manual CAN can be used as a Speed Source.
'''More information can be found [[Manual CAN Speed & Ignition source explained|here]].'''[[Image:Manual CAN Ignition Speed source.png]]
{| class="wikitable" style="border-style: solid; border-width: 0px;"
|+
| style="width: auto; text-align: left;" |[[File:Alert.png|30px]]
| style="width: auto; text-align: left;" |Instructions on how to configure Manual CAN functionality can be found in <b>[[How to configure Manual CAN I/O parameters|here]]</b>.
|-
| style="width: auto; text-align: left;" |[[File:Alert.png|30px]]
| style="width: auto; text-align: left;" |Instructions on how to configure Manual CAN Commands can be found in <b>[[How to configure Manual CAN Commands?|here]]</b>.
|}
==Manual CAN Settings (For '''Manual J1939''' functionality)==
----
[[Image:Manual J1939.gif|right]]
To use '''Manual J1939''' feature user should select '''Manual J1939''' protocol in CAN I/O tab. Then user can configure CAN parameters in Manual CAN settings tab.
{| class="wikitable" style="border-style: solid; border-width: 0px;"
|+
| style="width: auto; text-align: left; background: #F6F6FB;" |'''NOTE!'''
| style="width: auto; text-align: left; background: #F6F6FB;" |''Manual J1939'' can be tested on FW 55.00.09.rev.08 or newer
|}
'''Manual J1939''' protocol support was added to TFT100 device's firmware as an addition to '''Default J1939''' protocol in case the given '''Default J1939''' I/O elements are not enough. With this functionality, the user is able to configure which '''J1939''' parameters he would like to read from the transport that uses '''J1939''' protocol. To read data with this functionality, the user must have:
*<font color="red">'''TFT100 device with CAN interface''';</font>
*<font color="red">'''55.00.09.Rev.08 or newer firmware''';</font>
*<font color="red">'''Machinery with CAN interface, which communicates via J1939 protocol''';</font>
*<font color="red">'''Machinery's J1939 protocol documentation (with required SPN's and PGN's)'''.</font>
===Manual CAN Baudrate settings===
----
{| style="width: 100%"
|[[Image:Manual CAN Baudrate.png|right]]
User can select Manual CAN baud rate (for '''Manual J1939''' this part is configured the same way as for '''Manual CAN''' functionality). The baud rate is the rate at which information is transferred in a communication channel. Selecting incorrect baud rate may lead to:
* Receiving inaccurate data;
* Not receiving any data at all.
|}
===Manual CAN I/O Settings===
----
User can configure 29 Manual CAN (J1939) I/O elements by setting CAN Type, Data Mask, PGN, Request PGN, Request Period parameters. Each CAN I/O has its own parameters and can be configured independently.
[[Image:Manual J1939 IO.png]]
*<b>CAN Type</b> parameter - enables or disables current Manual CAN (J1939) element.
*<b>CAN ID/PGN</b> - defines which PGN (Parameter Group Number) will be received by device. '''For J1939,''' '''PGN has to be configured in decimal, not hex.'''
*<b>Data Mask</b> parameter - defines which data mask will be applied to received CAN data. CAN Data mask parameter is 8byte hex value. Displayed data value will be Received Data Value AND Data Mask. For example, if received data is 0x1122334455667788 and data mask is FFFF00000000FFFF displayed value will be 0x1122000000007788. In other words - Data Mask parameter defines which data will be taken from the specific frame.
*<b>Endianess</b> - Little or Big depends on CAN communication protocol. The value should be provided in the protocol description. In most cases the the standard value is Little.
*<b>Req ID/PGN</b> - defines which PGN will be requested by device.
*<b>Request DA</b> - Request destination address.
*<b>Request Period</b> - defines how often request will be send. If 0 is selected - ID/PGN will not be requested.
==Important note!==
<b>Send Period details</b>
#If only CAN commands are being used:
#*Each command <i>period increases</i> approximately by <b>50 ms</b>.
#*Enabling all messages with the same period <i>adds delay</i> of <b>500-550 ms</b><br><code>Example: 100 ms Period selected for all commands - each command sending could take up to 550 ms.</code>
#If CAN Commands will be used together with CAN data reading:
#*CAN DATA reading <i>increase CAN commands period</i> approximately by <b>50 ms</b>.<br><code>Example: One command configured with 200 ms period - command sending could take up to 250 ms.</code>
#*Using all CAN commands <i>period increase</i> approximately by <b>150 ms</b>.
#CAN Commands will be used together with frequent (less than 5 seconds) records saving/sending:
#*One command <i>period increases</i> approximately by <b>100 ms</b>.
#*If all are commands used - <i>period increases</i> approximately by <b>200 ms</b>.
#CAN Commands will be used together with CAN reading and frequent (less than 5 seconds) records saving/sending:
#*Using one command <i>increases period</i> by approximately <b>250 ms</b><br><code>Example: One command configured with 50 ms period could have delay up to 300 ms.</code>
#*Enabling all commands could drastically <i>increase delay</i> - sending could take up to <b>1.5 s</b> (All commands configured with 100 ms period).
<font color="#0054A6"><b>We strongly advise:</b></font>
#If all commands are necessary with certain period - keep all commands with same sending period.
#If one particular command (ex. Heartbeat) is necessary to be sent with specific period - increase particular command period and increase other commands period as high as possible.<br><br><code>For example: Heartbeat 50 ms, all other commands 1000 ms.</code><br>That will give particular command priority, but other commands will be sent with a bigger delay than configured.<br><br>
#Do not leave any enabled CAN reading parameters if CAN reading is not used.
#Keep Data Acquisition settings with higher than 15 seconds.
{| class="wikitable" style="border-style: solid; border-width: 0px;"
|+
|-
| style="width: auto; text-align: left; background: #F6F6FB;" | '''NOTE!'''
| style="width: auto; text-align: left; background: #F6F6FB;" | <b>Send Period details</b><br>Records could drastically increase CAN command sending period as records could be generated every second by configured Features records, Data Acquisition settings or IO elements operands.<br>Each particular case has different affect for CAN Command delay, that depends on configuration and in case of issue should be investigated individually.
|}
[[Category:TFT100 Configuration]]
==Manual CAN Settings (For '''Manual CAN''' functionality)==
----
[[Image:Manual CAN protocol.gif|right]]
To use Manual CAN protocol user should '''select Manual CAN protocol in CAN I/O tab'''. Then user can configure CAN parameters in Manual CAN settings tab.
{| class="wikitable" style="border-style: solid; border-width: 0px;"
|+
| style="width: auto; text-align: left; background: #F6F6FB;" |'''NOTE!'''
| style="width: auto; text-align: left; background: #F6F6FB;" |''Manual CAN'' can be tested on FW 55.00.09.rev.04 or newer
|}
The main benefit, of using Manual CAN functionality is that user is able to read data via CAN BUS without requiring additional CAN protocol development from the device's firmware side. To read data with this functionality, the user must have:
*<font color="red">'''TFT100 device with CAN interface''';</font>
*<font color="red">'''55.00.09.Rev.04 or newer firmware''';</font>
*<font color="red">'''Transport with CAN interface''';</font>
*<font color="red">'''Transport's CAN communication protocol (with information about frames, parameters, ID's, baud rate)'''.</font>
===Manual CAN Baudrate settings===
----
{| style="width: 100%"
|[[Image:Manual CAN Baudrate.png|right]]
User can select Manual CAN baud rate. The baud rate is the rate at which information is transferred in a communication channel. Selecting incorrect baud rate may lead to:
* Receiving inaccurate data;
* Not receiving any data at all.
|}
===Manual CAN I/O Settings===
----
User can configure 30 Manual CAN I/O element by setting CAN Type, Data Mask, CAN ID, Request ID, Request Period, Request Data Length parameters. Each CAN I/O has its own parameters and can be configured independently.
[[Image:Manual CAN IO Settings.png]]
*<b>Manual CAN Type parameter</b> - defines which CAN ID type will be received and requested (Standard - 11bit, Extended - 29bit).
*<b>CAN ID/PGN</b> - depends on CAN Type parameter and defines which CAN ID will be received by device.
*<b>Data Mask</b> - defines which data mask will be applied to received CAN data. CAN Data mask parameter is 8byte hex value. Displayed data value will be Received Data Value AND Data Mask. For example, if received data is 0x1122334455667788 and data mask is FFFF00000000FFFF displayed value will be 0x1122000000007788. In other words - Data Mask parameter defines which data will be taken from the specific frame.
*<b>Endianess</b> - Little or Big depends on CAN communication protocol. The value should be provided in the protocol description. In most cases the the standard value is Little.
*<b>Request ID/PGN</b> - depends on CAN Type parameter and defines which CAN ID will be requested by device.
*<b>RTR</b> - Remote Transmission Request,is the choice if data frame needs to be send (if disabled) and if data frame needs to be requested (if enabled).
*<b>Payload</b> - defines data bytes, which are send if RTR disabled.
*<b>Request Period</b> - defines how often request will be send. If 0 is selected - ID will not be requested.
*<b>Request data length</b> - defines data length of requested ID.<br></br>
[[File:Alert.png|30px]]<b>Note:</b> from the FW 55.01.02.Rev.01 it is possible to configure Speed source and Ignition source separately from other Manual CAN parameters so that the values can be used in other features, for example Speed from the Manual CAN can be used as a Speed Source.
'''More information can be found [[Manual CAN Speed & Ignition source explained|here]].'''[[Image:Manual CAN Ignition Speed source.png]]
{| class="wikitable" style="border-style: solid; border-width: 0px;"
|+
| style="width: auto; text-align: left;" |[[File:Alert.png|30px]]
| style="width: auto; text-align: left;" |Instructions on how to configure Manual CAN functionality can be found in <b>[[How to configure Manual CAN I/O parameters|here]]</b>.
|-
| style="width: auto; text-align: left;" |[[File:Alert.png|30px]]
| style="width: auto; text-align: left;" |Instructions on how to configure Manual CAN Commands can be found in <b>[[How to configure Manual CAN Commands?|here]]</b>.
|}
==Manual CAN Settings (For '''Manual J1939''' functionality)==
----
[[Image:Manual J1939.gif|right]]
To use '''Manual J1939''' feature user should select '''Manual J1939''' protocol in CAN I/O tab. Then user can configure CAN parameters in Manual CAN settings tab.
{| class="wikitable" style="border-style: solid; border-width: 0px;"
|+
| style="width: auto; text-align: left; background: #F6F6FB;" |'''NOTE!'''
| style="width: auto; text-align: left; background: #F6F6FB;" |''Manual J1939'' can be tested on FW 55.00.09.rev.08 or newer
|}
'''Manual J1939''' protocol support was added to TFT100 device's firmware as an addition to '''Default J1939''' protocol in case the given '''Default J1939''' I/O elements are not enough. With this functionality, the user is able to configure which '''J1939''' parameters he would like to read from the transport that uses '''J1939''' protocol. To read data with this functionality, the user must have:
*<font color="red">'''TFT100 device with CAN interface''';</font>
*<font color="red">'''55.00.09.Rev.08 or newer firmware''';</font>
*<font color="red">'''Machinery with CAN interface, which communicates via J1939 protocol''';</font>
*<font color="red">'''Machinery's J1939 protocol documentation (with required SPN's and PGN's)'''.</font>
===Manual CAN Baudrate settings===
----
{| style="width: 100%"
|[[Image:Manual CAN Baudrate.png|right]]
User can select Manual CAN baud rate (for '''Manual J1939''' this part is configured the same way as for '''Manual CAN''' functionality). The baud rate is the rate at which information is transferred in a communication channel. Selecting incorrect baud rate may lead to:
* Receiving inaccurate data;
* Not receiving any data at all.
|}
===Manual CAN I/O Settings===
----
User can configure 29 Manual CAN (J1939) I/O elements by setting CAN Type, Data Mask, PGN, Request PGN, Request Period parameters. Each CAN I/O has its own parameters and can be configured independently.
[[Image:Manual J1939 IO.png]]
*<b>CAN Type</b> parameter - enables or disables current Manual CAN (J1939) element.
*<b>CAN ID/PGN</b> - defines which PGN (Parameter Group Number) will be received by device. '''For J1939,''' '''PGN has to be configured in decimal, not hex.'''
*<b>Data Mask</b> parameter - defines which data mask will be applied to received CAN data. CAN Data mask parameter is 8byte hex value. Displayed data value will be Received Data Value AND Data Mask. For example, if received data is 0x1122334455667788 and data mask is FFFF00000000FFFF displayed value will be 0x1122000000007788. In other words - Data Mask parameter defines which data will be taken from the specific frame.
*<b>Endianess</b> - Little or Big depends on CAN communication protocol. The value should be provided in the protocol description. In most cases the the standard value is Little.
*<b>Req ID/PGN</b> - defines which PGN will be requested by device.
*<b>Request DA</b> - Request destination address.
*<b>Request Period</b> - defines how often request will be send. If 0 is selected - ID/PGN will not be requested.
==Important note!==
<b>Send Period details</b>
#If only CAN commands are being used:
#*Each command <i>period increases</i> approximately by <b>50 ms</b>.
#*Enabling all messages with the same period <i>adds delay</i> of <b>500-550 ms</b><br><code>Example: 100 ms Period selected for all commands - each command sending could take up to 550 ms.</code>
#If CAN Commands will be used together with CAN data reading:
#*CAN DATA reading <i>increase CAN commands period</i> approximately by <b>50 ms</b>.<br><code>Example: One command configured with 200 ms period - command sending could take up to 250 ms.</code>
#*Using all CAN commands <i>period increase</i> approximately by <b>150 ms</b>.
#CAN Commands will be used together with frequent (less than 5 seconds) records saving/sending:
#*One command <i>period increases</i> approximately by <b>100 ms</b>.
#*If all are commands used - <i>period increases</i> approximately by <b>200 ms</b>.
#CAN Commands will be used together with CAN reading and frequent (less than 5 seconds) records saving/sending:
#*Using one command <i>increases period</i> by approximately <b>250 ms</b><br><code>Example: One command configured with 50 ms period could have delay up to 300 ms.</code>
#*Enabling all commands could drastically <i>increase delay</i> - sending could take up to <b>1.5 s</b> (All commands configured with 100 ms period).
<font color="#0054A6"><b>We strongly advise:</b></font>
#If all commands are necessary with certain period - keep all commands with same sending period.
#If one particular command (ex. Heartbeat) is necessary to be sent with specific period - increase particular command period and increase other commands period as high as possible.<br><br><code>For example: Heartbeat 50 ms, all other commands 1000 ms.</code><br>That will give particular command priority, but other commands will be sent with a bigger delay than configured.<br><br>
#Do not leave any enabled CAN reading parameters if CAN reading is not used.
#Keep Data Acquisition settings with higher than 15 seconds.
{| class="wikitable" style="border-style: solid; border-width: 0px;"
|+
|-
| style="width: auto; text-align: left; background: #F6F6FB;" | '''NOTE!'''
| style="width: auto; text-align: left; background: #F6F6FB;" | <b>Send Period details</b><br>Records could drastically increase CAN command sending period as records could be generated every second by configured Features records, Data Acquisition settings or IO elements operands.<br>Each particular case has different affect for CAN Command delay, that depends on configuration and in case of issue should be investigated individually.
|}
[[Category:TFT100 Configuration]]
