TinyGo

https://tinygo.org/docs
Admin
TinyGo is a Go compiler that brings Go to microcontrollers, embedded systems, and WebAssembly,...
Tokens:300,952
Snippets:3,584
Trust Score:9.7
Update:2 months ago
Show doc for...
Tokens:
Raw
### Install BOSSA on Linux

Source: https://tinygo.org/docs/reference/microcontrollers/boards/arduino-nano33

Build and install the BOSSA utility from source on Linux systems.

```bash
sudo apt install libreadline-dev libwxgtk3.0-gtk3-dev
git clone https://github.com/shumatech/BOSSA.git
cd BOSSA
make
sudo cp bin/bossac /usr/local/bin
```

--------------------------------

### Install adafruit-nrfutil

Source: https://tinygo.org/docs/reference/microcontrollers/boards/feather-nrf52840-sense

Install the utility required for updating the board's bootloader.

```bash
pip3 install --user adafruit-nrfutil
```

--------------------------------

### Blink an LED using GPIO

Source: https://tinygo.org/docs/concepts/peripherals/gpio

A complete example demonstrating how to configure a pin as an output and toggle it in a loop.

```go
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)
    }
}
```

--------------------------------

### Verify BOSSA Installation

Source: https://tinygo.org/docs/reference/microcontrollers/boards/arduino-nano33

Run the help command to confirm that BOSSA is correctly installed and accessible in the system path.

```bash
bossac --help
```

--------------------------------

### Full I2C MPU6050 Interaction Example

Source: https://tinygo.org/docs/concepts/peripherals/i2c

Complete implementation for configuring I2C and reading from an MPU6050 sensor.

```go
package main

import "machine"

func main() {
    i2c := machine.I2C0
    err := i2c.Configure(machine.I2CConfig{
        SCL: machine.P0_30,
        SDA: machine.P0_31,
    })
    if err != nil {
        println("could not configure I2C:", err)
        return
    }
    
    w := []byte{0x75}
    r := make([]byte, 1)
    err = i2c.Tx(0x68, w, r)
    if err != nil {
        println("could not interact with I2C device:", err)
        return
    }
    println("WHO_AM_I:", r[0]) // prints "WHO_AM_I: 104"
}
```

--------------------------------

### Build TinyGo

Source: https://tinygo.org/docs/guides/build/bring-your-own-llvm

Compiles and installs TinyGo from the cloned repository.

```bash
go install
```

--------------------------------

### View bootloader information

Source: https://tinygo.org/docs/reference/microcontrollers/boards/feather-nrf52840-sense

Example content found in the INFO_UF2.TXT file when the board is in bootloader mode.

```text
UF2 Bootloader 0.4.1 lib/nrfx (v2.0.0) lib/tinyusb (0.6.0-272-g4e6aa0d8) lib/uf2 (remotes/origin/configupdate-9-gadbb8c7)
Model: Adafruit CLUE nRF52840
Board-ID: nRF52840-CLUE-revA
SoftDevice: S140 version 6.1.1
Date: Jan 19 2021
```

--------------------------------

### Install TinyGo binary to system path

Source: https://tinygo.org/docs/guides/build/manual-llvm

Move the built binary to the system bin directory for global access.

```bash
mv ./build/tinygo /usr/bin/
```

--------------------------------

### Install LLVM toolchain on Debian or Ubuntu

Source: https://tinygo.org/docs/guides/build/bring-your-own-llvm

Adds the GPG key and installs the required LLVM packages via apt.

```bash
wget -O - https://apt.llvm.org/llvm-snapshot.gpg.key | sudo apt-key add -
sudo apt-get update
sudo apt-get install clang-18 llvm-18-dev lld-18 libclang-18-dev
```

--------------------------------

### Install LLVM on Fedora

Source: https://tinygo.org/docs/guides/build/bring-your-own-llvm

Installs LLVM development and LLD libraries using dnf.

```bash
sudo dnf install llvm-devel lld-libs lld
```

--------------------------------

### Install and run pyserial miniterm

Source: https://tinygo.org/docs/tutorials/serialmonitor

Install the pyserial library and launch the miniterm tool to monitor a serial port.

```bash
$ python3 -m pip install --user pyserial
$ python3 -m serial.tools.miniterm /dev/ttyUSB0 115200
```

--------------------------------

### Full size output format

Source: https://tinygo.org/docs/reference/usage/misc-options

Example output when using the -size=full flag, showing per-package space usage.

