Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
fxos-device-service
Advanced tools
Changelog
4.2.0
/devices/:id/profile
/devices/:id/profile
Readme
A RESTful web service that exposes interactions with a connected Firefox OS device
GET /
Status message that shows whether the service is running.
GET /devices[?host=<host>&port=<port>]
List IDs and serial numbers of adb-attached devices. Can optionally specify a
remote host
and port
for which the device is connected.
GET /devices/:id
Fetch details about the device whose session ID is the parameter id
.
POST /devices/:id/connections/:port
Open a tcp connection to the parameter port
. Returns a port on the
host machine that is proxied to the device's port.
DELETE /devices/:id/connections/:port
Close the device tcp connection previously opened on the parameter
port
.
GET /devices/:id/crashes
List IDs of crash reports on device.
GET /devices/:id/crashes/:crashId
Download the crash dump with the parameter crash crashId
.
POST /devices/:id/events
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.
POST /devices/:id/events/:event
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
drag
keydown
keyup
reset
, needs no parameterssleep
tap
Example:
curl \
-H 'Content-Type: application/json' \
-X POST \
'http://localhost:8080/devices/abcdef0123456789/events/tap' \
--data-binary '{"x":100,"y":200}'
GET /devices/:id/files?filepath=<filepath>
Download a file from device. Use the filepath
query parameter to specify the
location of the file to download.
PUT /devices/:id/files?filepath=<filepath>
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 'upload=@myfile.txt'
'http://localhost:8080/devices/abcdef0123456789/files?filepath=/data/local/myfile.txt'
# Will upload image.jpg to /data/local/image.jpg with 777 permissions
curl \
-X PUT
-F 'upload=@image.jpg'
-F 'mode=777'
'http://localhost:8080/devices/abcdef0123456789/files?filepath=/data/local/image.jpg'
# Will upload script.sh to /data/local/script.sh with executable permissions
curl \
-X PUT
-F 'upload=@script.sh'
-F 'mode=+x'
'http://localhost:8080/devices/abcdef0123456789/files?filepath=/data/local/script.sh'
GET /devices/:id/logs
Pipe logs from logcat to the connected client.
POST /devices/:id/logs
Write a log entry to the device. The client is expected to write a JSON object in the request body with the following fields:
i
DeviceService
DELETE /devices/:id/logs
Clear all logcat logs on the device.
DELETE /devices/:id/processes/:pid
Stop the process given by pid
parameter.
GET /devices/:id/properties
Retrieve a JSON object of all the device properties and their associates values.
GET /devices/:id/properties/:property
Retrieve the value of a device property specified by the property
url parameter.
POST /devices/:id/properties
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.
POST /devices/:id/restart?hard=(true|false|0|1)
true
or 1
, then the device will be restarted instead.
GET /devices/:id/profile
Stream the gecko profile from the target device as a tarball (.tar.gz
).
POST /devices/:id/profile
Push a gecko profile to the target device. The service expects a gzipped tarball to be sent along as the request body.
FAQs
A web service that exposes interactions with a connected Firefox OS device
The npm package fxos-device-service receives a total of 13 weekly downloads. As such, fxos-device-service popularity was classified as not popular.
We found that fxos-device-service demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.