gpio

package
v0.13.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 10, 2016 License: Apache-2.0, Apache-2.0 Imports: 5 Imported by: 0

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 -d -u github.com/hybridgroup/gobot/... && go install github.com/hybridgroup/gobot/platforms/gpio

Hardware Support

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

  • Analog Sensor
  • Button
  • Buzzer
  • Direct Pin
  • Grove Touch Sensor
  • Grove Sound Sensor
  • Grove Button
  • Grove Buzzer
  • Grove Light Sensor
  • Grove Piezo Vibration Sensor
  • Grove LED
  • Grove Rotary Dial
  • Grove Relay
  • Grove Temperature Sensor
  • LED
  • Makey Button
  • Motor
  • Relay
  • RGB LED
  • Servo

More drivers are coming soon...

Documentation

Overview

Package gpio provides Gobot drivers for General Purpose Input/Output devices.

Installing: 

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

For further information refer to gpio README: https://github.com/hybridgroup/gobot/blob/master/platforms/gpio/README.md

Index

Constants

View Source 
const (
	Whole   = 4
	Half    = 2
	Quarter = 1
	Eighth  = 0.500
)
View Source 
const (
	Rest = 0
	C0   = 16.35
	Db0  = 17.32
	D0   = 18.35
	Eb0  = 19.45
	E0   = 20.60
	F0   = 21.83
	Gb0  = 23.12
	G0   = 24.50
	Ab0  = 25.96
	A0   = 27.50
	Bb0  = 29.14
	B0   = 30.87
	C1   = 32.70
	Db1  = 34.65
	D1   = 36.71
	Eb1  = 38.89
	E1   = 41.20
	F1   = 43.65
	Gb1  = 46.25
	G1   = 49.00
	Ab1  = 51.91
	A1   = 55.00
	Bb1  = 58.27
	B1   = 61.74
	C2   = 65.41
	Db2  = 69.30
	D2   = 73.42
	Eb2  = 77.78
	E2   = 82.41
	F2   = 87.31
	Gb2  = 92.50
	G2   = 98.00
	Ab2  = 103.83
	A2   = 110.00
	Bb2  = 116.54
	B2   = 123.47
	C3   = 130.81
	Db3  = 138.59
	D3   = 146.83
	Eb3  = 155.56
	E3   = 164.81
	F3   = 174.61
	Gb3  = 185.00
	G3   = 196.00
	Ab3  = 207.65
	A3   = 220.00
	Bb3  = 233.08
	B3   = 246.94
	C4   = 261.63
	Db4  = 277.18
	D4   = 293.66
	Eb4  = 311.13
	E4   = 329.63
	F4   = 349.23
	Gb4  = 369.99
	G4   = 392.00
	Ab4  = 415.30
	A4   = 440.00
	Bb4  = 466.16
	B4   = 493.88
	C5   = 523.25
	Db5  = 554.37
	D5   = 587.33
	Eb5  = 622.25
	E5   = 659.25
	F5   = 698.46
	Gb5  = 739.99
	G5   = 783.99
	Ab5  = 830.61
	A5   = 880.00
	Bb5  = 932.33
	B5   = 987.77
	C6   = 1046.50
	Db6  = 1108.73
	D6   = 1174.66
	Eb6  = 1244.51
	E6   = 1318.51
	F6   = 1396.91
	Gb6  = 1479.98
	G6   = 1567.98
	Ab6  = 1661.22
	A6   = 1760.00
	Bb6  = 1864.66
	B6   = 1975.53
	C7   = 2093.00
	Db7  = 2217.46
	D7   = 2349.32
	Eb7  = 2489.02
	E7   = 2637.02
	F7   = 2793.83
	Gb7  = 2959.96
	G7   = 3135.96
	Ab7  = 3322.44
	A7   = 3520.00
	Bb7  = 3729.31
	B7   = 3951.07
	C8   = 4186.01
	Db8  = 4434.92
	D8   = 4698.63
	Eb8  = 4978.03
	E8   = 5274.04
	F8   = 5587.65
	Gb8  = 5919.91
	G8   = 6271.93
	Ab8  = 6644.88
	A8   = 7040.00
	Bb8  = 7458.62
	B8   = 7902.13
)
View Source 
const (
	// Error event
	Error = "error"
	// Release event
	ButtonRelease = "release"
	// Push event
	ButtonPush = "push"
	// Data event
	Data = "data"
	// Vibration event
	Vibration = "vibration"
)

Variables

View Source 
var (
	// ErrServoWriteUnsupported is the error resulting when a driver attempts to use
	// hardware capabilities which a connection does not support
	ErrServoWriteUnsupported = errors.New("ServoWrite is not supported by this platform")
	// ErrPwmWriteUnsupported is the error resulting when a driver attempts to use
	// hardware capabilities which a connection does not support
	ErrPwmWriteUnsupported = errors.New("PwmWrite is not supported by this platform")
	// ErrAnalogReadUnsupported is error resulting when a driver attempts to use
	// hardware capabilities which a connection does not support
	ErrAnalogReadUnsupported = errors.New("AnalogRead is not supported by this platform")
	// ErrDigitalWriteUnsupported is the error resulting when a driver attempts to use
	// hardware capabilities which a connection does not support
	ErrDigitalWriteUnsupported = errors.New("DigitalWrite is not supported by this platform")
	// ErrDigitalReadUnsupported is the error resulting when a driver attempts to use
	// hardware capabilities which a connection does not support
	ErrDigitalReadUnsupported = errors.New("DigitalRead is not supported by this platform")
	// ErrServoOutOfRange is the error resulting when a driver attempts to use
	// hardware capabilities which a connection does not support
	ErrServoOutOfRange = errors.New("servo angle must be between 0-180")
)

Functions

This section is empty.

Types

type AnalogReader 

type AnalogReader interface {
	gobot.Adaptor
	AnalogRead(string) (val int, err error)
}

AnalogReader interface represents an Adaptor which has Analog capabilities

type AnalogSensorDriver 

type AnalogSensorDriver struct {
	gobot.Eventer
	gobot.Commander
	// contains filtered or unexported fields
}

AnalogSensorDriver represents an Analog Sensor

func NewAnalogSensorDriver 

func NewAnalogSensorDriver(a AnalogReader, name string, pin string, v ...time.Duration) *AnalogSensorDriver

NewAnalogSensorDriver returns a new AnalogSensorDriver with a polling interval of 10 Milliseconds given an AnalogReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the AnalogSensor is polled for new information

Adds the following API Commands: 

"Read" - See AnalogSensor.Read

func (*AnalogSensorDriver) Connection 

func (a *AnalogSensorDriver) Connection() gobot.Connection

Connection returns the AnalogSensorDrivers Connection

func (*AnalogSensorDriver) Halt 

func (a *AnalogSensorDriver) Halt() (errs []error)

Halt stops polling the analog sensor for new information

func (*AnalogSensorDriver) Name 

func (a *AnalogSensorDriver) Name() string

Name returns the AnalogSensorDrivers name

func (*AnalogSensorDriver) Pin 

func (a *AnalogSensorDriver) Pin() string

Pin returns the AnalogSensorDrivers pin

func (*AnalogSensorDriver) Read 

func (a *AnalogSensorDriver) Read() (val int, err error)

Read returns the current reading from the Analog Sensor

func (*AnalogSensorDriver) Start 

func (a *AnalogSensorDriver) Start() (errs []error)

Start starts the AnalogSensorDriver and reads the Analog Sensor at the given interval. Emits the Events: 

Data int - Event is emitted on change and represents the current reading from the sensor.
Error error - Event is emitted on error reading from the sensor.

type ButtonDriver 

type ButtonDriver struct {
	Active bool

	gobot.Eventer
	// contains filtered or unexported fields
}

ButtonDriver Represents a digital Button

func NewButtonDriver 

func NewButtonDriver(a DigitalReader, name string, pin string, v ...time.Duration) *ButtonDriver

NewButtonDriver returns a new ButtonDriver with a polling interval of 10 Milliseconds given a DigitalReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the ButtonDriver is polled for new information

func (*ButtonDriver) Connection 

func (b *ButtonDriver) Connection() gobot.Connection

Connection returns the ButtonDrivers Connection

func (*ButtonDriver) Halt 

func (b *ButtonDriver) Halt() (errs []error)

Halt stops polling the button for new information

func (*ButtonDriver) Name 

func (b *ButtonDriver) Name() string

Name returns the ButtonDrivers name

func (*ButtonDriver) Pin 

func (b *ButtonDriver) Pin() string

Pin returns the ButtonDrivers pin

func (*ButtonDriver) Start 

func (b *ButtonDriver) Start() (errs []error)

Start starts the ButtonDriver and polls the state of the button at the given interval.

Emits the Events: 

Push int - On button push
Release int - On button release
Error error - On button error

type BuzzerDriver 

type BuzzerDriver struct {
	BPM float64
	// contains filtered or unexported fields
}

BuzzerDriver represents a digital buzzer

func NewBuzzerDriver 

func NewBuzzerDriver(a DigitalWriter, name string, pin string) *BuzzerDriver

NewBuzzerDriver return a new BuzzerDriver given a DigitalWriter, name and pin.

func (*BuzzerDriver) Connection 

func (l *BuzzerDriver) Connection() gobot.Connection

Connection returns the BuzzerDrivers Connection

func (*BuzzerDriver) Halt 

func (l *BuzzerDriver) Halt() (errs []error)

Halt implements the Driver interface

func (*BuzzerDriver) Name 

func (l *BuzzerDriver) Name() string

Name returns the BuzzerDrivers name

func (*BuzzerDriver) Off 

func (l *BuzzerDriver) Off() (err error)

Off sets the buzzer to a low state.

func (*BuzzerDriver) On 

func (l *BuzzerDriver) On() (err error)

On sets the buzzer to a high state.

func (*BuzzerDriver) Pin 

func (l *BuzzerDriver) Pin() string

Pin returns the BuzzerDrivers name

func (*BuzzerDriver) Start 

func (l *BuzzerDriver) Start() (errs []error)

Start implements the Driver interface

func (*BuzzerDriver) State 

func (l *BuzzerDriver) State() bool

State return true if the buzzer is On and false if the led is Off

func (*BuzzerDriver) Toggle 

func (l *BuzzerDriver) Toggle() (err error)

Toggle sets the buzzer to the opposite of it's current state

func (*BuzzerDriver) Tone 

func (l *BuzzerDriver) Tone(hz, duration float64) (err error)

type DigitalReader 

type DigitalReader interface {
	gobot.Adaptor
	DigitalRead(string) (val int, err error)
}

DigitalReader interface represents an Adaptor which has DigitalRead capabilities

type DigitalWriter 

type DigitalWriter interface {
	gobot.Adaptor
	DigitalWrite(string, byte) (err error)
}

DigitalWriter interface represents an Adaptor which has DigitalWrite capabilities

type DirectPinDriver 

type DirectPinDriver struct {
	gobot.Commander
	// contains filtered or unexported fields
}

DirectPinDriver represents a GPIO pin

func NewDirectPinDriver 

func NewDirectPinDriver(a gobot.Connection, name string, pin string) *DirectPinDriver

NewDirectPinDriver return a new DirectPinDriver given a Connection, name and pin.

Adds the following API Commands: 

"DigitalRead" - See DirectPinDriver.DigitalRead
"DigitalWrite" - See DirectPinDriver.DigitalWrite
"AnalogRead" - See DirectPinDriver.AnalogRead
"AnalogWrite" - See DirectPinDriver.AnalogWrite
"PwmWrite" - See DirectPinDriver.PwmWrite
"ServoWrite" - See DirectPinDriver.ServoWrite

func (*DirectPinDriver) AnalogRead 

func (d *DirectPinDriver) AnalogRead() (val int, err error)

AnalogRead reads the current analog reading of the pin

func (*DirectPinDriver) Connection 

func (d *DirectPinDriver) Connection() gobot.Connection

Connection returns the DirectPinDrivers Connection

func (*DirectPinDriver) DigitalRead 

func (d *DirectPinDriver) DigitalRead() (val int, err error)

DigitalRead returns the current digital state of the pin

func (*DirectPinDriver) DigitalWrite 

func (d *DirectPinDriver) DigitalWrite(level byte) (err error)

DigitalWrite writes to the pin. Acceptable values are 1 or 0

func (*DirectPinDriver) Halt 

func (d *DirectPinDriver) Halt() (errs []error)

Halt implements the Driver interface

func (*DirectPinDriver) Name 

func (d *DirectPinDriver) Name() string

Name returns the DirectPinDrivers name

func (*DirectPinDriver) Off added in v0.12.1 

func (d *DirectPinDriver) Off() (err error)

Turn Off pin

func (*DirectPinDriver) On added in v0.12.1 

func (d *DirectPinDriver) On() (err error)

Turn On pin

func (*DirectPinDriver) Pin 

func (d *DirectPinDriver) Pin() string

Pin returns the DirectPinDrivers pin

func (*DirectPinDriver) PwmWrite 

func (d *DirectPinDriver) PwmWrite(level byte) (err error)

PwmWrite writes the 0-254 value to the specified pin

func (*DirectPinDriver) ServoWrite 

func (d *DirectPinDriver) ServoWrite(level byte) (err error)

ServoWrite writes value to the specified pin

func (*DirectPinDriver) Start 

func (d *DirectPinDriver) Start() (errs []error)

Start implements the Driver interface

type GroveButtonDriver 

type GroveButtonDriver struct {
	*ButtonDriver
}

GroveButtonDriver represents a button sensor with a Grove connector

func NewGroveButtonDriver 

func NewGroveButtonDriver(a DigitalReader, name string, pin string, v ...time.Duration) *GroveButtonDriver

NewGroveButtonDriver returns a new GroveButtonDriver with a polling interval of 10 Milliseconds given a DigitalReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the ButtonDriver is polled for new information

type GroveBuzzerDriver 

type GroveBuzzerDriver struct {
	*BuzzerDriver
}

GroveBuzzerDriver represents a buzzer with a Grove connector

func NewGroveBuzzerDriver 

func NewGroveBuzzerDriver(a DigitalWriter, name string, pin string) *GroveBuzzerDriver

NewGroveBuzzerDriver return a new GroveBuzzerDriver given a DigitalWriter, name and pin.

type GroveLedDriver 

type GroveLedDriver struct {
	*LedDriver
}

GroveLedDriver represents an LED with a Grove connector

func NewGroveLedDriver 

func NewGroveLedDriver(a DigitalWriter, name string, pin string) *GroveLedDriver

NewGroveLedDriver return a new GroveLedDriver given a DigitalWriter, name and pin.

Adds the following API Commands: 

"Brightness" - See LedDriver.Brightness
"Toggle" - See LedDriver.Toggle
"On" - See LedDriver.On
"Off" - See LedDriver.Off

type GroveLightSensorDriver 

type GroveLightSensorDriver struct {
	*AnalogSensorDriver
}

GroveLightSensorDriver represents an analog light sensor with a Grove connector

func NewGroveLightSensorDriver 

func NewGroveLightSensorDriver(a AnalogReader, name string, pin string, v ...time.Duration) *GroveLightSensorDriver

NewGroveLightSensorDriver returns a new GroveLightSensorDriver with a polling interval of 10 Milliseconds given an AnalogReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the AnalogSensor is polled for new information

Adds the following API Commands: 

"Read" - See AnalogSensor.Read

type GrovePiezoVibrationSensorDriver 

type GrovePiezoVibrationSensorDriver struct {
	*AnalogSensorDriver
}

GrovePiezoVibrationSensorDriver represents an analog vibration sensor with a Grove connector

func NewGrovePiezoVibrationSensorDriver 

func NewGrovePiezoVibrationSensorDriver(a AnalogReader, name string, pin string, v ...time.Duration) *GrovePiezoVibrationSensorDriver

NewGrovePiezoVibrationSensorDriver returns a new GrovePiezoVibrationSensorDriver with a polling interval of 10 Milliseconds given an AnalogReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the AnalogSensor is polled for new information

Adds the following API Commands: 

"Read" - See AnalogSensor.Read

type GroveRelayDriver 

