buttplughttp

command module
v0.0.0-...-76d4b71 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 1, 2021 License: ISC Imports: 15 Imported by: 0

README

buttplughttp

An example application using the buttplug API that exposes a REST API to control devices.

Endpoints

The API will always return either nothing or a JSON object indicating success. When it returns nothing, 204 is used.

  • GET /api/devices lists known devices.
  • GET /api/device/n shows the information for the device with index n (where n is a number).
  • GET /api/device/n/rssi returns the signal level for the device.
  • GET /api/device/n/battery returns the battery level for the device.
  • POST /api/device/n/vibrate?strength=1&motor=0 starts vibrating the device.
    • ?strength is required; its range is 0.0 to 1.0.
    • ?motor is optional; it indicates the motor number to start.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL