joule

README

Edison

The Intel Joule is a WiFi and Bluetooth enabled development platform for the Internet of Things.

For more info about the Intel Joule platform go to:

http://www.intel.com/joule

How to Install

You would normally install Go and Gobot on your workstation. Once installed, cross compile your program on your workstation, transfer the final executable to your Intel Joule, and run the program on the Intel Joule itself as documented here.

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

Setting up your Intel Joule

Everything you need to get started with the Joule is in the Intel Getting Started Guide located at:

https://intel.com/joule/getstarted

Don't forget to configure your Joule's WiFi connection and update your Joule to the latest firmware image. Gobot has been tested using the reference OS based on Ostro.

How To Use

package main

import (
	"time"

	"gobot.io/x/gobot"
	"gobot.io/x/gobot/drivers/gpio"
	"gobot.io/x/gobot/platforms/intel-iot/joule"
)

func main() {
	e := joule.NewAdaptor()
	led := gpio.NewLedDriver(e, "GP103")

	work := func() {
		gobot.Every(1*time.Second, func() {
			led.Toggle()
		})
	}

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

	robot.Start()
}

You can read the full API documentation online.

How to Connect

Compiling

Compile your Gobot program on your workstation like this:

$ GOARCH=386 GOOS=linux go build joule_blink.go

Once you have compiled your code, you can you can upload your program and execute it on the Intel Joule from your workstation using the scp and ssh commands like this:

$ scp joule_blink root@<IP of your device>:/home/root/
$ ssh -t root@<IP of your device> "./joule_blink"

At this point you should see one of the onboard LEDs blinking. Press control + c to exit.

To update the program after you made a change, you will need to scp it over once again and start it from the command line (via screen).

Pin Mapping

The Gobot pin mapping for the Intel Joule uses a naming system based on how the pins are labeled on the board itself.

There are 2 jumpers on the Joule expansion board, labeled "J12" and "J13". There are 2 rows of pins on each jumper, labeled from 1 to 40. So to use the 26th pin of jumper J12, you use pin name "J12_26".

In addition, there are pins that control the build-in LEDs (pins GP100 thru GP103) as used in the example above.

The i2c interfaces on the Intel Joule developer kit board require that you terminate the SDA & SCL lines using 2 10K resistors pulled up to the voltage used for the i2c device, for example 5V.

Documentation

Overview

Package joule contains the Gobot adaptor for the Intel Joule.

For further information refer to intel-iot README: https://github.com/hybridgroup/gobot/blob/master/platforms/intel-iot/joule/README.md

Index

• type Adaptor
  • func NewAdaptor() *Adaptor
  • func (e *Adaptor) Connect() (err error)
  • func (e *Adaptor) DigitalPin(pin string, dir string) (sysfsPin sysfs.DigitalPinner, err error)
  • func (e *Adaptor) DigitalRead(pin string) (i int, err error)
  • func (e *Adaptor) DigitalWrite(pin string, val byte) (err error)
  • func (e *Adaptor) Finalize() (err error)
  • func (e *Adaptor) GetConnection(address int, bus int) (connection i2c.Connection, err error)
  • func (e *Adaptor) GetDefaultBus() int
  • func (e *Adaptor) Name() string
  • func (e *Adaptor) PWMPin(pin string) (sysfsPin sysfs.PWMPinner, err error)
  • func (e *Adaptor) PwmWrite(pin string, val byte) (err error)
  • func (e *Adaptor) SetName(n string)

Types

type Adaptor

type Adaptor struct {
	// contains filtered or unexported fields
}

Adaptor represents an Intel Joule

func NewAdaptor

func NewAdaptor() *Adaptor

NewAdaptor returns a new Joule Adaptor

func (*Adaptor) Connect

func (e *Adaptor) Connect() (err error)

Connect initializes the Joule for use with the Arduino beakout board

func (*Adaptor) DigitalPin

func (e *Adaptor) DigitalPin(pin string, dir string) (sysfsPin sysfs.DigitalPinner, err error)

digitalPin returns matched digitalPin for specified values

func (*Adaptor) DigitalRead

func (e *Adaptor) DigitalRead(pin string) (i int, err error)

DigitalRead reads digital value from pin

func (*Adaptor) DigitalWrite

func (e *Adaptor) DigitalWrite(pin string, val byte) (err error)

DigitalWrite writes a value to the pin. Acceptable values are 1 or 0.

func (*Adaptor) Finalize

func (e *Adaptor) Finalize() (err error)

Finalize releases all i2c devices and exported digital and pwm pins.

func (*Adaptor) GetConnection

func (e *Adaptor) GetConnection(address int, bus int) (connection i2c.Connection, err error)

GetConnection returns an i2c connection to a device on a specified bus. Valid bus number is [0..2] which corresponds to /dev/i2c-0 through /dev/i2c-2.

func (*Adaptor) GetDefaultBus

func (e *Adaptor) GetDefaultBus() int

GetDefaultBus returns the default i2c bus for this platform

func (*Adaptor) Name

func (e *Adaptor) Name() string

Name returns the Adaptors name

func (*Adaptor) PWMPin

func (e *Adaptor) PWMPin(pin string) (sysfsPin sysfs.PWMPinner, err error)

PWMPin returns a sysfs.PWMPin

func (*Adaptor) PwmWrite

func (e *Adaptor) PwmWrite(pin string, val byte) (err error)

PwmWrite writes the 0-254 value to the specified pin

func (*Adaptor) SetName

func (e *Adaptor) SetName(n string)

SetName sets the Adaptors name