A RESTful web service that exposes interactions with a connected Firefox OS device

Status message that shows whether the service is running.

Open a tcp connection to the parameter port. Returns a port on the host machine that is proxied to that device port.

Close the device tcp connection previously opened on the parameter port.

List ids of crash reports on device.

Download the crash dump with the parameter crash id.

List ids of adb-attached devices.

Fetch details about the device whose adb id is the parameter id.

Fetch details about a device. The service will look at the request headers (particularly X-Session-Id or X-Android-Serial) to figure out which device to report about.

Trigger a series of sequential low-level touch interactions. The client is expected to write a JSON array of event objects for which to sequentially execute. See the syntax for POST /events/:event for event object schema.

Trigger a low-level touch-related interaction. The client is expected to write a JSON object with event-related properties which control the trigger details.

Valid event types and their JSON properties:

• doubletap
  • x, X-axis coordinate
  • y, Y-axis coordinate
• drag
  • x, X-axis coordinate to start drag
  • y, Y-axis coordinate to start drag
  • endX, X-axis coordinate to end drag
  • endY, Y-axis coordinate to end drag
  • duration, time in milliseconds for drag to elapse
• keydown
  • code, keycode for the key press
• keyup
  • code, keycode for the key release
• reset, needs no parameters
• sleep
  • duration, time in milliseconds to wait before next event invocation. Useful when triggering many events in a single request.
• tap
  • x, X-axis coordinate
  • y, Y-axis coordinate

Example:

curl \
  -H 'Content-Type: application/json' \
  -X POST \
  'http://localhost:8080/events/tap' \
  --data-binary '{"x":100,"y":200}'

Download a file from device. Use the filepath query parameter to specify the location of the file to download.

Upload a file to device. Use the filepath query parameter to specify the path destination of the uploaded file. The uploaded file should sent via multipart/form-data. A file permissions mode may also be set during upload.

Examples:

# Will upload myfile.txt to /data/local/myfile.txt
curl \
  -X PUT
  -F '[email protected]'
  'http://localhost:8080/files?filepath=/data/local/myfile.txt'

# Will upload image.jpg to /data/local/image.jpg with 777 permissions
curl \
  -X PUT
  -F '[email protected]'
  -F 'mode=777'
  'http://localhost:8080/files?filepath=/data/local/image.jpg'

# Will upload script.sh to /data/local/script.sh with executable permissions
curl \
  -X PUT
  -F '[email protected]'
  -F 'mode=+x'
  'http://localhost:8080/files?filepath=/data/local/script.sh'

Pipe logs from logcat to the connected client.

Write a log to the adb-connected device. The client is expected to write a JSON object in the request body with the following fields:

• message, required
• priority, optional, defaults to i
• tag, optional, defaults to DeviceService

Clear all logcat logs on adb-connected device.

Delete the process given by pid parameter.

Retrieve a JSON object of all the device properties and their associates values.

Retrieve the value of a device property specified by the :id url parameter.

Set the values of a collection device properties. The client is expected to write a JSON object which contains a dictionary of property names to values.

Restarts b2g process running on device. If the url parameter hard is true or 1, then the device will be restarted instead.

We store a map from session ids to sessions on the server. The X-Session-Id request header allows you to make a request using details from an existing session which are stored on the server. Every request response comes with an X-Session-Id header.

The X-Android-Serial header allows you to specify that a certain adb device id should be used when multiple devices are connected to the host machine.

The X-Remote-Host header specifies a remote host for any commands issued via adb to use during this request.

The X-Remote-Port header specifies a device port for any commands issued via adb to use during this request.