Got Stuck?

Forum for Lovense Developers

Support

Document Feedback

Unity Universal Plugin For Remote

Introduction

This Unity plugin can establish communication with the Lovense Remote App available on the LAN to send toy control commands.

Note: Android and iOS Remote App requires "Game Mode" to be enabled, PC Remote App requires "Allow Control" to be enabled.

Compatibility

Unity version: >= 2018.4.0

Api Compatibility Level:

• For .Net 4.x, the import package name is remotePlugin_.Net4.x.unitypackage.
• For .Net Framework, the import package name is remotePlugin_.NetFramework.unitypackage.
• For .Net Standard 2.0, the import package name isremotePlugin_.NetStandard2.0.unitypackage.
• For .Net Standard 2.1, the import package name is remotePlugin_.NetStandard2.1.unitypackage.

Import the plugin

1. Download the plugin package from here. The latest version of the current plugin is V1.3 click to view version records

   remotePlugin_.Net4.x.unitypackage

   remotePlugin_.NetFramework.unitypackage

   remotePlugin_.NetStandard2.0.unitypackage

   remotePlugin_.NetStandard2.1.unitypackage

2. Import the appropriate package based on your project's Api Compatibility Level.

   

3. Select all options and click import.

   

4.The file Assets/StreamingAssets/LovenseToySupportConfig.json is the configuration file for the toy support directive, and the version field represents the version of the information. The current latest version is 1.0. If it is older than this version, it is recommended to download and replace the file.

Dowload: LovenseToySupportConfig.json

The LovenseDemo folder is an example that you can refer to. Removing it won't affect the functionality.

Guide

1. Search for the local LAN Lovense Remote.

public class YourLovenseToyUI: MonoBehaviour {
	 // do search
   private void DoSearch() {
      LovenseRemote.GetInstance().SearchRemoteApp();
   }

   //callback function,parames is List<RemoteAppData>
	private void OnSearchLocalApp(List<RemoteAppData> appDatas) {
       // Show the Lovense Remote search result in the UI
	}

   private void OnGetAppsError(string errorMsg) {
       //when get apps error
   }
  

   void Awake(){
      // Add listener
		LovenseRemote.onGetAppsEvent.AddListener(OnSearchLocalApp);
       LovenseRemote.onGetAppsErrorEvent.AddListener(OnGetAppsError);
   }

	void OnDestory() {
		// Remove listener
		LovenseRemote.onGetAppsEvent.RemoveListener(OnSearchLocalApp);
		LovenseRemote.onGetAppsErrorEvent.RemoveListener(OnGetAppsError);
	}
}

2. List toys based on the specified IP and port

public class YourLovenseToyUI: MonoBehaviour {
   
   //do search toys
   private void DoSearchToys(string domain,int port) {
      //The default value of useHttps is true, if set value to false, http will be used for data transfer.
      LovenseRemote.GetInstance().GetToys(domin,post[,useHttps=true]);
   }

   private void OnGetToys(List<LovenseRemoteToy> toys) {
      //when get toys
   }

   private void OnGetToysError(string errorMsg) {
       //when get toys error
   }

   void Awake() {
      // Add listener
      LovenseRemote.onGotToysEvent.AddListener(OnGetToys);
      LovenseRemote.onGetToysErrorEvent.AddListener(OnGetToysError);
   } 
 
   void OnDestroy() {
       // Remove listener
      LovenseRemote.onGotToysEvent.AddListener(OnGetToys);
      LovenseRemote.onGetToysErrorEvent.AddListener(OnGetToysError);
   }
}

3. Send commands

3.1 Send functions commands

public class YourLovenseToyUI : MonoBehaviour {
   
  private void DoSendCommands(List<LovenseRemoteToy> toys, List<LovenseCommand> commands, float timeSec,  float loopRunningSec , float loopPauseSec,int stopPrevious, ) {
    LovenseRemote.GetInstance().SendFunctions(toys,commands,timeSec[,loopRunningSec,loopPauseSec,stopPrevious]); 
  }

  private void OnControlToysResult(string toyId,ControlToysResult result){
      //...
  }

  void Awake() {
    // Add listener
    LovenseRemote.onControlToysEvent.AddListener(OnControlToysResult);
  } 

  void OnDestroy() {
    // Remove listener:
    LovenseRemote.onControlToysEvent.RemoveListener(OnControlToysResult);
  }
}

3.2 Send pattern commands

public class YourLovenseToyUI : MonoBehaviour {

  private void DoSendPattern(List<LovenseRemoteToy> toys, List<LovenseCommandType> types, List<int> strengthValues,  float timeSec,int intervalsMs ) {

    LovenseRemote.GetInstance().SendPattern(toys, types,strengthValues, timeSec,intervals );
  }

