Skip to content

Latest commit

 

History

History
135 lines (90 loc) · 5.31 KB

README.md

File metadata and controls

135 lines (90 loc) · 5.31 KB
Raw

Introduction to Distributed Publish Subscribe for IoT

Note: This is a preview release of the software and is intended for evaluation and experimentation only.

Install prerequisites

Linux

  • gcc

  • SCons

  • libuv is used by node.js so packages are available for many distributions but note that DPS requires libuv 1.7 or later so it may be necessary to build libuv from source. libuv source code on GitHub.

  • SWIG

Windows

  • Visual Studio

    Note: In Visual Studio 2015, Visual C++ is not installed by default. When installing, be sure to choose Custom installation and then choose the C++ components you require. Or, if Visual Studio is already installed, choose File | New | Project | C++ and you will be prompted to install the necessary components.

  • Latest Python 2.7 Release

  • SCons

    Note: The SCons installer will not detect the 64-bit installation of Python. Instead, download the zip file and follow the installation instructions in SCons README.txt.

  • libuv

  • SWIG

Documentation

The C API documentation is generated using Doxygen. There is currently no support for generating API documentation for the Python or JS APIs.

Doxygen can be downloaded from here: Doxygen

Building the documentation requires the scons DoxygenBuilder tool. This page has instructions on how to install the builder.

Build

To build the DPS libraries, examples, bindings, and documentation run 'scons'.

$ scons [variant=debug|release] [transport=udp|tcp] [bindings=all|none]

To see the complete list of build options trune scons --help

The default build configuration is variant=release transport=udp bindings=all.

A limitation of the current implementation is that the transport must be configured at compile time.

The scons script pulls down source code from two external projects (tinycrypt and safestringlib) into the ./ext directory. If necessary these projects can be populated manually:

git clone https://github.com/01org/tinycrypt.git ext/tinycrypt

git clone https://github.com/01org/safestringlib.git ext/safestring

Note: the ext projects are populated the first time DPS is built. To update these projects you need to manually do a git pull or delete the project directory and rerun scons.

Examples

There are C, Python, and JS (node.js) examples.

The C examples are found in ./examples, the Python examples are in ./py_scripts and the JS examples are in ./js_scripts. There are currently six C samples:

  • publisher.c

    This application shows how to initialize a DPS node, create a publication and send it. It supports IP multicast or publication to a specific host and port number over the configured transport (udp or tcp). Optionally the application will request acknowledgments from the receiving subscribers.

    publisher a/b/c "hello world"

sends a single publication to the topic string **a/b/c** and exits.

  • subscriber.c

    This application is the subscription counterpart to publisher.c, it creates a subscription and either listens for multicast publications or links another node to form a subscriber mesh. With the following commands the subscriber application listens for multicast subscriptions that match the specified topic string.

    subscriber a/b/c
    subscriber a/+/c
    subscriber a/#

In the examples above the subscriptions all match **a/b/c**. On receiving a matching publication the
application prints out the subscription topic string that was matched and all the topic strings that
were in the publication, if the publication had a payload that is printed also.

  • registry.c

    This applications uses DPS to implement an experimental discovery service. There are two companion applications, reg_pubs and reg_subs described below that make use of this service to find and join a mesh identified by a tenant topic string.

  • reg_pubs.c

    This application is similar to publisher but it uses the registry service to find other nodes to link with. The result is a randomly multiply-connected mesh.

  • reg_subs.c

    This application is subscription counterpart to reg_subs, it uses the registry service to find other node and links into the mesh.

  • pub_many.c

    This is application sends a series of publications as fast as they are acknowledged. It can be used with the subscriber application.

The C examples are installed in ./build/dist/bin. There are some some test scripts in ./test_scripts that run some more complex scenarios using the example programs. The test script tree1 builds a small mesh and shows how publications sent to any node in the mesh get forwarded to the matching subscribers. The script reg1 uses the registry, reg_pubs, and reg_subs examples programs to build a dynamic mesh using the experimental discovery service.