gpio

README

GPIO

This package provides drivers for General Purpose Input/Output (GPIO) devices . It is normally not used directly, but instead is registered by an adaptor such as firmata that supports the needed interfaces for GPIO devices.

Getting Started

Installing

go get github.com/hybridgroup/gobot && go install github.com/hybridgroup/platforms/gpio

Hardware Support

Gobot has a extensible system for connecting to hardware devices. The following GPIO devices are currently supported:

• Analog Sensor
• Button
• Direct Pin
• LED
• Makey Button
• Motor
• Servo

More drivers are coming soon...

Documentation

Index

• type AnalogReader
• type AnalogSensorDriver
  • func NewAnalogSensorDriver(a AnalogReader, name string, pin string) *AnalogSensorDriver
  • func (a *AnalogSensorDriver) Halt() bool
  • func (a *AnalogSensorDriver) Init() bool
  • func (a *AnalogSensorDriver) Read() int
  • func (a *AnalogSensorDriver) Start() bool
• type AnalogWriter
• type ButtonDriver
  • func NewButtonDriver(a DigitalReader, name string, pin string) *ButtonDriver
  • func (b *ButtonDriver) Halt() bool
  • func (b *ButtonDriver) Init() bool
  • func (b *ButtonDriver) Start() bool
• type DigitalReader
• type DigitalWriter
• type DirectPin
• type DirectPinDriver
  • func NewDirectPinDriver(a DirectPin, name string, pin string) *DirectPinDriver
  • func (d *DirectPinDriver) AnalogRead() int
  • func (d *DirectPinDriver) AnalogWrite(level byte)
  • func (d *DirectPinDriver) DigitalRead() int
  • func (d *DirectPinDriver) DigitalWrite(level byte)
  • func (d *DirectPinDriver) Halt() bool
  • func (d *DirectPinDriver) Init() bool
  • func (d *DirectPinDriver) PwmWrite(level byte)
  • func (d *DirectPinDriver) ServoWrite(level byte)
  • func (d *DirectPinDriver) Start() bool
• type LedDriver
  • func NewLedDriver(a PwmDigitalWriter, name string, pin string) *LedDriver
  • func (l *LedDriver) Brightness(level byte)
  • func (l *LedDriver) Halt() bool
  • func (l *LedDriver) Init() bool
  • func (l *LedDriver) IsOff() bool
  • func (l *LedDriver) IsOn() bool
  • func (l *LedDriver) Off() bool
  • func (l *LedDriver) On() bool
  • func (l *LedDriver) Start() bool
  • func (l *LedDriver) Toggle()
• type MakeyButtonDriver
  • func NewMakeyButtonDriver(a DigitalReader, name string, pin string) *MakeyButtonDriver
  • func (m *MakeyButtonDriver) Halt() bool
  • func (m *MakeyButtonDriver) Init() bool
  • func (m *MakeyButtonDriver) Start() bool
• type MotorDriver
  • func NewMotorDriver(a PwmDigitalWriter, name string, pin string) *MotorDriver
  • func (m *MotorDriver) Backward(speed byte)
  • func (m *MotorDriver) Direction(direction string)
  • func (m *MotorDriver) Forward(speed byte)
  • func (m *MotorDriver) Halt() bool
  • func (m *MotorDriver) Init() bool
  • func (m *MotorDriver) IsOff() bool
  • func (m *MotorDriver) IsOn() bool
  • func (m *MotorDriver) Max()
  • func (m *MotorDriver) Min()
  • func (m *MotorDriver) Off()
  • func (m *MotorDriver) On()
  • func (m *MotorDriver) Speed(value byte)
  • func (m *MotorDriver) Start() bool
  • func (m *MotorDriver) Toggle()
• type Pwm
• type PwmDigitalWriter
• type Servo
• type ServoDriver
  • func NewServoDriver(a Servo, name string, pin string) *ServoDriver
  • func (s *ServoDriver) Center()
  • func (s *ServoDriver) Halt() bool
  • func (s *ServoDriver) Init() bool
  • func (s *ServoDriver) InitServo()
  • func (s *ServoDriver) Max()
  • func (s *ServoDriver) Min()
  • func (s *ServoDriver) Move(angle uint8)
  • func (s *ServoDriver) Start() bool

Types

type AnalogReader

type AnalogReader interface {
	AnalogRead(string) int
}

type AnalogSensorDriver

type AnalogSensorDriver struct {
	gobot.Driver
}

func NewAnalogSensorDriver

func NewAnalogSensorDriver(a AnalogReader, name string, pin string) *AnalogSensorDriver

func (*AnalogSensorDriver) Halt

func (a *AnalogSensorDriver) Halt() bool

func (*AnalogSensorDriver) Init

func (a *AnalogSensorDriver) Init() bool

func (*AnalogSensorDriver) Read

func (a *AnalogSensorDriver) Read() int

func (*AnalogSensorDriver) Start

func (a *AnalogSensorDriver) Start() bool

type AnalogWriter

type AnalogWriter interface {
	AnalogWrite(string, byte)
}

type ButtonDriver

type ButtonDriver struct {
	gobot.Driver
	Active bool
}

func NewButtonDriver

func NewButtonDriver(a DigitalReader, name string, pin string) *ButtonDriver

func (*ButtonDriver) Halt

func (b *ButtonDriver) Halt() bool

func (*ButtonDriver) Init

func (b *ButtonDriver) Init() bool

func (*ButtonDriver) Start

func (b *ButtonDriver) Start() bool

type DigitalReader

type DigitalReader interface {
	DigitalRead(string) int
}

type DigitalWriter

type DigitalWriter interface {
	DigitalWrite(string, byte)
}

type DirectPin

type DirectPin interface {
	DigitalWriter
	DigitalReader
	Pwm
	Servo
	AnalogWriter
	AnalogReader
}

type DirectPinDriver

type DirectPinDriver struct {
	gobot.Driver
}

func NewDirectPinDriver

func NewDirectPinDriver(a DirectPin, name string, pin string) *DirectPinDriver

func (*DirectPinDriver) AnalogRead

func (d *DirectPinDriver) AnalogRead() int

func (*DirectPinDriver) AnalogWrite

func (d *DirectPinDriver) AnalogWrite(level byte)

func (*DirectPinDriver) DigitalRead

func (d *DirectPinDriver) DigitalRead() int

func (*DirectPinDriver) DigitalWrite

func (d *DirectPinDriver) DigitalWrite(level byte)

func (*DirectPinDriver) Halt

func (d *DirectPinDriver) Halt() bool

func (*DirectPinDriver) Init

func (d *DirectPinDriver) Init() bool

func (*DirectPinDriver) PwmWrite

func (d *DirectPinDriver) PwmWrite(level byte)

func (*DirectPinDriver) ServoWrite

func (d *DirectPinDriver) ServoWrite(level byte)

func (*DirectPinDriver) Start

func (d *DirectPinDriver) Start() bool

type LedDriver

type LedDriver struct {
	gobot.Driver
	High bool
}

func NewLedDriver

func NewLedDriver(a PwmDigitalWriter, name string, pin string) *LedDriver

func (*LedDriver) Brightness

func (l *LedDriver) Brightness(level byte)

func (*LedDriver) Halt

func (l *LedDriver) Halt() bool

func (*LedDriver) Init

func (l *LedDriver) Init() bool

func (*LedDriver) IsOff

func (l *LedDriver) IsOff() bool

func (*LedDriver) IsOn

func (l *LedDriver) IsOn() bool

func (*LedDriver) Off

func (l *LedDriver) Off() bool

func (*LedDriver) On

func (l *LedDriver) On() bool

func (*LedDriver) Start

func (l *LedDriver) Start() bool

func (*LedDriver) Toggle

func (l *LedDriver) Toggle()

type MakeyButtonDriver

type MakeyButtonDriver struct {
	gobot.Driver
	Adaptor DigitalReader
	Active  bool
	// contains filtered or unexported fields
}

func NewMakeyButtonDriver

func NewMakeyButtonDriver(a DigitalReader, name string, pin string) *MakeyButtonDriver

func (*MakeyButtonDriver) Halt

func (m *MakeyButtonDriver) Halt() bool

func (*MakeyButtonDriver) Init

func (m *MakeyButtonDriver) Init() bool

func (*MakeyButtonDriver) Start

func (m *MakeyButtonDriver) Start() bool

type MotorDriver

type MotorDriver struct {
	gobot.Driver
	SpeedPin         string
	SwitchPin        string
	DirectionPin     string
	ForwardPin       string
	BackwardPin      string
	CurrentState     byte
	CurrentSpeed     byte
	CurrentMode      string
	CurrentDirection string
}

func NewMotorDriver

func NewMotorDriver(a PwmDigitalWriter, name string, pin string) *MotorDriver

func (*MotorDriver) Backward

func (m *MotorDriver) Backward(speed byte)

func (*MotorDriver) Direction

func (m *MotorDriver) Direction(direction string)

func (*MotorDriver) Forward

func (m *MotorDriver) Forward(speed byte)

func (*MotorDriver) Halt

func (m *MotorDriver) Halt() bool

func (*MotorDriver) Init

func (m *MotorDriver) Init() bool

func (*MotorDriver) IsOff

func (m *MotorDriver) IsOff() bool

func (*MotorDriver) IsOn

func (m *MotorDriver) IsOn() bool

func (*MotorDriver) Max

func (m *MotorDriver) Max()

func (*MotorDriver) Min

func (m *MotorDriver) Min()

func (*MotorDriver) Off

func (m *MotorDriver) Off()

func (*MotorDriver) On

func (m *MotorDriver) On()

func (*MotorDriver) Speed

func (m *MotorDriver) Speed(value byte)

func (*MotorDriver) Start

func (m *MotorDriver) Start() bool

func (*MotorDriver) Toggle

func (m *MotorDriver) Toggle()

type Pwm

type Pwm interface {
	PwmWrite(string, byte)
}

type PwmDigitalWriter

type PwmDigitalWriter interface {
	DigitalWriter
	Pwm
}

type Servo

type Servo interface {
	InitServo()
	ServoWrite(string, byte)
}

type ServoDriver

type ServoDriver struct {
	gobot.Driver
	CurrentAngle byte
}

func NewServoDriver

func NewServoDriver(a Servo, name string, pin string) *ServoDriver

func (*ServoDriver) Center

func (s *ServoDriver) Center()

func (*ServoDriver) Halt

func (s *ServoDriver) Halt() bool

func (*ServoDriver) Init

func (s *ServoDriver) Init() bool

func (*ServoDriver) InitServo

func (s *ServoDriver) InitServo()

func (*ServoDriver) Max

func (s *ServoDriver) Max()

func (*ServoDriver) Min

func (s *ServoDriver) Min()

func (*ServoDriver) Move

func (s *ServoDriver) Move(angle uint8)

func (*ServoDriver) Start

func (s *ServoDriver) Start() bool