README ¶
Microbit
The Microbit is a tiny computer with built-in Bluetooth LE aka Bluetooth 4.0.
How to Install
go get -d -u gobot.io/x/gobot/... && go install gobot.io/x/gobot/platforms/microbit
You must install the Microbit firmware from [@sandeepmistry] located at https://github.com/sandeepmistry/node-bbc-microbit to use the Microbit with Gobot. This firmware is based on the micro:bit template, but with a few changes.
If you have the Gort command line tool installed, you can install the firmware using the following commands:
gort microbit download
gort microbit install /media/mysystem/MICROBIT
Substitute the proper location to your Microbit for /media/mysystem/MICROBIT
in the previous command.
Once the firmware is installed, make sure your rotate your Microbit in a circle to calibrate the magnetometer before your try to connect to it using Gobot, or it will not respond.
You can also follow the firmware installation instructions at https://github.com/sandeepmistry/node-bbc-microbit#flashing-microbit-firmware.
The source code for the firmware is located at https://github.com/sandeepmistry/node-bbc-microbit-firmware however you do not need this source code to install the firmware using the installation instructions.
How to Use
The Gobot platform for the Microbit includes several different drivers, each one corresponding to a different capability:
- AccelerometerDriver
- ButtonDriver
- LEDDriver
- MagnetometerDriver
- TemperatureDriver
The following example uses the LEDDriver:
package main
import (
"os"
"time"
"gobot.io/x/gobot"
"gobot.io/x/gobot/platforms/ble"
"gobot.io/x/gobot/platforms/microbit"
)
func main() {
bleAdaptor := ble.NewClientAdaptor(os.Args[1])
ubit := microbit.NewLEDDriver(bleAdaptor)
work := func() {
ubit.Blank()
gobot.After(1*time.Second, func() {
ubit.WriteText("Hello")
})
gobot.After(7*time.Second, func() {
ubit.Smile()
})
}
robot := gobot.NewRobot("blinkBot",
[]gobot.Connection{bleAdaptor},
[]gobot.Device{ubit},
work,
)
robot.Start()
}
How to Connect
The Microbit is a Bluetooth LE device.
You need to know the BLE ID of the Microbit that you want to connect to.
OSX
To run any of the Gobot BLE code you must use the GODEBUG=cgocheck=0
flag in order to get around some of the issues in the CGo-based implementation.
For example:
GODEBUG=cgocheck=0 go run examples/microbit_blink.go "BBC micro:bit"
OSX uses its own Bluetooth ID system which is different from the IDs used on Linux. The code calls thru the XPC interfaces provided by OSX, so as a result does not need to run under sudo.
Ubuntu
On Linux the BLE code will need to run as a root user account. The easiest way to accomplish this is probably to use go build
to build your program, and then to run the requesting executable using sudo
.
For example:
go build examples/microbit_blink.go
sudo ./microbit_blink "BBC micro:bit"
Windows
Hopefully coming soon...
Documentation ¶
Overview ¶
Package microbit contains the Gobot drivers for the Microbit.
For more information refer to the microbit README: https://github.com/hybridgroup/gobot/blob/master/platforms/microbit/README.md
Index ¶
- Constants
- type AccelerometerData
- type AccelerometerDriver
- type ButtonDriver
- type LEDDriver
- func (b *LEDDriver) Blank() (err error)
- func (b *LEDDriver) Connection() gobot.Connection
- func (b *LEDDriver) Dimond() (err error)
- func (b *LEDDriver) DownLeftArrow() (err error)
- func (b *LEDDriver) DownRightArrow() (err error)
- func (b *LEDDriver) Halt() (err error)
- func (b *LEDDriver) Name() string
- func (b *LEDDriver) ReadMatrix() (data []byte, err error)
- func (b *LEDDriver) ReadScrollingDelay() (delay uint16, err error)
- func (b *LEDDriver) SetName(n string)
- func (b *LEDDriver) Smile() (err error)
- func (b *LEDDriver) Solid() (err error)
- func (b *LEDDriver) Start() (err error)
- func (b *LEDDriver) UpLeftArrow() (err error)
- func (b *LEDDriver) UpRightArrow() (err error)
- func (b *LEDDriver) Wink() (err error)
- func (b *LEDDriver) WriteMatrix(data []byte) (err error)
- func (b *LEDDriver) WriteScrollingDelay(delay uint16) (err error)
- func (b *LEDDriver) WriteText(msg string) (err error)
- type MagnetometerData
- type MagnetometerDriver
- type RawAccelerometerData
- type RawMagnetometerData
- type TemperatureDriver
Constants ¶
const ( // ButtonA event ButtonA = "buttonA" // ButtonB event ButtonB = "buttonB" )
const (
// Accelerometer event
Accelerometer = "accelerometer"
)
const (
// Magnetometer event
Magnetometer = "magnetometer"
)
const (
// Temperature event
Temperature = "temperature"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccelerometerData ¶
type AccelerometerDriver ¶
AccelerometerDriver is the Gobot driver for the Microbit's built-in accelerometer
func NewAccelerometerDriver ¶
func NewAccelerometerDriver(a ble.BLEConnector) *AccelerometerDriver
NewAccelerometerDriver creates a Microbit AccelerometerDriver
func (*AccelerometerDriver) Connection ¶
func (b *AccelerometerDriver) Connection() gobot.Connection
Connection returns the BLE connection
func (*AccelerometerDriver) Halt ¶
func (b *AccelerometerDriver) Halt() (err error)
Halt stops LED driver (void)
func (*AccelerometerDriver) Name ¶
func (b *AccelerometerDriver) Name() string
Name returns the Driver Name
func (*AccelerometerDriver) SetName ¶
func (b *AccelerometerDriver) SetName(n string)
SetName sets the Driver Name
func (*AccelerometerDriver) Start ¶
func (b *AccelerometerDriver) Start() (err error)
Start tells driver to get ready to do work
type ButtonDriver ¶
ButtonDriver is the Gobot driver for the Microbit's built-in buttons
func NewButtonDriver ¶
func NewButtonDriver(a ble.BLEConnector) *ButtonDriver
NewButtonDriver creates a Microbit ButtonDriver
func (*ButtonDriver) Connection ¶
func (b *ButtonDriver) Connection() gobot.Connection
Connection returns the BLE connection
func (*ButtonDriver) SetName ¶
func (b *ButtonDriver) SetName(n string)
SetName sets the Driver Name
func (*ButtonDriver) Start ¶
func (b *ButtonDriver) Start() (err error)
Start tells driver to get ready to do work
type LEDDriver ¶
LEDDriver is the Gobot driver for the Microbit's LED array
func NewLEDDriver ¶
func NewLEDDriver(a ble.BLEConnector) *LEDDriver
NewLEDDriver creates a Microbit LEDDriver
func (*LEDDriver) Connection ¶
func (b *LEDDriver) Connection() gobot.Connection
Connection returns the BLE connection
func (*LEDDriver) DownLeftArrow ¶
DownLeftArrow displays an arrow pointing down and to the left on the Microbit LEDs
func (*LEDDriver) DownRightArrow ¶
DownRightArrow displays an arrow pointing down and to the right on the Microbit LEDs
func (*LEDDriver) ReadMatrix ¶
ReadMatrix read the current LED matrix state
func (*LEDDriver) ReadScrollingDelay ¶
func (*LEDDriver) UpLeftArrow ¶
UpLeftArrow displays an arrow pointing upwards and to the left on the Microbit LEDs
func (*LEDDriver) UpRightArrow ¶
UpRightArrow displays an arrow pointing upwards and to the right on the Microbit LEDs
func (*LEDDriver) WriteMatrix ¶
WriteMatrix writes an array of 5 bytes to set the LED matrix
func (*LEDDriver) WriteScrollingDelay ¶
type MagnetometerData ¶
type MagnetometerDriver ¶
MagnetometerDriver is the Gobot driver for the Microbit's built-in magnetometer
func NewMagnetometerDriver ¶
func NewMagnetometerDriver(a ble.BLEConnector) *MagnetometerDriver
NewMagnetometerDriver creates a Microbit MagnetometerDriver
func (*MagnetometerDriver) Connection ¶
func (b *MagnetometerDriver) Connection() gobot.Connection
Connection returns the BLE connection
func (*MagnetometerDriver) Halt ¶
func (b *MagnetometerDriver) Halt() (err error)
Halt stops LED driver (void)
func (*MagnetometerDriver) Name ¶
func (b *MagnetometerDriver) Name() string
Name returns the Driver Name
func (*MagnetometerDriver) SetName ¶
func (b *MagnetometerDriver) SetName(n string)
SetName sets the Driver Name
func (*MagnetometerDriver) Start ¶
func (b *MagnetometerDriver) Start() (err error)
Start tells driver to get ready to do work
type RawAccelerometerData ¶
type RawMagnetometerData ¶
type TemperatureDriver ¶
TemperatureDriver is the Gobot driver for the Microbit's built-in thermometer
func NewTemperatureDriver ¶
func NewTemperatureDriver(a ble.BLEConnector) *TemperatureDriver
NewTemperatureDriver creates a Microbit TemperatureDriver
func (*TemperatureDriver) Connection ¶
func (b *TemperatureDriver) Connection() gobot.Connection
Connection returns the BLE connection
func (*TemperatureDriver) Halt ¶
func (b *TemperatureDriver) Halt() (err error)
Halt stops Temperature driver (void)
func (*TemperatureDriver) Name ¶
func (b *TemperatureDriver) Name() string
Name returns the Driver Name
func (*TemperatureDriver) SetName ¶
func (b *TemperatureDriver) SetName(n string)
SetName sets the Driver Name
func (*TemperatureDriver) Start ¶
func (b *TemperatureDriver) Start() (err error)
Start tells driver to get ready to do work