Skip to content

Latest commit

 

History

History
80 lines (56 loc) · 1.86 KB

README.md

File metadata and controls

80 lines (56 loc) · 1.86 KB

tinyterm - TinyGo Terminal Emulator

Build

A minimal terminal for TinyGo displays. Supporting 256-color ANSI escape codes, as well as monochrome displays such as e-ink or OLED.

examples/colors/main.go running on PyPortal

How to use it

package main

import (
	"fmt"
	"time"

	"tinygo.org/x/tinyfont/proggy"
	"tinygo.org/x/tinyterm"
	"tinygo.org/x/tinyterm/displays"
)

var (
	font = &proggy.TinySZ8pt7b
)

func main() {
	display := displays.Init()
	terminal := tinyterm.NewTerminal(display)

	terminal.Configure(&tinyterm.Config{
		Font:              font,
		FontHeight:        10,
		FontOffset:        6,
		UseSoftwareScroll: displays.NeedsSoftwareScroll(),
	})
	for {
		time.Sleep(time.Second)

		fmt.Fprintf(terminal, "\ntime: %d", time.Now().UnixNano())
		terminal.Display()
	}
}

How to compile examples

Most of the examples will work with any of the following hardware:

basic

Displays basic text.

tinygo flash -target pyportal ./examples/basic

colors

Displays ANSI colors.

tinygo flash -target pyportal ./examples/colors

httpclient

Connects to an http server and displays the results. Runs on PyPortal and WioTerminal only, since it requires a connected WiFi coprocessor.

tinygo flash -target pyportal -ldflags="-X main.ssid=MYSSID -X main.pass=MYPASS" ./examples/httpclient