├── .github └── workflows │ └── go.yml ├── 99-ledbadge.rules ├── LICENSE ├── README.md ├── go.mod ├── go.sum └── main.go /.github/workflows/go.yml: -------------------------------------------------------------------------------- 1 | name: Build and upload 2 | 3 | on: 4 | push: 5 | tags: 6 | - "v*.*.*" 7 | 8 | permissions: 9 | contents: write 10 | 11 | jobs: 12 | shipit: 13 | runs-on: ubuntu-latest 14 | steps: 15 | - uses: actions/checkout@v4 16 | 17 | - name: Set up Go 18 | uses: actions/setup-go@v4 19 | with: 20 | go-version: '1.20' 21 | 22 | - name: Build 23 | run: go build . 24 | 25 | - name: Upload 26 | uses: softprops/action-gh-release@v2 27 | with: 28 | files: badgemagic-tool 29 | token: ${{ secrets.GITHUB_TOKEN }} 30 | -------------------------------------------------------------------------------- /99-ledbadge.rules: -------------------------------------------------------------------------------- 1 | SUBSYSTEM=="usb", ATTR{idVendor}="0416", ATTR{idProduct}=="5020", GROUP="plugdev" 2 | -------------------------------------------------------------------------------- /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 | # Badge "Magic" Tool 2 | 3 | ## Download font 4 | 5 | NOTE: This step is optional, getting you a nice compact font. 6 | 7 | http://littlelimit.net/k8x12.htm 8 | 9 | ```sh 10 | wget https://littlelimit.net/arc/k8x12/k8x12_ttf_2021-05-05.zip 11 | unzip -d k8x12 k8x12_ttf_2021-05-05.zip 12 | ``` 13 | 14 | ## Download prebuilt version 15 | 16 | ```sh 17 | wget https://github.com/fossasia/badgemagic-go/releases/download/v0.0.10/badgemagic-tool 18 | chmod +x badgemagic-tool # set executable permissions 19 | ``` 20 | 21 | ## Run it 22 | 23 | ```sh 24 | sudo ./badgemagic-tool -mode anim "Your text..." 25 | ``` 26 | 27 | NOTE: By default, the font is assumed to be in a subdirectory named `k8x12`. 28 | 29 | With custom font: 30 | 31 | ```sh 32 | sudo ./badgemagic-tool -mode anim -font path/to/font.ttf "Your text..." 33 | ``` 34 | 35 | NOTE: If you set up udev rules, you will not need `sudo`. 36 | Copy the file `99-ledbadge.rules` to `/etc/udev/rules.d/`. 37 | 38 | ## Build yourelf 39 | 40 | Given a Go compiler, after cloning this repository: 41 | 42 | ```sh 43 | go build . 44 | ``` 45 | -------------------------------------------------------------------------------- /go.mod: -------------------------------------------------------------------------------- 1 | module github.com/fossasia/badgemagic-tool 2 | 3 | go 1.18 4 | 5 | require ( 6 | github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0 7 | github.com/karalabe/hid v1.0.1-0.20240919124526-821c38d2678e 8 | golang.org/x/image v0.15.0 9 | ) 10 | -------------------------------------------------------------------------------- /go.sum: -------------------------------------------------------------------------------- 1 | github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0 h1:DACJavvAHhabrF08vX0COfcOBJRhZ8lUbR+ZWIs0Y5g= 2 | github.com/golang/freetype v0.0.0-20170609003504-e2365dfdc4a0/go.mod h1:E/TSTwGwJL78qG/PmXZO1EjYhfJinVAhrmmHX6Z8B9k= 3 | github.com/karalabe/hid v1.0.0 h1:+/CIMNXhSU/zIJgnIvBD2nKHxS/bnRHhhs9xBryLpPo= 4 | github.com/karalabe/hid v1.0.0/go.mod h1:Vr51f8rUOLYrfrWDFlV12GGQgM5AT8sVh+2fY4MPeu8= 5 | github.com/karalabe/hid v1.0.1-0.20240919124526-821c38d2678e h1:ryNJIEs1fyZNVwJ/Dsz7+EFZTow0ggBdnAIVo8SAs+A= 6 | github.com/karalabe/hid v1.0.1-0.20240919124526-821c38d2678e/go.mod h1:qk1sX/IBgppQNcGCRoj90u6EGC056EBoIc1oEjCWla8= 7 | golang.org/x/image v0.15.0 h1:kOELfmgrmJlw4Cdb7g/QGuB3CvDrXbqEIww/pNtNBm8= 8 | golang.org/x/image v0.15.0/go.mod h1:HUYqC05R2ZcZ3ejNQsIHQDQiwWM4JBqmm6MKANTp4LE= 9 | -------------------------------------------------------------------------------- /main.go: -------------------------------------------------------------------------------- 1 | package main 2 | 3 | import ( 4 | "bytes" 5 | "encoding/binary" 6 | "encoding/hex" 7 | "errors" 8 | "flag" 9 | "fmt" 10 | "image" 11 | "image/color" 12 | "io/ioutil" 13 | "log" 14 | "os" 15 | "time" 16 | 17 | _ "image/gif" 18 | _ "image/jpeg" 19 | _ "image/png" 20 | 21 | "github.com/golang/freetype/truetype" 22 | 23 | "golang.org/x/image/font" 24 | "golang.org/x/image/math/fixed" 25 | 26 | "github.com/golang/freetype" 27 | 28 | "github.com/karalabe/hid" 29 | ) 30 | 31 | var testData = []byte{ 32 | 119, 97, 110, 103, 0, 0, 0, 0, 69, 69, 69, 69, 69, 69, 69, 69, 0, 11, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 19, 8, 30, 23, 11, 39, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 25, 0, 17, 0, 4, 64, 32, 63, 0, 0, 0, 128, 7, 4, 4, 7, 64, 132, 135, 0, 0, 0, 0, 128, 128, 0, 128, 159, 149, 149, 0, 0, 0, 0, 0, 4, 36, 4, 36, 36, 36, 0, 0, 0, 0, 1, 1, 241, 145, 241, 129, 240, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 51, 0, 17, 0, 4, 0, 96, 63, 0, 0, 0, 0, 7, 4, 4, 7, 0, 196, 135, 0, 0, 0, 0, 128, 128, 0, 128, 159, 149, 149, 0, 0, 0, 0, 0, 4, 36, 4, 36, 36, 36, 0, 0, 0, 0, 1, 1, 241, 145, 241, 129, 240, 1, 0, 0, 0, 0, 0, 0, 0, 0} 33 | 34 | // DisplayMode how message is displayed on screen 35 | type DisplayMode int 36 | 37 | const ( 38 | // ModeScrollLeft scrolls from right to left 39 | ModeScrollLeft DisplayMode = iota 40 | // ModeScrollRight scrolls from left to right 41 | ModeScrollRight 42 | // ModeScrollUp gfx scrolls up 43 | ModeScrollUp 44 | // ModeScrollDown gfx scrolls down 45 | ModeScrollDown 46 | // ModeStillCenter gfx stays in middle 47 | ModeStillCenter 48 | // ModeAnimation quickly repeats frames 49 | ModeAnimation 50 | // ModeDropDown drop-down 51 | ModeDropDown 52 | // ModeCurtain opening-closing curtains 53 | ModeCurtain 54 | // ModeLaser laser-engraving 55 | ModeLaser 56 | ) 57 | 58 | // Message one frame 59 | type Message struct { 60 | Speed int 61 | Mode DisplayMode 62 | Border bool 63 | Blink bool 64 | Columns [][11]byte 65 | } 66 | 67 | // ErrBadImageSize if image size is wrong (e.g. not 11 pixels high) 68 | var ErrBadImageSize = errors.New("Bad image size") 69 | 70 | // SetImage add picture data from image 71 | func (m *Message) SetImage(img image.Image) error { 72 | bounds := img.Bounds() 73 | if bounds.Dy() != 11 { 74 | return ErrBadImageSize 75 | } 76 | imgWidth := bounds.Dx() 77 | nrCells := imgWidth / 8 78 | if imgWidth%8 != 0 { 79 | nrCells++ 80 | } 81 | m.Columns = make([][11]byte, nrCells) 82 | for i := 0; i < imgWidth; i += 8 { 83 | for j := 0; j < 11; j++ { 84 | for b := 0; b < 8 && i+b < imgWidth; b++ { 85 | pixelValue := color.GrayModel.Convert(img.At(i+b, j)).(color.Gray).Y 86 | if pixelValue > 0x7f { 87 | m.Columns[i/8][j] |= 1 << uint(7-b) 88 | } 89 | } 90 | } 91 | } 92 | return nil 93 | } 94 | 95 | // Packet to send to device 96 | type Packet struct { 97 | Magic [6]byte 98 | Timestamp time.Time 99 | Messages []Message 100 | } 101 | 102 | type packetHeader struct { 103 | Magic [6]byte 104 | BlinkAttr byte 105 | BorderAttr byte 106 | SpeedAndMode [8]byte 107 | MessageLength [8]uint16 108 | _ [6]byte 109 | Tm struct { 110 | Yr byte 111 | Mo byte 112 | Dy byte 113 | Hr byte 114 | Mi byte 115 | Sc byte 116 | } 117 | _ [20]byte 118 | } 119 | 120 | // UnmarshalBinary parse binary blob 121 | func (p *Packet) UnmarshalBinary(data []byte) error { 122 | buf := bytes.NewBuffer(data) 123 | var ph packetHeader 124 | if err := binary.Read(buf, binary.BigEndian, &ph); err != nil { 125 | return err 126 | } 127 | p.Magic = [6]byte(ph.Magic) 128 | var err error 129 | p.Timestamp, err = time.Parse("06-01-02 15:04:05", fmt.Sprintf("%02d-%02d-%02d %02d:%02d:%02d", ph.Tm.Yr, ph.Tm.Mo, ph.Tm.Dy, ph.Tm.Hr, ph.Tm.Mi, ph.Tm.Sc)) 130 | if err != nil { 131 | return err 132 | } 133 | p.Messages = []Message{} 134 | for idx, msgLength := range ph.MessageLength { 135 | // log.Printf("Message[%d]: %d 8-bit columns", idx, msgLength) 136 | if msgLength == 0 { 137 | continue 138 | } 139 | msg := Message{ 140 | Speed: int(ph.SpeedAndMode[idx]&0xf0) >> 4, 141 | Mode: DisplayMode(ph.SpeedAndMode[idx] & 0x0f), 142 | Blink: ph.BlinkAttr&(1< 8192 { 374 | log.Fatalf("Too long buffer (%d), max is 8192", l) 375 | } 376 | 377 | _, err = devOpen.Write(buf) 378 | if err != nil { 379 | log.Fatalf("Could not write to device %#v: %s", di[0], err) 380 | } 381 | } 382 | --------------------------------------------------------------------------------