This wrapper is designed to simplify the use of the m5stack/M5_BMM150 library. The BMM150 is a digital geomagnetic sensor by Bosch, compatible with M5Stack modules. This wrapper streamlines the initialization of the geomagnetic sensor, reading of data, and the calibration process, making it easier to use in Arduino sketches.
- Initialization and Setup: Initiates and configures the BMM150 sensor via I2C communication. Offers options to customize the sensor's operational modes and settings. Data Reading: Reads geomagnetic data (X, Y, Z axes) from the sensor. Utilizes the read data to calculate the bearing. The BMM150 magnetic sensor module detects the strength and direction of the geomagnetic field, basing its calculations on this data to determine the direction of magnetic north. Therefore, using this library enables the determination of the magnetic north direction.
- Calibration: Provides calibration features to improve the accuracy of sensor data. Supports saving and loading calibration data.
Set up your platformio.ini file to use the private repository https://github.com/tichise/bmm150-compass as follows.
Example platformio.ini file:
platform = espressif32
board = m5stack-core-esp32
framework = arduino
lib_deps =
https://github.com/tichise/bmm150-compass.git
This configuration considers the following:
- Platform: Specifies espressif32, assuming an ESP32-based board.
- Board: Set as board = m5stack-core-esp32, compatible with the M5Stack ESP32 board, but can be modified according to your board.
- Framework: Uses the Arduino framework.
- Library Dependencies: Directly specifies the URL https://github.com/tichise/bmm150-compass.git.
Refer to bmm150-compass/examples/m5stamp-s3/BasicCompassExample.ino at main · tichise/bmm150-compass for an example.
このラッパーは、m5stack/M5_BMM150ライブラリを簡単に使用できるように設計されています。BMM150は、Boschのデジタル地磁気センサーで、M5Stackモジュールに対応しています。このラッパーは、地磁気センサーの初期化、データの読み取り、およびキャリブレーションプロセスを簡素化し、Arduinoスケッチでの使用を容易にします。
- 初期化と設定:I2C通信を介してBMM150センサーの初期化と設定を行います。 センサーの動作モードや設定をカスタマイズするオプションを提供します。
- データ読み取り:センサーからの地磁気データ（X、Y、Z軸）を読み取ります。読み取ったデータを利用して、方位角を計算します。BMM150磁気センサーモジュールは地磁気の強さと方向を検出し、そのデータを基に磁北の方向を算出します。したがって、このライブラリを使用すると、磁北の方向を知ることが可能です。
- キャリブレーション:センサーデータの精度を向上させるためのキャリブレーション機能を提供します。キャリブレーションデータの保存と読み込みをサポートします。
プライベートリポジトリ https://github.com/tichise/bmm150-compass を使用するための platformio.ini ファイルは以下のように設定します。
platformio.ini ファイルの例
platform = espressif32
board = m5stack-core-esp32
framework = arduino
lib_deps =
https://github.com/tichise/bmm150-compass.git
この設定では、以下の点を考慮しています：
- プラットフォーム: espressif32 を指定しています。これはESP32ベースのボードを想定しています。
- ボード: board = m5stack-core-esp32 と設定しています。これはM5StackのESP32ボードに対応していますが、お使いのボードに応じて変更してください。
- フレームワーク: Arduinoフレームワークを使用します。
- ライブラリ依存関係: URL https://github.com/tichise/bmm150-compass.git を直接指定しています。
bmm150-compass/examples/m5stamp-s3/BasicCompassExample.ino at main · tichise/bmm150-compassを参考にしてください。