Skip to content

Utils

Jump to bottom
zjn0505 edited this page Dec 2, 2024 · 43 revisions

System Settings Related

API Overview

Return Method Description
String getSerialNumber() Get temi's Serial Number
BatteryData getBatteryData() Get temis's Battery information
void showTopBar() Show Top Bar
void hideTopBar() Hide Top Bar
void showAppList() Show App List
boolean isHardButtonsDiabled() Is Hard Buttons disabled
void setHardButtonsDisabled(boolean disable) Disable/Enable Hard Buttons
boolean getPrivacyMode() Is Privacy Mode on
void setPrivacyMode(boolean on) Turn on/off Privacy Mode
String getLauncherVersion() Get the version of Launcher
String getRoboxVersion() Get the version of Robox
void toggleWakeup() Disable(Enable) wake-up
boolean isWakeupDisabled() Check is wake-up disabled
void toggleNavigationBillboard() Hide(show) billboard during go to
boolean isNavigationBillboardDisabled() Check is billboard invisible during go to
void setTopBadgeEnabled(boolean enabled) Enable(Disable) top badge
boolean isTopBadgeEnabled() Check is top badge enabled
void setAutoReturnOn(boolean on) Turn on(off) auto-return
boolean isAutoReturnOn() Check is auto-return on
void setVolume(int volume) Set system volume
int getVolume() Get system volume
void setNavigationSafety(SafetyLevel level) Set obstacles avoidance sensitivity level of navigation
SafetyLevel getNavigationSafety() Get obstacles avoidance sensitivity level of navigation
void setGoToSpeed(SpeedLevel level) Set speed level of go-to
SpeedLevel getGoToSpeed() Get speed level of go-to
SafetyLevel getNavigationSafety() Get obstacles avoidance sensitivity level of navigation
int setFollowSpeed(SpeedLevel level) Set speed level of follow
SpeedLevel getFollowSpeed() Get speed level of follow
int setMinimumObstacleDistance() set minimum obstacle distance
int minimumObstacleDistance() Get minimum obstacle distance
void restart() Restart temi
void startPage(Page page) Start system internal page
void setLocked(boolean locked) Enable(disable) protection by password
boolean isLocked() Check is protection enabled
void muteAlexa() Mute Alexa's microphone
void shutdown Shutdown temi
void setSoundMode(SoundMode soundMode) Set the mode of sound
void setHardButtonMode(HardButton type, HardButton.Mode mode) Set mode for the specific hard button
HardButton.Mode getHardButtonMode(HardButton type) Get the mode of the specific hard button
HardButton.Status getButtonStatus(HardButton type) Get the status of the specific hard button
String getNickName() Get temi's nick name
void setMode(Mode mode) Set system mode
Mode getMode() Get system mode
Map<String, Boolean> getSupportedLatinKeyboards() Get all supported Latin keyboards and their enabled status.
void enabledLatinKeyboards(List<String>) Enable the required Latin keyboard
void setGroundDepthCliffDetectionEnabled(boolean enabled) Enable(Disable) ground depth sensor
boolean isGroundDepthCliffDetectionEnabled() Check is ground depth sensor enabled
boolean hasCliffSensor() Check if temi has cliff sensor
void setCliffSensorMode(CliffSensorMode cliffSensorMode) Set the mode of cliff sensor
CliffSensorMode getCliffSensorMode() Check the mode of cliff sensor
void setHeadDepthSensitivity(SensitivityLevel sensitivityLevel) Set the level of the head depth sensitivity
SensitivityLevel getHeadDepthSensitivity() Get the level of the head depth sensitivity
void setFrontTOFEnabled(boolean enabled) Enable(Disable) front TOF sensor
boolean isFrontTOFEnabled() Check is front TOF sensor enabled
void setBackTOFEnabled(boolean enabled) Enable(Disable) back TOF sensor
boolean isBackTOFEnabled() Check is back TOF sensor enabled
boolean isStandByOn() Get StandBy status
int startStandBy() Start StandBy
int stopStandBy() Stop StandBy with optional password
int enableStandBy(Boolean enabled, String password) Turn ON/OFF StandBy Mode
HomeScreenMode getHomeScreenMode() Get current home screen mode
Interface Description
OnBatteryStatusChangedListener Battery Data Status Changed listener
OnPrivacyModeChangedListener Privacy Mode Changed listener
OnDisabledFeatureListUpdatedListener Disabled features list updated listener
OnButtonStatusChangedListener Hard button status listener
Model Description
BatteryData Battery Data
SafetyLevel Obstacles avoidance sensitivity level
SpeedLevel Go to speed level
Page System internal page
SoundMode Sound mode
HardButton.Mode Hard button mode
HardButton.Status Hard button status
Mode System mode
CliffSensorMode The mode of cliff sensor
SensitivityLevel Sensitivity level
HomeScreenMode Home Screen Mode

