hybridgroup.gobot/platforms/sphero
Dmitry Lisin 88188d3ccb Use go.mod friendly version of go.bug.st/serial library 2020-05-13 19:16:41 +02:00
..
bb8 ble: correct spelling error in function name everywhere they occur 2018-04-12 12:25:39 +02:00
ollie Added methods to read Sphero Power States 2019-05-22 11:34:39 +02:00
sprkplus ble: correct spelling error in function name everywhere they occur 2018-04-12 12:25:39 +02:00
LICENSE docs: update copyright date to 2018 2018-02-14 08:24:39 +01:00
README.md Fixing broken link 2018-08-01 19:19:13 -03:00
doc.go docs: correct Sphero README link 2016-12-21 10:56:01 +01:00
sphero_adaptor.go Use go.mod friendly version of go.bug.st/serial library 2020-05-13 19:16:41 +02:00
sphero_adaptor_test.go sphero: increase test coverage 2017-04-06 11:16:48 +02:00
sphero_driver.go sphero: eliminate race conditions 2017-04-02 23:50:07 +02:00
sphero_driver_test.go sphero: increase test coverage 2017-04-06 11:16:48 +02:00
sphero_packets.go Fix misspellings 2016-07-13 10:44:47 -06:00

README.md

Sphero

Sphero is a sophisticated and programmable robot housed in a polycarbonate sphere shell.

The Gobot Sphero Adaptor & Driver makes it easy to interact with Sphero using Go. Once you have your Sphero setup and connected to your computer you can start writing code to make Sphero move, change direction, speed and colors, or detect Sphero events and execute some code when they occur.

Learn more about the Sphero robot go here: http://www.gosphero.com/

How to Install

go get -d -u gobot.io/x/gobot/...

How To Connect

OSX

In order to allow Gobot running on your Mac to access the Sphero, go to "Bluetooth > Open Bluetooth Preferences > Sharing Setup" and make sure that "Bluetooth Sharing" is checked.

Now you must pair with the Sphero. Open System Preferences > Bluetooth. Now with the Bluetooth devices windows open, smack the Sphero until it starts flashing three colors. You should see "Sphero-XXX" pop up as available devices where "XXX" is the first letter of the three colors the sphero is flashing. Pair with that device. Once paired your Sphero will be accessable through the serial device similarly named as /dev/tty.Sphero-XXX-RN-SPP

Ubuntu

Connecting to the Sphero from Ubuntu or any other Linux-based OS can be done entirely from the command line using Gort CLI commands. Here are the steps.

Find the address of the Sphero, by using:

gort scan bluetooth

Pair to Sphero using this command (substituting the actual address of your Sphero):

gort bluetooth pair <address>

Connect to the Sphero using this command (substituting the actual address of your Sphero):

gort bluetooth connect <address>

Windows

You should be able to pair your Sphero using your normal system tray applet for Bluetooth, and then connect to the COM port that is bound to the device, such as COM3.

How to Use

Example of a simple program that makes the Sphero roll.

package main

import (
	"fmt"
	"time"

	"gobot.io/x/gobot"
	"gobot.io/x/gobot/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()
}