example_basic.md

Description

Once the Arduino library has been installed, the Example1_BasicReadings.ino example file can be accessed from the File > Examples > SparkFun TMAG5273 Arduino Library > Example1_BasicReadings drop-down menu. This example reads the raw magnetic flux (mT) and temperature (°C) data from the TMAG5273 sensor through the I²C interface and displays them in the Serial Monitor.

??? code "Example1_BasicReadings.ino" ??? info "Code Verification" This code was last verified to be functional under the following parameters:

	```
	Arduino IDE Version: 2.2.1
	Arduino Library Version: 1.0.3

	Hardware Platform:
	- SparkFun RedBoard Plus
	- SparkFun Linear 3D Hall-Effect Sensor - TMAG5273 (Qwiic)
	- SparkFun Mini Linear 3D Hall-Effect Sensor - TMAG5273 (Qwiic)
	```

```cpp linenums="1"
--8<-- "https://raw.githubusercontent.com/sparkfun/SparkFun_TMAG5273_Arduino_Library/main/examples/Example1_BasicReadings/Example1_BasicReadings.ino"
```

Hardware Connections

For this example, users simply need to connect their Qwiic Hall-Effect Sensor board to their microcontroller, utilizing the I²C interface. With the recommended hardware, users can easily connect their boards with the Qwiic connection system.

[{ width="400" }](./assets/img/hookup_guide/example-basic-1x1.jpg "Click to enlarge")

[{ width="400" }](./assets/img/hookup_guide/example-basic-mini.jpg "Click to enlarge")

*The Qwiic Hall-Effect Sensor boards are connected to a [RedBoard Plus](https://www.sparkfun.com/products/18158), with a [Qwiic cable](https://www.sparkfun.com/products/15081).*

??? info "Pin Connections" For users with a development board without a Qwiic connector, the table below illustrates the required pin connections. Make sure that the logic-level of the sensor is compatible with the development board that is being connected.

<center>

| Sensor Pin | Microcontroller Pin | RedBoard/Uno |
| :--------: | :------------------ | :----------: |
| `SCL` | I<sup>2</sup>C - Serial Clock | `SCL`/`A5` |
| `SDA` | I<sup>2</sup>C - Serial Data  | `SDA`/`A4` |
| `3V3` | Power: **1.7 to 3.6V**        | `3.3V`     |
| `GND` | Ground                        | `GND`      |

</center>

Serial Monitor

This example reads the magnetic flux (mT) and temperature values (°C) from the TMAG5273 sensor and displays them in the Serial Monitor.

[{ width="400" }](./assets/img/hookup_guide/example-basic.gif "Click to enlarge") The magnetic flux (mT) and temperature (°C) values streamed from the TMAG5273 sensor into the [Serial Monitor](https://learn.sparkfun.com/tutorials/112).

!!! tip For this example to work, users will need to move a magnet near the sensor.

!!! warning
	The casing of rare Earth magnets is often conductive. Users should take precautions to avoid shorting out the components or electrical contacts with these types of magnets.