Example of using the HSCDTD008A Geomagnetic Sensor.

Dependencies:   HSCDTD008A

Files at this revision

API Documentation at this revision

Comitter:
hudakz
Date:
Sun Jun 20 13:56:50 2021 +0000
Child:
1:2d4aa9e794a5
Commit message:
Example of using the HSCDTD008A Geomagnetic Sensor.

Changed in this revision

.gitignore Show annotated file Show diff for this revision Revisions of this file
CONTRIBUTING.md Show annotated file Show diff for this revision Revisions of this file
HSCDTD008A.lib Show annotated file Show diff for this revision Revisions of this file
README.md Show annotated file Show diff for this revision Revisions of this file
main.cpp Show annotated file Show diff for this revision Revisions of this file
mbed-os.lib Show annotated file Show diff for this revision Revisions of this file
mbed_app.json Show annotated file Show diff for this revision Revisions of this file
resources/official_armmbed_example_badge.png Show annotated file Show diff for this revision Revisions of this file
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/.gitignore	Sun Jun 20 13:56:50 2021 +0000
@@ -0,0 +1,4 @@
+.build
+.mbed
+projectfiles
+*.py*
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/CONTRIBUTING.md	Sun Jun 20 13:56:50 2021 +0000
@@ -0,0 +1,5 @@
+# Contributing to Mbed OS
+
+Mbed OS is an open-source, device software platform for the Internet of Things. Contributions are an important part of the platform, and our goal is to make it as simple as possible to become a contributor.
+
+To encourage productive collaboration, as well as robust, consistent and maintainable code, we have a set of guidelines for [contributing to Mbed OS](https://os.mbed.com/docs/mbed-os/latest/contributing/index.html).
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/HSCDTD008A.lib	Sun Jun 20 13:56:50 2021 +0000
@@ -0,0 +1,1 @@
+https://os.mbed.com/users/hudakz/code/HSCDTD008A/#ccf912737de7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/README.md	Sun Jun 20 13:56:50 2021 +0000
@@ -0,0 +1,64 @@
+![](./resources/official_armmbed_example_badge.png)
+# Blinky Mbed OS example
+
+The example project is part of the [Arm Mbed OS Official Examples](https://os.mbed.com/code/) and is the [getting started example for Mbed OS](https://os.mbed.com/docs/mbed-os/v5.14/quick-start/index.html). It contains an application that repeatedly blinks an LED on supported [Mbed boards](https://os.mbed.com/platforms/).
+
+You can build the project with all supported [Mbed OS build tools](https://os.mbed.com/docs/mbed-os/latest/tools/index.html). However, this example project specifically refers to the command-line interface tool [Arm Mbed CLI](https://github.com/ARMmbed/mbed-cli#installing-mbed-cli).
+(Note: To see a rendered example you can import into the Arm Online Compiler, please see our [import quick start](https://os.mbed.com/docs/mbed-os/latest/quick-start/online-with-the-online-compiler.html#importing-the-code).)
+
+1. [Install Mbed CLI](https://os.mbed.com/docs/mbed-os/latest/quick-start/offline-with-mbed-cli.html).
+
+1. Clone this repository on your system, and change the current directory to where the project was cloned:
+
+    ```bash
+    $ git clone git@github.com:armmbed/mbed-os-example-blinky && cd mbed-os-example-blinky
+    ```
+
+    Alternatively, you can download the example project with Arm Mbed CLI using the `import` subcommand:
+
+    ```bash
+    $ mbed import mbed-os-example-blinky && cd mbed-os-example-blinky
+    ```
+
+
+## Application functionality
+
+The `main()` function is the single thread in the application. It toggles the state of a digital output connected to an LED on the board.
+
+## Building and running
+
+1. Connect a USB cable between the USB port on the board and the host computer.
+2. <a name="build_cmd"></a> Run the following command to build the example project and program the microcontroller flash memory:
+    ```bash
+    $ mbed compile -m <TARGET> -t <TOOLCHAIN> --flash
+    ```
+The binary is located at `./BUILD/<TARGET>/<TOOLCHAIN>/mbed-os-example-blinky.bin`.
+
+Alternatively, you can manually copy the binary to the board, which you mount on the host computer over USB.
+
+Depending on the target, you can build the example project with the `GCC_ARM`, `ARM` or `IAR` toolchain. After installing Arm Mbed CLI, run the command below to determine which toolchain supports your target:
+
+```bash
+$ mbed compile -S
+```
+
+## Expected output
+The LED on your target turns on and off every 500 milliseconds.
+
+
+## Troubleshooting
+If you have problems, you can review the [documentation](https://os.mbed.com/docs/latest/tutorials/debugging.html) for suggestions on what could be wrong and how to fix it.
+
+## Related Links
+
+* [Mbed OS Stats API](https://os.mbed.com/docs/latest/apis/mbed-statistics.html).
+* [Mbed OS Configuration](https://os.mbed.com/docs/latest/reference/configuration.html).
+* [Mbed OS Serial Communication](https://os.mbed.com/docs/latest/tutorials/serial-communication.html).
+* [Mbed OS bare metal](https://os.mbed.com/docs/mbed-os/latest/reference/mbed-os-bare-metal.html).
+* [Mbed boards](https://os.mbed.com/platforms/).
+
+### License and contributions
+
+The software is provided under Apache-2.0 license. Contributions to this project are accepted under the same license. Please see contributing.md for more info.
+
+This project contains code from other projects. The original license text is included in those source files. They must comply with our license guide.
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/main.cpp	Sun Jun 20 13:56:50 2021 +0000
@@ -0,0 +1,92 @@
+#include "mbed.h"
+#include "HSCDTD008A.h"
+
+#define M_PI  3.14159265358979323846
+
+HSCDTD008A  compass(PB_7, PB_6, PA_8);
+Watchdog&   watchdog = Watchdog::get_instance();
+
+int main()
+{
+    float   x_sum;
+    float   y_sum;
+    float   z_sum;
+    float   x_avg;
+    float   y_avg;
+    float   z_avg;
+    float   bearing;
+
+    printf("Starting selftest.. ");
+    if (compass.selftest() == OK) {
+        printf("passed\r\n");
+    }
+    else {
+        printf("failed\r\n");
+    }
+
+    printf("Calibrating offsets.. ");
+    compass.calibrateOffsets();
+
+    printf("done\r\n");
+
+    printf("Compensating temperature.. ");
+    compass.compensateTemp();
+    printf("done\r\n");
+
+    ThisThread::sleep_for(1000ms);
+
+    compass.setResolution(true);    // set 15bit resolution
+    printf("res = %d\r\n", compass.getResolution());
+
+    compass.enableFifo();
+    compass.normalMode(0b10);
+
+    watchdog.start(3000);  // clears WDTOF
+
+    while (true) {
+        printf("-----------------\r\n");
+        printf("Measuring.. \r\n");
+
+        if (compass.isFifoFull()) {
+           watchdog.kick();
+
+            //printf("FIFO pointer = %d\r\n", compass.fifoPointer());
+            //printf("FIFO full = %d\r\n", compass.isFifoFull());
+
+           // get data and calculate sums
+            x_sum = 0;
+            y_sum = 0;
+            z_sum = 0;
+
+            for (uint8_t i = 0; i < 8; i++) {
+                compass.readData();
+                x_sum += compass.x();
+                y_sum += compass.y();
+                z_sum += compass.z();
+            }
+
+            // calculate averages
+            x_avg = x_sum / 8;
+            y_avg = y_sum / 8;
+            z_avg = z_sum / 8;
+
+            //printf("FIFO pointer = %d\r\n", compass.fifoPointer());
+            //printf("FIFO full = %d\r\n", compass.isFifoFull());
+            //printf("\r\n");
+
+            printf("x_avg = %f\r\n", x_avg);
+            printf("y_avg = %f\r\n", y_avg);
+            printf("z_avg = %f\r\n", z_avg);
+            printf("\r\n");
+
+            bearing = atan2(y_avg, x_avg) * 180 / M_PI;
+            if (bearing < 0) {
+                bearing = 360 + bearing;
+            };
+
+            printf("bearing = %f\r\n", bearing);
+        }
+
+        ThisThread::sleep_for(1s);
+    }
+}
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed-os.lib	Sun Jun 20 13:56:50 2021 +0000
@@ -0,0 +1,1 @@
+https://github.com/ARMmbed/mbed-os/#14e5d307bb6cdccb554b591ab2602d8d47e0b2d0
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mbed_app.json	Sun Jun 20 13:56:50 2021 +0000
@@ -0,0 +1,11 @@
+{
+       "target_overrides": {
+           "*": {
+            "platform.callback-nontrivial": true,
+            "platform.stdio-baud-rate": 115200,
+            "target.macros_remove": ["MBED_TICKLESS"],
+            "target.c_lib": "std",
+            "target.printf_lib": "std"
+        }
+    }
+}
Binary file resources/official_armmbed_example_badge.png has changed