Methods

getSerialNumber()

Use this method to fetch temi's serial number. This method can be used if you need to use a unique identifier for your temi.

  • Return

    Type Description
    String temi's serial number

  • Prototype

    String getSerialNumber();

  • Required permissions

    None.

  • Support from

    0.10.43

getBatteryData()

Use this method to manually request information on temi's battery. This information includes: Battery percentage and charging status.

  • Return

    Type Description
    BatteryData Battery data

  • Prototype

    BatteryData getBatteryData();

  • Required permissions

    None.

  • Support from

    0.10.43

showTopBar()

Use this method to manually request to show temi's top bar.

  • Prototype

    void showTopBar();

  • Required permissions

    None.

  • Support from

    0.10.43

hideTopBar()

Use this method to manually request to hide temi's top bar

  • Prototype

    void hideTopBar();

  • Required permissions

    None.

  • Support from

    0.10.43

showAppList()

Use this method to manually request to show temi's all apps.

  • Prototype

    void showAppList();

  • Required permissions

    None.

  • Support from

    0.10.36

getPrivacyMode()

Use this method to get temi's privacy mode status.

  • Return

    Type Description
    boolean true if privacy mode is on, false otherwise

  • Prototype

    boolean getPrivacyMode();

  • Required permissions

    None.

  • Support from

    0.10.53

setPrivacyMode()

Use this method to set the status programmatically.

  • Parameters

    Parameter Type Description
    on boolean true to turn on privacy mode, false to turn off

  • Prototype

    void setPrivacyMode(boolean on);

  • Required permissions

Selected Kiosk (Before 129 version), SETTINGS.

  • Support from

    0.10.53

isHardButtonsDisabled()

Use this method to get whether the hardware button is currently disabled.

  • Return

    Type Description
    boolean true if hard buttons is disabled, false otherwise

  • Prototype

    boolean isHardButtonsDisabled();

  • Required permissions

    None.

  • Support from

    0.10.6

setHardButtonsDisabled()

Use this method to disable or enable hard buttons.

  • Parameters

    Parameter Type Description
    disable boolean true to disable the hard buttons, false to enable hard buttons

  • Prototype

    void setHardButtonsDisabled(boolean disable);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.6

getHardButtonMode()

Use this method to get the mode of the specific hard button.

  • Parameters

    Parameter Type Description
    type HardButton Hard button type, [HardButton.MAIN], [HardButton.POWER], [HardButton.VOLUME]

  • Return

    Type Description
    HardButton.Mode The mode of the specific hard button

  • Prototype

    HardButton.Mode getHardButtonMode();

  • Required permissions

    None.

  • Support from

    0.10.77

setHardButtonMode()

Use this method to set hard button mode for the specific hard button.

  • Parameters

    Parameter Type Description
    type HardButton Type of the specific hard button
    mode HardButton.Mode The mode of the specific hard button(ENABLED, DISABLED, MAIN_BLOCK_FOLLOW)

  • Prototype

    void setHardButtonMode(HardButton type, HardButton.Mode mode);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.77

getHardButtonStatus()

Use this method to get the status of the specific hard button.

  • Parameters

    Parameter Type Description
    type HardButton Hard button type, [HardButton.EMERGENCY_STOP]

  • Return

    Type Description
    HardButton.Status The status of the specific hard button

  • Prototype

    HardButton.Status getHardButtonStatus();

  • Required permissions

    None.

  • Support from

    1.134.0

