[Submission] Group 13 - Coursework 2

.github/pull_request_template.md

@@ -0,0 +1,22 @@
+# Summary
+
+One or two line summary of what this PR's changes do, and why you're making them.
+
+If this closes an issue, include the phrase: Closes (hashtag-issue_number)
+
+## Details
+
+- List of key changes made
+- Can be functional changes, or non-functional (eg, style, linting, refactoring)
+
+## Action Items
+
+- [ ] Test
+  - [ ] Minimum SDK (Android 9)
+  - [ ] Latest SDK
+- [ ] If there are any other outstanding items to be completed before merging, put them here
+  - Remember to request at least one code review! (You don't need to list this as an item here, as GitHub will already track code reviews for you)
+
+> # **NOTICE! Do not merge a pull request if it is not your assigned pull request!**
+>
+> Do not merge just because you are a code reviewer and you are okay with it. _Only_ merge if you are (one of) the author(s)!

.github/workflows/android-16.yml

@@ -0,0 +1,36 @@
+name: Android 16 Build
+
+on:
+  push:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 21.0.3
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21.0.3'
+          distribution: 'jetbrains'
+          cache: gradle
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v5
+
+      - name: Add (empty) local.properties
+        run: touch ./local.properties
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Setup Android 16.0 SDK
+        uses: android-actions/setup-android@v3.2.2
+        with:
+          cmdline-tools-version: 12266719
+
+      - name: gradle build
+        run: ./gradlew --no-daemon --parallel build

.github/workflows/android-9.yml

@@ -0,0 +1,36 @@
+name: Android 9 Build
+
+on:
+  push:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up JDK 21.0.3
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21.0.3'
+          distribution: 'jetbrains'
+          cache: gradle
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@v5
+
+      - name: Add (empty) local.properties
+        run: touch ./local.properties
+
+      - name: Grant execute permission for gradlew
+        run: chmod +x gradlew
+
+      - name: Setup Android 9.0 SDK
+        uses: android-actions/setup-android@v3.2.2
+        with:
+          cmdline-tools-version: 9477386
+
+      - name: gradle build
+        run: ./gradlew --no-daemon --parallel build

.gitignore

@@ -1,16 +1,10 @@
 *.iml
 .gradle
 /local.properties
-/.idea/caches
-/.idea/libraries
-/.idea/modules.xml
-/.idea/workspace.xml
-/.idea/navEditor.xml
-/.idea/assetWizardSettings.xml
 .DS_Store
 /build
 /captures
 .externalNativeBuild
 .cxx
-local.properties
 /.idea/
+**/.vscode/

README.md

@@ -1,4 +1,9 @@
-**PositionMe** is an indoor positioning data collection application initially developed for the University of Edinburgh's Embedded Wireless course. The application now includes enhanced features, including **trajectory playback**, improved UI design, and comprehensive location tracking.
+# Embedded Mobile and Wireless Systems (EWireless) 5 2025/26
+## Coursework 2 - Group 13
+
+[![Android 9](https://github.com/sa-fx/ENG-EMWSE5/actions/workflows/android-9.yml/badge.svg)](https://github.com/sa-fx/ENG-EMWSE5/actions/workflows/android-9.yml) [![Android 16](https://github.com/sa-fx/ENG-EMWSE5/actions/workflows/android-16.yml/badge.svg)](https://github.com/sa-fx/ENG-EMWSE5/actions/workflows/android-16.yml)
+
+**PositionMe** is an indoor positioning data collection application initially developed for the [University of Edinburgh's Embedded Wireless course](https://www.drps.ed.ac.uk/25-26/dpt/cxelee11083.htm). The application now includes enhanced features, including **trajectory playback**, improved UI design, and comprehensive location tracking.
 
 ## Features
 
@@ -13,19 +18,6 @@
     - **Progress bar for tracking playback status**.
 - **Redesigned UI**: Modern and user-friendly interface for enhanced usability.
 
-## Requirements
-
-- **Android Studio 4.2** or later
-- **Android SDK 30** or later
-
-## Installation
-
-1. **Clone the repository.**
-2. **Open the project in Android Studio**.
-3. Add your own API key for Google Maps in AndroidManifest.xml
-4. Set the website where you want to send your data. The application was built for use with [openpositioning.org](http://openpositioning.org/).
-5. **Build and run the project on your Android device**.
-
 ## Usage
 
 1. **Install the application** using Android Studio.
@@ -43,3 +35,41 @@
 6. **Control playback**:
     - Pause, restart, or jump to the end using playback controls.
 
+## Requirements
+
+- **Android Studio 4.2** or later
+- **Android SDK 28** or later
+
+For developers, the latest commits have been tested using the following configuration:
+- [Android Studio 2024.2.1 Patch 1 ('Ladybird')](https://developer.android.com/studio/archive)
+  - Android Gradle Plugin 8.7.3
+  - Gradle 8.10.2
+  - Google Services 4.4.2
+  - [Spotless](https://github.com/diffplug/spotless) 8.3.0
+- Android SDK 28 ('Android 9')
+
+## Installation
+
+1. Clone the repository (`git clone`).
+2. Open the project in Android Studio.
+3. Add your own API keys for Google Maps and OpenPositioning in `secrets.properties`.
+4. Build and run the project on your Android device.
+
+## Build
+
+This project uses [Spotless](https://github.com/diffplug/spotless) for automatic linting against the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html). To build the project with linting, run:
+
+```bash
+$ chmod +x ./gradlew
+$ ./gradlew clean build
+```
+
+This will run `spotlessCheck` as a pre-requisite for `build`. Any lint errors will cause the build to fail.
+
+If there are lint errors, you can either resolve these manually or run:
+
+```bash
+$ ./gradlew spotlessApply
+```
+
+This will use Spotless to let you resolve the errors identified during `spotlessCheck`.

app/build.gradle

@@ -3,15 +3,43 @@ plugins {
     id 'com.google.gms.google-services'
     id 'androidx.navigation.safeargs'
     id 'com.google.android.libraries.mapsplatform.secrets-gradle-plugin'
+    id 'com.diffplug.spotless' version "8.3.0"
 }
 
-// (Optional) load local secrets file:
+// Load local secrets file:
 def localProperties = new Properties()
 def localPropertiesFile = rootProject.file('secrets.properties')
 if (localPropertiesFile.exists()) {
     localProperties.load(new FileInputStream(localPropertiesFile))
 }
 
+spotless {
+  format 'misc', {
+    // Define the files to apply `misc` to
+    target '*.gradle', '.gitattributes', '.gitignore'
+
+    // Define the steps to apply to those files
+    trimTrailingWhitespace()
+    leadingTabsToSpaces(2)
+    endWithNewline()
+  }
+  java {
+    // All Java files, except autogenerated Traj.java
+    target "**/*.java"
+    targetExclude "**/Traj.java"
+
+    // Checks to be applied (on top of Google's Java style guide)
+    endWithNewline()
+    forbidWildcardImports()
+    formatAnnotations()
+    leadingTabsToSpaces(2)
+    removeUnusedImports()
+    trimTrailingWhitespace()
+
+    googleJavaFormat('1.35.0').aosp().reflowLongStrings()
+  }
+}
+
 android {
     namespace "com.openpositioning.PositionMe"
     compileSdk 34
@@ -28,10 +56,11 @@ android {
         // Example of referencing secrets (if you use secrets.properties):
         buildConfigField "String", "MAPS_API_KEY",
                 "\"${localProperties['MAPS_API_KEY'] ?: ''}\""
-        buildConfigField "String", "OPENPOSITIONING_API_KEY",
-                "\"${localProperties['OPENPOSITIONING_API_KEY'] ?: ''}\""
         buildConfigField "String", "OPENPOSITIONING_MASTER_KEY",
                 "\"${localProperties['OPENPOSITIONING_MASTER_KEY'] ?: ''}\""
+
+        // Add reference to maps API key for manifest file
+        manifestPlaceholders = [MAPS_API_KEY:localProperties['MAPS_API_KEY']?:""]
     }
 
     buildFeatures {
@@ -55,29 +84,37 @@ android {
         sourceCompatibility JavaVersion.VERSION_17
         targetCompatibility JavaVersion.VERSION_17
     }
+
+    // Add lint support (Android linting)
+    lintOptions {
+        abortOnError true
+        baseline file("lint-baseline.xml")
+    }
 }
 
 dependencies {
     // Core AndroidX
     implementation 'androidx.appcompat:appcompat:1.7.0-alpha03' // or stable: 1.6.1
-    implementation 'androidx.core:core-ktx:1.12.0'
     implementation 'androidx.constraintlayout:constraintlayout:2.2.0'
-    implementation 'androidx.preference:preference:1.2.1'
+    implementation 'androidx.core:core-ktx:1.12.0'
+    implementation 'androidx.gridlayout:gridlayout:1.0.0'
     implementation 'androidx.legacy:legacy-support-v4:1.0.0'
+    implementation 'androidx.preference:preference:1.2.1'
     implementation 'com.android.volley:volley:1.2.1'
     implementation 'androidx.gridlayout:gridlayout:1.0.0'
-
     // Material Components (Material 3 support is in 1.12.0+)
-    testImplementation 'junit:junit:4.13.2'
-    androidTestImplementation 'androidx.test.ext:junit:1.2.1'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.6.1'
     implementation 'com.google.android.material:material:1.12.0'
 
-    implementation 'com.google.protobuf:protobuf-java:3.0.0'
-    implementation 'com.squareup.okhttp3:okhttp:4.10.0'
-    implementation "com.google.protobuf:protobuf-java-util:3.0.0"
-    implementation "com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava"
     implementation 'com.google.android.gms:play-services-maps:19.0.0'
+    implementation 'com.google.android.gms:play-services-location:21.3.0'
+    implementation "com.google.guava:listenablefuture:9999.0-empty-to-avoid-conflict-with-guava"
+    implementation 'com.google.protobuf:protobuf-java:3.20.1'
+    implementation "com.google.protobuf:protobuf-java-util:3.20.1"
+    implementation 'com.squareup.okhttp3:okhttp:4.10.0'
+
+    // Secure credential storage
+    implementation 'androidx.datastore:datastore-preferences-rxjava3:1.2.1'
+    implementation "androidx.security:security-crypto:1.1.0"
 
     // Navigation components
     def nav_version = "2.8.6"
@@ -88,8 +125,10 @@ dependencies {
     // implementation "androidx.compose.material3:material3:1.3.1"
     // implementation "androidx.activity:activity-compose:1.7.2"
 
+    implementation "org.ejml:ejml-all:0.38"
+
     // Testing
     testImplementation 'junit:junit:4.13.2'
+    androidTestImplementation 'androidx.test.espresso:espresso-core:3.6.1'
     androidTestImplementation 'androidx.test.ext:junit:1.2.1'
-    androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
 }