nova.actions

 7class Action(pydantic.BaseModel, ABC):
 8    @abstractmethod
 9    @pydantic.model_serializer
10    def serialize_model(self):
11        """Serialize the model to a dictionary"""
12
13    @abstractmethod
14    def is_motion(self) -> bool:
15        """Return whether the action is a motion"""

181def cartesian_ptp(
182    target: PoseOrVectorTuple,
183    settings: MotionSettings = MotionSettings(),
184    collision_scene: wb.models.CollisionScene | None = None,
185) -> CartesianPTP:
186    """Convenience function to create a point-to-point motion
187
188    Args:
189        target: the target pose or vector. If the target is a vector, the orientation is set to (0, 0, 0).
190        settings: the motion settings
191
192    Returns: the point-to-point motion
193
194    Examples:
195    >>> ms = MotionSettings(tcp_acceleration_limit=10)
196    >>> assert cartesian_ptp((1, 2, 3, 4, 5, 6), settings=ms) == CartesianPTP(target=Pose((1, 2, 3, 4, 5, 6)), settings=ms)
197    >>> assert cartesian_ptp((1, 2, 3)) == cartesian_ptp((1, 2, 3, 0, 0, 0))
198    >>> assert cartesian_ptp(Pose((1, 2, 3, 4, 5, 6)), settings=ms) == cartesian_ptp((1, 2, 3, 4, 5, 6), settings=ms)
199
200    """
201    if not isinstance(target, Pose):
202        t = (*target, 0.0, 0.0, 0.0) if len(target) == 3 else target
203        target = Pose(t)
204
205    return CartesianPTP(target=target, settings=settings, collision_scene=collision_scene)

181def cartesian_ptp(
182    target: PoseOrVectorTuple,
183    settings: MotionSettings = MotionSettings(),
184    collision_scene: wb.models.CollisionScene | None = None,
185) -> CartesianPTP:
186    """Convenience function to create a point-to-point motion
187
188    Args:
189        target: the target pose or vector. If the target is a vector, the orientation is set to (0, 0, 0).
190        settings: the motion settings
191
192    Returns: the point-to-point motion
193
194    Examples:
195    >>> ms = MotionSettings(tcp_acceleration_limit=10)
196    >>> assert cartesian_ptp((1, 2, 3, 4, 5, 6), settings=ms) == CartesianPTP(target=Pose((1, 2, 3, 4, 5, 6)), settings=ms)
197    >>> assert cartesian_ptp((1, 2, 3)) == cartesian_ptp((1, 2, 3, 0, 0, 0))
198    >>> assert cartesian_ptp(Pose((1, 2, 3, 4, 5, 6)), settings=ms) == cartesian_ptp((1, 2, 3, 4, 5, 6), settings=ms)
199
200    """
201    if not isinstance(target, Pose):
202        t = (*target, 0.0, 0.0, 0.0) if len(target) == 3 else target
203        target = Pose(t)
204
205    return CartesianPTP(target=target, settings=settings, collision_scene=collision_scene)

244def circular(
245    target: PoseOrVectorTuple,
246    intermediate: PoseOrVectorTuple,
247    settings: MotionSettings = MotionSettings(),
248    collision_scene: wb.models.CollisionScene | None = None,
249) -> Circular:
250    """Convenience function to create a circular motion
251
252    Args:
253        target: the target pose or vector. If the target is a vector, the orientation is set to (0, 0, 0).
254        intermediate: the intermediate pose or vector. If the intermediate is a vector, the orientation is set to
255            (0, 0, 0).
256        settings: the motion settings
257
258    Returns: the circular motion
259
260    Examples:
261    >>> ms = MotionSettings(tcp_acceleration_limit=10)
262    >>> assert circular((1, 2, 3, 4, 5, 6), (7, 8, 9, 10, 11, 12), settings=ms) == Circular(target=Pose((1, 2, 3, 4, 5, 6)), intermediate=Pose((7, 8, 9, 10, 11, 12)), settings=ms)
263    >>> assert circular((1, 2, 3), (4, 5, 6)) == circular((1, 2, 3, 0, 0, 0), (4, 5, 6, 0, 0, 0))
264
265    """
266    if not isinstance(target, Pose):
267        t = (*target, 0.0, 0.0, 0.0) if len(target) == 3 else target
268        target = Pose(t)
269
270    if not isinstance(intermediate, Pose):
271        i = (*intermediate, 0.0, 0.0, 0.0) if len(intermediate) == 3 else intermediate
272        intermediate = Pose(i)
273
274    return Circular(
275        target=target, intermediate=intermediate, settings=settings, collision_scene=collision_scene
276    )

