Skip to content

Latest commit

 

History

History
180 lines (128 loc) · 8.25 KB

build.md

File metadata and controls

180 lines (128 loc) · 8.25 KB
Raw

Build and Install

Index

Building IoT Agents

These IoT Agents are successfully built in CentOS 6.5 distribution.

Support to build dependencies

Some dependencies are included in third_party directory in order to make easy this building process. CMakeLists.txt add external projects in order to download and build following dependencies:

#####IMPORTANT If you want to modify the URL from dependencies are downloaded, you must modify CMakeLists.txt

Note: our CMakeLists.txt requires cmake 2.8.12 or higher to build the project.

IoT Agents need MongoDB as persistent storage. Be sure that MongoDB is started in your host in order to execute unit tests.

Get the source

Run:

git clone https://github.com/telefonicaid/fiware-IoTAgent-Cplusplus.git

Configure build environment

To build IoT Agents you need cmake 2.8.12 (minimum version). If you want to build our MQTT module you must add -DMQTT=ON to command line.

Build

We use out-of-source building, so you must build out of source directory. The directory where source is downloaded will be called SourcePath. From this directory let'us make a directory build/build_type (build_type must be Debug, Release or DebugCoverage) and execute (in this example we use Debug as build_type ): (target install only copy built libraries in a directory to concentrate them).

$ pwd
$ /home/develop/dca-core
$ mkdir -p build/Debug
$ cd build/Debug
$ cmake -DGIT_VERSION=<version> -DGIT_COMMIT=<release> -DMQTT=ON -DCMAKE_BUILD_TYPE=Debug ../../
$ make
$ make check install

The target check execute unit tests and target install copies libraries in SourcePath/lib/build_type and executable in SourcePath/bin/build_type. For example, for DebugCoverage target:

-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/bin/DebugCoverage/iotagent
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libiota.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libiota.a

-- Up-to-date: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libEsp.a
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/MqttService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libMqttService.a

-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libMqttService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/TTService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libTTService.a
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libTTService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/RepsolService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libRepsolService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/UL20Service.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libUL20Service.a
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libUL20Service.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/TestService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libTestService.a
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libTestService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/EvadtsService.so
-- Installing: /home/develop/JENKINS/workspace/Rebuild_iotagent/lib/DebugCoverage/libEvadtsService.so

You must know that shared objects without prefix lib are modules. These modules are loaded by IoT Agent based on PION as plugins implementing protocols. If you need rpms execute make package in order to build:

  • iot-agent-base-[version]-[release].x86_64.rpm: IoT Agent core.
  • iot-agent-ul-[version]-[release].x86_64.rpm: IoT Agent Ultra-Light module.
  • iot-agent-mqtt-[version]-[release].x86_64.rpm: IoT Agent MQTT module.
  • iot-agent-tt-[version]-[release].x86_64.rpm: IoT Agent Thinking Things module.

Some dependencies are include in rpm (boost, pion, log library).

An unit test called testPUSHCommandProxyAndOutgoingRoute needs tinyproxy in port 8888 (this test checks sending command through http proxy).

Documentation

TBC. If you have doxygen installed, you can generate html documentation of the libvariant public interface from the source code with:

$ cd build/Debug
$ cmake -DGIT_VERSION=<version> -DGIT_COMMIT=<release> -DBOOST_ROOT=<path-to-boost> -DCMAKE_BUILD_TYPE=Debug ../../
$ make doc

The output html is in build/Debug/doc

How to start agents

The general procedure to start an IoT Agent needs needs that libraries generated or deployed can be loaded by executable (LD_LIBRARY_PATH environment variable). The executable is named iotagent.

To get information about parameter uses

$iotagent -h
usage:   iotagent [OPTIONS] -f CONFIG_FILE RESOURCE WEBSERVICE
         iotagent [OPTIONS (except -o)] -c SERVICE_CONFIG_FILE
options: [-m] [-4] [-6] [-i IP] [-p PORT] [-u URL_BASE] [-n IOTAGENT_NAME] [-d PLUGINS_DIR] [-o OPTION=VALUE] [-v LOG_LEVEL]
options explication:
-c/--config_file <CONFIG_FILE> starts all RESOURCE configured in CONFIG_FILE
-h/--help             This help text.
-m/--manager          an iota manager server is started, without this option an iota agent is started.
-4/--ipv4             server is started in 0.0.0.0
-6/--ipv6             server is started in [::]
-i/--ip <IP>          ip address where server is started (Default is 0.0.0.0). If no provided we cannot register for commands. Thus, this parameter is recommended to provide, any way.
-p/--port <PORT>      the port where server is listening (Default is 8080)
-u/--url <URL_BASE>   It defines a root url (Default is /iot)
-n/--name <IOTAGENT_NAME>  The name assigned. This name is used as part of log file (IoTAgent-.log)
-d/--plugins-dir <PLUGINS_DIR>  You can specify a directory where modules are located.
-o/--option <OPTION=VALUE>   options for web server.
-v/--verbose <LOG_LEVEL> log level (DEBUG, INFO, WARNING, ERROR, FATAL).
-s/--ssl <ssl_pem_file> start ssl interface.
-t/--threads <num threads> start so threads as num threads, by default 8.
-I/--identifier <UNIQUE_IDENTIFIER> identifier used with iota manager.

You can start an iotagent by following procedure:

     iotagent -i IP [OPTIONS (except -o)] -c SERVICE_CONFIG_FILE

This way starts all RESOURCE configured in CONFIG_FILE.

     options:  [-p PORT] [-u URL_BASE] [-n IOTAGENT_NAME] [-d PLUGINS_DIR] [-v LOG_LEVEL]

Examples:

     iotagent -p 80 -n mqtt -c /etc/iot/config.json

Port is 80 (modifying the default port), log file is IoTAgent-mqtt.log, url for this module is /iot/mqtt (root url is /iot). Configuration as iotagent is in /etc/iot/config.json file.

     iotagent -p 80 -n mqtt -v ERROR -c /etc/iot/config.json

It defines a log level to ERROR.

To check iotagent, you can use curl

     curl -g -X GET http://127.0.0.1:80/iot/about

the response

     Welcome to IoTAgents 1.1.0 identifier:dev:80 commit 134.g5b92683 in Jul 23 2015

Identifier is the unique name sending to iota manager.

if you start with -6 you can use

    curl -g -X GET http://[::1]:80/iot/about

To check your installation exists a Sanity check iotagent, execute it to be sure that everything is ok.

Making your module-based iotagent

Sample Module