Skip to content

grizzlei/libimu

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

libimu

Quaternion based (gimbal lock-safe), hardware independent IMU data processing library.

libimu-demo

Building and using libimu

Following commands will build and install libimu on your system. Then you can include it to your project using #include <imu/imu.h> and compile with linker flag -limu.

make
make install

Dependencies for demo.c (made for Linux, no portability intended)

apt-get install mesa-utils libglu1-mesa-dev freeglut3-dev mesa-common-dev libglfw3-dev

To compile demo or run it directly (second line will compile and run demo.c):

make demo
make run

Example use

Here's a simplified piece of code from demo.c. Following code is essentially all you need to compute the current orientation of the body.

#include <imu/imu.h>

// let's say we are using a popular imu that is mpu6050
// and it is initialized with ±500 °/s gyro, ±4g accelerometer configurations
// then the raw data from sensors will be multiplied with below values per mpu6050 datasheet
imu_t imu = imu_init(IMU_CALIBMODE_ONCE, 2.f / 131.f, 2.f / 16384.f);

// application loop
// ..

    // set ax, ay, az and gx, gy, gz with values received from sensors
    imu_set_accelerometer_raw(&imu, ax, ay, az);
    imu_set_gyro_raw(&imu, gx, gy, gz);
    imu_main_loop(&imu);

    // get orientation either in euler angles or as a quaternion as below
    prdbg("euler angles: %f %f %f", imu.orientation.roll, imu.orientation.pitch, imu.orientation.yaw);
    prdbg("quaternion: %f %f %f %f", imu.orientation_quat.w, imu.orientation_quat.x, imu.orientation_quat.y, imu.orientation_quat.z);

    // sleep as minimal as possible (1msec maybe)
// ..
// end of application loop

In application loop, ax, ay, az and gx, gy, gz have to be acquired from accelerometer and gyro sensors.


MPU6050 tool for Orange Pi and Raspberry Pi boards

In demo.c to acquire sensor data, i've used a tool I wrote to use mpu6050 with OrangePi Zero board. You can get the tool and wiring information from https://github.com/grizzlei/mpu6050.

If you wish to use another tool, please remember that expected format is: ax,ay,az,gx,gy,gz\r\n over serial with 115200 bps (8N1).


Thanks

Thanks to Gordon Wetzstein for the content and Stanford University for making them available online. Math behind the library essentially relies on this lecture note.

https://stanford.edu/class/ee267/lectures/lecture10.pdf


License

libimu is a free software, it can be used by anyone who try to build a better world.

MIT License

Copyright (c) 2022 Hasan Karaman

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


hasan karaman (whoami) - https://hasankaraman.dev - hk@hasankaraman.dev - 2022