Skip to content

Skills API Reference

This page provides API documentation for the skills module.

BaseSkill

Base class for all manipulation skills.

Constructor

python
BaseSkill(cfg, task, controller, **kwargs)

Parameters:

ParameterTypeDescription
cfgDictConfigSkill configuration
taskBananaBaseTaskTask instance
controllerTemplateControllerController instance

Properties

PropertyTypeDescription
skill_cfgdictSkill-specific configuration
taskBananaBaseTaskReference to task
controllerTemplateControllerReference to controller

Methods

run() -> bool

Execute the skill. Must be implemented by subclass.

Returns: bool - Success status


Dexpick

Dex-style picking skill with approach planning.

python
class Dexpick(BaseSkill):
    def __init__(self, cfg, task, controller, **kwargs)
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
objectsList[str]requiredObjects to pick
pick_pose_idxint0Pick pose group index
pre_grasp_offsetfloat0.0Pre-grasp approach offset
post_grasp_offsetfloat0.1Post-grasp lift offset

Dexplace

Dex-style placing skill with constraints.

python
class Dexplace(BaseSkill):
    def __init__(self, cfg, task, controller, **kwargs)
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
objectsList[str]required[object, target]
camera_axis_filterdictNoneCamera constraint

Pick

Standard pick skill.

python
class Pick(BaseSkill):
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
objectsList[str]requiredObjects to pick

Place

Standard place skill.

python
class Place(BaseSkill):
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
objectsList[str]required[object, target]

GotoPose

Move to target pose skill.

python
class GotoPose(BaseSkill):
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
target_posetuplerequired(position, orientation)

Home

Return to home configuration.

python
class Home(BaseSkill):
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
modestr"default"Home configuration mode

Open / Close

Gripper control skills.

python
class Open(BaseSkill):
    def run(self) -> bool
        self.controller.set_gripper_state(1.0)

class Close(BaseSkill):
    def run(self) -> bool
        self.controller.set_gripper_state(-1.0)

PourWaterSucc

Pouring skill for liquid simulation.

python
class PourWaterSucc(BaseSkill):
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
objectsList[str]required[container, target]
pour_anglefloat90.0Pouring angle (degrees)

Rotate

Rotation skill.

python
class Rotate(BaseSkill):
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
axisstr"z"Rotation axis
anglefloat90.0Rotation angle (degrees)

Wait

Wait skill for timing control.

python
class Wait(BaseSkill):
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
durationfloat1.0Wait duration (seconds)

HeuristicSkill

Configurable skill for simple actions.

python
class HeuristicSkill(BaseSkill):
    def run(self) -> bool

Configuration:

ParameterTypeDefaultDescription
modestr"home"Action mode
gripper_statefloatNoneGripper state to set

Released under the MIT License.