docs: Clarify deviceId is BYOD-only in documentation

This commit is contained in:
Hossain Khan
2026-01-31 13:26:57 -05:00
parent 7976e77509
commit a8d4066af2
2 changed files with 8 additions and 2 deletions
@@ -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 =
@@ -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,
)