https://github.com/maximilian-nitsch/magnetometer-simulator
C++ Simulator and ROS 2 Node for Magnetometers (MAG).
https://github.com/maximilian-nitsch/magnetometer-simulator
autonomous-robots autonomous-underwater-vehicle autonomous-vehicles auv-simulator magnetometer navigation robotics robotics-simulation sensor simulation simulator
Last synced: 4 months ago
JSON representation
C++ Simulator and ROS 2 Node for Magnetometers (MAG).
- Host: GitHub
- URL: https://github.com/maximilian-nitsch/magnetometer-simulator
- Owner: maximilian-nitsch
- License: bsd-3-clause
- Created: 2025-04-04T07:49:10.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-04-11T08:39:36.000Z (10 months ago)
- Last Synced: 2025-05-20T14:18:08.949Z (8 months ago)
- Topics: autonomous-robots, autonomous-underwater-vehicle, autonomous-vehicles, auv-simulator, magnetometer, navigation, robotics, robotics-simulation, sensor, simulation, simulator
- Language: C++
- Homepage:
- Size: 12.2 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT
Awesome Lists containing this project
README
# C++/ROS 2 Magnetometer Simulator
[](https://github.com/maximilian-nitsch/Magnetometer-Simulator/commits/main)
[](https://index.ros.org/doc/ros2/Installation/Humble/)
[](https://github.com/maximilian-nitsch/Magnetometer-Simulator/releases)
[](https://github.com/maximilian-nitsch/Magnetometer-Simulator/issues)
[](https://github.com/maximilian-nitsch/Magnetometer-Simulator/graphs/contributors)
**Author:**
- Maximilian Nitsch
**Affiliation:** Institute of Automatic Control - RWTH Aachen University
**Maintainer:**
- Maximilian Nitsch
## Description
This project provides a high-fidelity MAG simulator written in C++.
The simulator implements the following features:
- Magnetometer measurement simulation
- Ideal measurement model
- Soft iron distortion
- Hard iron bias
- Stochastic noise (colored/non-white noise)
- Velocity/angular random walk
- Bias instability
- Acceleration/rate random walk
- Saturation
- Quantization errors
- All parameters for the MAG can be configured in a YAML file
- All models and effects can be enabled/disabled separately
An example config file from real data of a PNI RM3100 MAG is provided.
## Table of Contents
- [Dependencies](#dependencies)
- [Installation](#installation)
- [Usage](#usage)
- [ROS 2 Nodes](#ros-2-nodes)
- [Publisher Node](#publisher-node)
- [Subscriber Node](#subscriber-node)
- [Coding Guidelines](#coding-guidelines)
- [References](#references)
- [Reports](#reports)
- [Contributing](#contributing)
- [License](#license)
# Dependencies
This project depends on the following literature and libraries:
- **Eigen3**: Eigen is a C++ template library for linear algebra: [Eigen website](https://eigen.tuxfamily.org/).
- **ROS 2 Humble**: ROS 2 is a set of software libraries and tools for building robot applications: [ROS 2 Installation page](https://docs.ros.org/en/humble/Installation.html).
- **Navigation Utilities Package**: ROS 2 package with common navigation utilities for TRIPLE-GNC: [Navigation Utilities](https://gitlab.informatik.uni-bremen.de/triple/gnc/utilities/navigation-utilities)
# Installation
To install the `mag_simulator_package`, you need to follow these steps:
1. **Install Eigen3**: Eigen3 is a dependency for your package. You can install it using your package manager. For example, on Ubuntu, you can install it using the following command:
```bash
sudo apt-get install libeigen3-dev
```
2. **Install ROS 2 Humble**: Ensure you have ROS 2 (Humble) installed. You can follow the official installation instructions provided by ROS 2. Visit [ROS 2 Humble Installation page](https://docs.ros.org/en/humble/Installation.html) for detailed installation instructions tailored to your platform.
3. **Clone the Package**: Clone the package repository to your ROS 2 workspace. If you don't have a ROS 2 workspace yet, you can create one using the following commands:
```bash
mkdir -p /path/to/ros2_workspace/src
cd /path/to/ros2_workspace/src
```
Now, clone the package repository:
```bash
git clone
```
Replace `` with the URL of your package repository.
4. **Build the Package**: Once the package is cloned, you must build it using colcon, the default build system for ROS 2. Navigate to your ROS 2 workspace and run the following command:
```bash
cd /path/to/ros2_workspace
colcon build
```
This command will build all the packages in your workspace, including the newly added package.
5. **Source the Workspace**: After building the package, you need to source your ROS 2 workspace to make the package available in your ROS 2 environment. Run the following command:
```bash
source /path/to/ros2_workspace/install/setup.bash
```
Replace `/path/to/ros2_workspace` with the actual path to your ROS 2 workspace.
That's it! Your `mag_simulator_package` should now be installed along with its dependencies and ready to use in your ROS 2 environment.
## Usage
1. **Configure your YAML file** for your MAG or use the default file.
2. **Start the MAG simulator** with the launch file:
```bash
ros2 launch mag_simulator_package mag_simulator.launch.py
```
The MAG simulator prints your settings and waits for a ground truth odometry message.
3. **Provide an odometry publisher** from you vehicle simulation.
For testing, you can launch the odometry_test_publisher node:
```bash
ros2 launch mag_simulator_package odometry_test_publisher.py
```
4. The MAG values should now be published.
**Important Usage Information**:
- The odometry message must be published with at least the MAG data rate/sample time.
- The message `/mag/diagnostic` will show `WARN` if the odometry rate is lower.
- If no odometry message is published, the message `/mag/diagnostic` will show `STALE`.
- If everything is correct, `/mag/diagnostic` will show `OK`.
## ROS 2 Nodes
The MAG simulator node implements two publishers and subscribes to one topic.
ROS 2 services or actions are not provided.
### Publisher Node
This node publishes the following topics:
| Topic Name | Message Type | Description |
|------------------|---------------------|------------------------------------|
| `/nanoauv/sensor/navigation/mag/magnetic_field` | `sensor_msgs/MagneticField` | Publishes MAG sensor data.|
| `/nanoauv/sensor/navigation/mag/magnetic_field_ideal` | `sensor_msgs/MagneticField` | Publishes ideal MAG sensor data.|
| `/nanoauv/sensor/navigation/mag/diagnostic` | `diagnostic_msgs/DiagnosticStatus.msg` | Publishes the diagnostic status of the MAG data.
### Subscriber Node
This node subscribes to the following topics:
| Topic Name | Message Type | Description |
|-------------------|---------------------|------------------------------------|
| `/nanoauv/odometry`| `nav_msgs/Odometry.msg`| Subscribes to ground truth vehicle odometry.|
## Coding Guidelines
This project follows these coding guidelines:
- https://google.github.io/styleguide/cppguide.html
- http://docs.ros.org/en/humble/The-ROS2-Project/Contributing/Code-Style-Language-Versions.html
## References
The MAG simulator implementation closely follows the work:
- J. A. Farrell, F. O. Silva, F. Rahman and J. Wendel, "Inertial Measurement Unit Error Modeling Tutorial: Inertial Navigation System State Estimation with Real-Time Sensor Calibration," in IEEE Control Systems Magazine, vol. 42, no. 6, pp. 40-66, Dec. 2022, [DOI: 10.1109/MCS.2022.3209059](https://doi.org/10.1109/MCS.2022.3209059).
- J. A. Farrell, "Aided Navigation Systems: GPS and High Rate Sensors," New York, NY, McGraw-Hill, 552 pages, 2008.
## Contributing
If you want to contribute to the project, see the [CONTRIBUTING](CONTRIBUTING) file for details.
## License
This project is licensed under the BSD-3-Clause License. Please look at the [LICENSE](LICENSE) file for details.