Skip to main content
POST
/
device
/
mode
Update Device Mode
curl --request POST \
  --url https://api.getmelody.io/device/mode \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "playback_protocol": "hdc"
}
'
{
  "playback_protocol": "hdc"
}

Authorizations

​
Authorization
string
header
required

Device Token for SDK operations. Obtain via: GET /api/haptics/device/device_token Format: {device_id}-{1|2}-{random} Note: ApiToken (from POST /device/otp/confirm) can also be used for most SDK endpoints.

Body

application/json
​
playback_protocol
enum<string>
required

Device operation protocol.

HDC: Haptic Direct Control - protocol for direct device control. User can set position & velocity or position & time it will take to get the receiver there.

HSC: Haptic Script Control - protocol for controlling script playback. The script is sent to device by passing the link. After script dowloaded by device, server controls device with start, stop, pause commands.

HPS: Haptic Points Stream - protocol for streaming device position signals. The stroker movement velocity is calculated on device and is based on time difference between signals. At least two signals needed to move the stroker.

HLC: Haptic Loop Control - protocol for simple up/down stroking without the need for data points. It only needs stroker velocity percentage and min/max positions for stroking range to create a loop and move according provided range.

Available options:
hdc,
hsc,
hps,
hlc
Example:

"hdc"

Response

200 - application/json

Updated Device Mode

​
playback_protocol
enum<string>
required

Device operation protocol.

HDC: Haptic Direct Control - protocol for direct device control. User can set position & velocity or position & time it will take to get the receiver there.

HSC: Haptic Script Control - protocol for controlling script playback. The script is sent to device by passing the link. After script dowloaded by device, server controls device with start, stop, pause commands.

HPS: Haptic Points Stream - protocol for streaming device position signals. The stroker movement velocity is calculated on device and is based on time difference between signals. At least two signals needed to move the stroker.

HLC: Haptic Loop Control - protocol for simple up/down stroking without the need for data points. It only needs stroker velocity percentage and min/max positions for stroking range to create a loop and move according provided range.

Available options:
hdc,
hsc,
hps,
hlc
Example:

"hdc"