drivers

README

TinyGo Drivers

This package provides a collection of hardware drivers for devices such as sensors and displays that can be used together with TinyGo.

Installing

go get tinygo.org/x/drivers

How to use

Here is an example in TinyGo that uses the BMP180 digital barometer:

package main

import (
    "time"

    "machine"

    "tinygo.org/x/drivers/bmp180"
)

func main() {
    machine.I2C0.Configure(machine.I2CConfig{})
    sensor := bmp180.New(machine.I2C0)
    sensor.Configure()

    connected := sensor.Connected()
    if !connected {
        println("BMP180 not detected")
        return
    }
    println("BMP180 detected")

    for {
        temp, _ := sensor.ReadTemperature()
        println("Temperature:", float32(temp)/1000, "°C")

        pressure, _ := sensor.ReadPressure()
        println("Pressure", float32(pressure)/100000, "hPa")

        time.Sleep(2 * time.Second)
    }
}

Currently supported devices

The following 65 devices are supported.

Device Name	Interface Type
ADT7410 I2C Temperature Sensor	I2C
ADXL345 accelerometer	I2C
AHT20 I2C Temperature and Humidity Sensor	I2C
AMG88xx 8x8 Thermal camera sensor	I2C
APA102 RGB LED	SPI
AT24CX 2-wire serial EEPROM	I2C
BBC micro:bit LED matrix	GPIO
BH1750 ambient light sensor	I2C
BlinkM RGB LED	I2C
BME280 humidity/pressure sensor	I2C
BMI160 accelerometer/gyroscope	SPI
BMP180 barometer	I2C
BMP280 temperature/barometer	I2C
BMP388 pressure sensor	I2C
Buzzer	GPIO
DHTXX thermometer and humidity sensor	GPIO
DS1307 real time clock	I2C
DS3231 real time clock	I2C
ESP32 as WiFi Coprocessor with Arduino nina-fw	SPI
ESP8266/ESP32 AT Command set for WiFi/TCP/UDP	UART
GPS module	I2C/UART
HC-SR04 Ultrasonic distance sensor	GPIO
HD44780 LCD controller	GPIO/I2C
HUB75 RGB led matrix	SPI
ILI9341 TFT color display	SPI
INA260 Volt/Amp/Power meter	I2C
4x4 Membrane Keypad	GPIO
L293x motor driver	GPIO/PWM
L9110x motor driver	GPIO/PWM
LIS2MDL magnetometer	I2C
LIS3DH accelerometer	I2C
LSM6DS3 accelerometer	I2C
MAG3110 magnetometer	I2C
MAX7219 & MAX7221 display driver	SPI
MCP23017 port expander	I2C
MCP3008 analog to digital converter (ADC)	SPI
MCP2515 Stand-Alone CAN Controller with SPI Interface	SPI
Microphone - PDM	I2S/PDM
MMA8653 accelerometer	I2C
MPU6050 accelerometer/gyroscope	I2C
P1AM-100 Base Controller	SPI
PCD8544 display	SPI
PCF8563 real time clock	I2C
Resistive Touchscreen (4-wire)	GPIO
Semihosting	Debug
Servo	PWM
Shift register (PISO)	GPIO
Shift registers (SIPO)	GPIO
SHT3x Digital Humidity Sensor	I2C
SPI NOR Flash Memory	SPI/QSPI
SSD1306 OLED display	I2C / SPI
SSD1331 TFT color display	SPI
SSD1351 OLED display	SPI
ST7735 TFT color display	SPI
ST7789 TFT color display	SPI
Stepper motor "Easystepper" controller	GPIO
Thermistor	ADC
TM1637 7-segment LED display	I2C
TMP102 I2C Temperature Sensor	I2C
VEML6070 UV light sensor	I2C
VL53L1X time-of-flight distance sensor	I2C
Waveshare 2.13" (B & C) e-paper display	SPI
Waveshare 2.13" e-paper display	SPI
Waveshare 4.2" e-paper B/W display	SPI
WS2812 RGB LED	GPIO

Contributing

Your contributions are welcome!

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

License

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

Documentation

Overview

Package drivers provides a collection of hardware drivers for TinyGo (https://tinygo.org) for devices such as sensors and displays.

Here is an example in TinyGo that uses the BMP180 digital barometer:

package main

import (
	"time"
	"machine"

	"tinygo.org/x/drivers/bmp180"
)

func main() {
	machine.I2C0.Configure(machine.I2CConfig{})
	sensor := bmp180.New(machine.I2C0)
	sensor.Configure()

	connected := sensor.Connected()
	if !connected {
		println("BMP180 not detected")
		return
	}
	println("BMP180 detected")

	for {
		temp, _ := sensor.ReadTemperature()
		println("Temperature:", float32(temp)/1000, "°C")

		pressure, _ := sensor.ReadPressure()
		println("Pressure", float32(pressure)/100000, "hPa")

		time.Sleep(2 * time.Second)
	}
}

Each individual driver is contained within its own sub-package within this package and there are no interdependencies in order to minimize the final size of compiled code that uses any of these drivers.

Index

• Constants
• type Displayer
• type I2C
• type SPI
• type UART

Constants

const Version = "0.16.0"

Version returns a user-readable string showing the version of the drivers package for support purposes. Update this value before release of new version of software.

Types

type Displayer

type Displayer interface {
	// Size returns the current size of the display.
	Size() (x, y int16)

	// SetPizel modifies the internal buffer.
	SetPixel(x, y int16, c color.RGBA)

	// Display sends the buffer (if any) to the screen.
	Display() error
}

type I2C

type I2C interface {
	ReadRegister(addr uint8, r uint8, buf []byte) error
	WriteRegister(addr uint8, r uint8, buf []byte) error
	Tx(addr uint16, w, r []byte) error
}

I2C represents an I2C bus. It is notably implemented by the machine.I2C type.

type SPI

type SPI interface {
	// Tx transmits the given buffer w and receives at the same time the buffer r.
	// The two buffers must be the same length. The only exception is when w or r are nil,
	// in which case Tx only transmits (without receiving) or only receives (while sending 0 bytes).
	Tx(w, r []byte) error

	// Transfer writes a single byte out on the SPI bus and receives a byte at the same time.
	// If you want to transfer multiple bytes, it is more efficient to use Tx instead.
	Transfer(b byte) (byte, error)
}

SPI represents a SPI bus. It is implemented by the machine.SPI type.

type UART

type UART interface {
	io.Reader
	io.Writer

	Buffered() int
}

UART represents a UART connection. It is implemented by the machine.UART type.