LovenseLocalAPI

By local application¶

If the user's device is in the same LAN environment, a POST request to Lovense Remote can trigger a toy response. In this case, your server and Lovense's server are not required.

If the user uses the mobile version of Lovense Remote app, the domain and httpsPort are accessed from the callback information. If the user uses Lovense Remote for PC, the domain is 127-0-0-1.lovense.club, and the httpsPort is 30010

With the same command line, different parameters will lead to different results as below.

GetToys Request¶

Get the user's toy(s) information.

API URL: https://{domain}:{httpsPort}/command

Request Protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Headers:

Parameters:

Request Example:

{  
  "command": "GetToys"  
}

Response Example:

{
  "code": 200,
  "data": {
    "toys": "{  \"f082c00246fa\" : {    \"id\" : \"f082c00246fa\",    \"status\" : \"1\",    \"version\" : \"\",    \"name\" : \"nora\",    \"battery\" : 60,    \"nickName\" : \"\",    \"shortFunctionNames\" : [      \"v\",    \"r\"    ],    \"fullFunctionNames\" : [       \"Vibrate\",    \"Rotate\"    ]  }}",
    "platform": "ios",
    "appType": "remote"
  },
  "type": "OK"
}

GetToyName Request¶

Get the user's toy(s) name.

API URL: https://{domain}:{httpsPort}/command

Request Protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Headers:

Parameters:

Request Example:

{  
  "command": "GetToyName"  
}

Response Example:

{  
  "code": 200,  
  "data": ["Domi", "Nora"],  
  "type": "OK"  
}

Function Request¶

API URL: https://{domain}:{httpsPort}/command

Request Protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Headers:

Parameters:

The stopPrevious parameter is available in the following versions: Android Remote 5.2.2, iOS Remote 5.4.4, PC Remote 1.6.3.

Request Example:

// Vibrate toy ff922f7fd345 at 16th strength, run 9 seconds then suspend 4 seconds. It will be looped. Total running time is 20 seconds.  
{  
  "command": "Function",  
  "action": "Vibrate:16",  
  "timeSec": 20,  
  "loopRunningSec": 9,  
  "loopPauseSec": 4,  
  "toy": "ff922f7fd345",  
  "apiVer": 1  
}

// Vibrate 9 seconds at 2nd strength  
// Rotate toys 9 seconds at 3rd strength  
// Pump all toys 9 seconds at 4th strength  
// For all toys, it will run 9 seconds then suspend 4 seconds. It will be looped. Total running time is 20 seconds.  
{  
  "command": "Function",  
  "action": "Vibrate:2,Rotate:3,Pump:3",  
  "timeSec": 20,  
  "loopRunningSec": 9,  
  "loopPauseSec": 4,  
  "apiVer": 1  
}

// Vibrate 9 seconds at 2nd strength  
// The rest of the functions respond to 10th strength 9 seconds  
{  
  "command": "Function",  
  "action": "Vibrate:2,All:10",  
  "timeSec": 20,  
  "loopRunningSec": 9,  
  "loopPauseSec": 4,  
  "apiVer": 1  
}

// Thrust 20 seconds at 10th strength and stroke range of 0-20  
{  
  "command": "Function",  
  "action": "Stroke:0-20,Thrusting:10",  
  "timeSec": 20,  
  "apiVer": 1  
}

// Stop all toys  
{  
  "command": "Function",  
  "action": "Stop",  
  "timeSec": 0,  
  "apiVer": 1  
}

Position Request¶

Controls the stroker of Solace Pro to move to a specified position(0\~100). It is suitable for scenarios requiring real-time control. If you have a predefined pattern, suggest to use PatternV2 Request.

API URL: https://{domain}:{httpsPort}/command

Request protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Parameters:

Request Example:

{  
  "command": "Position",  
  "value": "38", //0\~100  
  "toy": "ff922f7fd345", // If you don’t include this, it will be applied to all connected Solace Pro  
  "apiVer": 1  
}

{  
  "code": 200,  
  "type": "ok"  
}

1. The stroker will continue moving 300 miliseconds after a position command is executed. If a new command is received during this time, it will be executed immediately. The more frequently commands are sent, the smoother the stroker movement will be.
2. It takes about 1 to 2 seconds for the stroker to reach the desired speed from rest. During this time, the stroker may not closely match the desired movement.

Pattern Request¶

If you want to change the way the toy responds very frequently you can use a pattern request. To avoid network pressure and obtain a stable response, use the commands below to send your predefined patterns at once.

API URL: https://{domain}:{httpsPort}/command

Request protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Headers:

Parameters:

Request Example:

// Vibrate the toy as defined. The interval between changes is 1 second. Total running time is 9 seconds.  
{  
  "command": "Pattern",  
  "rule": "V:1;F:v;S:1000#",  
  "strength": "20;20;5;20;10",  
  "timeSec": 9,  
  "toy": "ff922f7fd345",  
  "apiVer": 2  
}

// Vibrate the toys as defined. The interval between changes is 0.1 second. Total running time is 9 seconds.  
// If the toys include Nora or Max, they will automatically rotate or pump, you don't need to define it.  
{  
  "command": "Pattern",  
  "rule": "V:1;F:v,r,p;S:100#",  
  "strength": "20;20;5;20;10",  
  "timeSec": 9,  
  "apiVer": 2  
}

PatternV2 Request¶

The 2nd version of the Pattern Request includes four operations: Setup, Play, Stop, and SyncTime. For version 7.71.0 and above, it works with all Lovense toys. For version 7.70.0 and below, it is only available for the position control of the Solace Pro. It is suitable for scenarios with a predefined pattern. If real-time control of position is needed, suggest to use Position Request.

Setup¶

Set up a predefined pattern.

API URL: https://{domain}:{httpsPort}/command

Request protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Parameters:

Request Example:

{  
  "command": "PatternV2",  
  "type": "Setup",  
  "actions": [  
    { "ts": 0, "pos": 10 },  
    { "ts": 100, "pos": 100 },  
    { "ts": 200, "pos": 10 },  
    { "ts": 400, "pos": 15 },  
    { "ts": 800, "pos": 88 }  
  ],  
  "apiVer": 1  
}

{  
  "code": 200,  
  "type": "ok"  
}

Play¶

Play the predefined pattern.

API URL: https://{domain}:{httpsPort}/command

Request protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Parameters:

Request Example:

{  
  "command": "PatternV2",  
  "type": "Play",  
  "toy": "ff922f7fd345",  
  "startTime": 100,  
  "offsetTime": 300,  
  "apiVer": 1  
}

{  
  "code": 200,  
  "type": "ok"  
}

InitPlay¶

Set up a predefined pattern and play it automatically once it is loaded.

API URL: https://{domain}:{httpsPort}/command

Request protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Parameters:

Tips

1. The InitPlay API is available in the version 7.76.0 for Android and iOS.
2. InitPlay is the auto-play version of PatternV2 Setup + Play. No need to use them together.
3. If a command is executing, new commands will be added to the queue and played in order.
4. The actions will begin playing from the time (startTime + offsetTime).

Request Example:

{  
  "command": "PatternV2",  
  "type": "InitPlay",  
  "actions": [  
    {  
      "ts": 0,  
      "pos": 10  
    },  
    {  
      "ts": 1000,  
      "pos": 20  
    },  
    {  
      "ts": 2000,  
      "pos": 30  
    },  
    {  
      "ts": 3000,  
      "pos": 40  
    },  
    {  
      "ts": 4000,  
      "pos": 50  
    },  
    {  
      "ts": 5000,  
      "pos": 60  
    },  
    {  
      "ts": 6000,  
      "pos": 70  
    },  
    {  
      "ts": 7000,  
      "pos": 80  
    },  
    {  
      "ts": 9000,  
      "pos": 90  
    }  
  ],  
  "startTime": 0,  
  "offsetTime": 0,  
  "stopPrevious": 0,  
  "apiVer": 1  
}

{  
  "code": 200,  
  "type": "ok"  
}

Stop¶

Stop playing the predefined pattern.

API URL: https://{domain}:{httpsPort}/command

Request protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Parameters:

Request Example:

{  
  "command": "PatternV2",  
  "type": "Stop",  
  "toy": "ff922f7fd345",  
  "apiVer": 1  
}

{  
  "code": 200,  
  "type": "ok"  
}

SyncTime¶

Use SyncTime to help you calculate the offset time from the server. Before sending the request, record the time T1; once you receive a successful response to the request, record the time T2. The estimated offset can then be calculated: offsetTime \= (T2 - T1).

API URL: https://{domain}:{httpsPort}/command

Request protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Parameters:

Request Example:

{  
  "command": "PatternV2",  
  "type": "SyncTime",  
  "apiVer": 1  
}

{  
  "code": 200,  
  "type": "ok"  
}

Preset Request¶

API URL: https://{domain}:{httpsPort}/command

Request protocol: HTTPS Request

Method: POST

Request Content Type: application/json

Response Format: JSON

Headers:

Parameters:

Request Example:

// Vibrate the toy with pulse pattern, the running time is 9 seconds.  
{  
  "command": "Preset",  
  "name": "pulse",  
  "timeSec": 9,  
  "toy": "ff922f7fd345",  
  "apiVer": 1  
}

Response Example:

{  
  "code": 200,  
  "type": "ok"  
}

Standard API Demo¶

https://developer.lovense.com/standard-api-demo-game-mode