type GroveRelayDriver struct {
	*RelayDriver
}

GroveRelayDriver represents a Relay with a Grove connector

func NewGroveRelayDriver 

func NewGroveRelayDriver(a DigitalWriter, name string, pin string) *GroveRelayDriver

NewGroveRelayDriver return a new GroveRelayDriver given a DigitalWriter, name and pin.

Adds the following API Commands: 

"Toggle" - See RelayDriver.Toggle
"On" - See RelayDriver.On
"Off" - See RelayDriver.Off

type GroveRotaryDriver 

type GroveRotaryDriver struct {
	*AnalogSensorDriver
}

GroveRotaryDriver represents an analog rotary dial with a Grove connector

func NewGroveRotaryDriver 

func NewGroveRotaryDriver(a AnalogReader, name string, pin string, v ...time.Duration) *GroveRotaryDriver

NewGroveRotaryDriver returns a new GroveRotaryDriver with a polling interval of 10 Milliseconds given an AnalogReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the AnalogSensor is polled for new information

Adds the following API Commands: 

"Read" - See AnalogSensor.Read

type GroveSoundSensorDriver 

type GroveSoundSensorDriver struct {
	*AnalogSensorDriver
}

GroveSoundSensorDriver represents a analog sound sensor with a Grove connector

func NewGroveSoundSensorDriver 

func NewGroveSoundSensorDriver(a AnalogReader, name string, pin string, v ...time.Duration) *GroveSoundSensorDriver

NewGroveSoundSensorDriver returns a new GroveSoundSensorDriver with a polling interval of 10 Milliseconds given an AnalogReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the AnalogSensor is polled for new information

Adds the following API Commands: 

"Read" - See AnalogSensor.Read

type GroveTemperatureSensorDriver 

type GroveTemperatureSensorDriver struct {
	gobot.Eventer
	// contains filtered or unexported fields
}

GroveTemperatureSensorDriver represents a Temperature Sensor

func NewGroveTemperatureSensorDriver 

func NewGroveTemperatureSensorDriver(a AnalogReader, name string, pin string, v ...time.Duration) *GroveTemperatureSensorDriver

NewGroveTemperatureSensorDriver returns a new GroveTemperatureSensorDriver with a polling interval of 10 Milliseconds given an AnalogReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the TemperatureSensor is polled for new information

Adds the following API Commands: 

"Read" - See AnalogSensor.Read

func (*GroveTemperatureSensorDriver) Connection 

func (a *GroveTemperatureSensorDriver) Connection() gobot.Connection

Connection returns the GroveTemperatureSensorDrivers Connection

func (*GroveTemperatureSensorDriver) Halt 

func (a *GroveTemperatureSensorDriver) Halt() (errs []error)

Halt stops polling the analog sensor for new information

func (*GroveTemperatureSensorDriver) Name 

func (a *GroveTemperatureSensorDriver) Name() string

Name returns the GroveTemperatureSensorDrivers name

func (*GroveTemperatureSensorDriver) Pin 

func (a *GroveTemperatureSensorDriver) Pin() string

Pin returns the GroveTemperatureSensorDrivers pin

func (*GroveTemperatureSensorDriver) Read 

func (a *GroveTemperatureSensorDriver) Read() (val int, err error)

Read returns the raw reading from the Sensor

func (*GroveTemperatureSensorDriver) Start 

func (a *GroveTemperatureSensorDriver) Start() (errs []error)

Start starts the GroveTemperatureSensorDriver and reads the Sensor at the given interval. Emits the Events: 

Data int - Event is emitted on change and represents the current temperature in celsius from the sensor.
Error error - Event is emitted on error reading from the sensor.

func (*GroveTemperatureSensorDriver) Temperature 

func (a *GroveTemperatureSensorDriver) Temperature() (val float64)

Read returns the current Temperature from the Sensor

type GroveTouchDriver 

type GroveTouchDriver struct {
	*ButtonDriver
}

GroveTouchDriver represents a touch button sensor with a Grove connector

func NewGroveTouchDriver 

func NewGroveTouchDriver(a DigitalReader, name string, pin string, v ...time.Duration) *GroveTouchDriver

NewGroveTouchDriver returns a new GroveTouchDriver with a polling interval of 10 Milliseconds given a DigitalReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the ButtonDriver is polled for new information

type LedDriver 

type LedDriver struct {
	gobot.Commander
	// contains filtered or unexported fields
}

LedDriver represents a digital Led

func NewLedDriver 

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

NewLedDriver return a new LedDriver given a DigitalWriter, name and pin.

Adds the following API Commands: 

"Brightness" - See LedDriver.Brightness
"Toggle" - See LedDriver.Toggle
"On" - See LedDriver.On
"Off" - See LedDriver.Off

func (*LedDriver) Brightness 

func (l *LedDriver) Brightness(level byte) (err error)

Brightness sets the led to the specified level of brightness

func (*LedDriver) Connection 

func (l *LedDriver) Connection() gobot.Connection

Connection returns the LedDrivers Connection

func (*LedDriver) Halt 

func (l *LedDriver) Halt() (errs []error)

Halt implements the Driver interface

func (*LedDriver) Name 

func (l *LedDriver) Name() string

Name returns the LedDrivers name

func (*LedDriver) Off 

func (l *LedDriver) Off() (err error)

Off sets the led to a low state.

func (*LedDriver) On 

func (l *LedDriver) On() (err error)

On sets the led to a high state.

func (*LedDriver) Pin 

func (l *LedDriver) Pin() string

Pin returns the LedDrivers name

func (*LedDriver) Start 

func (l *LedDriver) Start() (errs []error)

Start implements the Driver interface

func (*LedDriver) State 

func (l *LedDriver) State() bool

State return true if the led is On and false if the led is Off

func (*LedDriver) Toggle 

func (l *LedDriver) Toggle() (err error)

Toggle sets the led to the opposite of it's current state

type MakeyButtonDriver 

type MakeyButtonDriver struct {
	Active bool

	gobot.Eventer
	// contains filtered or unexported fields
}

MakeyButtonDriver Represents a Makey Button

func NewMakeyButtonDriver 

func NewMakeyButtonDriver(a DigitalReader, name string, pin string, v ...time.Duration) *MakeyButtonDriver

NewMakeyButtonDriver returns a new MakeyButtonDriver with a polling interval of 10 Milliseconds given a DigitalReader, name and pin.

Optionally accepts: 

time.Duration: Interval at which the ButtonDriver is polled for new information

func (*MakeyButtonDriver) Connection 

func (b *MakeyButtonDriver) Connection() gobot.Connection

Connection returns the MakeyButtonDrivers Connection

func (*MakeyButtonDriver) Halt 

func (b *MakeyButtonDriver) Halt() (errs []error)

Halt stops polling the makey button for new information

func (*MakeyButtonDriver) Name 

func (b *MakeyButtonDriver) Name() string

Name returns the MakeyButtonDrivers name

func (*MakeyButtonDriver) Pin 

func (b *MakeyButtonDriver) Pin() string

Pin returns the MakeyButtonDrivers pin

func (*MakeyButtonDriver) Start 

func (b *MakeyButtonDriver) Start() (errs []error)

Start starts the MakeyButtonDriver and polls the state of the button at the given interval.

Emits the Events: 

Push int - On button push
Release int - On button release
Error error - On button error

type MotorDriver 

type MotorDriver struct {
	SpeedPin         string
	SwitchPin        string
	DirectionPin     string
	ForwardPin       string
	BackwardPin      string
	CurrentState     byte
	CurrentSpeed     byte
	CurrentMode      string
	CurrentDirection string
	// contains filtered or unexported fields
}

MotorDriver Represents a Motor

func NewMotorDriver 

func NewMotorDriver(a DigitalWriter, name string, speedPin string) *MotorDriver

NewMotorDriver return a new MotorDriver given a DigitalWriter, name and pin

func (*MotorDriver) Backward 

func (m *MotorDriver) Backward(speed byte) (err error)

Backward sets the backward pin to the specified speed

func (*MotorDriver) Connection 

func (m *MotorDriver) Connection() gobot.Connection

Connection returns the MotorDrivers Connection

