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

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!

Example program

Save the following code into a file called main.go.

package main

import (
	"time"

	"github.com/hybridgroup/gobot"
	"github.com/hybridgroup/gobot/platforms/gpio"
	"github.com/hybridgroup/gobot/platforms/intel-iot/joule"
)

func main() {
	gbot := gobot.NewGobot()

	e := joule.NewJouleAdaptor("joule")
	led := gpio.NewLedDriver(e, "led", "103")

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

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

	gbot.AddRobot(robot)

	gbot.Start()
}

You can read the full API documentation online.

Cross compiling for the Intel Joule

Compile your Gobot program run the following command using the command line from the directory where you have your main.go file:

$ GOARCH=386 GOOS=linux go build .

Then you can simply upload your program over the network from your host computer to the Joule

$ scp main root@<IP of your device>:/home/root/blink

and then execute it on your Joule (use screen to connect, see the Intel setup steps if you don't recall how to connect)

$ ./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 the same numbering as the MRAA library does, as documented here:

https://software.intel.com/en-us/pin-mapping-for-carrier-board-joule

Of special note are the pins that control the build-in LEDs, which are pins 100 thru 103, 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.

License

Copyright (c) 2014-2016 The Hybrid Group. Licensed under the Apache 2.0 license.

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

TODO: move this into shared PWM package

Index

• type JouleAdaptor
  • func NewJouleAdaptor(name string) *JouleAdaptor
  • func (e *JouleAdaptor) Connect() (errs []error)
  • func (e *JouleAdaptor) DigitalRead(pin string) (i int, err error)
  • func (e *JouleAdaptor) DigitalWrite(pin string, val byte) (err error)
  • func (e *JouleAdaptor) Finalize() (errs []error)
  • func (e *JouleAdaptor) I2cRead(address int, size int) (data []byte, err error)
  • func (e *JouleAdaptor) I2cStart(address int) (err error)
  • func (e *JouleAdaptor) I2cWrite(address int, data []byte) (err error)
  • func (e *JouleAdaptor) Name() string
  • func (e *JouleAdaptor) PwmWrite(pin string, val byte) (err error)

Types

type JouleAdaptor

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

JouleAdaptor represents an Intel Joule

func NewJouleAdaptor

func NewJouleAdaptor(name string) *JouleAdaptor

NewJouleAdaptor returns a new JouleAdaptor with specified name

func (*JouleAdaptor) Connect

func (e *JouleAdaptor) Connect() (errs []error)

Connect initializes the Joule for use with the Arduino beakout board

func (*JouleAdaptor) DigitalRead

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

DigitalRead reads digital value from pin

func (*JouleAdaptor) DigitalWrite

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

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

func (*JouleAdaptor) Finalize

func (e *JouleAdaptor) Finalize() (errs []error)

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

func (*JouleAdaptor) I2cRead

func (e *JouleAdaptor) I2cRead(address int, size int) (data []byte, err error)

I2cRead returns size bytes from the i2c device

func (*JouleAdaptor) I2cStart

func (e *JouleAdaptor) I2cStart(address int) (err error)

I2cStart initializes i2c device for addresss

func (*JouleAdaptor) I2cWrite

func (e *JouleAdaptor) I2cWrite(address int, data []byte) (err error)

I2cWrite writes data to i2c device

func (*JouleAdaptor) Name

func (e *JouleAdaptor) Name() string

Name returns the JouleAdaptors name

func (*JouleAdaptor) PwmWrite

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

PwmWrite writes the 0-254 value to the specified pin