getLauncherVersion()

Use this method to get the version of Launcher.

  • Return

    Type Description
    String The version of Launcher

  • Prototype

    String getLauncherVersion();

  • Required permissions

    None.

  • Support from

    0.10.65

getRoboxVersion()

Use this method to get the version of Robox.

  • Return

    Type Description
    String The version of Robox

  • Prototype

    String getRoboxVersion();

  • Required permissions

    None.

  • Support from

    0.10.65

toggleWakeup()

In kiosk mode you have the option of toggling the wakeup trigger on and off to your liking.

  • Parameters

    Parameter Type Description
    disabled boolean Set true(false) to disable(enable)

  • Prototype

    void toggleWakeup(boolean disabled);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.44

isWakeupDisabled()

Check wheather wake-up is disabled.

  • Return

    Type Description
    boolean true(false) means disabled(enabled)

  • Prototype

    boolean isWakeupDisabled();

  • Required permissions

    None.

  • Support from

    0.10.70

toggleNavigationBillboard()

In kiosk mode you have the option of toggling the visibility of the navigation billboard when you perform goTo commands.

  • Parameters

    Parameter Type Description
    disabled boolean Set true(false) to hide(show)

  • Prototype

    void toggleNavigationBillboard(boolean disabled);

  • Required permissions

    Selected Kiosk (Before 129 version),Settings

  • Support from

    0.10.44

isNavigationBillboardDisabled()

Check wheather navigation billboard is invisible.

  • Return

    Type Description
    boolean true(false) means invisible(visible)

  • Prototype

    boolean isNavigationBillboardDisabled();

  • Required permissions

    None.

  • Support from

    0.10.70

setTopBadgeEnabled()

Enable(Disable) top green badge. When badge is enabled, the movement status will be displayed in the top badge in real time when following, navigating, etc.

  • Parameters

    Parameter Type Description
    enabled boolean Set true(false) to enable(disable) top badge

  • Prototype

    void setTopBadgeEnabled(boolean enabled);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.70

isTopBadgeEnabled()

Check wheather top badge is enabled. Enabled is as the default.

  • Return

    Type Description
    boolean true(false) means enabled(disabled)

  • Prototype

    boolean isTopBadgeEnabled();

  • Required permissions

    None.

  • Support from

    0.10.70

setAutoReturnOn()

Enable(disable) auto return. With Auto Return ON, temi will return to one of your locations after a predefined amount of time. How to set up in Launcher: Settings > General > Auto Return > Duration or Locations.

  • Parameters

    Parameter Type Description
    on boolean Set true(false) to turn on(off) auto return

  • Prototype

    void setAutoReturnOn(boolean on);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.70

isAutoReturnOn()

Check wheather auto return is on. Off is as the default.

  • Return

    Type Description
    boolean ture(false) means auto return is on(off)

  • Prototype

    boolean isAutoReturnOn();

  • Required permissions

    None.

  • Support from

    0.10.70

setVolume()

Set the volume of system, the value range is 0-10. In the system, you can adjust the volume by touching the "+" and "-" buttons at the top of head, or by sliding up from the bottom edge of the screen to pop up the volume and brightness adjustment sliders, and sliding the volume adjustment slider left and right to adjust the volume.

  • Parameters

    Parameter Type Description
    volume int volume

  • Prototype

    void setVolume(int volume);

  • Required permissions

    Settings

  • Support from

    0.10.70

getVolume()

Get the current system volume, the range is 0-10.

  • Return

    Type Description
    int Current volume

  • Prototype

    int getVolume();

  • Required permissions

    None.

  • Support from

    0.10.70

setNavigationSafety()

Set the sensitivity level of obstacle avoidance during navigation. How to set in Launcher: Settings > Navigation > Obstacle avoidance sensitivity.

  • Parameters

    Parameter Type Description
    level SafetyLevel Obstacle avoidance sensitivity level

  • Prototype

    void setNavigationSafety(SafetyLevel level);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.70

getNavigationSafety()

Get current navigation safety level.

  • Return

    Type Description
    SafetyLevel Current obstacle avoidance sensitivity level

  • Prototype

    SafetyLevel getNavigationSafety();

  • Required permissions

    None.

  • Support from

    0.10.70