244def circular(
245    target: PoseOrVectorTuple,
246    intermediate: PoseOrVectorTuple,
247    settings: MotionSettings = MotionSettings(),
248    collision_scene: wb.models.CollisionScene | None = None,
249) -> Circular:
250    """Convenience function to create a circular motion
251
252    Args:
253        target: the target pose or vector. If the target is a vector, the orientation is set to (0, 0, 0).
254        intermediate: the intermediate pose or vector. If the intermediate is a vector, the orientation is set to
255            (0, 0, 0).
256        settings: the motion settings
257
258    Returns: the circular motion
259
260    Examples:
261    >>> ms = MotionSettings(tcp_acceleration_limit=10)
262    >>> assert circular((1, 2, 3, 4, 5, 6), (7, 8, 9, 10, 11, 12), settings=ms) == Circular(target=Pose((1, 2, 3, 4, 5, 6)), intermediate=Pose((7, 8, 9, 10, 11, 12)), settings=ms)
263    >>> assert circular((1, 2, 3), (4, 5, 6)) == circular((1, 2, 3, 0, 0, 0), (4, 5, 6, 0, 0, 0))
264
265    """
266    if not isinstance(target, Pose):
267        t = (*target, 0.0, 0.0, 0.0) if len(target) == 3 else target
268        target = Pose(t)
269
270    if not isinstance(intermediate, Pose):
271        i = (*intermediate, 0.0, 0.0, 0.0) if len(intermediate) == 3 else intermediate
272        intermediate = Pose(i)
273
274    return Circular(
275        target=target, intermediate=intermediate, settings=settings, collision_scene=collision_scene
276    )

