auto-trainer-api 0.9.6__py3-none-any.whl → 0.9.7__py3-none-any.whl

{auto_trainer_api-0.9.6.dist-info → auto_trainer_api-0.9.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: auto-trainer-api
-Version: 0.9.6
+Version: 0.9.7
 Summary: API for interfacing with the core acquisition process via platform and language agnostic message queues.
 License: AGPL-3.0-only
 Classifier: Operating System :: OS Independent
@@ -83,7 +83,7 @@ The returned `ApiCommandRequestResponse` object contains one require field
 * `result` - a value of `ApiCommandReqeustResult`
 
 There are also three optional fields
-* `data` - an optional dictionary with results from the command beyond success/failure (often will be None)
+* `data` - an optional object with results from the command beyond success/failure (often will be None)
 * `error_code` an integer error code value if the command is not successful or can't be initiated
 * `error_message` an integer error code value if the command is not successful or can't be initiated
 
@@ -106,6 +106,18 @@ topic of `ApiTopic.COMMAND_RESULT`.  The `message` argument of the `send_dict` m
 received in the `ApiCommandRequest` (the client is responsible for storing these values until needed).  Note that
 those two properties are ignored for synchronous command handling, but required for asynchronous responses.
 
+## Tools
+
+### Client Application
+`scripts/client_application.py` starts an interactive process that enables the `RpcService` as a "real" autotrainer
+application would.  It generates heartbeat events, can publish other events from the command line, and responds to
+commands.  This is primarily useful for testing remote applictions/services without running the main autotrainer
+acquisition application.
+
+### Remote Console
+`scripts/remote_console.py` starts an interactive process that connects to an `RpcService` instance in the same manner
+full remote management services would.  Currently, it only supports sending a small subset of the predefined 
+`ApiCommand` values, but may be expanded to show events and send additional commands.
 
 ## Publishing
 `python -m build`

auto_trainer_api-0.9.7.dist-info/RECORD

@@ -0,0 +1,16 @@
+autotrainer/api/__init__.py,sha256=SaDhy95qTzVH67pZ3qM0Uv86KoKP6Zh-V3VUHJqBBXo,686
+autotrainer/api/api_event_kind.py,sha256=-suGV1kTS5gXrkOS2Yq_ahkyTgFhwhbPn8PcR7vT9CE,3647
+autotrainer/api/api_options.py,sha256=LJrWqVe6JhYKw9UDL3uJcX4HTkwLW0STaNCGpPWRkoc,761
+autotrainer/api/rpc_service.py,sha256=b1zseMu328sdPWJHazlfl_fC94iXy7zwmDwmv3rqNw0,18351
+autotrainer/api/util.py,sha256=RfN6xMgCUahOz6RWMvSUkuw3mz0JEB2cpYoZBVdDY5M,1244
+autotrainer/api/command/__init__.py,sha256=CPwRJSFU89XchwJhZ4Yw8ANYBDalb7uoMW63RxQ8NRQ,141
+autotrainer/api/command/api_command.py,sha256=p5ymobZXBGiZt1RFwGZLaZnXgfZOPWTZg60Zra6fv_w,804
+autotrainer/api/command/configuration_response.py,sha256=-V8vbZlgHFCwTNf3KTq5wqPWaysY2-SxdjKkUdrVVFQ,233
+autotrainer/api/command/status_response.py,sha256=-Sq52Ebv8oIkzLhkIJdpgb3zKBqJXQ09aZZXTISfBQE,433
+autotrainer/api/telemtry/__init__.py,sha256=gd013s0gvD2Wc-hj2tGkvQQGNR3u0f8ZGYxbYvITWfo,57
+autotrainer/api/telemtry/open_telemetry_service.py,sha256=V-bDe_UX1I4iPtBgKV4R4tAAuGbsE3kyxGtr5ZD2mJc,2018
+autotrainer/api/zeromq/__init__.py,sha256=L0txGZRsARnVMfuKpEg9E22WkiuoU1FRmzqMAQCqtf4,50
+autotrainer/api/zeromq/zeromq_api_service.py,sha256=StThMM5JMu_Zua9_q9MzMM0xkQijyuABunADqq8yAKY,5029
+auto_trainer_api-0.9.7.dist-info/METADATA,sha256=h6CvFJgjhRNpuK9debdIWVSvJWoqL2ntWq9kaytQ6cY,7065
+auto_trainer_api-0.9.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+auto_trainer_api-0.9.7.dist-info/RECORD,,

autotrainer/api/__init__.py

@@ -4,18 +4,15 @@ API Service functionality for Autotrainer.
 
 from typing import Optional
 
+from .api_event_kind import ApiEventKind
+from .command import ApiCommand, ConfigurationResponse, StatusResponse
 from .api_options import ApiOptions, create_default_api_options
 from .rpc_service import ApiTopic, ApiCommandRequest, ApiCommandRequestResponse, ApiCommandReqeustResult, RpcService
 
-from .util import patch_uuid_encoder
-
 
 def create_api_service(options: ApiOptions) -> Optional[RpcService]:
     from .zeromq import ZeroMQApiService
 
-    # Several autotrainer messages may contain a UUID, which is not handled by the default JSON encoder.
-    # patch_uuid_encoder()
-
     # TODO Enable when ready
     # configure_telemetry(options.telemetry)
 

autotrainer/api/api_event_kind.py

@@ -16,11 +16,20 @@ class ApiEventKind(IntEnum):
 
     # Core/System
     emergencyStop = 101
+    """Payload {"reason": <string>}"""
     emergencyResume = 102
+    """Payload {"reason": <string>}"""
 
     applicationLaunched = 201
     applicationTerminating = 202
 
+    acquisitionStarted = 301
+    acquisitionEnded = 305
+    calibrationDcsStarted = 310
+    calibrationDcsEnded = 315
+    calibration3dStarted = 320
+    calibration3dEnded = 325
+
     propertyChanged = 501
 
     # Behavior
@@ -111,10 +120,14 @@ class ApiEventKind(IntEnum):
 
     # Training
     trainingModeChanged = 5001
+    """Payload {"training_mode": ApiTrainingMode}"""
 
     trainingPlanLoad = 5101
+    """Payload {training_plan_id: <uuid of plan>}"""
 
     trainingPhaseEnter = 5201
+    """Payload {"training_phase_id": <uuid of plan>}"""
     trainingPhaseExit = 5202
+    """Payload {"training_phase_id": <uuid of plan>}"""
 
     trainingProgressUpdate = 5501

autotrainer/api/command/__init__.py

@@ -0,0 +1,3 @@
+from .api_command import ApiCommand
+from .configuration_response import ConfigurationResponse
+from .status_response import StatusResponse

autotrainer/api/command/api_command.py

@@ -0,0 +1,30 @@
+from enum import IntEnum
+
+
+class ApiCommand(IntEnum):
+    """
+    A command value is required for all command requests.
+    """
+    NONE = 0
+    """No command.  Can be used to verify connection or that the receiver is configured to receive commands."""
+
+    START_ACQUISITION = 100
+    STOP_ACQUISITION = 110
+
+    EMERGENCY_STOP = 200
+    EMERGENCY_RESUME = 210
+
+    GET_CONFIGURATION = 300
+    """Response Payload: ConfigurationResponse"""
+
+    GET_STATUS = 400
+    """Response Payload: StatusResponse"""
+
+    USER_DEFINED = 99999
+    """A custom command defined between a particular commander and receiver.  Additional information can be 
+    defined in the `data` field."""
+
+    @classmethod
+    def is_member(cls, value):
+        return value in cls._value2member_map_
+

autotrainer/api/command/configuration_response.py

@@ -0,0 +1,11 @@
+from dataclasses import dataclass
+
+
+@dataclass
+class ConfigurationResponse:
+    device_id: str
+    configuration_location: str
+    data_location: str
+    animal_location: str
+    log_location: str
+    inference_model: str

autotrainer/api/command/status_response.py

@@ -0,0 +1,22 @@
+from dataclasses import dataclass
+from enum import IntEnum
+
+
+class ApiAppStatus(IntEnum):
+    IDLE = 0
+    ACQUIRING = 100
+    CALIBRATION_DCS = 200
+    CALIBRATION_3D = 300
+
+
+class ApiTrainingMode(IntEnum):
+    UNDEFINED = 0
+    MANUAL = 100
+    MANUAL_WITH_PROTOCOL = 200
+    AUTOMATIC = 300
+
+@dataclass
+class StatusResponse:
+    app_status: ApiAppStatus
+    training_mode: ApiTrainingMode
+    animal_id: str

autotrainer/api/rpc_service.py

@@ -1,7 +1,7 @@
 import json
 import logging
 import time
-from dataclasses import dataclass, asdict
+from dataclasses import dataclass, asdict, is_dataclass
 from enum import IntEnum
 from queue import Queue, Empty
 from threading import Timer, Thread
@@ -10,11 +10,16 @@ from typing_extensions import Self
 
 import humps
 
+from autotrainer.api.command.api_command import ApiCommand
 from .api_event_kind import ApiEventKind
 from .api_options import RpcOptions
 
 logger = logging.getLogger(__name__)
 
+import importlib.metadata
+
+_heartbeat_version = importlib.metadata.version("auto-trainer-api")
+
 
 class ApiTopic(IntEnum):
     """
@@ -40,25 +45,6 @@ class ApiTopic(IntEnum):
     """ Responses to asynchronous command handling. """
 
 
-class ApiCommand(IntEnum):
-    """
-    A command value is required for all command requests.
-    """
-    NONE = 0
-    START_ACQUISITION = 100
-    STOP_ACQUISITION = 110
-    EMERGENCY_STOP = 130
-    EMERGENCY_RESUME = 135
-    """No command.  Can be used to verify connection or that the receiver is configured to receive commands."""
-    USER_DEFINED = 99999
-    """A custom command defined between a particular commander and receiver.  Additional information can be 
-    defined in the `data` field."""
-
-    @classmethod
-    def is_member(cls, value):
-        return value in cls._value2member_map_
-
-
 @dataclass(frozen=True)
 class ApiCommandRequest:
     """
@@ -136,7 +122,7 @@ NotificationEventKinds = [ApiEventKind.emergencyStop, ApiEventKind.emergencyResu
 class ApiCommandRequestResponse:
     result: ApiCommandReqeustResult
 
-    data: Optional[dict] = None
+    data: Optional[Any] = None
 
     error_code: int = 0
     error_message: Optional[str] = None
@@ -264,7 +250,7 @@ class RpcService:
         self._heartbeat_timer = None
         self._heartbeat: HeartbeatMessage = HeartbeatMessage(
             identifier=options.identifier,
-            version="0.9.6",
+            version=_heartbeat_version,
             timestamp=0.0
         )
 
@@ -394,10 +380,15 @@ class RpcService:
 
                         error_kind = ApiCommandRequestErrorKind.COMMAND_ERROR if client_response.error_code != 0 else ApiCommandRequestErrorKind.NONE
 
+                        data = client_response.data
+
+                        if data is not None and is_dataclass(data):
+                            data = asdict(data)
+
                         self._send_command_response(
                             ApiCommandRequestServiceResponse(request.nonce, request.command, client_response.result,
-                                                             client_response.data, error_kind,
-                                                             client_response.error_code, client_response.error_message))
+                                                             data, error_kind, client_response.error_code,
+                                                             client_response.error_message))
                     except Exception as e:
                         self._send_command_response(
                             ApiCommandRequestServiceResponse.for_exception(request.command, request.nonce, e))

