Home

Awesome

<!-- ~ Licensed to the Apache Software Foundation (ASF) under one or more ~ contributor license agreements. See the NOTICE file distributed with ~ this work for additional information regarding copyright ownership. ~ The ASF licenses this file to You under the Apache License, Version 2.0 ~ (the "License"); you may not use this file except in compliance with ~ the License. You may obtain a copy of the License at ~ ~ http://www.apache.org/licenses/LICENSE-2.0 ~ ~ Unless required by applicable law or agreed to in writing, software ~ distributed under the License is distributed on an "AS IS" BASIS, ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. ~ See the License for the specific language governing permissions and ~ limitations under the License. ~ -->

Github Actions Docker pulls Maven central License Last commit Apache StreamPipes Contributors GitHub commit activity GitHub issues by-label <br> LinkedIn Twitter

<h1 align="center"> <br> <img src="https://streampipes.apache.org/img/sp-logo-color.png" alt="StreamPipes Logo" title="Apache StreamPipes Logo" width="50%"/> <br> </h1> <h3 align="center">Self-Service Data Analytics for the (Industrial) IoT</h3> <h4 align="center">StreamPipes is a self-service (Industrial) IoT toolbox to enable non-technical users to connect , analyze and explore IoT data streams. </h4> <p align="center"> <img src="https://raw.githubusercontent.com/apache/streampipes/dev/images/streampipes-overview.png" alt="StreamPipes Overview"/> </p>

Table of contents


About Apache StreamPipes

Apache StreamPipes makes industrial data analytics easy!

StreamPipes is an end-to-end toolbox for the industrial IoT. It comes with a rich graphical user interface targeted at non-technical users and provides the following features:

StreamPipes is highly extensible and includes a Java SDK to create new pipeline elements and adapters. Python support is available in an early development stage - stay tuned!
Pipeline elements are standalone microservices that can run anywhere - centrally on your server or close at the edge. You want to employ your own machine learning model on live data? Just write your own data processor and make it reusable as a pipeline element.

Besides that, StreamPipes includes features for production deployments:

User interface

StreamPipes Connect

StreamPipes Pipeline Editor

StreamPipes Data Explorer

Installation

The quickest way to run StreamPipes including the latest extensions (adapters, pipeline elements) is by using our Docker-based installation & operation options, namely:

[!IMPORTANT] StreamPipes CLI & k8s are highly recommended for developers or operators. Standard users should stick to StreamPipes Compose.

Please follow the instructions provided in the corresponding README.md to get started.

For a more in-depth manual, read the installation guide.

[!NOTE] TL;DR: Download the latest release, switch to the installer/compose directory and run docker-compose up -d.

Documentation

The full documentation is available here.

Quick Links:

Building StreamPipes

To properly build the StreamPipes core, the following tools should be installed:

Prerequisites

Building

To build the core project, do the following:

    mvn clean package

To build the ui, switch to the ui folder and perform the following steps:

    npm install
    npm run build

Starting

To start StreamPipes, run docker-compose up --build -d from the root directory.

You can also use the installer or CLI as described in the Installation section.

Pipeline Elements

StreamPipes includes a repository of extensions for adapters and pipeline elements:

The source code of all included pipeline elements and adapters can be found here.

Extending StreamPipes

You can easily add your own data streams, processors or sinks. A Java-based SDK can be used to integrate your existing processing logic into StreamPipes. Pipeline elements are packaged as Docker images and can be installed at runtime, whenever your requirements change.

šŸ‘‰ Check our developer guide.

Bugs and Feature Requests

If you've found a bug or have a feature that you'd love to see in StreamPipes, feel free to create an issue on GitHub:

šŸ‘‰ Bugs šŸ‘‰ Feature requests

Get help

If you have any problems during the installation or questions around StreamPipes, you'll get help through one of our community channels:

šŸ‘‰ Mailing Lists

Or directly subscribe to users-subscribe@streampipes.apache.org!

šŸ‘‰ And don't forget to follow us on Twitter!

Contribute

We welcome all kinds of contributions to StreamPipes. If you are interested in contributing, let us know! You'll get to know an open-minded and motivated team working together to build the next IIoT analytics toolbox.

Here are some first steps in case you want to contribute:

Have fun!

Feedback

We'd love to hear your feedback! Subscribe to users@streampipes.apache.org

License

Apache License 2.0