setGoToSpeed()

Set speed level of go to. How to set in Launcher: Launcher > Navigation > “Go To” configuration > Speed Control.

  • Parameters

    Parameter Type Description
    level SpeedLevel Speed level

  • Prototype

    void setGoToSpeed(SpeedLevel level);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.70

getGoToSpeed()

Get the speed level of go to.

  • Return

    Type Description
    SpeedLevel Current speed level of go to

  • Prototype

    SpeedLevel getGoToSpeed();

  • Required permissions

    None.

  • Support from

    0.10.70

setFollowSpeed()

Set speed level of follow.

  • Parameters

    Parameter Type Description
    level SpeedLevel Speed level

  • Return

    Type Description
    int 0 not support by current launcher
    200 success
    400 invalid parameter
    403 SETTINGS Permission required

  • Prototype

    int setFollowSpeed(SpeedLevel level);

  • Required permissions

    Settings

  • Support from

    1.135.1

getFollowSpeed()

Get the speed level of follow.

  • Return

    Type Description
    SpeedLevel Current speed level of follow

  • Prototype

    SpeedLevel getFollowSpeed();

  • Required permissions

    None.

  • Support from

    1.135.1

setMinimumObstacleDistance()

Set minimum obstacle distance to add more safe margin in navigation when you robot is wider than normal because of some add-ons.

  • Parameters

    Parameter Type Description
    value int Value of distance in meters, range from 0 to 100, step by 5

  • Return

    The value that was set as integer.

    Return 0 may stand for failure

  • Prototype

    int setMinimumObstacleDistance(int value);

  • Required permissions

    Settings

  • Support from

    1.131.4

minimumObstacleDistance()

Get value of minimum obstacle distance.

  • Return

    Type Description
    int Distance in meters, or error code 400 or 403, if invalid argument or permission required.

  • Prototype

    int minimumObstacleDistance();

  • Required permissions

    None.

  • Support from

    1.131.4

restart()

Using this method to restart temi.

  • Prototype

    void restart();

  • Required permissions

    Selected Kiosk

  • Support from

    0.10.72

startPage()

Using this method to start system internal page.

  • Parameters

    Parameter Type Description
    page Page System page

  • Prototype

    void startPage(Page page);

  • Required permissions

    None.

  • Support from

    0.10.72

setLocked()

Using this method to enable(disable) protection by password.

  • Parameters

    Parameter Type Description
    locked boolean Set true(false) to enable(disable) protection

  • Prototype

    void setLocked(boolean);

  • Required permissions

    Settings

  • Support from

    0.10.74

isLocked()

Check whether the protection by password is on.

  • Return

    Type Description
    boolean ture(false) means protection by password is enabled(disabled)

  • Prototype

    boolean isLocked();

  • Required permissions

    None.

  • Support from

    0.10.74

muteAlexa()

Using this method to mute Alexa's microphone. The microphone resource will be occupied when the assistant Alexa is selected. So using this to release the microphone if you want to use that in your App.

  • Prototype

    void muteAlexa();

  • Support from

    0.10.75

shutdown()

Using this method to shutdown temi.

  • Prototype

    void shutdown();

  • Required permissions

    Selected Kiosk

  • Support from

    0.10.77

setSoundMode()

Use this method to set the sound mode(NORMAL, VIDEO_CALL) that is for improving the user experience of sound in the video call scenario.

  • Parameters

    Parameter Type Description
    soundMode SoundMode The sound mode to be set

  • Prototype

    void setSoundMode(SoundMode soundMode);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.77

  • Note

    To improve user experience, if you set the sound mode to video call mode when you start your own video call application, it is recommended to switch the sound mode back to normal mode after ending the video call (NORMAL).

getNickName()

Use this method to get the nick name of temi.

  • Return

    Type Description
    String temi's nick name

  • Prototype

    String getNickName();

  • Required permissions

    None.

  • Support from

    0.10.77

setMode()

