Skip to content
Go compiler for small places. Microcontrollers, WebAssembly, and command-line tools. Based on LLVM.
Branch: master
Clone or download
Latest commit 5569cd1 Mar 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci test: add WebAssembly tests Mar 4, 2019
bin all: add stub pieces for GoLand support Dec 1, 2018
compiler compiler: inline slice bounds checking Mar 8, 2019
docs docs: change links in README and remove old ReadTheDocs pages to poin… Jan 13, 2019
interp interp: refactor to eliminate lots of code Mar 8, 2019
ir
lib
loader all: add macOS support Feb 19, 2019
src compiler: inline slice bounds checking Mar 8, 2019
targets wasm: ignore arguments and environment variables Mar 7, 2019
testdata
tools generators: correctly handle clustered subtypes used in Atmel SAMD21 … Jan 20, 2019
.gitignore generator: generate device wrappers for Atmel SAM family Jan 13, 2019
.gitmodules
.travis.yml
BUILDING.md
CHANGELOG.md main: version 0.4.1 Mar 15, 2019
CONTRIBUTING.md docs: refactor README content (#171) Feb 8, 2019
Dockerfile
Gopkg.lock all: use internal objcopy implementation Mar 4, 2019
Gopkg.toml
LICENSE
Makefile
README.md
binutils.go compiler: add -size flag to replace size utility Sep 17, 2018
buildcache.go
builtins.go main: include prebuilt compiler-rt libraries in release tarball Feb 1, 2019
colorwriter.go all: implement gdb sub-command for easy debugging Oct 3, 2018
commands.go main: use OS specific name for llvm-ar-7 tool to ensure that llvm7 to… Mar 15, 2019
commands_macos.go main: use OS specific name for llvm-ar-7 tool to ensure that llvm7 to… Mar 15, 2019
linker-builtin.go
linker-external.go main: optionally build with LLD Feb 1, 2019
lld.cpp
main.go main: use OS specific name for llvm-ar-7 tool to ensure that llvm7 to… Mar 15, 2019
main_test.go main: only run WebAssembly tests on Linux Mar 6, 2019
objcopy.go main: include .data section in .hex file Mar 11, 2019
target.go
uf2.go main: include .data section in .hex file Mar 11, 2019
version.go main: version 0.4.1 Mar 15, 2019

README.md

TinyGo - Go compiler for small places

Travis CI CircleCI

TinyGo is a Go compiler intended for use in small places such as microcontrollers, WebAssembly (WASM), and command-line tools.

It reuses libraries used by the Go language tools alongside LLVM to provide an alternative way to compile programs written in the Go programming language.

Here is an example program that blinks the built-in LED when run directly on any supported board with onboard LED:

package main

import (
    "machine"
    "time"
)

func main() {
    led := machine.GPIO{machine.LED}
    led.Configure(machine.GPIOConfig{Mode: machine.GPIO_OUTPUT})
    for {
        led.Low()
        time.Sleep(time.Millisecond * 1000)

        led.High()
        time.Sleep(time.Millisecond * 1000)
    }
}

The above program can be compiled and run without modification on an Arduino Uno, an Adafruit ItsyBitsy M0, or any of the supported boards that have a built-in LED, just by setting the correct TinyGo compiler target. For example, this compiles and flashes an Arduino Uno:

tinygo flash -target arduino examples/blinky1

Installation

See the getting started instructions for information on how to install TinyGo, as well as how to run the TinyGo compiler using our Docker container.

Supported boards/targets

You can compile TinyGo programs for microcontrollers, WebAssembly and Linux.

The following microcontroller boards are currently supported:

For more information, see this list of boards. Pull requests for additional support are welcome!

Currently supported features:

For a description of currently supported Go language features, please see https://tinygo.org/lang-support/.

Documentation

Documentation is located on our web site at https://tinygo.org/.

You can find the web site code at https://github.com/tinygo-org/tinygo-site.

Getting help

If you're looking for a more interactive way to discuss TinyGo usage or development, we have a #TinyGo channel on the Gophers Slack.

If you need an invitation for the Gophers Slack, you can generate one here which should arrive fairly quickly (under 1 min): https://invite.slack.golangbridge.org

Contributing

Your contributions are welcome!

Please take a look at our CONTRIBUTING.md document for details.

Project Scope

Goals:

  • Have very small binary sizes. Don't pay for what you don't use.
  • Support for most common microcontroller boards.
  • Be usable on the web using WebAssembly.
  • Good CGo support, with no more overhead than a regular function call.
  • Support most standard library packages and compile most Go code without modification.

Non-goals:

  • Using more than one core.
  • Be efficient while using zillions of goroutines. However, good goroutine support is certainly a goal.
  • Be as fast as gc. However, LLVM will probably be better at optimizing certain things so TinyGo might actually turn out to be faster for number crunching.
  • Be able to compile every Go program out there.

Why this project exists

We never expected Go to be an embedded language and so its got serious problems...

-- Rob Pike, GopherCon 2014 Opening Keynote

TinyGo is a project to bring Go to microcontrollers and small systems with a single processor core. It is similar to emgo but a major difference is that we want to keep the Go memory model (which implies garbage collection of some sort). Another difference is that TinyGo uses LLVM internally instead of emitting C, which hopefully leads to smaller and more efficient code and certainly leads to more flexibility.

The original reasoning was: if Python can run on microcontrollers, then certainly Go should be able to run on even lower level micros.

License

This project is licensed under the BSD 3-clause license, just like the Go project itself.

You can’t perform that action at this time.