README ¶
Pebble
This repository contains the Gobot adaptor for Pebble smart watch.
It uses the Pebble 2.0 SDK, and requires the 2.0 iOS or Android app, and that the "watchbot" app has been installed on the Pebble watch.
How to Install
go get -d -u gobot.io/x/gobot/... && go install gobot.io/x/gobot/platforms/pebble
- Install Pebble 2.0 iOS or Android app. (If you haven't already)
- Follow README to install and configure "watchbot" on your watch: https://gobot.io/x/watchbot
How to Use
Before running the example, make sure configuration settings match with your program. In the example, api host is your computer IP, robot name is 'pebble' and robot api port is 8080
package main
import (
"fmt"
"gobot.io/x/gobot"
"gobot.io/x/gobot/api"
"gobot.io/x/gobot/platforms/pebble"
)
func main() {
master := gobot.NewMaster()
api.NewAPI(master).Start()
pebbleAdaptor := pebble.NewAdaptor()
watch := pebble.NewDriver(pebbleAdaptor)
work := func() {
watch.SendNotification("Hello Pebble!")
watch.On(watch.Event("button"), func(data interface{}) {
fmt.Println("Button pushed: " + data.(string))
})
watch.On(watch.Event("tap"), func(data interface{}) {
fmt.Println("Tap event detected")
})
}
robot := gobot.NewRobot("pebble",
[]gobot.Connection{pebbleAdaptor},
[]gobot.Device{watch},
work,
)
master.AddRobot(robot)
master.Start()
}
Supported Features
- We support event detection of 3 main pebble buttons.
- Accelerometer events
- Pushing data to pebble watch
Documentation
We're busy adding documentation to our web site at http://gobot.io/ please check there as we continue to work on Gobot
Thank you!
Contributing
- All patches must be provided under the Apache 2.0 License
- Please use the -s option in git to "sign off" that the commit is your work and you are providing it under the Apache 2.0 License
- Submit a Github Pull Request to the appropriate branch and ideally discuss the changes with us in IRC.
- We will look at the patch, test it out, and give you feedback.
- Avoid doing minor whitespace changes, renamings, etc. along with merged content. These will be done by the maintainers from time to time but they can complicate merges and should be done seperately.
- Take care to maintain the existing coding style.
- Add unit tests for any new or changed functionality
- All pull requests should be "fast forward"
- If there are commits after yours use “git rebase -i <new_head_branch>”
- If you have local changes you may need to use “git stash”
- For git help see progit which is an awesome (and free) book on git
License
Copyright (c) 2013-2017 The Hybrid Group. Licensed under the Apache 2.0 license.
Documentation ¶
Overview ¶
Package pebble contains the Gobot adaptor and driver for Pebble smart watch.
Installing:
It requires the 2.x iOS or Android app, and "watchbot" app (https://gobot.io/x/watchbot) installed on Pebble watch. Then install running:
go get gobot.io/x/gobot/platforms/pebble
Example:
Before running the example, make sure configuration settings match with your program. In the example, api host is your computer IP, robot name is 'pebble' and robot api port is 8080
package main import ( "fmt" "gobot.io/x/gobot" "gobot.io/x/gobot/api" "gobot.io/x/gobot/platforms/pebble" ) func main() { master := gobot.NewMaster() api.NewAPI(master).Start() pebbleAdaptor := pebble.NewAdaptor() watch := pebble.NewDriver(pebbleAdaptor) work := func() { watch.SendNotification("Hello Pebble!") watch.On(watch.Event("button"), func(data interface{}) { fmt.Println("Button pushed: " + data.(string)) }) watch.On(watch.Event("tap"), func(data interface{}) { fmt.Println("Tap event detected") }) } robot := gobot.NewRobot("pebble", []gobot.Connection{pebbleAdaptor}, []gobot.Device{watch}, work, ) master.AddRobot(robot) master.Start() }
For more information refer to the pebble README: https://github.com/hybridgroup/gobot/blob/master/platforms/pebble/README.md
Index ¶
- type Adaptor
- type Driver
- func (d *Driver) Connection() gobot.Connection
- func (d *Driver) Halt() (err error)
- func (d *Driver) Name() string
- func (d *Driver) PendingMessage() string
- func (d *Driver) PublishEvent(name string, data string)
- func (d *Driver) SendNotification(message string) string
- func (d *Driver) SetName(n string)
- func (d *Driver) Start() (err error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Adaptor ¶ added in v1.0.0
type Adaptor struct {
// contains filtered or unexported fields
}
func NewAdaptor ¶ added in v1.0.0
func NewAdaptor() *Adaptor
NewAdaptor creates a new pebble adaptor
func (*Adaptor) Connect ¶ added in v1.0.0
Connect returns true if connection to pebble is established successfully
type Driver ¶ added in v1.0.0
type Driver struct { gobot.Commander gobot.Eventer Messages []string // contains filtered or unexported fields }
func NewDriver ¶ added in v1.0.0
NewDriver creates a new pebble driver Adds following events:
button - Sent when a pebble button is pressed accel - Pebble watch acceleromenter data tab - When a pebble watch tap event is detected
And the following API commands:
"publish_event" "send_notification" "pending_message"
func (*Driver) Connection ¶ added in v1.0.0
func (d *Driver) Connection() gobot.Connection
func (*Driver) PendingMessage ¶ added in v1.0.0
PendingMessages returns messages to be sent as notifications to pebble (Not intended to be used directly)
func (*Driver) PublishEvent ¶ added in v1.0.0
PublishEvent publishes event with specified name and data in gobot
func (*Driver) SendNotification ¶ added in v1.0.0
SendNotification appends message to list of notifications to be sent to watch