The TM4 ODIN diagnostic interface is used to verify and program the embedded application, configure and retrieve the BlackBox information as well as providing access to selected embedded application variables.For specific operation guidelines, refer to the TM4 ODIN v4 Technical Guide [3].

1.Set-up 

Connect your TM4 ODIN -equipped PC to the MCU CAN port using a CAN case adapter from Vector as specified in the TM4 ODIN v4 Technical Guide [3].

2.Watch and graphics

Using TM4 ODIN tools, you can visualize the variable values of the software application in asynchronous watch lists or in a synchronous graphic form. The variable sample frequency could be 10 Hz, 1 kHz and 16 kHz, see the Product Specifications [6] for the exact frequency.
The following list explains the variable arborescence:
◆Calibration: Contains command/data related to the motor phase and temperature calibration.
◆Drive: Contains data related to the MCU.
→Can Communication: Contains information about the actual CAN bus speed.
→Customer SupportInfo: Contains information monitored throughout the life of the MCU.
→Model Number: Contains the model number of the MCU.
→Part Number: Contains the part number of the MCU.
→Sensors: Contains the value of different sensors the MCU monitors.
→Serial Number: Contains the serial number of the MCU.
◆ErrorsAndWarnings: Contains potential errors and warnings. When the system runs correctly, all variables in Errors And Warnings are set to 0. Otherwise, some values will be set.
→Controller: Contains potential errors and warnings of the MCU.
→MacEeprom: Contains potential errors and warnings of the internal permanent memory of the motor.
→MotorControl: Contains potential errors and warnings of the motor.
→PositionSensor: Contains potential errors and warnings of the position sensor.
◆Motor: Contains data related to the motor.
→ModelNumber: Contains the model number of the motor.
→PartNumber: Contains the part number of the motor.
→Sensors: Contains the value of different sensors the motor monitors.
→SerialNumber: Contains the serial number of the motor.
→Could have other information depending on the motor type.
◆Parameters: Contains customer configurable parameters for the system. Some can be changed; others are read-only.
→Drive: Contains parameter values contained in the permanent memory of the MCU.
→Motor: Contains parameter values contained in the permanent memory of the motor.
◆System: Contains data related to the system.
→CanMsg: Contains all the CAN messages related to the MCU.
→ManualControl: Contains an EnableManualControl parameter to emulate the VMU commands manually.
→Status: Contains system status information.
◆Versions: Contains the version of:
→Application: Embedded software application version.
→Bootloader: Bootloader application version.
→Protocol: CAN protocol and extension pack protocol versions.
Available variables can be viewed in the TM4 ODIN Items Explorer window. A detailed description of each variable is given by the application.
The UserInterface.odn4 file can be loaded from TM4 ODIN to quickly view the most commonly used variables.
2.1 GetCSInfo script
Important system information can be collected and exported in .zip format to send to TM4 for troubleshooting purposes. Access this script using the File/Tools menu in TM4 ODIN; refer to the TM4 ODIN v4 Technical Guide [3] for more information.
2.2 Customer registers (errors and warnings)
Customer registers can be consulted using the TM4 ODIN diagnostic tool. The Errors And Warnings section, within the Controller, MotorControl, MacEeprom and PositionSensor folders, contains information on possible sources of error.
2.3 Error codes and corrective actions
Each error recorded by the embedded MCU software can be viewed in the SysFile accessible via the TM4 ODIN GUI (refer to TM4 ODIN v4 Technical Guide [3] for more information). The SysFile records the most relevant events with enough detail to allow the system integrator to define if the cause of the event is external or internal to the traction system; the file works as a circular buffer that overwrites the oldest entries with the newest ones.
The TM4 Error Codes and Corrective Action [8] document identifies each error code that
might be displayed in the SysFile; gives a short description of the cause of the problem and then, in some cases, lists the numbers of the actions to be performed to resolve the issue.
If the issue remains unresolved, contact TM4 Customer Service; see Section 7 for contact information.

3.Configuring the BlackBox

The BlackBox is used to diagnose unexpected behaviour with the MCU, it records a list of variables based on the occurrence of predefined trigger events. The MCU comes with a default BlackBox configuration designed to ease the first step analysis of most issues that could be encountered with the application software.
The BlackBox configuration can be performed in any of the operating modes of the system. TM4 ODIN is used to configure the data that needs to be captured. To launch the capture, the user needs to set up a trigger. The new BlackBox configuration is then automatically saved in non-volatile memory.
When the BlackBox is started, the trigger condition is set to FALSE and then when the condition becomes TRUE, the BlackBox captures data for the configured period. The capture is then stopped and the data is saved in internal permanent memory. The time is determined by the space of the BlackBox memory and the amount of data that needs to be captured.
Note: The usual acquisition time is about 10 ms.
At start-up, each time the MCU becomes operational, the BlackBox is automatically cleared of all data but still allows the system to recover data on the last error. This information, which you can view when you connect with the TM4 ODIN GUI, is stored in internal permanent memory in the BlackBox. The error data includes the associated boot-up number generated by the VMU at start-up.
When TM4 ODIN connects to the embedded application, the text “BlackBox info available” is displayed in green in the status bar at the bottom of the window, telling you that there is information to be recovered from the BlackBox. You can then view the graph captured to diagnose the problem. Using the TM4 ODIN GUI, you can clear the acquired data and start a new capture session at any time.
For further information, refer to the TM4 ODIN Technical Guide [3].

4.Application version

To check which version is currently flashed on the embedded system, you can connect to the embedded application with TM4 ODIN. The name of the embedded application and the version of the current application will be displayed in the status bar.
For further information, refer to the TM4 ODIN v4 Technical Guide [3].

5.Package documentation

From v4.16.x of TM4 ODIN links to all customer documentation related to a currently loaded package are available via the ODIN GUI in the Package Files menu item.
For further information, refer to the TM4 ODIN v4 Technical Guide [3].