onero-sdk 0.3.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (96) hide show
  1. onero_sdk/__init__.py +141 -0
  2. onero_sdk/_buffered_slcan.py +86 -0
  3. onero_sdk/arm.py +2950 -0
  4. onero_sdk/arm_transforms.py +504 -0
  5. onero_sdk/backend.py +130 -0
  6. onero_sdk/calibration.py +257 -0
  7. onero_sdk/can_backend.py +366 -0
  8. onero_sdk/can_bus.py +203 -0
  9. onero_sdk/clock.py +47 -0
  10. onero_sdk/collision.py +350 -0
  11. onero_sdk/compliance.py +145 -0
  12. onero_sdk/config.py +81 -0
  13. onero_sdk/debugui/__init__.py +39 -0
  14. onero_sdk/debugui/__main__.py +177 -0
  15. onero_sdk/debugui/server.py +974 -0
  16. onero_sdk/debugui/static/app.js +1183 -0
  17. onero_sdk/debugui/static/index.html +35 -0
  18. onero_sdk/debugui/static/style.css +355 -0
  19. onero_sdk/debugui/static/vendor/urdf-loader/URDFClasses.js +507 -0
  20. onero_sdk/debugui/static/vendor/urdf-loader/URDFLoader.js +690 -0
  21. onero_sdk/diag.py +134 -0
  22. onero_sdk/dual_arm.py +324 -0
  23. onero_sdk/dual_mujoco_backend.py +434 -0
  24. onero_sdk/dynamics.py +471 -0
  25. onero_sdk/end_effector.py +152 -0
  26. onero_sdk/exceptions.py +100 -0
  27. onero_sdk/fk.py +181 -0
  28. onero_sdk/gain_policy.py +170 -0
  29. onero_sdk/geometry.py +223 -0
  30. onero_sdk/grippers.py +369 -0
  31. onero_sdk/ik_solver.py +377 -0
  32. onero_sdk/kinematic_calibration.py +240 -0
  33. onero_sdk/meshes/A1/A1_l/Link1.STL +0 -0
  34. onero_sdk/meshes/A1/A1_l/Link2.STL +0 -0
  35. onero_sdk/meshes/A1/A1_l/Link3.STL +0 -0
  36. onero_sdk/meshes/A1/A1_l/Link4.STL +0 -0
  37. onero_sdk/meshes/A1/A1_l/Link5.STL +0 -0
  38. onero_sdk/meshes/A1/A1_l/Link6.STL +0 -0
  39. onero_sdk/meshes/A1/A1_l/Link7.STL +0 -0
  40. onero_sdk/meshes/A1/A1_l/base_link.STL +0 -0
  41. onero_sdk/meshes/A1/A1_r/Link1.STL +0 -0
  42. onero_sdk/meshes/A1/A1_r/Link2.STL +0 -0
  43. onero_sdk/meshes/A1/A1_r/Link3.STL +0 -0
  44. onero_sdk/meshes/A1/A1_r/Link4.STL +0 -0
  45. onero_sdk/meshes/A1/A1_r/Link5.STL +0 -0
  46. onero_sdk/meshes/A1/A1_r/Link6.STL +0 -0
  47. onero_sdk/meshes/A1/A1_r/Link7.STL +0 -0
  48. onero_sdk/meshes/A1/A1_r/base_link.STL +0 -0
  49. onero_sdk/meshes/grippers/omnipicker/gripper_base_link.STL +0 -0
  50. onero_sdk/meshes/grippers/omnipicker/gripper_narrow1_Link.STL +0 -0
  51. onero_sdk/meshes/grippers/omnipicker/gripper_narrow2_Link.STL +0 -0
  52. onero_sdk/meshes/grippers/omnipicker/gripper_narrow3_Link.STL +0 -0
  53. onero_sdk/meshes/grippers/omnipicker/gripper_narrow_loop_Link.STL +0 -0
  54. onero_sdk/meshes/grippers/omnipicker/gripper_wide1_Link.STL +0 -0
  55. onero_sdk/meshes/grippers/omnipicker/gripper_wide2_Link.STL +0 -0
  56. onero_sdk/meshes/grippers/omnipicker/gripper_wide3_Link.STL +0 -0
  57. onero_sdk/meshes/grippers/omnipicker/gripper_wide_loop_Link.STL +0 -0
  58. onero_sdk/meshes/grippers/woan_picker/Link_L1.STL +0 -0
  59. onero_sdk/meshes/grippers/woan_picker/Link_L2.STL +0 -0
  60. onero_sdk/meshes/grippers/woan_picker/Link_L3.STL +0 -0
  61. onero_sdk/meshes/grippers/woan_picker/Link_L4.STL +0 -0
  62. onero_sdk/meshes/grippers/woan_picker/Link_R1.STL +0 -0
  63. onero_sdk/meshes/grippers/woan_picker/Link_R2.STL +0 -0
  64. onero_sdk/meshes/grippers/woan_picker/Link_R3.STL +0 -0
  65. onero_sdk/meshes/grippers/woan_picker/Link_R4.STL +0 -0
  66. onero_sdk/meshes/grippers/woan_picker/base_link.STL +0 -0
  67. onero_sdk/model_registry.py +261 -0
  68. onero_sdk/motion_executor.py +170 -0
  69. onero_sdk/motion_strategy.py +318 -0
  70. onero_sdk/motor.py +114 -0
  71. onero_sdk/mounting.py +274 -0
  72. onero_sdk/mujoco_backend.py +208 -0
  73. onero_sdk/protocol.py +297 -0
  74. onero_sdk/protocols.py +66 -0
  75. onero_sdk/python_can_bus.py +185 -0
  76. onero_sdk/realtime.py +154 -0
  77. onero_sdk/ruckig_planner.py +202 -0
  78. onero_sdk/safe_backend.py +113 -0
  79. onero_sdk/safety.py +420 -0
  80. onero_sdk/tool_models.py +97 -0
  81. onero_sdk/tools/omnipicker.urdf +221 -0
  82. onero_sdk/tools/woan_picker.urdf +205 -0
  83. onero_sdk/toppra_planner.py +235 -0
  84. onero_sdk/trajectory.py +300 -0
  85. onero_sdk/trajectory_profiles.py +482 -0
  86. onero_sdk/urdf/A1/a1_l.srdf +32 -0
  87. onero_sdk/urdf/A1/a1_l.urdf +468 -0
  88. onero_sdk/urdf/A1/a1_r.srdf +32 -0
  89. onero_sdk/urdf/A1/a1_r.urdf +231 -0
  90. onero_sdk/zero_calibration.py +160 -0
  91. onero_sdk/zero_offset_backend.py +103 -0
  92. onero_sdk-0.3.0.dist-info/METADATA +1205 -0
  93. onero_sdk-0.3.0.dist-info/RECORD +96 -0
  94. onero_sdk-0.3.0.dist-info/WHEEL +5 -0
  95. onero_sdk-0.3.0.dist-info/licenses/LICENSE +191 -0
  96. onero_sdk-0.3.0.dist-info/top_level.txt +1 -0
