MCPcopy Index your code
hub / github.com/hybridgroup/gobot

github.com/hybridgroup/gobot @v2.6.0 sqlite

repository ↗ · DeepWiki ↗ · release v2.6.0 ↗
6,588 symbols 25,810 edges 822 files 3,203 documented · 49%
README

Gobot

GoDoc CircleCI Build status Appveyor Build status codecov Go Report Card License

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:

git clone https://github.com/hybridgroup/gobot.git
git checkout release

Afterwards have a look at the examples directory. 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.

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.

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

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() {
      if err := led.Toggle(); err != nil {
        fmt.Println(err)
      }
    })
  }

  robot := gobot.NewRobot("bot",
    []gobot.Connection{firmataAdaptor},
    []gobot.Device{led},
    work,
  )

  if err := robot.Start(); err != nil {
    panic(err)
  }
}

Gobot with Sphero

package main

import (
  "fmt"
  "time"

  "gobot.io/x/gobot/v2"
  "gobot.io/x/gobot/v2/drivers/serial"
  "gobot.io/x/gobot/v2/platforms/serialport"
)

func main() {
  adaptor := serialport.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,
  )

  if err := robot.Start(); err != nil {
        panic(err)
    }
}

"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:

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()
  if err := e.Connect(); err != nil {
    fmt.Println(err)
  }

  led := gpio.NewLedDriver(e, "13")
  if err := led.Start(); err != nil {
    fmt.Println(err)
  }

  for {
    if err := led.Toggle(); err != nil {
      fmt.Println(err)
    }
    time.Sleep(1000 * time.Millisecond)
  }
}

"Manager" Gobot

You can also use the full capabilities of the framework aka "Manager Gobot" to control swarms of robots or other features such as the built-in API server. For example:

package main

import (
  "fmt"
  "time"

  "gobot.io/x/gobot/v2"
  "gobot.io/x/gobot/v2/api"
  "gobot.io/x/gobot/v2/drivers/common/spherocommon"
  "gobot.io/x/gobot/v2/drivers/serial"
  "gobot.io/x/gobot/v2/platforms/serialport"
)

func NewSwarmBot(port string) *gobot.Robot {
  spheroAdaptor := serialport.NewAdaptor(port)
  spheroDriver := sphero.NewSpheroDriver(spheroAdaptor, serial.WithName("Sphero" + port))

  work := func() {
    spheroDriver.Stop()

    _ = spheroDriver.On(sphero.CollisionEvent, 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() {
  manager := gobot.NewManager()
  api.NewAPI(manager).Start()

  spheros := []string{
    "/dev/rfcomm0",
    "/dev/rfcomm1",
    "/dev/rfcomm2",
    "/dev/rfcomm3",
  }

  for _, port := range spheros {
    manager.AddRobot(NewSwarmBot(port))
  }

  if err := manager.Start(); err != nil {
    panic(err)
  }
}

Hardware Support

Gobot has a extensible system for connecting to hardware devices. The following robotics and physical computing platforms are currently supported:

Support for many devices that use Analog Input/Output (AIO) have a shared set of drivers provided using the gobot/drivers/aio package:

  • AIO <=> Drivers
  • Analog Actuator
  • Analog Sensor
  • Grove Light Sensor
  • Grove Piezo Vibration Sensor
  • Grove Rotary Dial
  • Grove Sound Sensor
  • Grove Temperature Sensor
  • Temperature Sensor (supports linear and NTC thermistor in normal and inverse mode)
  • Thermal Zone Temperature Sensor

Support for many devices that use Bluetooth LE (BLE) have a shared set of drivers provided using the gobot/drivers/ble package:

  • BLE <=> Drivers
  • Battery Service
  • Device Information Service
  • Generic Access Service
  • Microbit: AccelerometerDriver
  • Microbit: ButtonDriver
  • Microbit: IOPinDriver
  • Microbit: LEDDriver
  • Microbit: MagnetometerDriver
  • Microbit: TemperatureDriver
  • Sphero: BB8
  • Sphero: Ollie
  • Sphero: SPRK+

Support for many devices that use General Purpose Input/Output (GPIO) have a shared set of drivers provided using

Extension points exported contracts — how you extend this code

Driver (Interface)
Driver is the interface that describes a driver in gobot [28 implementers]
driver.go
AnalogPinner (Interface)
AnalogPinner is the interface for system analog io interactions [23 implementers]
adaptor.go
OptionApplier (Interface)
OptionApplier needs to be implemented by each configurable option type [13 implementers]
drivers/serial/serial_driver.go
PwmWriter (Interface)
PwmWriter interface represents an Adaptor which has Pwm capabilities [9 implementers]
drivers/gpio/gpio_driver.go
OptionApplier (Interface)
OptionApplier needs to be implemented by each configurable option type [13 implementers]
drivers/ble/ble_driver.go
AnalogReader (Interface)
AnalogReader interface represents an Adaptor which has AnalogRead capabilities [18 implementers]
drivers/aio/aio_driver.go
AccesserOptionApplier (Interface)
accesserOptionApplier is the interface for system options. This provides the possibility for change the systems behavior [13 …
system/systemoptions.go
DigitalPinsOptionApplier (Interface)
DigitalPinsOptionApplier is the interface for digital adaptors options. This provides the possibility for change the pla [13 …
platforms/adaptors/digitalpinsadaptoroptions.go

Core symbols most depended-on inside this repo

Write
called by 1128
system/system.go
Read
called by 807
platforms/opencv/camera_driver.go
Start
called by 331
driver.go
Start
called by 246
robot.go
On
called by 236
platforms/nats/nats_driver.go
Every
called by 210
robot_work.go
On
called by 189
eventer.go
Run
called by 187
drivers/gpio/stepper_driver.go

Shape

Method 3,033
Function 2,834
Struct 514
TypeAlias 112
Interface 87
FuncType 8

Languages

Go100%

Modules by API surface

platforms/mavlink/common/common.go806 symbols
adaptor.go96 symbols
api/robeaux/robeaux.go90 symbols
platforms/dji/tello/driver.go58 symbols
system/system.go53 symbols
platforms/dexter/gopigo3/driver.go47 symbols
platforms/adaptors/digitalpinsadaptoroptions.go41 symbols
platforms/parrot/bebop/client/client.go40 symbols
platforms/intel-iot/curie/imu_driver_test.go40 symbols
platforms/dexter/gopigo3/driver_test.go40 symbols
platforms/intel-iot/edison/edison_adaptor_test.go38 symbols
platforms/firmata/firmata_adaptor.go38 symbols

Dependencies from manifests, versioned

github.com/0xcafed00d/joystickv1.0.1 · 1×
github.com/bmizerany/patv0.0.0-2021040621384 · 1×
github.com/creack/goselectv0.1.3 · 1×
github.com/donovanhide/eventsourcev0.0.0-2021083008255 · 1×
github.com/eclipse/paho.mqtt.golangv1.5.1 · 1×
github.com/go-ole/go-olev1.3.0 · 1×
github.com/godbus/dbus/v5v5.1.0 · 1×
github.com/gofrs/uuidv4.4.0+incompatible · 1×
github.com/hashicorp/errwrapv1.1.0 · 1×

For agents

$ claude mcp add gobot \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact