goled

README

go-oled-i2c

Go implementation for .96 OLED I2C manipulation

This is a very basic Go implementation for 0.96" Oled i2c display manipulation.

Why

Story behing this library is that I have an Omega2+ with me and I wanted to do something with it(which should be suited for this little beast's capability). So I decided to build a local file server with this. Now a basic file server is okay but I also have various 0.96" Oled display with me so decided to add for this file server.

I tried initializing this Oled with Go's Periph package but it was not working. So while searching for other i2c libraries for Go, I found go-i2c and it was working.. TADA!

So I wrote this wrapper around this library for 0.96" Oled display.

Features

As of now the library is very basic and only supports,

1. Switch on/off display functions
2. Clear function
3. Write text function
4. Set cursor function

Usage

Library is very easy to use. Check the following example,

package main

import (
	"log"
	goled "github.com/sachingorade/go-oled-i2c"
)

func main() {
	oled, err := goled.BeginOled()
	if err != nil {
		log.Fatal(err)
		return
	}
	defer oled.Close()

	oled.Clear()

	oled.Write("Hello from go!")
}

License

Licensed under MIT :)

Documentation

Index

• type Oled
  • func BeginOled() (*Oled, error)
  • func (v *Oled) Clear() error
  • func (v *Oled) Close()
  • func (v *Oled) DisplayOff() error
  • func (v *Oled) DisplayOn() error
  • func (v *Oled) SetColumnAddressing(startPixel int, endPixel int) (int, error)
  • func (v *Oled) SetCursor(row int, column int) error
  • func (v *Oled) Write(message string) (int, error)
  • func (v *Oled) WriteChar(c int) error
  • func (v *Oled) WriteCharUnchecked(c int) error

Types

type Oled

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

Oled Represents oled display

func BeginOled

func BeginOled() (*Oled, error)

BeginOled Creates a new Oled reference

func (*Oled) Clear

func (v *Oled) Clear() error

Clear clears oled screen

func (*Oled) Close

func (v *Oled) Close()

Close closes the oled i2c bus

func (*Oled) DisplayOff

func (v *Oled) DisplayOff() error

DisplayOff switches off the oled display

func (*Oled) DisplayOn

func (v *Oled) DisplayOn() error

DisplayOn switches on the oled display

func (*Oled) SetColumnAddressing

func (v *Oled) SetColumnAddressing(startPixel int, endPixel int) (int, error)

SetColumnAddressing sets the oled viewport

func (*Oled) SetCursor

func (v *Oled) SetCursor(row int, column int) error

SetCursor sets the cursor at specified row and column

func (*Oled) Write

func (v *Oled) Write(message string) (int, error)

Write writes the specified string on oled

func (*Oled) WriteChar

func (v *Oled) WriteChar(c int) error

WriteChar writes specified character on oled display

func (*Oled) WriteCharUnchecked

func (v *Oled) WriteCharUnchecked(c int) error

WriteCharUnchecked write specified character as it is on oled