Use this method to set temi's system mode(Default, Greet, Privacy). You can also set the mode manually in Settings > Modes.

  • Parameters

    Parameter Type Description
    mode Mode System mode

  • Prototype

    void setMode(Mode mode);

  • Required permissions

    Selected kiosk (Before 129 version), Settings

  • Support from

    0.10.77

getMode()

Use this method to get the current system mode of temi.

  • Return

    Type Description
    Mode Current system mode of temi

  • Prototype

    Mode getMode();

  • Required permissions

    None.

  • Support from

    0.10.77

getSupportedLatinKeyboards()

Use this method to get all supported Latin keyboards and their enabled status.

  • Return

    Type Description
    Map<String, Boolean> Specific language and corresponding enabled status

  • Prototype

    Map<String, Boolean> getSupportedLatinKeyboards();

  • Required permissions

    None.

  • Support from

    0.10.77

enabledLatinKeyboards()

Use this method to enable the required Latin keyboard.

  • Parameters

    Parameter Type Description
    keyboards List<String> The list of required Latin keyboards and its first element will be the current selected keyboard. Get all supported Latin keyboards by method getSupportedLatinKeyboards().

  • Prototype

    void enabledLatinKeyboards(List<String> keyboards);

  • Required permissions

    Settings

  • Support from

    0.10.77

setGroundDepthCliffDetectionEnabled()

Use this method to enable(disable) the ground depth sensor. You can also set it manually in Settings > Navigation > Sensors Settings.

  • Parameters

    Parameter Type Description
    enabled boolean Set true(false) to enable(disable) ground depth sensor

  • Prototype

    void setGroundDepthCliffDetectionEnabled(boolean enabled);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.78

isGroundDepthCliffDetectionEnabled()

Use this method to check wheather the ground depth sensor is enabled, You can also check it manually in Settings > Navigation > Sensors Settings.

  • Return

    Type Description
    boolean true(false) means ground depth sensor is enabled(disabled)

  • Prototype

    boolean isGroundDepthCliffDetectionEnabled();

  • Required permissions

    None.

  • Support from

    0.10.78

hasCliffSensor()

Use this method to check wheather temi has cliff sensor.

  • Return

    Type Description
    boolean true(false) means temi has(does not have) cliff sensor

  • Prototype

    boolean hasCliffSensor();

  • Required permissions

    None.

  • Support from

    0.10.78

setCliffSensorMode()

Use this method to set the mode of cliff sensor. You can also set it manually in Settings > Navigation > Sensors Settings.

Note, the premise of effectively calling this method is that the machine has a cliff sensor, how to check whether the machine has a cliff sensor.

  • Parameters

    Parameter Type Description
    cliffSensorMode CliffSensorMode The mode of cliff sensor

  • Prototype

    void setCliffSensorMode(CliffSensorMode cliffSensorMode);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.78

getCliffSensorMode()

Use this method to get the mode of cliff sensor. You can also check it manually in Settings > Navigation > Sensors Settings.

Note, the premise of effectively calling this method is that the machine has a cliff sensor, how to check whether the machine has a cliff sensor.

  • Return

    Type Description
    CliffSensorMode The mode of cliff sensor

  • Prototype

    CliffSensorMode getCliffSensorMode();

  • Required permissions

    None.

  • Support from

    0.10.78

setHeadDepthSensitivity()

Use this method to set the sensitivity level of head depth sensor. You can also set it manually in Settings > Navigation > Sensors Settings.

  • Parameters

    Parameter Type Description
    sensitivityLevel SensitivityLevel Sensitivity level of head depth sensor

  • Prototype

    void setHeadDepthSensitivity(SensitivityLevel sensitivityLevel);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.78

getHeadDepthSensitivity()

Use this method to get the sensitivity level of head depth sensor. You can also check it manually in Settings > Navigation > Sensors Settings.

  • Return

    Type Description
    SensitivityLevel Sensitivity level of head depth sensor

  • Prototype

    SensitivityLevel getHeadDepthSensitivity();

  • Required permissions

    None.

  • Support from

    0.10.78

setFrontTOFEnabled()

Use this method to enable(disable) the front TOF sensor. You can also set it manually in Settings > Navigation > Sensors Settings.

  • Parameters

    Parameter Type Description
    enabled boolean Set true(false) to enabel(disable) front TOF sensor

  • Prototype

    void setFrontTOFEnabled(boolean enabled);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.78

