iShapes Demonstrator

[TOC]

What is it?

iShapes is an interactive GUI based Zenoh (Zero Network Overhead) Application to learn, demonstate and test Zenoh key concepts.

It shows and demonstrates the key Zenoh concepts. It has also been used at the Eclipse Foundation to test the interoperability of the Zettascale products.

Each geometrical shape is represented by a dedicated key expression

The shape dataType is characterized by its color, its position in a 2D space and its Size. Shapes with different colors are considered different data objects, i,e different data instances, as the color data attribute is considered the @Key of the dataType. Each data instance has its unique identity, its own lifecycle and its state.

Building iShapes

ishapes can be rely on Zenoh C++ API,

For the Zenoh Ishape demo, the Zenoh C core, Zenoh C++ binding for Zenoh need to be installed before proceeding.
You can get Zenog C Core from https://github.com/eclipse-zenoh/zenoh-c , t and the related C++ APIs from hhttps://github.com/eclipse-zenoh/zenoh-cpp

To clone the ishape demo application in your locale repository, do

  $ git clone https://github.com/vivekpandey02/Demo_Ishape_Zenoh_Interoperability_with_CycloneDDS   
  $ cd Demo_Ishape_Zenoh_Interoperability_with_CycloneDDS   

Building Zenoh iShapes

From now one, we assume Zenoh and QT5 are installed

Building on Linux/MacOS with cmake

To build the iShapes demo you need to have installed a QT5 development environment. The following QT5 environment variables has to be set in order to build and run ishapes:

  $ export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:<qt5_install-location>
  
   Where <qt5_install-location> is the installation directory of your QT5 installation , e.g (/usr/lib/x86_64_linux-gnu/qt5)  

then you need to simply do the following from the iShape demo root directory:

  $ mkdir zenoh_demo_ishapes && cd zenoh_demo_ishapes  
  $ cmake .. 
  $ cmake --build . --config Release  

Note: please use '--config Debug' if you are using zenoh debug build to build this iShape application. $ cmake --build . --config Release

 Note: please use '--config Debug' if you are using zenoh debug build to build this iShape application.

Building on Windows with cmake

To build the demo you need to have installed a QT5 development environment. The following QT5 environment variables has to be set in order to build and run ishapes:

  C:\> set QTDIR=<QT5-INSTALLATION-DIR> 
  C:\> set QT_PLUGIN_PATH=<QT5-INSTALLATION-DIR>\plugins  
  C:\> set PATH=<QT5-INSTALLATION-DIR>\bin;%PATH%   
  
  Where <QT5-INSTALLATION-DIR> is the installation directory of your QT5 installation , e.g (<C:\Qt\5.7.1> )  

then you need to simply do the following from the iShape demo root directory:

  $ mkdir zenoh_demo_ishapes && cd zenoh_demo_ishapes
  $ cmake ..
  $ cmake --build . --config Release    

Note: please use '--config Debug' if you are using zenoh debug build to build this iShape application.

Running iShapes

The iShapes demo allows you to publish and subscribe instances of various shapes. The demo is didactic if you run it as at least into two application instances, thus from a shell do one of the below then have one of the applications publish some shapes and press the subscribe button on the other application to receive them.

image-20201022104103958

Running Zenoh iShapes

Linux/MacOS:

To run it you need to simply do the following:

  $ <build_directory>/zenoh_demo_ishapes &  
  $ <build_directory>/zenoh_demo_ishapes &  

Windows:

  C:\> start <build_directory>/zenoh_demo_ishapes  
  C:\> start <build_directory>/zenoh_demo_ishapes