embd

README

embd

embd is a hardware abstraction layer (HAL) for embedded systems.

It allows you to start your hardware hack on easily available hobby boards (like the Raspberry Pi, BeagleBone Black, C.H.I.P., etc.) by giving you straight-forward access to the board's capabilities as well as a plethora of sensors (like accelerometers, gyroscopes, thermometers, etc.) and controllers (PWM generators, digital-to-analog convertors) for which it includes drivers. If you move to custom designed boards you have to throw away your code: you carry forward the effort where the HAL abstraction of EMBD will save you precious time.

The overall strategy used in embd is to use Linux device drivers to access gpio pins, SPI and I2C buses, as well as interrupts. This makes it easy to port from one platform to another and it enables kernel code to handle the devices as efficiently as possible. What embd then adds is first a Golang library interface on top of the various Linux devices and then another layer of user-level drivers for specific sensors and controllers that are connected to gpio pins or one of the buses.

Blog post introducing EMBD

Getting Started

Install Go version 1.6 or later to make compiling for ARM easy. The set up your GOPATH, and create your first .go file. We'll call it simpleblinker.go.

package main

import (
	"time"

	"github.com/aquarat/embd"
	_ "github.com/aquarat/embd/host/rpi" // This loads the RPi driver
)

func main() {
	for {
		embd.LEDToggle("LED0")
		time.Sleep(250 * time.Millisecond)
	}
}

Then install the EMBD package:

$ go get github.com/aquarat/embd

Build the binary for linux/ARM:

$ export GOOS=linux
$ export GOARCH=arm
$ go build simpleblinker.go

Copy the cross-compiled binary to your RaspberryPi*:

$ scp simpleblinker pi@192.168.2.2:~

Then on the rPi run the program with sudo*:

$ sudo ./simpleblinker

You will now see the green LED (next to the always on power LED) blink every 1/4 sec.

* Notes

• Assuming your RaspberryPi has an IP address of 192.168.2.2. Substitute as necessary
• sudo (root) permission is required as we are controlling the hardware by writing to special files
• This sample program is optimized for brevity and does not clean up after itself. Click here to see the full version

Supported Platforms

• BeagleBone Black
• Intel Edison
• NextThing C.H.I.P
• RaspberryPi 1 A+
• RaspberryPi 1 B+
• RaspberryPi 2
• RaspberryPi 3

Supported Protocols

• Digital GPIO Documentation
• Analog GPIO Documentation
• PWM Documentation
• I2C Documentation
• LED Documentation
• SPI Documentation

Supported Sensors

• BH1750FVI Luminosity sensor Documentation, Datasheet
• BME280 Pressure, Temperature and Humidity Sensor Documentation, Datasheet
• BMP085 Barometric pressure sensor Documentation, Datasheet
• BMP180 Barometric pressure sensor Documentation, Datasheet
• L3GD20 Gyroscope Documentation, Datasheet
• LSM303 Accelerometer and magnetometer Documentation, Datasheet
• TMP006 Thermopile sensor Documentation, Datasheet
• US020 Ultrasonic proximity sensor Documentation, Product Page
• Watersensor Based on LM393 (currently only provides digital support) DocumentationDatasheet

Interfaces

• Keypad(4x3) Product Page

Controllers

• PCA9685 16-channel, 12-bit PWM Controller with I2C protocol Documentation, Datasheet, Product Page
• MCP4725 12-bit DAC Documentation, Datasheet, Product Page
• ServoBlaster RPi PWM/PCM based PWM controller Documentation, Product Page

Convertors

• MCP3008 8-channel, 10-bit ADC with SPI protocol, Datasheet

The command line tool

go get github.com/aquarat/embd/embd

will install a command line utility embd which will allow you to quickly get started with prototyping. The binary should be available in your $GOPATH/bin. However, to be able to run this on a ARM based device, you will need to build it with GOOS=linux and GOARCH=arm environment variables set.

For example, if you run embd detect on a BeagleBone Black:

root@beaglebone:~# embd detect

detected host BeagleBone Black (rev 0)

