.. _simple_examples:

Simple Examples
***************

Code examples that use the :ref:`simple_api`.

.. note::
   The examples require Python 3.9+ to run.

.. _simple_discovery_example:

Find one or more devices
========================

.. literalinclude:: ../../examples/simple/discover_devices.py
   :language: python
   :linenos:

Remote control devices
======================

.. _simple_get_status_example:

Get current status
------------------

.. literalinclude:: ../../examples/simple/get_status.py
   :language: python
   :linenos:

.. _simple_auto_update_example:

Automatic status updates
------------------------

The :py:class:`Device <pupil_labs.realtime_api.simple.Device>` class monitors a
Neon / Pupil Invisible Companion device in the background and mirrors its state accordingly.

.. literalinclude:: ../../examples/simple/status_auto_update.py
   :language: python
   :linenos:


Send event
----------

An event without an explicit timestamp, will be timestamped on arrival at the Neon / Pupil
Invisible Companion device.

.. literalinclude:: ../../examples/simple/send_event.py
   :language: python
   :emphasize-lines: 12,16-19,24,25,29,30,32-34
   :linenos:

Start, stop and save, and cancel recordings
-------------------------------------------

.. literalinclude:: ../../examples/simple/start_stop_recordings.py
   :language: python
   :emphasize-lines: 13,18,21
   :linenos:

Templates
-------------------------------------------

You can programmatically fill the template. This allows you to also define the
recording name if the template is created correctly.

.. _simple_template_example:

.. literalinclude:: ../../examples/simple/templates.py
   :language: python
   :emphasize-lines: 19,22,70-107,112
   :linenos:

Streaming
=========

Gaze data
---------

.. literalinclude:: ../../examples/simple/stream_gaze.py
   :language: python
   :emphasize-lines: 10,14,19
   :linenos:

Scene camera video
------------------

.. literalinclude:: ../../examples/simple/stream_scene_camera_video.py
   :language: python
   :emphasize-lines: 18
   :linenos:

Eyes camera video
-----------------

.. note:: Only available when connecting to a Neon Companion app

.. literalinclude:: ../../examples/simple/stream_eyes_camera_video.py
   :language: python
   :emphasize-lines: 18
   :linenos:

Camera calibration
------------------

.. note:: Only available when connecting to a Neon Companion app

.. literalinclude:: ../../examples/simple/camera_calibration.py
   :language: python
   :emphasize-lines: 12
   :linenos:


.. _stream_video_with_overlayed_gaze_example_simple:

Scene camera video with overlayed gaze
--------------------------------------

.. literalinclude:: ../../examples/simple/stream_video_with_overlayed_gaze.py
   :language: python
   :emphasize-lines: 18,20,21
   :linenos:

Scene camera video with overlayed eyes video and gaze circle
------------------------------------------------------------

.. note:: Only available when connecting to a Neon Companion app

.. literalinclude:: ../../examples/simple/stream_scene_eyes_and_gaze.py
   :language: python
   :emphasize-lines: 18,27,35-36
   :linenos:

Time Offset Estimation
======================

See :py:mod:`pupil_labs.realtime_api.time_echo` for details.

.. literalinclude:: ../../examples/simple/device_time_offset.py
   :language: python
   :emphasize-lines: 9,14,15
   :linenos: