{"id":16146166,"url":"https://github.com/libdriver/ir_remote","last_synced_at":"2025-04-06T20:13:52.628Z","repository":{"id":154066856,"uuid":"616576329","full_name":"libdriver/ir_remote","owner":"libdriver","description":"NEC IR remote decode full function driver library for general MCU and Linux.","archived":false,"fork":false,"pushed_at":"2025-03-02T13:13:46.000Z","size":2313,"stargazers_count":76,"open_issues_count":0,"forks_count":35,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-03-30T19:08:31.947Z","etag":null,"topics":["c","full-function-driver","gpio","ir-remote","linux","mcu","nec"],"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-03-20T16:52:39.000Z","updated_at":"2025-03-02T13:13:24.000Z","dependencies_parsed_at":"2024-02-14T05:26:26.202Z","dependency_job_id":"7b5c6dce-ebee-40d0-8d75-f29d4f2eb602","html_url":"https://github.com/libdriver/ir_remote","commit_stats":null,"previous_names":["libdriver/ir_remote"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fir_remote","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fir_remote/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fir_remote/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fir_remote/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libdriver","download_url":"https://codeload.github.com/libdriver/ir_remote/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247543595,"owners_count":20955865,"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","gpio","ir-remote","linux","mcu","nec"],"created_at":"2024-10-10T00:19:18.829Z","updated_at":"2025-04-06T20:13:52.610Z","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 IR_REMOTE\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/ir_remote/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)\n\nThe NEC IR transmission protocol uses pulse distance encoding of the message bits. Each pulse burst is 562.5μs in length, at a carrier frequency of 38kHz (26.3μs). Logical bits are transmitted as follows:\n\nLogical '0' – a 562.5μs pulse burst followed by a 562.5μs space, with a total transmit time of 1.125ms;\n\nLogical '1' – a 562.5μs pulse burst followed by a 1.6875ms space, with a total transmit time of 2.25ms.\n\nWhen a key is pressed on the remote controller, the message transmitted consists of the following in order: \n\n1. A 9ms leading pulse burst (16 times the pulse burst length used for a logical data bit). \n2. A 4.5ms space.\n3. The 8-bit address for the receiving device.\n4. The 8-bit logical inverse of the address.\n5. The 8-bit command.\n6. The 8-bit logical inverse of the command.\n7. A final 562.5μs pulse burst to signify the end of message transmission.\n\nLibDriver IR_REMOTE is the full function driver of ir_remote launched by LibDriver. It provides NEC IR remote decoding function. 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  - [Document](#Document)\n  - [Contributing](#Contributing)\n  - [License](#License)\n  - [Contact Us](#Contact-Us)\n\n### Instruction\n\n/src includes LibDriver IR_REMOTE source files.\n\n/interface includes LibDriver IR_REMOTE GPIO platform independent template.\n\n/test includes LibDriver IR_REMOTE driver test code and this code can test the chip necessary function simply.\n\n/example includes LibDriver IR_REMOTE sample code.\n\n/doc includes LibDriver IR_REMOTE offline document.\n\n/datasheet includes IR_REMOTE 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 GPIO platform independent template and finish your platform GPIO 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_ir_remote_basic.h\"\n\nvolatile uint8_t g_flag;                       \nuint8_t (*g_gpio_irq)(void) = NULL;                      \nuint8_t res;\nuint32_t i;\nuint16_t timeout;\n\nstatic void a_receive_callback(ir_remote_t *data)\n{\n    switch (data-\u003estatus)\n    {\n        case IR_REMOTE_STATUS_OK :\n        {\n            ir_remote_interface_debug_print(\"ir_remote: irq ok.\\n\");\n            ir_remote_interface_debug_print(\"ir_remote: add is 0x%02X and cmd is 0x%02X.\\n\", data-\u003eaddress, data-\u003ecommand);\n            g_flag = 1;\n            \n            break;\n        }\n        case IR_REMOTE_STATUS_REPEAT :\n        {\n            break;\n        }\n        case IR_REMOTE_STATUS_ADDR_ERR :\n        {\n            ir_remote_interface_debug_print(\"ir_remote: irq addr error.\\n\");\n            \n            break;\n        }\n        case IR_REMOTE_STATUS_CMD_ERR :\n        {\n            ir_remote_interface_debug_print(\"ir_remote: irq cmd error.\\n\");\n            \n            break;\n        }\n        case IR_REMOTE_STATUS_FRAME_INVALID :\n        {\n            ir_remote_interface_debug_print(\"ir_remote: irq frame invalid.\\n\");\n            \n            break;\n        }\n        default :\n        {\n            ir_remote_interface_debug_print(\"ir_remote: irq unknown status.\\n\");\n            \n            break;\n        }\n    }\n}\n\n...\n    \n/* gpio init */\nres = gpio_interrupt_init();\nif (res != 0)\n{\n    return 1;\n}\n\n/* set the irq */\ng_gpio_irq = ir_remote_basic_irq_handler;\n\n...\n    \n/* basic init */\nres = ir_remote_basic_init(a_receive_callback);\nif (res != 0)\n{\n    (void)gpio_interrupt_deinit();\n    g_gpio_irq = NULL;\n}\n\n...\n    \n/* loop */\nfor (i = 0; i \u003c times; i++)\n{\n    /* output */\n    ir_remote_interface_debug_print(\"%d/%d.\\n\", i + 1, times);\n\n    /* 5s timeout */\n    timeout = 500;\n\n    /* init 0 */\n    g_flag = 0;\n\n    /* check timeout */\n    while (timeout != 0)\n    {\n        /* check the flag */\n        if (g_flag != 0)\n        {\n            break;\n        }\n\n        /* timeout -- */\n        timeout--;\n\n        /* delay 10ms */\n        ir_remote_interface_delay_ms(10);\n    }\n\n    /* check the timeout */\n    if (timeout == 0)\n    {\n        /* receive timeout */\n        ir_remote_interface_debug_print(\"ir_remote: receive timeout.\\n\");\n        (void)ir_remote_basic_deinit();\n        (void)gpio_interrupt_deinit();\n        g_gpio_irq = NULL;\n\n        return 1;\n    }\n    \n    ....\n}\n\n...\n    \n/* basic deinit */\n(void)ir_remote_basic_deinit();\n\n/* gpio 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/ir_remote/index.html](https://www.libdriver.com/docs/ir_remote/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%2Fir_remote","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibdriver%2Fir_remote","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fir_remote/lists"}