Package edu.tufts.hrilab.temiv3

Interface TemiV3Interface

All Known Implementing Classes:
MockTemiV3Component
public interface TemiV3Interface

  • Method Details

    • goToLoc

      boolean goToLoc(Symbol location, Boolean escorting)
      checks that location is saved then goes to that location.
      Parameters:
      location - label for location to go to

    • interruptGoToLocation

      void interruptGoToLocation()

    • goToPos

      boolean goToPos(List<Float> goalCoords, Symbol destination, boolean clearScreen)
      Goes to desired coordinates.
      Used when fetch script is enacted from an unknown starting location
      Parameters:
      goalCoords - coordinates to go to

    • followMe

      void followMe()

    • followMeBlocking

      void followMeBlocking()
      Blocking version of followMe (waits for acknowledgement)

    • interruptFollowBlocking

      void interruptFollowBlocking()

    • stopMoving

      void stopMoving()
      Stop moving. Has side effect of causing goToLocationStatus and ReposeStatus to be set to ABORT. We additionally unlock the goToLoc() condition to prevent deadlock upon temi primitives failing.

    • endRepositionLoop

      void endRepositionLoop()
      Utility func for interrupting goToLocation in case we are currently repositioning

    • getRepositionFailure

      boolean getRepositionFailure()
      Helper function to exit with correct failure predicate in case goToLocation fails due to repositioning errors
      Returns:

    • saveLocation

      void saveLocation(Symbol location)
      Stores robots current location
      Parameters:
      location - label for current location

    • interruptSaveLocation

      void interruptSaveLocation()

    • backupLocations

      void backupLocations(Symbol collectionName)

    • restoreLocations

      void restoreLocations(Symbol collectionName)

    • deleteLocationBackup

      void deleteLocationBackup(Symbol collectionName)

    • getLocationBackupCollections

      List<String> getLocationBackupCollections()

    • deleteLocation

      void deleteLocation(Symbol location)
      deletes location with label @location
      Parameters:
      location - label for location to be deleted

    • getCurrentPosition

      List<Float> getCurrentPosition()
      Gets Temi's current x and y coordinates on the map. Used in fetch script to store coordinates to return to when called from an unknown location.
      Returns:
      Temi's x,y coordinates

    • knowsLocation

      boolean knowsLocation(Symbol location)
      Checks whether the temi has stored the supplied location as a known location. Used to exit goToLocation script when appropriate with the correct failure predicate.
      Parameters:
      location - location name to check against temi's known location
      Returns:
      true if there exists a matching location, false otherwise

    • getKnownLocationNames

      List<String> getKnownLocationNames()
      for control app
      Returns:
      list of temi's known location names

    • waitForDetection

      void waitForDetection()
      wait for Temi to detect a person

    • startAcknowledgeDisplay

      void startAcknowledgeDisplay(String message)
      Blocks until acknowledged is set to true

    • endAcknowledgeDisplay

      void endAcknowledgeDisplay()
      sets acknowledged to true

    • freezeTemi

      void freezeTemi()
      Duplicate function necessary for scoping between freeze and underlying paused action acknowledgements

    • endFreezeTemi

      void endFreezeTemi()

    • displayFreezeScreen

      void displayFreezeScreen()

    • endDisplayFreezeScreen

      void endDisplayFreezeScreen()

    • playVideo

      void playVideo(Symbol name)
      play video, blocking until closeVideo() is called

    • closeVideo

      void closeVideo()
      signals videoDone lock allowing playVideo(edu.tufts.hrilab.fol.Symbol) to end and clears the screen

    • display

      void display(Symbol message)
      Linked to language "display" or "display message" Navigates to display fragment with supplied message, not blocking
      Parameters:
      message - message to display on screen

    • clearScreen

      void clearScreen()
      returns temi tablet to main screen

    • showTopBar

      void showTopBar()
      show top bar on temi tablet

    • uploadMap

      void uploadMap(boolean overwrite)
      Sends temi map data to firebase

    • updateHomeBase

      void updateHomeBase(boolean overwriteMap)

    • chargeTemi

      void chargeTemi()
      Linked to Language "charge"
      Behavior which is automatically enacted upon battery reaching a certain percent threshold. Informs the user that the charge behavior is being enacted, then proceeds to navigate to home base and wait either for acknowledgement or to reach back up to a certain battery level. The associated language command "charge" will also cause dialogue to clear the current goal queue, ensuring this task is either immediately executed or first on the queue.

    • displayChargingAlert

      void displayChargingAlert()
      zno displays alert signalling that new tasks cannot be submitted while zno is charging

    • setEscortWaitDuration

      void setEscortWaitDuration(Symbol waitDuration)
      Sets the value stored in SharedPreferences with the key "escortWaitDuration". Used to determine the duration to wait for acknowledgement between requests within the escort script.

    • setEscortWaitAttempts

      void setEscortWaitAttempts(Symbol waitAttempts)
      Sets the value stored in SharedPreferences with the key "escortWaitAttempts". Used to determine the number of times the temi calls out the patient name and waits for acknowledgement within the escort script.

    • setBatteryWarnLevel

      void setBatteryWarnLevel(Symbol warnLevel)
      Sets the value stored in SharedPreferences with the key "chargeWarningPercent". Used to determine battery level upon which to perform a warning sayText to indicate the temi will clear tasks to charge soon

    • setBatteryAbortLevel

      void setBatteryAbortLevel(Symbol abortLevel)
      Sets the value stored in SharedPreferences with the key "chargeActionPercent". Used to determine battery level upon which the temi enacts its charge behavior

    • setBatteryChargedLevel

      void setBatteryChargedLevel(Symbol chargedLevel)
      Sets the value stored in SharedPreferences with the key "chargeAbortPercent". Used to determine battery level upon which the temi enacts its charge behavior

    • getEscortWaitDuration

      long getEscortWaitDuration()
      Gets the value stored in SharedPreferences with the key "escortWaitDuration". Used to determine the duration to wait for acknowledgement between requests within the escort script.

    • getEscortWaitAttempts

      int getEscortWaitAttempts()
      Gets the value stored in SharedPreferences with the key "escortWaitAttempts". Used to determine the number of times the temi calls out the patient name and waits for acknowledgement within the escort script.

    • setVolume

      void setVolume(Symbol volume)
      Calls setVolume from temi sdk
      Parameters:
      volume - value to set volume to

    • setHardButtons

      void setHardButtons(boolean disabled)
      Disables/enables hardButtons on the temi. Currently only acts on the volume buttons and the main top bar, does not affect the power button
      Parameters:
      disabled - true to disable the hardButtons, false to enable them

    • sayText

      void sayText(String message)

    • sayTextDialogueHistory

      void sayTextDialogueHistory(String message)

    • sayTextDialogueHistory

      void sayTextDialogueHistory(String message, boolean wait)

    • enablePrivacyMode

      void enablePrivacyMode()

    • disablePrivacyMode

      void disablePrivacyMode()

    • requestPermissions

      void requestPermissions()

    • restartApp

      void restartApp()

    • enableVoiceAck

      void enableVoiceAck()

    • disableVoiceAck

      void disableVoiceAck()

    • enableButtons

      void enableButtons()

    • disableButtons

      void disableButtons()

    • enableObstacleNotifications

      void enableObstacleNotifications()

    • disableObstacleNotifications

      void disableObstacleNotifications()

    • enableKidsMode

      void enableKidsMode()

    • disableKidsMode

      void disableKidsMode()

    • displayFace

      void displayFace()

    • startQRCodeDisplay

      void startQRCodeDisplay(String url, String header)

    • endQRCodeDisplay

      void endQRCodeDisplay()

    • getLocationNameFromReference

      String getLocationNameFromReference(Symbol locRef)

    • convertPredToReadable

      String convertPredToReadable(String predString)

    • setSayTextBlocks

      void setSayTextBlocks(boolean value)

    • sendPositionUpdate

      void sendPositionUpdate()

    • relocalize

      boolean relocalize(boolean sayText)

    • isLocalized

      boolean isLocalized()

    • checkInKiosk

      void checkInKiosk(Symbol location)

    • interruptCheckIn

      void interruptCheckIn()

    • enableKioskMode

      void enableKioskMode()

    • disableKioskMode

      void disableKioskMode()

    • setKioskTimeout

      void setKioskTimeout(Symbol timeout)

    • setKioskLocation

      boolean setKioskLocation(Symbol location)

    • setDisplayAppointmentsSince

      void setDisplayAppointmentsSince(Symbol time)

    • getDisplayAppointmentsSince

      int getDisplayAppointmentsSince()

    • setAllowAppointmentsSince

      void setAllowAppointmentsSince(Symbol time)

    • getAllowAppointmentsSince

      int getAllowAppointmentsSince()

    • setLateAppointmentMessage

      void setLateAppointmentMessage(Symbol message)

    • getLateAppointmentMessage

      String getLateAppointmentMessage()

    • setDisplayAppointmentsUntil

      void setDisplayAppointmentsUntil(Symbol time)

    • getDisplayAppointmentsUntil

      int getDisplayAppointmentsUntil()

    • setAllowAppointmentsUntil

      void setAllowAppointmentsUntil(Symbol time)

    • getAllowAppointmentsUntil

      int getAllowAppointmentsUntil()

    • setEarlyAppointmentMessage

      void setEarlyAppointmentMessage(Symbol message)

    • getEarlyAppointmentMessage

      String getEarlyAppointmentMessage()

    • setSuccessfulCheckInMessage

      void setSuccessfulCheckInMessage(Symbol message)

    • getSuccessfulCheckInMessage

      String getSuccessfulCheckInMessage()

    • setBirthdayMessageRange

      void setBirthdayMessageRange(Symbol range)

    • getBirthdayMessageRange

      int getBirthdayMessageRange()

    • setBirthdayMessage

      void setBirthdayMessage(Symbol message)

    • getBirthdayMessage

      String getBirthdayMessage()

    • setAppointmentLoadErrorMessage

      void setAppointmentLoadErrorMessage(Symbol message)

    • getAppointmentLoadErrorMessage

      String getAppointmentLoadErrorMessage()

    • setAppointmentListEmptyMessage

      void setAppointmentListEmptyMessage(Symbol message)

    • getAppointmentListEmptyMessage

      String getAppointmentListEmptyMessage()

    • setCheckInHeaderMessage

      void setCheckInHeaderMessage(Symbol message)

    • getCheckInHeaderMessage

      String getCheckInHeaderMessage()

    • ignoreTentativeAccept

      boolean ignoreTentativeAccept(Predicate goalPred)

    • skipsQueue

      boolean skipsQueue(String funcName)