isFrontTOFEnabled()

Use this method to check wheather the front TOF sensor is enabeld. You can also check it manually in Settings > Navigation > Sensors Settings.

  • Return

    Type Description
    boolean true(false) means enabled(disabled)

  • Prototype

    boolean isFrontTOFEnabled();

  • Required permissions

    None.

  • Support from

    0.10.78

setBackTOFEnabled()

Use this method to enable(disable) the back TOF sensor. You can also set it manually in Settings > Navigation > Sensors Settings.

  • Parameters

    Parameter Type Description
    enabled boolean Set true(false) to enabel(disable) back TOF sensor

  • Prototype

    void setBackTOFEnabled(boolean enabled);

  • Required permissions

    Selected Kiosk (Before 129 version), Settings

  • Support from

    0.10.78

isBackTOFEnabled()

Use this method to check wheather the back TOF sensor is enabeld. You can also check it manually in Settings > Navigation > Sensors Settings.

  • Return

    Type Description
    boolean true(false) means enabled(disabled)

  • Prototype

    boolean isBackTOFEnabled();

  • Required permissions

    None.

  • Support from

    0.10.78

isStandByOn()

Get StandBy status

  • Return

    Type Description
    boolean true if under standBy status, false if not, null if check failed

  • Prototype

    boolean isStandByOn();

  • Required permissions

    None.

  • Support from

    1.129.0

startStandBy()

Start StandBy

  • Return

    Type Description
    int Check result code below
    • -1 for failed to request, maybe robot is not ready
    • 0 for standBy is started
    • 1 for standBy was already running
    • 2 for standby if disabled in settings
    • 3 for robot is busy, e.g. OTA, Greet Mode
    • 403 for SETTINGS permission required
    • 429 for too many requests, should be longer than 5 seconds between 2 calls

  • Prototype

    int startStandBy();

  • Required permissions

    SETTINGS

  • Support from

    1.129.0

stopStandBy()

Stop StandBy with optional password.

  • Parameters

    Parameter Type Description
    password String When temi requires password to unlock, this method only works when here a valid password is passed.
    Default as empty

  • Return

    Type Description
    int Check result code below
    • -1 for failed to request, maybe robot is not ready
    • 0 for standBy is stopped
    • 1 for standBy was not running
    • 2 for password required
    • 3 for wrong password
    • 403 for SETTINGS permission required
    • 429 for too many requests, should be longer than 5 seconds between 2 calls

  • Prototype

    void stopStandBy(String password);

  • Required permissions

    Settings

  • Support from

    1.129.0

enableStandBy()

Enable or disable StandBy Mode, Disable may need password.

  • Parameters

    Parameter Type Description
    enabled Boolean true or false to turn ON/OFF StandBy Mode
    password String When temi requires password to unlock, this method only works when here a valid password is passed.
    Default as empty

  • Return

    Type Description
    int Check result code below
    • -1 for failed to request, maybe robot is not ready
    • 0 for operation failed
    • 1 for operation succeed.
    • 2 for password required
    • 3 for wrong password
    • 403 for SETTINGS permission required
    • 429 for too many requests, should be longer than 5 seconds between 2 calls

  • Prototype

    int enableStandBy(Boolean enabled, String password);

  • Required permissions

    Settings

  • Support from

    1.131.0

getHomeScreenMode()

Get current home screen mode,

  • Return

    Type Description
    HomeScreenMode Current home screen mode

  • Prototype

    HomeScreenMode getHomeScreenMode();

  • Required permissions

    None

  • Support from

    1.135.1


Interfaces

Below are details regarding utils listeners.

OnBatteryStatusChangedListener

This listener will listen to the status of battery data changed. Set your context to implement this listener and add the override method to get the battery status changes.

Prototype

package com.robotemi.sdk.listener;

interface OnBatteryStatusChangedListener {}

Abstract methods

  • Parameters

    Parameters Type Description
    batteryData BatteryData BatteryData object containing temi's battery status information

  • Prototype

    void onBatteryStatusChanged(BatteryData batteryData);