Run embd without any arguments to discover the various commands supported by the utility.

How to use the framework

Package embd provides a hardware abstraction layer for doing embedded programming on supported platforms like the Raspberry Pi and BeagleBone Black. Most of the examples below will work without change (i.e. the same binary) on all supported platforms. How cool is that?

Although samples are all present in the samples folder, we will show a few choice examples here.

Use the LED driver to toggle LEDs on the BBB:

import "github.com/aquarat/embd"
import _ "github.com/aquarat/embd/host/all"
...
embd.InitLED()
defer embd.CloseLED()
...
led, err := embd.NewLED(3)
...
led.Toggle()

Even shorter when quickly trying things out:

import "github.com/aquarat/embd"
import _ "github.com/aquarat/embd/host/all"
...
embd.InitLED()
defer embd.CloseLED()
...
embd.ToggleLED(3)

3 is the same as USR3 for all intents and purposes. The driver is smart enough to figure all this out.

BBB + PWM:

import "github.com/aquarat/embd"
import _ "github.com/aquarat/embd/host/all"
...
embd.InitGPIO()
defer embd.CloseGPIO()
...
pwm, _ := embd.NewPWMPin("P9_14")
defer pwm.Close()
...
pwm.SetDuty(1000)

Control GPIO pins on the RaspberryPi / BeagleBone Black:

import "github.com/aquarat/embd"
import _ "github.com/aquarat/embd/host/all"
...
embd.InitGPIO()
defer embd.CloseGPIO()
...
embd.SetDirection(10, embd.Out)
embd.DigitalWrite(10, embd.High)

Could also do:

import "github.com/aquarat/embd"
import _ "github.com/aquarat/embd/host/all"
...
embd.InitGPIO()
defer embd.CloseGPIO()
...
pin, err := embd.NewDigitalPin(10)
...
pin.SetDirection(embd.Out)
pin.Write(embd.High)

Or read data from the Bosch BMP085 barometric sensor:

import "github.com/aquarat/embd"
import "github.com/aquarat/embd/sensor/bmp085"
import _ "github.com/aquarat/embd/host/all"
...
bus := embd.NewI2CBus(1)
...
baro := bmp085.New(bus)
...
temp, err := baro.Temperature()
altitude, err := baro.Altitude()

Even find out the heading from the LSM303 magnetometer:

import "github.com/aquarat/embd"
import "github.com/aquarat/embd/sensor/lsm303"
import _ "github.com/aquarat/embd/host/all"
...
bus := embd.NewI2CBus(1)
...
mag := lsm303.New(bus)
...
heading, err := mag.Heading()

The above two examples depend on I2C and therefore will work without change on almost all platforms.

Contributing

Pull requests that follow the guidelines are very appreciated.

If you find a problem but are not up to coding a fix please file an issue. Thank you!

ROADMAP

• Continue to tidy up the README and other documentation.
• move utils.go into util package
• Make sure there are samples for all supported hardware. Better organise samples move into godoc?
• Rummage through the old, largely abandoned parent repo and pull in as many of the requests as possible.
• A fully featured cli tool (embd)
• Continue to add support for additional sensors/controllers/convertors.
• Continue to add support for additional hosts (Cubietruck, Radxa, etc).
• Supporting something other than Linux

Documentation

Overview

Package embd provides a hardware abstraction layer for doing embedded programming on supported platforms like the Raspberry Pi, BeagleBone Black and CHIP. Most of the examples below will work without change (i.e. the same binary) on all supported platforms.

== Overall structure

It's best to think of the top-level embd package as a switchboard that doesn't implement anything on its own but rather relies on sub-packages for hosts drivers and devices and stitches them together. The exports in the top-level package serve a number of different purposes, which can be confusing at first: - it defines a number of driver interfaces, such as the GPIODriver, this is the interface that the driver for each specific platform must implement and is not something of concern to the typical user. - it defines the main low-level hardware interface types: analog pins, digital pins, interrupt pins, I2Cbuses, SPI buses, PWM pins and LEDs. Each type has a New function to instantiate one of these pins or buses. - it defines a number of InitXXX functions that initialize the various drivers, however, these are called by the coresponding NewXXX functions, so can be ignored. - it defines a number of top-level convenience functions, such as DigitalWrite, that can be called as 1-liners instead of first instantiating a DigitalPin and then writing to it

