Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/libdriver/max30105
MAX30105 full function driver library for general MCU and Linux.
https://github.com/libdriver/max30105
c full-function-driver iic linux max30105 mcu particle-sensing
Last synced: 12 days ago
JSON representation
MAX30105 full function driver library for general MCU and Linux.
- Host: GitHub
- URL: https://github.com/libdriver/max30105
- Owner: libdriver
- License: mit
- Created: 2022-01-01T18:06:54.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-31T11:39:10.000Z (2 months ago)
- Last Synced: 2024-10-11T00:19:04.308Z (28 days ago)
- Topics: c, full-function-driver, iic, linux, max30105, mcu, particle-sensing
- Language: C
- Homepage: https://www.libdriver.com
- Size: 4.68 MB
- Stars: 40
- Watchers: 146
- Forks: 112
- 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 MAX30105
[](/misra/README.md) [](https://www.libdriver.com/docs/max30105/index.html) [](/LICENSE)
The MAX30105 is an integrated particle-sensing module.It includes internal LEDs, photodetectors, optical elements and low-noise electronics with ambient light rejection. The MAX30105 provides a complete system solution to ease the design-in process of smoke detection applications including fire alarms. Due to its extremely small size, the MAX30105 can also be used as a smoke detection sensor for mobile and wearable devices.The MAX30105 operates on a single 1.8V power supply and a separate 5.0V power supply for the internal LEDs.It communicates through a standard I2C-compatible interface.The module can be shut down through software with zero standby current, allowing the power rails to remain powered at all times.It can be used in fire alarms, smoke detectors for building automation, smoke detectors for mobile devices, smoke detectors for wearable devices and so on.
LibDriver MAX30105 is the full function driver of MAX30105 launched by LibDriver. It provides fifo reading, id reading and other functions. LibDriver is MISRA compliant.
### Table of Contents
- [Instruction](#Instruction)
- [Install](#Install)
- [Usage](#Usage)
- [example fifo](#example-fifo)
- [Document](#Document)
- [Contributing](#Contributing)
- [License](#License)
- [Contact Us](#Contact-Us)
### Instruction
/src includes LibDriver MAX30105 source files.
/interface includes LibDriver MAX30105 IIC platform independent template.
/test includes LibDriver MAX30105 driver test code and this code can test the chip necessary function simply.
/example includes LibDriver MAX30105 sample code.
/doc includes LibDriver MAX30105 offline document.
/datasheet includes MAX30105 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 platform independent template and finish your platform IIC 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 fifo
```C
#include "driver_max30105_fifo.h"
static uint32_t gs_raw_red[32];
static uint32_t gs_raw_ir[32];
static uint32_t gs_raw_green[32];
uint8_t res;
uint32_t timeout;
uint32_t cnt, times;
uint8_t (*g_gpio_irq)(void) = NULL;
...
void max30105_receive_callback(uint8_t type)
{
switch (type)
{
case MAX30105_INTERRUPT_STATUS_FIFO_FULL :
{
uint8_t res;
uint8_t len;
/* read data */
len = 32;
res = max30105_fifo_read((uint32_t *)gs_raw_red, (uint32_t *)gs_raw_ir, (uint32_t *)gs_raw_green, (uint8_t *)&len);
if (res != 0)
{
max30105_interface_debug_print("max30105: read failed.\n");
}
max30105_interface_debug_print("max30105: irq fifo full with %d.\n", len);
gs_flag = 1;
break;
}
case MAX30105_INTERRUPT_STATUS_DATA_RDY :
{
max30105_interface_debug_print("max30105: irq data rdy.\n");
break;
}
case MAX30105_INTERRUPT_STATUS_ALC_OVF :
{
max30105_interface_debug_print("max30105: irq alc ovf.\n");
break;
}
case MAX30105_INTERRUPT_STATUS_PROX_INT :
{
max30105_interface_debug_print("max30105: irq prox int.\n");
break;
}
case MAX30105_INTERRUPT_STATUS_PWR_RDY :
{
max30105_interface_debug_print("max30105: irq pwr rdy.\n");
break;
}
case MAX30105_INTERRUPT_STATUS_DIE_TEMP_RDY :
{
max30105_interface_debug_print("max30105: irq die temp rdy.\n");
break;
}
default :
{
max30105_interface_debug_print("max30105: unknown code.\n");
break;
}
}
}
...
/* get times */
times = 3;
cnt = times;
/* set gpio */
g_gpio_irq = max30105_fifo_irq_handler;
res = gpio_interrupt_init();
if (res != 0)
{
g_gpio_irq = NULL;
return 1;
}
/* fifo init */
res = max30105_fifo_init(max30105_receive_callback);
if (res != 0)
{
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
...
/* read data */
gs_flag = 0;
timeout = 5000;
while (timeout != 0)
{
if (gs_flag != 0)
{
max30105_interface_debug_print("max30105: %d/%d.\n", cnt - times + 1, cnt);
/* clear config */
gs_flag = 0;
timeout = 5000;
times--;
if (times == 0)
{
break;
}
}
max30105_interface_delay_ms(1);
timeout--;
}
/* check timeout */
if (timeout == 0)
{
max30105_interface_debug_print("max30105: read timeout failed.\n");
(void)max30105_fifo_deinit();
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 1;
}
...
(void)max30105_fifo_deinit();
(void)gpio_interrupt_deinit();
g_gpio_irq = NULL;
return 0;
```
### Document
Online documents: [https://www.libdriver.com/docs/max30105/index.html](https://www.libdriver.com/docs/max30105/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].