diff --git a/app/src/main/java/ink/trmnl/android/data/TrmnlDeviceConfigDataStore.kt b/app/src/main/java/ink/trmnl/android/data/TrmnlDeviceConfigDataStore.kt index e1577c5..c11b629 100644 --- a/app/src/main/java/ink/trmnl/android/data/TrmnlDeviceConfigDataStore.kt +++ b/app/src/main/java/ink/trmnl/android/data/TrmnlDeviceConfigDataStore.kt @@ -383,7 +383,9 @@ class TrmnlDeviceConfigDataStore } /** - * Saves the device ID (TRMNL device ID from /api/devices/me) + * Saves the device ID (TRMNL device ID from /api/devices/me). + * + * **Note:** This is only applicable for BYOD device types. */ suspend fun saveDeviceId(deviceId: Int) { Timber.tag(TAG).d("Saving device ID: $deviceId") @@ -394,7 +396,9 @@ class TrmnlDeviceConfigDataStore } /** - * Gets the device ID + * Gets the device ID. + * + * **Note:** This is only applicable for BYOD device types. */ suspend fun getDeviceId(): Int? { val deviceId = diff --git a/app/src/main/java/ink/trmnl/android/model/TrmnlDeviceConfig.kt b/app/src/main/java/ink/trmnl/android/model/TrmnlDeviceConfig.kt index 9c8a513..4c7f89e 100644 --- a/app/src/main/java/ink/trmnl/android/model/TrmnlDeviceConfig.kt +++ b/app/src/main/java/ink/trmnl/android/model/TrmnlDeviceConfig.kt @@ -46,6 +46,8 @@ data class TrmnlDeviceConfig constructor( * * This ID is fetched during BYOD device validation and is required for * reporting battery status and other device-specific updates. + * + * **Note:** This field is only applicable for BYOD device types. */ val deviceId: Int? = null, )