To get started a host driver needs to be registered with the top-level embd package. This is most easily accomplished by doing an "underscore import" on of the sub-packages of embd/host, e.g., `import _ "github.com/aquarat/embd/host/chip"`. An `Init()` function in the host driver registers all the individual drivers with embd.

After getting the host driver the next step might be to instantiate a GPIO pin using `NewDigitalPin` or an I2CBus using `NewI2CBus`. Such a pin or bus can be used directly but often it is passed into the initializer of a sensor, controller or other user-level driver which provides a high-level interface to some device. For example, the New function for the BMP180 type in the `embd/sensor/bmp180` package takes an I2CBus as argument, which it will use to reach the sensor.

== Samples

This section shows a few choice samples, more are available in the samples folder.

Use the LED driver to toggle LEDs on the BBB:

import "github.com/aquarat/embd"
...
embd.InitLED()
defer embd.CloseLED()
...
led, err := embd.NewLED("USR3")
...
led.Toggle()

Even shorter while prototyping:

import "github.com/aquarat/embd"
...
embd.InitLED()
defer embd.CloseLED()
...
embd.ToggleLED(3)

BBB + PWM:

import "github.com/aquarat/embd"
...
embd.InitGPIO()
defer embd.CloseGPIO()
...
pwm, _ := embd.NewPWMPin("P9_14")
defer pwm.Close()
...
pwm.SetDuty(1000)

Control GPIO pins on the RaspberryPi / BeagleBone Black:

import "github.com/aquarat/embd"
...
embd.InitGPIO()
defer embd.CloseGPIO()
...
embd.SetDirection(10, embd.Out)
embd.DigitalWrite(10, embd.High)

Could also do:

import "github.com/aquarat/embd"
...
embd.InitGPIO()
defer embd.CloseGPIO()
...
pin, err := embd.NewDigitalPin(10)
...
pin.SetDirection(embd.Out)
pin.Write(embd.High)

Or read data from the Bosch BMP085 barometric sensor:

import "github.com/aquarat/embd"
import "github.com/aquarat/embd/sensor/bmp085"
...
bus := embd.NewI2CBus(1)
...
baro := bmp085.New(bus)
...
temp, err := baro.Temperature()
altitude, err := baro.Altitude()

Even find out the heading from the LSM303 magnetometer:

import "github.com/aquarat/embd"
import "github.com/aquarat/embd/sensor/lsm303"
...
bus := embd.NewI2CBus(1)
...
mag := lsm303.New(bus)
...
heading, err := mag.Heading()

The above two examples depend on I2C and therefore will work without change on almost all platforms.

• Copyright (c) Karan Misra 2014 *
• Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
• associated documentation files (the "Software"), to deal in the Software without restriction,
• including without limitation the rights to use, copy, modify, merge, publish, distribute,
• sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
• furnished to do so, subject to the following conditions: *
• The above copyright notice and this permission notice shall be included in all copies or
• substantial portions of the Software. *
• THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
• NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
• NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
• DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
• OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

• Constants
• Variables
• func ActiveLow(key interface{}, b bool) error
• func AnalogRead(key interface{}) (int, error)
• func CloseGPIO() error
• func CloseI2C() error
• func CloseLED() error
• func CloseSPI() error
• func DigitalRead(key interface{}) (int, error)
• func DigitalWrite(key interface{}, val int) error
• func FindFirstMatchingFile(glob string) (string, error)
• func InitGPIO() error
• func InitI2C() error
• func InitLED() error
• func InitSPI() error
• func LEDOff(key interface{}) error
• func LEDOn(key interface{}) error
• func LEDToggle(key interface{}) error
• func PullDown(key interface{}) error
• func PullUp(key interface{}) error
• func Register(host Host, describer Describer)
• func SetDirection(key interface{}, dir Direction) error
• func SetHost(host Host, rev int)
• type AnalogPin
  • func NewAnalogPin(key interface{}) (AnalogPin, error)
