GGS
/
FireWatchTower_2axis
Archived
8
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
This repository has been archived on 2026-06-17. You can view files and clone it, but cannot push or open issues or pull requests.
FireWatchTower_2axis/firmware/lib/tmc/ic/TMC4671/README.md

2.5 KiB
Executable File
Raw Blame History

TMC4671

How to use

To access the TMC4671's registers, the TMC-API offers two functions: tmc4671_readRegister and tmc4671_writeRegister. Each of these functions takes in an icID, which is used to identify the IC when multiple ICs are connected. This identifier is passed down to the callback functions (see How to Integrate).

How to integrate: overview

  1. Include all the files of the TMC-API/ic/tmc/TMC4671 folder into the custom project.
  2. Include the TMC4671.h file in the custom source code.
  3. Implement the necessary callback functions (see below).
  4. (optional): Take a look at the Examples subfolder for ready-made examples of the TMC-API usage.

Accessing the TMC4671 via SPI

The following diagram depicts how to access the TMC4671 via SPI using the TMC-API.

screenshot

The description of the functions, in the above flowchart, are as follows:

  • The functions tmc4671_readRegister and tmc4671_writeRegister are used to read and write the registers respectively. These functions check the current active bus and calls the bus-specific function i.e readRegisterSPI or writeRegisterSPI.
  • These bus specific functions constructs the datagram and further calls the bus specific callback 'tmcXXXX_readWriteSPI.
  • This callback function further calls the hardware specific read/write function for SPI and needs to be implemented externally.

How to integrate: Callback functions

Implement the following callback functions to access the chip via SPI:

  1. tmc4671_readWriteSPI(), which is a HAL wrapper function that provides the necessary hardware access. This function should also set the chip select pin CSN to low before starting the data transfer and set to high upon completion. Please refer to the datasheet of the IC for further details.

Further info

Dependency graph for the ICs with new register R/W mechanism

This graph illustrates the relationships between files within the TMC-API library, highlighting dependencies and identifying the files that are essential for integrating the library into the custom projects.

screenshot

Example usage: TMC-Evalsystem

For a reference usage of the TMC-API, visit the TMC-Evalsystem

Migration status

The TMC4671 has been reworked to the access system described above. For more infos on the status of this and other ICs, check out the migration page.