Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libdriver/adxl345
ADXL345 full function driver library for general MCU and Linux.
https://github.com/libdriver/adxl345
accelerometer adxl345 c full-function-driver iic linux mcu spi
Last synced: 1 day ago
JSON representation
ADXL345 full function driver library for general MCU and Linux.
- Host: GitHub
- URL: https://github.com/libdriver/adxl345
- Owner: libdriver
- License: mit
- Created: 2021-05-05T15:26:02.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-31T11:09:15.000Z (4 months ago)
- Last Synced: 2024-10-11T00:19:16.504Z (3 months ago)
- Topics: accelerometer, adxl345, c, full-function-driver, iic, linux, mcu, spi
- Language: C
- Homepage: https://www.libdriver.com
- Size: 9.19 MB
- Stars: 180
- Watchers: 12
- Forks: 15
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)
## LibDriver ADXL345
[](/misra/README.md) [](https://www.libdriver.com/docs/adxl345/index.html) [](/LICENSE)
The ADXL345 is a small, thin, ultralow power, 3-axis accelerometer launched by Analog Devices. It has high resolution (13-bit) measurement at up to ±16 g. Digital output data is formatted as 16-bit twos complement and is accessible through either a SPI (3- or 4-wire) or I2C digital interface.The ADXL345 is well suited for mobile device applications. It measures the static acceleration of gravity in tilt-sensing applications, as well as dynamic acceleration resulting from motion or shock. Its high resolution (3.9 mg/LSB) enables measurement of inclination changes less than 1.0°.Several special sensing functions are provided. Activity and inactivity sensing detect the presence or lack of motion by comparing the acceleration on any axis with user-set thresholds.Tap sensing detects single and double taps in any direction. Freefall sensing detects if the device is falling. These functions can be mapped individually to either of two interrupt output pins.An integrated memory management system with a 32-level first in,first out (FIFO) buffer can be used to store data to minimize host processor activity and lower overall system power consumption.Low power modes enable intelligent motion-based power management with threshold sensing and active acceleration measurement at extremely low power dissipation.
LibDriver ADXL345 is the full function driver of adxl345 launched by LibDriver. It provides acceleration reading, acceleration FIFO mode acquisition, free fall detection, activity /inactivity state detection, tap detection and other functions. LibDriver is MISRA compliant.
### Table of Contents
- [Instruction](#Instruction)
- [Install](#Install)
- [Usage](#Usage)
- [example basic](#example-basic)
- [example fifo](#example-fifo)
- [example interrupt](#example-interrupt)
- [Document](#Document)
- [Contributing](#Contributing)
- [License](#License)
- [Contact Us](#Contact-Us)
### Instruction
/src includes LibDriver ADXL345 source files.
/interface includes LibDriver ADXL345 IIC and SPI platform independent template.
/test includes LibDriver ADXL345 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver ADXL345 sample code.
/doc includes LibDriver ADXL345 offline document.
/datasheet includes ADXL345 datasheet.
/project includes the common Linux and MCU development board sample code. All projects use the shell script to debug the driver and the detail instruction can be found in each project's README.md.
/misra includes the LibDriver MISRA code scanning results.
### Install
Reference /interface IIC and SPI platform independent template and finish your platform IIC and SPI driver.
Add the /src directory, the interface driver for your platform, and your own drivers to your project, if you want to use the default example drivers, add the /example directory to your project.
### Usage
You can refer to the examples in the /example directory to complete your own driver. If you want to use the default programming examples, here's how to use them.
#### example basic
```C
#include "driver_adxl345_basic.h"
uint8_t res;
uint8_t i;
float g[3];
res = adxl345_basic_init(ADXL345_INTERFACE_IIC, ADXL345_ADDRESS_ALT_0);
if (res != 0)
{
return 1;
}
...
for (i = 0; i < 3; i++)
{
res = adxl345_basic_read((float *)g);
if (res != 0)
{
(void)adxl345_basic_deinit();
return 1;
}
adxl345_interface_debug_print("adxl345: x is %0.3f.\n", g[0]);
adxl345_interface_debug_print("adxl345: y is %0.3f.\n", g[1]);
adxl345_interface_debug_print("adxl345: z is %0.3f.\n", g[2]);
adxl345_interface_delay_ms(1000);
...
}
...
(void)adxl345_basic_deinit();
return 0;
```
#### example fifo
```C
#include "driver_adxl345_fifo.h"
uint8_t res;
float g[3];
void fifo_callback(float (*g)[3], uint16_t len)
{
...
return 0;
}
res = gpio_interrupt_init(adxl345_fifo_irq_handler);
if (res != 0)
{
return 1;
}
res = adxl345_fifo_init(ADXL345_INTERFACE_IIC, ADXL345_ADDRESS_ALT_0, fifo_callback);
if (res != 0)
{
(void)gpio_interrupt_deinit();
return 1;
}
while (1)
{
adxl345_interface_delay_ms(10);
...
}
...
(void)gpio_interrupt_deinit();
(void)adxl345_fifo_deinit();
return 0;
```
#### example interrupt
```C
#include "driver_adxl345_interrupt.h"
uint8_t res;
void interrupt_callback(uint8_t type)
{
switch (type)
{
case ADXL345_INTERRUPT_DATA_READY :
{
...
break;
}
case ADXL345_INTERRUPT_SINGLE_TAP :
{
adxl345_interface_debug_print("adxl345: irq single tap.\n");
...
break;
}
case ADXL345_INTERRUPT_DOUBLE_TAP :
{
adxl345_interface_debug_print("adxl345: irq double tap.\n");
...
break;
}
case ADXL345_INTERRUPT_ACTIVITY :
{
adxl345_interface_debug_print("adxl345: irq activity.\n");
...
break;
}
case ADXL345_INTERRUPT_INACTIVITY :
{
adxl345_interface_debug_print("adxl345: irq inactivity.\n");
...
break;
}
case ADXL345_INTERRUPT_FREE_FALL :
{
adxl345_interface_debug_print("adxl345: irq free fall.\n");
...
break;
}
case ADXL345_INTERRUPT_OVERRUN :
{
...
break;
}
default :
{
...
break;
}
}
}
res = gpio_interrupt_init(adxl345_interrupt_irq_handler);
if (res != 0)
{
return 1;
}
res = adxl345_interrupt_init(ADXL345_INTERFACE_SPI, ADXL345_ADDRESS_ALT_0,
interrupt_callback,
ADXL345_BOOL_TRUE
ADXL345_BOOL_TRUE,
ADXL345_BOOL_TRUE,
ADXL345_BOOL_TRUE
);
if (res != 0)
{
(void)gpio_interrupt_deinit();
return 1;
}
...
while (1)
{
if (adxl345_interrupt_server() != 0)
{
return 1;
}
adxl345_interface_delay_ms(10);
...
}
...
(void)gpio_interrupt_deinit();
(void)adxl345_interrupt_deinit();
return 0;
```
### Document
Online documents: [https://www.libdriver.com/docs/adxl345/index.html](https://www.libdriver.com/docs/adxl345/index.html).
Offline documents: /doc/html/index.html.
### Contributing
Please refer to CONTRIBUTING.md.
### License
Copyright (c) 2015 - present LibDriver All rights reserved
The MIT License (MIT)
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.
### Contact Us
Please send an e-mail to [email protected].