Merge branch 'develop'

kerberos-io · Dec 31, 2019 · 1f3d156 · 1f3d156
2 parents 98c9ad6 + 3698e43
commit 1f3d156
Show file tree

Hide file tree

Showing 49 changed files with 93 additions and 113 deletions.
diff --git a/README.md b/README.md
@@ -1,102 +1,82 @@
-# KERBEROS.**IO**
+# Kerberos Open Source - Machinery
 
-[![Build Status](https://travis-ci.org/kerberos-io/machinery.svg)](https://travis-ci.org/kerberos-io/machinery) [![Stories in Ready](https://badge.waffle.io/kerberos-io/machinery.svg?label=ready&title=Ready)](https://waffle.io/kerberos-io/machin ) [![Join the chat](https://img.shields.io/gitter/room/TechnologyAdvice/Stardust.svg?style=flat)](https://gitter.im/kerberos-io/hades?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://travis-ci.org/kerberos-io/machinery.svg)](https://travis-ci.org/kerberos-io/machinery) [![Join the chat](https://img.shields.io/gitter/room/TechnologyAdvice/Stardust.svg?style=flat)](https://gitter.im/kerberos-io/hades?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 [![Kerberos.io - video surveillance](https://kerberos.io/images/kerberos.png)](https://kerberos.io)
 
-## CC-NC-ND license
+## License
 
-THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
+The Kerberos Open Source project is licensed with BY-NC-SA 4.0, this means that everyone can use Kerberos and modify if to their needs, in a non commercial activity.
 
-More information [**about this license**](https://doc.kerberos.io/2.0/license).
+More information [**about this license**](https://doc.kerberos.io/opensource/license).
 
 ## Vote for features
 
-[**Report features**](https://feathub.com/kerberos-io/machinery) if you think something is missing, and should be added to Kerberos.io, we love to hear about your ideas.
+[**Report features**](https://feathub.com/kerberos-io/machinery) if you think something is missing, and should be added to Kerberos Open Source, we love to hear about your ideas.
 
 ## Supported cameras
 
 [**In this thread**](https://github.com/kerberos-io/machinery/issues/136) you can find a list of cameras that users confirmed working properly. Do you have a working camera missing from this list? Report your camera [**here**](https://github.com/kerberos-io/machinery/issues/136).
 
-## Why Kerberos.io?
+## Why Kerberos?
 
 As burglary is very common, we believe that video surveillance is a **trivial tool** in our daily lifes which helps us to **feel** a little bit more **secure**. Responding to this need, a lot of companies have started developing their own video surveillance software in the past few years.
 
-Nowadays we have a myriad of **expensive** cameras, recorders, and software solutions which are mainly **outdated** and **difficult** to install and use. Kerberos.io's goal is to solve these problems and to provide every human being in this world to have their own **ecological**, **affordable**, **easy-to-use** and **innovative** surveillance solution.
+Nowadays we have a myriad of **expensive** cameras, recorders, and software solutions which are mainly **outdated** and **difficult** to install and use. Kerberos Open Source goal is to solve these problems and to provide every human being in this world to have their own **ecological**, **affordable**, **easy-to-use** and **innovative** surveillance solution.
 
 ## Introduction
 
-[Kerberos.io](https://kerberos.io) is a **low-budget** video surveillance solution, that uses computer vision algorithms to detect changes, and that can trigger other devices. [Kerberos.io](https://kerberos.io) is open source so everyone can customize the source code to their needs and share it with the community under the [**CC-NC-ND license model**](https://doc.kerberos.io/license). When deployed on the Raspberry Pi, it has a **green footprint** and it's **easy to install**; you only need to transfer the [Kerberos.io OS (KIOS)](https://doc.kerberos.io/2.0/installation/KiOS) to your SD card and that's it.
+Kerberos Open Source is perfect for personal usage. It's great if you only have a couple of surveillance cameras to be managed. A Kerberos agent (e.g. on a Raspberry Pi or inside a Docker container) runs for each camera. Their are many different installation possibilities, please have a look at [**the architecture**](https://doc.kerberos.io/architectures) or [**installation page**](https://doc.kerberos.io/opensource/installation).
 
-Use your mobile phone, tablet or PC to keep an eye on your property. View the images taken by [Kerberos.io](https://kerberos.io) with our responsive and user-friendly web interface. Look at the dashboard to get a graphical overview of the past days. Multiple [Kerberos.io](https://kerberos.io) instances can be installed and can be viewed with only 1 web interface.
+Every Kerberos agent has it's own web interface (front-end) to review media recording, and processing engine (back-end) of a specific surveillance camera. The Open Source version doesn't come with a central overview of all recordings generated by your Kerberos agents. For this feature we highly recommend Kerberos cloud.
 
-## Machinery
-
-The machinery is responsible for the processing. It's **an image processing framework** which takes images from the type of camera (USB-, IP- or RPi-camera) you've configured in the configuration files and executes one or more algorithms and post-processes (e.g. save a snapshot). The configuration files allow you to define the type of camera, post-processes, conditions and much more; it's **highly configurable**. It's important to note that the machinery, out-of-the-box, can handle only one camera at a time; more information can be found on the [documentation website](https://doc.kerberos.io).
+If you want to manage more than 10 Kerberos agents, it's recommended to use [**Kerberos Enterprise**](https://doc.kerberos.io/enterprise). This will help you to scale, support high availability and load balancing. Check out [**the architecture**](https://doc.kerberos.io/architectures) section for a better understanding of when to use what.
 
-Developers can easily add new:
+## Machinery
 
-- Algorithms to detect motion, by using the OpenCV library.
-- Create new heuristics to validate if detection was real.
-- Integrate support for other output devices (a NOSQL database, E-mail, GPIO, TCP server and other notification services)
+[**The machinery**](https://doc.kerberos.io/opensource/introduction) is the processing engine of Kerberos Open Source. It's an image processing framework, written in C++, who benefits from other third party libraries (OpenCV, etc). It takes images from the type of camera (USB-, IP- or RPi-camera) you've configured in the configuration files and executes one ore more algorithms and post-processes (e.g. save a snapshot). The configuration files allow you to define the type of camera, post-processes, conditions and much more; it's highly configurable. It's important to note that the machinery, out-of-the-box, can handle only one camera at a time.
 
 ## How does it work?
 
-The machinery is an **image processing framework** which is devided into four steps:
-
-* condition
-* algorithm
-* expositor
-* heuristic
-
-The steps belong to a four passway; illustrated on the image below. In each cycle a sequence of images is processed. Each step will process the sequence, and will return some result to the next step. Please check out the [demo environment](https//doc.kerberos.io) if you want to see a real life example.
-
-[Read more](https://doc.kerberos.io/2.0/machinery/introduction)
+[Read more](https://doc.kerberos.io/opensource/machinery#project-structure) on our documentation website to have a better understanding of how the machinery works.
 
 ## Installation
 
-The reason why you're reading this paragraph is because you want to know how to install the machinery on your Raspberry Pi, local working station, server or whatever machine you prefer. The good news is that we have **different approaches** from basic to advanced; it depends on how you want to install it.
-
-### KiOS (for Raspberry Pi)
-
-[KiOS](https://github.com/kerberos-io/kios) is a custom linux OS (created by buildroot) which runs Kerberos.io out-of-the-box (it contains both the machinery and the web). KiOS is **installed like every other OS** for the Raspberry Pi, you need to flash the OS (.img) to a SD card, update your network configuration and you're up and running; no manual compilation or horrible configurations. This is the **most simple** and **basic** installation procedure.
-
-[Read more](https://doc.kerberos.io/2.0/installation/KiOS)
-
-### Raspbian (for Raspberry Pi)
-
-If you already have a Raspberry Pi running with Raspbian, you probably don't want to reflash your SD-card. Therefore you can install the different parts of Kerberos.io (the machinery and the web) manual.
-
-[Read more](https://doc.kerberos.io/2.0/installation/Raspbian)
-
-### Armbian (for Orange Pi, PCDuino, etc)
-
-Kerberos.io can also be installed on other boards, which run the Armbian OS. 
-
-[Read more](https://doc.kerberos.io/2.0/installation/Armbian)
-
-### Docker (for x86, AMD64, ARMv7, ARMv8)
-
-Kerberos.io can also be installed as a Docker container.
-
-[Read more](https://doc.kerberos.io/2.0/installation/Docker)
+Kerberos Open Source comes with different installation flavours (it includes both the machinery and web repository). The reason is because depending on the use case one option is better than another. A short list of recommendations:
 
-### Generic
+- [**KiOS**](https://doc.kerberos.io/opensource/installation): You have a Raspberry Pi, and you only want to run a Kerberos agent on it.
+- [**Raspbian**](https://doc.kerberos.io/opensource/installation): You have a Raspberry Pi, but you want other services running next to the Kerberos agent.
+- [**Docker**](https://doc.kerberos.io/opensource/installation): You have a lot of IP cameras, and/or don't want to mess with dependencies.
+- [**Generic**](https://doc.kerberos.io/opensource/installation): You want to develop/extend Kerberos with your own features, or you want to run a Kerberos agent on a not supported OS/architecure.
 
-If you want to install the machinery on your working station, than you'll need to compile the source code yourself; it's a little bit more work.
+## Compile from source
 
-[Read more](https://doc.kerberos.io/2.0/installation/Generic)
+Update the packages and kernel, and install some development tools.
 
-## Configure
+```ts
+sudo apt-get update && sudo apt-get upgrade
+sudo apt-get install git cmake subversion libav-tools dh-autoreconf libcurl4-openssl-dev yasm libx264-dev pkg-config libssl-dev
+```
 
-The configuration files can be found at **/etc/opt/kerberosio/config**. By default the Raspberry Pi Camera module is set as capture device. You can update the **config.xml** file to change it to **USBCamera** or **IPCamera**. Images are stored in the **/etc/opt/kerberosio/capture** directory; this location can be changed by editing the **io.xml** file.
+Install the FFmpeg library with x264 support.
 
-## Run
+```ts
+git clone https://github.com/FFmpeg/FFmpeg ffmpeg
+cd ffmpeg && git checkout remotes/origin/release/2.8
+./configure --enable-gpl --enable-libx264 --enable-shared --prefix=/usr/local
+make && sudo make install
+```
 
-After kerberos is installed a binary is available at **/usr/bin/kerberosio**. Just run following command in your terminal to start kerberosio.
+Go to your home directory, or any place your prefer and pull the machinery from Github. Afterwards create a build directory and start the compilation.
 
-    kerberosio
+```ts
+cd && git clone https://github.com/kerberos-io/machinery
+cd machinery && mkdir build && cd build
+cmake .. && make && make check && sudo make install
+```
 
-## Contribute
+After the machinery is build and installed succesfully, you can enable `kerberosio` to start on boot.
 
-Want to contribute? You're a Ph.D. in Computer Vision, or an ambitious programmer who wants to take kerberos.io to the next level? Then we like to welcome you to the community. Contributions are taken very seriously, besides your code, testing and documentation is very very ... very important! We only will accept pull-request with tests and documentation of a decent level and of course if everything works as expected. 
+```ts
+sudo systemctl enable kerberosio
+```
diff --git a/exceptions/Exception.h b/exceptions/Exception.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license.
 //

diff --git a/exceptions/Exception.hpp b/exceptions/Exception.hpp
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/exceptions/KerberosException.h b/exceptions/KerberosException.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/exceptions/OpenCVException.h b/exceptions/OpenCVException.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/exceptions/SocketException.h b/exceptions/SocketException.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/exceptions/TinyXMLException.h b/exceptions/TinyXMLException.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/Factory.h b/include/kerberos/Factory.h
@@ -10,7 +10,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/Globals.h b/include/kerberos/Globals.h
@@ -8,7 +8,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //
@@ -17,7 +17,7 @@
 #ifndef __Version_H_INCLUDED__   // if Version.h hasn't been included yet...
 #define __Version_H_INCLUDED__   // #define this so the compiler knows it has been included
 
-    #define VERSION "2.6.2"
+    #define VERSION "2.8.0"
     #define HADES "https://hades.kerberos.io"
     #define CLOUD "https://cloud.kerberos.io"
     #define SYMBOL_DIRECTORY "/etc/opt/kerberosio/symbols/"

diff --git a/include/kerberos/Helper.h b/include/kerberos/Helper.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/Kerberos.h b/include/kerberos/Kerberos.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/System.h b/include/kerberos/System.h
@@ -10,7 +10,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/Types.h b/include/kerberos/Types.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/capture/Capture.h b/include/kerberos/capture/Capture.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/capture/IPCamera.h b/include/kerberos/capture/IPCamera.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/capture/Image.h b/include/kerberos/capture/Image.h
@@ -8,7 +8,7 @@
 //
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium. 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/capture/RaspiCamera.h b/include/kerberos/capture/RaspiCamera.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/capture/Stream.h b/include/kerberos/capture/Stream.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/capture/USBCamera.h b/include/kerberos/capture/USBCamera.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/capture/VideoCapture.h b/include/kerberos/capture/VideoCapture.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/cloud/Cloud.h b/include/kerberos/cloud/Cloud.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/cloud/ForwardStream.h b/include/kerberos/cloud/ForwardStream.h
@@ -10,7 +10,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/cloud/GoogleDrive.h b/include/kerberos/cloud/GoogleDrive.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/cloud/S3.h b/include/kerberos/cloud/S3.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/machinery/Machinery.h b/include/kerberos/machinery/Machinery.h
@@ -2,14 +2,14 @@
 //  Class: Machinery.h
 //  Description: The kerberos controller.
 //  Created:     17/07/2014
-//  Author:      Cédric Verstraeten
+//  Author:      C�dric Verstraeten
 //  Mail:        cedric@verstraeten.io
 //  Website:     www.verstraeten.io
 //
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/machinery/algorithm/Algorithm.h b/include/kerberos/machinery/algorithm/Algorithm.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //

diff --git a/include/kerberos/machinery/algorithm/BackgroundSubtraction.h b/include/kerberos/machinery/algorithm/BackgroundSubtraction.h
@@ -9,7 +9,7 @@
 //  The copyright to the computer program(s) herein
 //  is the property of Verstraeten.io, Belgium.
 //  The program(s) may be used and/or copied under 
-//  the CC-NC-ND license model.
+//  the BY-NC-SA 4.0 license model.
 //
 //  https://doc.kerberos.io/license
 //