  private void OnControlToysResult(string id,ControlToysResult result){
    //...
  }

  void Awake() {
    // Add listener//
    LovenseRemote.onControlToysEvent.AddListener(OnControlToysResult);
  } 

   void OnDestroy() {
    // Remove listener:
    LovenseRemote.onControlToysEvent.RemoveListener(OnControlToysResult);
  }
}

values[]: Changes in intensity

personTimeMs: Time interval for intensity switching in milliseconds

timeSec: Total running time in seconds

3.3 Send preset commands

public class YourLovenseToyUI : MonoBehaviour {

   private void DoSendPreset(List<LovenseRemoteToy> toys, string presetName, int timeSec) {

      LovenseRemote.GetInstance().SendPreset(toys, presetName, timeSec);

   }

   //callback function, parames is ControlToysResult
   private void OnControlToysResult(string id,ControlToysResult result){
      //...
   }

   void Awake() {
      // Add listener;
      LovenseRemote.onControlToysEvent.AddListener(OnControlToysResult);
   } 

   void OnDestroy() {
       // Remove listener:
      LovenseRemote.onControlToysEvent.RemoveListener(OnControlToysResult);
   }
}

Currently available preset names: "earthquake," "fireworks," "pulse," "wave"

3.4 Send stop command

public class YourLovenseToyUI : MonoBehaviour {

   private void DoSendStop(List<LovenseRemoteToy> toys) {

      LovenseRemote.GetInstance().SendStopFunction(toys);

   }

   //callback function,parames is ControlToysResult
   private void OnControlToysResult(string id,ControlToysResult result){
      //...
   }

   void Awake() {
      // Add listener//
      LovenseRemote.onControlToysEvent.AddListener(OnControlToysResult);
   } 

   void OnDestroy() {
       // Remove listener:
      LovenseRemote.onControlToysEvent.RemoveListener(OnControlToysResult);
   }
}

4. Events of toys

You need to enable the game mode in Lovense Remote and establish the connection before calling the following methods.

See How to use Toy Events API

public class YourLovenseToyUI : MonoBehaviour {

   private void DoSendStop(string ip,int port,bool isSSL) {
       LovenseRemote.GetInstance().AddEventApiListener(ip, port, isSSL);
      
   }

   //callback function,parames is ControlToysResult
   private void OnEventOfApi(string ip,EventApiType eve){
      //...
   }

   private void OnEventOfGetToys(string ip,List<EventToy> toys) {
     //...
   }

   private void OnEventOfButton(string ip,string id,int target,ButtonActionType type){
      //...
   }

   private void OnEventOfFunction(string ip,string id,FunctionValue functionValue){
      //...
   }

   private void OnEventOfFunctionWithShake(string ip,string id,float value){
      //...
   }

   private void OnEventOfToyStatus(string ip,string id,bool connected){
     //...
   }

    private void OnEveryShake(string ip,string id){
     //...
    }
    

   void Awake() {
      // Add listener
       LovenseRemote.eventOfApi.AddListener(OnEventOfApi);
       LovenseRemote.eventOfGetToys.AddListener(OnEventOfGetToys);

       LovenseRemote.eventOfButton.AddListener(OnEventOfButton);
       LovenseRemote.eventOfFunction.AddListener(OnEventOfFunction);
       LovenseRemote.eventOfShakeFrequencyChanged.AddListener(OnEventOfFunctionWithShake);
       LovenseRemote.eventOfToyStatus.AddListener(OnEventOfToyStatus);
       LovenseRemote.eventOfEveryShake.AddListener(OnEveryShake);
   } 

   void OnDestroy() {
       // Remove listener:
       LovenseRemote.eventOfApi.RemoveListener(OnEventOfApi);
       LovenseRemote.eventOfGetToys.RemoveListener(OnEventOfGetToys);

       LovenseRemote.eventOfButton.RemoveListener(OnEventOfButton);
       LovenseRemote.eventOfFunction.RemoveListener(OnEventOfFunction);
       LovenseRemote.eventOfShakeFrequencyChanged.RemoveListener(OnEventOfFunctionWithShake);
       LovenseRemote.eventOfToyStatus.RemoveListener(OnEventOfToyStatus);
       LovenseRemote.eventOfEveryShake.RemoveListener(OnEveryShake);
   }
}

Interface

LovenseRemote

Method

GetInstance

• Description:

  Get the singleton instance of LovenseRemote

• Parameters: None

• Return:

  LovenseRemote instance

SearchRemoteApp