39def collision_free(
40    target: Pose | tuple[float, ...],
41    settings: MotionSettings = MotionSettings(),
42    collision_scene: wb.models.CollisionScene | None = None,
43) -> CollisionFreeMotion:
44    return CollisionFreeMotion(target=target, settings=settings, collision_scene=collision_scene)

 25class CombinedActions(pydantic.BaseModel):
 26    """A trajectory of motions and actions"""
 27
 28    # See: https://docs.pydantic.dev/latest/concepts/serialization/#serialize_as_any-runtime-setting
 29    items: tuple[
 30        Annotated[
 31            pydantic.SerializeAsAny[ActionContainerItem], pydantic.Field(discriminator="type")
 32        ],
 33        ...,
 34    ] = ()
 35
 36    def __len__(self):
 37        return len(self.items)
 38
 39    def __getitem__(self, item):
 40        return self.items[item]
 41
 42    def __setattr__(self, key, value):
 43        if key == "items":
 44            raise TypeError("Cannot set items directly")
 45        super().__setattr__(key, value)
 46
 47    def __iter__(self):
 48        return iter(self.items)
 49
 50    def append(self, item: ActionContainerItem):
 51        super().__setattr__("items", self.items + (item,))
 52
 53    def _generate_trajectory(
 54        self,
 55    ) -> tuple[list[Motion | CollisionFreeMotion], list[ActionLocation]]:
 56        """Generate two lists: one of Motion objects and another of ActionContainer objects,
 57        where each ActionContainer wraps a non-Motion action with its path parameter.
 58
 59        The path parameter is the index of the last Motion object in the list of Motion objects.
 60        S - M - M - A - A - M - M - A - M - M
 61        0 - 1 - 2 - 3 - 3 - 3 - 4 - 5 - 5 - 6
 62
 63        Returns:
 64            tuple: A tuple containing:
 65                - list of Motion objects from self.items.
 66                - list of ActionContainer objects with indexed path parameters.
 67        """
 68        motions = []
 69        actions = []
 70        last_motion_index = 0
 71
 72        for item in self.items:
 73            if isinstance(item, Motion) or isinstance(item, CollisionFreeMotion):
 74                motions.append(item)
 75                last_motion_index += 1  # Increment the motion index for each new Motion
 76            else:
 77                # Assign the current value of last_motion_index as path_parameter for actions
 78                actions.append(ActionLocation(path_parameter=last_motion_index, action=item))
 79
 80        return motions, actions
 81
 82    @property
 83    def motions(self) -> list[Motion | CollisionFreeMotion]:
 84        motions, _ = self._generate_trajectory()
 85        return motions
 86
 87    @property
 88    def actions(self) -> list[ActionLocation]:
 89        _, actions = self._generate_trajectory()
 90        return actions
 91
 92    @property
 93    def start(self) -> ActionContainerItem | None:
 94        return self.motions[0] if self.motions else None
 95
 96    @property
 97    def end(self) -> ActionContainerItem | None:
 98        return self.motions[-1] if self.motions else None
 99
100    def poses(self) -> list[Pose]:
101        """Returns the positions of all motions. If a motion is not a cartesian motion, the position is ignored
102
103        Returns: the positions
104
105        """
106        motions, _ = self._generate_trajectory()
107        return [
108            Pose(position=motion.target.position, orientation=motion.target.orientation)
109            for motion in motions
110            if isinstance(motion.target, Pose)
111        ]
112
113    def positions(self):
114        """Returns the positions of all motions. If a motion is not a cartesian motion, the position is ignored
115
116        Returns: the positions
117
118        """
119        return [pose.position for pose in self.poses()]
120
121    def orientations(self):
122        """Returns the orientations of all motions. If a motion is not a cartesian motion, the orientation is ignored
123
124        Returns: the orientations
125
126        """
127        return [pose.orientation for pose in self.poses()]
128
129    def __add__(self, other: CombinedActions) -> CombinedActions:
130        return CombinedActions(items=self.items + other.items)
131
132    def to_motion_command(self) -> list[api.models.MotionCommand]:
133        motion_commands = []
134        for motion in self.motions:
135            path = api.models.MotionCommandPath.from_dict(motion.model_dump())
136            blending = (
137                motion.settings.as_blending_setting()
138                if motion.settings.has_blending_settings()
139                else None
140            )
141            limits_override = (
142                motion.settings.as_limits_settings()
143                if motion.settings.has_limits_override()
144                else None
145            )
146            motion_commands.append(
147                api.models.MotionCommand(
148                    path=path, blending=blending, limits_override=limits_override
149                )
150            )
151        return motion_commands
152
153    def to_set_io(self) -> list[api.models.SetIO]:
154        return [
155            api.models.SetIO(
156                io=api.models.IOValue(**action.action.model_dump(exclude_unset=True)),
157                location=action.path_parameter,
158            )
159            for action in self.actions
160        ]

24def io_write(key: str, value: Any, device_id: str | None = None) -> WriteAction:
25    """Create a WriteAction
26
27    Args:
28        key: The key to write
29        value: The value to write
30        device_id: The device id
31
32    Returns:
33        The WriteAction
34
35    """
36    return WriteAction(key=key, value=value, device_id=device_id)

