You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Ayke van Laethem c23a5b65ef darwin: support -size= flag 2 years ago
.circleci avr: use compiler-rt 3 years ago
.github/workflows avr: use compiler-rt 3 years ago
bin all: add stub pieces for GoLand support 6 years ago
builder darwin: support -size= flag 2 years ago
cgo all: remove support for LLVM 11 and LLVM 12 3 years ago
compileopts all: remove support for LLVM 11 and LLVM 12 3 years ago
compiler compiler: alignof [0]func() = 1 3 years ago
docs docs: change links in README and remove old ReadTheDocs pages to point to TinyGo.org site 6 years ago
goenv all: update version for next development iteration 3 years ago
hooks dockerhub: use post checkout hook for git submodule init 4 years ago
interp interp: fix some buggy localValue handling 2 years ago
lib all: use compiler-rt from LLVM 3 years ago
loader Add a shim for internal/fuzz 3 years ago
src darwin: adjust syscall suffix for arm64 3 years ago
stacksize build: support machine outlining pass in stacksize calculation 3 years ago
targets avr: use compiler-rt 3 years ago
testdata compiler: alignof [0]func() = 1 3 years ago
tests test: Add text/template smoke test 3 years ago
tools Provide Set/Get for each register field described in SVD files 3 years ago
transform all: remove support for LLVM 11 and LLVM 12 3 years ago
.dockerignore docker: apt clean before apt get of llvm to avoid broken packages 3 years ago
.gitignore Revert "all: move stm32 files to separate repository" 3 years ago
.gitmodules all: use compiler-rt from LLVM 3 years ago
BUILDING.md os: Drop support for go 1.15 3 years ago
CHANGELOG.md all: release v0.23.0 3 years ago
CODE-OF-CONDUCT.md docs: add official code of conduct using 'Contributor Covenant' 5 years ago
CONTRIBUTING.md docs: update CONTRIBUTING links to point to web site. Also replace Azure build badge with Windows build on GH Actions. 3 years ago
CONTRIBUTORS update my name in the contributors list 4 years ago
Dockerfile docker: update Dockerfile to use Go 1.18 3 years ago
LICENSE all: update license year to 2022 3 years ago
Makefile darwin: support -size= flag 2 years ago
README.md docs: update list of currently supported boards 3 years ago
colorwriter.go all: implement gdb sub-command for easy debugging 6 years ago
corpus_test.go main (test): integrate test corpus runner 3 years ago
go.mod os: Drop support for go 1.15 3 years ago
go.sum all: update to LLVM 14 3 years ago
main.go esp32: add support for running and debuggin using qemu-esp32 3 years ago
main_test.go avr: enable testdata/map.go 3 years ago
util_unix.go all: update build constraints to Go 1.17 3 years ago
util_windows.go gdb: support daemonization on windows 4 years ago

README.md

TinyGo - Go compiler for small places

Linux macOS Windows Docker 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 85 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 page on our web site 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:

  • 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.

Some code has been copied from the LLVM project and is therefore licensed under a variant of the Apache 2.0 license. This has been clearly indicated in the header of these files.

Some code has been copied and/or ported from Paul Stoffregen's Teensy libraries and is therefore licensed under PJRC's license. This has been clearly indicated in the header of these files.