Skip to content

Latest commit

 

History

History
109 lines (79 loc) · 3.93 KB

README.md

File metadata and controls

109 lines (79 loc) · 3.93 KB
Raw

Open IoT Service Platform (OISP)

This project is designed to provide Cloud Service Providers with a platform for enabling and supporting IoT developers to create IoT solutions with both edge devices and the cloud.

The platform provides developers with an end-to-end solution for streaming telemetry data to the cloud, applying rules (using the rules engine) to this data, triggering actuations whilst also providing an interface for the platform to communicate with your own cloud services.

Key features:

  • Easy to use and deploy IoT agent
  • Inbuilt dashboard to create rules, graphs and catalog items
  • Full RESTful JSON API supported
  • Realtime actuations (cloud -> IoT device)

Getting started with OISP

The platform consists of multiple components (services) each designed and optimised for a specific usecase. For example, the rules engine (built on top of Gearpump) runs seperately to the rest of the system and ingests telemetry data from a Kafka queue.

To get platform running quickly we recommened using Docker. First ensure you have the latest version of Docker installed on your computer.

Cloning OISP platform launcher

$ git clone https://github.com/Open-IoT-Service-Platform/platform-launcher.git

Starting from scratch

Precondtion for building is to have the following installed

  • Docker and Docker-Compose
  • Git
  • Make
  • Kafkacat

As an example for Ubuntu 16.04, we have created a shell script to install all the dependencies.

$ cd platform-launcher
$ sh ./platform-setup/setup-ubuntu16.04.sh

Creating and launching OISP

Make sure you are either on master branch or using a pre-release tag.

$ cd platform-launcher
$ cp setup-environment.example.sh setup-environment.sh

Now modify the setup-environment.sh shell script with parameters valid for your needs. For example the SMTP settings require you to have an SMTP server.

To build all the images,run:

$ make

Starting application using Docker

Now that all the images are built, we can create (if not already) and start all the neccessary containers:

$ make start

Note: If your environment requries a proxy. Ensure you have set the http_proxy and https_proxy enviornment variables before running the script above.

Once all the containers have been built and are running, you can access the application in your browser by visiting: http://localhost

Other make commands

Stop OISP

The following command will stop all the Open IoT Connector containers:

$ make stop

Update (including submodules) the project - Development only

The following command will pull latest changes to the Open IoT Connector and the latest changes from the submodules:

$ make update

Destroy OISP (including data)

The following command will stop and remove the containers, keys, databases, but preserves the images:

$ make distclean

The project has been structured using Git submodules according to recommendations made here: https://www.philosophicalhacker.com/post/using-git-submodules-effectively/

Please check out our Wiki for more details.

Development

Development Process

Community contributions are welcome! All PRs have to be applied to the develop branches in the platform-launcher repository or the sub repositories. At least one review and approval of a project admin is needed to merge it in. Before submitting a PRs make sure that you checked out the most recent develop state. The master branches are only getting PRs from the respective develop branches.

How to checkout and build most recent development state from scratch

Assumptions:

  • No Docker Containers, i.e. docker ps -a is empty
  • No Docker Images, i.e. docker images is empty
$ git clone https://github.com/Open-IoT-Service-Platform/platform-launcher.git
$ cd platform-launcher
$ git checkout develop
$ make update
$ make