This repository contains several examples for the XENSIV™ 3D Magnetic Sensor family. It not only includes the sensor's core library, which can be found here, but also provides the necessary low level wrappers to use the core library within the ModusToolbox™.
Important
This is not an official example of the ModusToolbox™ and will therefore not be available through the ModusToolbox™ project creation tool. Also the necessary wrappers cannot be obtained through the library manager of the ModusToolbox™. You will find detailed instructions on how to use this repository in the following sections.
In this guide we use the CY8CPROTO-062-4343W with the TLE493D-P3B6 sensor connected.
| Pin on sensor | Pin on microcontroller |
|---|---|
VDD1 |
3.3V / P6 VDD |
GND |
GND |
SDA |
P6.1 I2C SDA |
SCL |
P6.0 I2C SCL |
Connect the sensor to the microcontroller as shown in the image below.
Before you begin, make sure you have ModusToolbox™ installed on your computer. You can download the latest version from here. Follow the installation instructions provided for your operating system.
This repository contains all necessary files, which are required to setup a working project in ModusToolbox™. Therefore, the first step is to clone this repository into the desired location on your computer. To make things easier you can simply clone the repository in your default project folder of ModusToolbox™. On a Windows machine it is usually the following location:
%userprofile%\mtw
If you have configured any other default location you can use it instead. You can clone the repository with the following command:
git clone https://github.com/Infineon/mtb-xensiv-3d-magnetic-sensor-tlx493d.git
Or download it as .ZIP-file directly from GitHub, unpack the .ZIP-file, and put it in the corresponding folder. With that done, you can now open ModusToolbox™ and click on "Import Existing Application In-Place" in the lower, left corner:
Now you should see the following window. Here you have to click on "Browse ...":
Now you should see your file explorer. Here, you have to select the repository folder and click on "Select Folder". After a few seconds the project should be included and you should be able to see it in the "Project Explorer" of ModusToolbox™. If everything worked out so far you just have to do a double-click on the folder in the "Project Explorer". This will set the project as active project. Now you should see the options "Build Project" and "Clean Project" in the "Quick Panel" of ModusToolbox™. Before you can build the project successfully, you have to get the resources of the core library. This can easily be done with the following command:
make getlibs
The easiest way to execute this command is using the integrated terminal of ModusToolbox™. It can be found at the bottom of the interface. Here is a picture of it:
With that done, you can now build the project with the "Build Project" button in the "Quick Panel" of ModusToolbox™.
This will build your project and will also gather all necessary resources, for example the core library of the XENSIV™ 3D Magnetic sensors. After you have successfully built the project you should now see the options to "Program" or "Debug" the selected project in the "Quick Panel" tab of ModusToolbox™:
Now you can connect your PSOC™ 6 to your PC and choose either of the two options to deploy the code to the hardware.
If you already have an existing ModusToolbox™ project and want to add the library to it, then you have to do the following steps:
- First, clone the repository into your desired location.
- Then copy the complete folder libs/mtb-xensiv-3d-magnetic-sensor-tlx493d-wrapper from the cloned repository into your project's libs folder.
- In order to use the ModusToolbox™ drivers we need to add the core library of the XENSIV™ 3D Magnetic Sensor family to the project as well. This can easily be done by creating a file named xensiv-3d-magnetic-sensor-tlx493d.mtb in the deps folder of your project with the following content:
https://github.com/Infineon/xensiv-3d-magnetic-sensor-tlx493d#latest-v4.X - Execute the command
make getlibsagain to retrieve the necessary resources.
After completing these steps, you're ready to use the library with all its features.
With the steps mentioned in the "How to get started" section you will build the default example, which is a very simple I2C example for the TLE493D-P3B6 sensor of the third generation. Following is an explanation on how you can change the example to your desired one. In order to do that, you simply have to change the value of the #define EXAMPLE macro in the main.c file to the desired example. You can see a list of all available examples in the examples_t enumeration found in main.c. The documentation of each example can be found in the corresponding folders in the examples/ directory.
Once you have decided for an example and changed the code accordingly, you can simply re-build the project and program your connected hardware again.
To view the 3D magnetic values, open the Serial Monitor by clicking on the terminal button located at the top of the interface, as shown in the image below.
After opening the Serial Monitor, select the appropriate serial port from the dropdown menu. Ensure that the correct port corresponding to your device is chosen.
Click "OK" to confirm your selection.
Navigate to the terminal button located at the bottom right of the interface.
Click on this button to open the serial port window, where you will be able to view the 3D magnetic values.
The library was tested with the following boards, but should be compatible with all boards, which support the PSOC™ 6 HAL.
- PSOC™ 6 Wi-Fi Bluetooth® Prototyping Kit (CY8CPROTO-062-4343W)
- PSOC™ 62S2 Wi-Fi BT Pioneer Kit (CY8CKIT-062S2-43012)
- PSOC™ 6 Artificial Intelligence Evaluation Kit (CY8CKIT-062S2-AI)
Warning
If you choose a different PSOC™ kit for your project, other than the boards mentioned above, you have to make sure to use valid pins for the I2C and SPI communication interface. Otherwise, there is a chance that the device will not function properly.
Here you can find an overview of all the PSOC™ 6 MCU datasheets. In the section "Pinouts" you can usually find a good overview which pin is available for which functionality (e.g. UART, SPI, I2C).