package org.droidplanner.android.notifications;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.content.IntentFilter;
import android.os.Build;
import android.os.Handler;
import android.speech.tts.TextToSpeech;
import android.speech.tts.TextToSpeech.OnInitListener;
import android.support.v4.content.LocalBroadcastManager;
import android.text.TextUtils;
import android.util.Log;
import android.util.SparseBooleanArray;
import android.widget.Toast;
import com.o3dr.android.client.Drone;
import com.o3dr.services.android.lib.drone.attribute.AttributeEvent;
import com.o3dr.services.android.lib.drone.attribute.AttributeEventExtra;
import com.o3dr.services.android.lib.drone.attribute.AttributeType;
import com.o3dr.services.android.lib.drone.attribute.error.ErrorType;
import com.o3dr.services.android.lib.drone.property.Altitude;
import com.o3dr.services.android.lib.drone.property.Battery;
import com.o3dr.services.android.lib.drone.property.Gps;
import com.o3dr.services.android.lib.drone.property.Signal;
import com.o3dr.services.android.lib.drone.property.Speed;
import com.o3dr.services.android.lib.drone.property.State;
import com.o3dr.services.android.lib.drone.property.VehicleMode;
import org.droidplanner.android.R;
import org.droidplanner.android.fragments.SettingsFragment;
import org.droidplanner.android.utils.prefs.DroidPlannerPrefs;
import java.util.HashMap;
import java.util.Locale;
import java.util.concurrent.atomic.AtomicBoolean;
/**
* Implements DroidPlanner audible notifications.
*/
public class TTSNotificationProvider implements OnInitListener,
NotificationHandler.NotificationProvider {
private static final String CLAZZ_NAME = TTSNotificationProvider.class.getName();
private static final String TAG = TTSNotificationProvider.class.getSimpleName();
private static final double BATTERY_DISCHARGE_NOTIFICATION_EVERY_PERCENT = 10;
private static final double MAX_ALTITUDE = 121.92; //meters
/**
* Utterance id for the periodic status speech.
*/
private static final String PERIODIC_STATUS_UTTERANCE_ID = "periodic_status_utterance";
/**
* Action used for message to be delivered by the tts speech engine.
*/
public static final String ACTION_SPEAK_MESSAGE = CLAZZ_NAME + ".ACTION_SPEAK_MESSAGE";
public static final String EXTRA_MESSAGE_TO_SPEAK = "extra_message_to_speak";
private final static IntentFilter eventFilter = new IntentFilter();
static {
eventFilter.addAction(AttributeEvent.STATE_ARMING);
eventFilter.addAction(AttributeEvent.BATTERY_UPDATED);
eventFilter.addAction(AttributeEvent.STATE_VEHICLE_MODE);
eventFilter.addAction(AttributeEvent.MISSION_SENT);
eventFilter.addAction(AttributeEvent.GPS_FIX);
eventFilter.addAction(AttributeEvent.MISSION_RECEIVED);
eventFilter.addAction(AttributeEvent.HEARTBEAT_FIRST);
eventFilter.addAction(AttributeEvent.HEARTBEAT_TIMEOUT);
eventFilter.addAction(AttributeEvent.HEARTBEAT_RESTORED);
eventFilter.addAction(AttributeEvent.STATE_DISCONNECTED);
eventFilter.addAction(AttributeEvent.MISSION_ITEM_UPDATED);
eventFilter.addAction(AttributeEvent.FOLLOW_START);
eventFilter.addAction(AttributeEvent.AUTOPILOT_ERROR);
eventFilter.addAction(AttributeEvent.ALTITUDE_UPDATED);
eventFilter.addAction(AttributeEvent.SIGNAL_WEAK);
eventFilter.addAction(AttributeEvent.WARNING_NO_GPS);
}
private final BroadcastReceiver eventReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
if (tts == null)
return;
final String action = intent.getAction();
State droneState = drone.getAttribute(AttributeType.STATE);
switch (action) {
case AttributeEvent.STATE_ARMING:
if (droneState != null)
speakArmedState(droneState.isArmed());
break;
case AttributeEvent.BATTERY_UPDATED:
Battery droneBattery = drone.getAttribute(AttributeType.BATTERY);
if (droneBattery != null)
batteryDischargeNotification(droneBattery.getBatteryRemain());
break;
case AttributeEvent.STATE_VEHICLE_MODE:
if (droneState != null)
speakMode(droneState.getVehicleMode());
break;
case AttributeEvent.MISSION_SENT:
Toast.makeText(context, "Waypoints sent", Toast.LENGTH_SHORT).show();
speak("Waypoints saved to Drone");
break;
case AttributeEvent.GPS_FIX:
Gps droneGps = drone.getAttribute(AttributeType.GPS);
if (droneGps != null)
speakGpsMode(droneGps.getFixType());
break;
case AttributeEvent.MISSION_RECEIVED:
Toast.makeText(context, "Waypoints received from Drone", Toast.LENGTH_SHORT).show();
speak("Waypoints received");
break;
case AttributeEvent.HEARTBEAT_FIRST:
watchdogCallback.setDrone(drone);
scheduleWatchdog();
speak("Connected");
break;
case AttributeEvent.HEARTBEAT_TIMEOUT:
if (mAppPrefs.getWarningOnLostOrRestoredSignal()) {
speak("Data link lost, check connection.");
handler.removeCallbacks(watchdogCallback);
}
break;
case AttributeEvent.HEARTBEAT_RESTORED:
watchdogCallback.setDrone(drone);
scheduleWatchdog();
if (mAppPrefs.getWarningOnLostOrRestoredSignal()) {
speak("Data link restored");
}
break;
case AttributeEvent.STATE_DISCONNECTED:
handler.removeCallbacks(watchdogCallback);
break;
case AttributeEvent.MISSION_ITEM_UPDATED:
int currentWaypoint = intent.getIntExtra(AttributeEventExtra.EXTRA_MISSION_CURRENT_WAYPOINT, 0);
speak("Going for waypoint " + currentWaypoint);
break;
case AttributeEvent.FOLLOW_START:
speak("Following");
break;
case AttributeEvent.ALTITUDE_UPDATED:
if (mAppPrefs.getWarningOn400ftExceeded()) {
final Altitude altitude = drone.getAttribute(AttributeType.ALTITUDE);
if (altitude.getAltitude() > MAX_ALTITUDE)
speak("warning, 400 feet exceeded");
}
break;
case AttributeEvent.AUTOPILOT_ERROR:
if(mAppPrefs.getWarningOnAutopilotWarning()) {
String errorId = intent.getStringExtra(AttributeEventExtra.EXTRA_AUTOPILOT_ERROR_ID);
final ErrorType errorType = ErrorType.getErrorById(errorId);
if (errorType != null && errorType != ErrorType.NO_ERROR) {
speak(errorType.getLabel(context).toString());
}
}
break;
case AttributeEvent.SIGNAL_WEAK:
if (mAppPrefs.getWarningOnLowSignalStrength()) {
speak("Warning, weak signal");
}
break;
case AttributeEvent.WARNING_NO_GPS:
speak("Error, no gps lock yet");
break;
}
}
};
private final AtomicBoolean mIsPeriodicStatusStarted = new AtomicBoolean(false);
/**
* Listens for updates to the status interval.
*/
private final BroadcastReceiver mSpeechIntervalUpdateReceiver = new BroadcastReceiver() {
@Override
public void onReceive(Context context, Intent intent) {
final String action = intent.getAction();
if (SettingsFragment.ACTION_UPDATED_STATUS_PERIOD.equals(action)) {
scheduleWatchdog();
} else if (ACTION_SPEAK_MESSAGE.equals(action)) {
String msg = intent.getStringExtra(EXTRA_MESSAGE_TO_SPEAK);
if (msg != null) {
speak(msg);
}
}
}
};
/**
* Monitors speech completion.
*/
private final TextToSpeech.OnUtteranceCompletedListener mSpeechCompleteListener = new TextToSpeech.OnUtteranceCompletedListener() {
@Override
public void onUtteranceCompleted(String utteranceId) {
if (PERIODIC_STATUS_UTTERANCE_ID.equals(utteranceId)) {
mIsPeriodicStatusStarted.set(false);
}
}
};
/**
* Stored the parameters to be passed to the tts `speak(...)` method.
*/
private final HashMap<String, String> mTtsParams = new HashMap<String, String>();
private TextToSpeech tts;
private int lastBatteryDischargeNotification;
private final Context context;
private final DroidPlannerPrefs mAppPrefs;
private final Handler handler = new Handler();
private int statusInterval;
private class Watchdog implements Runnable {
private final StringBuilder mMessageBuilder = new StringBuilder();
private Drone drone;
public void run() {
handler.removeCallbacks(watchdogCallback);
if (drone != null) {
final State droneState = drone.getAttribute(AttributeType.STATE);
if(droneState.isConnected() && droneState.isArmed())
speakPeriodic(drone);
}
if (statusInterval != 0) {
handler.postDelayed(watchdogCallback, statusInterval * 1000);
}
}
private void speakPeriodic(Drone drone) {
// Drop the message if the previous one is not done yet.
if (mIsPeriodicStatusStarted.compareAndSet(false, true)) {
final SparseBooleanArray speechPrefs = mAppPrefs.getPeriodicSpeechPrefs();
mMessageBuilder.setLength(0);
if (speechPrefs.get(R.string.pref_tts_periodic_bat_volt_key)) {
final Battery droneBattery = drone.getAttribute(AttributeType.BATTERY);
mMessageBuilder.append(String.format("battery %2.1f volts. ", droneBattery.getBatteryVoltage()));
}
if (speechPrefs.get(R.string.pref_tts_periodic_alt_key)) {
final Altitude altitude = drone.getAttribute(AttributeType.ALTITUDE);
mMessageBuilder.append("altitude, ").append((int) (altitude.getAltitude())).append(" meters. ");
}
if (speechPrefs.get(R.string.pref_tts_periodic_airspeed_key)) {
final Speed droneSpeed = drone.getAttribute(AttributeType.SPEED);
mMessageBuilder.append("airspeed, ").append((int) (droneSpeed.getAirSpeed()))
.append(" meters per second. ");
}
if (speechPrefs.get(R.string.pref_tts_periodic_rssi_key)) {
final Signal signal = drone.getAttribute(AttributeType.SIGNAL);
mMessageBuilder.append("r s s i, ").append((int) signal.getRssi()).append(" decibels");
}
speak(mMessageBuilder.toString(), true, PERIODIC_STATUS_UTTERANCE_ID);
}
}
public void setDrone(Drone drone) {
this.drone = drone;
}
}
public final Watchdog watchdogCallback = new Watchdog();
private final Drone drone;
TTSNotificationProvider(Context context, Drone drone) {
this.context = context;
this.drone = drone;
tts = new TextToSpeech(context, this);
mAppPrefs = new DroidPlannerPrefs(context);
LocalBroadcastManager.getInstance(context).registerReceiver(eventReceiver, eventFilter);
}
private void scheduleWatchdog() {
handler.removeCallbacks(watchdogCallback);
statusInterval = mAppPrefs.getSpokenStatusInterval();
if (statusInterval != 0) {
handler.postDelayed(watchdogCallback, statusInterval * 1000);
}
}
@Override
public void onInit(int status) {
if (status == TextToSpeech.SUCCESS) {
// TODO: check if the language is available
Locale ttsLanguage;
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR2) {
ttsLanguage = tts.getDefaultLanguage();
} else {
ttsLanguage = tts.getLanguage();
}
if (ttsLanguage == null) {
ttsLanguage = Locale.US;
}
int supportStatus = tts.setLanguage(ttsLanguage);
switch (supportStatus) {
case TextToSpeech.LANG_MISSING_DATA:
case TextToSpeech.LANG_NOT_SUPPORTED:
tts.shutdown();
tts = null;
Log.e(TAG, "TTS Language data is not available.");
Toast.makeText(context, "Unable to set 'Text to Speech' language!",
Toast.LENGTH_LONG).show();
break;
}
if (tts != null) {
tts.setOnUtteranceCompletedListener(mSpeechCompleteListener);
// Register the broadcast receiver
final IntentFilter intentFilter = new IntentFilter();
intentFilter.addAction(ACTION_SPEAK_MESSAGE);
intentFilter.addAction(SettingsFragment.ACTION_UPDATED_STATUS_PERIOD);
LocalBroadcastManager.getInstance(context).registerReceiver(
mSpeechIntervalUpdateReceiver, intentFilter);
}
} else {
// Notify the user that the tts engine is not available.
Log.e(TAG, "TextToSpeech initialization failed.");
Toast.makeText(
context,
"Please make sure 'Text to Speech' is enabled in the "
+ "system accessibility settings.", Toast.LENGTH_LONG).show();
}
}
private void speak(String string) {
speak(string, false, null);
}
private void speak(String string, boolean append, String utteranceId) {
if (tts != null) {
if (shouldEnableTTS()) {
final int queueType = append ? TextToSpeech.QUEUE_ADD : TextToSpeech.QUEUE_FLUSH;
mTtsParams.clear();
if (utteranceId != null) {
mTtsParams.put(TextToSpeech.Engine.KEY_PARAM_UTTERANCE_ID, utteranceId);
}
tts.speak(string, queueType, mTtsParams);
}
}
}
private boolean shouldEnableTTS() {
return mAppPrefs.prefs.getBoolean("pref_enable_tts", false);
}
private void speakArmedState(boolean armed) {
if (armed) {
speak("Armed");
} else {
speak("Disarmed");
}
}
private void batteryDischargeNotification(double battRemain) {
if (lastBatteryDischargeNotification > (int) ((battRemain - 1) / BATTERY_DISCHARGE_NOTIFICATION_EVERY_PERCENT)
|| lastBatteryDischargeNotification + 1 < (int) ((battRemain - 1) / BATTERY_DISCHARGE_NOTIFICATION_EVERY_PERCENT)) {
lastBatteryDischargeNotification = (int) ((battRemain - 1) / BATTERY_DISCHARGE_NOTIFICATION_EVERY_PERCENT);
speak("Battery at" + (int) battRemain + "%");
}
}
private void speakMode(VehicleMode mode) {
if(mode == null)
return;
String modeString = "Mode ";
switch (mode) {
case PLANE_FLY_BY_WIRE_A:
modeString += "Fly by wire A";
break;
case PLANE_FLY_BY_WIRE_B:
modeString += "Fly by wire B";
break;
case COPTER_ACRO:
modeString += "Acrobatic";
break;
case COPTER_ALT_HOLD:
modeString += "Altitude hold";
break;
case COPTER_POSHOLD:
modeString += "Position hold";
break;
case PLANE_RTL:
case COPTER_RTL:
modeString += "Return to launch";
break;
default:
modeString += mode.getLabel();
break;
}
speak(modeString);
}
private void speakGpsMode(int fix) {
switch (fix) {
case 2:
speak("GPS 2D Lock");
break;
case 3:
speak("GPS 3D Lock");
break;
default:
speak("Lost GPS Lock");
break;
}
}
@Override
public void onTerminate() {
if (tts != null) {
tts.shutdown();
tts = null;
}
LocalBroadcastManager.getInstance(context).unregisterReceiver(eventReceiver);
}
}