{"id":539,"date":"2023-03-30T17:31:02","date_gmt":"2023-03-30T09:31:02","guid":{"rendered":"https:\/\/doc.orionstar.com\/en\/?post_type=lsvr_kba&p=539"},"modified":"2026-11-03T11:00:54","modified_gmt":"2026-11-03T03:00:54","slug":"sdk-access","status":"publish","type":"lsvr_kba","link":"https:\/\/doc.orionstar.com\/en\/knowledge-base\/sdk-access\/","title":{"rendered":"SDK Access"},"content":{"rendered":"\n

All Robots Except a Few Older Models Use the Same SDK<\/strong><\/p>\n\n\n\n

The robots now share a single, unified SDK, which is included in the demo program. Download the demo program and copy the SDK library file from its libs folder.<\/p>\n\n\n\n

Sample Code<\/a><\/strong><\/p>\n\n\n\n

Demo program download: Click to download<\/a><\/p>\n\n\n\n

Note: <\/mark><\/strong>For the SDK used in the demo, download the jar that matches the robot’s system from the releases <\/a>page.<\/p>\n\n\n\n

Configure the default launch app<\/p>\n\n\n\n

Configure the Manifest file<\/p>\n\n\n\n

<activity android:name=\".MainActivity\">\n    <intent-filter>\n        <action android:name=\"android.intent.action.MAIN\"\/>\n        <category android:name=\"android.intent.category.LAUNCHER\"\/>\n     <\/intent-filter>\n     <intent-filter>\n         <action android:name=\"action.orionstar.default.app\" \/>\n         <category android:name=\"android.intent.category.DEFAULT\" \/>\n     <\/intent-filter>\n<\/activity><\/pre>\n\n\n\n
If the app needs to launch by default after the robot boots, configure the following in the Manifest<\/p>\n\n\n\n
<intent-filter>\n    <action android:name=\"action.orionstar.default.app\" \/>\n    <category android:name=\"android.intent.category.DEFAULT\" \/>\n<\/intent-filter><\/pre>\n\n\n\n
Then set it in Settings (swipe down with three fingers and tap Settings) – Developer Settings \u2013 Boot Apps<\/p>\n\n\n\n
Note: The Boot Apps setting was officially released in OTA3<\/em><\/strong><\/p>\n\n\n\n
Permissions<\/a><\/strong><\/p>\n\n\n\n
For full SDK integration, declare the following permissions in AndroidManifest.xml<\/p>\n\n\n\n
<uses-permission android:name=\"android.permission.INTERNET\"\/>\n<uses-permission android:name=\"com.ainirobot.coreservice.robotSettingProvider\" \/>\n<uses-permission android:name=\"android.permission.WRITE_EXTERNAL_STORAGE\"\/>\n<uses-permission android:name=\"android.permission.READ_EXTERNAL_STORAGE\"\/><\/pre>\n\n\n\n
SDK Access<\/a><\/strong><\/p>\n\n\n\n
1. Create a callback for receiving voice requests and system events<\/p>\n\n\n\n
public class ModuleCallback extends ModuleCallbackApi {\n    @Override\n    public boolean onSendRequest(int reqId, String reqType, String reqText, String reqParam)\n            throws RemoteException {\n        \/\/Receive voice commands\n        \/\/reqTyp : Voice command type\n        \/\/reqText : Speech recognition text\n        \/\/reqParam : Voice command parameters\n        return true;\n    }\n    @Override\n    public void onRecovery()\n            throws RemoteException {\n           \/\/Control is restored. After receiving this event, resume control of the robot\n\n    }\n    @Override\n    public void onSuspend()\n            throws RemoteException {\n           \/\/Control has been taken away by the system. After receiving this event, all API calls are invalid\n\n    }<\/pre>\n\n\n\n
2. Connect to the server<\/p>\n\n\n\n
RobotApi.getInstance().connectServer(this, new ApiListener() {\n    @Override\n    public void handleApiDisabled() {\n    }\n    @Override\n    public void handleApiConnected() {\n        \/\/Server connected. Set the callback for receiving requests, including voice commands, system events, etc.\n        RobotApi.getInstance().setCallback(new ModuleCallback());\n    }\n    @Override\n    public void handleApiDisconnected() {\n        \/\/Disconnected\n    }\n});<\/pre>\n\n\n\n
Initializing the robot SDK means the robot hands over control of the chassis capabilities to the app that is currently running. The robot triggers the disconnected callback when the system takes over, when a fault occurs, or when another program that uses the robot SDK is started. Of these, the connection is re-established only when the system takeover ends.<\/p>\n\n\n\n
Note 1: All APIs can be called only after the connection to the server succeeds<\/em><\/p>\n\n\n\n
Note 2: Only a foreground process running in the foreground can connect correctly and obtain control of the robot chassis. Service processes do not work.<\/em><\/p>\n\n\n\n
3. Set the callback<\/p>\n\n\n\n
RobotApi.getInstance().setCallback(new ModuleCallback());<\/pre>\n\n\n\n
4. Finish the command<\/p>\n\n\n\n
RobotApi.getInstance().finishModuleParser(reqId, result);<\/pre>\n\n\n\n
After a received request or voice command has been processed, call finishModuleParser to finish the command. reqId is obtained from the onSendRequest callback, and result is the execution result.<\/p>\n\n\n\n
5. Register a status listener<\/p>\n\n\n\n
StatusListener statusListener = new StatusListener(){\n    @Override\n    public void onStatusUpdate(String type, String data) throws RemoteException {\n    };\n}\n\/\/Register the status listener\nRobotApi.getInstance().registerStatusListener(type, statusListener);\n\/\/Unregister the status listener\nRobotApi.getInstance().unregisterStatusListener(statusListener);<\/pre>\n\n\n\n
type is the status type to listen for. The following types are supported:<\/p>\n\n\n\n