PyNiryo

Setup

  • Installation
    • Installation with pip
    • Uninstall
  • Find your Robot’s IP address
    • Hotspot mode
    • Simulation or directly on the robot
    • Direct ethernet connection
    • Computer and robot connected on the same router
    • Make IP permanent
  • Verify your Setup and Get Started

Examples

  • Examples: Basics
    • Your first move joint
      • Code Details - First Move J
    • Your first pick and place
      • Code Details - First Pick And Place
    • Notes
  • Examples: Movement
    • Joints
      • Move Joints
      • Get Joints
    • Pose
      • Move Pose
      • Get Pose
      • How to use the PoseObject
  • Examples: Tool action
    • Tool control
      • Equip Tool
      • Grasping
      • Releasing
    • Pick & Place with tools
      • Code Baseline
      • First Solution: the heaviest
      • Second Solution: Use of PoseObject
      • Third Solution: Pick from pose & Place from pose functions
      • Fourth Solution: All in one
  • Examples : Conveyor Belt
    • Simple Conveyor control
    • Advanced Conveyor Belt control
  • Examples: Vision
    • Needed piece of code
    • Simple Vision Pick & Place
      • Code Details - Simple Vision Pick and Place
    • First conditioning via Vision
      • Code Details - First Conditioning via Vision
    • Multi Reference Conditioning
      • Code Details - Multi Reference Conditioning
    • Sorting Pick with Conveyor
      • Code Details - Sort Picking
  • Examples : Dynamic frames
    • Simple dynamic frame control
  • Code templates
    • The short template
    • Advanced template
    • Advanced template for Conveyor Belt
    • Advanced template for Vision

API Documentation

  • PyNiryo API Documentation
    • Command functions
      • TCP Connection
        • NiryoRobot.connect()
        • NiryoRobot.close_connection()
      • Main purpose functions
        • NiryoRobot.calibrate()
        • NiryoRobot.calibrate_auto()
        • NiryoRobot.need_calibration()
        • NiryoRobot.get_learning_mode()
        • NiryoRobot.set_learning_mode()
        • NiryoRobot.set_arm_max_velocity()
        • NiryoRobot.set_jog_control()
        • NiryoRobot.wait()
      • Joints & Pose
        • NiryoRobot.get_joints()
        • NiryoRobot.get_pose()
        • NiryoRobot.get_pose_quat()
        • NiryoRobot.move_joints()
        • NiryoRobot.move_pose()
        • NiryoRobot.move_linear_pose()
        • NiryoRobot.shift_pose()
        • NiryoRobot.shift_linear_pose()
        • NiryoRobot.jog_joints()
        • NiryoRobot.jog_pose()
        • NiryoRobot.move_to_home_pose()
        • NiryoRobot.go_to_sleep()
        • NiryoRobot.forward_kinematics()
        • NiryoRobot.inverse_kinematics()
      • Saved Poses
        • NiryoRobot.get_pose_saved()
        • NiryoRobot.save_pose()
        • NiryoRobot.delete_pose()
        • NiryoRobot.get_saved_pose_list()
      • Pick & Place
        • NiryoRobot.pick_from_pose()
        • NiryoRobot.place_from_pose()
        • NiryoRobot.pick_and_place()
      • Trajectories
        • NiryoRobot.get_trajectory_saved()
        • NiryoRobot.get_saved_trajectory_list()
        • NiryoRobot.execute_trajectory_from_poses()
        • NiryoRobot.execute_trajectory_from_poses_and_joints()
        • NiryoRobot.save_trajectory()
        • NiryoRobot.delete_trajectory()
      • Dynamic frames
      • Tools
        • NiryoRobot.get_current_tool_id()
        • NiryoRobot.update_tool()
        • NiryoRobot.grasp_with_tool()
        • NiryoRobot.release_with_tool()
        • NiryoRobot.open_gripper()
        • NiryoRobot.close_gripper()
        • NiryoRobot.pull_air_vacuum_pump()
        • NiryoRobot.push_air_vacuum_pump()
        • NiryoRobot.setup_electromagnet()
        • NiryoRobot.activate_electromagnet()
        • NiryoRobot.deactivate_electromagnet()
        • NiryoRobot.enable_tcp()
        • NiryoRobot.set_tcp()
        • NiryoRobot.reset_tcp()
        • NiryoRobot.tool_reboot()
      • Hardware
        • NiryoRobot.set_pin_mode()
        • NiryoRobot.digital_write()
        • NiryoRobot.digital_read()
        • NiryoRobot.get_hardware_status()
        • NiryoRobot.get_digital_io_state()
      • Conveyor
        • NiryoRobot.set_conveyor()
        • NiryoRobot.unset_conveyor()
        • NiryoRobot.run_conveyor()
        • NiryoRobot.stop_conveyor()
        • NiryoRobot.control_conveyor()
        • NiryoRobot.get_connected_conveyors_id()
      • Vision
        • NiryoRobot.get_img_compressed()
        • NiryoRobot.set_brightness()
        • NiryoRobot.set_contrast()
        • NiryoRobot.set_saturation()
        • NiryoRobot.get_image_parameters()
        • NiryoRobot.get_target_pose_from_rel()
        • NiryoRobot.get_target_pose_from_cam()
        • NiryoRobot.vision_pick()
        • NiryoRobot.move_to_object()
        • NiryoRobot.detect_object()
        • NiryoRobot.get_camera_intrinsics()
        • NiryoRobot.save_workspace_from_robot_poses()
        • NiryoRobot.save_workspace_from_points()
        • NiryoRobot.delete_workspace()
        • NiryoRobot.get_workspace_ratio()
        • NiryoRobot.get_workspace_list()
      • Led Ring
      • Sound
    • Enums
    • Python object classes
      • PoseObject
        • PoseObject.copy_with_offsets()
        • PoseObject.to_list()
      • HardwareStatusObject
      • DigitalPinObject