Method for adding listener

  • Parameters

    Parameter Type Description
    listener OnBatteryStatusChangedListener The object of the class implements this listener interface

  • Prototype

    void addOnBatteryStatusChangedListener(OnBatteryStatusChangedListener listener);

Method for removing listener

  • Parameters

    Parameter Type Description
    listener OnBatteryStatusChangedListener The object of the class implements this listener interface

  • Prototype

    void removeOnBatteryStatusChangedListener(OnBatteryStatusChangedListener listener);

Support from

0.10.53

OnPrivacyModeChangedListener

This listener will listen to the status of privacy mode changed. Set your context to implement this listener and add the override method to get the privacy mode state changes.

Prototype

package com.robotemi.sdk.listener;

interface OnPrivacyModeChangedListener {}

Abstract methods

  • Parameters

    Parameter Type Description
    state boolean state will be true if privacy mode is on else flase

  • Prototype

    void onPrivacyModeChanged(boolean state);

Method for adding listener

  • Parameters

    Parameter Type Description
    listener OnPrivacyModeChangedListener The object of the class implements this listener interface

  • Prototype

    void addOnPrivacyModeStateChangedListener(OnPrivacyModeChangedListener listener);

Method for removing listener

  • Parameters

    Parameter Type Description
    listener OnPrivacyModeChangedListener The object of the class implements this listener interface

  • Prototype

    void removeOnPrivacyModeStateChangedListener(OnPrivacyModeChangedListener listener);

Support from

0.10.53

OnSdkExceptionListener

Set your context to implement this listener and add the override method to get the exception message in using temi SDK API(Such as permission denied, invoke too frequently), so that developers can quickly locate the problem to improve development efficiency.

Prototype

package com.robotemi.sdk.exception;

interface OnSdkExceptionListener {}

Abstract methods

  • Parameters

    Parameter Type Description
    sdkException SdkException temi SDK exception information

  • Prototype

    void onSdkError(SdkException sdkException);

Method for adding listener

  • Parameters

    Parameter Type Description
    listener OnSdkExceptionListener The object of the class implements this listener interface

  • Prototype

    void addOnSdkExceptionListener(OnSdkExceptionListener listener);

Method for removing listener

  • Parameters

    Parameter Type Description
    listener OnSdkExceptionListener The object of the class implements this listener interface

  • Prototype

    void removeOnSdkExceptionListener(OnSdkExceptionListener listener);

Support from

0.10.70

OnButtonStatusChangedListener

Set your context to implement this listener and add the override method to get the updates of hard button status.

Prototype

package com.robotemi.sdk.listeners;

interface OnButtonStatusChangedListener {}

Abstract methods

  • Parameters

    Parameter Type Description
    hardButton HardButton Button type, only support Emergency Stop button.
    status HardButton.Status Button status

  • Prototype

    void onButtonStatusChanged(HardButton hardButton, HardButton.Status status);

Method for adding listener

  • Parameters

    Parameter Type Description
    listener OnButtonStatusChangedListener The object of the class implements this listener interface

  • Prototype

    void addOnButtonStatusChangedListener(OnButtonStatusChangedListener listener);

Method for removing listener

  • Parameters

    Parameter Type Description
    listener OnButtonStatusChangedListener The object of the class implements this listener interface

  • Prototype

    void removeOnButtonStatusChangedListener(OnButtonStatusChangedListener listener);

Support from

1.134.0

OnDisabledFeatureListUpdatedListener

Set your context to implement this listener and add the override method to get the updates of the list of disabled features(Navigation, follow, video call...)

Prototype

package com.robotemi.sdk.listeners;

interface OnDisabledFeatureListUpdatedListener {}

Abstract methods

  • Parameters

    Parameter Type Description
    disabledFeatureList List<String> List of disabled features

  • Prototype

    void onDisabledFeatureListUpdated(List<String> disabledFeatureList);

Method for adding listener

  • Parameters

    Parameter Type Description
    listener OnDisabledFeatureListUpdatedListener The object of the class implements this listener interface

  • Prototype

    void addOnDisabledFeatureListUpdatedListener(OnDisabledFeatureListUpdatedListener listener);

