Skip to content
Go compiler for small places. Microcontrollers, WebAssembly, and command-line tools. Based on LLVM.
Go Python JavaScript Makefile Assembly HTML Other
Branch: master
Clone or download
Latest commit cc31379 Sep 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci ci: add caching to macOS build Sep 18, 2019
bin all: add stub pieces for GoLand support Dec 1, 2018
cgo cgo: add support for anonymous structs Jun 3, 2019
compiler fix bugs found by LLVM assertions Sep 16, 2019
docs docs: change links in README and remove old ReadTheDocs pages to poin… Jan 13, 2019
interp compiler: rename getZeroValue to llvm.ConstNull Sep 15, 2019
ir WASM: Support for setting an imported function's module name (#455) Sep 12, 2019
lib all: add HiFive1 rev B board with RISC-V architecture Jul 7, 2019
loader Add test command to tinygo (#243) Jun 18, 2019
src runtime/samd51: set minimum sleep to 260us due to minimum delay in re… Sep 18, 2019
targets machine/stm32f103xx/nucleo-f103rb: add support for NUCLEO-F103RB STM3… Sep 17, 2019
testdata reflect: implement t.Comparable() Aug 20, 2019
tests/tinygotest Add common test logging methods such as Errorf/Fatalf/Printf Aug 13, 2019
tools tools/generator: correctly handle padding when it is 3 bytes long Sep 12, 2019
transform all: move OptimizeMaps to transforms and add tests Sep 15, 2019
.gitignore all: add HiFive1 rev B board with RISC-V architecture Jul 7, 2019
.gitmodules all: add HiFive1 rev B board with RISC-V architecture Jul 7, 2019
BUILDING.md all: replace dep with Go modules Sep 15, 2019
CHANGELOG.md main: version 0.8.0 Sep 18, 2019
CONTRIBUTING.md docs: add note to current/future contributors to please start by open… Jun 6, 2019
CONTRIBUTORS CONTRIBUTORS: add name Aug 10, 2019
Dockerfile all: replace dep with Go modules Sep 15, 2019
LICENSE compiler: implement complex division May 11, 2019
Makefile machine/stm32f103xx/nucleo-f103rb: add support for NUCLEO-F103RB STM3… Sep 17, 2019
README.md docs: update README with current list of supported boards Sep 18, 2019
binutils.go compiler: add -size flag to replace size utility Sep 17, 2018
buildcache.go main: use os.UserCacheDir to get a cache directory Apr 30, 2019
builtins.go main: add fallback mechanism for LLVM commands May 5, 2019
colorwriter.go all: implement gdb sub-command for easy debugging Oct 3, 2018
commands.go main: return an error when running a command failed Jun 5, 2019
go.mod all: refactor heap-to-stack transform into the transform package Sep 15, 2019
go.sum all: refactor heap-to-stack transform into the transform package Sep 15, 2019
linker-builtin.go main: set the current working directory when calling an external linker Jul 7, 2019
linker-external.go main: set the current working directory when calling an external linker Jul 7, 2019
lld.cpp main: optionally build with LLD Feb 1, 2019
main.go fix bugs found by LLVM assertions Sep 16, 2019
main_test.go fix bugs found by LLVM assertions Sep 16, 2019
objcopy.go main: include .data section in .hex file Mar 11, 2019
target.go compiler: ensure that any passed in target, if it does not point to a… Sep 18, 2019
target_test.go compiler: ensure that any passed in target, if it does not point to a… Sep 18, 2019
uf2.go uf2: extract target address from ELF to accomodate the differences wi… Sep 12, 2019
version.go main: version 0.8.0 Sep 18, 2019

README.md

TinyGo - Go compiler for small places

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.LED
    led.Configure(machine.PinConfig{Mode: machine.PinOutput})
    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 18 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.