Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@PaulMcInnis
PaulMcInnis committed Apr 10, 2013
1 parent 09f43a4 commit 0469d8f
Showing 1 changed file with 67 additions and 68 deletions.
135 changes: 67 additions & 68 deletions README.md
View file
Expand Up @@ -2,51 +2,78 @@ libpebble
=========
Interact with your Pebble from OSX, Ubuntu or Debian operating systems.

###General Dependancies
The following dependancies should be installed regardless of the Operating System:
## Warning and Complications

_Python_
* `python 2.7`
* Supported OS's are `OSX 10.8`, `Ubuntu`, `Debian`
* OS's which can utilize a faster bluetooth library, Lightblue-0.4, are `OSX 10.8` and `Ubuntu`
* Lightblue installation instructions for earlier version of OSX (10.6) and other OS's can be found [here](http://lightblue.sourceforge.net/#downloads)

_Lightblue:_
* `lightblue-0.4` from `https://github.com/pebble/lightblue-0.4`
-------------------------

##1. Install Dependancies

All supported OS's will require `python 2.7` to operate libpebble. It can be installed [here](http://www.python.org/download/releases/2.7/)

###a. OSX Additional Dependencies

Installing lightblue-0.4 in OSX will require the following be installed:
* `PyObjC` which can be installed via [pip](https://pypi.python.org/pypi/pip)
* `Xcode 2.1 or later` to build LightAquaBlue framework

###b. Ubunutu Additional Dependencies

Installing lightblue-0.4 in Ubuntu requires some extra dependancies be installed via `apt-get install`:
* `python-dev`
* `libopenobex1-dev`
* `python-tk` if you wish to use the GUI selection tool

###c. Debian Additional Dependencies

Support for lightblue is untested in Debian, however the following should be installed/completed for use with PySerial:
* Install rfcomm `sudo apt-get install rfcomm`
* Bind the device `sudo rfcomm bind 0 PEBBLE_BLUETOOTH_ADDRESS 1`
* Make the following code change to `pebble/pebble.py`:
Change:

self._ser = serial.Serial("/dev/tty.Pebble"+id+"-SerialPortSe", 115200, timeout=2)

to:

self._ser = serial.Serial("/dev/rfcomm0", 115200, timeout=2)

* Note that you may have to run libpebble as root with `sudo python pebble.py` in Debian

-------------------------

##2. Install Libpebble and Lightblue

* To install libpebble, clone the current libpebble with lightblue support from `git@github.com:pebble/libpebble.git` to a location of your choosing
* If lightblue is being installed clone `lightblue-0.4` from `https://github.com/pebble/lightblue-0.4` and then
* `cd lightblue-0.4`
* `sudo python setup.py install`

Getting started - Mac OSX
-------------------------
When using libpebble on OSX, it is recommended that `--lightblue` be utilized.

###Additional Dependencies
* `PyObjC` which can be installed via [pip](https://pypi.python.org/pypi/pip)
* `Xcode 2.1 or later` to build LightAquaBlue framework
* OSX 10.4 or later to perform MAC Address discovery
##3. Testing the Connection

###Interacting with a Pebble
* First install the general dependancies and LightBlue
###a. OSX
#####Using libpebble with --lightblue on OSX
When using libpebble on OSX, it is recommended that `--lightblue` be utilized.
* From the `libpebble-dev` folder, execute the following: `./p.py --lightblue --pair get_time`
* Note that if no --pebble_id is specified before the command, you are provided with a GUI selection tool.
* Note that if no `--pebble_id` is specified before the command, you are provided with a GUI selection tool.
* Note that if a MAC address is supplied, initialization time is reduced.
* For example: `./p.py --pebble_id 00:11:22:33:44:55:66 --lightblue get_time`
where `00:11:22:33:44:55:66` is the Pebble's MAC Address, viewable on the Pebble from `settings`-->`about`
* The `--pebble_id` can also be the 4 letter friendly name of your pebble but this will require that the Pebble is broadcasting.
* You can obtain your pebble's MAC address after a successful connection in the libpebble stdout debug logs
* The `--pebble_id` can also be the 4 letter firendly name of your pebble but this will require that the Pebble is broadcasting.

###Using libpebble without --lightblue on OSX
_NOT RECOMMENDED. MAY CAUSE KERNEL PANICS ON OSX 10.8.X_
#####Using libpebble without --lightblue on OSX (MAY CAUSE KERNEL PANICS)

* Pair your Pebble to your computer and make sure it's setup as a serial port. For example it could be exposed as `/dev/tty.Pebble123A-SerialPortSe`. You can accomplish this by using OSX's pairing utility in `System Preferences` --> `Bluetooth` -> `+` --> selecting your pebble `Pebble XXXX` then confirming the pairing code on the Pebble.
* Once you're paired and the serial port is setup, you can execute commands without the `--lightblue` flag, just ensure that the `--pebble_id` is the 4 letter friendly name of your Pebble, `123A` for example.
* A command to get the time might be: `./p.py --pebble_id 123A get_time`

Getting started - Ubuntu
------------------------
###Extra Dependancies
Installing lightblue-0.4 in Ubuntu requires some extra dependancies be installed via `apt-get install`:
* `python-dev`
* `libopenobex1-dev`
* `python-tk` if you wish to use the GUI selection tool

###Interacting with a Pebble
### b. Ubuntu

_Automated pairing via `--pair` on linux is not currently supported_

Expand All @@ -55,51 +82,30 @@ _Automated pairing via `--pair` on linux is not currently supported_
* From the `libpebble-dev` folder, execute the following: `./p.py --lightblue get_time`
* Note that if no `--pebble_id` is specified before the command, you are provided with a GUI selection tool.
* For example: `./p.py --pebble_id 00:11:22:33:44:55:66 --lightblue get_time`
* The `--pebble_id` can also be the 4 letter friendly name of your pebble but this will still be slower than passing the MAC Address.

Getting started - Debian
------------------------
* The `--pebble_id` can also be the 4 letter firendly name of your pebble but this will still be slower than passing the MAC Address.

**Please note the following was tested on Linux Mint 13, but should be valid for any Debian based distro**
### b. Debian

###Extra Dependancies
* Install rfcomm `sudo apt-get install rfcomm`
* Bind the device `sudo rfcomm bind 0 PEBBLE_BLUETOOTH_ADDRESS 1`
* Make the following code change to `pebble/pebble.py`:

Change:

self._ser = serial.Serial("/dev/tty.Pebble"+id+"-SerialPortSe", 115200, timeout=2)

to:

self._ser = serial.Serial("/dev/rfcomm0", 115200, timeout=2)

Note that you may have to run libpebble as root with `sudo python pebble.py`

###Interacting with a Pebble
_Please note the following was tested on Linux Mint 13, but should be valid for any Debian based distro_
* `./p.py --pebble_id 123A get_time`

Status
------

The following are currently supported:
Functionality
-------------

The following are currently supported:

* Installing applications
* Installing firmware
* Sending email, sms and ping notifications
* Installing, reinstalling and uninstalling applications
* Installing firmwares
* Launching applications by UUID
* Sending application messages
* Pinging device
* Resetting device
* Setting/getting time
* Sending notifications
* Setting the currently playing track
* Listing installed apps
* Installing apps
* Deleting apps
* Getting the installed firmware versions
* Installing firmware
* Getting device data (serial, BT MAC etc)
* Getting the installed firmware version
* Getting and setting the pebble's time

REPL
----
Expand All @@ -108,11 +114,4 @@ A basic REPL is available, it is best used with ipython:

`sudo ipython repl.py`

The variable pebble refers the watch connection. You can for example do `pebble.ping()` to perform a ping.

Thanks
------

* Pebble for making an awesome watch.
* RaYmAn for helping me figure out how the PutBytesClient worked.
* Overv for helping me pick apart the Android different message factories in the Android app.
The variable pebble refers the watch connection. You can for example perform `pebble.get_time()` to get the time of the watch

0 comments on commit 0469d8f

Please sign in to comment.