Skip to content

Commit

Permalink
Fixing formatting of spec
Browse files Browse the repository at this point in the history
  • Loading branch information
stevenleeg committed Aug 18, 2013
1 parent 1335a43 commit 8228a2c
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ The only required field is `e`.
## Phone protocol
The phone protocol is used for communication between the server and the (hurr) phone.

### `getPin`
### Event: `getPin`
Assigns a pin to this connection and responds back with the pin.

**Expects arguments:**
None
* None

**Example response:**
```JSON
Expand All @@ -33,11 +33,11 @@ None

**NOTE:** The `pin` argument of the response may be changing in the future, as I'd like it to be a 4 character pairing pin.

### `restorePin`
### Event: `restorePin`
Assigns the given pin to this connection. Useful for reassigning your previous PIN after the app/connection closes.

**Expects arguments:**
`pin`: The pin to assign
* `pin`: The pin to assign

**Example response**
```JSON
Expand All @@ -47,29 +47,29 @@ Assigns the given pin to this connection. Useful for reassigning your previous P
}
```

### `keyDown`
### Event: `keyDown`
Tells the server that a button on the controller has been pressed down.

**Expects arguments:**
`v`: The key code of the button pressed
* `v`: The key code of the button pressed

**Example response:**
No response

### `keyUp`
### Event: `keyUp`
Tells the server that a button on the controller has been released.

**Expects arguments:**
`v`: The key code of the button released
* `v`: The key code of the button released

**Example response:**
No response

### `tilt`
### Event `tilt`
Tells the server that the phone is currently being tilted by the user.

**Expects arguments:**
`v`: The value of the accelerometer. *Should be a float between -1 and 1*.
* `v`: The value of the accelerometer. *Should be a float between -1 and 1*.

**Example response:**
No response
Expand Down

0 comments on commit 8228a2c

Please sign in to comment.