{"id":16146130,"url":"https://github.com/libdriver/scd4x","last_synced_at":"2025-03-16T09:33:26.610Z","repository":{"id":196664749,"uuid":"696279671","full_name":"libdriver/scd4x","owner":"libdriver","description":"SCD4X(SCD40, SCD41) full function driver library for general MCU and Linux.","archived":false,"fork":false,"pushed_at":"2025-03-14T13:47:42.000Z","size":3446,"stargazers_count":21,"open_issues_count":1,"forks_count":12,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-14T14:34:06.534Z","etag":null,"topics":["c","co2","full-function-driver","humidity","iic","linux","mcu","scd40","scd41","temperature"],"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":"2023-09-25T12:52:19.000Z","updated_at":"2025-03-14T13:47:23.000Z","dependencies_parsed_at":null,"dependency_job_id":"e4b2bf09-7ac8-421c-9f61-54dc0a5c4f78","html_url":"https://github.com/libdriver/scd4x","commit_stats":{"total_commits":4,"total_committers":2,"mean_commits":2.0,"dds":0.25,"last_synced_commit":"247182ec83985db875a7a95e59e187ba87a8e62e"},"previous_names":["hepingood/scd4x","libdriver/scd4x"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fscd4x","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fscd4x/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fscd4x/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fscd4x/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libdriver","download_url":"https://codeload.github.com/libdriver/scd4x/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243809851,"owners_count":20351407,"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","co2","full-function-driver","humidity","iic","linux","mcu","scd40","scd41","temperature"],"created_at":"2024-10-10T00:19:01.361Z","updated_at":"2025-03-16T09:33:25.470Z","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 SCD4X\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/scd4x/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)\n\nThe SCD4x is Sensirion’s next generation miniature CO2 sensor. This sensor builds on the photoacoustic NDIR sensing principle and Sensirion’s patented PASens® and CMOSens® technology to offer high accuracy at an unmatched price and smallest form factor. SMD assembly allows cost- and space-effective integration of the sensor combined with maximal freedom of design. On-chip signal compensation is realized with the built-in SHT4x humidity and temperature sensor.CO2 is a key indicator for indoor air quality (IAQ) as high levels compromise humans’ cognitive performance and well-being. The SCD4x enables smart ventilation systems to regulate ventilation in the most energy-efficient and human-friendly way. Moreover, indoor air quality monitors and other connected devices based on the SCD4x can help maintain low CO2 concentration for a healthy, productive environment.\n\nLibDriver SCD4X is a full function driver of SCD4X launched by LibDriver.It provides CO2 reading, temperature reading, humidity 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 basic](#example-basic)\n    - [example shot](#example-shot)\n  - [Document](#Document)\n  - [Contributing](#Contributing)\n  - [License](#License)\n  - [Contact Us](#Contact-Us)\n\n### Instruction\n\n/src includes LibDriver SCD4X source files.\n\n/interface includes LibDriver SCD4X IIC platform independent template.\n\n/test includes LibDriver SCD4X driver test code and this code can test the chip necessary function simply.\n\n/example includes LibDriver SCD4X sample code.\n\n/doc includes LibDriver SCD4X offline document.\n\n/datasheet includes SCD4X 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 basic\n\n```C\n#include \"driver_scd4x_basic.h\"\n\nuint8_t res;\nuint32_t i;\nuint32_t times = 3;\nuint16_t co2_ppm;\nfloat temperature;\nfloat humidity;\n\n/* basic init */\nres = scd4x_basic_init(SCD41);\nif (res != 0)\n{\n    return 1;\n}\n\n...\n    \n/* loop */\nfor (i = 0; i \u003c times; i++)\n{\n    /* delay 5000ms */\n    scd4x_interface_delay_ms(5000);\n\n    /* read data */\n    res = scd4x_basic_read((uint16_t *)\u0026co2_ppm, (float *)\u0026temperature, (float *)\u0026humidity);\n    if (res != 0)\n    {\n        (void)scd4x_basic_deinit();\n\n        return 1;\n    }\n\n    /* output */\n    scd4x_interface_debug_print(\"scd4x: %d/%d.\\n\", (uint32_t)(i + 1), (uint32_t)times);\n    scd4x_interface_debug_print(\"scd4x: co2 is %02dppm.\\n\", co2_ppm);\n    scd4x_interface_debug_print(\"scd4x: temperature is %0.2fC.\\n\", temperature);\n    scd4x_interface_debug_print(\"scd4x: humidity is %0.2f%%.\\n\", humidity);\n    \n    ...\n}\n\n...\n    \n/* basic deinit */\n(void)scd4x_basic_deinit();\n\nreturn 0;\n```\n#### example shot\n\n```C\n#include \"driver_scd4x_shot.h\"\n\nuint8_t res;\nuint32_t i;\nuint32_t times = 3;\nuint16_t co2_ppm;\nfloat temperature;\nfloat humidity;\n\n/* shot init */\nres = scd4x_shot_init(SCD41);\nif (res != 0)\n{\n    return 1;\n}\n\n...\n    \n/* loop */\nfor (i = 0; i \u003c times; i++)\n{\n    /* delay 5000ms */\n    scd4x_interface_delay_ms(5000);\n\n    /* read data */\n    res = scd4x_shot_read((uint16_t *)\u0026co2_ppm, (float *)\u0026temperature, (float *)\u0026humidity);\n    if (res != 0)\n    {\n        (void)scd4x_shot_deinit();\n\n        return 1;\n    }\n\n    /* output */\n    scd4x_interface_debug_print(\"scd4x: %d/%d.\\n\", (uint32_t)(i + 1), (uint32_t)times);\n    scd4x_interface_debug_print(\"scd4x: co2 is %02dppm.\\n\", co2_ppm);\n    scd4x_interface_debug_print(\"scd4x: temperature is %0.2fC.\\n\", temperature);\n    scd4x_interface_debug_print(\"scd4x: humidity is %0.2f%%.\\n\", humidity);\n    \n    ...\n}\n\n...\n    \n/* shot deinit */\n(void)scd4x_shot_deinit();\n\nreturn 0;\n```\n### Document\n\nOnline documents: [https://www.libdriver.com/docs/scd4x/index.html](https://www.libdriver.com/docs/scd4x/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%2Fscd4x","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibdriver%2Fscd4x","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fscd4x/lists"}