func (*MotorDriver) Direction 

func (m *MotorDriver) Direction(direction string) (err error)

Direction sets the direction pin to the specified speed

func (*MotorDriver) Forward 

func (m *MotorDriver) Forward(speed byte) (err error)

Forward sets the forward pin to the specified speed

func (*MotorDriver) Halt 

func (m *MotorDriver) Halt() (errs []error)

Halt implements the Driver interface

func (*MotorDriver) IsOff 

func (m *MotorDriver) IsOff() bool

IsOff returns true if the motor is off

func (*MotorDriver) IsOn 

func (m *MotorDriver) IsOn() bool

IsOn returns true if the motor is on

func (*MotorDriver) Max 

func (m *MotorDriver) Max() (err error)

Max sets the motor to the maximum speed

func (*MotorDriver) Min 

func (m *MotorDriver) Min() (err error)

Min sets the motor to the minimum speed

func (*MotorDriver) Name 

func (m *MotorDriver) Name() string

Name returns the MotorDrivers name

func (*MotorDriver) Off 

func (m *MotorDriver) Off() (err error)

Off turns the motor off or sets the motor to a 0 speed

func (*MotorDriver) On 

func (m *MotorDriver) On() (err error)

On turns the motor on or sets the motor to a maximum speed

func (*MotorDriver) Speed 

func (m *MotorDriver) Speed(value byte) (err error)

Speed sets the speed of the motor

func (*MotorDriver) Start 

func (m *MotorDriver) Start() (errs []error)

Start implements the Driver interface

func (*MotorDriver) Toggle 

func (m *MotorDriver) Toggle() (err error)

Toggle sets the motor to the opposite of it's current state

type PwmWriter 

type PwmWriter interface {
	gobot.Adaptor
	PwmWrite(string, byte) (err error)
}

PwmWriter interface represents an Adaptor which has Pwm capabilities

type RelayDriver 

type RelayDriver struct {
	gobot.Commander
	// contains filtered or unexported fields
}

RelayDriver represents a digital relay

func NewRelayDriver 

func NewRelayDriver(a DigitalWriter, name string, pin string) *RelayDriver

NewRelayDriver return a new RelayDriver given a DigitalWriter, name and pin.

Adds the following API Commands: 

"Toggle" - See RelayDriver.Toggle
"On" - See RelayDriver.On
"Off" - See RelayDriver.Off

func (*RelayDriver) Connection 

func (l *RelayDriver) Connection() gobot.Connection

Connection returns the RelayDrivers Connection

func (*RelayDriver) Halt 

func (l *RelayDriver) Halt() (errs []error)

Halt implements the Driver interface

func (*RelayDriver) Name 

func (l *RelayDriver) Name() string

Name returns the RelayDrivers name

func (*RelayDriver) Off 

func (l *RelayDriver) Off() (err error)

Off sets the relay to a low state.

func (*RelayDriver) On 

func (l *RelayDriver) On() (err error)

On sets the relay to a high state.

func (*RelayDriver) Pin 

func (l *RelayDriver) Pin() string

Pin returns the RelayDrivers name

func (*RelayDriver) Start 

func (l *RelayDriver) Start() (errs []error)

Start implements the Driver interface

func (*RelayDriver) State 

func (l *RelayDriver) State() bool

State return true if the relay is On and false if the relay is Off

func (*RelayDriver) Toggle 

func (l *RelayDriver) Toggle() (err error)

Toggle sets the relay to the opposite of it's current state

type RgbLedDriver added in v0.12.1 

type RgbLedDriver struct {
	gobot.Commander
	// contains filtered or unexported fields
}

RgbLedDriver represents a digital RGB Led

func NewRgbLedDriver added in v0.12.1 

func NewRgbLedDriver(a DigitalWriter, name string, redPin string, greenPin string, bluePin string) *RgbLedDriver

NewRgbLedDriver return a new RgbLedDriver given a DigitalWriter, name and 3 pins: redPin, greenPin, and bluePin

Adds the following API Commands: 

"SetRGB" - See RgbLedDriver.SetRGB
"Toggle" - See RgbLedDriver.Toggle
"On" - See RgbLedDriver.On
"Off" - See RgbLedDriver.Off

