import "gobot.io/x/gobot/drivers/spi"
Package spi provides Gobot drivers for spi devices. Uses periph.io for spi Installing:
go get -d -u gobot.io/x/gobot
For further information refer to spi README: https://github.com/hybridgroup/gobot/blob/master/drivers/spi/README.md
apa102.go doc.go mcp3002.go mcp3004.go mcp3008.go mcp3202.go mcp3204.go mcp3208.go mcp3304.go spi.go spi_config.go ssd1306_driver.go
const MCP3002DriverMaxChannel = 2MCP3002DriverMaxChannel is the number of channels of this A/D converter.
const MCP3004DriverMaxChannel = 3MCP3004DriverMaxChannel is the number of channels of this A/D converter.
const MCP3008DriverMaxChannel = 8MCP3008DriverMaxChannel is the number of channels of this A/D converter.
const MCP3202DriverMaxChannel = 2MCP3202DriverMaxChannel is the number of channels of this A/D converter.
const MCP3204DriverMaxChannel = 4MCP3204DriverMaxChannel is the number of channels of this A/D converter.
const MCP3208DriverMaxChannel = 8MCP3208DriverMaxChannel is the number of channels of this A/D converter.
const MCP3304DriverMaxChannel = 8MCP3304DriverMaxChannel is the number of channels of this A/D converter.
const (
// NotInitialized is the initial value for a bus/chip
NotInitialized = -1
)WithBits sets how many bits to use as a optional param.
WithBus sets which bus to use as a optional param.
WithChip sets which chip to use as a optional param.
WithDCPin option sets the SSD1306Driver DC Pin option.
WithDisplayHeight option sets the SSD1306Driver DisplayHeight option.
WithDisplayWidth option sets the SSD1306Driver DisplayWidth option.
WithExternalVCC option sets the SSD1306Driver external vcc option.
WithMode sets which mode to use as a optional param.
WithRstPin option sets the SSD1306Driver RST pin option.
WithSpeed sets what speed to use as a optional param.
APA102Driver is a driver for the APA102 programmable RGB LEDs.
NewAPA102Driver creates a new Gobot Driver for APA102 RGB LEDs.
Params:
a *Adaptor - the Adaptor to use with this Driver. count int - how many LEDs are in the array controlled by this driver. bright - the default brightness to apply for all LEDs (must be between 0 and 31).
Optional params:
spi.WithBus(int): bus to use with this driver. spi.WithChip(int): chip to use with this driver. spi.WithMode(int): mode to use with this driver. spi.WithBits(int): number of bits to use with this driver. spi.WithSpeed(int64): speed in Hz to use with this driver.
func (d *APA102Driver) Brightness() uint8
Brightness return driver brightness value.
func (d *APA102Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (d *APA102Driver) Draw() error
Draw displays the RGBA values set on the actual LED strip.
func (d *APA102Driver) Halt() (err error)
Halt stops the driver.
func (d *APA102Driver) Name() string
Name returns the name of the device.
func (d *APA102Driver) SetBrightness(i uint8)
SetBrightness sets the ith LED's brightness to the given value. Must be between 0 and 31.
func (d *APA102Driver) SetName(n string)
SetName sets the name of the device.
func (d *APA102Driver) SetRGBA(i int, v color.RGBA)
SetRGBA sets the ith LED's color to the given RGBA value. A subsequent call to Draw is required to transmit values to the LED strip.
func (d *APA102Driver) Start() (err error)
Start initializes the driver.
type Config interface {
// WithBus sets which bus to use
WithBus(bus int)
// GetBusOrDefault gets which bus to use
GetBusOrDefault(def int) int
// WithChip sets which chip to use
WithChip(chip int)
// GetChipOrDefault gets which chip to use
GetChipOrDefault(def int) int
// WithMode sets which mode to use
WithMode(mode int)
// GetModeOrDefault gets which mode to use
GetModeOrDefault(def int) int
// WithBIts sets how many bits to use
WithBits(bits int)
// GetBitsOrDefault gets how many bits to use
GetBitsOrDefault(def int) int
// WithSpeed sets which speed to use (in Hz)
WithSpeed(speed int64)
// GetSpeedOrDefault gets which speed to use (in Hz)
GetSpeedOrDefault(def int64) int64
}Config is the interface which describes how a Driver can specify optional SPI params such as which SPI bus it wants to use.
NewConfig returns a new SPI Config.
type Connection Operations
Connection is a connection to a SPI device with a specific bus/chip. Provided by an Adaptor, usually just by calling the spi package's GetSpiConnection() function.
func GetSpiConnection(busNum, chipNum, mode, bits int, maxSpeed int64) (Connection, error)
GetSpiConnection is a helper to return a SPI device.
type Connector interface {
// GetSpiConnection returns a connection to a SPI device at the specified bus and chip.
// Bus numbering starts at index 0, the range of valid buses is
// platform specific. Same with chip numbering.
GetSpiConnection(busNum, chip, mode, bits int, maxSpeed int64) (device Connection, err error)
// GetSpiDefaultBus returns the default SPI bus index
GetSpiDefaultBus() int
// GetSpiDefaultChip returns the default SPI chip index
GetSpiDefaultChip() int
// GetDefaultMode returns the default SPI mode (0/1/2/3)
GetSpiDefaultMode() int
// GetDefaultMode returns the default SPI number of bits (8)
GetSpiDefaultBits() int
// GetSpiDefaultMaxSpeed returns the max SPI speed
GetSpiDefaultMaxSpeed() int64
}Connector lets Adaptors provide the interface for Drivers to get access to the SPI buses on platforms that support SPI.
type DisplayBuffer struct {
// contains filtered or unexported fields
}DisplayBuffer represents the display buffer intermediate memory
func NewDisplayBuffer(width, height, pageSize int) *DisplayBuffer
NewDisplayBuffer creates a new DisplayBuffer
func (d *DisplayBuffer) Clear()
Clear the contents of the display buffer
func (d *DisplayBuffer) Set(buf []byte)
Set sets the display buffer with the given buffer
func (d *DisplayBuffer) SetPixel(x, y, c int)
SetPixel sets the x, y pixel with c color
func (d *DisplayBuffer) Size() int
Size returns the memory size of the display buffer
MCP3002Driver is a driver for the MCP3002 A/D converter.
func NewMCP3002Driver(a Connector, options ...func(Config)) *MCP3002Driver
NewMCP3002Driver creates a new Gobot Driver for MCP3002 A/D converter
Params:
a *Adaptor - the Adaptor to use with this Driver
Optional params:
spi.WithBus(int): bus to use with this driver spi.WithChip(int): chip to use with this driver spi.WithMode(int): mode to use with this driver spi.WithBits(int): number of bits to use with this driver spi.WithSpeed(int64): speed in Hz to use with this driver
func (d *MCP3002Driver) AnalogRead(pin string) (value int, err error)
AnalogRead returns value from analog reading of specified pin
func (d *MCP3002Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (d *MCP3002Driver) Halt() (err error)
Halt stops the driver.
func (d *MCP3002Driver) Name() string
Name returns the name of the device.
func (d *MCP3002Driver) Read(channel int) (result int, err error)
Read reads the current analog data for the desired channel.
func (d *MCP3002Driver) SetName(n string)
SetName sets the name of the device.
func (d *MCP3002Driver) Start() (err error)
Start initializes the driver.
MCP3004Driver is a driver for the MCP3008 A/D converter.
func NewMCP3004Driver(a Connector, options ...func(Config)) *MCP3004Driver
NewMCP3004Driver creates a new Gobot Driver for MCP3004 A/D converter
Params:
a *Adaptor - the Adaptor to use with this Driver
Optional params:
spi.WithBus(int): bus to use with this driver spi.WithChip(int): chip to use with this driver spi.WithMode(int): mode to use with this driver spi.WithBits(int): number of bits to use with this driver spi.WithSpeed(int64): speed in Hz to use with this driver
func (d *MCP3004Driver) AnalogRead(pin string) (value int, err error)
AnalogRead returns value from analog reading of specified pin
func (d *MCP3004Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (d *MCP3004Driver) Halt() (err error)
Halt stops the driver.
func (d *MCP3004Driver) Name() string
Name returns the name of the device.
func (d *MCP3004Driver) Read(channel int) (result int, err error)
Read reads the current analog data for the desired channel.
func (d *MCP3004Driver) SetName(n string)
SetName sets the name of the device.
func (d *MCP3004Driver) Start() (err error)
Start initializes the driver.
MCP3008Driver is a driver for the MCP3008 A/D converter.
func NewMCP3008Driver(a Connector, options ...func(Config)) *MCP3008Driver
NewMCP3008Driver creates a new Gobot Driver for MCP3008Driver A/D converter
Params:
a *Adaptor - the Adaptor to use with this Driver
Optional params:
spi.WithBus(int): bus to use with this driver spi.WithChip(int): chip to use with this driver spi.WithMode(int): mode to use with this driver spi.WithBits(int): number of bits to use with this driver spi.WithSpeed(int64): speed in Hz to use with this driver
func (d *MCP3008Driver) AnalogRead(pin string) (value int, err error)
AnalogRead returns value from analog reading of specified pin
func (d *MCP3008Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (d *MCP3008Driver) Halt() (err error)
Halt stops the driver.
func (d *MCP3008Driver) Name() string
Name returns the name of the device.
func (d *MCP3008Driver) Read(channel int) (result int, err error)
Read reads the current analog data for the desired channel.
func (d *MCP3008Driver) SetName(n string)
SetName sets the name of the device.
func (d *MCP3008Driver) Start() (err error)
Start initializes the driver.
MCP3202Driver is a driver for the MCP3202 A/D converter.
func NewMCP3202Driver(a Connector, options ...func(Config)) *MCP3202Driver
NewMCP3202Driver creates a new Gobot Driver for MCP3202Driver A/D converter
Params:
a *Adaptor - the Adaptor to use with this Driver
Optional params:
spi.WithBus(int): bus to use with this driver spi.WithChip(int): chip to use with this driver spi.WithMode(int): mode to use with this driver spi.WithBits(int): number of bits to use with this driver spi.WithSpeed(int64): speed in Hz to use with this driver
func (d *MCP3202Driver) AnalogRead(pin string) (value int, err error)
AnalogRead returns value from analog reading of specified pin, scaled to 0-1023 value.
func (d *MCP3202Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (d *MCP3202Driver) Halt() (err error)
Halt stops the driver.
func (d *MCP3202Driver) Name() string
Name returns the name of the device.
func (d *MCP3202Driver) Read(channel int) (result int, err error)
Read reads the current analog data for the desired channel.
func (d *MCP3202Driver) SetName(n string)
SetName sets the name of the device.
func (d *MCP3202Driver) Start() (err error)
Start initializes the driver.
MCP3204Driver is a driver for the MCP3204 A/D converter.
func NewMCP3204Driver(a Connector, options ...func(Config)) *MCP3204Driver
NewMCP3204Driver creates a new Gobot Driver for MCP3204Driver A/D converter
Params:
a *Adaptor - the Adaptor to use with this Driver
Optional params:
spi.WithBus(int): bus to use with this driver spi.WithChip(int): chip to use with this driver spi.WithMode(int): mode to use with this driver spi.WithBits(int): number of bits to use with this driver spi.WithSpeed(int64): speed in Hz to use with this driver
func (d *MCP3204Driver) AnalogRead(pin string) (value int, err error)
AnalogRead returns value from analog reading of specified pin, scaled to 0-1023 value.
func (d *MCP3204Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (d *MCP3204Driver) Halt() (err error)
Halt stops the driver.
func (d *MCP3204Driver) Name() string
Name returns the name of the device.
func (d *MCP3204Driver) Read(channel int) (result int, err error)
Read reads the current analog data for the desired channel.
func (d *MCP3204Driver) SetName(n string)
SetName sets the name of the device.
func (d *MCP3204Driver) Start() (err error)
Start initializes the driver.
MCP3208Driver is a driver for the MCP3208 A/D converter.
func NewMCP3208Driver(a Connector, options ...func(Config)) *MCP3208Driver
NewMCP3208Driver creates a new Gobot Driver for MCP3208Driver A/D converter
Params:
a *Adaptor - the Adaptor to use with this Driver
Optional params:
spi.WithBus(int): bus to use with this driver spi.WithChip(int): chip to use with this driver spi.WithMode(int): mode to use with this driver spi.WithBits(int): number of bits to use with this driver spi.WithSpeed(int64): speed in Hz to use with this driver
func (d *MCP3208Driver) AnalogRead(pin string) (value int, err error)
AnalogRead returns value from analog reading of specified pin, scaled to 0-1023 value.
func (d *MCP3208Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (d *MCP3208Driver) Halt() (err error)
Halt stops the driver.
func (d *MCP3208Driver) Name() string
Name returns the name of the device.
func (d *MCP3208Driver) Read(channel int) (result int, err error)
Read reads the current analog data for the desired channel.
func (d *MCP3208Driver) SetName(n string)
SetName sets the name of the device.
func (d *MCP3208Driver) Start() (err error)
Start initializes the driver.
MCP3304Driver is a driver for the MCP3304 A/D converter.
func NewMCP3304Driver(a Connector, options ...func(Config)) *MCP3304Driver
NewMCP3304Driver creates a new Gobot Driver for MCP3304Driver A/D converter
Params:
a *Adaptor - the Adaptor to use with this Driver
Optional params:
spi.WithBus(int): bus to use with this driver spi.WithChip(int): chip to use with this driver spi.WithMode(int): mode to use with this driver spi.WithBits(int): number of bits to use with this driver spi.WithSpeed(int64): speed in Hz to use with this driver
func (d *MCP3304Driver) AnalogRead(pin string) (value int, err error)
AnalogRead returns value from analog reading of specified pin, scaled to 0-1023 value.
func (d *MCP3304Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (d *MCP3304Driver) Halt() (err error)
Halt stops the driver.
func (d *MCP3304Driver) Name() string
Name returns the name of the device.
func (d *MCP3304Driver) Read(channel int) (result int, err error)
Read reads the current analog data for the desired channel.
func (d *MCP3304Driver) SetName(n string)
SetName sets the name of the device.
func (d *MCP3304Driver) Start() (err error)
Start initializes the driver.
Operations are the wrappers around the actual functions used by the SPI device interface
type SSD1306Driver struct {
DisplayWidth int
DisplayHeight int
DCPin string
RSTPin string
ExternalVcc bool
Config
gobot.Commander
// contains filtered or unexported fields
}SSD1306Driver is a Gobot Driver for a SSD1306 Display
func NewSSD1306Driver(a gobot.Adaptor, options ...func(Config)) *SSD1306Driver
NewSSD1306Driver creates a new SSD1306Driver.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
spi.WithBus(int): bus to use with this driver spi.WithChip(int): chip to use with this driver spi.WithMode(int): mode to use with this driver spi.WithBits(int): number of bits to use with this driver spi.WithSpeed(int64): speed in Hz to use with this driver spi.WithDisplayWidth(int): width of display (defaults to 128) spi.WithDisplayHeight(int): height of display (defaults to 64) spi.WithDCPin(string): gpio pin number connected to dc pin on display (defaults to "16") spi.WithRstPin(string): gpio pin number connected to rst pin on display (defaults to "18") spi.WithExternalVCC(bool): set to true if using external vcc (defaults to false)
func (s *SSD1306Driver) Clear() (err error)
Clear clears the display buffer.
func (s *SSD1306Driver) Connection() gobot.Connection
Connection returns the connection for the Driver
func (s *SSD1306Driver) Display() (err error)
Display sends the memory buffer to the display.
func (s *SSD1306Driver) Halt() (err error)
Halt returns true if device is halted successfully.
func (s *SSD1306Driver) Name() string
Name returns the Name for the Driver
func (s *SSD1306Driver) Off() (err error)
Off turns off the display.
func (s *SSD1306Driver) On() (err error)
On turns on the display.
func (s *SSD1306Driver) Reset() (err error)
Reset re-initializes the device to a clean state.
func (s *SSD1306Driver) Set(x, y, c int)
Set sets a pixel in the display buffer.
func (s *SSD1306Driver) SetBufferAndDisplay(buf []byte) (err error)
SetBufferAndDisplay sets the display buffer with the given buffer and displays the image.
func (s *SSD1306Driver) SetContrast(contrast byte) (err error)
SetContrast sets the display contrast (0-255).
func (s *SSD1306Driver) SetName(n string)
SetName sets the Name for the Driver
func (s *SSD1306Driver) ShowImage(img image.Image) (err error)
ShowImage takes a standard Go image and shows it on the display in monochrome.
func (s *SSD1306Driver) Start() (err error)
Start sets up the needed connection, and initialized the device.
type SpiConnection struct {
Operations
// contains filtered or unexported fields
}SpiConnection is the implementation of the SPI interface using the periph.io sysfs implementation for Linux.
func NewConnection(port xspi.PortCloser, conn xspi.Conn) (connection *SpiConnection)
NewConnection creates and returns a new connection to a specific spi device on a bus/chip using the periph.io interface.
func (c *SpiConnection) Close() error
Close the SPI connection.
func (c *SpiConnection) Tx(w, r []byte) error
Tx uses the SPI device to send/receive data.
Package spi imports 12 packages (graph) and is imported by 6 packages. Updated 2019-10-16. Refresh now. Tools for package owners.