{"id":16239765,"url":"https://github.com/nopnop2002/esp-idf-rotaryencoder","last_synced_at":"2025-10-14T22:07:31.522Z","repository":{"id":175982957,"uuid":"611623755","full_name":"nopnop2002/esp-idf-RotaryEncoder","owner":"nopnop2002","description":"RotaryEncoder driver for esp-idf","archived":false,"fork":false,"pushed_at":"2025-05-29T01:49:08.000Z","size":10,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-11T21:54:25.822Z","etag":null,"topics":["esp-idf","esp32","rotary-encoder"],"latest_commit_sha":null,"homepage":"","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/nopnop2002.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2023-03-09T07:54:59.000Z","updated_at":"2025-06-10T18:19:35.000Z","dependencies_parsed_at":null,"dependency_job_id":"56144a01-3b92-42ca-9e54-4c5983ab344d","html_url":"https://github.com/nopnop2002/esp-idf-RotaryEncoder","commit_stats":null,"previous_names":["nopnop2002/esp-idf-rotaryencoder"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/nopnop2002/esp-idf-RotaryEncoder","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nopnop2002%2Fesp-idf-RotaryEncoder","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nopnop2002%2Fesp-idf-RotaryEncoder/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nopnop2002%2Fesp-idf-RotaryEncoder/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nopnop2002%2Fesp-idf-RotaryEncoder/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nopnop2002","download_url":"https://codeload.github.com/nopnop2002/esp-idf-RotaryEncoder/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nopnop2002%2Fesp-idf-RotaryEncoder/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274215624,"owners_count":25242966,"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","status":"online","status_checked_at":"2025-09-08T02:00:09.813Z","response_time":121,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["esp-idf","esp32","rotary-encoder"],"created_at":"2024-10-10T13:45:06.013Z","updated_at":"2025-10-14T22:07:26.474Z","avatar_url":"https://github.com/nopnop2002.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"# esp-idf-RotaryEncoder\nRotaryEncoder driver for esp-idf.\n\nI ported from [this](https://haizairenmei.com/2019/12/05/rotary-encoder/).   \nCalculating the direction of movement is very simple.   \nThis is the Japanese homepage.    \n\n# Software requirements   \nESP-IDF V5.0 or later.   \nESP-IDF V4.4 release branch reached EOL in July 2024.   \nESP-IDF V5.1 is required when using ESP32C6.   \n\n# Installation\n```\ngit clone https://github.com/nopnop2002/esp-idf-RotaryEncoder\ncd esp-idf-RotaryEncoder\nidf.py set-target {esp32/esp32s2/esp32s3/esp32c2/esp32c3/esp32c6}\nidf.py menuconfig\nidf.py flash\n```\n\n# Configure for RotaryEncoder\n\n![config-top-encoder1](https://user-images.githubusercontent.com/6020549/223957718-6e0f99b7-2d86-4a99-b29b-b041238d2ecc.jpg)\n![config-top-encoder2](https://user-images.githubusercontent.com/6020549/223957750-3547a623-0d32-4a6b-be5e-e619eb68cdd4.jpg)\n\n\n# Configure for Appication\nThere are 2 APIs.   \nOne is an API that uses CallBack and the other is an API that does not use CallBack.   \n\n![config-top-app1](https://user-images.githubusercontent.com/6020549/223958108-88626cf1-d20f-4efa-a908-2d8b726eb27b.jpg)\n![config-top-app2](https://user-images.githubusercontent.com/6020549/223958112-1be05f0a-b40f-4d8e-93dc-20b58dd47862.jpg)\n![config-top-app3](https://user-images.githubusercontent.com/6020549/223958114-cbe27c66-4247-4ad0-bb46-b7d7e0a06e91.jpg)\n\n\n\n# Wireing\n\n|RotaryEncoder||ESP32|ESP32-S2/S3|ESP32-C2/C3/C6|\n|:-:|:-:|:-:|:-:|:-:|\n|OUT A|--|GPIO15|GPIO15|GPIO1|\n|OUT B|--|GPIO16|GPIO16|GPIO2|\n|SWITCH|--|GPIO17|GPIO17|GPIO3|\n|GND|--|GND|GND|GND|\n|VCC|--|3.3V|3.3V|3.3V|\n\nYou can change any GPIO using menuconfig.   \n\n![KY-04-Rotary-Encoder-Pinout](https://user-images.githubusercontent.com/6020549/223959379-0fa835f7-8e8f-454b-8147-7b02e5173fb5.jpg)\n\nThe RotaryEncoder has two forms, but the functionality is the same.\n![rotary-encoder](https://user-images.githubusercontent.com/6020549/223959616-e994e8ad-d612-414a-999e-dfc46d2b193c.jpeg)\n\n\n# How to use this component in your project   \nCreate idf_component.yml in the same directory as main.c.   \n```\nYourProject --+-- CMakeLists.txt\n              +-- main --+-- main.c\n                         +-- CMakeLists.txt\n                         +-- idf_component.yml\n```\n\nContents of idf_component.yml.\n```\ndependencies:\n  nopnop2002/RotaryEncoder:\n    path: components/RotaryEncoder\n    git: https://github.com/nopnop2002/esp-idf-RotaryEncoder.git\n```\n\nWhen you build a projects esp-idf will automaticly fetch repository to managed_components dir and link with your code.   \n```\nYourProject --+-- CMakeLists.txt\n              +-- main --+-- main.c\n              |          +-- CMakeLists.txt\n              |          +-- idf_component.yml\n              +-- managed_components ----- nopnop2002__RotaryEncoder\n```\n\n\n# ScreenShot   \nThe value of Count changes by 4 per click.   \n![ScreenShot](https://user-images.githubusercontent.com/6020549/223961866-44fbde58-b12e-498a-84e4-c50929e373f5.jpg)\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnopnop2002%2Fesp-idf-rotaryencoder","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnopnop2002%2Fesp-idf-rotaryencoder","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnopnop2002%2Fesp-idf-rotaryencoder/lists"}