• type Describer
• type Descriptor
  • func DescribeHost() (*Descriptor, error)
• type DigitalPin
  • func NewDigitalPin(key interface{}) (DigitalPin, error)
• type Direction
• type Edge
• type GPIODriver
  • func NewGPIODriver(pinMap PinMap, dpf digitalPinFactory, apf analogPinFactory, ppf pwmPinFactory) GPIODriver
• type Host
  • func DetectHost() (host Host, rev int, err error)
• type I2CBus
  • func NewI2CBus(l byte) I2CBus
• type I2CDriver
  • func NewI2CDriver(ibf i2cBusFactory) I2CDriver
• type InterruptPin
• type LED
  • func NewLED(key interface{}) (LED, error)
• type LEDDriver
  • func NewLEDDriver(ledMap LEDMap, lf ledFactory) LEDDriver
• type LEDMap
• type PWMPin
  • func NewPWMPin(key interface{}) (PWMPin, error)
• type PinDesc
• type PinMap
  • func (m PinMap) Lookup(k interface{}, cap int) (*PinDesc, bool)
• type Polarity
• type SPIBus
  • func NewSPIBus(mode, channel byte, speed, bpw, delay int) SPIBus
• type SPIDriver
  • func NewSPIDriver(spiDevMinor int, sbf spiBusFactory, i func() error) SPIDriver

Constants

const (
	// HostNull reprents a null host.
	HostNull Host = ""

	// HostRPi represents the RaspberryPi.
	HostRPi = "Raspberry Pi"

	// HostBBB represents the BeagleBone Black.
	HostBBB = "BeagleBone Black"

	// HostGalileo represents the Intel Galileo board.
	HostGalileo = "Intel Galileo"

	// HostEdison represents teh Intel Edison board.
	HostEdison = "Intel Edison"

	// HostCubieTruck represents the Cubie Truck.
	HostCubieTruck = "CubieTruck"

	// HostRadxa represents the Radxa board.
	HostRadxa = "Radxa"

	// HostCHIP represents the NextThing C.H.I.P.
	HostCHIP = "CHIP"
)

const (
	// Low represents 0.
	Low int = iota

	// High represents 1.
	High
)

const (
	// CapDigital represents the digital IO capability.
	CapDigital int = 1 << iota

	// CapI2C represents pins with the I2C capability.
	CapI2C

	// CapUART represents pins with the UART capability.
	CapUART

	// CapSPI represents pins with the SPI capability.
	CapSPI

	// CapGPMS represents pins with the GPMC capability.
	CapGPMC

	// CapLCD represents pins used to carry LCD data.
	CapLCD

	// CapPWM represents pins with PWM capability.
	CapPWM

	// CapAnalog represents pins with analog IO capability.
	CapAnalog
)

const (

	// SPIMode0 represents the mode0 operation (CPOL=0 CPHA=0) of spi.
	SPIMode0 = (0 | 0)

	// SPIMode1 represents the mode0 operation (CPOL=0 CPHA=1) of spi.
	SPIMode1 = (0 | spiCpha)

	// SPIMode2 represents the mode0 operation (CPOL=1 CPHA=0) of spi.
	SPIMode2 = (spiCpol | 0)

	// SPIMode3 represents the mode0 operation (CPOL=1 CPHA=1) of spi.
	SPIMode3 = (spiCpol | spiCpha)
)

Variables

var ErrFeatureNotImplemented = errors.New("embd: requested feature is not implemented")

ErrFeatureNotImplemented is returned when a particular feature is supported by the host but not implemented yet.

var ErrFeatureNotSupported = errors.New("embd: requested feature is not supported")

ErrFeatureNotSupported is returned when the host does not support a particular feature.

Functions

func ActiveLow

func ActiveLow(key interface{}, b bool) error

ActiveLow makes the pin active low. A low logical state is represented by a high state on the physical pin, and vice-versa.

