SLYU066A October   2023  – June 2024 TMAG3001

 

  1.   1
  2.   Description
  3.   Get Started
  4.   Features
  5.   Applications
  6.   6
  7. 1Evaluation Module Overview
    1. 1.1 Introduction
    2. 1.2 Kit Contents
    3. 1.3 Specifications
    4. 1.4 Device Information
  8. 2Hardware
    1. 2.1 TMAG3001 EVM Components
    2. 2.2 SCB LEDs
  9. 3Software
    1. 3.1 Quick Start Setup
    2. 3.2 EVM Operation
      1. 3.2.1 Setup
        1. 3.2.1.1 Driver Installation
        2. 3.2.1.2 Firmware
          1. 3.2.1.2.1 Updating Firmware on SCB
        3. 3.2.1.3 GUI Setup and Usage
          1. 3.2.1.3.1 Initial Setup
          2. 3.2.1.3.2 GUI Operation
      2. 3.2.2 Rotate and Push Demo
      3. 3.2.3 CRC Calculator
      4. 3.2.4 Direct EVM Serial Communication
  10. 4Hardware Design Files
    1. 4.1 Schematics
    2. 4.2 PCB Layout
    3. 4.3 Bill of Materials
  11. 5Additional Information
    1. 5.1 Trademarks
  12. 6Related Documentation
  13. 7Revision History

Direct EVM Serial Communication

If desired, the SCB can communicate directly with the EVM without the use of the GUI through the USB serial (COM) port. Simply send the desired command string over the serial port and receive the results. This is useful for interfacing the EVM with custom setups/scripts/GUIs. Note that the TMAG3001EVM must be connected to the SCB to receive any command responses from the SCB.

To read and write registers, follow the below format:

  • Read register command format: rreg ADR
    • Where ADR is the address in hex, and rreg is always lower case
    • Register addresses can be in upper or lower case, and do not need to be led by "0x". 0 padding register addresses is also optional. For example, to read register address 0xE, some valid commands include:
      • rreg e
      • rreg 0E
      • rreg 0x0E
        • When "0x" is used, the "x" must be lower case.
    • Figure 4-22 is an example response to this command:
    TMAG3001EVM Example Register Read ResponseFigure 3-22 Example Register Read Response

    The number to the right of value represents the value read from the register. Note that this value is represented in decimal form and not hexadecimal.

  • Write register command format: wreg ADR VAL
    • Where ADR and VAL are in hex, and wreg is always lower case
    • Register addresses and values can be in upper or lower case, and do not need to be led by "0x". 0 padding register addresses and values is also optional. For example, to write register address 0x0 with the value 4, some valid commands include:
      • wreg 0 4
      • wreg 00 0x4
      • wreg 0x00 0x04
        • When "0x" is used, the "x" must be lower case.
    • Figure 4-23 is an example response to this command:
      TMAG3001EVM Example Register Write ResponseFigure 3-23 Example Register Write Response

Other useful commands include the following:

  • Firmware revision command format: id
    • This command prints the EVM the SCB is configured for (TMAG3001EVM in this case) and the date associated with the version of the firmware loaded on the SCB.
    • Figure 4-24 is an example response to this command:
      TMAG3001EVM Example
                                    Firmware Revision Command Response Figure 3-24 Example Firmware Revision Command Response
    • The date and time obtained from this command is the same date and time that appears in the GUI’s About screen (see Figure 4-25). Click the About option under the GUI's Help menu to view the About screen.
      TMAG3001EVM Firmware
                                    Revision Version in GUI About Screen Figure 3-25 Firmware Revision Version in GUI About Screen
  • BSL command format: bsl
    • This command puts the device in BSL mode, which is necessary before reflashing the SCB firmware. Another alternative to entering BSL mode is to do so via hardware as described in step 1b of Section 3.2.1.2.1. Before BSL is entered, LED D1 is on. If BSL mode is successfully entered, LED D1 is turned off so that only the Power LED (LED D5) is on. After entering BSL mode, the device does not accept any of the above commands.
    • Figure 4-26 shows an example response to this command:
      TMAG3001EVM BSL Command ResponseFigure 3-26 BSL Command Response
  • Trigger conversion command format: rreg 0

    • If the device is in standby mode and new conversions are set to be triggered through I2C, doing a register read at register 0 automatically starts a new set of conversions.