Niryo Vision Set - User Manual
================================

.. ifconfig:: language in ['en']

  .. image:: images/ned_vision_set.jpeg
         :alt: Ned Vision Set
         :width: 500px
         :align: center


.. ifconfig:: language in ['fr']

  .. image:: images/fr_ned_vision_set.png
         :alt: Ned Vision Set
         :width: 500px
         :align: center


Introduction
----------------

This manual provides a general overview of Niryo’s Vision Set
and describes in detail how to control and use the product.

Niryo’s Vision Set has been developed to allow Ned to use its
camera to deal with its environment. This module can be used with:

 - A prerecorded sequence which will be run by pressing Ned's top button,
 - A Blockly script written on Niryo Studio,
 - A Python script which can be launched via |python_ros_wrapper|_ or |pyniryo|_,
 - An image processing script written by the user.

Prerequisites
----------------

 - Software Niryo Robot Version ≥ 3.0
 - Niryo Studio Version ≥ 3.0

If you do not have the recommended versions, you can refer to those tutorials:
  - |Update Niryo Robot Raspberry|_
  - |Update Niryo Studio|_


Kit Overview
----------------

.. list-table::
   :header-rows: 1
   :widths: auto
   :align: center

   * - Part
     - Quantity
     - Description
   * - USB Cable
     - x1
     - PH-4 to USB 1m, connects the camera to Ned
   * - Scratch
     - x2
     - Allows to attach the cable to the robotic arm
   * - Calibration tip
     - x1
     - End effector used for workspace calibration
   * - Squared Container
     - x3
     - Handable 3D squares that can be used as containers for the circles
   * - Circles
     - x3
     - Handable 3D circles that can be placed in the squared containers
   * - Workspace board
     - x1
     - A repositionable printed workspace board
   * - Workspace support
     - x1
     - Allows to set the workspace board
   * - Mechanical connector
     - x1
     - | Which is composed of an aluminum base for Ned
       | and links to connect the workspace support as well as the Conveyor Belt

.. toctree::
   :maxdepth: 1
   :hidden:
   :caption: Documentation Sections

   self
   source/how_it_works
   source/setup
   source/how_to_use_blockly
   source/go_further
   source/warnings_typical_issues


.. |pyniryo| replace:: PyNiryo
.. _pyniryo: https://docs.niryo.com/dev/pyniryo/

.. |python_ros_wrapper| replace:: Python ROS Wrapper
.. _python_ros_wrapper: https://docs.niryo.com/dev/ros/source/ros_wrapper.html

.. |Update Niryo Studio| replace:: Update Niryo Studio
.. _Update Niryo Studio: https://niryo.com/docs/niryo-one/update-your-robot/update-niryo-one-studio/

.. |Update Niryo Robot Raspberry| replace:: Update Niryo Robot Raspberry Image
.. _Update Niryo Robot Raspberry: https://niryo.com/docs/niryo-one/update-your-robot/update-raspberry-pi-image/