Method for removing listener

  • Parameters

    Parameter Type Description
    listener OnDisabledFeatureListUpdatedListener The object of the class implements this listener interface

  • Prototype

    void removeOnDisabledFeatureListUpdatedListener(OnDisabledFeatureListUpdatedListener listener);

Support from

0.10.74


Models

Below are the list of models used in the utils methods.

BatteryData

Object used to hold information regarding temi's battery.

Prototype

package com.robotemi.sdk;

class BatteryData {}

Attributes

Attribute Type Description
level int Battery level in percentage 1-100%
isCharging boolean true if temi is charging else false
battery2Level int The battery level for the second battery, added in 134 version

SafetyLevel

Sensitivity level of obstacle avoidance during navigation.

Prototype

package com.robotemi.sdk.navigation.model;

enum SafetyLevel {
   HIGH,
   MEDIUM;
}

SpeedLevel

Speed level of go to.

Prototype

package com.robotemi.sdk.navigation.model;

enum SpeedLevel {
   HIGH,
   MEDIUM,
   SLOW;
}

SdkException

Exception information in using temi SDK, such as permission denied, invoke too frequently.

Prototype

package com.robotemi.sdk.exception;

class SdkException {}

Attributes

Attribute Type Description
code int Exception code
message String Exception message

Static constants

Constant Type Value Description
CODE_ILLEGAL_ARGUMENT int 400 Illgeal arguments
CODE_PERMISSION_DENIED int 403 Permission denied
CODE_OPERATION_CONFLICT int 409 Operation conflict
CODE_LAUNCHER_ERROR int 500 Interal error in Launcher

Page

System internal page.

The current system interface that can be started

Page Enum Value Value
Settings SETTINGS com.robotemi.page.settings
Map Editor MAP_EDITOR com.robotemi.page.map_editor
Contacts CONTACTS com.robotemi.page.contacts
Locations LOCATIONS com.robotemi.page.locations
App List ALL_APPS com.robotemi.page.all_apps
Home Page HOME com.robotemi.page.home
Tour list (Supported in 132 version) TOURS com.robotemi.page.tours

Prototype

package com.robotemi.sdk.constants;

enum Page {
    SETTINGS,
    MAP_EDITOR,
    CONTACTS,
    LOCATIONS,
    ALL_APPS,
    HOME,
    TOURS;
}

HardButton

Hard button.

Subclass

Mode
Prototype
enum Mode {
    ENABLED,
    DISABLED,
    MAIN_BLOCK_FOLLOW;  // Blocking follow(Only works for the main button).
}
Status
Prototype
enum Status {
    UNKNOWN,
    HOLD,  // emergency button is pressed/hold
    RELEASED;  // emergency button is released.
}

Prototype

package com.robotemi.sdk.constants;

enum HardButton {
    MAIN,  // Main button
    POWER,  // Power button
    VOLUME;  // Volumes buttons
}

SoundMode

Sound mode.

Prototype

package com.robotemi.sdk.constants;

enum SoundMode {
    NORMAL,  // Default mode(for media playing).
    VIDEO_CALL;  // For video call scenarios.
}

Mode

System mode, including Default, Greet and Privacy mode.

Prototype

package com.robotemi.sdk.constants;

enum Mode {
   DEFAULT,
   GREET,
   PRIVACY;
}

CliffSensorMode

The mode of cliff sensor, including Off, low sensitivity and high sensitivity.

Prototype

package com.robotemi.sdk.constants;

enum CliffSensorMode {
    OFF,
    LOW_SENSITIVITY,
    HIGH_SENSITIVITY;
}

SensitivityLevel

Sensitivity level, including low sensitivity and high sensitivity.

Prototype

package com.robotemi.sdk.constants;

enum SensitivityLevel {
    HIGH,
    LOW;
}

HomeScreenMode

The mode of home screen

Prototype

enum class HomeScreenMode {
    DEFAULT,
    CLEAR,
    CUSTOM_SCREEN,
    URL,
    APPLICATION,
}

General

Features

Advanced Features
temi GO

中文版

概要

功能

高级功能

temi GO 送餐送货机器人

Clone this wiki locally