```text
code  rodata    data     bss |   flash     ram | package
876        0       4       0 |     880       4 | (bootstrap)
38         0       0       0 |      38       0 | device/arm
0          0       0      66 |       0      66 | machine
2994     440     124       0 |    3558     124 | main
948      127       4       1 |    1079       5 | runtime
4856     567     132      67 |    5555     199 | (sum)
5780       -     144    2132 |    5924    2276 | (all)
```

--------------------------------

### Manage Watchdog Lifecycle

Source: https://tinygo.org/docs/reference/machine

Methods to start the watchdog and signal system health.

```go
func (wd *Watchdog) Start() error
```

```go
func (wd *Watchdog) Update()
```

--------------------------------

### Verify TinyGo installation

Source: https://tinygo.org/docs/guides/build/manual-llvm

Check the version of the newly built TinyGo binary.

```bash
$ ./build/tinygo version
tinygo version 0.41.1-dev-d4189fec linux/amd64 (using go version go1.26.2 and LLVM version 20.1.1)
```

--------------------------------

### Install TinyGo drivers via GOPATH

Source: https://tinygo.org/docs/guides/ide-integration

Use this command to download hardware drivers when not utilizing Go modules.

```bash
go get -d tinygo.org/x/drivers
```

--------------------------------

### Get start of flash data

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-zero

Returns the start address of the writable flash area, aligned to a page boundary.

```go
func FlashDataStart() uintptr
```

--------------------------------

### AVRDude missing error

Source: https://tinygo.org/docs/reference/microcontrollers/boards/arduino-uno

Example of the error message displayed when the avrdude utility is not installed on the system.

```text
/bin/sh: 1: avrdude: not found
```

--------------------------------

### Initialize Go module

Source: https://tinygo.org/docs/tutorials/blinky

Create a new Go module for the project using the command line.

```bash
go mod init blinky
```

--------------------------------

### Initialize Serial

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-nano

Initializes the serial interface.

```go
func InitSerial()
```

--------------------------------

### Identify Missing LLVM Headers

Source: https://tinygo.org/docs/guides/build/bring-your-own-llvm

Example of a fatal build error indicating that LLVM development headers are not installed or configured correctly.

```text
# tinygo.org/x/go-llvm
../../../go/pkg/mod/tinygo.org/x/go-llvm@v0.0.0-20221028183034-8341240c0b32/analysis.go:16:10: fatal error: 'llvm-c/Analysis.h' file not found
#include "llvm-c/Analysis.h" // If you are getting an error here you need to build or install LLVM, see https://tinygo.org/docs/guides/build/
         ^~~~~~~~~~~~~~~~~~~
1 error generated.
```

--------------------------------

### Flash a program to the QT Py RP2040

Source: https://tinygo.org/docs/reference/microcontrollers/boards/qtpy-rp2040

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=qtpy-rp2040 [PATH TO YOUR PROGRAM]
```

--------------------------------

### Flash a program to the Trinkey QT2040

Source: https://tinygo.org/docs/reference/microcontrollers/boards/trinkey-qt2040

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=trinkey-qt2040 [PATH TO YOUR PROGRAM]
```

--------------------------------

### Install build dependencies on MacOS

Source: https://tinygo.org/docs/guides/build/manual-llvm

Use Homebrew to install cmake and ninja on MacOS.

```bash
brew install cmake ninja
```

--------------------------------

### Declare the main package

Source: https://tinygo.org/docs/tutorials/blinky

Every Go program must start with a package declaration. The main package is the entry point for the application.

```go
package main
```

--------------------------------

### Install BOSSA on macOS

Source: https://tinygo.org/docs/reference/microcontrollers/boards/arduino-nano33

Use Homebrew to install the BOSSA command line interface on macOS.

```bash
brew install bossa
```

--------------------------------

### Initialize Go Module

Source: https://tinygo.org/docs/tutorials/pwm

Initialize a new Go module for the PWM project.

```bash
go mod init pwm-blinky
```

--------------------------------

### Install Upstream OpenOCD Dependencies on MacOS

Source: https://tinygo.org/docs/guides/debugging

Install debugging tools and toolchains using Homebrew.

```bash
brew install open-ocd
brew tap ARMmbed/homebrew-formulae
brew install arm-none-eabi-gcc
brew install automake
```

--------------------------------

### Install dfu-util on macOS

Source: https://tinygo.org/docs/reference/microcontrollers/boards/feather-stm32f405

Command to install the dfu-util tool using the Homebrew package manager.

```bash
brew install dfu-util
```

--------------------------------

### Initialize DAC peripheral

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-zero

