fix:PRComments

Author: RSam-NI

docs/getting_started.rst

@@ -338,18 +338,26 @@ default connection. The default connection depends on your environment.
 
 With a :class:`.AssetManagementClient` object, you can:
 
-* Create, delete, query assets and link files to assets.
-* Track asset utilization with start, heartbeat, end, and query history operations.
+**Asset Operations:**
 
-Examples
-~~~~~~~~
+* Create, delete, query assets and link files to assets.
 
-Create, delete, query assets, link files, and track asset utilization.
+Example:
 
 .. literalinclude:: ../examples/assetmanagement/assets.py
    :language: python
    :linenos:
 
+**Asset Utilization Operations:**
+
+* Track asset utilization with start, heartbeat, end, and query history operations.
+
+Example:
+
+.. literalinclude:: ../examples/assetmanagement/asset_utilization.py
+   :language: python
+   :linenos:
+
 Systems API
 -------
 

examples/assetmanagement/asset_utilization.py

@@ -6,7 +6,7 @@
 from nisystemlink.clients.assetmanagement import AssetManagementClient
 from nisystemlink.clients.assetmanagement.models import (
     AssetBusType,
-    AssetIdentificationModel,
+    AssetIdentification,
     StartUtilizationRequest,
 )
 from nisystemlink.clients.core._http_configuration import HttpConfiguration
@@ -24,15 +24,15 @@
 
 # Define the assets being used in the test
 test_assets = [
-    AssetIdentificationModel(
+    AssetIdentification(
         model_name="NI PXIe-6368",
         model_number=4000,
         serial_number="01BB877A",
         vendor_name="NI",
         vendor_number=4244,
         bus_type=AssetBusType.ACCESSORY,
     ),
-    AssetIdentificationModel(
+    AssetIdentification(
         model_name="NI PXIe-5163",
         model_number=5000,
         serial_number="02CC988B",
@@ -66,19 +66,23 @@
 
 
 # Heartbeat mechanism using a background thread
-# IMPORTANT: Heartbeats must be sent at least every 5 minutes to keep assets
-# marked as "in use" in the SystemLink UI. If heartbeats stop, the assets
-# will no longer appear as actively utilized.
+# IMPORTANT: Heartbeats are for UI purposes only, to keep assets visually
+# marked as "in use" in the SystemLink UI. This applies only to utilizations
+# that have not been ended. While the standard heartbeat interval is 5 minutes,
+# the UI requires heartbeats at least every 10 minutes to continue showing
+# assets as actively utilized. If heartbeats stop, the assets will no longer
+# appear as "in use" in the UI.
 heartbeat_interval = 300  # 5 minutes in seconds
 is_active = True
 
 
 def heartbeat_loop():
     """Background thread that sends periodic heartbeats.
 
-    This keeps the asset marked as "in use" in the SystemLink UI.
-    Without periodic heartbeats (at least every 5 minutes), the UI
-    will no longer show the asset as actively utilized.
+    This keeps the asset visually marked as "in use" in the SystemLink UI
+    (for UI purposes only). Applies only to utilizations that have not been ended.
+    The UI requires heartbeats at least every 10 minutes to continue displaying
+    the asset as actively utilized.
     """
     while is_active:
         heartbeat_response = client.utilization_heartbeat(

nisystemlink/clients/assetmanagement/models/__init__.py

@@ -27,7 +27,7 @@
 )
 from ._asset_utilization_history_item import AssetUtilizationHistoryItem
 from ._asset_utilization_history_response import AssetUtilizationHistoryResponse
-from ._asset_identification_model import AssetIdentificationModel
+from ._asset_identification import AssetIdentification
 from ._start_utilization_request import StartUtilizationRequest
 from ._start_utilization_partial_success_response import (
     StartUtilizationPartialSuccessResponse,

…nt/models/_asset_identification_model.py …nagement/models/_asset_identification.pynisystemlink/clients/assetmanagement/models/_asset_identification_model.py renamed to nisystemlink/clients/assetmanagement/models/_asset_identification.py nisystemlink/clients/assetmanagement/models/_asset_identification_model.py renamed to nisystemlink/clients/assetmanagement/models/_asset_identification.py

@@ -7,7 +7,7 @@
 from ._asset_types import AssetBusType
 
 
-class AssetIdentificationModel(JsonModel):
+class AssetIdentification(JsonModel):
     """Model for object containing properties which identify an asset.
 
     An asset is uniquely identified by a combination of:

nisystemlink/clients/assetmanagement/models/_start_utilization_partial_success_response.py

@@ -5,7 +5,7 @@
 from nisystemlink.clients.core._api_error import ApiError
 from nisystemlink.clients.core._uplink._json_model import JsonModel
 
-from ._asset_identification_model import AssetIdentificationModel
+from ._asset_identification import AssetIdentification
 
 
 class StartUtilizationPartialSuccessResponse(JsonModel):
@@ -14,8 +14,8 @@ class StartUtilizationPartialSuccessResponse(JsonModel):
     error: Optional[ApiError] = None
     """Error information if any failures occurred."""
 
-    assets_with_started_utilization: Optional[List[AssetIdentificationModel]] = None
+    assets_with_started_utilization: Optional[List[AssetIdentification]] = None
     """Array containing the asset identification data for the assets that started being utilized."""
 
-    failed: Optional[List[AssetIdentificationModel]] = None
+    failed: Optional[List[AssetIdentification]] = None
     """Array containing the asset identification data for the assets that failed to start being utilized."""

nisystemlink/clients/assetmanagement/models/_start_utilization_request.py

@@ -5,7 +5,7 @@
 
 from nisystemlink.clients.core._uplink._json_model import JsonModel
 
-from ._asset_identification_model import AssetIdentificationModel
+from ._asset_identification import AssetIdentification
 
 
 class StartUtilizationRequest(JsonModel):
@@ -17,7 +17,7 @@ class StartUtilizationRequest(JsonModel):
     minion_id: Optional[str] = None
     """Identifier of the minion where the utilized assets are located."""
 
-    asset_identifications: Optional[List[AssetIdentificationModel]] = None
+    asset_identifications: Optional[List[AssetIdentification]] = None
     """Array of the identification information for the assets which are utilized.
     The maximum number of asset identifications allowed per request is 100."""
 

tests/integration/assetmanagement/test_asset_management.py

@@ -9,7 +9,7 @@
     AssetBusType,
     AssetDiscoveryType,
     AssetField,
-    AssetIdentificationModel,
+    AssetIdentification,
     AssetLocationForCreate,
     AssetPresence,
     AssetPresenceStatus,
@@ -84,7 +84,7 @@ def _start_utilization(
         user_name: str,
     ) -> None:
         asset_identifications = [
-            AssetIdentificationModel(
+            AssetIdentification(
                 model_name=asset.model_name,
                 model_number=asset.model_number,
                 serial_number=asset.serial_number,
@@ -534,7 +534,7 @@ def test__start_utilization_with_nonexistent_asset__raises_ApiException(
             utilization_identifier=unique_identifier,
             minion_id="test-minion",
             asset_identifications=[
-                AssetIdentificationModel(
+                AssetIdentification(
                     model_name="TestModel",
                     serial_number="TEST123",
                     vendor_name="TestVendor",