Update the calibration dialog. (sky-map-team#453)

* Change the calibration video. * Reword the calibration dialog, especially when it's user-initiated and move the text out of the html to make it translatable. * Updates the calibration dialog again. Provides a landscape version. Have been unable to get the imaged properly centered though and need to test this on different form factors. * Remove the code that hacked the calibration dialog's appearance. * Crop the image a bit.
dieudv · Dec 28, 2021 · b296f6e · b296f6e
1 parent ce8cfcf
commit b296f6e
Show file tree

Hide file tree

Showing 8 changed files with 145 additions and 35 deletions.
diff --git a/app/src/main/assets/html/animated_gif_wrapper.html b/app/src/main/assets/html/animated_gif_wrapper.html
@@ -0,0 +1,6 @@
+<html style="margin: 0;">
+<body">
+<!-- To work around Android's rubbish animated gif support -->
+<img src="file:///android_asset/html/calib.gif"/>
+</body>
+</html>
diff --git a/app/src/main/assets/html/calib.gif b/app/src/main/assets/html/calib.gif
diff --git a/app/src/main/assets/html/how_to_calibrate.html b/app/src/main/assets/html/how_to_calibrate.html
diff --git a/app/src/main/java/com/google/android/stardroid/activities/CompassCalibrationActivity.java b/app/src/main/java/com/google/android/stardroid/activities/CompassCalibrationActivity.java
@@ -42,17 +42,31 @@ protected void onCreate(Bundle savedInstanceState) {
         .compassCalibrationModule(new CompassCalibrationModule(this)).build().inject(this);
 
     setContentView(R.layout.activity_compass_calibration);
-    WebView web = (WebView) findViewById(R.id.compass_calib_activity_webview);
-    web.loadUrl("file:///android_asset/html/how_to_calibrate.html");
+    WebView web = findViewById(R.id.compass_calib_activity_webview);
+    web.loadUrl("file:///android_asset/html/animated_gif_wrapper.html");
 
-    checkBoxView = (CheckBox) findViewById(R.id.compass_calib_activity_donotshow);
+    checkBoxView = findViewById(R.id.compass_calib_activity_donotshow);
     boolean hideCheckbox = getIntent().getBooleanExtra(HIDE_CHECKBOX, false);
+    String whatToDoText;
     if (hideCheckbox) {
+      // Dialog was user-initiated.
       checkBoxView.setVisibility(View.GONE);
       View reasonText = findViewById(R.id.compass_calib_activity_explain_why);
       reasonText.setVisibility(View.GONE);
+      whatToDoText = getString(R.string.compass_calib_what_to_do_user);
+    } else {
+      checkBoxView.setVisibility(View.VISIBLE);
+      View reasonText = findViewById(R.id.compass_calib_activity_explain_why);
+      reasonText.setVisibility(View.VISIBLE);
+      whatToDoText = getString(R.string.compass_calib_what_to_do);
+    }
+    TextView explanationText = findViewById(R.id.compass_calib_what_to_do);
+    explanationText.setText(String.format(whatToDoText,
+        "https://www.youtube.com/watch?v=-Uq7AmSAjt8"));
+
+    if (sensorManager != null) {
+      magneticSensor = sensorManager.getDefaultSensor(Sensor.TYPE_MAGNETIC_FIELD);
     }
-    magneticSensor = sensorManager.getDefaultSensor(Sensor.TYPE_MAGNETIC_FIELD);
     if (magneticSensor == null) {
       ((TextView) findViewById(R.id.compass_calib_activity_compass_accuracy)).setText(
           getString(R.string.sensor_absent));
@@ -62,17 +76,19 @@ protected void onCreate(Bundle savedInstanceState) {
   @Override
   public void onResume() {
     super.onResume();
-    if (magneticSensor != null) {
+    if (magneticSensor != null && sensorManager != null) {
       sensorManager.registerListener(this, magneticSensor, SensorManager.SENSOR_DELAY_UI);
     }
   }
 
   @Override
   public void onPause() {
     super.onPause();
-    sensorManager.unregisterListener(this);
+    if (sensorManager != null) {
+      sensorManager.unregisterListener(this);
+    }
     if (checkBoxView.isChecked()) {
-      sharedPreferences.edit().putBoolean(DONT_SHOW_CALIBRATION_DIALOG, true).commit();
+      sharedPreferences.edit().putBoolean(DONT_SHOW_CALIBRATION_DIALOG, true).apply();
     }
   }
 

diff --git a/app/src/main/res/layout-land/activity_compass_calibration.xml b/app/src/main/res/layout-land/activity_compass_calibration.xml
@@ -0,0 +1,89 @@
+<?xml version="1.0" encoding="utf-8"?>
+<androidx.core.widget.NestedScrollView
+    xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:layout_width="match_parent"
+    android:layout_height="match_parent"
+    android:paddingBottom="@dimen/activity_vertical_margin"
+    android:paddingLeft="@dimen/activity_horizontal_margin"
+    android:paddingRight="@dimen/activity_horizontal_margin"
+    android:paddingTop="@dimen/activity_vertical_margin"
+    tools:context="com.google.android.stardroid.activities.CompassCalibrationActivity">
+    <LinearLayout
+        android:layout_width="match_parent"
+        android:layout_height="match_parent"
+        android:orientation="horizontal">
+
+        <WebView
+            android:id="@+id/compass_calib_activity_webview"
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:layout_weight="1"
+            android:background="@android:color/white" />
+
+        <LinearLayout
+            android:layout_width="0dp"
+            android:layout_height="wrap_content"
+            android:orientation="vertical"
+            android:padding="@dimen/text_margin"
+            android:layout_weight="2">
+
+            <TextView
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:textAppearance="?android:attr/textAppearanceLarge"
+                android:text="@string/compass_calibration_activity_warning"
+                android:id="@+id/compass_calib_activity_explain_why"/>
+
+            <LinearLayout
+                android:orientation="horizontal"
+                android:layout_width="match_parent"
+                android:layout_height="wrap_content">
+
+                <TextView
+                    android:layout_width="wrap_content"
+                    android:layout_height="wrap_content"
+                    android:textAppearance="?android:attr/textAppearanceMedium"
+                    android:text="@string/compass_calibration_activity_heading_compass"
+                    />
+
+                <TextView
+                    android:layout_width="wrap_content"
+                    android:layout_height="wrap_content"
+                    android:textAppearance="?android:attr/textAppearanceMedium"
+                    android:id="@+id/compass_calib_activity_compass_accuracy"
+                    android:text="accuracy: unknown"
+                    android:paddingBottom="10dp"
+                    android:paddingLeft="5dp"
+                    android:paddingTop="5dp"
+                    android:paddingRight="5dp"/>
+
+            </LinearLayout>
+
+            <TextView
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:textAppearance="?android:attr/textAppearanceMedium"
+                android:text="@string/compass_calibration_activity_warning"
+                android:autoLink="web"
+                android:id="@+id/compass_calib_what_to_do"/>
+
+            <CheckBox
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:text="@string/compass_calibration_activity_do_not_show_this_again"
+                android:id="@+id/compass_calib_activity_donotshow"/>
+
+            <Button
+                android:layout_width="wrap_content"
+                android:layout_height="wrap_content"
+                android:text="@android:string/ok"
+                android:layout_gravity="center_horizontal"
+                android:nestedScrollingEnabled="false"
+                android:onClick="onOkClicked"/>
+
+        </LinearLayout>
+
+
+    </LinearLayout>
+</androidx.core.widget.NestedScrollView>
diff --git a/app/src/main/res/layout/activity_compass_calibration.xml b/app/src/main/res/layout/activity_compass_calibration.xml
@@ -14,6 +14,12 @@
         android:layout_height="match_parent"
         android:orientation="vertical">
 
+        <WebView
+            android:layout_width="match_parent"
+            android:layout_height="wrap_content"
+            android:id="@+id/compass_calib_activity_webview"
+            android:background="@android:color/black"/>
+
         <TextView
             android:layout_width="wrap_content"
             android:layout_height="wrap_content"
@@ -46,11 +52,13 @@
 
         </LinearLayout>
 
-        <WebView
-            android:layout_width="match_parent"
+        <TextView
+            android:layout_width="wrap_content"
             android:layout_height="wrap_content"
-            android:id="@+id/compass_calib_activity_webview"
-            android:background="@android:color/black"/>
+            android:textAppearance="?android:attr/textAppearanceMedium"
+            android:text="@string/compass_calibration_activity_warning"
+            android:autoLink="web"
+            android:id="@+id/compass_calib_what_to_do"/>
 
         <CheckBox
             android:layout_width="wrap_content"

diff --git a/app/src/main/res/values/strings.xml b/app/src/main/res/values/strings.xml
@@ -196,7 +196,20 @@
     <string name="menu_calibrate">Calibrate</string>
     <string name="compass_calibration_activity_heading_compass">Compass -</string>
     <string name="compass_calibration_activity_do_not_show_this_again">Do not show this again</string>
-    <string name="compass_calibration_activity_warning">Your compass needs to be calibrated</string>
+    <string name="compass_calibration_activity_warning">Your compass may need to be
+        calibrated</string>
+    <string name="compass_calib_what_to_do"
+        translation_description="Information for the user on how to calibrate the compass when the dialog auto-opens. Placeholder is the video URL">Your phone is reporting to Sky
+        Map that its internal compass is uncalibrated.
+    This is not a Sky Map issue but we can help you try to fix it. To calibrate the compass try moving your phone in a figure of eight
+        motion as demonstrated in this video %s until the accuracy reads \'high\'.</string>
+    <string name="compass_calib_what_to_do_user"
+        transation_description="Information for the user on how to calibrate the compass when they invoke the calibration dialog. Placeholder is the video URL">Your phone\'s
+        compass
+        accuracy is shown above.
+    If it is not \'high\' then the compass may need calibrating. This is not a Sky Map issue, but
+    a property of your phone. To calibrate the compass try moving your phone in a figure of eight
+        motion as demonstrated in this video %s.</string>
     <string name="sensor_reverse_preference_title">Reverse Magnetic Z</string>
     <string name="sensor_reverse_preference_summary">Fix for phones with incorrectly implemented sensors - requires restart</string>
     <string name="whats_new_dialog_title">What\'s new</string>

diff --git a/app/src/main/res/values/whatsnew.xml b/app/src/main/res/values/whatsnew.xml
@@ -3,10 +3,7 @@
     <string name="whats_new_text" translation_description="Description of new features in this version in html">
 <![CDATA[
     <h1>New in version %s</h1>
-    \t • Added Comet Leonard which will be visible through binoculars for a few days around Christmas <br/>
-    \t • Major re-working and simplification of the code - this should allow more features to be added in the future! <br/>
-    \t • Persian Translations (Credit: MLDFRJDN) <br/>
-    \t • Assorted other translation fixes (e.g. credit VegaDark for Spanish, Aga-C for Polish, VasilisKos for Greek, FTNo for Norwegian and more. <br/>
+    \t • Clarified the calibration dialog text. <br/>
 ]]>
     </string>
 </resources>