Adjust examples

Author: ysoldak

examples/ssd1306/i2c_128x32/main.go

@@ -1,25 +1,31 @@
-package common
+package main
+
+// This example shows how to use SSD1306 OLED display driver over I2C and SPI.
+//
+// Check the `newSSD1306Display()` functions for I2C and SPI initializations.
 
 import (
 	"runtime"
 
 	"image/color"
 	"time"
-
-	"tinygo.org/x/drivers/ssd1306"
 )
 
-var ms = runtime.MemStats{}
+func main() {
 
-func Loop(display ssd1306.Device) {
+	display := newSSD1306Display()
 	display.ClearDisplay()
+
 	w, h := display.Size()
 	x := int16(0)
 	y := int16(0)
 	deltaX := int16(1)
 	deltaY := int16(1)
-	trace := time.Now().UnixMilli() + 1000
+
+	traceTime := time.Now().UnixMilli() + 1000
 	frames := 0
+	ms := runtime.MemStats{}
+
 	for {
 		pixel := display.GetPixel(x, y)
 		c := color.RGBA{255, 255, 255, 255}
@@ -42,11 +48,12 @@ func Loop(display ssd1306.Device) {
 
 		frames++
 		now := time.Now().UnixMilli()
-		if now >= trace {
+		if now >= traceTime {
 			runtime.ReadMemStats(&ms)
 			println("TS", now, "| FPS", frames, "| HeapInuse", ms.HeapInuse)
-			trace = now + 1000
+			traceTime = now + 1000
 			frames = 0
 		}
 	}
+
 }

examples/ssd1306/i2c_128x64/main.go

@@ -0,0 +1,38 @@
+//go:build xiao_ble
+
+// This initializes SSD1306 OLED display driver over I2C.
+//
+// Seeed XIAO BLE board + SSD1306 128x32 I2C OLED display.
+//
+// Wiring:
+// - XIAO GND      -> OLED GND
+// - XIAO 3v3      -> OLED VCC
+// - XIAO D4 (SDA) -> OLED SDA
+// - XIAO D5 (SCL) -> OLED SCK
+//
+// For your case:
+// - Connect the display to I2C pins on your board.
+// - Adjust I2C address and display size as needed.
+
+package main
+
+import (
+	"machine"
+
+	"tinygo.org/x/drivers/ssd1306"
+)
+
+func newSSD1306Display() *ssd1306.Device {
+	machine.I2C0.Configure(machine.I2CConfig{
+		Frequency: 400 * machine.KHz,
+		SDA:       machine.SDA0_PIN,
+		SCL:       machine.SCL0_PIN,
+	})
+	display := ssd1306.NewI2C(machine.I2C0)
+	display.Configure(ssd1306.Config{
+		Address: ssd1306.Address_128_32, // or ssd1306.Address
+		Width:   128,
+		Height:  32, // or 64
+	})
+	return display
+}

examples/ssd1306/common/common.go renamed to examples/ssd1306/main.go

@@ -1,15 +1,20 @@
-// This example using the SSD1306 OLED display over SPI on the Thumby board
-// A very tiny 72x40 display.
+//go:build thumby
+
+// This initializes SSD1306 OLED display driver over SPI.
+//
+// Thumby board has a tiny built-in 72x40 display.
+//
+// As the display is built-in, no wiring is needed.
+
 package main
 
 import (
 	"machine"
 
-	"tinygo.org/x/drivers/examples/ssd1306/common"
 	"tinygo.org/x/drivers/ssd1306"
 )
 
-func main() {
+func newSSD1306Display() *ssd1306.Device {
 	machine.SPI0.Configure(machine.SPIConfig{})
 	display := ssd1306.NewSPI(machine.SPI0, machine.THUMBY_DC_PIN, machine.THUMBY_RESET_PIN, machine.THUMBY_CS_PIN)
 	display.Configure(ssd1306.Config{
@@ -18,6 +23,5 @@ func main() {
 		ResetCol:  ssd1306.ResetValue{28, 99},
 		ResetPage: ssd1306.ResetValue{0, 5},
 	})
-
-	common.Loop(display)
+	return display
 }

examples/ssd1306/main_i2c_xiao-ble.go

@@ -0,0 +1,40 @@
+//go:build xiao_rp2040
+
+// This initializes SSD1306 OLED display driver over SPI.
+//
+// Seeed XIAO RP2040 board + SSD1306 128x64 SPI OLED display.
+//
+// Wiring:
+// - XIAO GND       -> OLED GND
+// - XIAO 3v3       -> OLED VCC
+// - XIAO D8 (SCK)  -> OLED D0
+// - XIAO D10 (SDO) -> OLED D1
+// - XIAO D4        -> OLED RES
+// - XIAO D5        -> OLED DC
+// - XIAO D6        -> OLED CS
+//
+// For your case:
+// - Connect the display to SPI pins on your board.
+// - Adjust RES, DC and CS pins as needed.
+// - Adjust SPI frequency as needed.
+// - Adjust display size as needed.
+
+package main
+
+import (
+	"machine"
+
+	"tinygo.org/x/drivers/ssd1306"
+)
+
+func newSSD1306Display() *ssd1306.Device {
+	machine.SPI0.Configure(machine.SPIConfig{
+		Frequency: 50 * machine.MHz,
+	})
+	display := ssd1306.NewSPI(machine.SPI0, machine.D5, machine.D4, machine.D6)
+	display.Configure(ssd1306.Config{
+		Width:  128,
+		Height: 64,
+	})
+	return display
+}

examples/ssd1306/spi_thumby/main.go renamed to examples/ssd1306/main_spi_thumby.go

@@ -11,8 +11,8 @@ type I2CBus struct {
 }
 
 // NewI2C creates a new SSD1306 connection. The I2C wire must already be configured.
-func NewI2C(bus drivers.I2C) Device {
-	return Device{
+func NewI2C(bus drivers.I2C) *Device {
+	return &Device{
 		bus: &I2CBus{
 			wire:    bus,
 			address: Address,

examples/ssd1306/main_spi_xiao-rp2040.go

@@ -16,11 +16,11 @@ type SPIBus struct {
 }
 
 // NewSPI creates a new SSD1306 connection. The SPI wire must already be configured.
-func NewSPI(bus drivers.SPI, dcPin, resetPin, csPin machine.Pin) Device {
+func NewSPI(bus drivers.SPI, dcPin, resetPin, csPin machine.Pin) *Device {
 	dcPin.Configure(machine.PinConfig{Mode: machine.PinOutput})
 	resetPin.Configure(machine.PinConfig{Mode: machine.PinOutput})
 	csPin.Configure(machine.PinConfig{Mode: machine.PinOutput})
-	return Device{
+	return &Device{
 		bus: &SPIBus{
 			wire:     bus,
 			dcPin:    dcPin,