func AnalogRead

func AnalogRead(key interface{}) (int, error)

AnalogWrite reads a value from the pin.

func CloseGPIO

func CloseGPIO() error

CloseGPIO releases resources associated with the GPIO driver.

func CloseI2C

func CloseI2C() error

CloseI2C releases resources associated with the I2C driver.

func CloseLED

func CloseLED() error

CloseLED releases resources associated with the LED driver.

func CloseSPI

func CloseSPI() error

CloseSPI releases resources associated with the SPI driver.

func DigitalRead

func DigitalRead(key interface{}) (int, error)

DigitalRead reads a value from the pin.

func DigitalWrite

func DigitalWrite(key interface{}, val int) error

DigitalWrite writes val to the pin.

func FindFirstMatchingFile

func FindFirstMatchingFile(glob string) (string, error)

FindFirstMatchingFile finds the first glob match in the filesystem. Inspiration: https://github.com/mrmorphic/hwio/blob/master/hwio.go#L451

func InitGPIO

func InitGPIO() error

InitGPIO initializes the GPIO driver.

func InitI2C

func InitI2C() error

InitI2C initializes the I2C driver.

func InitLED

func InitLED() error

InitLED initializes the LED driver.

func InitSPI

func InitSPI() error

InitSPI initializes the SPI driver.

func LEDOff

func LEDOff(key interface{}) error

LEDOff switches the LED off.

func LEDOn

func LEDOn(key interface{}) error

LEDOn switches the LED on.

func LEDToggle

func LEDToggle(key interface{}) error

LEDToggle toggles the LED.

func PullDown

func PullDown(key interface{}) error

PullDown pulls the pin down.

func PullUp

func PullUp(key interface{}) error

PullUp pulls the pin up.

func Register

func Register(host Host, describer Describer)

Register makes a host describer available by the provided host key. If Register is called twice with the same host or if describer is nil, it panics.

func SetDirection

func SetDirection(key interface{}, dir Direction) error

SetDirection sets the direction of the pin (in/out).

func SetHost

func SetHost(host Host, rev int)

SetHost overrides the host and revision no.

Types

type AnalogPin

type AnalogPin interface {
	// N returns the logical GPIO number.
	N() int

	// Read reads the value from the pin.
	Read() (int, error)

	// Close releases the resources associated with the pin.
	Close() error
}

AnalogPin implements access to a analog IO capable GPIO pin.

func NewAnalogPin

func NewAnalogPin(key interface{}) (AnalogPin, error)

NewAnalogPin returns a AnalogPin interface which allows control over the analog GPIO pin.

type Describer

type Describer func(rev int) *Descriptor

The Describer type is a Descriptor provider.

type Descriptor

type Descriptor struct {
	GPIODriver func() GPIODriver
	I2CDriver  func() I2CDriver
	LEDDriver  func() LEDDriver
	SPIDriver  func() SPIDriver
}

Descriptor represents a host descriptor.

func DescribeHost

func DescribeHost() (*Descriptor, error)

DescribeHost returns the detected host descriptor. Can be overriden by calling SetHost though.

type DigitalPin

type DigitalPin interface {
	InterruptPin

	// N returns the logical GPIO number.
	N() int

	// Write writes the provided value to the pin.
	Write(val int) error

	// Read reads the value from the pin.
	Read() (int, error)

	// TimePulse measures the duration of a pulse on the pin.
	TimePulse(state int) (time.Duration, error)

	// SetDirection sets the direction of the pin (in/out).
	SetDirection(dir Direction) error

	// ActiveLow makes the pin active low. A low logical state is represented by
	// a high state on the physical pin, and vice-versa.
	ActiveLow(b bool) error

	// PullUp pulls the pin up.
	PullUp() error

	// PullDown pulls the pin down.
	PullDown() error

	// Close releases the resources associated with the pin.
	Close() error
}

DigitalPin implements access to a digital IO capable GPIO pin.

func NewDigitalPin

func NewDigitalPin(key interface{}) (DigitalPin, error)

NewDigitalPin returns a DigitalPin interface which allows control over the digital GPIO pin.

type Direction

type Direction int

The Direction type indicates the direction of a GPIO pin.

const (
	// In represents read mode.
	In Direction = iota

	// Out represents write mode.
	Out
)

type Edge

type Edge string

The Edge trigger for the GPIO Interrupt

const (
	EdgeNone    Edge = "none"
	EdgeRising  Edge = "rising"
	EdgeFalling Edge = "falling"
	EdgeBoth    Edge = "both"
)

type GPIODriver

type GPIODriver interface {
	// PinMap returns the pinmap for this driver.
	PinMap() PinMap

	// Unregister unregisters the pin from the driver. Should be called when the pin is closed.
	Unregister(string) error

	// DigitalPin returns a pin capable of doing digital IO.
	DigitalPin(key interface{}) (DigitalPin, error)

	// AnalogPin returns a pin capable of doing analog IO.
	AnalogPin(key interface{}) (AnalogPin, error)

	// PWMPin returns a pin capable of generating PWM.
	PWMPin(key interface{}) (PWMPin, error)

	// Close releases the resources associated with the driver.
	Close() error
}

GPIODriver implements a generic GPIO driver.

func NewGPIODriver

func NewGPIODriver(pinMap PinMap, dpf digitalPinFactory, apf analogPinFactory, ppf pwmPinFactory) GPIODriver

NewGPIODriver returns a GPIODriver interface which allows control over the GPIO subsystem.

type Host

type Host string

The Host type represents all the supported host types.

func DetectHost

func DetectHost() (host Host, rev int, err error)

DetectHost returns the detected host and its revision number.

type I2CBus

type I2CBus interface {
	// ReadByte reads a byte from the given address.
	ReadByte(addr byte) (value byte, err error)
	// ReadBytes reads a slice of bytes from the given address.
	ReadBytes(addr byte, num int) (value []byte, err error)
	// WriteByte writes a byte to the given address.
	WriteByte(addr, value byte) error
	// WriteBytes writes a slice bytes to the given address.
	WriteBytes(addr byte, value []byte) error

	// ReadFromReg reads n (len(value)) bytes from the given address and register.
	ReadFromReg(addr, reg byte, value []byte) error
	// ReadByteFromReg reads a byte from the given address and register.
	ReadByteFromReg(addr, reg byte) (value byte, err error)
	// ReadU16FromReg reads a unsigned 16 bit integer from the given address and register.
	ReadWordFromReg(addr, reg byte) (value uint16, err error)

	// WriteToReg writes len(value) bytes to the given address and register.
	WriteToReg(addr, reg byte, value []byte) error
	// WriteByteToReg writes a byte to the given address and register.
	WriteByteToReg(addr, reg, value byte) error
	// WriteU16ToReg
	WriteWordToReg(addr, reg byte, value uint16) error

	// Close releases the resources associated with the bus.
	Close() error
}

I2CBus interface is used to interact with the I2C bus.

func NewI2CBus

func NewI2CBus(l byte) I2CBus

NewI2CBus returns a I2CBus.

type I2CDriver

type I2CDriver interface {
	Bus(l byte) I2CBus

	// Close releases the resources associated with the driver.
	Close() error
}

I2CDriver interface interacts with the host descriptors to allow us control of I2C communication.

func NewI2CDriver

func NewI2CDriver(ibf i2cBusFactory) I2CDriver

NewI2CDriver returns a I2CDriver interface which allows control over the I²C subsystem.

type InterruptPin

type InterruptPin interface {

	// Start watching this pin for interrupt
	Watch(edge Edge, handler func(DigitalPin)) error

	// Stop watching this pin for interrupt
	StopWatching() error
}

InterruptPin implements access to an interrupt capable GPIO pin. The basic capability provided is to watch for a transition on the pin and generate a callback to a handler when a transition occurs. On Linux the underlying implementation generally uses epoll to receive the interrupts at user-level.

type LED

type LED interface {
	// On switches the LED on.
	On() error

	// Off switches the LED off.
	Off() error

	// Toggle toggles the LED.
	Toggle() error

	// Close releases resources associated with the LED.
	Close() error
}

