├── LICENSE ├── README.md └── monochromeoled.go /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # MonochromeOLED Library 2 | 3 | Library for working with OLEDs on the raspberry pi. 4 | 5 | # Credit 6 | 7 | This was taken from https://github.com/goiot/devices and modified to work 8 | with both 128x32 and 128x64 SSD1306 OLEDs 9 | 10 | # License 11 | 12 | In keeping with 'goiot/devices' - Apache 2.0 13 | -------------------------------------------------------------------------------- /monochromeoled.go: -------------------------------------------------------------------------------- 1 | package monochromeoled 2 | 3 | // Modified from the original code at https://github.com/goiot/devices/tree/master/monochromeoled 4 | // Works with 128x62 and 128x32 5 | 6 | import ( 7 | "fmt" 8 | "image" 9 | 10 | "golang.org/x/exp/io/i2c" 11 | "golang.org/x/exp/io/i2c/driver" 12 | ) 13 | 14 | const ( 15 | // On or off registers. 16 | ssd1306DisplayOn = 0xAf 17 | ssd1306DisplayOff = 0xAe 18 | 19 | // Scrolling registers. 20 | ssd1306ActivateScroll = 0x2F 21 | ssd1306DeactivateScroll = 0x2E 22 | ssd1306SetVerticalScrollArea = 0xA3 23 | ssd1306RightHorizontalScroll = 0x26 24 | ssd1306LeftHorizontalScroll = 0x27 25 | ssd1306VerticalAndRightHorizontalScroll = 0x29 26 | ssd1306VerticalAndLeftHorizontalScroll = 0x2A 27 | ) 28 | 29 | // OLED represents an SSD1306 OLED display. 30 | type OLED struct { 31 | dev *i2c.Device 32 | 33 | w int // width of the display 34 | h int // height of the display 35 | buf []byte // each pixel is represented by a bit 36 | } 37 | 38 | // Open opens an SSD1306 OLED display. Once not in use, it needs to 39 | // be close by calling Close. 40 | // The default width is 128, height is 64 if zero values are given. 41 | func Open(o driver.Opener, addr, w, h int) (*OLED, error) { 42 | dev, err := i2c.Open(o, addr) 43 | buf := make([]byte, w*(h/8)+1) 44 | buf[0] = 0x40 // start frame of pixel data 45 | oled := &OLED{dev: dev, w: w, h: h, buf: buf} 46 | err = oled.Init() 47 | if err != nil { 48 | return nil, err 49 | } 50 | return oled, nil 51 | } 52 | 53 | // Init sets up the display for writing 54 | func (o *OLED) Init() (err error) { 55 | err = o.dev.Write([]byte{ 56 | 0xae, 57 | 0x00 | 0x00, // row offset 58 | 0x10 | 0x00, // column offset 59 | 0xd5, 0x80, 60 | 0xa8, uint8(o.h - 1), 61 | 0xd3, 0x00, // set display offset to no offset 62 | 0x80 | 0, 63 | 0x8d, 0x14, 64 | 0x20, 0x0, 65 | 66 | 0xA0 | 0x1, 67 | 0xC8, 68 | }) 69 | if err != nil { 70 | return 71 | } 72 | if o.h == 32 { 73 | err = o.dev.Write([]byte{ 74 | 0xda, 0x02, 75 | 0x81, 0x8f, // set contrast 76 | }) 77 | } 78 | if o.h == 64 { 79 | err = o.dev.Write([]byte{ 80 | 0xda, 0x12, 81 | 0x81, 0x7f, // set contrast 82 | }) 83 | } 84 | err = o.dev.Write([]byte{ 85 | 0x9d, 0xf1, 86 | 0xdb, 0x40, 87 | 0xa4, 0xa6, 88 | 89 | 0x2e, 90 | 0xaf, 91 | }) 92 | return 93 | } 94 | 95 | // On turns on the display if it is off. 96 | func (o *OLED) On() error { 97 | return o.dev.Write([]byte{ssd1306DisplayOn}) 98 | } 99 | 100 | // Off turns off the display if it is on. 101 | func (o *OLED) Off() error { 102 | return o.dev.Write([]byte{ssd1306DisplayOff}) 103 | } 104 | 105 | // Clear clears the entire display. 106 | func (o *OLED) Clear() error { 107 | for i := 1; i < len(o.buf); i++ { 108 | o.buf[i] = 0 109 | } 110 | return o.Draw() 111 | } 112 | 113 | // SetPixel set and x,y pixel to on or off 114 | func (o *OLED) SetPixel(x, y int, v byte) error { 115 | if x >= o.w || y >= o.h { 116 | return fmt.Errorf("(x=%v, y=%v) is out of bounds on this %vx%v display", x, y, o.w, o.h) 117 | } 118 | if v > 1 { 119 | return fmt.Errorf("value needs to be either 0 or 1; given %v", v) 120 | } 121 | i := 1 + x + (y/8)*o.w 122 | if v == 0 { 123 | o.buf[i] &= ^(1 << uint((y & 7))) 124 | } else { 125 | o.buf[i] |= 1 << uint((y & 7)) 126 | } 127 | return nil 128 | } 129 | 130 | // SetImage draws an image on the display buffer starting from x, y. 131 | // A call to Draw is required to display it on the OLED display. 132 | func (o *OLED) SetImage(x, y int, img image.Image) error { 133 | imgW := img.Bounds().Dx() 134 | imgH := img.Bounds().Dy() 135 | 136 | endX := x + imgW 137 | endY := y + imgH 138 | 139 | if endX >= o.w { 140 | endX = o.w 141 | } 142 | if endY >= o.h { 143 | endY = o.h 144 | } 145 | 146 | var imgI, imgY int 147 | for i := x; i < endX; i++ { 148 | imgY = 0 149 | for j := y; j < endY; j++ { 150 | r, g, b, _ := img.At(imgI, imgY).RGBA() 151 | var v byte 152 | if r+g+b > 0 { 153 | v = 0x1 154 | } 155 | if err := o.SetPixel(i, j, v); err != nil { 156 | return err 157 | } 158 | imgY++ 159 | } 160 | imgI++ 161 | } 162 | return nil 163 | } 164 | 165 | // Draw draws the intermediate pixel buffer on the display. 166 | // See SetPixel and SetImage to mutate the buffer. 167 | func (o *OLED) Draw() error { 168 | if err := o.dev.Write([]byte{ 169 | 0xa4, // write mode 170 | 0x40 | 0, // start line = 0 171 | 0x21, 0, uint8(o.w), 172 | 0x22, 0, 7, 173 | }); err != nil { // the write mode 174 | return err 175 | } 176 | return o.dev.Write(o.buf) 177 | } 178 | 179 | // EnableScroll starts scrolling in the horizontal direction starting from 180 | // startY column to endY column. 181 | func (o *OLED) EnableScroll(startY, endY int) error { 182 | panic("not implemented") 183 | } 184 | 185 | // DisableScroll stops the scrolling on the display. 186 | func (o *OLED) DisableScroll() error { 187 | panic("not implemented") 188 | } 189 | 190 | // Width returns the display width. 191 | func (o *OLED) Width() int { return o.w } 192 | 193 | // Height returns the display height. 194 | func (o *OLED) Height() int { return o.h } 195 | 196 | // Close closes the display. 197 | func (o *OLED) Close() error { 198 | return o.dev.Close() 199 | } 200 | --------------------------------------------------------------------------------