{"id":16146125,"url":"https://github.com/libdriver/ssd1306","last_synced_at":"2025-05-15T19:06:37.379Z","repository":{"id":39914682,"uuid":"367809992","full_name":"libdriver/ssd1306","owner":"libdriver","description":"SSD1306 full-featured driver library for general MCU and Linux.","archived":false,"fork":false,"pushed_at":"2025-04-19T03:41:35.000Z","size":4997,"stargazers_count":498,"open_issues_count":1,"forks_count":102,"subscribers_count":24,"default_branch":"main","last_synced_at":"2025-04-19T11:51:04.838Z","etag":null,"topics":["c","full-featured-driver","iic","linux","mcu","oled","spi","ssd1306"],"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-05-16T07:14:21.000Z","updated_at":"2025-04-19T03:41:15.000Z","dependencies_parsed_at":"2024-12-13T17:06:45.627Z","dependency_job_id":"7325d3f6-16f4-4148-9911-fd3ebbe851c6","html_url":"https://github.com/libdriver/ssd1306","commit_stats":{"total_commits":40,"total_committers":3,"mean_commits":"13.333333333333334","dds":"0.15000000000000002","last_synced_commit":"24cff05846d9f9bfec8c2a67e7427911874c358b"},"previous_names":["libdriver/ssd1306"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fssd1306","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fssd1306/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fssd1306/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/libdriver%2Fssd1306/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/libdriver","download_url":"https://codeload.github.com/libdriver/ssd1306/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254404357,"owners_count":22065641,"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-featured-driver","iic","linux","mcu","oled","spi","ssd1306"],"created_at":"2024-10-10T00:18:58.187Z","updated_at":"2025-05-15T19:06:37.370Z","avatar_url":"https://github.com/libdriver.png","language":"C","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 SSD1306\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/ssd1306/index.html) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](/LICENSE)\n\nSSD1306 is a single-chip CMOS OLED/PLED driver with controller for organic / polymer light emitting diode dot-matrix graphic display system. It consists of 128 segments and 64 commons. This IC is designed for Common Cathode type OLED panel.The SSD1306 embeds with contrast control, display RAM and oscillator, which reduces the number of external components and power consumption. It has 256-step brightness control. Data/Commands are sent from general MCU through the hardware selectable 6800/8000 series compatible Parallel Interface, I2C interface or Serial Peripheral Interface. It is suitable for many compact portable applications, such as mobile phone sub-display, MP3 player and calculator, etc.\n\nLibDriver SSD1306 is a full-featured driver of SSD1306 launched by LibDriver.It provides the functions of drawing single point, filling block, image display, etc. 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 advance](#example-advance)\n  - [Document](#Document)\n  - [Contributing](#Contributing)\n  - [License](#License)\n  - [Contact Us](#Contact-Us)\n\n### Instruction\n\n/src includes LibDriver SSD1306 source files.\n\n/interface includes LibDriver SSD1306 IIC, SPI platform independent template.\n\n/test includes LibDriver SSD1306 driver test code and this code can test the chip necessary function simply.\n\n/example includes LibDriver SSD1306 sample code.\n\n/doc includes LibDriver SSD1306 offline document.\n\n/datasheet includes SSD1306 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, SPI platform independent template and finish your platform IIC, SPI 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_ssd1306_basic.h\"\n\nuint8_t res;\n\nres = ssd1306_basic_init(SSD1306_INTERFACE_IIC, SSD1306_ADDR_SA0_0);\nif (res != 0)\n{\n    return 1;\n}\n\n...\n\nres = ssd1306_basic_clear();\nif (res != 0)\n{\n    ssd1306_interface_debug_print(\"ssd1306: clear screen failed.\\n\");\n    (void)ssd1306_basic_deinit();\n\n    return 1;\n}\nres = ssd1306_basic_string(0, 0, \"123\", 3, 1, SSD1306_FONT_16);\nif (res != 0)\n{\n    ssd1306_interface_debug_print(\"ssd1306: show string failed.\\n\");\n    (void)ssd1306_basic_deinit();\n\n    return 1;\n}\n\n...\n\nres = ssd1306_basic_rect(0, 31, 31, 31, 1);\nif (res != 0)\n{\n    (void)ssd1306_basic_deinit();\n\n    return 1;\n}    \n\n...\n\n(void)ssd1306_basic_deinit();\n\nreturn 0;\n```\n\n#### example advance\n\nThe image extraction format is as follows and every pixel stored in one byte.\n\n\u003cdiv align=center\u003e\n\u003cimg src=\"/doc/image/image_format.svg\" width=\"220\" height=\"220\"/\u003e\n\u003c/div\u003e\n\n```C\n#include \"driver_ssd1306_advance.h\"\n\nuint8_t res;\nuint8_t image[8192];\n\nres = ssd1306_advance_init(SSD1306_INTERFACE_IIC, SSD1306_ADDR_SA0_0);\nif (res != 0)\n{\n    return 1;\n}\n\n...\n\nres = ssd1306_advance_clear();\nif (res != 0)\n{\n    ssd1306_interface_debug_print(\"ssd1306: clear screen failed.\\n\");\n    (void)ssd1306_advance_deinit();\n\n    return 1;\n}\nres = ssd1306_advance_string(0, 0, \"123\", 3, 1, SSD1306_FONT_16);\nif (res != 0)\n{\n    ssd1306_interface_debug_print(\"ssd1306: show string failed.\\n\");\n    (void)ssd1306_advance_deinit();\n\n    return 1;\n}\n\n...\n\nres = ssd1306_advance_write_point(38, 38, 1);\nif (res != 0)\n{\n    (void)ssd1306_advance_deinit();\n\n    return 1;\n}\n\n...\n\nres = ssd1306_advance_rect(0, 31, 31, 31, 1);\nif (res != 0)\n{\n    (void)ssd1306_advance_deinit();\n\n    return 1;\n}\n\n...\n\nres = ssd1306_advance_fade_blinking(SSD1306_FADE_BLINKING_MODE_BLINKING, 0);\nif (res != 0)\n{\n    (void)ssd1306_advance_deinit();\n\n    return 1;\n}\n\n...\n\nres = ssd1306_advance_vertical_left_horizontal_scroll(0, 7, 0, SSD1306_SCROLL_FRAME_2);\nif (res != 0)\n{\n    (void)ssd1306_advance_deinit();\n\n    return 1;\n}\n\n...\n\nres = ssd1306_advance_picture(0, 0, 0, 0, image);\nif (res != 0)\n{\n    (void)ssd1306_advance_deinit();\n\n    return 1;\n}\n\n...\n\n(void)ssd1306_advance_deinit();\n\nreturn 0;\n```\n\n### Document\n\nOnline documents: [https://www.libdriver.com/docs/ssd1306/index.html](https://www.libdriver.com/docs/ssd1306/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.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fssd1306","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flibdriver%2Fssd1306","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flibdriver%2Fssd1306/lists"}