Skip to content

Follow

Be With Me AKA Follow Mode tells temi to search for a person that is standing next to it, lock on and then follow it's movement. Generally, a user would click on temi's top hard button or verbally ask temi to follow them, however, with the SDK you can trigger this feature programatically. temi also has the option to constraint follow, in this case temi tracks only on its axis using turn and tilt but with no movement.


API Overview

ReturnMethodDescription
voidbeWithMe()Initiate follow mode
voidconstraintBeWith()Initiate constraint follow mode
InterfaceDescription
OnBeWithMeStatusChangedListenerListener for follow mode status
OnConstraintBeWithStatusChangedListenerListener for constraint follow mode status

Methods

beWithMe()

Use this method to manually invoke the follow mode. Follow mode is the state where temi searches for a person standing in front of it and once found it locks on and follows their movement until told otherwise.

  • Parameters

    ParameterTypeDescription
    speedLevelSpeedLevelcontrol the follow speed, set null to use system settings, added in 1.135.1 SDK, supported by 135 Launcher
  • Prototype

    java
    void beWithMe(SpeedLevel speedLevel);
  • Required permissions

    None.

  • Support from

    0.10.35


constraintBeWith()

Use this method to manually invoke the constraint follow mode. Constraint Follow mode is the state where temi searches for a person standing in front of it and once found it locks on to their movement until told otherwise. Unlike the regular follow in constraint mode temi only tilts and turns on its' axis it does not leave its' position.

  • Prototype

    java
    void constraintBeWith();
  • Required permissions

    None.

  • Support from

    0.10.35


Interfaces

OnBeWithMeStatusChangedListener

Set your context to implement this listener and add the override method to get the latest status regarding the follow mode. Possible statuses for follow mode are (value in parentheses is the actual string value that will be returned).

Prototype

java
package com.robotemi.sdk.listeners;

interface OnBeWithMeStatusChangedListener {}

Static constants

All constants here are only for the status of following.

ConstantTypeValueDescription
ABORTString"abort"When the user or temi aborts the follow action
CALCULATINGString"calculating"When temi gets stuck following due to an obstacle and is trying to figure its' way around it
SEARCHString"search"Follow mode is triggered and temi is looking for a person to follow
STARTString"start"temi temi has found a person and following has began
TRACKString"track"temi is following
OBSTACLE_DETECTEDString"obstacle detected"temi detected obstacles

Abstract methods

  • Parameters

    ParametersTypeDescription
    statusStringStatus of following mode
  • Prototype

    java
    void onBeWithMeStatusChanged(String status);

Method for adding listener

  • Parameters

    ParameterTypeDescription
    listenerOnBeWithMeStatusChangedListenerThe object of the class implements this listener interface
  • Prototype

    java
    void addOnBeWithMeStatusChangedListener(OnBeWithMeStatusChangedListener listener);

Method for removing listener

  • Parameters

    ParameterTypeDescription
    listenerOnBeWithMeStatusChangedListenerThe object of the class implements this listener interface
  • Prototype

    java
    void removeOnBeWithMeStatusChangedListener(OnBeWithMeStatusChangedListener listener);
  • Support from

    0.10.36


OnConstraintBeWithStatusChangedListener

Set your context to implement this listener and add the override method to get the latest status regarding the constraint follow mode. There are two possible statuses for the constraint follow mode.

Prototype

java
package com.robotemi.sdk.listeners;

interface OnConstraintBeWithStatusChangedListener {}

Abstract methods

  • Parameters

    ParametersTypeDescription
    isConstraintbooleanIn constraint follow mode or not
  • Prototype

    java
    void onConstraintBeWithStatusChanged(boolean isConstraint);

Method for adding listener

  • Parameters

    ParameterTypeDescription
    listenerOnConstraintBeWithStatusChangedListenerThe object of the class implements this listener interface
  • Prototype

    java
    void addOnConstraintBeWithStatusChangedListener(OnConstraintBeWithStatusChangedListener listener);

Method for removing listener

  • Parameters

    ParameterTypeDescription
    listenerOnConstraintBeWithStatusChangedListenerThe object of the class implements this listener interface
  • Prototype

    java
    void removeOnConstraintBeWithStatusChangedListener(OnConstraintBeWithStatusChangedListener listener);
  • Support from

    0.10.49