{"id":16146154,"url":"https://github.com/libdriver/max30102","last_synced_at":"2025-04-06T08:13:44.380Z","repository":{"id":40515027,"uuid":"430106000","full_name":"libdriver/max30102","owner":"libdriver","description":"MAX30102 full function driver library for general MCU and Linux.","archived":false,"fork":false,"pushed_at":"2025-03-02T14:58:46.000Z","size":7267,"stargazers_count":91,"open_issues_count":2,"forks_count":24,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-03-30T07:08:27.707Z","etag":null,"topics":["c","full-function-driver","heart-rate","iic","linux","max30102","mcu","spo2"],"latest_commit_sha":null,"homepage":"https://www.libdriver.com","language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/libdriver.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-20T13:08:55.000Z","updated_at":"2025-03-25T13:29:46.000Z","dependencies_parsed_at":"2024-03-24T10:36:59.807Z","dependency_job_id":"2c6b80f1-2d68-460f-8197-7028d647f04a","html_url":"https://github.com/libdriver/max30102","commit_stats":null,"previous_names":["libdriver/max30102","hepingood/max30102"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fmax30102","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fmax30102/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fmax30102/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fmax30102/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libdriver","download_url":"https://codeload.github.com/libdriver/max30102/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247451665,"owners_count":20940944,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c","full-function-driver","heart-rate","iic","linux","max30102","mcu","spo2"],"created_at":"2024-10-10T00:19:16.150Z","updated_at":"2025-04-06T08:13:44.361Z","avatar_url":"https://github.com/libdriver.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"[English](/README.md) | [ 简体中文](/README_zh-Hans.md) | [繁體中文](/README_zh-Hant.md) | [日本語](/README_ja.md) | [Deutsch](/README_de.md) | [한국어](/README_ko.md)\n\n\u003cdiv align=center\u003e\n\u003cimg src=\"/doc/image/logo.svg\" width=\"400\" height=\"150\"/\u003e\n\u003c/div\u003e\n\n## LibDriver MAX30102\n\n[![MISRA](https://img.shields.io/badge/misra-compliant-brightgreen.svg)](/misra/README.md) [![API](https://img.shields.io/badge/api-reference-blue.svg)](https://www.libdriver.com/docs/max30102/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)\n\nThe MAX30102 is an integrated pulse oximetry and heart-rate monitor module. It includes internal LEDs, photodetectors, optical elements, and low-noise electronics with ambient light rejection. The MAX30102 provides a complete system solution to ease the design-in process for mobile and wearable devices.The MAX30102 operates on a single 1.8V power supply and a separate 3.3V power supply for the internal LEDs. Communication is 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 wearable devices, fitness assistant devices, smartphones, tablets and so on.\n\nLibDriver MAX30102 is the full function driver of MAX30102 launched by LibDriver. It provides fifo reading, id reading and other functions. LibDriver is MISRA compliant.\n\n### Table of Contents\n\n  - [Instruction](#Instruction)\n  - [Install](#Install)\n  - [Usage](#Usage)\n    - [example fifo](#example-fifo)\n  - [Document](#Document)\n  - [Contributing](#Contributing)\n  - [License](#License)\n  - [Contact Us](#Contact-Us)\n\n### Instruction\n\n/src includes LibDriver MAX30102 source files.\n\n/interface includes LibDriver MAX30102 IIC platform independent template.\n\n/test includes LibDriver MAX30102 driver test code and this code can test the chip necessary function simply.\n\n/example includes LibDriver MAX30102 sample code.\n\n/doc includes LibDriver MAX30102 offline document.\n\n/datasheet includes MAX30102 datasheet.\n\n/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.\n\n/misra includes the LibDriver MISRA code scanning results.\n\n### Install\n\nReference /interface IIC platform independent template and finish your platform IIC driver.\n\nAdd 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.\n\n### Usage\n\nYou 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.\n\n#### example fifo\n\n```C\n#include \"driver_max30102_fifo.h\"\n\nstatic uint8_t gs_flag;\nstatic uint32_t gs_raw_red[32];\nstatic uint32_t gs_raw_ir[32];\nuint8_t res;\nuint32_t timeout;\nuint32_t times;\nuint8_t (*g_gpio_irq)(void) = NULL;\n\n...\n    \nvoid max30102_receive_callback(uint8_t type)\n{\n    switch (type)\n    {\n        case MAX30102_INTERRUPT_STATUS_FIFO_FULL :\n        {\n            uint8_t res;\n            uint8_t len;\n            \n            /* read data */\n            len = 32;\n            res = max30102_fifo_read((uint32_t *)gs_raw_red, (uint32_t *)gs_raw_ir, (uint8_t *)\u0026len);\n            if (res != 0)\n            {\n                max30102_interface_debug_print(\"max30102: read failed.\\n\");\n            }\n            max30102_interface_debug_print(\"max30102: irq fifo full with %d.\\n\", len);\n            gs_flag = 1;\n            \n            break;\n        }\n        case MAX30102_INTERRUPT_STATUS_PPG_RDY :\n        {\n            max30102_interface_debug_print(\"max30102: irq ppg rdy.\\n\");\n            \n            break;\n        }\n        case MAX30102_INTERRUPT_STATUS_ALC_OVF :\n        {\n            max30102_interface_debug_print(\"max30102: irq alc ovf.\\n\");\n            \n            break;\n        }\n        case MAX30102_INTERRUPT_STATUS_PWR_RDY :\n        {\n            max30102_interface_debug_print(\"max30102: irq pwr rdy.\\n\");\n            \n            break;\n        }\n        case MAX30102_INTERRUPT_STATUS_DIE_TEMP_RDY :\n        {\n            max30102_interface_debug_print(\"max30102: irq die temp rdy.\\n\");\n            \n            break;\n        }\n        default :\n        {\n            max30102_interface_debug_print(\"max30102: unknown code.\\n\");\n            \n            break;\n        }\n    }\n}\n\n...\n    \n/* set gpio */\ng_gpio_irq = max30102_fifo_irq_handler;\nres = gpio_interrupt_init();\nif (res != 0)\n{\n    g_gpio_irq = NULL;\n\n    return 1;\n}\n\n/* fifo init */\nres = max30102_fifo_init(max30102_receive_callback);\nif (res != 0)\n{\n    (void)gpio_interrupt_deinit();\n    g_gpio_irq = NULL;\n\n    return 1;\n}\n\n/* read data */\ntimes = 3;\ngs_flag = 0;\ntimeout = 5000;\nwhile (timeout != 0)\n{\n    if (gs_flag != 0)\n    {\n        /* clear config */\n        gs_flag = 0;\n        timeout = 5000;\n        times--;\n        if (times == 0)\n        {\n            break;\n        }\n    }\n    max30102_interface_delay_ms(1);\n    timeout--;\n}\n\n/* check timeout */\nif (timeout == 0)\n{\n    max30102_interface_debug_print(\"max30102: read timeout failed.\\n\");\n    (void)max30102_fifo_deinit();\n    (void)gpio_interrupt_deinit();\n    g_gpio_irq = NULL;\n\n    return 1;\n}\n\n(void)max30102_fifo_deinit();\n(void)gpio_interrupt_deinit();\ng_gpio_irq = NULL;\n\nreturn 0;\n```\n\n### Document\n\nOnline documents: [https://www.libdriver.com/docs/max30102/index.html](https://www.libdriver.com/docs/max30102/index.html).\n\nOffline documents: /doc/html/index.html.\n\n### Contributing\n\nPlease refer to CONTRIBUTING.md.\n\n### License\n\nCopyright (c) 2015 - present LibDriver All rights reserved\n\n\n\nThe MIT License (MIT) \n\n\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\n\nof this software and associated documentation files (the \"Software\"), to deal\n\nin the Software without restriction, including without limitation the rights\n\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\n\ncopies of the Software, and to permit persons to whom the Software is\n\nfurnished to do so, subject to the following conditions: \n\n\n\nThe above copyright notice and this permission notice shall be included in all\n\ncopies or substantial portions of the Software. \n\n\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n\nSOFTWARE. \n\n### Contact Us\n\nPlease send an e-mail to lishifenging@outlook.com.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fmax30102","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibdriver%2Fmax30102","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fmax30102/lists"}