Merge branch 'feature/699-time-constraints' into develop

Author: sds100

CHANGELOG.md

@@ -1,3 +1,11 @@
+## [3.1.0](https://github.com/sds100/KeyMapper/releases/tag/v3.1.0)
+
+#### TO BE RELEASED
+
+## Added
+
+- #699 Time constraints ⏰
+
 ## [3.0.1](https://github.com/sds100/KeyMapper/releases/tag/v3.0.1)
 
 #### 28 April 2025

app/build.gradle

@@ -119,6 +119,9 @@ android {
     }
 
     compileOptions {
+        // Required for desugaring new Java time API on lower than API 26
+        coreLibraryDesugaringEnabled = true
+
         sourceCompatibility JavaVersion.VERSION_17
         targetCompatibility JavaVersion.VERSION_17
     }
@@ -192,6 +195,7 @@ dependencies {
     proImplementation 'com.revenuecat.purchases:purchases:8.15.0'
     proImplementation "com.airbnb.android:lottie-compose:6.6.3"
     implementation("com.squareup.okhttp3:okhttp:4.12.0")
+    coreLibraryDesugaring("com.android.tools:desugar_jdk_libs:2.1.5")
 
     // splitties
     implementation "com.louiscad.splitties:splitties-bitflags:$splitties_version"

app/src/main/java/io/github/sds100/keymapper/actions/FlashlightActionBottomSheet.kt

@@ -35,7 +35,9 @@ import androidx.compose.material3.SheetValue
 import androidx.compose.material3.Slider
 import androidx.compose.material3.Text
 import androidx.compose.material3.TextButton
+import androidx.compose.material3.TimePicker
 import androidx.compose.material3.rememberModalBottomSheetState
+import androidx.compose.material3.rememberTimePickerState
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.remember
 import androidx.compose.runtime.rememberCoroutineScope

app/src/main/java/io/github/sds100/keymapper/constraints/ChooseConstraintScreen.kt

@@ -62,6 +62,8 @@ fun ChooseConstraintScreen(
     val listItems by viewModel.listItems.collectAsStateWithLifecycle()
     val query by viewModel.searchQuery.collectAsStateWithLifecycle()
 
+    TimeConstraintBottomSheet(viewModel)
+
     ChooseConstraintScreen(
         modifier = modifier,
         state = listItems,

app/src/main/java/io/github/sds100/keymapper/constraints/ChooseConstraintViewModel.kt

@@ -1,5 +1,8 @@
 package io.github.sds100.keymapper.constraints
 
+import androidx.compose.runtime.getValue
+import androidx.compose.runtime.mutableStateOf
+import androidx.compose.runtime.setValue
 import androidx.lifecycle.ViewModel
 import androidx.lifecycle.ViewModelProvider
 import androidx.lifecycle.viewModelScope
@@ -88,6 +91,8 @@ class ChooseConstraintViewModel(
 
             ConstraintId.CHARGING,
             ConstraintId.DISCHARGING,
+
+            ConstraintId.TIME,
         )
     }
 
@@ -104,6 +109,17 @@ class ChooseConstraintViewModel(
             State.Data(filteredItems)
         }.flowOn(Dispatchers.Default).stateIn(viewModelScope, SharingStarted.Eagerly, State.Loading)
 
+    var timeConstraintState: Constraint.Time? by mutableStateOf(null)
+
+    fun onDoneConfigTimeConstraintClick() {
+        timeConstraintState?.let { constraint ->
+            viewModelScope.launch {
+                _returnResult.emit(constraint)
+                timeConstraintState = null
+            }
+        }
+    }
+
     fun onListItemClick(id: String) {
         viewModelScope.launch {
             when (val constraintType = ConstraintId.valueOf(id)) {
@@ -192,6 +208,15 @@ class ChooseConstraintViewModel(
 
                 ConstraintId.LOCK_SCREEN_NOT_SHOWING ->
                     _returnResult.emit(Constraint.LockScreenNotShowing())
+
+                ConstraintId.TIME -> {
+                    timeConstraintState = Constraint.Time(
+                        startHour = 0,
+                        startMinute = 0,
+                        endHour = 0,
+                        endMinute = 0,
+                    )
+                }
             }
         }
     }

app/src/main/java/io/github/sds100/keymapper/constraints/Constraint.kt

@@ -8,6 +8,7 @@ import io.github.sds100.keymapper.system.display.Orientation
 import io.github.sds100.keymapper.util.getKey
 import io.github.sds100.keymapper.util.valueOrNull
 import kotlinx.serialization.Serializable
+import java.time.LocalTime
 import java.util.UUID
 
 /**
@@ -216,6 +217,20 @@ sealed class Constraint {
     data class Discharging(override val uid: String = UUID.randomUUID().toString()) : Constraint() {
         override val id: ConstraintId = ConstraintId.DISCHARGING
     }
+
+    @Serializable
+    data class Time(
+        override val uid: String = UUID.randomUUID().toString(),
+        val startHour: Int,
+        val startMinute: Int,
+        val endHour: Int,
+        val endMinute: Int,
+    ) : Constraint() {
+        override val id: ConstraintId = ConstraintId.TIME
+
+        val startTime: LocalTime by lazy { LocalTime.of(startHour, startMinute) }
+        val endTime: LocalTime by lazy { LocalTime.of(endHour, endMinute) }
+    }
 }
 
 object ConstraintModeEntityMapper {
@@ -375,6 +390,28 @@ object ConstraintEntityMapper {
             ConstraintEntity.CHARGING -> Constraint.Charging(uid = entity.uid)
             ConstraintEntity.DISCHARGING -> Constraint.Discharging(uid = entity.uid)
 
+            ConstraintEntity.TIME -> {
+                val startTime =
+                    entity.extras.getData(ConstraintEntity.EXTRA_START_TIME).valueOrNull()!!
+                        .split(":")
+                val startHour = startTime[0].toInt()
+                val startMin = startTime[1].toInt()
+
+                val endTime =
+                    entity.extras.getData(ConstraintEntity.EXTRA_END_TIME).valueOrNull()!!
+                        .split(":")
+                val endHour = endTime[0].toInt()
+                val endMin = endTime[1].toInt()
+
+                Constraint.Time(
+                    uid = entity.uid,
+                    startHour = startHour,
+                    startMinute = startMin,
+                    endHour = endHour,
+                    endMinute = endMin,
+                )
+            }
+
             else -> throw Exception("don't know how to convert constraint entity with type ${entity.type}")
         }
     }
@@ -606,5 +643,18 @@ object ConstraintEntityMapper {
             uid = constraint.uid,
             ConstraintEntity.DISCHARGING,
         )
+
+        is Constraint.Time -> ConstraintEntity(
+            uid = constraint.uid,
+            type = ConstraintEntity.TIME,
+            EntityExtra(
+                ConstraintEntity.EXTRA_START_TIME,
+                "${constraint.startHour}:${constraint.startMinute}",
+            ),
+            EntityExtra(
+                ConstraintEntity.EXTRA_END_TIME,
+                "${constraint.endHour}:${constraint.endMinute}",
+            ),
+        )
     }
 }

app/src/main/java/io/github/sds100/keymapper/constraints/ConstraintId.kt

@@ -48,4 +48,6 @@ enum class ConstraintId {
 
     CHARGING,
     DISCHARGING,
+
+    TIME
 }

app/src/main/java/io/github/sds100/keymapper/constraints/ConstraintSnapshot.kt

@@ -17,6 +17,7 @@ import io.github.sds100.keymapper.system.phone.PhoneAdapter
 import io.github.sds100.keymapper.system.power.PowerAdapter
 import io.github.sds100.keymapper.util.firstBlocking
 import timber.log.Timber
+import java.time.LocalTime
 
 /**
  * Created by sds100 on 08/05/2021.f
@@ -69,6 +70,8 @@ class LazyConstraintSnapshot(
         lockScreenAdapter.isLockScreenShowing()
     }
 
+    private val localTime = LocalTime.now()
+
     private fun isMediaPlaying(): Boolean {
         return audioVolumeStreams.contains(AudioManager.STREAM_MUSIC) || appsPlayingMedia.isNotEmpty()
     }
@@ -156,6 +159,13 @@ class LazyConstraintSnapshot(
             // an another activity like the camera app while the phone is locked.
             is Constraint.LockScreenShowing -> isLockscreenShowing && appInForeground == "com.android.systemui"
             is Constraint.LockScreenNotShowing -> !isLockscreenShowing || appInForeground != "com.android.systemui"
+
+            is Constraint.Time ->
+                if (constraint.startTime.isAfter(constraint.endTime)) {
+                    localTime.isAfter(constraint.startTime) || localTime.isBefore(constraint.endTime)
+                } else {
+                    localTime.isAfter(constraint.startTime) && localTime.isBefore(constraint.endTime)
+                }
         }
 
         if (isSatisfied) {

app/src/main/java/io/github/sds100/keymapper/constraints/ConstraintUiHelper.kt

@@ -5,10 +5,12 @@ import androidx.compose.material.icons.rounded.Android
 import io.github.sds100.keymapper.R
 import io.github.sds100.keymapper.system.camera.CameraLens
 import io.github.sds100.keymapper.system.display.Orientation
+import io.github.sds100.keymapper.util.TimeUtils
 import io.github.sds100.keymapper.util.handle
 import io.github.sds100.keymapper.util.ui.ResourceProvider
 import io.github.sds100.keymapper.util.ui.compose.ComposeIconInfo
 import io.github.sds100.keymapper.util.valueIfFailure
+import java.time.format.FormatStyle
 
 /**
  * Created by sds100 on 18/03/2021.
@@ -20,6 +22,8 @@ class ConstraintUiHelper(
 ) : DisplayConstraintUseCase by displayConstraintUseCase,
     ResourceProvider by resourceProvider {
 
+    private val timeFormatter by lazy { TimeUtils.localeDateFormatter(FormatStyle.SHORT) }
+
     fun getTitle(constraint: Constraint): String = when (constraint) {
         is Constraint.AppInForeground ->
             getAppName(constraint.packageName).handle(
@@ -144,6 +148,13 @@ class ConstraintUiHelper(
         is Constraint.Discharging -> getString(R.string.constraint_discharging)
         is Constraint.LockScreenShowing -> getString(R.string.constraint_lock_screen_showing)
         is Constraint.LockScreenNotShowing -> getString(R.string.constraint_lock_screen_not_showing)
+        is Constraint.Time -> getString(
+            R.string.constraint_time_formatted,
+            arrayOf(
+                timeFormatter.format(constraint.startTime),
+                timeFormatter.format(constraint.endTime),
+            ),
+        )
     }
 
     fun getIcon(constraint: Constraint): ComposeIconInfo = when (constraint) {

app/src/main/java/io/github/sds100/keymapper/constraints/ConstraintUtils.kt

@@ -20,6 +20,7 @@ import androidx.compose.material.icons.outlined.SignalWifiStatusbarNull
 import androidx.compose.material.icons.outlined.StayCurrentLandscape
 import androidx.compose.material.icons.outlined.StayCurrentPortrait
 import androidx.compose.material.icons.outlined.StopCircle
+import androidx.compose.material.icons.outlined.Timer
 import androidx.compose.material.icons.outlined.Wifi
 import androidx.compose.material.icons.outlined.WifiOff
 import androidx.compose.material.icons.rounded.Android
@@ -78,6 +79,7 @@ object ConstraintUtils {
         ConstraintId.DISCHARGING -> ComposeIconInfo.Vector(Icons.Outlined.Battery2Bar)
         ConstraintId.LOCK_SCREEN_SHOWING -> ComposeIconInfo.Vector(Icons.Outlined.ScreenLockPortrait)
         ConstraintId.LOCK_SCREEN_NOT_SHOWING -> ComposeIconInfo.Vector(Icons.Outlined.LockOpen)
+        ConstraintId.TIME -> ComposeIconInfo.Vector(Icons.Outlined.Timer)
     }
 
     fun getTitleStringId(constraintId: ConstraintId): Int = when (constraintId) {
@@ -114,5 +116,6 @@ object ConstraintUtils {
         ConstraintId.DISCHARGING -> R.string.constraint_discharging
         ConstraintId.LOCK_SCREEN_SHOWING -> R.string.constraint_lock_screen_showing
         ConstraintId.LOCK_SCREEN_NOT_SHOWING -> R.string.constraint_lock_screen_not_showing
+        ConstraintId.TIME -> R.string.constraint_time
     }
 }