├── LICENSE ├── README.md └── repo.go /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright 2014 Google Inc. 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Go + hardware 2 | 3 | This repo is a directory of tools, packages and tutorials to let 4 | you introduce Go in your hardware projects. 5 | 6 | ## Why Go? 7 | 8 | * Go can target platforms and architectures that are primarily in the scope of non-real time embedded operating systems. 9 | - ARMv5, ARMv6, ARMv7 and ARMv8 support for Linux 10 | - ARMv7, ARMv8, x86 support for Android 11 | - Experimental OpenWRT 12 | 13 | * Out-of-the-box cross compilation story. 14 | - E.g. Run `GOOS=linux GOARCH=arm go build` to build a binary for ARM/linux boards from a Mac or Windows machine. No other configuration is required. 15 | 16 | * Built-in concurrency primitives in Go is making it easier to write concurrent programs. 17 | - Strong advantage in implementing hardware controllers. 18 | - Strong advantage in implementing networking devices. 19 | 20 | * Go is garbage collected language but the garbage collector footprint has been improved significantly since Go 1.4. The pause times are being targetted to be 10ms or less even with large heaps and is not a significant disadvantage on non-real time operating systems -- the preemptive nature of the OS scheduler is more of a major problem than pause times. 21 | 22 | * Go's network stack is high quality and maintained well. Networking is a core component in IoT. 23 | 24 | * Go provides out-of-the-box HTTP, HTTPS and HTTP/2 client/server implementations. 25 | - Standard library might be missing higher level implementations for P2P protocols, but the community works to fill that gap. 26 | - Community is also investing time to implement newer IoT-targeting networking protocols such as COAP. 27 | 28 | * Writing C bindings in Go is very trivial with cgo unlike other high level programming languages like Python and Java. It is so much easier to depend on an existing C/C++ library from the Go context. 29 | - E.g. [portmidi](https://github.com/rakyll/portmidi/blob/master/portmidi.go) bindings. See the source code to see how you can mix and match Go and C code in the same Go file. 30 | 31 | * C-like syntax enables the existing IoT/embedded programmers (mostly fluent in C) to read and write Go without much knowledge of the language. 32 | 33 | * Go programs compile to static binaries and doesn’t require a runtime on the host (e.g. a VM). Deployment is copy/pasting a binary. 34 | 35 | * Go had strong community figures who worked on the hardware aspects from the early days. 36 | - Gobot made its debut at the first GopherCon. 37 | - There are numerous libraries and frameworks around hardware and robotics already contributed by the community. A list can be found at go-hardware. 38 | 39 | * Go is efficient, fast and has low memory footprint. 40 | 41 | * Code reuse between server and client (connected device or mobile). 42 | - E.g. gRPC Go is working out of the box on servers, Android, iOS and embedded Linux. 43 | 44 | 45 | ## Tutorials 46 | 47 | * (Go 1.5 and above) [Cross compilation guide](https://medium.com/@rakyll/go-1-5-cross-compilation-488092ba44ec) 48 | * (Go 1.4 and below) [Cross compilation guide](http://dave.cheney.net/2013/07/09/an-introduction-to-cross-compilation-with-go-1-1) 49 | * [Go on ARM tips, known issues and success stories](https://github.com/golang/go/wiki/GoArm) 50 | 51 | ## Packages 52 | 53 | ### Controllers 54 | * [devices](https://github.com/goiot/devices) - A repository of high-level device/sensor packages for Go. 55 | * [gobot](http://gobot.io/) - High level Go package with a variety of platform APIs to talk to popular drivers such as GPIO on Arduino and Raspberry Pi, Leap Motion or Pebble. 56 | * [go-gpio](https://github.com/stianeikeland/go-rpio) - GPIO for Go, doesn't require cgo. 57 | * [embd](http://embd.io/) - Embedded programming framework for Go. 58 | * [fadecandy](https://github.com/scanlime/fadecandy) - Dithering OPC-based LED controller 59 | * [godrone](http://godoc.org/github.com/felixge/godrone/) - High level Parrot AR Drone 2.0 framework written in Go. 60 | * [launchpad](https://github.com/rakyll/launchpad) - High level controller library for Novation Launchpad. 61 | * [littlebits](https://github.com/rakyll/littlebits) - littleBits controller for Go. It requires [USB I/O](http://littlebits.cc/bits/usb-io) module. 62 | * [piCamera](https://github.com/technomancers/piCamera) - Capture the stream of Images for a Raspberry Pi Camera in GoLang 63 | * [hwio](https://github.com/mrmorphic/hwio) - Hardware library for ARM boards such as Raspberry Pi and BeagleBone, loosely based on Arduino. 64 | * [go-lepton](https://github.com/maruel/go-lepton) - Streams images taken on a FLIR Lepton connected to a Raspberry Pi SPI port to over via WebSockets via embedded HTTP server. 65 | * [go-embedded](https://github.com/SpaceLeap/go-embedded) - Embedded Linux support for I2C, SPI, PWM, GPIO, ADC 66 | * [go-beaglebone](https://github.com/SpaceLeap/go-beaglebone) - Go package for the BeagleBone open source hardware 67 | * [go-mavlink](https://github.com/SpaceLeap/go-mavlink) - MAVLink protocol implementation for Go (MAVLink is used to control drones) 68 | * [joystick](https://github.com/SimulatedSimian/joystick) - a polled API to read the state of an attached joystick. 69 | * [emgo](https://github.com/ziutek/emgo) - Go-like language for programming embedded systems (e.g. STM32 MCU). 70 | * [go-rpi-rgb-led-matrix](https://github.com/mcuadros/go-rpi-rgb-led-matrix) - Controlling up to three chains of 32x32 or 16x32 RGB LED displays using Raspberry Pi GPIO 71 | * [go-rpi-ws281x](https://github.com/mcuadros/go-rpi-ws281x) - Go bindings for Raspberry Pi PWM library for WS281X LEDs Edit 72 | * [ghw](https://github.com/jaypipes/ghw) - Golang hardware discovery/inspection library 73 | * [sysinfo](https://github.com/zcalusic/sysinfo) - A pure Go library providing Linux OS / kernel / hardware system information. 74 | 75 | 76 | ### Signal processing, computer vision, graphics, media 77 | * [go-gl](https://github.com/go-gl) - OpenGL bindings for Go. 78 | * [go-opc](https://github.com/kellydunn/go-opc) - Open Pixel Control bindings for Go. 79 | * [go-opencv](https://github.com/lazywei/go-opencv) - OpenCV bindings for Go. 80 | * [go-sox](https://github.com/krig/go-sox) - SoX bindings for Go. 81 | * [portaudio](https://code.google.com/p/portaudio-go/) - PortAudio bindings for Go. 82 | * [portmidi](https://github.com/rakyll/portmidi) - PortMidi bindings for Go. 83 | * [go-osc](https://github.com/hypebeast/go-osc) - Open Sound Control (OSC) bindings for Go. 84 | * [openvg](https://github.com/ajstarks/openvg) - 2D Graphics library wrapping the OpenVG API 85 | * [lirc](https://github.com/chbmuc/lirc) - Go Client for Linux Infra-red Remote Control. Allows sending and receiving IR commands. 86 | * [gocv](https://gocv.io) - OpenCV 3+ bindings for Go. Also supports OpenVINO. 87 | 88 | ### Networking, peripheral communications 89 | * [mdns](https://github.com/hashicorp/mdns) - mDNS server and client implementation in Go. Multicast DNS can be used to discover services and message on the local network without the use of an authoritative DNS server. 90 | * [gatt](https://github.com/paypal/gatt) - Provides a Bluetooth Low Energy GATT implementation. 91 | * [go.hid](https://github.com/GeertJohan/go.hid) - Provides communication with USB Human Interface Devices. 92 | * [goble](https://github.com/MarinX/goble) - Bluetooth Low Energy (HM10) module for Go 93 | * [serial](https://github.com/tarm/serial) - Serial Port Communication Package for Go 94 | * [firmata](https://github.com/kraman/go-firmata) - Firmata client for Go 95 | * [periph](https://periph.io/) - Peripherals I/O in Go 96 | * [go-ckb](https://gitlab.com/dnaf/go-ckb) - Corsair ckb-daemon communication in Go 97 | * [ble](https://github.com/go-ble/ble) - Bluetooth Low Energy communication wrapper for Linux/macOS. 98 | 99 | ### Mobile (Go 1.5 or above) 100 | * [Native applications (Android and iOS)](https://github.com/golang/go/wiki/Mobile#native-applications) 101 | * [SDK applications](https://github.com/golang/go/wiki/Mobile#sdk-applications-and-generating-bindings) 102 | 103 | Contributions are welcome, please fork and open a PR if you see 104 | a missing package, tutorial, etc. 105 | -------------------------------------------------------------------------------- /repo.go: -------------------------------------------------------------------------------- 1 | package repo 2 | --------------------------------------------------------------------------------