v7 model: Replace device.overall_status offline & idle with disconnec…

…ted, reduced-functionality & operational Change-type: major
balena-io · Aug 30, 2024 · f3f33b8 · f3f33b8
1 parent 64ca509
commit f3f33b8
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 16 deletions.
diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md
@@ -4705,7 +4705,7 @@ The name must be a string; the optional doc argument can have any type.
     "cpu_temp": int,
     "cpu_id": str,
     "is_undervolted": bool,
-    "overall_status": Any,
+    "overall_status": Literal["configuring", "inactive", "post-provisioning", "updating", "operational", "disconnected", "reduced-functionality"],
     "overall_progress": int,
     "is_of__device_type": Union[List[DeviceTypeType], PineDeferred],
     "belongs_to__application": Union[List[TypeApplication], PineDeferred],
@@ -4770,7 +4770,7 @@ The name must be a string; the optional doc argument can have any type.
     "cpu_temp": int,
     "cpu_id": str,
     "is_undervolted": bool,
-    "overall_status": Any,
+    "overall_status": Literal["configuring", "inactive", "post-provisioning", "updating", "operational", "disconnected", "reduced-functionality"],
     "overall_progress": int,
     "is_of__device_type": Union[List[DeviceTypeType], PineDeferred],
     "belongs_to__application": Union[List[TypeApplication], PineDeferred],

diff --git a/balena/models/device.py b/balena/models/device.py
@@ -83,19 +83,6 @@ class SupervisorStateType(TypedDict):
     download_progress: str
 
 
-class DeviceStatus:
-    """
-    Balena device statuses.
-    """
-
-    IDLE = "Idle"
-    CONFIGURING = "Configuring"
-    UPDATING = "Updating"
-    OFFLINE = "Offline"
-    POST_PROVISIONING = "Post Provisioning"
-    INACTIVE = "Inactive"
-
-
 class Device:
     """
     This class implements device model for balena python SDK.

diff --git a/balena/types/models.py b/balena/types/models.py
@@ -317,7 +317,16 @@ class TypeDevice(TypedDict):
     cpu_id: str
     is_undervolted: bool
     # This is a computed term
-    overall_status: Any
+    overall_status: Literal[
+        "configuring",
+        "inactive",
+        "post-provisioning",
+        "updating",
+        "operational",
+        "disconnected",
+        "reduced-functionality",
+    ]
+
     # This is a computed term
     overall_progress: int