PyNiryo2
?
Setup
Installation
Find your Robot’s IP address
Verify your Setup and Get Started
Examples
Examples: Basics
Examples: Movement
Examples: Tool Action
Examples: Conveyor
Examples: Vision
Examples: Dynamic frames
Code templates
API Documentation
NiryoRobot
NiryoTopic
NiryoRos
Arm
Tool
Vision
I/Os
Conveyor
Saved poses
Pick & Place
Trajectories
Frames
Led Ring
Sound
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
A
ABORTED (RobotErrors attribute)
activate_electromagnet() (Tool method)
ADD (ManageSound attribute)
ALTERNATE (AnimationMode attribute)
alternate() (LedRing method)
AnimationMode (class in pyniryo2.led_ring.enums)
Arm (class in pyniryo2.arm.arm)
ARM_COMMANDER_FAILURE (RobotErrors attribute)
ArmMoveCommandType (class in pyniryo2.enums)
B
BREATH (AnimationMode attribute)
breath() (LedRing method)
BUTTON_ERROR (RobotErrors attribute)
C
calibrate() (Arm method)
calibrate_auto() (Arm method)
CALIBRATION_IN_PROGRESS (RobotErrors attribute)
CALIBRATION_NOT_DONE (RobotErrors attribute)
CAN_READ_ERROR (RobotErrors attribute)
CAN_WRITE_ERROR (RobotErrors attribute)
CANCELLED (RobotErrors attribute)
CHASE (AnimationMode attribute)
chase() (LedRing method)
clean_trajectory_memory() (Trajectories method)
client (NiryoRobot property)
close() (NiryoRos method)
close_gripper() (Tool method)
COLOR_WIPE (AnimationMode attribute)
control_conveyor() (Conveyor method)
CONTROLLER_PROBLEMS (RobotErrors attribute)
Conveyor (class in pyniryo2.conveyor.conveyor)
CONVEYOR_ID_INVALID (RobotErrors attribute)
conveyors (Conveyor property)
CUSTOM (AnimationMode attribute)
custom() (LedRing method)
D
deactivate_electromagnet() (Tool method)
DELETE (ManageSound attribute)
delete() (Sound method)
delete_pose() (SavedPoses method)
delete_saved_dynamic_frame() (Frames method)
delete_trajectory() (Trajectories method)
delete_workspace() (Vision method)
detect_object() (Vision method)
DIGITAL_IO_PANEL_ERROR (RobotErrors attribute)
digital_io_states (IO property)
digital_read() (IO method)
digital_write() (IO method)
DRAW_CIRCLE (ArmMoveCommandType attribute)
DRAW_SPIRAL (ArmMoveCommandType attribute)
DXL_READ_ERROR (RobotErrors attribute)
DXL_WRITE_ERROR (RobotErrors attribute)
E
edit_dynamic_frame() (Frames method)
enable_tcp() (Tool method)
end() (NiryoRobot method)
ENGLISH (Language attribute)
EXECUTE_FULL_TRAJ (ArmMoveCommandType attribute)
EXECUTE_RAW_TRAJ (ArmMoveCommandType attribute)
execute_registered_trajectory() (Trajectories method)
EXECUTE_TRAJ (ArmMoveCommandType attribute)
execute_trajectory_from_poses() (Trajectories method)
F
FAILURE (RobotErrors attribute)
FILE_ALREADY_EXISTS (RobotErrors attribute)
flash() (LedRing method)
FLASHING (AnimationMode attribute)
forward_kinematics() (Arm method)
Frames (class in pyniryo2.frames.frames)
FRENCH (Language attribute)
G
get_camera_intrinsics (Vision property)
get_conveyors_feedback (Conveyor property)
get_current_tool_id (Tool property)
get_digital_io_state() (IO method)
get_digital_io_states (IO property)
get_image_parameters (Vision property)
get_img_compressed (Vision property)
get_joints() (Arm method)
get_learning_mode() (Arm method)
get_pose (Arm property)
get_pose_quat() (Arm method)
get_pose_saved() (SavedPoses method)
get_saved_dynamic_frame() (Frames method)
get_saved_dynamic_frame_list() (Frames method)
get_saved_pose_list() (SavedPoses method)
get_saved_trajectory() (Trajectories method)
get_saved_trajectory_list() (Trajectories method)
get_sound_duration() (Sound method)
get_sounds() (Sound method)
get_status() (LedRing method)
get_target_pose_from_cam() (Vision method)
get_target_pose_from_rel() (Vision method)
get_volume() (Sound method)
get_workspace_list() (Vision method)
get_workspace_ratio() (Vision method)
go_to_sleep() (Arm method)
GO_UP (AnimationMode attribute)
go_up() (LedRing method)
GO_UP_AND_DOWN (AnimationMode attribute)
go_up_down() (LedRing method)
GOAL_STILL_ACTIVE (RobotErrors attribute)
grasp_with_tool() (Tool method)
H
HARDWARE_FAILURE (RobotErrors attribute)
HARDWARE_NOT_OK (RobotErrors attribute)
hardware_status (Arm property)
hardware_version (NiryoRos property)
HardwareStatusObject (class in pyniryo2.arm.objects)
I
INVALID_PARAMETERS (RobotErrors attribute)
inverse_kinematics() (Arm method)
INVERT_KINEMATICS_FAILURE (RobotErrors attribute)
IO (class in pyniryo2.io.io)
is_subscribed (NiryoTopic property)
J
JOG_CONTROLLER_ENABLED (RobotErrors attribute)
JOG_CONTROLLER_FAILURE (RobotErrors attribute)
jog_joints() (Arm method)
jog_pose() (Arm method)
joints (Arm property)
JOINTS (ArmMoveCommandType attribute)
joints_state (Arm property)
JointStateObject (class in pyniryo2.arm.objects)
L
Language (class in pyniryo2.sound.enums)
learning_mode (Arm property)
LEARNING_MODE_ON (RobotErrors attribute)
LED_MANAGER_ERROR (RobotErrors attribute)
LedMode (class in pyniryo2.led_ring.enums)
LedRing (class in pyniryo2.led_ring)
LedRingStatusObject (class in pyniryo2.led_ring.objects)
LINEAR_POSE (ArmMoveCommandType attribute)
M
ManageSound (class in pyniryo2.sound.enums)
MANDARIN (Language attribute)
MARKERS_NOT_FOUND (RobotErrors attribute)
module
pyniryo2.enums
pyniryo2.led_ring
pyniryo2.led_ring.enums
pyniryo2.led_ring.objects
pyniryo2.sound
pyniryo2.sound.enums
move_joints() (Arm method)
move_linear_pose() (Arm method)
move_linear_relative() (Arm method)
move_pose() (Arm method)
move_relative() (Arm method)
move_to_home_pose() (Arm method)
move_to_object() (Vision method)
MQTT_PUBLISH_FUNCTION_DOESNT_EXIST (RobotErrors attribute)
MQTT_PUBLISH_FUNCTION_INVALID_ARGUMENTS (RobotErrors attribute)
N
need_calibration() (Arm method)
NiryoRobot (class in pyniryo2.niryo_robot)
NiryoRos (class in pyniryo2.niryo_ros)
NiryoRosTimeoutException
NiryoTopic (class in pyniryo2.niryo_topic)
NO_CONVEYOR_FOUND (RobotErrors attribute)
NO_CONVEYOR_LEFT (RobotErrors attribute)
NO_PLAN_AVAILABLE (RobotErrors attribute)
NONE (AnimationMode attribute)
(LedMode attribute)
NOT_IMPLEMENTED_COMMAND (RobotErrors attribute)
O
OBJECT_NOT_FOUND (RobotErrors attribute)
open_gripper() (Tool method)
P
pick_and_place() (PickPlace method)
pick_from_pose() (PickPlace method)
PickPlace (class in pyniryo2.pick_place.pick_place)
place_from_pose() (PickPlace method)
PLAN_FAILED (RobotErrors attribute)
play() (Sound method)
PORTUGUESE (Language attribute)
pose (Arm property)
POSE (ArmMoveCommandType attribute)
POSE_QUAT (ArmMoveCommandType attribute)
PoseObject (class in pyniryo2.objects)
POSES_HANDLER_COMPUTE_FAILURE (RobotErrors attribute)
POSES_HANDLER_CREATION_FAILED (RobotErrors attribute)
POSES_HANDLER_READ_FAILURE (RobotErrors attribute)
POSES_HANDLER_REMOVAL_FAILED (RobotErrors attribute)
POSITION (ArmMoveCommandType attribute)
PREEMPTED (RobotErrors attribute)
PROGRAMS_MANAGER_AUTORUN_FAILURE (RobotErrors attribute)
PROGRAMS_MANAGER_EXECUTION_FAILED (RobotErrors attribute)
PROGRAMS_MANAGER_FAILURE (RobotErrors attribute)
PROGRAMS_MANAGER_FILE_ALREADY_EXISTS (RobotErrors attribute)
PROGRAMS_MANAGER_FILE_DOES_NOT_EXIST (RobotErrors attribute)
PROGRAMS_MANAGER_NOT_RUNNABLE_LANGUAGE (RobotErrors attribute)
PROGRAMS_MANAGER_READ_FAILURE (RobotErrors attribute)
PROGRAMS_MANAGER_STOPPING_FAILED (RobotErrors attribute)
PROGRAMS_MANAGER_UNKNOWN_LANGUAGE (RobotErrors attribute)
PROGRAMS_MANAGER_WRITING_FAILURE (RobotErrors attribute)
publish() (NiryoTopic method)
pull_air_vacuum_pump() (Tool method)
push_air_vacuum_pump() (Tool method)
pyniryo2.enums
module
pyniryo2.led_ring
module
pyniryo2.led_ring.enums
module
pyniryo2.led_ring.objects
module
pyniryo2.sound
module
pyniryo2.sound.enums
module
R
RAINBOW (AnimationMode attribute)
rainbow() (LedRing method)
RAINBOW_CHASE (AnimationMode attribute)
rainbow_chase() (LedRing method)
rainbow_cycle() (LedRing method)
RAINBOW_CYLE (AnimationMode attribute)
release_with_tool() (Tool method)
request_new_calibration() (Arm method)
reset_calibration() (Arm method)
reset_tcp() (Tool method)
ROBOT_STATUS (LedMode attribute)
RobotErrors (class in pyniryo2.enums)
ROS_ERROR (RobotErrors attribute)
RPY (ArmMoveCommandType attribute)
run_conveyor() (Conveyor method)
S
save() (Sound method)
save_dynamic_frame_from_points() (Frames method)
save_dynamic_frame_from_poses() (Frames method)
save_last_learned_trajectory() (Trajectories method)
save_pose() (SavedPoses method)
save_trajectory() (Trajectories method)
save_workspace_from_points() (Vision method)
save_workspace_from_robot_poses() (Vision method)
SavedPoses (class in pyniryo2.saved_poses.saved_poses)
say() (Sound method)
SERIAL_FILE_ERROR (RobotErrors attribute)
SERIAL_UNKNOWN_ERROR (RobotErrors attribute)
set_arm_max_velocity() (Arm method)
set_brightness() (Vision method)
set_contrast() (Vision method)
set_conveyor() (Conveyor method)
set_jog_control() (Arm method)
set_learning_mode() (Arm method)
set_led_color() (LedRing method)
set_pin_mode() (IO method)
set_saturation() (Vision method)
set_tcp() (Tool method)
set_volume() (Sound method)
setup_electromagnet() (Tool method)
SHIFT_LINEAR_POSE (ArmMoveCommandType attribute)
SHIFT_POSE (ArmMoveCommandType attribute)
shift_pose() (Arm method)
SHOULD_RESTART (RobotErrors attribute)
SNAKE (AnimationMode attribute)
snake() (LedRing method)
SOLID (AnimationMode attribute)
solid() (LedRing method)
Sound (class in pyniryo2.sound)
sounds (Sound property)
SPANISH (Language attribute)
state (Sound property)
status (LedRing attribute)
stop() (Sound method)
stop_conveyor() (Conveyor method)
stop_move() (Arm method)
STOPPED (RobotErrors attribute)
subscribe() (NiryoTopic method)
SUCCESS (RobotErrors attribute)
SYSTEM_API_CLIENT_INVALID_ROBOT_NAME (RobotErrors attribute)
SYSTEM_API_CLIENT_REQUEST_FAILED (RobotErrors attribute)
SYSTEM_API_CLIENT_UNKNOWN_ERROR (RobotErrors attribute)
T
terminate() (NiryoRos method)
Tool (class in pyniryo2.tool.tool)
tool (Tool property)
TOOL_FAILURE (RobotErrors attribute)
TOOL_ID_INVALID (RobotErrors attribute)
TOOL_NOT_CONNECTED (RobotErrors attribute)
TOOL_ROS_INTERFACE_ERROR (RobotErrors attribute)
Trajectories (class in pyniryo2.trajectories.trajectories)
turn_off() (LedRing method)
U
UNKNOWN (AnimationMode attribute)
(LedMode attribute)
UNKNOWN_COMMAND (RobotErrors attribute)
unset_conveyor() (Conveyor method)
unsubscribe() (NiryoTopic method)
update_tool() (Tool method)
update_trajectory_infos() (Trajectories method)
USER (LedMode attribute)
V
value (NiryoTopic property)
VIDEO_STREAM_NOT_RUNNING (RobotErrors attribute)
VIDEO_STREAM_ON_OFF_FAILURE (RobotErrors attribute)
Vision (class in pyniryo2.vision.vision)
vision_pick() (Vision method)
volume (Sound property)
W
wait() (NiryoRobot static method)
wipe() (LedRing method)
WORKSPACE_CREATION_FAILED (RobotErrors attribute)
WRONG_MOTOR_TYPE (RobotErrors attribute)