Global DAC instance.

```go
var (
	DAC0 = DAC{}
)
```

--------------------------------

### Initialization and Utility Functions

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-nano33

Functions for initializing hardware peripherals and managing buffers.

```go
func InitADC()
```

```go
func InitSerial()
```

```go
func NewRingBuffer() *RingBuffer
```

--------------------------------

### Install cross-compiler on Debian

Source: https://tinygo.org/docs/guides/linux

Install the necessary GCC cross-compiler toolchain for ARM on Debian-based systems.

```bash
sudo apt-get install gcc-arm-linux-gnueabihf
```

--------------------------------

### Install picocom on Linux and MacOS

Source: https://tinygo.org/docs/tutorials/serialmonitor

Commands to install the picocom terminal emulator using package managers.

```bash
$ sudo apt install picocom
```

```bash
$ brew install picocom
```

--------------------------------

### Flash a program to the Sparkfun Thing Plus RP2040

Source: https://tinygo.org/docs/reference/microcontrollers/boards/thingplus-rp2040

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=thingplus-rp2040 [PATH TO YOUR PROGRAM]
```

--------------------------------

### Install Upstream OpenOCD Dependencies on Fedora

Source: https://tinygo.org/docs/guides/debugging

Install debugging tools using the dnf package manager.

```bash
dnf install gdb openocd
```

--------------------------------

### Hardware Initialization Functions

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-mega1280

Functions for retrieving CPU frequency and initializing peripherals.

```go
func CPUFrequency() uint32
```

```go
func InitADC()
```

```go
func InitSerial()
```

```go
func NewRingBuffer() *RingBuffer
```

--------------------------------

### Configure SPI interface

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-nano

Sets up the SPI interface using the provided configuration.

```go
func (s *SPI) Configure(config SPIConfig) error
```

--------------------------------

### Install Binaryen on MacOS

Source: https://tinygo.org/docs/guides/build/additional-requirements

Installs the Binaryen tool using Homebrew, as the make target is disabled on MacOS.

```bash
brew install binaryen
```

--------------------------------

### Flash a program to the Pico W

Source: https://tinygo.org/docs/reference/microcontrollers/featured/pico-w

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=pico-w [PATH TO YOUR PROGRAM]
```

--------------------------------

### Install Upstream OpenOCD Dependencies on Debian/Ubuntu

Source: https://tinygo.org/docs/guides/debugging

Install common debugging tools via the apt package manager.

```bash
sudo apt-get install gdb-multiarch openocd
```

--------------------------------

### Flash a program to the Nano RP2040

Source: https://tinygo.org/docs/reference/microcontrollers/boards/nano-rp2040

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=nano-rp2040 [PATH TO YOUR PROGRAM]
```

--------------------------------

### Configure PWM Peripheral

Source: https://tinygo.org/docs/reference/microcontrollers/machine/digispark

Initializes the PWM peripheral with the provided configuration.

```go
func (pwm PWM) Configure(config PWMConfig) error
```

--------------------------------

### Install dfu-util on Linux

Source: https://tinygo.org/docs/reference/microcontrollers/boards/feather-stm32f405

Commands to update package lists and install the dfu-util tool on Debian-based Linux distributions.

```bash
sudo apt update 
sudo apt install dfu-util
```

--------------------------------

### Install LLVM on MacOS

Source: https://tinygo.org/docs/guides/build/bring-your-own-llvm

Installs LLVM and LLD using Homebrew. Apple's default Clang/LLVM is not supported.

```bash
brew install llvm lld
```

--------------------------------

### Flash a program to the Pico 2 W

Source: https://tinygo.org/docs/reference/microcontrollers/boards/pico2-w

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=pico2-w [PATH TO YOUR PROGRAM]
```

--------------------------------

### Flash TinyGo program to Badger2040-W

Source: https://tinygo.org/docs/reference/microcontrollers/boards/badger2040-w

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=badger2040-w [PATH TO YOUR PROGRAM]
```

--------------------------------

### Install build dependencies on Windows

Source: https://tinygo.org/docs/guides/build/manual-llvm

Use Chocolatey to install necessary build tools on Windows with administrative privileges.

```bash
choco install --confirm git golang mingw make cmake ninja python
```

--------------------------------

### Install build dependencies on Linux Fedora

Source: https://tinygo.org/docs/guides/build/manual-llvm

Use dnf to install development tools and build utilities on Fedora.

```bash
sudo dnf groupinstall "Development Tools"
sudo dnf install cmake ninja-build
```

--------------------------------

### Flash a program to the Badger2040

Source: https://tinygo.org/docs/reference/microcontrollers/boards/badger2040

Use the TinyGo CLI to compile and flash a program to the board. Ensure the target is set to badger2040.

```bash
tinygo flash -target=badger2040 [PATH TO YOUR PROGRAM]
```

--------------------------------

### Flash a program to the XIAO RP2040

Source: https://tinygo.org/docs/reference/microcontrollers/boards/xiao-rp2040

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=xiao-rp2040 [PATH TO YOUR PROGRAM]
```

