tinyterm

README

tinyterm - TinyGo Terminal Emulator

A minimal terminal for TinyGo devices supporting 256-color ANSI escape codes.

How to compile examples

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

• Adafruit Clue (https://www.adafruit.com/clue)
• Gopher Badge (https://gopherbadge.com/)
• PyBadge (https://www.adafruit.com/product/4200)
• PyPortal (https://www.adafruit.com/product/4116)
• WioTerminal (https://wiki.seeedstudio.com/Wio-Terminal-Getting-Started/)

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

Documentation

Overview

package tinyterm is for TinyGo developers who want to use a terminal style user interface for any display that supports the Displayer interface. This includes several different displays in the TinyGo Drivers repo.

Index

• Constants
• type Color
• type Config
• type Displayer
• type Terminal
  • func NewTerminal(display Displayer) *Terminal
  • func (t *Terminal) Configure(config *Config)
  • func (t *Terminal) Printf(format string, args ...interface{}) (n int, err error)
  • func (t *Terminal) Println(args ...interface{}) (n int, err error)
  • func (t *Terminal) Write(buf []byte) (int, error)
  • func (t *Terminal) WriteByte(b byte) error

Constants

const (
	SGRReset = iota
	SGRBold
	SGRFaint
	SGRItalic
	SGRUnderline
	SGRSlowBlink
	SGRRapidBlink
	SGRReverseVideo
	SGRConceal
	SGRCrossedOut
	SGRPrimaryFont
	SGRAltFont1
	SGRAltFont2
	SGRAltFont3
	SGRAltFont4
	SGRAltFont5
	SGRAltFont6
	SGRAltFont7
	SGRAltFont8
	SGRAltFont9
	SGRFraktur
	SGRDoubleUnderline
	SGRNormal
	SGRNotItalicNotFraktur
	SGRUnderlineOff
	SGRBlinkOff
	SGRInverseOff
	SGRReveal
	SGRNotCrossedOut

	SGRFgBlack
	SGRFgRed
	SGRFgGreen
	SGRFgYellow
	SGRFgBlue
	SGRFgMagenta
	SGRFgCyan
	SGRFgWhite
	SGRSetFgColor
	SGRDefaultFgColor
	SGRBgBlack
	SGRBgRed
	SGRBgGreen
	SGRBgYellow
	SGRBgBlue
	SGRBgMagenta
	SGRBgCyan
	SGRBgWhite
	SGRSetBgColor
	SGRDefaultBgColor
	SGRFramed
	SGREncircled
	SGROverlined
	SGRIdeogramUnderline
	SGRIdeogramDblUnderline
	SGRIdeogramOverline
	SGRIdeogramStress
	SGRIdeogramAttrOff
)

const Version = "0.3.0"

Version returns a user-readable string showing the version of the TinyTerm package for support purposes.

Update this value before release of new version of software.

Types

type Color

type Color uint8

const (
	ColorBlack Color = iota
	ColorRed
	ColorGreen
	ColorYellow
	ColorBlue
	ColorMagenta
	ColorCyan
	ColorWhite
	ColorBrBlack
	ColorBrRed
	ColorBrGreen
	ColorBrYellow
	ColorBrBlue
	ColorBrMagenta
	ColorBrCyan
	ColorBrWhite
)

type Config

type Config struct {
	// the font to be used for the terminal
	Font *tinyfont.Font

	// font height for the terminal
	FontHeight int16

	// font offset for the terminal
	FontOffset int16

	// UseSoftwareScroll when true will blank the display an start again at
	// the top when running out of space, instead of using whatever hardware
	// scrolling is available on the display.
	UseSoftwareScroll bool
}

Config contains the configuration for a Terminal.

type Displayer

type Displayer interface {
	drivers.Displayer
	FillRectangle(x, y, width, height int16, c color.RGBA) error
	SetScroll(line int16)
}

Displayer is a wrapper around the TinyGo drivers repo's Displayer interface.

type Terminal

type Terminal struct {
	// contains filtered or unexported fields
}

Terminal is a terminal interface that can be used on any display that supports the Displayer interface.

func NewTerminal

func NewTerminal(display Displayer) *Terminal

NewTerminal returns a new Terminal. The Terminal will need to have Configure called on it to be used.

func (*Terminal) Configure

func (t *Terminal) Configure(config *Config)

Configure needs to be called for a new Terminal before it can be used.

func (*Terminal) Printf

func (t *Terminal) Printf(format string, args ...interface{}) (n int, err error)

Printf wraps the fmt package function of the same name, and outputs the result to the terminal.

func (*Terminal) Println

func (t *Terminal) Println(args ...interface{}) (n int, err error)

Println wraps the fmt package function of the same name, and outputs the result to the terminal.

func (*Terminal) Write

func (t *Terminal) Write(buf []byte) (int, error)

Write some data to the terminal.

func (*Terminal) WriteByte

func (t *Terminal) WriteByte(b byte) error

Write a single byte to the terminal.