onero_sdk/__init__.py ADDED
@@ -0,0 +1,141 @@
1
+ """
2
+ onero SDK — Python interface for onero robotic arms.
3
+
4
+ High-level API (recommended):
5
+ from onero_sdk import Arm, DualArm, ArmState
6
+
7
+ Low-level API (advanced):
8
+ from onero_sdk import CanBus, PythonCanBus, Motor, MotorLimits, MotorState
9
+ from onero_sdk.protocol import encode_mit, decode_feedback
10
+ """
11
+
12
+ # High-level API
13
+ from .arm import Arm
14
+ from .dual_arm import DualArm
15
+ from .backend import ArmBackend, ArmState
16
+ from .end_effector import EndEffector, Gripper, DexterousHand
17
+ from .grippers import (
18
+ CanGripper, GripperState, OmniPickerGripper, OneroGripper,
19
+ )
20
+ from .trajectory import Recording, Recorder, TrajectoryPlanner, Waypoint, TrajectoryFrame
21
+ from .exceptions import (
22
+ OneroError, OneroConnectionError, OneroHardwareError,
23
+ OneroConfigError, OneroTimeoutError, OneroSafetyError,
24
+ )
25
+ from .safety import SafetyConfig
26
+ from .collision import CollisionConfig, CollisionEvent, CollisionDetector, CollisionResponse
27
+
28
+ # Low-level API (hardware access)
29
+ from .can_bus import CanBus, CanFrame, CanTransport
30
+ from .python_can_bus import PythonCanBus
31
+ from .motor import Motor
32
+ from .protocol import MotorLimits, MotorState, MotorError, RegisterID
33
+
34
+ # Utilities
35
+ from .model_registry import get_model, register_model, ArmModel, JointSpec
36
+ from .config import load_arm_config, load_dual_arm_config
37
+ from . import geometry
38
+ from .clock import ControlClock
39
+ from .motion_executor import MotionExecutor, MotionFrame, VelocityFrame
40
+ from .safe_backend import SafeBackend
41
+ from .gain_policy import GainPolicy, Stiffness
42
+ from .mounting import MountingPreset, MountingConfig
43
+ from .protocols import ArmProtocol
44
+ from .realtime import apply_realtime, release_realtime, RealtimeStatus
45
+
46
+ # Optional: IK (requires pip install onero-sdk[ik])
47
+ try:
48
+ from .ik_solver import IKSolver, PinkIKSolver
49
+ except ImportError:
50
+ IKSolver = None
51
+ PinkIKSolver = None
52
+
53
+ # Optional: Dynamics (requires pip install onero-sdk[dynamics])
54
+ try:
55
+ from .dynamics import DynamicsModel
56
+ except ImportError:
57
+ DynamicsModel = None
58
+
59
+ # Optional: Calibration (requires pip install onero-sdk[dynamics])
60
+ try:
61
+ from .calibration import CalibrationResult, GravityCalibrator
62
+ except ImportError:
63
+ CalibrationResult = None
64
+ GravityCalibrator = None
65
+
66
+ # Optional: Kinematic calibration (requires scipy)
67
+ try:
68
+ from .kinematic_calibration import KinematicCalibrator, KinematicCalibrationResult
69
+ except ImportError:
70
+ KinematicCalibrator = None
71
+ KinematicCalibrationResult = None
72
+
73
+ # Trajectory profiles (numpy only — always available)
74
+ from .trajectory_profiles import (
75
+ TrapezoidalProfile, SCurveProfile, QuinticBlend,
76
+ compute_synchronized_duration, multi_joint_trapezoidal,
77
+ )
78
+
79
+ # Optional: Ruckig (requires pip install onero-sdk[trajectory])
80
+ try:
81
+ from .ruckig_planner import RuckigPlanner
82
+ except ImportError:
83
+ RuckigPlanner = None
84
+
85
+ # Optional: TOPP-RA (requires pip install onero-sdk[trajectory])
86
+ try:
87
+ from .toppra_planner import TimeOptimalPlanner
88
+ except ImportError:
89
+ TimeOptimalPlanner = None
90
+
91
+ # Optional: MuJoCo simulation (requires pip install onero-sdk[sim])
92
+ try:
93
+ from .mujoco_backend import MujocoBackend
94
+ except ImportError:
95
+ MujocoBackend = None
96
+
97
+ try:
98
+ from .dual_mujoco_backend import DualMujocoBackend
99
+ except ImportError:
100
+ DualMujocoBackend = None
101
+
102
+ __version__ = "0.3.0"
103
+
104
+
105
+ def __getattr__(name):
106
+ if name == "URDFChain":
107
+ from .fk import URDFChain
108
+ return URDFChain
109
+ raise AttributeError(f"module 'onero_sdk' has no attribute {name!r}")
110
+
111
+
112
+ __all__ = [
113
+ # High-level
114
+ "Arm", "DualArm", "ArmBackend", "ArmState",
115
+ "EndEffector", "Gripper", "DexterousHand",
116
+ "Recording", "Recorder", "TrajectoryPlanner", "Waypoint", "TrajectoryFrame",
117
+ "OneroError", "OneroConnectionError", "OneroHardwareError", "OneroConfigError",
118
+ "OneroTimeoutError", "OneroSafetyError",
119
+ "SafetyConfig",
120
+ "CollisionConfig", "CollisionEvent", "CollisionDetector", "CollisionResponse",
121
+ # Low-level
122
+ "CanBus", "PythonCanBus", "CanTransport", "CanFrame", "Motor",
123
+ "MotorLimits", "MotorState", "MotorError", "RegisterID",
124
+ # Utilities
125
+ "get_model", "register_model", "ArmModel", "JointSpec",
126
+ "load_arm_config", "load_dual_arm_config",
127
+ "geometry", "ControlClock", "MotionExecutor", "MotionFrame", "VelocityFrame",
128
+ "SafeBackend", "GainPolicy", "Stiffness",
129
+ "MountingPreset", "MountingConfig",
130
+ "ArmProtocol",
131
+ "apply_realtime", "release_realtime", "RealtimeStatus",
132
+ "URDFChain",
133
+ # Optional
134
+ "IKSolver", "PinkIKSolver", "DynamicsModel",
135
+ "CalibrationResult", "GravityCalibrator",
136
+ "KinematicCalibrator", "KinematicCalibrationResult",
137
+ # Trajectory profiles
138
+ "TrapezoidalProfile", "SCurveProfile", "QuinticBlend",
139
+ "compute_synchronized_duration", "multi_joint_trapezoidal",
140
+ "RuckigPlanner", "TimeOptimalPlanner",
141
+ ]
@@ -0,0 +1,86 @@
1
+ """Optional SLCAN bulk serial I/O; retains python-can's receive parser."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import time
6
+
7
+ from can import CanOperationError
8
+ from can.interfaces.slcan import slcanBus
9
+
10
+
11
+ class BufferedSlcanBus(slcanBus):
12
+ """Read available serial bytes together instead of issuing one read per byte."""
13
+
14
+ _READ_CHUNK_SIZE = 4096
15
+ _MAX_UNTERMINATED_LINE = 4096
16
+
17
+ def send_batch(self, messages) -> None:
18
+ """Send classic data frames in order using one serial write and flush."""
19
+ lines = []
20
+ for msg in messages:
21
+ if msg.is_fd or msg.is_remote_frame or msg.is_error_frame:
22
+ raise ValueError("SLCAN batch sending requires classic CAN data frames")
23
+ if msg.dlc != len(msg.data) or not 0 <= msg.dlc <= 8:
24
+ raise ValueError("Invalid classic CAN data length")
25
+ if msg.is_extended_id:
26
+ header = f"T{msg.arbitration_id:08X}{msg.dlc:d}"
27
+ else:
28
+ header = f"t{msg.arbitration_id:03X}{msg.dlc:d}"
29
+ lines.append((header + msg.data.hex().upper()).encode() + self.LINE_TERMINATOR)
30
+ if not lines:
31
+ return
32
+ payload = b"".join(lines)
33
+ try:
34
+ # Match the normal send(message) timeout policy.
35
+ if self.serialPortOrig.write_timeout is not None:
36
+ self.serialPortOrig.write_timeout = None
37
+ written = self.serialPortOrig.write(payload)
38
+ if written != len(payload):
39
+ raise CanOperationError("Incomplete SLCAN batch write")
40
+ self.serialPortOrig.flush()
41
+ except CanOperationError:
42
+ raise
43
+ except Exception as exc:
44
+ raise CanOperationError("Could not write SLCAN batch") from exc
45
+
46
+ def _read(self, timeout):
47
+ deadline = None if timeout is None else time.monotonic() + max(0.0, timeout)
48
+ attempted_read = False
49
+ try:
50
+ while True:
51
+ endings = [index for index in (self._buffer.find(self._OK),
52
+ self._buffer.find(self._ERROR)) if index >= 0]
53
+ if endings:
54
+ end = min(endings) + 1
55
+ line = bytes(self._buffer[:end]).decode()
56
+ del self._buffer[:end]
57
+ return line
58
+ if len(self._buffer) >= self._MAX_UNTERMINATED_LINE:
59
+ raise CanOperationError('SLCAN input exceeded the unterminated-line limit')
60
+ # A zero-timeout poll may read bytes already waiting once, but
61
+ # never waits for the first byte. Preserve partial lines.
62
+ now = time.monotonic()
63
+ if attempted_read and deadline is not None and now >= deadline:
64
+ return None
65
+ waiting = self.serialPortOrig.in_waiting
66
+ if waiting:
67
+ chunk = self.serialPortOrig.read(min(waiting, self._READ_CHUNK_SIZE))
68
+ else:
69
+ if deadline is not None and now >= deadline:
70
+ return None
71
+ old_timeout = self.serialPortOrig.timeout
72
+ remaining = None if deadline is None else max(0.0, deadline - time.monotonic())
73
+ limit_read = remaining is not None and (old_timeout is None or old_timeout > remaining)
74
+ try:
75
+ if limit_read:
76
+ self.serialPortOrig.timeout = remaining
77
+ chunk = self.serialPortOrig.read(1)
78
+ finally:
79
+ if limit_read:
80
+ self.serialPortOrig.timeout = old_timeout
81
+ attempted_read = True
82
+ self._buffer.extend(chunk)
83
+ except CanOperationError:
84
+ raise
85
+ except Exception as exc:
86
+ raise CanOperationError('Could not read from SLCAN serial device') from exc