Skip to main content
GET
/
device
/
stroker
/
status
Retrieve Stroker Status
curl --request GET \
  --url https://api.getmelody.io/device/stroker/status \
  --header 'Authorization: Bearer <token>'
{
  "current_pos_angle": 1.57,
  "current_pos_range": 50,
  "target_pos_angle": 3.14,
  "target_pos_range": 75,
  "current_vel_angle": 2.5,
  "current_vel_range": 30
}

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.

Response

200 - application/json

OK

The current status of the stroker on the device.

​
current_pos_angle
number<float>

The current position of the stroker in radians.

Example:

1.57

​
current_pos_range
integer<int32>

The current position of the stroker in points.

Example:

50

​
target_pos_angle
number<float>

The target position of the stroker in radians.

Example:

3.14

​
target_pos_range
integer<int32>

The target position of the stroker in points.

Example:

75

​
current_vel_angle
number<float>

The current velocity of the stroker in rad/s.

Example:

2.5

​
current_vel_range
integer<int32>

The current velocity of the stroker in points/s.

Example:

30