pinreg

Documentation

Overview

Package pinreg is a registry for the physical headers (made up of pins) on a host.

Index

• func All() map[string][][]pin.Pin
• func IsConnected(p pin.Pin) bool
• func Position(p pin.Pin) (string, int)
• func Register(name string, allPins [][]pin.Pin) error

Functions

func All

func All() map[string][][]pin.Pin

All contains all the on-board headers on a micro computer.

The map key is the header name, e.g. "P1" or "EULER" and the value is a slice of slice of pin.Pin. For a 2x20 header, it's going to be a slice of [20][2]pin.Pin.

func IsConnected

func IsConnected(p pin.Pin) bool

IsConnected returns true if the pin is on a header.

func Position

func Position(p pin.Pin) (string, int)

Position returns the position on a pin if found.

The header and the pin number. Pin numbers are 1-based.

Returns "", 0 if not connected.

func Register

func Register(name string, allPins [][]pin.Pin) error

Register registers a physical header.

It automatically registers all gpio pins to gpioreg.