Skip to content

Latest commit

 

History

History
60 lines (48 loc) · 2.44 KB

action_status.md

File metadata and controls

60 lines (48 loc) · 2.44 KB
Raw

ActionStatus

from magnebot import ActionStatus

The status of the Magnebot after doing an action.

Usage:

With a Magnebot agent:

from tdw.controller import Controller
from tdw.tdw_utils import TDWUtils
from magnebot import Magnebot, ActionStatus

m = Magnebot(robot_id=0, position={"x": 0.5, "y": 0, "z": -1})
c = Controller()
c.add_ons.append(m)
c.communicate(TDWUtils.create_empty_room(12, 12))
m.move_by(1)
print(m.action.status) # ActionStatus.ongoing
while m.action.status == ActionStatus.ongoing:
    c.communicate([])
print(m.action.status) # ActionStatus.success
c.communicate({"$type": "terminate"})

With a single-agent MagnebotController:

from magnebot import MagnebotController

m = MagnebotController()
m.init_scene()
status = m.move_by(1)
print(status) # ActionStatus.success
m.end()

If the status description states that the Magnebot tried to do something and failed, it means that the Magnebot moved for n frames before giving up.

If the status description states that the Magnebot didn't try to do something, it means that the action failed without advancing the simulation at all.

Value Description
ongoing The action is ongoing.
failure Generic failure code (useful for custom APIs).
success The action was successful.
failed_to_move Tried to move to a target position or object but failed.
failed_to_turn Tried to turn but failed to align with the target angle, position, or object.
cannot_reach Didn't try to reach for the target position because it can't.
failed_to_reach Tried to reach for the target but failed; the magnet isn't close to the target.
failed_to_grasp Tried to grasp the object and failed.
not_holding Didn't try to drop the object(s) because it isn't holding them.
clamped_camera_rotation Rotated the camera but at least one angle of rotation was clamped.
failed_to_bend Tried to bend its arm but failed to bend it all the way.
collision Tried to move or turn but failed because it collided with the environment (such as a wall) or a large object (mass > 30).
tipping Tried to move or turn but failed because it started to tip over.
held_by_other Didn't try to grasp a target object because another Magnebot is already holding it.
cannot_reset_position Didn't try to reset the position because the Magnebot hasn't tipped over.