311def joint_ptp(
312    target: tuple[float, ...],
313    settings: MotionSettings = MotionSettings(),
314    collision_scene: wb.models.CollisionScene | None = None,
315) -> JointPTP:
316    """Convenience function to create a joint PTP motion
317
318    Args:
319        target: the target joint configuration
320        settings: the motion settings
321
322    Returns: the joint PTP motion
323
324    Examples:
325    >>> ms = MotionSettings(tcp_acceleration_limit=10)
326    >>> assert joint_ptp((1, 2, 3, 4, 5, 6), settings=ms) == JointPTP(target=(1, 2, 3, 4, 5, 6), settings=ms)
327
328    """
329    return JointPTP(target=target, settings=settings, collision_scene=collision_scene)

311def joint_ptp(
312    target: tuple[float, ...],
313    settings: MotionSettings = MotionSettings(),
314    collision_scene: wb.models.CollisionScene | None = None,
315) -> JointPTP:
316    """Convenience function to create a joint PTP motion
317
318    Args:
319        target: the target joint configuration
320        settings: the motion settings
321
322    Returns: the joint PTP motion
323
324    Examples:
325    >>> ms = MotionSettings(tcp_acceleration_limit=10)
326    >>> assert joint_ptp((1, 2, 3, 4, 5, 6), settings=ms) == JointPTP(target=(1, 2, 3, 4, 5, 6), settings=ms)
327
328    """
329    return JointPTP(target=target, settings=settings, collision_scene=collision_scene)

121def linear(
122    target: PoseOrVectorTuple,
123    settings: MotionSettings = MotionSettings(),
124    collision_scene: wb.models.CollisionScene | None = None,
125) -> Linear:
126    """Convenience function to create a linear motion
127
128    Args:
129        target: the target pose or vector. If the target is a vector, the orientation is set to (0, 0, 0).
130        settings: the motion settings
131
132    Returns: the linear motion
133
134    Examples:
135    >>> ms = MotionSettings(tcp_velocity_limit=10)
136    >>> assert linear((1, 2, 3, 4, 5, 6), settings=ms) == Linear(target=Pose((1, 2, 3, 4, 5, 6)), settings=ms)
137    >>> assert linear((1, 2, 3)) == linear((1, 2, 3, 0, 0, 0))
138    >>> assert linear(Pose((1, 2, 3, 4, 5, 6)), settings=ms) == linear((1, 2, 3, 4, 5, 6), settings=ms)
139
140    """
141    if not isinstance(target, Pose):
142        t = (*target, 0.0, 0.0, 0.0) if len(target) == 3 else target
143        target = Pose(t)
144
145    return Linear(target=target, settings=settings, collision_scene=collision_scene)

121def linear(
122    target: PoseOrVectorTuple,
123    settings: MotionSettings = MotionSettings(),
124    collision_scene: wb.models.CollisionScene | None = None,
125) -> Linear:
126    """Convenience function to create a linear motion
127
128    Args:
129        target: the target pose or vector. If the target is a vector, the orientation is set to (0, 0, 0).
130        settings: the motion settings
131
132    Returns: the linear motion
133
134    Examples:
135    >>> ms = MotionSettings(tcp_velocity_limit=10)
136    >>> assert linear((1, 2, 3, 4, 5, 6), settings=ms) == Linear(target=Pose((1, 2, 3, 4, 5, 6)), settings=ms)
137    >>> assert linear((1, 2, 3)) == linear((1, 2, 3, 0, 0, 0))
138    >>> assert linear(Pose((1, 2, 3, 4, 5, 6)), settings=ms) == linear((1, 2, 3, 4, 5, 6), settings=ms)
139
140    """
141    if not isinstance(target, Pose):
142        t = (*target, 0.0, 0.0, 0.0) if len(target) == 3 else target
143        target = Pose(t)
144
145    return Linear(target=target, settings=settings, collision_scene=collision_scene)

164class MovementControllerContext(pydantic.BaseModel):
165    combined_actions: CombinedActions
166    motion_id: str