Image Processing

  • Overview & examples
    • Play with Robot video stream
      • Get & display image from stream
      • Undistort and display video stream
    • Pure image processing functions
      • Color thresholding
      • Morphological transformations
      • Contours finder
      • Find object center position
      • Markers extraction
      • Debug mode
    • Do your own image processing!
      • Display video stream with extracted workspace
      • Vision pick via your image processing pipeline
  • Functions documentation
    • Pure image processing
      • image_functions.threshold_hsv()
      • image_functions.debug_threshold_color()
      • image_functions.morphological_transformations()
      • image_functions.get_contour_barycenter()
      • image_functions.get_contour_angle()
      • image_functions.biggest_contour_finder()
      • image_functions.biggest_contours_finder()
      • image_functions.draw_contours()
    • Workspaces wise
      • image_functions.extract_img_workspace()
      • image_functions.debug_markers()
      • image_functions.relative_pos_from_pixels()
    • Show
      • image_functions.show_img_and_check_close()
      • image_functions.show_img()
      • image_functions.show_img_and_wait_close()
    • Image Editing
      • image_functions.compress_image()
      • image_functions.uncompress_image()
      • image_functions.add_annotation_to_image()
      • image_functions.undistort_image()
      • image_functions.resize_img()
      • image_functions.concat_imgs()
    • Enums Image Processing
      • ColorHSV
        • ColorHSV.BLUE
        • ColorHSV.RED
        • ColorHSV.GREEN
        • ColorHSV.ANY
      • ColorHSVPrime
        • ColorHSVPrime.BLUE
        • ColorHSVPrime.RED
        • ColorHSVPrime.GREEN
        • ColorHSVPrime.ANY
      • ObjectType
        • ObjectType.SQUARE
        • ObjectType.TRIANGLE
        • ObjectType.CIRCLE
        • ObjectType.ANY
      • MorphoType
        • MorphoType.ERODE
        • MorphoType.DILATE
        • MorphoType.OPEN
        • MorphoType.CLOSE
      • KernelType
        • KernelType.RECT
        • KernelType.ELLIPSE
        • KernelType.CROSS
PyNiryo
  • Search

© Copyright 2025, Niryo All rights reserved. No part of this document may be reproduced or transmitted in any form or by any means without prior written consent of Niryo SAS.

Built with Sphinx using a theme provided by Read the Docs.
  Other versions   v: v1.1.2
Tags
v1.0.5
v1.2.1
v1.2.0
v1.1.2
v1.0.3
v1.0.4
v1.2.0-1
v1.1.0
v1.1.1
Search