hybridgroup.gobot/drivers/i2c/README.md

# I2C

This package provides drivers for [i2c](https://en.wikipedia.org/wiki/I%C2%B2C)devices. It must be used along with an adaptor such as [firmata](https://gobot.io/x/gobot/platforms/firmata) that supports the needed interfaces for i2c devices.

## Getting Started

## Installing
```
go get -d -u gobot.io/x/gobot/...
```

## Hardware Support
Gobot has a extensible system for connecting to hardware devices. The following i2c devices are currently supported:

- Adafruit Motor Hat
- ADS1015 Analog to Digital Converter
- ADS1115 Analog to Digital Converter
- ADXL345 Digital Accelerometer
- BH1750 Digital Luminosity/Lux/Light Sensor
- BlinkM LED
- BME280 Barometric Pressure/Temperature/Altitude/Humidity Sensor
- BMP180 Barometric Pressure/Temperature/Altitude Sensor
- BMP280 Barometric Pressure/Temperature/Altitude Sensor
- DRV2605L Haptic Controller
- Grove Digital Accelerometer
- GrovePi Expansion Board
- Grove RGB LCD
- HMC6352 Compass
- INA3221 Voltage Monitor
- JHD1313M1 LCD Display w/RGB Backlight
- L3GD20H 3-Axis Gyroscope
- LIDAR-Lite
- MCP23017 Port Expander
- MMA7660 3-Axis Accelerometer
- MPL115A2 Barometer
- MPU6050 Accelerometer/Gyroscope
- PCA9685 16-channel 12-bit PWM/Servo Driver
- SHT3x-D Temperature/Humidity
- SSD1306 OLED Display Controller
- TSL2561 Digital Luminosity/Lux/Light Sensor
- Wii Nunchuck Controller

More drivers are coming soon...

## Using A Different Bus or Address

You can set a different I2C address or I2C bus than the default when initializing your I2C drivers by using optional parameters. Here is an example:

```go
blinkm := i2c.NewBlinkMDriver(e, i2c.WithBus(0), i2c.WithAddress(0x09))
```
Update READMEs for each platform 2014-06-09 19:01:53 -07:00			`# I2C`
WIP combine all seperate adaptor and driver repos into a single repo 2014-04-26 03:11:51 -07:00
core: use canonical import domain of gobot.io for all code Signed-off-by: deadprogram <ron@hybridgroup.com> 2016-12-08 13:24:03 +01:00			`This package provides drivers for [i2c](https://en.wikipedia.org/wiki/I%C2%B2C)devices. It must be used along with an adaptor such as [firmata](https://gobot.io/x/gobot/platforms/firmata) that supports the needed interfaces for i2c devices.`
WIP combine all seperate adaptor and driver repos into a single repo 2014-04-26 03:11:51 -07:00
			`## Getting Started`

Update READMEs for each platform 2014-06-09 19:01:53 -07:00			`## Installing`
			```
i2c: small README update Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-02-15 12:41:20 +01:00			`go get -d -u gobot.io/x/gobot/...`
WIP combine all seperate adaptor and driver repos into a single repo 2014-04-26 03:11:51 -07:00			```
Update READMEs for each platform 2014-06-09 19:01:53 -07:00
WIP combine all seperate adaptor and driver repos into a single repo 2014-04-26 03:11:51 -07:00			`## Hardware Support`
			`Gobot has a extensible system for connecting to hardware devices. The following i2c devices are currently supported:`

docs: update list of currently supported i2c devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-01-03 10:22:06 +01:00			`- Adafruit Motor Hat`
i2c: add ads1015 adc to README Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-04-24 17:58:30 +02:00			`- ADS1015 Analog to Digital Converter`
i2c: add ads1115 to list of supported devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-04-27 16:13:29 +02:00			`- ADS1115 Analog to Digital Converter`
docs: add references to new drivers for ADXL345, BH1750, and TM1638. Signed-off-by: Ron Evans <ron@hybridgroup.com> 2018-02-14 09:40:39 +01:00			`- ADXL345 Digital Accelerometer`
added comments for godoc added bh1750 to readme 2018-01-12 16:26:21 +01:00			`- BH1750 Digital Luminosity/Lux/Light Sensor`
docs: update list of currently supported i2c devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-01-03 10:22:06 +01:00			`- BlinkM LED`
i2c: add bme280 and bmp280 to list of supported drivers Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-04-01 13:51:36 +02:00			`- BME280 Barometric Pressure/Temperature/Altitude/Humidity Sensor`
docs: update list of currently supported i2c devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-01-03 10:22:06 +01:00			`- BMP180 Barometric Pressure/Temperature/Altitude Sensor`
i2c: add bme280 and bmp280 to list of supported drivers Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-04-01 13:51:36 +02:00			`- BMP280 Barometric Pressure/Temperature/Altitude Sensor`
i2c: update list of supported i2c devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-02-24 08:19:20 +01:00			`- DRV2605L Haptic Controller`
core: Refactor I2C drivers for new Driver creation signatures Signed-off-by: deadprogram <ron@hybridgroup.com> 2016-09-25 14:08:18 +02:00			`- Grove Digital Accelerometer`
docs: add GrovePi to README Signed-off-by: Ron Evans <ron@hybridgroup.com> 2018-08-23 18:07:08 +02:00			`- GrovePi Expansion Board`
core: Refactor I2C drivers for new Driver creation signatures Signed-off-by: deadprogram <ron@hybridgroup.com> 2016-09-25 14:08:18 +02:00			`- Grove RGB LCD`
			`- HMC6352 Compass`
i2c: add INA3221 Voltage Monitor to README under supported i2c devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-05-05 09:27:08 +02:00			`- INA3221 Voltage Monitor`
docs: update list of currently supported i2c devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-01-03 10:22:06 +01:00			`- JHD1313M1 LCD Display w/RGB Backlight`
			`- L3GD20H 3-Axis Gyroscope`
i2c: update list of supported i2c devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-02-24 08:19:20 +01:00			`- LIDAR-Lite`
core: Refactor I2C drivers for new Driver creation signatures Signed-off-by: deadprogram <ron@hybridgroup.com> 2016-09-25 14:08:18 +02:00			`- MCP23017 Port Expander`
			`- MMA7660 3-Axis Accelerometer`
			`- MPL115A2 Barometer`
Add missing device descriptions to README 2014-12-13 18:50:09 -08:00			`- MPU6050 Accelerometer/Gyroscope`
i2c: add PCA9685 servo driver to README Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-06-23 20:18:02 +02:00			`- PCA9685 16-channel 12-bit PWM/Servo Driver`
Add a driver for the sht3x chip. Signed-off-by: Weston Schmidt <weston_schmidt@alumni.purdue.edu> 2017-01-03 01:21:09 -08:00			`- SHT3x-D Temperature/Humidity`
i2c: add bme280 and bmp280 to list of supported drivers Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-04-01 13:51:36 +02:00			`- SSD1306 OLED Display Controller`
i2c: update list of supported i2c devices Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-02-24 08:19:20 +01:00			`- TSL2561 Digital Luminosity/Lux/Light Sensor`
WIP combine all seperate adaptor and driver repos into a single repo 2014-04-26 03:11:51 -07:00			`- Wii Nunchuck Controller`

			`More drivers are coming soon...`
i2c: example of using optional params Signed-off-by: deadprogram <ron@hybridgroup.com> 2017-02-10 12:01:44 +01:00
			`## Using A Different Bus or Address`

			`You can set a different I2C address or I2C bus than the default when initializing your I2C drivers by using optional parameters. Here is an example:`

			```go
			`blinkm := i2c.NewBlinkMDriver(e, i2c.WithBus(0), i2c.WithAddress(0x09))`
			```