The LED interface is used to control a led on the prototyping board.

func NewLED

func NewLED(key interface{}) (LED, error)

NewLED returns a LED interface which allows control over the LED.

type LEDDriver

type LEDDriver interface {
	LED(key interface{}) (LED, error)

	Close() error
}

LEDDriver interface interacts with the host descriptors to allow us control of the LEDs.

func NewLEDDriver

func NewLEDDriver(ledMap LEDMap, lf ledFactory) LEDDriver

NewLEDDriver returns a LEDDriver interface which allows control over the LED subsystem.

type LEDMap

type LEDMap map[string][]string

LEDMap type represents a LED mapping for a host.

type PWMPin

type PWMPin interface {
	// N returns the logical PWM id.
	N() string

	// SetPeriod sets the period of a pwm pin.
	SetPeriod(ns int) error

	// SetDuty sets the duty of a pwm pin.
	SetDuty(ns int) error

	// SetPolarity sets the polarity of a pwm pin.
	SetPolarity(pol Polarity) error

	// SetMicroseconds sends a command to the PWM driver to generate a us wide pulse.
	SetMicroseconds(us int) error

	// SetAnalog allows easy manipulation of the PWM based on a (0-255) range value.
	SetAnalog(value byte) error

	// Close releases the resources associated with the pin.
	Close() error
}

PWMPin implements access to a pwm capable GPIO pin.

func NewPWMPin

func NewPWMPin(key interface{}) (PWMPin, error)

NewPWMPin returns a PWMPin interface which allows PWM signal generation over a the PWM pin.

type PinDesc

type PinDesc struct {
	ID      string
	Aliases []string
	Caps    int

	DigitalLogical int
	AnalogLogical  int
}

PinDesc represents a pin descriptor.

type PinMap

type PinMap []*PinDesc

PinMap type represents a collection of pin descriptors.

func (PinMap) Lookup

func (m PinMap) Lookup(k interface{}, cap int) (*PinDesc, bool)

Lookup returns a pin descriptor matching the provided key and capability combination. This allows the same keys to be used across pins with differing capabilities. For example, it is perfectly fine to have:

pin1: {Aliases: [10, GPIO10], Cap: CapDigital}
pin2: {Aliases: [10, AIN0], Cap: CapAnalog}

Searching for 10 with CapDigital will return pin1 and searching for 10 with CapAnalog will return pin2. This makes for a very pleasant to use API.

type Polarity

type Polarity int

The Polarity type indicates the polarity of a pwm pin.

const (
	// Positive represents (default) positive polarity.
	Positive Polarity = iota

	// Negative represents negative polarity.
	Negative
)

type SPIBus

type SPIBus interface {
	io.Writer

	// TransferAndReceiveData transmits data in a buffer(slice) and receives into it.
	TransferAndReceiveData(dataBuffer []uint8) error

	// ReceiveData receives data of length len into a slice.
	ReceiveData(len int) ([]uint8, error)

	// TransferAndReceiveByte transmits a byte data and receives a byte.
	TransferAndReceiveByte(data byte) (byte, error)

	// ReceiveByte receives a byte data.
	ReceiveByte() (byte, error)

	// Close releases the resources associated with the bus.
	Close() error
}

SPIBus interface allows interaction with the SPI bus.

func NewSPIBus

func NewSPIBus(mode, channel byte, speed, bpw, delay int) SPIBus

NewSPIBus returns a SPIBus.

type SPIDriver

type SPIDriver interface {
	// Bus returns a SPIBus interface which allows us to use spi functionalities
	Bus(byte, byte, int, int, int) SPIBus

	// Close cleans up all the initialized SPIbus
	Close() error
}

SPIDriver interface interacts with the host descriptors to allow us control of SPI communication.

func NewSPIDriver

func NewSPIDriver(spiDevMinor int, sbf spiBusFactory, i func() error) SPIDriver

NewSPIDriver returns a SPIDriver interface which allows control over the SPI bus.