{"id":20587198,"url":"https://github.com/sparkfun/sparkfun_micro_oled_arduino_library","last_synced_at":"2025-07-09T11:05:55.807Z","repository":{"id":30984922,"uuid":"34543231","full_name":"sparkfun/SparkFun_Micro_OLED_Arduino_Library","owner":"sparkfun","description":"Arduino library for the SparkFun Micro OLED - a breakout board for a monochrome, 0.66\", 64x48 OLED display. ","archived":false,"fork":false,"pushed_at":"2025-06-17T12:59:06.000Z","size":513,"stargazers_count":83,"open_issues_count":1,"forks_count":58,"subscribers_count":47,"default_branch":"main","last_synced_at":"2025-07-09T11:05:46.419Z","etag":null,"topics":["arduino-library","oled","oled-display"],"latest_commit_sha":null,"homepage":null,"language":"C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sparkfun.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-04-24T21:39:53.000Z","updated_at":"2025-06-17T12:59:10.000Z","dependencies_parsed_at":"2022-08-26T15:41:45.833Z","dependency_job_id":null,"html_url":"https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library","commit_stats":null,"previous_names":[],"tags_count":20,"template":false,"template_full_name":null,"purl":"pkg:github/sparkfun/SparkFun_Micro_OLED_Arduino_Library","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2FSparkFun_Micro_OLED_Arduino_Library","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2FSparkFun_Micro_OLED_Arduino_Library/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2FSparkFun_Micro_OLED_Arduino_Library/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2FSparkFun_Micro_OLED_Arduino_Library/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sparkfun","download_url":"https://codeload.github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sparkfun%2FSparkFun_Micro_OLED_Arduino_Library/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264446716,"owners_count":23609632,"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":["arduino-library","oled","oled-display"],"created_at":"2024-11-16T07:16:25.739Z","updated_at":"2025-07-09T11:05:55.772Z","avatar_url":"https://github.com/sparkfun.png","language":"C","funding_links":[],"categories":[],"sub_categories":[],"readme":"SparkFun Micro OLED Breakout Arduino Library\n========================================\n\n\u003ctable class=\"table table-hover table-striped table-bordered\"\u003e\n  \u003ctr align=\"center\"\u003e\n   \u003ctd\u003e\u003ca href=\"https://www.sparkfun.com/products/13003\"\u003e\u003cimg src=\"https://cdn.sparkfun.com//assets/parts/9/9/5/6/OLED_Action.jpg\" alt=\"SparkFun Micro OLED Breakout\"\u003e\u003c/a\u003e\u003c/td\u003e\n   \u003ctd\u003e\u003ca href=\"https://www.sparkfun.com/products/14532\"\u003e\u003cimg src=\"https://cdn.sparkfun.com//assets/parts/1/2/6/2/1/14532-SparkFun_Micro_OLED_Breakout__Qwiic_-01.jpg\" alt=\"SparkFun Micro OLED Breakout (Qwiic)\"\u003e\u003c/a\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr align=\"center\"\u003e\n    \u003ctd\u003e\u003ci\u003e\u003ca href=\"https://www.sparkfun.com/products/13003\"\u003eSparkFun Micro OLED Breakout (LCD-13003)\u003c/a\u003e\u003c/i\u003e\u003c/td\u003e\n    \u003ctd\u003e\u003ci\u003e\u003ca href=\"https://www.sparkfun.com/products/14532\"\u003eSparkFun Micro OLED Breakout (Qwiic)\u003c/a\u003e\u003c/i\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\nAn Arduino library that allows you to draw shapes and text on the Micro OLED display and Qwiic micro OLED breakout.\n\nRepository Contents\n-------------------\n\n* **/examples** - Example sketches for the library (.ino). Run these from the Arduino IDE.\n* **/src** - Source files for the library (.cpp, .h).\n* **keywords.txt** - Keywords from this library that will be highlighted in the Arduino IDE.\n* **library.properties** - General library properties for the Arduino package manager.\n\nDocumentation\n--------------\n\n* **[Installing an Arduino Library Guide](https://learn.sparkfun.com/tutorials/installing-an-arduino-library)** - Basic information on how to install an Arduino library.\n* **[Product Repository](https://github.com/sparkfun/Micro_OLED_Breakout)** - Main repository (including hardware files) for the Micro OLED Breakout.\n* **[Hookup Guide](https://learn.sparkfun.com/tutorials/micro-oled-breakout-hookup-guide)** - Hookup guide for the Micro OLED Breakout.\n* **[Hookup Guide (Qwiic version)](https://learn.sparkfun.com/tutorials/718)** - Hookup guide for the Micro OLED Breakout (Qwiic).\n\nProducts that use this Library\n---------------------------------\n\n* [Micro OLED Breakout](https://www.sparkfun.com/products/13003)- A breakout for the monochrome 64x48 OLED.\n* [Micro OLED Breakout (Qwiic)](https://www.sparkfun.com/products/14532) - Qwiic version of the Micro OLED breakout with jumpers set for I2C\n\nContributing\n--------------\n\nIf you would like to contribute to this library: please do, we truly appreciate it, but please follow [these guidelines](./CONTRIBUTING.md). Thanks!\n\nMicroOLED: Version 1.3 - A New Hope\n---------------\n\nPrior to version 1.3, this library was hard-wired to the ```Wire``` I\u003csup\u003e2\u003c/sup\u003eC and ```SPI``` ports. Version 1.3\nallows alternate ports to be used, in a way which is backward-compatible with the previous versions.\n\nWe have of course tested the new code, but if you do notice any compatibility issues please\n[raise an issue](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/issues).\n\n### I\u003csup\u003e2\u003c/sup\u003eC Example\n\nPrior to v1.3, you would have used:\n```\n#define DC_JUMPER 1\nMicroOLED oled(PIN_RESET, DC_JUMPER); // I2C declaration\n```\n\nfollowed by:\n```\noled.begin();    // Initialize the OLED\n```\n\nFrom v1.3.0, you can still do it that way, or can do it like this:\n```\nMicroOLED oled(PIN_RESET); // The TwoWire I2C port is passed to .begin instead\n```\n\nfollowed by:\n```\noled.begin(0x3D, Wire);    // Initialize the OLED using address 0x3D and the Wire port\n```\n\nTo use a non-standard address or port, you can call:\n```\noled.begin(0x3C, Qwiic);    // Initialize the OLED using address 0x3C and the Qwiic port\n```\n\nPlease see [this example](./examples/Example10_MultiDemo_v13/Example10_MultiDemo_v13.ino) for more details.\n\n### SPI Example\n\nFor SPI in v1.3, you still need to instantiate the oled using:\n```\nMicroOLED oled(PIN_RESET, PIN_DC, PIN_CS); //SPI declaration\n```\n\nIf you want to use _SPI_ as the SPIClass, then you can continue to call:\n```\n  oled.begin();    // Initialize the OLED\n```\n\nTo use a non-standard port, call:\n```\n  oled.begin(SPI1);    // Initialize the OLED using SPI1\n```\n\nPlease see [this example](./examples/SPI/MicroOLED_Demo_v13/MicroOLED_Demo_v13.ino) for more details.\n\nVersion History\n---------------\n\n* [v 1.3.2](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v1.3.2) - adds support for APOLLO3 v2, allow fonts to be included/excluded individually\n* [v 1.3.0](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v1.3.0) - adding support for non-standard I\u003csup\u003e2\u003c/sup\u003eC and SPI ports\n* [v 1.2.10](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v1.2.10) - prevent-write-outside-buffer corrections; improved I2C transfer speeds; includes the missing scroll functions; ```line``` corrections; ```enableDebugging```.\n* [v 1.2.9](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v1.2.9) - drawIcon() correction\n* [v 1.2.8](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v1%2C2.8) - Add drawIcon() and resort examples with Qwiic as default.\n* [v 1.2.7](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v1.2.7) - Add more comments and Wire.begin() to examples\n* [v 1.2.6](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/V_1.2.6) - Removes call of Wire.begin from library\n* [v 1.2.5](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v1.2.5) - Adding Qwiic Examples for I2C\n* [v 1.2.4](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v.1.2.4) - Add colon to 7-segment font, add version history information to README, move and rename swap function to avoid namespace issues, add support for Arduino 101.\n* [v 1.2.3](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/v1.2.3) -- Fix for I2C dcPin not configured\n* [v 1.2.0](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/releases/tag/V_1.2.0) - add SAMD21 support, fix PROGMEM and `_BV` errors\n* v 1.1.3 (not released)\n* [v 1.1.2](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/tree/V_1.1.2) - Added compatibility for ESP8266\n* [v 1.1.1](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/tree/V_1.1.1) - Changed to remove register level pin access, for cross-platform compatibility\n* [v 1.1.0](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/tree/V_1.1.0) - Matching 1.6 standard\n* [V 1.0.0](https://github.com/sparkfun/SparkFun_Micro_OLED_Arduino_Library/tree/V_1.0.0) - Initial release\n\nLicense Information\n-------------------\n\nThis product is _**open source**_!\n\nPlease see [LICENSE.md](./LICENSE.md) for more information.\n\nDistributed as-is; no warranty is given.\n\n- Your friends at SparkFun.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkfun%2Fsparkfun_micro_oled_arduino_library","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsparkfun%2Fsparkfun_micro_oled_arduino_library","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsparkfun%2Fsparkfun_micro_oled_arduino_library/lists"}