robotrace-sdk 2.0.0__py3-none-any.whl

robotrace/__init__.py

@@ -0,0 +1,97 @@
+"""RoboTrace SDK v2 — OTel-native robot observability.
+
+Quick start::
+
+    from robotrace import RoboTrace, mission, phase, Scalar, Pose3D
+
+    rt = RoboTrace(
+        host="http://localhost:8080",
+        public_key="rt-pk-xxx",
+        secret_key="rt-sk-xxx",
+        device_id="urn:rosp:device:robotis:turtlebot3:001",
+    )
+
+    with rt.mission("deliver_pallet", tags=["zone-B"]) as m:
+        with m.phase("navigate") as nav:
+            nav.log("robot/pose", Pose3D(x=1.0, y=2.0, z=0.0))
+            nav.log("sensors/battery", Scalar(87.5))
+        m.score("success", True)
+"""
+
+import logging as _logging
+
+# Python library best practice: NullHandler prevents "No handler found" warnings
+# when the application doesn't configure logging. Users configure their own handlers.
+_logging.getLogger("robotrace").addHandler(_logging.NullHandler())
+
+# Single version source — read from installed package metadata, fallback to hardcoded.
+# Must be defined before submodule imports (client.py and decorators.py reference it).
+try:
+    from importlib.metadata import version as _pkg_version
+    __version__ = _pkg_version("robotrace-sdk")
+except Exception:
+    __version__ = "2.0.0"
+
+from .client import RoboTrace
+from .commands import CommandChannel
+from .component import Component
+from .fleet import RoboTraceFleet
+from .decorators import mission, phase
+from .recorder import McapRecorder, mcap_available
+from .streaming import StreamingCamera
+from .types import (
+    Battery,
+    Bitset,
+    BoundingBox2D,
+    BoundingBox3D,
+    DepthImage,
+    GeoLocation,
+    Image,
+    JointState,
+    LaserScan,
+    Log,
+    NumericSet,
+    Path,
+    PointCloud,
+    Pose3D,
+    Scalar,
+    Transform3D,
+    Twist,
+    Vector3,
+    VectorN,
+    Video,
+)
+
+__all__ = [
+    "RoboTrace",
+    "RoboTraceFleet",
+    "CommandChannel",
+    "Component",
+    "mission",
+    "phase",
+    "McapRecorder",
+    "mcap_available",
+    "StreamingCamera",
+    # Timeline values are set via rt.set_time() / rt.reset_time() on the RoboTrace instance
+    "Scalar",
+    "Vector3",
+    "VectorN",
+    "Pose3D",
+    "Transform3D",
+    "PointCloud",
+    "Image",
+    "DepthImage",
+    "LaserScan",
+    "JointState",
+    "NumericSet",
+    "GeoLocation",
+    "Path",
+    "Twist",
+    "BoundingBox2D",
+    "BoundingBox3D",
+    "Video",
+    "Log",
+    "Battery",
+    "Bitset",
+]
+

robotrace/_semconv.py

@@ -0,0 +1,45 @@
+"""RoboTrace semantic convention constants for OpenTelemetry."""
+
+# Resource attributes (robot identity)
+ROBOT_ID = "robot.id"
+ROBOT_TYPE = "robot.type"
+ROBOT_MANUFACTURER = "robot.manufacturer"
+ROBOT_MODEL = "robot.model"
+ROBOT_FIRMWARE_VERSION = "robot.firmware_version"
+ROBOT_FLEET = "robot.fleet"
+
+# Mission attributes (trace-level)
+MISSION_NAME = "robotrace.mission.name"
+MISSION_STATUS = "robotrace.mission.status"
+MISSION_TAGS = "robotrace.mission.tags"
+SHIFT_ID = "robotrace.shift.id"
+
+# Phase attributes (span-level)
+PHASE_TYPE = "robotrace.phase.type"
+PHASE_COMMAND = "robotrace.phase.command"
+
+# Decision attributes
+DECISION_MODEL = "robotrace.decision.model"
+DECISION_INPUT = "robotrace.decision.input"
+DECISION_OUTPUT = "robotrace.decision.output"
+DECISION_CONFIDENCE = "robotrace.decision.confidence"
+
+# Event attributes
+EVENT_NAME = "robotrace.event.name"
+EVENT_SEVERITY = "robotrace.event.severity"
+
+# Score attributes
+SCORE_NAME = "robotrace.score.name"
+SCORE_VALUE = "robotrace.score.value"
+SCORE_SOURCE = "robotrace.score.source"
+SCORE_COMMENT = "robotrace.score.comment"
+
+# Telemetry attributes
+TELEMETRY_STREAM = "robotrace.telemetry.stream"
+TELEMETRY_SENSOR_ID = "robotrace.telemetry.sensor_id"
+
+# SDK metadata
+SDK_NAME = "robotrace.sdk.name"
+SDK_VERSION = "robotrace.sdk.version"
+ENVIRONMENT = "robotrace.environment"
+RELEASE = "robotrace.release"