• Description:

  Search for the Lovense Remote App and toys on the LAN, when the search is complete, the onSearchLocalAppEvent event will be triggered.

• Parameters: None

• Return: None

GetToys

• Description:

  Get the active toy list through the Remote App domain and port, when the search is complete, the onGotToysEvent event will be triggered.

• Parameters:

  Name	Type	Default	Required	Description
  domain	string		yes	The Domain of the Lovense Remote App
  port	int	30010	no	The port of the Lovense Remote App
  isUseHttps	bool	true	no	Whether to use https or http to communicate with the Lovense Remote App

• Return: None

GetSupportCommandsByName

• Description:

  Obtain Command types supported by toys through their names

• Parameters:

  Name	Type	Description
  name	string	the name of toy

• Return: List<LovenseCommandType>

SendFunctions

• Description:

  Send function commands to the toys.

• Parameters:

  Name	Type	Default	Required	Description
  toys	List<LovenseRemoteToy>		yes	The toys you want to control
  commands	List<LovenseCommand>		yes	See LovenseCommand
  timeSec	float		yes	The total runtime in second, "0" = indefinite time length. Otherwise, the value should be greater than or equal to 1.
  loopRunningSec	float	0	no	time running for each command loop in second,the value should be greater than or equal to 1.
  loopPauseSec	float	0	no	time gap for each command loop in second ,the value should be greater than or equal to 1.
  stopPrevious	int	1	no	Stop previous command, if set to 0 the previous command will not stop

• Return: None

SendPattern

• Description:

  Send a series of functions to the toys, all the functions will be excecuted in types according to the order of the level in strengthValues with the interval of intervalsMs.

• Parameters:

  Name	Type	Default	Required	Description
  toys	List<LovenseRemoteToy>		yes	The toys you want to control
  types	List<LovenseCommandType>		yes	See LovenseCommandType
  strengthValues	List<int>		yes	The order of the levels
  timeSec	float		yes	The total runtime in second, "0" = indefinite time length. Otherwise, the value should be greater than or equal to 1.
  intervalsMs	float	150	no	The level interval in milliseconds ,Should be greater than 100 ,default 150

• Return: None

SendPreset

• Description:

  Send a preset command to the toys.

• Parameters:

  Name	Type	Default	Required	Description
  toys	List<LovenseRemoteToy>		yes	The toys you want to control
  presetName	string		yes	The preset name to send, we provide four preset patterns in the Lovense Remote app: pulse, wave, fireworks, earthquake
  timeSec	float		yes	The total runtime in second, "0" = indefinite time length. Otherwise, the value should be greater than or equal to 1.

• Return: None

SendStopFunction

• Description:

  Send a stop command to the toys.

• Parameters:

  Name	Type	Description
  toys	List<LovenseRemoteToy>	The toys you want to stop

• Return: None

AddEventApiListener

• Description:  Add events API listener, will trigger eventOfApi and eventOfGetToys if any toy under the local network supports Events API.

• Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's ip
  port	int	The Lovense Remote App's port
  isSSL	bool	Determine whether to use SSL protocol, default value is false

• Return: None

RemoveEventApiListener

• Description:

  Remove the event API listener under the specified local IP and port.

• Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's ip
  port	int	The Lovense Remote App's port

• Return: None

CloseAllEventApi

• Description:

  Remove all event API connection.

• Parameters:None

• Return: None

Event

onGetAppsEvent

• Description:

  Triggered when the search for the Lovense Remote App is complete.

• Callback Parameters:

  Name	Type	Description
  appDatas	List<RemoteAppData>	The search result

onGetAppsErrorEvent

• Description:

  Triggered when getting Lovense Remote App is on error.

• Callback Parameters:

  Name	Type	Description
  errorMsg	string	Error message

onGotToysEvent

• Description:

  Triggered when getting toy list is complete.

• Callback Parameters:

  Name	Type	Description
  toys	List<LovenseRemoteToy>	The toys of getting

onGetToysErrorEvent

• Description:

  Triggered when getting toy list is on error.

• Callback Parameters:

  Name	Type	Description
  errorMsg	string	Error message

onControlToysEvent

• Description:

  Triggered when sending commands is complete.

• Callback Parameters:

  Name	Type	Description
  result	ControlToysResult	The result

eventOfApi

• Description:

  Triggered when the events API status has changed.

• Callback Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's IP
  eve	EventApiType	See EventApiType

eventOfGetToys

• Description:

  Triggered when the events API has been enabled and the toys under local network support Events API.

• Callback Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's IP
  toys	List<EventToy>	the toys which support events api, See EventToy

eventOfToyStatus

• Description:

  Triggered when the connection status of the toy changes.

