Documentation ¶
Overview ¶
Package i2c provides Gobot drivers for i2c devices.
Installing:
go get -d -u gobot.io/x/gobot
For further information refer to i2c README: https://github.com/hybridgroup/gobot/blob/master/drivers/i2c/README.md
Index ¶
- Constants
- Variables
- func NewConnection(bus sysfs.I2cDevice, address int) (connection *i2cConnection)
- func WithAddress(address int) func(Config)
- func WithBus(bus int) func(Config)
- func WithMCP23017Bank(val uint8) func(Config)
- func WithMCP23017Disslw(val uint8) func(Config)
- func WithMCP23017Haen(val uint8) func(Config)
- func WithMCP23017Intpol(val uint8) func(Config)
- func WithMCP23017Mirror(val uint8) func(Config)
- func WithMCP23017Odr(val uint8) func(Config)
- func WithMCP23017Seqop(val uint8) func(Config)
- func WithTSL2561AutoGain(c Config)
- func WithTSL2561Gain16X(c Config)
- func WithTSL2561Gain1X(c Config)
- func WithTSL2561IntegrationTime101MS(c Config)
- func WithTSL2561IntegrationTime13MS(c Config)
- func WithTSL2561IntegrationTime402MS(c Config)
- type AdafruitDirection
- type AdafruitMotorHatDriver
- func (a *AdafruitMotorHatDriver) Connection() gobot.Connection
- func (a *AdafruitMotorHatDriver) Halt() (err error)
- func (a *AdafruitMotorHatDriver) Name() string
- func (a *AdafruitMotorHatDriver) RunDCMotor(dcMotor int, dir AdafruitDirection) (err error)
- func (a *AdafruitMotorHatDriver) SetDCMotorSpeed(dcMotor int, speed int32) (err error)
- func (a *AdafruitMotorHatDriver) SetMotorHatAddress(addr int) (err error)
- func (a *AdafruitMotorHatDriver) SetName(n string)
- func (a *AdafruitMotorHatDriver) SetServoHatAddress(addr int) (err error)
- func (a *AdafruitMotorHatDriver) SetServoMotorFreq(freq float64) (err error)
- func (a *AdafruitMotorHatDriver) SetServoMotorPulse(channel byte, on, off int32) (err error)
- func (a *AdafruitMotorHatDriver) SetStepperMotorSpeed(stepperMotor int, rpm int) (err error)
- func (a *AdafruitMotorHatDriver) Start() (err error)
- func (a *AdafruitMotorHatDriver) Step(motor, steps int, dir AdafruitDirection, style AdafruitStepStyle) (err error)
- type AdafruitStepStyle
- type BMP180Driver
- func (d *BMP180Driver) Connection() gobot.Connection
- func (d *BMP180Driver) Halt() (err error)
- func (d *BMP180Driver) Name() string
- func (d *BMP180Driver) Pressure(mode BMP180OversamplingMode) (pressure float32, err error)
- func (d *BMP180Driver) SetName(n string)
- func (d *BMP180Driver) Start() (err error)
- func (d *BMP180Driver) Temperature() (temp float32, err error)
- type BMP180OversamplingMode
- type BlinkMDriver
- func (b *BlinkMDriver) Color() (color []byte, err error)
- func (b *BlinkMDriver) Connection() gobot.Connection
- func (b *BlinkMDriver) Fade(red byte, green byte, blue byte) (err error)
- func (b *BlinkMDriver) FirmwareVersion() (version string, err error)
- func (b *BlinkMDriver) Halt() (err error)
- func (b *BlinkMDriver) Name() string
- func (b *BlinkMDriver) Rgb(red byte, green byte, blue byte) (err error)
- func (b *BlinkMDriver) SetName(n string)
- func (b *BlinkMDriver) Start() (err error)
- type Config
- type Connection
- type Connector
- type DRV2605LDriver
- func (d *DRV2605LDriver) Connection() gobot.Connection
- func (d *DRV2605LDriver) GetPauseWaveform(delayTime10MS uint8) (pauseID uint8)
- func (d *DRV2605LDriver) Go() (err error)
- func (d *DRV2605LDriver) Halt() (err error)
- func (d *DRV2605LDriver) Name() string
- func (d *DRV2605LDriver) SelectLibrary(library uint8) (err error)
- func (d *DRV2605LDriver) SetMode(newMode DRV2605Mode) (err error)
- func (d *DRV2605LDriver) SetName(name string)
- func (d *DRV2605LDriver) SetSequence(waveforms []uint8) (err error)
- func (d *DRV2605LDriver) SetStandbyMode(standby bool) (err error)
- func (d *DRV2605LDriver) Start() (err error)
- type DRV2605Mode
- type GroveAccelerometerDriver
- type GroveLcdDriver
- type HMC6352Driver
- type JHD1313M1Driver
- func (h *JHD1313M1Driver) Clear() error
- func (h *JHD1313M1Driver) Connection() gobot.Connection
- func (h *JHD1313M1Driver) Halt() error
- func (h *JHD1313M1Driver) Home() error
- func (h *JHD1313M1Driver) Name() string
- func (h *JHD1313M1Driver) Scroll(leftToRight bool) error
- func (h *JHD1313M1Driver) SetCustomChar(pos int, charMap [8]byte) error
- func (h *JHD1313M1Driver) SetName(n string)
- func (h *JHD1313M1Driver) SetPosition(pos int) (err error)
- func (h *JHD1313M1Driver) SetRGB(r, g, b int) error
- func (h *JHD1313M1Driver) Start() (err error)
- func (h *JHD1313M1Driver) Write(message string) error
- type L3GD20HDriver
- func (d *L3GD20HDriver) Connection() gobot.Connection
- func (d *L3GD20HDriver) Halt() (err error)
- func (d *L3GD20HDriver) Name() string
- func (d *L3GD20HDriver) Scale() L3GD20HScale
- func (d *L3GD20HDriver) SetName(name string)
- func (d *L3GD20HDriver) SetScale(s L3GD20HScale)
- func (d *L3GD20HDriver) Start() (err error)
- func (d *L3GD20HDriver) XYZ() (x float32, y float32, z float32, err error)
- type L3GD20HScale
- type LIDARLiteDriver
- type MCP23017Config
- type MCP23017Driver
- func (m *MCP23017Driver) Connection() gobot.Connection
- func (m *MCP23017Driver) Halt() (err error)
- func (m *MCP23017Driver) Name() string
- func (m *MCP23017Driver) PinMode(pin, val uint8, portStr string) (err error)
- func (m *MCP23017Driver) ReadGPIO(pin uint8, portStr string) (val uint8, err error)
- func (m *MCP23017Driver) SetGPIOPolarity(pin uint8, val uint8, portStr string) (err error)
- func (m *MCP23017Driver) SetName(n string)
- func (m *MCP23017Driver) SetPullUp(pin uint8, val uint8, portStr string) error
- func (m *MCP23017Driver) Start() (err error)
- func (m *MCP23017Driver) WriteGPIO(pin uint8, val uint8, portStr string) (err error)
- type MMA7660Driver
- func (h *MMA7660Driver) Acceleration(x, y, z float64) (ax, ay, az float64)
- func (h *MMA7660Driver) Connection() gobot.Connection
- func (h *MMA7660Driver) Halt() (err error)
- func (h *MMA7660Driver) Name() string
- func (h *MMA7660Driver) SetName(n string)
- func (h *MMA7660Driver) Start() (err error)
- func (h *MMA7660Driver) XYZ() (x float64, y float64, z float64, err error)
- type MPL115A2Driver
- func (h *MPL115A2Driver) Connection() gobot.Connection
- func (h *MPL115A2Driver) Halt() (err error)
- func (h *MPL115A2Driver) Name() string
- func (h *MPL115A2Driver) Pressure() (p float32)
- func (h *MPL115A2Driver) SetName(n string)
- func (h *MPL115A2Driver) Start() (err error)
- func (h *MPL115A2Driver) Temperature() (t float32)
- type MPU6050Driver
- type SHT3xDriver
- func (s *SHT3xDriver) Accuracy() byte
- func (s *SHT3xDriver) Connection() gobot.Connection
- func (s *SHT3xDriver) Halt() (err error)
- func (s *SHT3xDriver) Heater() (status bool, err error)
- func (s *SHT3xDriver) Name() string
- func (s *SHT3xDriver) Sample() (temp float32, rh float32, err error)
- func (s *SHT3xDriver) SerialNumber() (sn uint32, err error)
- func (s *SHT3xDriver) SetAccuracy(a byte) (err error)
- func (s *SHT3xDriver) SetAddress(address int)
- func (s *SHT3xDriver) SetHeater(enabled bool) (err error)
- func (s *SHT3xDriver) SetName(n string)
- func (s *SHT3xDriver) Start() (err error)
- type TSL2561Driver
- func (d *TSL2561Driver) CalculateLux(broadband uint16, ir uint16) (lux uint32)
- func (d *TSL2561Driver) Connection() gobot.Connection
- func (d *TSL2561Driver) GetLuminocity() (broadband uint16, ir uint16, err error)
- func (d *TSL2561Driver) Halt() error
- func (d *TSL2561Driver) Name() string
- func (d *TSL2561Driver) SetGain(gain TSL2561Gain) error
- func (d *TSL2561Driver) SetIntegrationTime(time TSL2561IntegrationTime) error
- func (d *TSL2561Driver) SetName(name string)
- func (d *TSL2561Driver) Start() (err error)
- type TSL2561Gain
- type TSL2561IntegrationTime
- type ThreeDData
- type WiichuckDriver
Constants ¶
const ( DRV2605ModeIntTrig DRV2605Mode = 0x00 DRV2605ModeExtTrigEdge = 0x01 DRV2605ModeExtTrigLvl = 0x02 DRV2605ModePWMAnalog = 0x03 DRV2605ModeAudioVibe = 0x04 DRV2605ModeRealtime = 0x05 DRV2605ModeDiagnose = 0x06 DRV2605ModeAutocal = 0x07 )
Operating modes, for use in SetMode()
const ( // BusNotInitialized is the initial value for a bus BusNotInitialized = -1 // AddressNotInitialized is the initial value for an address AddressNotInitialized = -1 )
const ( REG_RED = 0x04 REG_GREEN = 0x03 REG_BLUE = 0x02 LCD_CLEARDISPLAY = 0x01 LCD_RETURNHOME = 0x02 LCD_ENTRYMODESET = 0x04 LCD_DISPLAYCONTROL = 0x08 LCD_CURSORSHIFT = 0x10 LCD_FUNCTIONSET = 0x20 LCD_SETCGRAMADDR = 0x40 LCD_SETDDRAMADDR = 0x80 LCD_ENTRYRIGHT = 0x00 LCD_ENTRYLEFT = 0x02 LCD_ENTRYSHIFTINCREMENT = 0x01 LCD_ENTRYSHIFTDECREMENT = 0x00 LCD_DISPLAYON = 0x04 LCD_DISPLAYOFF = 0x00 LCD_CURSORON = 0x02 LCD_CURSOROFF = 0x00 LCD_BLINKON = 0x01 LCD_BLINKOFF = 0x00 LCD_DISPLAYMOVE = 0x08 LCD_CURSORMOVE = 0x00 LCD_MOVERIGHT = 0x04 LCD_MOVELEFT = 0x00 LCD_2LINE = 0x08 LCD_CMD = 0x80 LCD_DATA = 0x40 LCD_2NDLINEOFFSET = 0x40 )
const ( MMA7660_X = 0x00 MMA7660_Y = 0x01 MMA7660_Z = 0x02 MMA7660_TILT = 0x03 MMA7660_SRST = 0x04 MMA7660_SPCNT = 0x05 MMA7660_INTSU = 0x06 MMA7660_MODE = 0x07 MMA7660_STAND_BY = 0x00 MMA7660_ACTIVE = 0x01 MMA7660_SR = 0x08 MMA7660_AUTO_SLEEP_120 = 0x00 MMA7660_AUTO_SLEEP_64 = 0x01 MMA7660_AUTO_SLEEP_32 = 0x02 MMA7660_AUTO_SLEEP_16 = 0x03 MMA7660_AUTO_SLEEP_8 = 0x04 MMA7660_AUTO_SLEEP_4 = 0x05 MMA7660_AUTO_SLEEP_2 = 0x06 MMA7660_AUTO_SLEEP_1 = 0x07 MMA7660_PDET = 0x09 MMA7660_PD = 0x0A )
const ( // TSL2561AddressLow - the address of the device when address pin is low TSL2561AddressLow = 0x29 // TSL2561AddressFloat - the address of the device when address pin is floating TSL2561AddressFloat = 0x39 // TSL2561AddressHigh - the address of the device when address pin is high TSL2561AddressHigh = 0x49 )
const ( // Joystick event when the Wiichuck joystick is moved Joystick = "joystick" // C event when the Wiichuck "C" button is pressed C = "c" // Z event when the Wiichuck "C" button is pressed Z = "z" )
const (
// Error event
Error = "error"
)
const MPL115A2_REGISTER_A0_COEFF_LSB = 0x05
const MPL115A2_REGISTER_A0_COEFF_MSB = 0x04
const MPL115A2_REGISTER_B1_COEFF_LSB = 0x07
const MPL115A2_REGISTER_B1_COEFF_MSB = 0x06
const MPL115A2_REGISTER_B2_COEFF_LSB = 0x09
const MPL115A2_REGISTER_B2_COEFF_MSB = 0x08
const MPL115A2_REGISTER_C12_COEFF_LSB = 0x0B
const MPL115A2_REGISTER_C12_COEFF_MSB = 0x0A
const MPL115A2_REGISTER_PRESSURE_LSB = 0x01
const MPL115A2_REGISTER_PRESSURE_MSB = 0x00
const MPL115A2_REGISTER_STARTCONVERSION = 0x12
const MPL115A2_REGISTER_TEMP_LSB = 0x03
const MPL115A2_REGISTER_TEMP_MSB = 0x02
const MPU6050_ACCEL_FS_2 = 0x00
const MPU6050_ACONFIG_AFS_SEL_BIT = 4
const MPU6050_ACONFIG_AFS_SEL_LENGTH = 2
const MPU6050_CLOCK_PLL_XGYRO = 0x01
const MPU6050_GCONFIG_FS_SEL_BIT = 4
const MPU6050_GCONFIG_FS_SEL_LENGTH = 2
const MPU6050_GYRO_FS_250 = 0x00
const MPU6050_PWR1_CLKSEL_BIT = 2
const MPU6050_PWR1_CLKSEL_LENGTH = 3
const MPU6050_PWR1_ENABLE_BIT = 0
const MPU6050_PWR1_SLEEP_BIT = 6
const MPU6050_RA_ACCEL_CONFIG = 0x1C
const MPU6050_RA_ACCEL_XOUT_H = 0x3B
const MPU6050_RA_GYRO_CONFIG = 0x1B
const MPU6050_RA_PWR_MGMT_1 = 0x6B
const SHT3xAccuracyHigh = 0x00
SHT3xAccuracyHigh is the high accuracy and slowest sample setting
const SHT3xAccuracyLow = 0x16
SHT3xAccuracyLow is the faster, but lower accuracy sample setting
const SHT3xAccuracyMedium = 0x0b
SHT3xAccuracyMedium is the medium accuracy and speed sample setting
const SHT3xAddressA = 0x44
SHT3xAddressA is the default address of device
const SHT3xAddressB = 0x45
SHT3xAddressB is the optional address of device
Variables ¶
var ( ErrEncryptedBytes = errors.New("Encrypted bytes") ErrNotEnoughBytes = errors.New("Not enough bytes read") ErrNotReady = errors.New("Device is not ready") ErrInvalidPosition = errors.New("Invalid position value") )
var ( ErrInvalidAccuracy = errors.New("Invalid accuracy") ErrInvalidCrc = errors.New("Invalid crc") ErrInvalidTemp = errors.New("Invalid temperature units") )
var CustomLCDChars = map[string][8]byte{
"é": {130, 132, 142, 145, 159, 144, 142, 128},
"è": {136, 132, 142, 145, 159, 144, 142, 128},
"ê": {132, 138, 142, 145, 159, 144, 142, 128},
"à": {136, 134, 128, 142, 145, 147, 141, 128},
"â": {132, 138, 128, 142, 145, 147, 141, 128},
"á": {2, 4, 14, 1, 15, 17, 15, 0},
"î": {132, 138, 128, 140, 132, 132, 142, 128},
"í": {2, 4, 12, 4, 4, 4, 14, 0},
"û": {132, 138, 128, 145, 145, 147, 141, 128},
"ù": {136, 134, 128, 145, 145, 147, 141, 128},
"ñ": {14, 0, 22, 25, 17, 17, 17, 0},
"ó": {2, 4, 14, 17, 17, 17, 14, 0},
"heart": {0, 10, 31, 31, 31, 14, 4, 0},
"smiley": {0, 0, 10, 0, 0, 17, 14, 0},
"frowney": {0, 0, 10, 0, 0, 0, 14, 17},
}
CustomLCDChars is a map of CGRAM characters that can be loaded into a LCD screen to display custom characters. Some LCD screens such as the Grove screen (jhd1313m1) isn't loaded with latin 1 characters. It's up to the developer to load the set up to 8 custom characters and update the input text so the character is swapped by a byte reflecting the position of the custom character to use. See SetCustomChar
Functions ¶
func NewConnection ¶ added in v1.2.0
NewConnection creates and returns a new connection to a specific i2c device on a bus and address.
func WithAddress ¶ added in v1.2.0
WithAddress sets which address to use as a optional param.
func WithMCP23017Bank ¶ added in v1.2.0
WithMCP23017Bank option sets the MCP23017Driver bank option
func WithMCP23017Disslw ¶ added in v1.2.0
WithMCP23017Disslw option sets the MCP23017Driver Disslw option
func WithMCP23017Haen ¶ added in v1.2.0
WithMCP23017Haen option sets the MCP23017Driver Haen option
func WithMCP23017Intpol ¶ added in v1.2.0
WithMCP23017Intpol option sets the MCP23017Driver Intpol option
func WithMCP23017Mirror ¶ added in v1.2.0
WithMCP23017Mirror option sets the MCP23017Driver Mirror option
func WithMCP23017Odr ¶ added in v1.2.0
WithMCP23017Odr option sets the MCP23017Driver Odr option
func WithMCP23017Seqop ¶ added in v1.2.0
WithMCP23017Seqop option sets the MCP23017Driver Seqop option
func WithTSL2561AutoGain ¶ added in v1.3.0
func WithTSL2561AutoGain(c Config)
WithTSL2561AutoGain option turns on TSL2561Driver auto gain
func WithTSL2561Gain16X ¶ added in v1.3.0
func WithTSL2561Gain16X(c Config)
WithTSL2561Gain16X option sets the TSL2561Driver gain to 16X
func WithTSL2561Gain1X ¶ added in v1.3.0
func WithTSL2561Gain1X(c Config)
WithTSL2561Gain1X option sets the TSL2561Driver gain to 1X
func WithTSL2561IntegrationTime101MS ¶ added in v1.3.0
func WithTSL2561IntegrationTime101MS(c Config)
WithTSL2561IntegrationTime101MS option sets the TSL2561Driver integration time to 101ms
func WithTSL2561IntegrationTime13MS ¶ added in v1.3.0
func WithTSL2561IntegrationTime13MS(c Config)
WithTSL2561IntegrationTime13MS option sets the TSL2561Driver integration time to 13ms
func WithTSL2561IntegrationTime402MS ¶ added in v1.3.0
func WithTSL2561IntegrationTime402MS(c Config)
WithTSL2561IntegrationTime402MS option sets the TSL2561Driver integration time to 402ms
Types ¶
type AdafruitDirection ¶
type AdafruitDirection int
AdafruitDirection declares a type for specification of the motor direction
const ( AdafruitForward AdafruitDirection = iota // 0 AdafruitBackward // 1 AdafruitRelease // 2 )
type AdafruitMotorHatDriver ¶
type AdafruitMotorHatDriver struct { Config gobot.Commander // contains filtered or unexported fields }
AdafruitMotorHatDriver is a driver for the DC+Stepper Motor HAT from Adafruit. The HAT is a Raspberry Pi add-on that can drive up to 4 DC or 2 Stepper motors with full PWM speed control. It has a dedicated PWM driver chip onboard to control both motor direction and speed over I2C.
func NewAdafruitMotorHatDriver ¶
func NewAdafruitMotorHatDriver(conn Connector, options ...func(Config)) *AdafruitMotorHatDriver
NewAdafruitMotorHatDriver initializes the internal DCMotor and StepperMotor types. Again the Adafruit Motor Hat supports up to four DC motors and up to two stepper motors. Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*AdafruitMotorHatDriver) Connection ¶
func (a *AdafruitMotorHatDriver) Connection() gobot.Connection
Connection identifies the particular adapter object
func (*AdafruitMotorHatDriver) Halt ¶
func (a *AdafruitMotorHatDriver) Halt() (err error)
Halt returns true if devices is halted successfully
func (*AdafruitMotorHatDriver) Name ¶
func (a *AdafruitMotorHatDriver) Name() string
Name identifies this driver object
func (*AdafruitMotorHatDriver) RunDCMotor ¶
func (a *AdafruitMotorHatDriver) RunDCMotor(dcMotor int, dir AdafruitDirection) (err error)
RunDCMotor will set the appropriate pins to run the specified DC motor for the given direction
func (*AdafruitMotorHatDriver) SetDCMotorSpeed ¶
func (a *AdafruitMotorHatDriver) SetDCMotorSpeed(dcMotor int, speed int32) (err error)
SetDCMotorSpeed will set the appropriate pins to run the specified DC motor for the given speed.
func (*AdafruitMotorHatDriver) SetMotorHatAddress ¶
func (a *AdafruitMotorHatDriver) SetMotorHatAddress(addr int) (err error)
SetMotorHatAddress sets the I2C address for the DC and Stepper Motor HAT. This addressing flexibility empowers "stacking" the HATs.
func (*AdafruitMotorHatDriver) SetName ¶
func (a *AdafruitMotorHatDriver) SetName(n string)
SetName sets nae for driver
func (*AdafruitMotorHatDriver) SetServoHatAddress ¶
func (a *AdafruitMotorHatDriver) SetServoHatAddress(addr int) (err error)
SetServoHatAddress sets the I2C address for the PWM-Servo Motor HAT. This addressing flexibility empowers "stacking" the HATs.
func (*AdafruitMotorHatDriver) SetServoMotorFreq ¶
func (a *AdafruitMotorHatDriver) SetServoMotorFreq(freq float64) (err error)
SetServoMotorFreq sets the frequency for the currently addressed PWM Servo HAT.
func (*AdafruitMotorHatDriver) SetServoMotorPulse ¶
func (a *AdafruitMotorHatDriver) SetServoMotorPulse(channel byte, on, off int32) (err error)
SetServoMotorPulse is a convenience function to specify the 'tick' value, between 0-4095, when the signal will turn on, and when it will turn off.
func (*AdafruitMotorHatDriver) SetStepperMotorSpeed ¶
func (a *AdafruitMotorHatDriver) SetStepperMotorSpeed(stepperMotor int, rpm int) (err error)
SetStepperMotorSpeed sets the seconds-per-step for the given Stepper Motor.
func (*AdafruitMotorHatDriver) Start ¶
func (a *AdafruitMotorHatDriver) Start() (err error)
Start initializes both I2C-addressable Adafruit Motor HAT drivers
func (*AdafruitMotorHatDriver) Step ¶
func (a *AdafruitMotorHatDriver) Step(motor, steps int, dir AdafruitDirection, style AdafruitStepStyle) (err error)
Step will rotate the stepper motor the given number of steps, in the given direction and step style.
type AdafruitStepStyle ¶
type AdafruitStepStyle int
AdafruitStepStyle declares a type for specification of the stepper motor rotation
const ( AdafruitSingle AdafruitStepStyle = iota // 0 AdafruitDouble // 1 AdafruitInterleave // 2 AdafruitMicrostep // 3 )
type BMP180Driver ¶ added in v1.1.0
type BMP180Driver struct { Config // contains filtered or unexported fields }
BMP180Driver is the gobot driver for the Bosch pressure sensor BMP180. Device datasheet: https://cdn-shop.adafruit.com/datasheets/BST-BMP180-DS000-09.pdf
func NewBMP180Driver ¶ added in v1.1.0
func NewBMP180Driver(c Connector, options ...func(Config)) *BMP180Driver
NewBMP180Driver creates a new driver with the i2c interface for the BMP180 device. Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*BMP180Driver) Connection ¶ added in v1.1.0
func (d *BMP180Driver) Connection() gobot.Connection
Connection returns the connection of the device.
func (*BMP180Driver) Halt ¶ added in v1.1.0
func (d *BMP180Driver) Halt() (err error)
Halt halts the device.
func (*BMP180Driver) Name ¶ added in v1.1.0
func (d *BMP180Driver) Name() string
Name returns the name of the device.
func (*BMP180Driver) Pressure ¶ added in v1.1.0
func (d *BMP180Driver) Pressure(mode BMP180OversamplingMode) (pressure float32, err error)
Pressure returns the current pressure, in pascals.
func (*BMP180Driver) SetName ¶ added in v1.1.0
func (d *BMP180Driver) SetName(n string)
SetName sets the name of the device.
func (*BMP180Driver) Start ¶ added in v1.1.0
func (d *BMP180Driver) Start() (err error)
Start initializes the BMP180 and loads the calibration coefficients.
func (*BMP180Driver) Temperature ¶ added in v1.1.0
func (d *BMP180Driver) Temperature() (temp float32, err error)
Temperature returns the current temperature, in celsius degrees.
type BMP180OversamplingMode ¶ added in v1.1.0
type BMP180OversamplingMode uint
BMP180OversamplingMode is the oversampling ratio of the pressure measurement.
const ( // BMP180UltraLowPower is the lowest oversampling mode of the pressure measurement. BMP180UltraLowPower BMP180OversamplingMode = iota // BMP180Standard is the standard oversampling mode of the pressure measurement. BMP180Standard // BMP180HighResolution is a high oversampling mode of the pressure measurement. BMP180HighResolution // BMP180UltraHighResolution is the highest oversampling mode of the pressure measurement. BMP180UltraHighResolution )
type BlinkMDriver ¶
BlinkMDriver is a Gobot Driver for a BlinkM LED
func NewBlinkMDriver ¶
func NewBlinkMDriver(a Connector, options ...func(Config)) *BlinkMDriver
NewBlinkMDriver creates a new BlinkMDriver.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*BlinkMDriver) Color ¶
func (b *BlinkMDriver) Color() (color []byte, err error)
Color returns an array with current rgb color
func (*BlinkMDriver) Connection ¶
func (b *BlinkMDriver) Connection() gobot.Connection
Connection returns the connection for the Driver
func (*BlinkMDriver) Fade ¶
func (b *BlinkMDriver) Fade(red byte, green byte, blue byte) (err error)
Fade removes color using r,g,b params
func (*BlinkMDriver) FirmwareVersion ¶
func (b *BlinkMDriver) FirmwareVersion() (version string, err error)
FirmwareVersion returns version with MAYOR.minor format
func (*BlinkMDriver) Halt ¶
func (b *BlinkMDriver) Halt() (err error)
Halt returns true if device is halted successfully
func (*BlinkMDriver) Name ¶
func (b *BlinkMDriver) Name() string
Name returns the Name for the Driver
func (*BlinkMDriver) Rgb ¶
func (b *BlinkMDriver) Rgb(red byte, green byte, blue byte) (err error)
Rgb sets color using r,g,b params
func (*BlinkMDriver) SetName ¶
func (b *BlinkMDriver) SetName(n string)
SetName sets the Name for the Driver
func (*BlinkMDriver) Start ¶
func (b *BlinkMDriver) Start() (err error)
Start starts the Driver up, and writes start command
type Config ¶ added in v1.2.0
type Config interface { // WithBus sets which bus to use WithBus(bus int) // GetBusOrDefault gets which bus to use GetBusOrDefault(def int) int // WithAddress sets which address to use WithAddress(address int) // GetAddressOrDefault gets which address to use GetAddressOrDefault(def int) int }
Config is the interface which describes how a Driver can specify optional I2C params such as which I2C bus it wants to use.
type Connection ¶ added in v1.2.0
type Connection sysfs.I2cOperations
Connection is a connection to an I2C device with a specified address on a specific bus. Used as an alternative to the I2c interface. Implements sysfs.I2cOperations to talk to the device, wrapping the calls in SetAddress to always target the specified device. Provided by an Adaptor by implementing the I2cConnector interface.
type Connector ¶ added in v1.2.0
type Connector interface { // GetConnection returns a connection to device at the specified address // and bus. Bus numbering starts at index 0, the range of valid buses is // platform specific. GetConnection(address int, bus int) (device Connection, err error) // GetDefaultBus returns the default I2C bus index GetDefaultBus() int }
Connector lets Adaptors provide the interface for Drivers to get access to the I2C buses on platforms that support I2C.
type DRV2605LDriver ¶ added in v1.3.0
type DRV2605LDriver struct { Config // contains filtered or unexported fields }
DRV2605LDriver is the gobot driver for the TI/Adafruit DRV2605L Haptic Controller
Device datasheet: http://www.ti.com/lit/ds/symlink/drv2605l.pdf
Inspired by the Adafruit Python driver by Sean Mealin.
Basic use:
haptic := i2c.NewDRV2605Driver(adaptor) haptic.SetSequence([]byte{1, 13}) haptic.Go()
func NewDRV2605LDriver ¶ added in v1.3.0
func NewDRV2605LDriver(conn Connector, options ...func(Config)) *DRV2605LDriver
NewDRV2605LDriver creates a new driver for the DRV2605L device.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*DRV2605LDriver) Connection ¶ added in v1.3.0
func (d *DRV2605LDriver) Connection() gobot.Connection
Connection returns the connection of the device.
func (*DRV2605LDriver) GetPauseWaveform ¶ added in v1.3.0
func (d *DRV2605LDriver) GetPauseWaveform(delayTime10MS uint8) (pauseID uint8)
GetPauseWaveform returns a special waveform ID used in SetSequence() to encode pauses between waveforms. Time is specified in tens of milliseconds ranging from 0ms (delayTime10MS = 0) to 1270ms (delayTime10MS = 127). Times out of range are clipped to fit.
func (*DRV2605LDriver) Go ¶ added in v1.3.0
func (d *DRV2605LDriver) Go() (err error)
Go plays the current sequence of waveforms.
func (*DRV2605LDriver) Halt ¶ added in v1.3.0
func (d *DRV2605LDriver) Halt() (err error)
Halt halts the device.
func (*DRV2605LDriver) Name ¶ added in v1.3.0
func (d *DRV2605LDriver) Name() string
Name returns the name of the device.
func (*DRV2605LDriver) SelectLibrary ¶ added in v1.3.0
func (d *DRV2605LDriver) SelectLibrary(library uint8) (err error)
SelectLibrary selects which waveform library to play from, 1-7. See datasheet for more info.
func (*DRV2605LDriver) SetMode ¶ added in v1.3.0
func (d *DRV2605LDriver) SetMode(newMode DRV2605Mode) (err error)
SetMode sets the device in one of the eight modes as described in the datasheet. Defaults to mode 0, internal trig.
func (*DRV2605LDriver) SetName ¶ added in v1.3.0
func (d *DRV2605LDriver) SetName(name string)
SetName sets the name of the device.
func (*DRV2605LDriver) SetSequence ¶ added in v1.3.0
func (d *DRV2605LDriver) SetSequence(waveforms []uint8) (err error)
SetSequence sets the sequence of waveforms to be played by the sequencer, specified by waveform id as described in the datasheet. The sequencer can play at most 8 waveforms in sequence, longer sequences will be truncated. A waveform id of zero marks the end of the sequence. Pauses can be encoded using GetPauseWaveform().
func (*DRV2605LDriver) SetStandbyMode ¶ added in v1.3.0
func (d *DRV2605LDriver) SetStandbyMode(standby bool) (err error)
SetStandbyMode controls device low power mode
func (*DRV2605LDriver) Start ¶ added in v1.3.0
func (d *DRV2605LDriver) Start() (err error)
Start initializes the device.
type GroveAccelerometerDriver ¶
type GroveAccelerometerDriver struct {
*MMA7660Driver
}
GroveAccelerometerDriver is a driver for the MMA7660 accelerometer
func NewGroveAccelerometerDriver ¶
func NewGroveAccelerometerDriver(a Connector, options ...func(Config)) *GroveAccelerometerDriver
NewGroveAccelerometerDriver creates a new driver with specified i2c interface Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
type GroveLcdDriver ¶
type GroveLcdDriver struct {
*JHD1313M1Driver
}
GroveLcdDriver is a driver for the Jhd1313m1 LCD display which has two i2c addreses, one belongs to a controller and the other controls solely the backlight. This module was tested with the Seed Grove LCD RGB Backlight v2.0 display which requires 5V to operate. http://www.seeedstudio.com/wiki/Grove_-_LCD_RGB_Backlight
func NewGroveLcdDriver ¶
func NewGroveLcdDriver(a Connector, options ...func(Config)) *GroveLcdDriver
NewGroveLcdDriver creates a new driver with specified i2c interface. Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
type HMC6352Driver ¶
type HMC6352Driver struct { Config // contains filtered or unexported fields }
HMC6352Driver is a Driver for a HMC6352 digital compass
func NewHMC6352Driver ¶
func NewHMC6352Driver(a Connector, options ...func(Config)) *HMC6352Driver
NewHMC6352Driver creates a new driver with specified i2c interface Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*HMC6352Driver) Connection ¶
func (h *HMC6352Driver) Connection() gobot.Connection
Connection returns the connection for this Driver
func (*HMC6352Driver) Halt ¶
func (h *HMC6352Driver) Halt() (err error)
Halt returns true if devices is halted successfully
func (*HMC6352Driver) Heading ¶
func (h *HMC6352Driver) Heading() (heading uint16, err error)
Heading returns the current heading
func (*HMC6352Driver) Name ¶
func (h *HMC6352Driver) Name() string
Name returns the name for this Driver
func (*HMC6352Driver) SetName ¶
func (h *HMC6352Driver) SetName(n string)
SetName sets the name for this Driver
func (*HMC6352Driver) Start ¶
func (h *HMC6352Driver) Start() (err error)
Start initializes the hmc6352
type JHD1313M1Driver ¶
type JHD1313M1Driver struct { Config // contains filtered or unexported fields }
JHD1313M1Driver is a driver for the Jhd1313m1 LCD display which has two i2c addreses, one belongs to a controller and the other controls solely the backlight. This module was tested with the Seed Grove LCD RGB Backlight v2.0 display which requires 5V to operate. http://www.seeedstudio.com/wiki/Grove_-_LCD_RGB_Backlight
func NewJHD1313M1Driver ¶
func NewJHD1313M1Driver(a Connector, options ...func(Config)) *JHD1313M1Driver
NewJHD1313M1Driver creates a new driver with specified i2c interface. Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver
func (*JHD1313M1Driver) Clear ¶
func (h *JHD1313M1Driver) Clear() error
Clear clears the text on the lCD display.
func (*JHD1313M1Driver) Connection ¶
func (h *JHD1313M1Driver) Connection() gobot.Connection
Connection returns the driver connection to the device.
func (*JHD1313M1Driver) Home ¶
func (h *JHD1313M1Driver) Home() error
Home sets the cursor to the origin position on the display.
func (*JHD1313M1Driver) Name ¶
func (h *JHD1313M1Driver) Name() string
Name returns the name the JHD1313M1 Driver was given when created.
func (*JHD1313M1Driver) Scroll ¶
func (h *JHD1313M1Driver) Scroll(leftToRight bool) error
func (*JHD1313M1Driver) SetCustomChar ¶
func (h *JHD1313M1Driver) SetCustomChar(pos int, charMap [8]byte) error
SetCustomChar sets one of the 8 CGRAM locations with a custom character. The custom character can be used by writing a byte of value 0 to 7. When you are using LCD as 5x8 dots in function set then you can define a total of 8 user defined patterns (1 Byte for each row and 8 rows for each pattern). Use http://www.8051projects.net/lcd-interfacing/lcd-custom-character.php to create your own characters. To use a custom character, write byte value of the custom character position as a string after having setup the custom character.
func (*JHD1313M1Driver) SetName ¶
func (h *JHD1313M1Driver) SetName(n string)
SetName sets the name for the JHD1313M1 Driver.
func (*JHD1313M1Driver) SetPosition ¶
func (h *JHD1313M1Driver) SetPosition(pos int) (err error)
SetPosition sets the cursor and the data display to pos. 0..15 are the positions in the first display line. 16..32 are the positions in the second display line.
func (*JHD1313M1Driver) SetRGB ¶
func (h *JHD1313M1Driver) SetRGB(r, g, b int) error
SetRGB sets the Red Green Blue value of backlit.
func (*JHD1313M1Driver) Start ¶
func (h *JHD1313M1Driver) Start() (err error)
Start starts the backlit and the screen and initializes the states.
func (*JHD1313M1Driver) Write ¶
func (h *JHD1313M1Driver) Write(message string) error
Write displays the passed message on the screen.
type L3GD20HDriver ¶ added in v1.1.0
type L3GD20HDriver struct { Config // contains filtered or unexported fields }
L3GD20HDriver is the gobot driver for the Adafruit Triple-Axis Gyroscope L3GD20H. Device datasheet: http://www.st.com/internet/com/TECHNICAL_RESOURCES/TECHNICAL_LITERATURE/DATASHEET/DM00036465.pdf
func NewL3GD20HDriver ¶ added in v1.1.0
func NewL3GD20HDriver(c Connector, options ...func(Config)) *L3GD20HDriver
NewL3GD20HDriver creates a new Gobot driver for the L3GD20H I2C Triple-Axis Gyroscope.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*L3GD20HDriver) Connection ¶ added in v1.1.0
func (d *L3GD20HDriver) Connection() gobot.Connection
Connection returns the connection of the device.
func (*L3GD20HDriver) Halt ¶ added in v1.1.0
func (d *L3GD20HDriver) Halt() (err error)
Halt halts the device.
func (*L3GD20HDriver) Name ¶ added in v1.1.0
func (d *L3GD20HDriver) Name() string
Name returns the name of the device.
func (*L3GD20HDriver) Scale ¶ added in v1.1.0
func (d *L3GD20HDriver) Scale() L3GD20HScale
Scale returns the scale sensitivity of the device.
func (*L3GD20HDriver) SetName ¶ added in v1.1.0
func (d *L3GD20HDriver) SetName(name string)
SetName sets the name of the device.
func (*L3GD20HDriver) SetScale ¶ added in v1.1.0
func (d *L3GD20HDriver) SetScale(s L3GD20HScale)
SetScale sets the scale sensitivity of the device.
func (*L3GD20HDriver) Start ¶ added in v1.1.0
func (d *L3GD20HDriver) Start() (err error)
Start initializes the device.
type L3GD20HScale ¶ added in v1.1.0
type L3GD20HScale byte
L3GD20HScale is the scale sensitivity of degrees-per-second.
const ( // L3GD20HScale250dps is the 250 degress-per-second scale. L3GD20HScale250dps L3GD20HScale = 0x00 // L3GD20HScale500dps is the 500 degress-per-second scale. L3GD20HScale500dps L3GD20HScale = 0x10 // L3GD20HScale2000dps is the 2000 degress-per-second scale. L3GD20HScale2000dps L3GD20HScale = 0x30 )
type LIDARLiteDriver ¶
type LIDARLiteDriver struct { Config // contains filtered or unexported fields }
LIDARLiteDriver is the Gobot driver for the LIDARLite I2C LIDAR device.
func NewLIDARLiteDriver ¶
func NewLIDARLiteDriver(a Connector, options ...func(Config)) *LIDARLiteDriver
NewLIDARLiteDriver creates a new driver for the LIDARLite I2C LIDAR device.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*LIDARLiteDriver) Connection ¶
func (h *LIDARLiteDriver) Connection() gobot.Connection
Connection returns the connection for the Driver
func (*LIDARLiteDriver) Distance ¶
func (h *LIDARLiteDriver) Distance() (distance int, err error)
Distance returns the current distance in cm
func (*LIDARLiteDriver) Halt ¶
func (h *LIDARLiteDriver) Halt() (err error)
Halt returns true if devices is halted successfully
func (*LIDARLiteDriver) Name ¶
func (h *LIDARLiteDriver) Name() string
Name returns the Name for the Driver
func (*LIDARLiteDriver) SetName ¶
func (h *LIDARLiteDriver) SetName(n string)
SetName sets the Name for the Driver
func (*LIDARLiteDriver) Start ¶
func (h *LIDARLiteDriver) Start() (err error)
Start initialized the LIDAR
type MCP23017Config ¶
type MCP23017Config struct { Bank uint8 Mirror uint8 Seqop uint8 Disslw uint8 Haen uint8 Odr uint8 Intpol uint8 }
MCP23017Config contains the device configuration for the IOCON register. These fields should only be set with values 0 or 1.
func (*MCP23017Config) GetUint8Value ¶
func (mc *MCP23017Config) GetUint8Value() uint8
GetUint8Value returns the configuration data as a packed value.
type MCP23017Driver ¶
type MCP23017Driver struct { Config MCPConf MCP23017Config gobot.Commander gobot.Eventer // contains filtered or unexported fields }
MCP23017Driver contains the driver configuration parameters.
func NewMCP23017Driver ¶
func NewMCP23017Driver(a Connector, options ...func(Config)) *MCP23017Driver
NewMCP23017Driver creates a new Gobot Driver to the MCP23017 i2c port expander. Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver i2c.WithMCP23017Bank(int): MCP23017 bank to use with this driver i2c.WithMCP23017Mirror(int): MCP23017 mirror to use with this driver i2c.WithMCP23017Seqop(int): MCP23017 seqop to use with this driver i2c.WithMCP23017Disslw(int): MCP23017 disslw to use with this driver i2c.WithMCP23017Haen(int): MCP23017 haen to use with this driver i2c.WithMCP23017Odr(int): MCP23017 odr to use with this driver i2c.WithMCP23017Intpol(int): MCP23017 intpol to use with this driver
func (*MCP23017Driver) Connection ¶
func (m *MCP23017Driver) Connection() gobot.Connection
Connection returns the I2c connection.
func (*MCP23017Driver) PinMode ¶
func (m *MCP23017Driver) PinMode(pin, val uint8, portStr string) (err error)
PinMode set pin mode val (0 output 1 input) port (A or B).
func (*MCP23017Driver) ReadGPIO ¶
func (m *MCP23017Driver) ReadGPIO(pin uint8, portStr string) (val uint8, err error)
ReadGPIO reads a value from a given gpio pin (0-7) and a port (A or B).
func (*MCP23017Driver) SetGPIOPolarity ¶
func (m *MCP23017Driver) SetGPIOPolarity(pin uint8, val uint8, portStr string) (err error)
SetGPIOPolarity will change a given pin's polarity based on the value: val = 1 opposite logic state of the input pin. val = 0 same logic state of the input pin.
func (*MCP23017Driver) SetName ¶
func (m *MCP23017Driver) SetName(n string)
SetName set the driver name.
func (*MCP23017Driver) SetPullUp ¶
func (m *MCP23017Driver) SetPullUp(pin uint8, val uint8, portStr string) error
SetPullUp sets the pull up state of a given pin based on the value: val = 1 pull up enabled. val = 0 pull up disabled.
func (*MCP23017Driver) Start ¶
func (m *MCP23017Driver) Start() (err error)
Start writes the device configuration.
type MMA7660Driver ¶
type MMA7660Driver struct { Config // contains filtered or unexported fields }
func NewMMA7660Driver ¶
func NewMMA7660Driver(a Connector, options ...func(Config)) *MMA7660Driver
NewMMA7660Driver creates a new driver with specified i2c interface Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*MMA7660Driver) Acceleration ¶
func (h *MMA7660Driver) Acceleration(x, y, z float64) (ax, ay, az float64)
Acceleration returns the acceleration of the provided x, y, z
func (*MMA7660Driver) Connection ¶
func (h *MMA7660Driver) Connection() gobot.Connection
Connection returns the connection for the Driver
func (*MMA7660Driver) Halt ¶
func (h *MMA7660Driver) Halt() (err error)
Halt returns true if devices is halted successfully
func (*MMA7660Driver) Name ¶
func (h *MMA7660Driver) Name() string
Name returns the Name for the Driver
func (*MMA7660Driver) SetName ¶
func (h *MMA7660Driver) SetName(n string)
SetName sets the Name for the Driver
func (*MMA7660Driver) Start ¶
func (h *MMA7660Driver) Start() (err error)
Start initialized the mma7660
type MPL115A2Driver ¶
type MPL115A2Driver struct { Config gobot.Eventer A0 float32 B1 float32 B2 float32 C12 float32 // contains filtered or unexported fields }
MPL115A2Driver is a Gobot Driver for the MPL115A2 I2C digitial pressure/temperature sensor.
func NewMPL115A2Driver ¶
func NewMPL115A2Driver(a Connector, options ...func(Config)) *MPL115A2Driver
NewMPL115A2Driver creates a new Gobot Driver for an MPL115A2 I2C Pressure/Temperature sensor.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*MPL115A2Driver) Connection ¶
func (h *MPL115A2Driver) Connection() gobot.Connection
Connection returns the Connection of the device.
func (*MPL115A2Driver) Halt ¶
func (h *MPL115A2Driver) Halt() (err error)
Halt returns true if devices is halted successfully
func (*MPL115A2Driver) Name ¶
func (h *MPL115A2Driver) Name() string
Name returns the name of the device.
func (*MPL115A2Driver) Pressure ¶
func (h *MPL115A2Driver) Pressure() (p float32)
Pressure fetches the latest data from the MPL115A2, and returns the pressure
func (*MPL115A2Driver) SetName ¶
func (h *MPL115A2Driver) SetName(n string)
SetName sets the name of the device.
func (*MPL115A2Driver) Start ¶
func (h *MPL115A2Driver) Start() (err error)
Start writes initialization bytes and reads from adaptor using specified interval to accelerometer andtemperature data
func (*MPL115A2Driver) Temperature ¶
func (h *MPL115A2Driver) Temperature() (t float32)
Temperature fetches the latest data from the MPL115A2, and returns the temperature
type MPU6050Driver ¶
type MPU6050Driver struct { Config Accelerometer ThreeDData Gyroscope ThreeDData Temperature int16 gobot.Eventer // contains filtered or unexported fields }
MPU6050Driver is a new Gobot Driver for an MPU6050 I2C Accelerometer/Gyroscope.
func NewMPU6050Driver ¶
func NewMPU6050Driver(a Connector, options ...func(Config)) *MPU6050Driver
NewMPU6050Driver creates a new Gobot Driver for an MPU6050 I2C Accelerometer/Gyroscope.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*MPU6050Driver) Connection ¶
func (h *MPU6050Driver) Connection() gobot.Connection
Connection returns the connection for the device.
func (*MPU6050Driver) GetData ¶ added in v1.2.0
func (h *MPU6050Driver) GetData() (err error)
GetData fetches the latest data from the MPU6050
func (*MPU6050Driver) Halt ¶
func (h *MPU6050Driver) Halt() (err error)
Halt returns true if devices is halted successfully
func (*MPU6050Driver) Name ¶
func (h *MPU6050Driver) Name() string
Name returns the name of the device.
func (*MPU6050Driver) SetName ¶
func (h *MPU6050Driver) SetName(n string)
SetName sets the name of the device.
func (*MPU6050Driver) Start ¶
func (h *MPU6050Driver) Start() (err error)
Start writes initialization bytes to sensor
type SHT3xDriver ¶ added in v1.1.0
SHT3xDriver is a Driver for a SHT3x humidity and temperature sensor
func NewSHT3xDriver ¶ added in v1.1.0
func NewSHT3xDriver(a Connector, options ...func(Config)) *SHT3xDriver
NewSHT3xDriver creates a new driver with specified i2c interface Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*SHT3xDriver) Accuracy ¶ added in v1.1.0
func (s *SHT3xDriver) Accuracy() byte
Accuracy returns the accuracy of the sampling
func (*SHT3xDriver) Connection ¶ added in v1.1.0
func (s *SHT3xDriver) Connection() gobot.Connection
Connection returns the connection for this Driver
func (*SHT3xDriver) Halt ¶ added in v1.1.0
func (s *SHT3xDriver) Halt() (err error)
Halt returns true if devices is halted successfully
func (*SHT3xDriver) Heater ¶ added in v1.1.0
func (s *SHT3xDriver) Heater() (status bool, err error)
Heater returns true if the heater is enabled
func (*SHT3xDriver) Name ¶ added in v1.1.0
func (s *SHT3xDriver) Name() string
Name returns the name for this Driver
func (*SHT3xDriver) Sample ¶ added in v1.1.0
func (s *SHT3xDriver) Sample() (temp float32, rh float32, err error)
Sample returns the temperature in celsius and relative humidity for one sample
func (*SHT3xDriver) SerialNumber ¶ added in v1.1.0
func (s *SHT3xDriver) SerialNumber() (sn uint32, err error)
SerialNumber returns the serial number of the chip
func (*SHT3xDriver) SetAccuracy ¶ added in v1.1.0
func (s *SHT3xDriver) SetAccuracy(a byte) (err error)
SetAccuracy sets the accuracy of the sampling
func (*SHT3xDriver) SetAddress ¶ added in v1.1.0
func (s *SHT3xDriver) SetAddress(address int)
SetAddress sets the address of the device
func (*SHT3xDriver) SetHeater ¶ added in v1.1.0
func (s *SHT3xDriver) SetHeater(enabled bool) (err error)
SetHeater enables or disables the heater on the device
func (*SHT3xDriver) SetName ¶ added in v1.1.0
func (s *SHT3xDriver) SetName(n string)
SetName sets the name for this Driver
func (*SHT3xDriver) Start ¶ added in v1.1.0
func (s *SHT3xDriver) Start() (err error)
Start initializes the SHT3x
type TSL2561Driver ¶ added in v1.3.0
type TSL2561Driver struct { Config // contains filtered or unexported fields }
TSL2561Driver is the gobot driver for the Adafruit Digital Luminosity/Lux/Light Sensor
Datasheet: http://www.adafruit.com/datasheets/TSL2561.pdf
Ported from the Adafruit driver at https://github.com/adafruit/Adafruit_TSL2561 by K. Townsend
func NewTSL2561Driver ¶ added in v1.3.0
func NewTSL2561Driver(conn Connector, options ...func(Config)) *TSL2561Driver
NewTSL2561Driver creates a new driver for the TSL2561 device.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver i2c.WithTSL2561Gain1X: sets the gain to 1X i2c.WithTSL2561Gain16X: sets the gain to 16X i2c.WithTSL2561AutoGain: turns on auto gain i2c.WithTSL2561IntegrationTime13MS: sets integration time to 13ms i2c.WithTSL2561IntegrationTime101MS: sets integration time to 101ms i2c.WithTSL2561IntegrationTime402MS: sets integration time to 402ms
func (*TSL2561Driver) CalculateLux ¶ added in v1.3.0
func (d *TSL2561Driver) CalculateLux(broadband uint16, ir uint16) (lux uint32)
CalculateLux converts raw sensor values to the standard SI Lux equivalent. Returns 65536 if the sensor is saturated.
func (*TSL2561Driver) Connection ¶ added in v1.3.0
func (d *TSL2561Driver) Connection() gobot.Connection
Connection returns the connection of the device.
func (*TSL2561Driver) GetLuminocity ¶ added in v1.3.0
func (d *TSL2561Driver) GetLuminocity() (broadband uint16, ir uint16, err error)
GetLuminocity gets the broadband and IR only values from the TSL2561, adjusting gain if auto-gain is enabled
func (*TSL2561Driver) Halt ¶ added in v1.3.0
func (d *TSL2561Driver) Halt() error
Halt stops the device
func (*TSL2561Driver) Name ¶ added in v1.3.0
func (d *TSL2561Driver) Name() string
Name returns the name of the device.
func (*TSL2561Driver) SetGain ¶ added in v1.3.0
func (d *TSL2561Driver) SetGain(gain TSL2561Gain) error
SetGain adjusts the TSL2561 gain (sensitivity to light)
func (*TSL2561Driver) SetIntegrationTime ¶ added in v1.3.0
func (d *TSL2561Driver) SetIntegrationTime(time TSL2561IntegrationTime) error
SetIntegrationTime sets integrations time for the TSL2561
func (*TSL2561Driver) SetName ¶ added in v1.3.0
func (d *TSL2561Driver) SetName(name string)
SetName sets the name of the device.
func (*TSL2561Driver) Start ¶ added in v1.3.0
func (d *TSL2561Driver) Start() (err error)
Start initializes the device.
type TSL2561Gain ¶ added in v1.3.0
type TSL2561Gain int
TSL2561Gain is the type of all valid gain settings
const ( // TSL2561Gain1X gain == 1x TSL2561Gain1X TSL2561Gain = 0x00 // No gain // TSL2561Gain16X gain == 16x TSL2561Gain16X = 0x10 // 16x gain )
type TSL2561IntegrationTime ¶ added in v1.3.0
type TSL2561IntegrationTime int
TSL2561IntegrationTime is the type of all valid integration time settings
const ( // TSL2561IntegrationTime13MS integration time 13ms TSL2561IntegrationTime13MS TSL2561IntegrationTime = iota // 13.7ms // TSL2561IntegrationTime101MS integration time 101ms TSL2561IntegrationTime101MS // 101ms // TSL2561IntegrationTime402MS integration time 402ms TSL2561IntegrationTime402MS // 402ms )
type ThreeDData ¶
type WiichuckDriver ¶
func NewWiichuckDriver ¶
func NewWiichuckDriver(a Connector, options ...func(Config)) *WiichuckDriver
NewWiichuckDriver creates a WiichuckDriver with specified i2c interface.
Params:
conn Connector - the Adaptor to use with this Driver
Optional params:
i2c.WithBus(int): bus to use with this driver i2c.WithAddress(int): address to use with this driver
func (*WiichuckDriver) Connection ¶
func (w *WiichuckDriver) Connection() gobot.Connection
Connection returns the connection for the device.
func (*WiichuckDriver) Halt ¶
func (w *WiichuckDriver) Halt() (err error)
Halt returns true if driver is halted successfully
func (*WiichuckDriver) Name ¶
func (w *WiichuckDriver) Name() string
Name returns the name of the device.
func (*WiichuckDriver) SetName ¶
func (w *WiichuckDriver) SetName(n string)
SetName sets the name of the device.
func (*WiichuckDriver) Start ¶
func (w *WiichuckDriver) Start() (err error)
Start initilizes i2c and reads from adaptor using specified interval to update with new value
Source Files ¶
- adafruit_driver.go
- blinkm_driver.go
- bmp180_driver.go
- doc.go
- drv2605l_driver.go
- grove_drivers.go
- hmc6352_driver.go
- i2c.go
- i2c_config.go
- jhd1313m1_driver.go
- l3gd20h_driver.go
- lidarlite_driver.go
- mcp23017_driver.go
- mma7660_driver.go
- mpl115a2_driver.go
- mpu6050_driver.go
- sht3x_driver.go
- tsl2561_driver.go
- wiichuck_driver.go