--------------------------------

### Install build dependencies on Linux Debian and Ubuntu

Source: https://tinygo.org/docs/guides/build/manual-llvm

Use apt-get to install essential build tools on Debian-based systems.

```bash
sudo apt-get install build-essential git cmake ninja-build
```

--------------------------------

### Install Raspberry Pi Debug Probe Dependencies on MacOS

Source: https://tinygo.org/docs/guides/debugging

Install build dependencies required for compiling the Raspberry Pi OpenOCD fork.

```bash
brew tap ARMmbed/homebrew-formulae
brew install libtool automake libusb aclocal texinfo pkg-config capstone gdb arm-none-eabi-gcc
```

--------------------------------

### Install Raspberry Pi Debug Probe Dependencies on Fedora

Source: https://tinygo.org/docs/guides/debugging

Install build dependencies required for compiling the Raspberry Pi OpenOCD fork.

```bash
sudo dnf install libtool arm-none-eabi-gcc-cs libusb1-devel gdb
```

--------------------------------

### Configure I2C interface

Source: https://tinygo.org/docs/reference/microcontrollers/machine/itsybitsy-m0

Initializes the I2C interface.

```go

func (i2c *I2C) Configure(config I2CConfig) error

```

--------------------------------

### Flash a program to the Challenger RP2040

Source: https://tinygo.org/docs/reference/microcontrollers/boards/challenger-rp2040

Use this command to compile and flash a TinyGo program to the board via the CLI.

```bash
tinygo flash -target=challenger-rp2040 [PATH TO YOUR PROGRAM]
```

--------------------------------

### Install Raspberry Pi Debug Probe Dependencies on Debian/Ubuntu

Source: https://tinygo.org/docs/guides/debugging

Install build dependencies required for compiling the Raspberry Pi OpenOCD fork.

```bash
sudo apt-get install gdb-multiarch libtool pkg-config libusb-1.0-0-dev make
```

--------------------------------

### Hardware Initialization Functions

Source: https://tinygo.org/docs/reference/microcontrollers/machine/digispark

Functions for retrieving CPU frequency, initializing ADC/Serial, and creating buffers.

```go
func CPUFrequency() uint32

func InitADC()

func InitSerial()

func NewRingBuffer() *RingBuffer
```

--------------------------------

### Watchdog.Start

Source: https://tinygo.org/docs/reference/machine

Starts the watchdog timer.

```APIDOC
## func (wd *Watchdog) Start() error

### Description
Starts the watchdog. After calling this method, Update must be called periodically to prevent a system reset.
```

--------------------------------

### Configure

Source: https://tinygo.org/docs/reference/microcontrollers/machine/badger2040

Initializes the I2C peripheral and configures the specified pins.

```APIDOC
### func (*I2C) Configure(config I2CConfig) error

Initializes the I2C peripheral and configures the pins passed in the config object.
```

--------------------------------

### Initialize PWM Peripheral

Source: https://tinygo.org/docs/tutorials/pwm

References a specific PWM peripheral for hardware control.

```go
pwm := machine.PWM4
```

--------------------------------

### FlashDataStart

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-nano33

Returns the start address of the writable flash area.

```APIDOC
## func FlashDataStart() uintptr

### Description
Return the start of the writable flash area, aligned on a page boundary. This is usually just after the program and static data.
```

--------------------------------

### Listen

Source: https://tinygo.org/docs/reference/microcontrollers/machine/badger2040

Starts listening for I2C requests sent to the specified address.

```APIDOC
### func (*I2C) Listen(addr uint16) error

Starts listening for I2C requests sent to the specified address.
```

--------------------------------

### func (Pin) Get

Source: https://tinygo.org/docs/reference/microcontrollers/machine/nrf52840-mdk

Returns the current logical state of the pin.

```APIDOC
## func (Pin) Get() bool

### Description
Get returns the current value of a GPIO pin when the pin is configured as an input or as an output.

### Returns
- **bool** - True if high, false if low.
```

--------------------------------

### SPI.Configure

Source: https://tinygo.org/docs/reference/microcontrollers/machine/waveshare-rp2040-zero

Initializes the SPI interface.

```APIDOC
## func (*SPI) Configure(config SPIConfig) error

### Description
Configure is intended to setup/initialize the SPI interface. Default baudrate of 4MHz is used if Frequency == 0. Default word length (data bits) is 8.
```

--------------------------------

### func (*ADC) Get

Source: https://tinygo.org/docs/reference/microcontrollers/machine/nrf52840-mdk-usb-dongle

Returns the current value of an ADC pin.

```APIDOC
## func (*ADC) Get() uint16

### Description
Get returns the current value of an ADC pin in the range 0..0xffff.

### Returns
- **uint16** - ADC reading
```

--------------------------------

### Initialize I2S peripheral

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-zero

Global I2S instance for the SAMD21.

```go
var I2S0 = I2S{Bus: sam.I2S}
```

--------------------------------

### Get PWM Period

Source: https://tinygo.org/docs/reference/microcontrollers/machine/digispark

Returns the active PWM period in nanoseconds.

```go
func (pwm PWM) Period() uint64
```

--------------------------------

### Get RNG

Source: https://tinygo.org/docs/reference/microcontrollers/machine/clue

Returns 32 bits of non-deterministic random data.

```go
func GetRNG() (ret uint32, err error)
```

--------------------------------

### Flash a program to the nice!nano

Source: https://tinygo.org/docs/reference/microcontrollers/boards/nicenano

Use the TinyGo CLI to flash a program to the board. This command is used for both initial flashing and troubleshooting.

```bash
tinygo flash -target=nicenano [PATH TO YOUR PROGRAM]
```

--------------------------------

### Flash a program to the Waveshare RP2040-Zero

Source: https://tinygo.org/docs/reference/microcontrollers/boards/waveshare-rp2040-zero

Use this command to compile and flash a TinyGo program to the board. Ensure the target is set correctly to the waveshare-rp2040-zero.

```bash
tinygo flash -target=waveshare-rp2040-zero [PATH TO YOUR PROGRAM]
```

--------------------------------

### Identify Target Status

Source: https://tinygo.org/docs/tutorials/gdb

Output indicating the target is paused at the start of the program.

```text
target halted due to debug-request, current mode: Thread 
```

--------------------------------

### I2C.Configure

Source: https://tinygo.org/docs/reference/microcontrollers/machine/bluepill

Sets up the STM32 I2C interface.

```APIDOC
## func (*I2C) Configure(config I2CConfig) error

### Description
Configure is intended to setup the STM32 I2C interface.
```

--------------------------------

### Flash a program to the Pico 2

Source: https://tinygo.org/docs/reference/microcontrollers/boards/pico2

Use the TinyGo CLI to compile and flash a program to the board.

```bash
tinygo flash -target=pico2 [PATH TO YOUR PROGRAM]
```

--------------------------------

### func (*I2C) Listen

Source: https://tinygo.org/docs/reference/microcontrollers/machine/itsybitsy-nrf52840

Starts listening for I2C requests as a target device.

```APIDOC
## func (*I2C) Listen(addr uint8) error

### Description
Listen starts listening for I2C requests sent to the specified address.

### Parameters
- **addr** (uint8) - Required - The I2C address to listen to.

### Returns
- **error** - Returns an error if the operation fails.
```

--------------------------------

### Flash a program to the Qt Py

Source: https://tinygo.org/docs/reference/microcontrollers/boards/qtpy

Use this command to compile and flash a TinyGo program to the connected Qt Py board.

```bash
tinygo flash -target=qtpy [PATH TO YOUR PROGRAM]
```

--------------------------------

### Get FPIOA Function

Source: https://tinygo.org/docs/reference/microcontrollers/machine/maixbit

Retrieves the current FPIOA function assigned to the pin.

```go
func (p Pin) FPIOAFunction() FPIOAFunction
```

--------------------------------

### Implement PDM methods

Source: https://tinygo.org/docs/reference/microcontrollers/machine/clue

Methods for configuring and reading from a PDM device.

```go
func (pdm *PDM) Configure(config PDMConfig) error

func (pdm *PDM) Read(buf []int16) (uint32, error)
```

--------------------------------

### Get byte from RingBuffer

Source: https://tinygo.org/docs/reference/microcontrollers/machine/arduino-nano

Retrieves a byte from the buffer, returning false if empty.

```go
func (rb *RingBuffer) Get() (byte, bool)
```
Tokens:
Raw