• Callback Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's IP
  id	string	The toy's id
  connected	bool	The toy's connection status

eventOfButton

• Description:

  Triggered when the toy's button is pressed.

• Callback Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's IP
  id	string	The toy's id
  index	bool	The index of the corresponding button. 0 represents button controls the vibration and 1 represents button controls the inflation/rotation.
  type	ButtonActionType	See ButtonActionType

eventOfFunction

• Description:

  Triggered when the parameter functionValue of the toy changed.

• Callback Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's IP
  id	string	The toy's id
  value	FunctionValue	See FunctionValue

eventOfShakeFrequencyChanged

• Description:

  Triggered when the shake value of the toy changed.

• Callback Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's IP
  id	string	The toy's id
  value	float	The value of shake

eventOfEveryShake

• Description:

  Trigger when user shakes the toy every time.

• Callback Parameters:

  Name	Type	Description
  ip	string	The Lovense Remote App's IP
  id	string	The toy's id

RemoteAppData

• Description:

  The connection information and status of the Lovense Remote App.

• Properties:

  Name	Type	Description
  online	bool	The status of the Lovense Remote App, true represents online, false represents offline
  domain	string	The domain of the Lovense Remote App
  httpsPort	int	The https port of the Lovense Remote App
  wssPort	int	The wss port of the Lovense Remote App

LovenseRemoteToy

• Description:

  The information of the Lovense toy.

• Properties:

  Name	Type	Description
  domain	string	The domain of the Lovense Remote App that the toy is connected to
  port	int	The port of the Lovense Remote App that the toy is connected to
  isHttps	bool	Whether to use https or http to communicate with the Lovense Remote App
  id	string	The toy's id
  status	string	The toy's status, 1 represents connected, 0 represents disconnected
  name	string	The toy's name, such as "nora"
  nickName	string	The toy's nickname, such as "My Nora"
  battery	int	The toy's battery level, from 0 to 100

LovenseCommand

• Description:

  The toy control command.

• Properties:

  Name	Type	Description
  type	LovenseCommandType	See below
  value	int	Function level

Function Level:

Type	Range
VIBRATE	0 - 20
ROTATE	0 - 20
PUMP	0 - 3
SUCTION	0 - 20
FINGERING	0 - 20
THRUSTRING	0 - 20

LovenseCommandType

• Description:

  The enum of the toy function type.

• Enum:

  Value
  VIBRATE
  ROTATE
  PUMP
  THRUSTRING
  FINGERING
  SUCTION

ControlToysResult

• Description:

  The result of the toy control command.

• Properties:

  Name	Type	Description
  code	int	The result code
  type	string	The result type

Result Code:

Code	Description
0	The request has an HTTP error or a network error
200	Success
400	Invalid Command
401	Toy Not Found
402	Toy Not Connected
403	Toy Doesn't Support This Command
404	Invalid Parameter
500	HTTP server not started or disabled
506	Server Error.Restart Lovense Connect

EventApiType

• Description:

  The enum of the events API type.

• Enum:

  Value	Description
  EVENT_OPEN	the events api has opened
  EVENT_ERROR	the events api is on error
  EVENT_GRANTED	the events open and granted the app name
  EVENT_CLOSE	the events api has closed

EventToy

• Description:

  The toys that support events API.

• Properties:

  Name	type
  id	string
  name	string
  type	string
  hVersion	string
  fVersion	int
  nickname	string
  battery	int
  connected	bool

ButtonActionType

• Description:

  The enum of the button action type.

• Enum:

  Value
  BUTTON_DOWN
  BUTTON_UP
  BUTTON_PRESSED

FunctionValue

• Description:

  The events API's action values.

• Properties:

  Name	type
  type	See FunctionType
  index	int
  value	int

FunctionType

• Description:

The enum of the function type.

• Enum:

  Value
  VIBRATE
  ROTATE
  INFLATION
  THRUSTING
  DEPTH
  BATTERY

Version Records

Version1.3 --------------------Date:2023.9.27

1.Add events API of Lovense Remote App.

Version1.2 --------------------Date:2023.9.12

1.Add a function that can query toy support instructions

2.Finding an empty Remote App or empty toy also triggers an event.

3.Change type of 'strengthValues' int[] to List<int> in pattern function

4.Change time type int to float.

5.Event [onControlToysEvent] add parames 'toyId'

Version1.1 --------------------Date:2023.8.25

1.Add onGetAppsErrorEvent and onGetAppsErrorEvent when the request has an HTTP error or a network error.

2.Add a error code when control toys has occus an HTTP error or a network error.

Version1.0 --------------------Date:2023.8.20

1.Functions

2.Pattern

3.Preset