422 lines
16 KiB
Markdown
422 lines
16 KiB
Markdown
[](http://gobot.io/)
|
|
|
|
[](https://godoc.org/gobot.io/x/gobot/v2)
|
|
[](https://circleci.com/gh/hybridgroup/gobot/tree/dev)
|
|
[](https://ci.appveyor.com/project/deadprogram/gobot/branch/dev)
|
|
[](https://codecov.io/gh/hybridgroup/gobot)
|
|
[](https://goreportcard.com/report/hybridgroup/gobot)
|
|
[](https://github.com/hybridgroup/gobot/blob/master/LICENSE.txt)
|
|
|
|
Gobot (<https://gobot.io/>) is a framework using the Go programming language (<https://golang.org/>) for robotics, physical
|
|
computing, and the Internet of Things.
|
|
|
|
It provides a simple, yet powerful way to create solutions that incorporate multiple, different hardware devices at the
|
|
same time.
|
|
|
|
Want to run Go directly on microcontrollers? Check out our sister project TinyGo (<https://tinygo.org/>)
|
|
|
|
## Getting Started
|
|
|
|
### Get in touch
|
|
|
|
Get the Gobot source code by running this commands:
|
|
|
|
```sh
|
|
git clone https://github.com/hybridgroup/gobot.git
|
|
git checkout release
|
|
```
|
|
|
|
Afterwards have a look at the [examples directory](./examples). You need to find an example matching your platform for your
|
|
first test (e.g. "raspi_blink.go"). Than build the binary (cross compile), transfer it to your target and run it.
|
|
|
|
`env GOOS=linux GOARCH=arm GOARM=5 go build -o ./output/my_raspi_bink examples/raspi_blink.go`
|
|
|
|
> Building the code on your local machine with the example code above will create a binary for ARMv5. This is probably not
|
|
> what you need for your specific target platform. Please read also the platform specific documentation in the platform
|
|
> subfolders.
|
|
|
|
### Create your first project
|
|
|
|
Create a new folder and a new Go module project.
|
|
|
|
```sh
|
|
mkdir ~/my_gobot_example
|
|
cd ~/my_gobot_example
|
|
go mod init my.gobot.example.com
|
|
```
|
|
|
|
Copy your example file besides the go.mod file, import the requirements and build.
|
|
|
|
```sh
|
|
cp /<path to gobot folder>/examples/raspi_blink.go ~/my_gobot_example/
|
|
go mod tidy
|
|
env GOOS=linux GOARCH=arm GOARM=5 go build -o ./output/my_raspi_bink raspi_blink.go
|
|
```
|
|
|
|
Now you are ready to modify the example and test your changes. Start by removing the build directives at the beginning
|
|
of the file.
|
|
|
|
## Examples
|
|
|
|
### Gobot with Arduino
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"time"
|
|
|
|
"gobot.io/x/gobot/v2"
|
|
"gobot.io/x/gobot/v2/drivers/gpio"
|
|
"gobot.io/x/gobot/v2/platforms/firmata"
|
|
)
|
|
|
|
func main() {
|
|
firmataAdaptor := firmata.NewAdaptor("/dev/ttyACM0")
|
|
led := gpio.NewLedDriver(firmataAdaptor, "13")
|
|
|
|
work := func() {
|
|
gobot.Every(1*time.Second, func() {
|
|
led.Toggle()
|
|
})
|
|
}
|
|
|
|
robot := gobot.NewRobot("bot",
|
|
[]gobot.Connection{firmataAdaptor},
|
|
[]gobot.Device{led},
|
|
work,
|
|
)
|
|
|
|
robot.Start()
|
|
}
|
|
```
|
|
|
|
### Gobot with Sphero
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
"gobot.io/x/gobot/v2"
|
|
"gobot.io/x/gobot/v2/platforms/sphero"
|
|
)
|
|
|
|
func main() {
|
|
adaptor := sphero.NewAdaptor("/dev/rfcomm0")
|
|
driver := sphero.NewSpheroDriver(adaptor)
|
|
|
|
work := func() {
|
|
gobot.Every(3*time.Second, func() {
|
|
driver.Roll(30, uint16(gobot.Rand(360)))
|
|
})
|
|
}
|
|
|
|
robot := gobot.NewRobot("sphero",
|
|
[]gobot.Connection{adaptor},
|
|
[]gobot.Device{driver},
|
|
work,
|
|
)
|
|
|
|
robot.Start()
|
|
}
|
|
```
|
|
|
|
### "Metal" Gobot
|
|
|
|
You can use the entire Gobot framework as shown in the examples above ("Classic" Gobot), or you can pick and choose from
|
|
the various Gobot packages to control hardware with nothing but pure idiomatic Golang code ("Metal" Gobot). For example:
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"gobot.io/x/gobot/v2/drivers/gpio"
|
|
"gobot.io/x/gobot/v2/platforms/intel-iot/edison"
|
|
"time"
|
|
)
|
|
|
|
func main() {
|
|
e := edison.NewAdaptor()
|
|
e.Connect()
|
|
|
|
led := gpio.NewLedDriver(e, "13")
|
|
led.Start()
|
|
|
|
for {
|
|
led.Toggle()
|
|
time.Sleep(1000 * time.Millisecond)
|
|
}
|
|
}
|
|
```
|
|
|
|
### "Master" Gobot
|
|
|
|
You can also use the full capabilities of the framework aka "Master Gobot" to control swarms of robots or other features
|
|
such as the built-in API server. For example:
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
"gobot.io/x/gobot/v2"
|
|
"gobot.io/x/gobot/v2/api"
|
|
"gobot.io/x/gobot/v2/platforms/sphero"
|
|
)
|
|
|
|
func NewSwarmBot(port string) *gobot.Robot {
|
|
spheroAdaptor := sphero.NewAdaptor(port)
|
|
spheroDriver := sphero.NewSpheroDriver(spheroAdaptor)
|
|
spheroDriver.SetName("Sphero" + port)
|
|
|
|
work := func() {
|
|
spheroDriver.Stop()
|
|
|
|
spheroDriver.On(sphero.Collision, func(data interface{}) {
|
|
fmt.Println("Collision Detected!")
|
|
})
|
|
|
|
gobot.Every(1*time.Second, func() {
|
|
spheroDriver.Roll(100, uint16(gobot.Rand(360)))
|
|
})
|
|
gobot.Every(3*time.Second, func() {
|
|
spheroDriver.SetRGB(uint8(gobot.Rand(255)),
|
|
uint8(gobot.Rand(255)),
|
|
uint8(gobot.Rand(255)),
|
|
)
|
|
})
|
|
}
|
|
|
|
robot := gobot.NewRobot("sphero",
|
|
[]gobot.Connection{spheroAdaptor},
|
|
[]gobot.Device{spheroDriver},
|
|
work,
|
|
)
|
|
|
|
return robot
|
|
}
|
|
|
|
func main() {
|
|
master := gobot.NewMaster()
|
|
api.NewAPI(master).Start()
|
|
|
|
spheros := []string{
|
|
"/dev/rfcomm0",
|
|
"/dev/rfcomm1",
|
|
"/dev/rfcomm2",
|
|
"/dev/rfcomm3",
|
|
}
|
|
|
|
for _, port := range spheros {
|
|
master.AddRobot(NewSwarmBot(port))
|
|
}
|
|
|
|
master.Start()
|
|
}
|
|
```
|
|
|
|
## Hardware Support
|
|
|
|
Gobot has a extensible system for connecting to hardware devices. The following robotics and physical computing
|
|
platforms are currently supported:
|
|
|
|
- [Arduino](http://www.arduino.cc/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/firmata)
|
|
- Audio <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/audio)
|
|
- [Beaglebone Black](http://beagleboard.org/boards) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/beaglebone)
|
|
- [Beaglebone PocketBeagle](http://beagleboard.org/pocket/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/beaglebone)
|
|
- [Bluetooth LE](https://www.bluetooth.com/what-is-bluetooth-technology/bluetooth-technology-basics/low-energy) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/ble)
|
|
- [C.H.I.P](http://www.nextthing.co/pages/chip) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/chip)
|
|
- [C.H.I.P Pro](https://docs.getchip.com/chip_pro.html) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/chip)
|
|
- [Digispark](http://digistump.com/products/1) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/digispark)
|
|
- [DJI Tello](https://www.ryzerobotics.com/tello) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/dji/tello)
|
|
- [DragonBoard](https://developer.qualcomm.com/hardware/dragonboard-410c) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/dragonboard)
|
|
- [ESP8266](http://esp8266.net/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/firmata)
|
|
- [GoPiGo 3](https://www.dexterindustries.com/gopigo3/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/dexter/gopigo3)
|
|
- [Intel Curie](https://www.intel.com/content/www/us/en/products/boards-kits/curie.html) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/intel-iot/curie)
|
|
- [Intel Edison](http://www.intel.com/content/www/us/en/do-it-yourself/edison.html) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/intel-iot/edison)
|
|
- [Intel Joule](http://intel.com/joule/getstarted) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/intel-iot/joule)
|
|
- [Jetson Nano](https://developer.nvidia.com/embedded/jetson-nano/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/jetson)
|
|
- [Joystick](http://en.wikipedia.org/wiki/Joystick) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/joystick)
|
|
- [Keyboard](https://en.wikipedia.org/wiki/Computer_keyboard) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/keyboard)
|
|
- [Leap Motion](https://www.leapmotion.com/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/leap)
|
|
- [MavLink](http://qgroundcontrol.org/mavlink/start) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/mavlink)
|
|
- [MegaPi](http://www.makeblock.com/megapi) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/megapi)
|
|
- [Microbit](http://microbit.org/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/microbit)
|
|
- [MQTT](http://mqtt.org/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/mqtt)
|
|
- [NanoPi NEO](https://wiki.friendlyelec.com/wiki/index.php/NanoPi_NEO) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/nanopi)
|
|
- [NATS](http://nats.io/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/nats)
|
|
- [Neurosky](http://neurosky.com/products-markets/eeg-biosensors/hardware/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/neurosky)
|
|
- [OpenCV](http://opencv.org/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/opencv)
|
|
- [Particle](https://www.particle.io/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/particle)
|
|
- [Parrot ARDrone 2.0](http://ardrone2.parrot.com/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/parrot/ardrone)
|
|
- [Parrot Bebop](http://www.parrot.com/usa/products/bebop-drone/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/parrot/bebop)
|
|
- [Parrot Minidrone](https://www.parrot.com/us/minidrones) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/parrot/minidrone)
|
|
- [Pebble](https://www.getpebble.com/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/pebble)
|
|
- [Radxa Rock Pi 4](https://wiki.radxa.com/Rock4/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/rockpi)
|
|
- [Raspberry Pi](http://www.raspberrypi.org/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/raspi)
|
|
- [Sphero](http://www.sphero.com/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/sphero)
|
|
- [Sphero BB-8](http://www.sphero.com/bb8) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/sphero/bb8)
|
|
- [Sphero Ollie](http://www.sphero.com/ollie) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/sphero/ollie)
|
|
- [Sphero SPRK+](http://www.sphero.com/sprk-plus) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/sphero/sprkplus)
|
|
- [Tinker Board](https://www.asus.com/us/Single-Board-Computer/Tinker-Board/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/tinkerboard)
|
|
- [UP2](http://www.up-board.org/upsquared/) <=> [Package](https://github.com/hybridgroup/gobot/tree/master/platforms/upboard/up2)
|
|
|
|
Support for many devices that use General Purpose Input/Output (GPIO) have
|
|
a shared set of drivers provided using the `gobot/drivers/gpio` package:
|
|
|
|
- [GPIO](https://en.wikipedia.org/wiki/General_Purpose_Input/Output) <=> [Drivers](https://github.com/hybridgroup/gobot/tree/master/drivers/gpio)
|
|
- AIP1640 LED
|
|
- Button
|
|
- Buzzer
|
|
- Direct Pin
|
|
- EasyDriver
|
|
- 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
|
|
|
|
Support for many devices that use Analog Input/Output (AIO) have
|
|
a shared set of drivers provided using the `gobot/drivers/aio` package:
|
|
|
|
- [AIO](https://en.wikipedia.org/wiki/Analog-to-digital_converter) <=> [Drivers](https://github.com/hybridgroup/gobot/tree/master/drivers/aio)
|
|
- Analog Sensor
|
|
- Grove Light Sensor
|
|
- Grove Piezo Vibration Sensor
|
|
- Grove Rotary Dial
|
|
- Grove Sound Sensor
|
|
- Grove Temperature Sensor
|
|
|
|
Support for devices that use Inter-Integrated Circuit (I2C) have a shared set of
|
|
drivers provided using the `gobot/drivers/i2c` package:
|
|
|
|
- [I2C](https://en.wikipedia.org/wiki/I%C2%B2C) <=> [Drivers](https://github.com/hybridgroup/gobot/tree/master/drivers/i2c)
|
|
- Adafruit 2x16 RGB-LCD with 5 keys
|
|
- 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
|
|
- BMP388 Barometric Pressure/Temperature/Altitude Sensor
|
|
- DRV2605L Haptic Controller
|
|
- Generic driver for read and write values to/from register address
|
|
- Grove Digital Accelerometer
|
|
- GrovePi Expansion Board
|
|
- Grove RGB LCD
|
|
- HMC6352 Compass
|
|
- HMC5883L 3-Axis Digital Compass
|
|
- INA3221 Voltage Monitor
|
|
- JHD1313M1 LCD Display w/RGB Backlight
|
|
- L3GD20H 3-Axis Gyroscope
|
|
- LIDAR-Lite
|
|
- MCP23017 Port Expander
|
|
- MMA7660 3-Axis Accelerometer
|
|
- MPL115A2 Barometric Pressure/Temperature
|
|
- MPU6050 Accelerometer/Gyroscope
|
|
- PCA9501 8-bit I/O port with interrupt, 2-kbit EEPROM
|
|
- PCA953x LED Dimmer for PCA9530 (2-bit), PCA9533 (4-bit), PCA9531 (8-bit), PCA9532 (16-bit)
|
|
- PCA9685 16-channel 12-bit PWM/Servo Driver
|
|
- PCF8583 clock and calendar or event counter, 240 x 8-bit RAM
|
|
- PCF8591 8-bit 4xA/D & 1xD/A converter
|
|
- SHT2x Temperature/Humidity
|
|
- SHT3x-D Temperature/Humidity
|
|
- SSD1306 OLED Display Controller
|
|
- TSL2561 Digital Luminosity/Lux/Light Sensor
|
|
- Wii Nunchuck Controller
|
|
- YL-40 Brightness/Temperature sensor, Potentiometer, analog input, analog output Driver
|
|
|
|
Support for devices that use Serial Peripheral Interface (SPI) have
|
|
a shared set of drivers provided using the `gobot/drivers/spi` package:
|
|
|
|
- [SPI](https://en.wikipedia.org/wiki/Serial_Peripheral_Interface_Bus) <=> [Drivers](https://github.com/hybridgroup/gobot/tree/master/drivers/spi)
|
|
- APA102 Programmable LEDs
|
|
- MCP3002 Analog/Digital Converter
|
|
- MCP3004 Analog/Digital Converter
|
|
- MCP3008 Analog/Digital Converter
|
|
- MCP3202 Analog/Digital Converter
|
|
- MCP3204 Analog/Digital Converter
|
|
- MCP3208 Analog/Digital Converter
|
|
- MCP3304 Analog/Digital Converter
|
|
- MFRC522 RFID Card Reader
|
|
- SSD1306 OLED Display Controller
|
|
|
|
More platforms and drivers are coming soon...
|
|
|
|
## API
|
|
|
|
Gobot includes a RESTful API to query the status of any robot running within a group, including the connection and
|
|
device status, and execute device commands.
|
|
|
|
To activate the API, import the `gobot.io/x/gobot/v2/api` package and instantiate the `API` like this:
|
|
|
|
```go
|
|
master := gobot.NewMaster()
|
|
api.NewAPI(master).Start()
|
|
```
|
|
|
|
You can also specify the api host and port, and turn on authentication:
|
|
|
|
```go
|
|
master := gobot.NewMaster()
|
|
server := api.NewAPI(master)
|
|
server.Port = "4000"
|
|
server.AddHandler(api.BasicAuth("gort", "klatuu"))
|
|
server.Start()
|
|
```
|
|
|
|
You may access the [robeaux](https://github.com/hybridgroup/robeaux) React.js interface with Gobot by navigating to `http://localhost:3000/index.html`.
|
|
|
|
## CLI
|
|
|
|
Gobot uses the Gort [http://gort.io](http://gort.io) Command Line Interface (CLI) so you can access important features
|
|
right from the command line. We call it "RobotOps", aka "DevOps For Robotics". You can scan, connect, update device
|
|
firmware, and more!
|
|
|
|
## Documentation
|
|
|
|
We're always adding documentation to our web site at <https://gobot.io/> please check there as we continue to work on Gobot
|
|
|
|
Thank you!
|
|
|
|
## Need help?
|
|
|
|
- Issues: <https://github.com/hybridgroup/gobot/issues>
|
|
- Twitter: [@gobotio](https://twitter.com/gobotio)
|
|
- Slack: [https://gophers.slack.com/messages/C0N5HDB08](https://gophers.slack.com/messages/C0N5HDB08)
|
|
- Mailing list: <https://groups.google.com/forum/#!forum/gobotio>
|
|
|
|
## Contributing
|
|
|
|
For our contribution guidelines, please go to [https://github.com/hybridgroup/gobot/blob/master/CONTRIBUTING.md
|
|
](https://github.com/hybridgroup/gobot/blob/master/CONTRIBUTING.md
|
|
).
|
|
|
|
Gobot is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
|
|
[You can read about it here](https://github.com/hybridgroup/gobot/tree/master/CODE_OF_CONDUCT.md).
|
|
|
|
## License
|
|
|
|
Copyright (c) 2013-2020 The Hybrid Group. Licensed under the Apache 2.0 license.
|
|
|
|
The Contributor Covenant is released under the Creative Commons Attribution 4.0 International Public License, which
|
|
requires that attribution be included.
|