Difference between revisions of "API2"

From RobotinoWiki
(Windows)
 
(55 intermediate revisions by 4 users not shown)
Line 1: Line 1:
The new API2 is currently under development. The main new features are
+
==Introduction==
* Support for up to 4 cameras
+
{|class="wikitable" cellpadding="20" vertical-align="top"
* Support for camera controls like brightness, contrast, auto white balance ... The supported controls depend on the camera used
+
|-
* Integrated web server for controlling Robotino by a web browser or your smartphone
+
|[[Image:Robotino_api2_icon_64.png]]
* Easy build process due to minimal dependencies to external libraries
+
|A C/C++ library to access Robotino's sensors and actors from your own program.
 +
|}
  
The new API2 is based on a RPC like infrastructure. The [http://servicerobotics.eu/weitere-projekte/rec-rpc-library/ REC-RPC] library is a interprocess communication middleware similar to ROS. It is based on Qt and does not have any other dependencies.
+
==Download and install==
 +
Check [[Robotino_OS|Robotino OS]] to find the link to the API2 library.
  
* [[API2_quickstart|Quickstart guide to use API2]]
+
===Windows===
* [[API2_install_daemons|How to install API2 daemons on Robotino]]
+
On Windows (Visual Studio) you need to install the binary package that fits your compiler. Currently we support two compilers. Please open a command prompt and use ''set'' to see your Visual Studio or Visual Studio Tools version.
* [[C++|C++ programming with API2]]
 
* [[Java|Java programming with API2]]
 
* [[dotnet|.Net programming with API2]]
 
  
 +
API2 for
 +
* [http://packages.openrobotino.org/windows/robotino-api2/msvc-12 Visual Studio 2013]
 +
* [http://packages.openrobotino.org/windows/robotino-api2/msvc-140 Visual Studio 2015]
 +
* [http://packages.openrobotino.org/windows/robotino-api2/msvc-141 Visual Studio 2017]
 +
* [http://packages.openrobotino.org/windows/robotino-api2/msvc-142 Visual Studio 2019]
  
===Building API2 from source===
+
==Build examples==
Get the source via SVN:
+
The API2 package comes with examples showing how to use the C/C++ interface.
 +
 
 +
===Linux===
 
<pre>
 
<pre>
svn co http://svn.openrobotino.org/api/trunk source/api
+
mkdir examples
 +
cd examples
 +
cp -R /opt/robotino/examples/cpp/circle/ circle
 +
cd circle
 +
mkdir build
 +
cd build
 +
cmake ..
 +
make
 
</pre>
 
</pre>
Configure the build environment with cmake, build and install:
+
 
 +
===Windows===
 +
* Download and install [https://cmake.org/ cmake].
 +
* Copy c:\program files\rec gmb\api2\examples to a user writable directory.
 +
* Run cmake-gui
 +
* Choose source and destiantion directory
 +
* Configure and Generate
 +
* Open the generated Visual Studio Solution
 +
 
 +
==Quick links==
 +
* [https://doc.openrobotino.org/download/RobotinoAPI2/rec_robotino_api2/ Documentation]
 +
 
 +
==C++ example==
 
<pre>
 
<pre>
mkdir build/api
+
#include <iostream>
cd build/api
+
#include "rec/robotino/api2/all.h"
ccmake ../../source/api
+
 
make install
+
rec::robotino::api2::Com com;
</pre>
+
rec::robotino::api2::Bumper bumper;
 +
 
 +
int main( int argc, char **argv )
 +
{
 +
  std::string hostname = "172.26.1.1";
 +
  if( argc > 1 )
 +
  {
 +
    hostname = argv[1];
 +
  }
 +
 
 +
  com.setAddress( hostname.c_str() );
 +
  com.connectToServer( true );
 +
 
 +
  while(com.isConnected() && false == bumper.value())
 +
  {
 +
    std::cout << "Bumper is " << (bumper.value()?"":"not") << " pressed" << std::endl;
 +
    com.processEvents();
 +
    rec::robotino::api2::msleep( 100 );
 +
  }
 +
 
 +
  com.disconnectFromServer();
  
On Windows:
+
  rec::robotino::api2::shutdown();
In case you used a 32bit compiler set the environment variable '''ROBOTINOAPI2_32_DIR''' to the installation directory. When you compiled the library with a 64bit compiler set the environment variable '''ROBOTINOAPI2_64_DIR''' The environment variable is used by the other packages to find the FindRobotinoApi.cmake scripts.
 
Example: On my system I got
 
<pre>ROBOTINOAPI2_32_DIR=E:\build\robotino_api_win32_vc100\install</pre>
 
  
On Linux:
+
  return 0;
<pre>
+
}
make ALL_CREATE_INSTALLER
 
sudo dpkg -i robotino-api-*.deb
 
 
</pre>
 
</pre>
  
===Building the API2 examples on Robotino===
+
==C example==
 
<pre>
 
<pre>
mkdir -p build/circle
+
#include <stdio.h>
cd build/circle
+
#include <stdlib.h>
ccmake /usr/local/robotino/examples/src/c++/circle/
+
#include <string.h>
configure(c) 2x, generate(g)
 
make
 
target/example_circle 127.0.0.1
 
</pre>
 
  
===Build Robotino tools and daemons===
+
#ifdef WIN32
 +
#include <windows.h>
 +
#else
 +
#include <unistd.h> //usleep
 +
#endif
  
Windows:
+
#include "rec/robotino/api2/c/Com.h"
* Get the latest Qt libraries from [http://qt.nokia.com/downloads Digia]
 
* Alternatively build Qt from source
 
  
Linux:
+
void msleep( unsigned int ms )
* Install libqt4-dev
+
{
 +
#ifdef WIN32
 +
  SleepEx( ms, FALSE );
 +
#else
 +
  usleep( ms * 1000 );
 +
#endif
 +
}
  
====Build REC-RPC====
+
ComId com;
Get the source via SVN:
+
BumperId bumper;
<pre>
 
svn co http://svn.servicerobotics.eu/rec_rpc/trunk source/rec_rpc
 
</pre>
 
Configure the build environment with cmake, build and install:
 
<pre>
 
mkdir build/rec_rpc
 
cd build/rec_rpc
 
ccmake ../../source/rec_rpc
 
make install
 
</pre>
 
  
On Windows:
+
int main( int argc, char **argv )
In case you used a 32bit compiler set the environment variable '''RECRPC32_DIR''' to the installation directory. When you compiled the library with a 64bit compiler set the environment variable '''RECRPC64_DIR''' The environment variable is used by the other packages to find the FindRecRpc.cmake scripts. Example: On my system I got
+
{
<pre>RECRPC32_DIR=E:\build\rec-rpc_win32_vc100\install</pre>
+
  com = Com_construct();
  
On Linux:
+
  if( argc > 1 )
<pre>
+
  {
make ALL_CREATE_INSTALLER
+
    Com_setAddress( com, argv[1] );
sudo dpkg -i rec-rpc-*.deb
+
  }
</pre>
+
  else
 +
  {
 +
    Com_setAddress( com, "172.26.1.1" );
 +
  }
  
====Build Robotino Common====
+
  if( FALSE == Com_connect( com ) )
Get the source via SVN:
+
  {
<pre>
+
    printf( "Error on connect" );
svn co http://svn.openrobotino.org/common/trunk source/common
+
    exit(1);
</pre>
+
  }
Configure the build environment with cmake, build and install:
+
  else
<pre>
+
  {
mkdir build/common
+
    char addressBuffer[256];
cd build/common
+
    Com_address( com, addressBuffer, 256 );
ccmake ../../source/common
+
    printf( "Connected to %s\n", addressBuffer );
make install
+
  }
</pre>
 
  
On Windows:
+
  while( Com_isConnected( com ) && FALSE == Bumper_value( bumper ) )
In case you used a 32bit compiler set the environment variable '''ROBOTINOCOMMON32_DIR''' to the installation directory. When you compiled the library with a 64bit compiler set the environment variable '''ROBOTINOCOMMON64_DIR''' The environment variable is used by the other packages to find the FindRobotinoCommon.cmake scripts.
+
  {
Example: On my system I got
+
    printf("Value of bumper is %d\n",Bumper_value( bumper ) )
<pre>ROBOTINOCOMMON32_DIR=E:\build\robotino_common_win32_vc100\install</pre>
+
    msleep( 50 );
 +
  }
  
On Linux:
+
  Bumper_destroy( bumper );
<pre>
+
  Com_destroy( com );
make ALL_CREATE_INSTALLER
 
sudo dpkg -i robotino-common-*.deb
 
</pre>
 
  
====Build Robotino Daemons====
+
  return 0;
Get the source via SVN:
+
}
<pre>
 
svn co http://svn.openrobotino.org/daemons/trunk source/daemons
 
</pre>
 
Configure the build environment with cmake, build and install:
 
<pre>
 
mkdir build/daemons
 
cd build/daemons
 
ccmake ../../source/daemons
 
make install
 
 
</pre>
 
</pre>

Latest revision as of 09:24, 10 May 2019

Introduction

Robotino api2 icon 64.png A C/C++ library to access Robotino's sensors and actors from your own program.

Download and install

Check Robotino OS to find the link to the API2 library.

Windows

On Windows (Visual Studio) you need to install the binary package that fits your compiler. Currently we support two compilers. Please open a command prompt and use set to see your Visual Studio or Visual Studio Tools version.

API2 for

Build examples

The API2 package comes with examples showing how to use the C/C++ interface.

Linux

mkdir examples
cd examples
cp -R /opt/robotino/examples/cpp/circle/ circle
cd circle
mkdir build
cd build
cmake ..
make

Windows

  • Download and install cmake.
  • Copy c:\program files\rec gmb\api2\examples to a user writable directory.
  • Run cmake-gui
  • Choose source and destiantion directory
  • Configure and Generate
  • Open the generated Visual Studio Solution

Quick links

C++ example

#include <iostream>
#include "rec/robotino/api2/all.h"

rec::robotino::api2::Com com;
rec::robotino::api2::Bumper bumper;

int main( int argc, char **argv )
{
  std::string hostname = "172.26.1.1";
  if( argc > 1 )
  {
    hostname = argv[1];
  }

  com.setAddress( hostname.c_str() );
  com.connectToServer( true );
  
  while(com.isConnected() && false == bumper.value())
  {
    std::cout << "Bumper is " << (bumper.value()?"":"not") << " pressed" << std::endl;
    com.processEvents();
    rec::robotino::api2::msleep( 100 );
  }

  com.disconnectFromServer();

  rec::robotino::api2::shutdown();

  return 0;
}

C example

#include <stdio.h>
#include <stdlib.h>
#include <string.h>

#ifdef WIN32
#include <windows.h>
#else
#include <unistd.h> //usleep
#endif

#include "rec/robotino/api2/c/Com.h"

void msleep( unsigned int ms )
{
#ifdef WIN32
  SleepEx( ms, FALSE );
#else
  usleep( ms * 1000 );
#endif
}

ComId com;
BumperId bumper;

int main( int argc, char **argv )
{
  com = Com_construct();

  if( argc > 1 )
  {
    Com_setAddress( com, argv[1] );
  }
  else
  {
    Com_setAddress( com, "172.26.1.1" );
  }

  if( FALSE == Com_connect( com ) )
  {
    printf( "Error on connect" );
    exit(1);
  }
  else
  {
    char addressBuffer[256];
    Com_address( com, addressBuffer, 256 );
    printf( "Connected to %s\n", addressBuffer );
  }

  while( Com_isConnected( com ) && FALSE == Bumper_value( bumper ) )
  {
    printf("Value of bumper is %d\n",Bumper_value( bumper ) )
    msleep( 50 );
  }

  Bumper_destroy( bumper );
  Com_destroy( com );

  return 0;
}