Categorygithub.com/rich1111/gobotdriversgpio

package

1.16.1

Repository: https://github.com/rich1111/gobot.git

Documentation: pkg.go.dev

# README

GPIO

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

Getting Started

Installing

go get -d -u github.com/rich1111/gobot/...

Hardware Support

Gobot has a extensible system for connecting to hardware devices. The following GPIO devices are currently supported: - Button - Buzzer - Direct Pin - Grove Button - Grove Buzzer - Grove LED - Grove Magnetic Switch - Grove Relay - Grove Touch Sensor - LED - Makey Button - Motor - Proximity Infra Red (PIR) Motion Sensor - Relay - RGB LED - Servo - Stepper Motor - TM1638 LED Controller

More drivers are coming soon...

# Functions

NewAIP1640Driver

NewAIP1640Driver return a new AIP1640Driver given a gobot.Connection and the clock, data and strobe pins.

NewButtonDriver

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

NewBuzzerDriver

NewBuzzerDriver return a new BuzzerDriver given a DigitalWriter and pin.

NewDirectPinDriver

NewDirectPinDriver return a new DirectPinDriver given a Connection and pin.

NewEasyDriver

NewEasyDriver returns a new EasyDriver from SparkFun (https://www.sparkfun.com/products/12779) TODO: Support selecting phase input instead of hard-wiring MS1 and MS2 to board truth table This should also work for the BigEasyDriver (untested) A - DigitalWriter stepPin - Pin corresponding to step input on EasyDriver dirPin - Pin corresponding to dir input on EasyDriver.

NewGroveButtonDriver

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

NewGroveBuzzerDriver

NewGroveBuzzerDriver return a new GroveBuzzerDriver given a DigitalWriter and pin.

NewGroveLedDriver

NewGroveLedDriver return a new GroveLedDriver given a DigitalWriter and pin.

NewGroveMagneticSwitchDriver

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

NewGroveRelayDriver

NewGroveRelayDriver return a new GroveRelayDriver given a DigitalWriter and pin.

NewGroveTouchDriver

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

NewHD44780Driver

NewHD44780Driver return a new HD44780Driver a: gobot.Conenction cols: lcd columns rows: lcd rows busMode: 4Bit or 8Bit pinRS: register select pin pinEN: clock enable pin pinDataBits: databit pins.

NewLedDriver

NewLedDriver return a new LedDriver given a DigitalWriter and pin.

NewMakeyButtonDriver

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

NewMAX7219Driver

NewMAX7219Driver return a new MAX7219Driver given a gobot.Connection, pins and how many chips are chained.

NewMotorDriver

NewMotorDriver return a new MotorDriver given a DigitalWriter and pin.

NewPIRMotionDriver

NewPIRMotionDriver returns a new PIRMotionDriver with a polling interval of 10 Milliseconds given a DigitalReader and pin.

NewRelayDriver

NewRelayDriver return a new RelayDriver given a DigitalWriter and pin.

NewRgbLedDriver

NewRgbLedDriver return a new RgbLedDriver given a DigitalWriter 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.

NewServoDriver

NewServoDriver returns a new ServoDriver given a ServoWriter and pin.

NewStepperDriver

NewStepperDriver returns a new StepperDriver given a DigitalWriter Pins - To which the stepper is connected Phase - Defined by StepperModes {SinglePhaseStepping, DualPhaseStepping, HalfStepping} Steps - No of steps per revolution of Stepper motor.

NewTM1638Driver

NewTM1638Driver return a new TM1638Driver given a gobot.Connection and the clock, data and strobe pins.

NewTM1638Fonts

NewTM1638Fonts returns a map with fonts and their corresponding byte for proper representation on the 7-segment LCD.

# Constants

No description provided by the author

Ab0

No description provided by the author

Ab1

No description provided by the author

Ab2

No description provided by the author

Ab3

No description provided by the author

Ab4

No description provided by the author

Ab5

No description provided by the author

Ab6

No description provided by the author

Ab7

No description provided by the author

Ab8

No description provided by the author

AIP1640AddrCmd

No description provided by the author

AIP1640DataCmd

No description provided by the author

AIP1640DispCtrl

No description provided by the author

AIP1640FixedAddr

No description provided by the author

Bb0

No description provided by the author

Bb1

No description provided by the author

Bb2

No description provided by the author

Bb3

No description provided by the author

Bb4

No description provided by the author

Bb5

No description provided by the author

Bb6

No description provided by the author

Bb7

No description provided by the author

Bb8

No description provided by the author

ButtonPush

ButtonPush event.

ButtonRelease

ButtonRelease event.

No description provided by the author

Data

Data event.

Db0

No description provided by the author

Db1

No description provided by the author

Db2

No description provided by the author

Db3

No description provided by the author

Db4

No description provided by the author

Db5

No description provided by the author

Db6

No description provided by the author

Db7

No description provided by the author

Db8

No description provided by the author

Eb0

No description provided by the author

Eb1

No description provided by the author

Eb2

No description provided by the author

Eb3

No description provided by the author

Eb4

No description provided by the author

Eb5

No description provided by the author

Eb6

No description provided by the author

Eb7

No description provided by the author

Eb8

No description provided by the author

Eighth

No description provided by the author

Error

Error event.

No description provided by the author

Gb0

No description provided by the author

Gb1

No description provided by the author

Gb2

No description provided by the author

Gb3

No description provided by the author

Gb4

No description provided by the author

Gb5

No description provided by the author

Gb6

No description provided by the author

Gb7

No description provided by the author

Gb8

No description provided by the author

Half

No description provided by the author

HD44780_1LINE

No description provided by the author

HD44780_2LINE

No description provided by the author

HD44780_2NDLINEOFFSET

No description provided by the author

HD44780_4BITBUS

No description provided by the author

HD44780_4BITMODE

No description provided by the author

HD44780_5x10DOTS

No description provided by the author

HD44780_5x8DOTS

No description provided by the author

HD44780_8BITBUS

No description provided by the author

HD44780_8BITMODE

No description provided by the author

HD44780_BLINKOFF

No description provided by the author

HD44780_BLINKON

No description provided by the author

HD44780_CLEARDISPLAY

No description provided by the author

HD44780_CURSORMOVE

No description provided by the author

HD44780_CURSOROFF

No description provided by the author

HD44780_CURSORON

No description provided by the author

HD44780_CURSORSHIFT

No description provided by the author

HD44780_DISPLAYCONTROL

No description provided by the author

HD44780_DISPLAYMOVE

No description provided by the author

HD44780_DISPLAYOFF

No description provided by the author

HD44780_DISPLAYON

No description provided by the author

HD44780_ENTRYLEFT

No description provided by the author

HD44780_ENTRYMODESET

No description provided by the author

HD44780_ENTRYRIGHT

No description provided by the author

HD44780_ENTRYSHIFTDECREMENT

No description provided by the author

HD44780_ENTRYSHIFTINCREMENT

No description provided by the author

HD44780_FUNCTIONSET

No description provided by the author

HD44780_MOVELEFT

No description provided by the author

HD44780_MOVERIGHT

No description provided by the author

HD44780_RETURNHOME

No description provided by the author

HD44780_SETCGRAMADDR

No description provided by the author

HD44780_SETDDRAMADDR

No description provided by the author

MAX7219DecodeMode

No description provided by the author

MAX7219Digit0

No description provided by the author

MAX7219Digit1

No description provided by the author

MAX7219Digit2

No description provided by the author

MAX7219Digit3

No description provided by the author

MAX7219Digit4

No description provided by the author

MAX7219Digit5

No description provided by the author

MAX7219Digit6

No description provided by the author

MAX7219Digit7

No description provided by the author

MAX7219DisplayTest

No description provided by the author

MAX7219Intensity

No description provided by the author

MAX7219ScanLimit

No description provided by the author

MAX7219Shutdown

No description provided by the author

MotionDetected

MotionDetected event.

MotionStopped

MotionStopped event.

Quarter

No description provided by the author

Rest

No description provided by the author

TM1638AddrCmd

No description provided by the author

TM1638DataCmd

No description provided by the author

TM1638DispCtrl

No description provided by the author

TM1638FixedAddr

No description provided by the author

TM1638Green

No description provided by the author

TM1638None

No description provided by the author

TM1638ReadKeys

No description provided by the author

TM1638Red

No description provided by the author

TM1638WriteDisp

No description provided by the author

Vibration

Vibration event.

Whole

No description provided by the author

# Variables

ErrAnalogReadUnsupported

ErrAnalogReadUnsupported is error resulting when a driver attempts to use hardware capabilities which a connection does not support.

ErrDigitalReadUnsupported

ErrDigitalReadUnsupported is the error resulting when a driver attempts to use hardware capabilities which a connection does not support.

ErrDigitalWriteUnsupported

ErrDigitalWriteUnsupported is the error resulting when a driver attempts to use hardware capabilities which a connection does not support.

ErrPwmWriteUnsupported

ErrPwmWriteUnsupported is the error resulting when a driver attempts to use hardware capabilities which a connection does not support.

ErrServoOutOfRange

ErrServoOutOfRange is the error resulting when a driver attempts to use hardware capabilities which a connection does not support.

ErrServoWriteUnsupported

ErrServoWriteUnsupported is the error resulting when a driver attempts to use hardware capabilities which a connection does not support.

StepperModes

StepperModes to decide on Phase and Stepping.

# Structs

AIP1640Driver

AIP1640Driver is the gobot driver for the AIP1640 LED driver used in the WEMOS D1 mini Matrix LED Shield.

ButtonDriver

ButtonDriver Represents a digital Button.

BuzzerDriver

BuzzerDriver represents a digital buzzer.

DirectPinDriver

DirectPinDriver represents a GPIO pin.

EasyDriver

EasyDriver object.

GroveButtonDriver

GroveButtonDriver represents a button sensor with a Grove connector.

GroveBuzzerDriver

GroveBuzzerDriver represents a buzzer with a Grove connector.

GroveLedDriver

GroveLedDriver represents an LED with a Grove connector.

GroveMagneticSwitchDriver

GroveMagneticSwitchDriver represent a magnetic switch sensor with a Grove connector.

GroveRelayDriver

GroveRelayDriver represents a Relay with a Grove connector.

GroveTouchDriver

GroveTouchDriver represents a touch button sensor with a Grove connector.

HD44780DataPin

databit pins.

HD44780Driver

HD44780Driver is the gobot driver for the HD44780 LCD controller Datasheet: https://www.sparkfun.com/datasheets/LCD/HD44780.pdf.

LedDriver

LedDriver represents a digital Led.

MakeyButtonDriver

MakeyButtonDriver Represents a Makey Button.

MAX7219Driver

MAX7219Driver is the gobot driver for the MAX7219 LED driver Datasheet: https://datasheets.maximintegrated.com/en/ds/MAX7219-MAX7221.pdf.

MotorDriver

MotorDriver Represents a Motor.

PIRMotionDriver

PIRMotionDriver represents a digital Proximity Infra Red (PIR) motion detecter.

RelayDriver

RelayDriver represents a digital relay.

RgbLedDriver

RgbLedDriver represents a digital RGB Led.

ServoDriver

ServoDriver Represents a Servo.

StepperDriver

StepperDriver object.

TM1638Driver

No description provided by the author

# Interfaces

DigitalReader

DigitalReader interface represents an Adaptor which has DigitalRead capabilities.

DigitalWriter

DigitalWriter interface represents an Adaptor which has DigitalWrite capabilities.

PwmWriter

PwmWriter interface represents an Adaptor which has Pwm capabilities.

ServoWriter

ServoWriter interface represents an Adaptor which has Servo capabilities.

# Type aliases

HD44780BusMode

data bus mode.