autotrainer/api/zeromq/zeromq_api_service.py

@@ -5,7 +5,8 @@ from typing import Optional
 import zmq
 import humps
 
-from ..rpc_service import RpcService, RpcOptions, ApiTopic, ApiCommandRequestServiceResponse, ApiCommandRequest, ApiCommand
+from ..rpc_service import RpcService, RpcOptions, ApiTopic, ApiCommandRequestServiceResponse, ApiCommandRequest
+from autotrainer.api.command.api_command import ApiCommand
 from ..util import get_ip4_addr_str, UUIDEncoder
 
 logger = logging.getLogger(__name__)

auto_trainer_api-0.9.6.dist-info/RECORD

@@ -1,12 +0,0 @@
-autotrainer/api/__init__.py,sha256=8GUKQ8L-gGgU8XlMztL88zwcjalregEVh__Mo6GGRg4,748
-autotrainer/api/api_event_kind.py,sha256=cKwMDhlTUGY6SM_A1r2vWfHIDPRHYHtSDkWdTt9oDbs,3159
-autotrainer/api/api_options.py,sha256=LJrWqVe6JhYKw9UDL3uJcX4HTkwLW0STaNCGpPWRkoc,761
-autotrainer/api/rpc_service.py,sha256=1r7RFrSgsjfZSMunq1UgA8AEP6oLXF48waM8TC-OMI4,18628
-autotrainer/api/util.py,sha256=RfN6xMgCUahOz6RWMvSUkuw3mz0JEB2cpYoZBVdDY5M,1244
-autotrainer/api/telemtry/__init__.py,sha256=gd013s0gvD2Wc-hj2tGkvQQGNR3u0f8ZGYxbYvITWfo,57
-autotrainer/api/telemtry/open_telemetry_service.py,sha256=V-bDe_UX1I4iPtBgKV4R4tAAuGbsE3kyxGtr5ZD2mJc,2018
-autotrainer/api/zeromq/__init__.py,sha256=L0txGZRsARnVMfuKpEg9E22WkiuoU1FRmzqMAQCqtf4,50
-autotrainer/api/zeromq/zeromq_api_service.py,sha256=WiG7B7rFJNESdDZhzxkmvHY03ei5T9PXeNgRFhJUTjg,4981
-auto_trainer_api-0.9.6.dist-info/METADATA,sha256=3P0jS8siCnK0uIw9MyIjvPfVSq7sPnZV3DozRmPgs8g,6332
-auto_trainer_api-0.9.6.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-auto_trainer_api-0.9.6.dist-info/RECORD,,