0
edits
Changes
Created page with "__TOC__ ==CAN Protocol== right|260px '''CAN I/O''' category offers users an ability to select one of CAN protocols to read specific data through TF..."
__TOC__
==CAN Protocol==
[[Image:CAN protocol.png|right|260px]]
'''CAN I/O''' category offers users an ability to select one of CAN protocols to read specific data through TFT100 CAN interface.<br>
TFT100 currently has 6 implemented CAN protocols and DEBUG function:<br>
*Bosch CAN Powertrain
*Askoll
*Default J1939
*Manual CAN
*Manual J1939
*FLEX
*Debug feature
'''Bosch''', '''Askoll''', '''Default J1939''' and <b>FLEX</b> CAN protocols come with specific CAN I/O parameters that can be read, monitored, configured and their values sent to the configured server.<br>
'''Manual CAN''' and '''Manual J1939''' protocols do not include dedicated specific I/O parameters however it welcomes user to configure what has to be read from the transport based on their transport CAN communication protocol.
===Bosch CAN Powertrain===
<hr>
{| style="width: 100%"
|[[Image:Bosch CAN Powertrain protocol.gif|right]]
'''Bosch CAN Powertrain protocol''' allows users to read parameters from their transport, if the transport uses ''Bosch'' motor. The protocol is enabled by selecting '''Bosch''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side.
|}
====Bosch CAN Powertrain I/O====
Specific '''Bosch CAN Powertrain''' I/O parameters were implemented to our device's firmware that can be read, configured and sent to the server just like regular I/O parameters. The parameters that were added can be seen in the image below.<br>
{| 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;" |The parameters were added upon clients' request. ''Bosch'' CAN protocol contains way more parameters that can be added by us if necessary.
|}
[[Image:Bosch CAN Powertrain IO.gif]]<br><br>
*<code>The '''AVL ID''' list of '''Bosch CAN Powertrain''' parameters can be found in [[Full_AVL_ID_List#CAN_BOSCH_I.2FO_elements|here]].</code><br>
*<code>'''SMS/GPRS commands''' that were developed for '''Bosch CAN Powertrain''' protocol can be found in [[TFT100_SMS/GPRS_Commands#CAN_Commands|here]].</code>
===Askoll===
<hr>
{| style="width: 100%"
|[[Image:Askoll protocol.gif|right]]
'''Askoll''' CAN protocol allows users to read parameters from their e-scooters manufactured by ''Askoll''. The protocol is enabled by selecting '''Askoll''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side.
|}
====Askoll I/O====
Specific '''Askoll''' I/O parameters were implemented to our device's firmware that can be read, configured and sent to the server just like regular I/O parameters. The parameters that were added can be seen in the image below.<br>
[[Image:Askoll CAN IO.gif]]<br><br>
*<code>The '''AVL ID''' list of '''Askoll''' parameters can be found in [[Full_AVL_ID_List#CAN_Askoll_I.2FO_elements|here]].</code><br>
*<code>'''SMS/GPRS commands''' that were developed for '''Askoll''' protocol can be found in [[TFT100_SMS/GPRS_Commands#CAN_Commands|here]].</code>
===Default J1939===
<hr>
{| style="width: 100%"
|[[Image:Default J1939 ss.png|right]]
'''Default J1939''' protocol support was added to TFT100 device's firmware since it is one of the most popular CAN protocols used in heavy duty (i.e. ''forklifts'') machinery industry. If the machinery communicates via J1939 CAN protocol, the device will be able to read provided parameter's data and transmit readings to your configured server. To use '''Default J1939''' CAN protocol user should select '''Default J1939''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side.
{| 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;" |''Default J1939'' can be tested on FW 55.00.09.rev.04 or newer
|}
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">'''Machinery with CAN interface, which communicates via J1939 protocol'''.</font>
|}
====Default J1939 I/O====
All '''Default J1939''' CAN I/O parameters can be configured like standard I/O parameters. User can set priority, high level, low level parameter limits, eventual record, operand, SMS text and number to which SMS notification would be sent.
[[Image:Default J1939 IO.gif]]<br><br>
*<code>The '''AVL ID''' list of '''Default J1939''' parameters can be found in [[Full_AVL_ID_List#Default_J1939_I.2FO_elements|here]].</code>
===Manual CAN===
<hr>
[[Image:Manual CAN protocol.gif|right]]
The '''Manual CAN''' protocol is enabled by selecting '''Manual CAN''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side. Then user can configure CAN parameters in [[TFT100_Manual_CAN_settings|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 I/O====
Up to 30 I/O parameters (Priority, Event Only, Operand, Send SMS To, SMS text) for '''Manual CAN''' functionality can be configured in CAN I/O 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;" |It is important to not forget that [[TFT100_Manual_CAN_settings|Manual CAN Settings]] tab '''must be configured''' as well.
|}
[[Image:Manual CAN IO.gif]]<br><br>
*<code>The '''AVL ID''' list of '''Manual CAN''' parameters can be found in [[Full_AVL_ID_List#Manual_CAN_I.2FO_elements|here]].</code><br>
*<code>Full '''Manual CAN''' and '''Manual CAN Settings''' description can be found in [[TFT100_Manual_CAN_settings|here]].</code>
*<code>Example on '''how to configure Manual CAN''' functionality can be found in [[How_to_configure_Manual_CAN_I/O_parameters|here]].</code>
===Manual J1939===
<hr>
[[Image:Manual J1939.gif|right]]
'''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. '''Manual J1939''' protocol is enabled by selecting '''Manual J1939''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side. Then user can configure CAN parameters in [[TFT100_Manual_CAN_settings|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
|}
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 J1939 I/O====
Up to 29 I/O parameters (Priority, Event Only, Operand, Send SMS To, SMS text) for '''Manual J1939''' functionality can be configured in CAN I/O tab the same way as for '''Manual CAN''' functionality.
{| 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;" |It is important to not forget that [[TFT100_Manual_CAN_settings#Manual_CAN_Settings_.28For_Manual_J1939_functionality.29|Manual CAN Settings]] tab '''must be configured''' as well.
|}
[[Image:Manual J1939 29 IO.gif]]<br><br>
===FLEX===
<hr>
[[Image:FLEX.PNG|right]]
The <b>FLEX</b> protocol is enabled by selecting '''FLEX''' parameter in ''CAN Protocol'' field.
====FLEX I/O====
Specific <b>FLEX</b> I/O parameters were implemented to our device's firmware that can be read, configured and sent to the server just like regular I/O parameters.
*<code>The '''AVL ID''' list of '''FLEX''' parameters can be found in [[Full_AVL_ID_List#FLEX_I.2FO_elements|here]].</code><br>
[[Image:FLEX CAN.gif]]<br><br>
===Debug===
{| style="width: 100%"
|[[File:Debug feature.png|right|260px]]
Debug Protocol is used to read all incoming message through CAN, it works as a CAN reader. By default it will print incoming messages into Terminal, including CAN ID and Data.
|}
{| style="width: 100%"
|[[File:Debug-can-log.png|right]]
When the DEBUG protocol is selected, CAN Log option will appear.<br>
By Enabling CAN Log parameter it will store CAN received data and CAN ID in a file.
|}
{| style="width: 100%"
|[[File:Debug-can-dump.png|right]]
To download saved file go to Status Tab and Maintenance section, press <b>“Dump”</b> button.
|}
{| style="width: 100%"
|[[File:Debug-can-opendir.png|right]]
After downloading, follow <b>“Open directory”</b> button. After unzipping file there will be CAN folder with “0.log” file. Maximum file size is 5MB. After exceeding limit it will rewrite data.
|}
==J1939 Settings==
{| style="width: 100%"
|[[Image:J1939 Settings.png|right]]
Some J1939 PGN’s are not sent periodically, so they must be requested. In order to request PGN device must be registered to J1939 network. To register device user should configure '''J1939 Source Address''' and '''J1939 Name''' parameters:
<br />
*'''J1939 Source Address''' parameter is used to set TFT source address on J1939 network. If device with selected source address already exists on network, user should change it to another address which might be free, or PGN’s which must be requested will not be received.
*'''J1939 Name''' parameter is used to set TFT name on J1939 network.
|}
==CAN I/O reset==
{| style="width: 100%"
|[[File:CAN_IO_reset.png|right]]
<font color="red"><i><b>* This parameter is available only with FW 55.01.10.Rev.00 or newer</b></i></font><br><br>
If CAN IO reset parameter configured as 0 it will keep captured CAN data, otherwise if data is not received anymore it will reset I/Os after configured timeout.
|}
Possible values (in seconds):<br>
<code><b>0</b></code> - Data will not be cleaned. If external power is removed it will still keep the value.<br>
<code><b>1-3600</b></code> - Data will be cleaned within timeout period if no more data is received or external power removed.
{| 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;" |CAN IO resets in any case after device restart or CAN Protocol switching.
|}
[[Category:TFT100 Configuration]]
==CAN Protocol==
[[Image:CAN protocol.png|right|260px]]
'''CAN I/O''' category offers users an ability to select one of CAN protocols to read specific data through TFT100 CAN interface.<br>
TFT100 currently has 6 implemented CAN protocols and DEBUG function:<br>
*Bosch CAN Powertrain
*Askoll
*Default J1939
*Manual CAN
*Manual J1939
*FLEX
*Debug feature
'''Bosch''', '''Askoll''', '''Default J1939''' and <b>FLEX</b> CAN protocols come with specific CAN I/O parameters that can be read, monitored, configured and their values sent to the configured server.<br>
'''Manual CAN''' and '''Manual J1939''' protocols do not include dedicated specific I/O parameters however it welcomes user to configure what has to be read from the transport based on their transport CAN communication protocol.
===Bosch CAN Powertrain===
<hr>
{| style="width: 100%"
|[[Image:Bosch CAN Powertrain protocol.gif|right]]
'''Bosch CAN Powertrain protocol''' allows users to read parameters from their transport, if the transport uses ''Bosch'' motor. The protocol is enabled by selecting '''Bosch''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side.
|}
====Bosch CAN Powertrain I/O====
Specific '''Bosch CAN Powertrain''' I/O parameters were implemented to our device's firmware that can be read, configured and sent to the server just like regular I/O parameters. The parameters that were added can be seen in the image below.<br>
{| 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;" |The parameters were added upon clients' request. ''Bosch'' CAN protocol contains way more parameters that can be added by us if necessary.
|}
[[Image:Bosch CAN Powertrain IO.gif]]<br><br>
*<code>The '''AVL ID''' list of '''Bosch CAN Powertrain''' parameters can be found in [[Full_AVL_ID_List#CAN_BOSCH_I.2FO_elements|here]].</code><br>
*<code>'''SMS/GPRS commands''' that were developed for '''Bosch CAN Powertrain''' protocol can be found in [[TFT100_SMS/GPRS_Commands#CAN_Commands|here]].</code>
===Askoll===
<hr>
{| style="width: 100%"
|[[Image:Askoll protocol.gif|right]]
'''Askoll''' CAN protocol allows users to read parameters from their e-scooters manufactured by ''Askoll''. The protocol is enabled by selecting '''Askoll''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side.
|}
====Askoll I/O====
Specific '''Askoll''' I/O parameters were implemented to our device's firmware that can be read, configured and sent to the server just like regular I/O parameters. The parameters that were added can be seen in the image below.<br>
[[Image:Askoll CAN IO.gif]]<br><br>
*<code>The '''AVL ID''' list of '''Askoll''' parameters can be found in [[Full_AVL_ID_List#CAN_Askoll_I.2FO_elements|here]].</code><br>
*<code>'''SMS/GPRS commands''' that were developed for '''Askoll''' protocol can be found in [[TFT100_SMS/GPRS_Commands#CAN_Commands|here]].</code>
===Default J1939===
<hr>
{| style="width: 100%"
|[[Image:Default J1939 ss.png|right]]
'''Default J1939''' protocol support was added to TFT100 device's firmware since it is one of the most popular CAN protocols used in heavy duty (i.e. ''forklifts'') machinery industry. If the machinery communicates via J1939 CAN protocol, the device will be able to read provided parameter's data and transmit readings to your configured server. To use '''Default J1939''' CAN protocol user should select '''Default J1939''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side.
{| 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;" |''Default J1939'' can be tested on FW 55.00.09.rev.04 or newer
|}
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">'''Machinery with CAN interface, which communicates via J1939 protocol'''.</font>
|}
====Default J1939 I/O====
All '''Default J1939''' CAN I/O parameters can be configured like standard I/O parameters. User can set priority, high level, low level parameter limits, eventual record, operand, SMS text and number to which SMS notification would be sent.
[[Image:Default J1939 IO.gif]]<br><br>
*<code>The '''AVL ID''' list of '''Default J1939''' parameters can be found in [[Full_AVL_ID_List#Default_J1939_I.2FO_elements|here]].</code>
===Manual CAN===
<hr>
[[Image:Manual CAN protocol.gif|right]]
The '''Manual CAN''' protocol is enabled by selecting '''Manual CAN''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side. Then user can configure CAN parameters in [[TFT100_Manual_CAN_settings|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 I/O====
Up to 30 I/O parameters (Priority, Event Only, Operand, Send SMS To, SMS text) for '''Manual CAN''' functionality can be configured in CAN I/O 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;" |It is important to not forget that [[TFT100_Manual_CAN_settings|Manual CAN Settings]] tab '''must be configured''' as well.
|}
[[Image:Manual CAN IO.gif]]<br><br>
*<code>The '''AVL ID''' list of '''Manual CAN''' parameters can be found in [[Full_AVL_ID_List#Manual_CAN_I.2FO_elements|here]].</code><br>
*<code>Full '''Manual CAN''' and '''Manual CAN Settings''' description can be found in [[TFT100_Manual_CAN_settings|here]].</code>
*<code>Example on '''how to configure Manual CAN''' functionality can be found in [[How_to_configure_Manual_CAN_I/O_parameters|here]].</code>
===Manual J1939===
<hr>
[[Image:Manual J1939.gif|right]]
'''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. '''Manual J1939''' protocol is enabled by selecting '''Manual J1939''' parameter in ''CAN Protocol'' field as shown in the image on the right hand side. Then user can configure CAN parameters in [[TFT100_Manual_CAN_settings|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
|}
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 J1939 I/O====
Up to 29 I/O parameters (Priority, Event Only, Operand, Send SMS To, SMS text) for '''Manual J1939''' functionality can be configured in CAN I/O tab the same way as for '''Manual CAN''' functionality.
{| 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;" |It is important to not forget that [[TFT100_Manual_CAN_settings#Manual_CAN_Settings_.28For_Manual_J1939_functionality.29|Manual CAN Settings]] tab '''must be configured''' as well.
|}
[[Image:Manual J1939 29 IO.gif]]<br><br>
===FLEX===
<hr>
[[Image:FLEX.PNG|right]]
The <b>FLEX</b> protocol is enabled by selecting '''FLEX''' parameter in ''CAN Protocol'' field.
====FLEX I/O====
Specific <b>FLEX</b> I/O parameters were implemented to our device's firmware that can be read, configured and sent to the server just like regular I/O parameters.
*<code>The '''AVL ID''' list of '''FLEX''' parameters can be found in [[Full_AVL_ID_List#FLEX_I.2FO_elements|here]].</code><br>
[[Image:FLEX CAN.gif]]<br><br>
===Debug===
{| style="width: 100%"
|[[File:Debug feature.png|right|260px]]
Debug Protocol is used to read all incoming message through CAN, it works as a CAN reader. By default it will print incoming messages into Terminal, including CAN ID and Data.
|}
{| style="width: 100%"
|[[File:Debug-can-log.png|right]]
When the DEBUG protocol is selected, CAN Log option will appear.<br>
By Enabling CAN Log parameter it will store CAN received data and CAN ID in a file.
|}
{| style="width: 100%"
|[[File:Debug-can-dump.png|right]]
To download saved file go to Status Tab and Maintenance section, press <b>“Dump”</b> button.
|}
{| style="width: 100%"
|[[File:Debug-can-opendir.png|right]]
After downloading, follow <b>“Open directory”</b> button. After unzipping file there will be CAN folder with “0.log” file. Maximum file size is 5MB. After exceeding limit it will rewrite data.
|}
==J1939 Settings==
{| style="width: 100%"
|[[Image:J1939 Settings.png|right]]
Some J1939 PGN’s are not sent periodically, so they must be requested. In order to request PGN device must be registered to J1939 network. To register device user should configure '''J1939 Source Address''' and '''J1939 Name''' parameters:
<br />
*'''J1939 Source Address''' parameter is used to set TFT source address on J1939 network. If device with selected source address already exists on network, user should change it to another address which might be free, or PGN’s which must be requested will not be received.
*'''J1939 Name''' parameter is used to set TFT name on J1939 network.
|}
==CAN I/O reset==
{| style="width: 100%"
|[[File:CAN_IO_reset.png|right]]
<font color="red"><i><b>* This parameter is available only with FW 55.01.10.Rev.00 or newer</b></i></font><br><br>
If CAN IO reset parameter configured as 0 it will keep captured CAN data, otherwise if data is not received anymore it will reset I/Os after configured timeout.
|}
Possible values (in seconds):<br>
<code><b>0</b></code> - Data will not be cleaned. If external power is removed it will still keep the value.<br>
<code><b>1-3600</b></code> - Data will be cleaned within timeout period if no more data is received or external power removed.
{| 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;" |CAN IO resets in any case after device restart or CAN Protocol switching.
|}
[[Category:TFT100 Configuration]]