func (*RgbLedDriver) BluePin added in v0.12.1 

func (l *RgbLedDriver) BluePin() string

BluePin returns the RgbLedDrivers bluePin

func (*RgbLedDriver) Connection added in v0.12.1 

func (l *RgbLedDriver) Connection() gobot.Connection

Connection returns the RgbLedDriver Connection

func (*RgbLedDriver) GreenPin added in v0.12.1 

func (l *RgbLedDriver) GreenPin() string

GreenPin returns the RgbLedDrivers redPin

func (*RgbLedDriver) Halt added in v0.12.1 

func (l *RgbLedDriver) Halt() (errs []error)

Halt implements the Driver interface

func (*RgbLedDriver) Name added in v0.12.1 

func (l *RgbLedDriver) Name() string

Name returns the LedDrivers name

func (*RgbLedDriver) Off added in v0.12.1 

func (l *RgbLedDriver) Off() (err error)

Off sets the led to black.

func (*RgbLedDriver) On added in v0.12.1 

func (l *RgbLedDriver) On() (err error)

On sets the led's pins to their various states

func (*RgbLedDriver) Pin added in v0.12.1 

func (l *RgbLedDriver) Pin() string

Pin returns the RgbLedDrivers pins

func (*RgbLedDriver) RedPin added in v0.12.1 

func (l *RgbLedDriver) RedPin() string

RedPin returns the RgbLedDrivers redPin

func (*RgbLedDriver) SetLevel added in v0.12.1 

func (l *RgbLedDriver) SetLevel(pin string, level byte) (err error)

SetLevel sets the led to the specified color level

func (*RgbLedDriver) SetRGB added in v0.12.1 

func (l *RgbLedDriver) SetRGB(r, g, b byte) error

SetRGB sets the Red Green Blue value of the LED.

func (*RgbLedDriver) Start added in v0.12.1 

func (l *RgbLedDriver) Start() (errs []error)

Start implements the Driver interface

func (*RgbLedDriver) State added in v0.12.1 

func (l *RgbLedDriver) State() bool

State return true if the led is On and false if the led is Off

func (*RgbLedDriver) Toggle added in v0.12.1 

func (l *RgbLedDriver) Toggle() (err error)

Toggle sets the led to the opposite of it's current state

type ServoDriver 

type ServoDriver struct {
	gobot.Commander
	CurrentAngle byte
	// contains filtered or unexported fields
}

ServoDriver Represents a Servo

func NewServoDriver 

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

NewServoDriver returns a new ServoDriver given a ServoWriter, name and pin.

Adds the following API Commands: 

"Move" - See ServoDriver.Move
"Min" - See ServoDriver.Min
"Center" - See ServoDriver.Center
"Max" - See ServoDriver.Max

func (*ServoDriver) Center 

func (s *ServoDriver) Center() (err error)

Center sets the servo to it's center position

func (*ServoDriver) Connection 

func (s *ServoDriver) Connection() gobot.Connection

Connection returns the ServoDrivers connection

func (*ServoDriver) Halt 

func (s *ServoDriver) Halt() (errs []error)

Halt implements the Driver interface

func (*ServoDriver) Max 

func (s *ServoDriver) Max() (err error)

Max sets the servo to its maximum position

func (*ServoDriver) Min 

func (s *ServoDriver) Min() (err error)

Min sets the servo to it's minimum position

func (*ServoDriver) Move 

func (s *ServoDriver) Move(angle uint8) (err error)

Move sets the servo to the specified angle. Acceptable angles are 0-180

func (*ServoDriver) Name 

func (s *ServoDriver) Name() string

Name returns the ServoDrivers name

func (*ServoDriver) Pin 

func (s *ServoDriver) Pin() string

Pin returns the ServoDrivers pin

func (*ServoDriver) Start 

func (s *ServoDriver) Start() (errs []error)

Start implements the Driver interface

type ServoWriter 

type ServoWriter interface {
	gobot.Adaptor
	ServoWrite(string, byte) (err error)
}

ServoWriter interface represents an Adaptor which has Servo capabilities

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.