|
1 | | -SparkFun <PRODUCT NAME> |
| 1 | +SparkFun TMAG5273 Arduino Library |
2 | 2 | ======================================== |
3 | 3 |
|
4 | | -[](URL for product on Sparkfun.com) |
| 4 | +[](https://cdn.sparkfun.com/assets/parts/2/1/9/9/5/22132-_01.jpg) |
5 | 5 |
|
6 | | -[*SparkFun Part Name (SKU)*](URL for product on Sparkfun.com) |
7 | 6 |
|
8 | | -<Basic description of the part.> |
| 7 | + |
| 8 | +This is the SparkFun library for the Texas Instruments TMAG5273 low-power linear 3D Hall-effect sensor with I<sup>2</sup>C interface as used on the [SparkFun IoT Motor Driver (ESP32 WROOM, TMC6300)](https://www.sparkfun.com/products/22132). |
9 | 9 |
|
10 | 10 | Repository Contents |
11 | 11 | ------------------- |
12 | 12 |
|
13 | | -* **/Documentation** - Data sheets, additional product information |
14 | | -* **/Enclosure** - Enclosure files |
15 | | -* **/Firmware** - Example code |
16 | | -* **/Hardware** - Eagle design files (.brd, .sch) |
17 | | -* **/Libraries** - Libraries for use with the <PRODUCT NAME> |
18 | | -* **/Production** - Production panel files (.brd) |
19 | | -* **/Software** - Related software for the <PRODUCT NAME> |
| 13 | +* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE. |
| 14 | +* **/src** - Source files for the library (.cpp, .h). |
| 15 | +* **/Documentation** - Datasheet for the TMAG5273. |
| 16 | +* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE. |
| 17 | +* **library.properties** - General library properties for the Arduino package manager. |
| 18 | +* **[CONTRIBUTING.md](./CONTRIBUTING.md)** - guidance on how to contribute to this library. |
| 19 | + |
20 | 20 |
|
21 | 21 | Documentation |
22 | 22 | -------------- |
23 | | -* **[Library](GitHub library URL)** - <LANGUAGE> library for the <PRODUCT NAME>. |
24 | | -* **[Hookup Guide](Learn.SparkFun URL)** - Basic hookup guide for the <PRODUCT NAME>. |
25 | | -* **[SparkFun Fritzing repo](https://github.com/sparkfun/Fritzing_Parts)** - Fritzing diagrams for SparkFun products. |
26 | | -* **[SparkFun 3D Model repo](https://github.com/sparkfun/3D_Models)** - 3D models of SparkFun products. |
27 | | -* **[SparkFun Graphical Datasheets](https://github.com/sparkfun/Graphical_Datasheets)** -Graphical Datasheets for various SparkFun products. |
28 | | - |
29 | | -Product Versions |
30 | | ----------------- |
31 | | -* [Part SKU](part URL) - Basic part and short description here |
32 | | -* [Retail part SKU](retail URL) - Retail packaging of standard description here |
33 | | -* [Any other parts this repo covers](any other URLs) - Description of said parts |
34 | | - |
35 | | -Version History |
36 | | ---------------- |
37 | | -* [vExxFxxZxxHxxLxxSxx](URL for tag specific to this version) - Description |
38 | | -* [vEyyFyyZyyHyyLyySyy](URL for tag specific to this version) - Description |
| 23 | + |
| 24 | +* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library. |
| 25 | +* **[Hookup Guide](LINK HERE)** - Basic hookup guide for the SparkFun IoT Motor Driver Breakout (ESP32, TMC6300). |
| 26 | +* **[Product Repository](https://github.com/sparkfun/SparkFun_IoT_Brushless_Motor_Driver)** - Main repository for the IoT Motor Driver (including hardware files) |
39 | 27 |
|
40 | 28 | License Information |
41 | 29 | ------------------- |
|
0 commit comments