kerberos-io/documentation
1
0
Fork 0
mirror of https://github.com/kerberos-io/documentation.git synced 2026-08-23 15:18:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

release v1.1.0

Browse Source
This commit is contained in:
Cédric Verstraeten
2015-09-13 21:47:51 +02:00
parent 24693a0ff6
commit 2bf6c0b442
16 changed files with 172 additions and 56 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
1_getting_started.md
View File

@@ -31,4 +31,4 @@ Kerberos is **easy to install**, you just have to copy the kerberos image to you
<a name="contribute"></a>
## Contribute
Want to contribute? You're a front end designer, user experience guru, an ambitious programmer, or a Ph.D. in Computer Vision 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 are very important!
Want to contribute? You're a front end designer, user experience guru, an ambitious programmer, or a Ph.D. in Computer Vision 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 are very important!

14
3_installation.md
View File

@@ -20,7 +20,7 @@ Kerberos is **easy to install**, you just have to copy the Kerberos image to you
If you want to use Kerberos.io **as a service**, this would be the preferred way. Kerberos is provided as an image, a pre-installed operating system. The only thing you have to do to make things work, is to transfer the image to your SD card. After transferring you can just plug the SD card into your Raspberry Pi and kerberos will work; isn't that great!
<a name="download-the-image"></a>
### 1. Download the image
### 1. Download the image (v1.1.0)
First you will need to download the Kerberos image; click on the image below. The Kerberos.io image contains a Linux operating system, built on Arch Linux. The image has the machinery and webinterface installed, and ofcourse all the dependencies Kerberos needs. With this image you just have to plugin the SD card in your Raspberry Pi and you're done.
@@ -28,11 +28,11 @@ First you will need to download the Kerberos image; click on the image below. Th
The Raspberry Pi 2 is the successor to the Raspberry Pi. It builds upon the original model B+ upgrading to 1 GB of RAM, and replacing the aged ARMv6l single-core with an ARMv7l Cortex-A7 quad-core.
[![Kerberos.io image](3_kerberos-image.png)](https://drive.google.com/open?id=0B-2b4NYY_1xuUmxxOURISjQweGc)
[![Kerberos.io image](3_kerberos-image.png)](https://drive.google.com/open?id=0B-2b4NYY_1xuODZ6eEE2bXN5eXM)
Checksum
c1234d6cc3df8f81510b36cd1589e2c5
10557f21beacbceaee172bd20e420e3e
**Please note** that the image is compressed, (on Linux/OSX) open your terminal and use the "7zip" command to decompress.
@@ -48,11 +48,11 @@ Linux
The Raspberry Pi is a credit-card sized computer that plugs into your TV and a keyboard. It’s a capable little PC which can be used for many of the things that your desktop PC does, like spreadsheets, word-processing and games. It also plays high-definition video.
[![Kerberos.io image](3_kerberos-image.png)](https://drive.google.com/open?id=0B-2b4NYY_1xuMWpLcU8zWjl2cTg)
[![Kerberos.io image](3_kerberos-image.png)](https://drive.google.com/open?id=0B-2b4NYY_1xuRkZNa19Gam5BMjg)
Checksum
689343d72bcfae8a6b13f86b0d9c3075
2b67a4ca6af0cdde39f4a428047da607
**Please note** that the image is compressed, (on Linux/OSX) open your terminal and use the "7zip" command to decompress.
@@ -63,7 +63,7 @@ OSX
Linux
7z e from/kerberos-io-armv6-4GB-..
<a name="insert-your-sd-card"></a>
### 2. Insert your SD Card
@@ -116,7 +116,7 @@ To format the SD card, enter the following command:
In Terminal, enter the following command ensuring that you identify the correct destination disc.
sudo dd if=~/Desktop/kerberos-io.img of=/dev/disk3
sudo dd if=~kerberos-io.img of=/dev/disk3
<a name="transfer-image-with-terminal-linux"></a>
### 3. Linux: transfer image with terminal

2
41_machinery/2_installation.md
View File

@@ -20,7 +20,7 @@ Update the ArchLinux kernel
Install git, subversion, development tools (c++, cmake) and V4L utils.
pacman -S git subversion cmake base-devel v4l-utils eigen
pacman -S git subversion cmake base-devel v4l-utils eigen ffmpeg curl
Go to home directory

6
41_machinery/5_capture.md
View File

@@ -1,6 +1,7 @@
# Capture
* [USB camera](#usb-camera)
* [IP camera](#ip-camera)
* [Raspberry Pi Camera Module](#raspberry-pi-camera-module)
The capture device is responsible to take images. The images are used in the four pass way.
@@ -10,6 +11,11 @@ The capture device is responsible to take images. The images are used in the fou
Kerberos supports a whole range of USB cameras. You will find a complete list [here](https://web.archive.org/web/20120815172655/http://opencv.willowgarage.com/wiki/Welcome/OS/). Make sure that you've updated the settings page on the web interface, that you will be using an USB camera.
<a name="ip-camera"></a>
## IP camera
Kerberos can be used with any IP camera, that provides a streaming URL. Make sure that you know the correct URL of your IP camera, you can find [a list here](http://www.ispyconnect.com/sources.aspx). Make sure you have updated the web interface, to make Kerberos aware you will be using an IP camera.
<a name="raspberry-pi-camera-module"></a>
## Raspberry Pi Camera Module

12
41_machinery/70_captures/1_USB_camera.md
View File

@@ -15,10 +15,20 @@ The parameters of the USB capture device can be found in the *config/capture.xml
<USBCamera>
<frameWidth type="number">1280</frameWidth>
<frameHeight type="number">720</frameHeight>
<delay type="number">0</delay>
<angle type="number">0</angle>
</USBCamera>
</captures>
### Framewidth and -height
You can set the resolution of the capture device, make sure the resolution you've defined is valid with your camera. Please check the specs of the USB camera you're using.
You can set the resolution of the capture device, make sure the resolution you've defined is valid with your camera. Please check the specs of the USB camera you're using.
### Delay
You can provide a delay/interval (milliseconds) between two captures.
### Angle
By defining an angle (degrees), you can rotate the images taken by the capture device. For example if you would mount the camera upside down, than you could enter the value 180 as the angle; this will flip the images.

39
41_machinery/70_captures/2_IP_camera.md Normal file
View File

@@ -0,0 +1,39 @@
# IP Camera
Kerberos can be used with any IP camera, that provides a MJPEG stream. Make sure that you know the correct URL of your IP camera, you can find [a list here](http://www.ispyconnect.com/sources.aspx). Make sure you have updated the web interface, to make Kerberos aware you will be using an IP camera.
## Web interface
![IP camera](2_ip-camera.png)
## Parameters
The parameters of the IP capture device can be found in the *config/capture.xml* file, but you can also use the web interface to modify the parameters. Below you see a default configuration file.
<captures>
<IPCamera>
<url type="text">http://username:password@ipaddress/image.jpg</url>
<frameWidth type="number">800</frameWidth>
<frameHeight type="number">640</frameHeight>
<delay type="number">0</delay>
<angle type="number">0</angle>
</IPCamera>
</captures>
### URL
To use your IP camera, you should provide a valid MJPEG URL. Kerberos will take snapshots from this stream.
### Framewidth and -height
You can set the resolution of the capture device, make sure the resolution you've defined is equal to the resolution you've defined in your IP camera software.
### Delay
You can provide a delay/interval (milliseconds) between two captures.
### Angle
By defining an angle (degrees), you can rotate the images taken by the capture device. For example if you would mount the camera upside down, than you could enter the value 180 as the angle; this will flip the images.

32
41_machinery/70_captures/2_Raspberry_camera.md
View File

@@ -1,32 +0,0 @@
# Raspberry Camera
You can use the Raspberry Pi Camera Module with Kerberos. You just need to attach the camera module and you're ready to go. The Raspberry Pi Camera Module is enabled by default in the web interface.
## Web interface
![Raspberry PI Camera Module](2_raspi-camera.png)
## Parameters
The parameters of the Raspberry Pi Camera Module can be found in the *config/capture.xml* file, but you can also use the web interface to modify the parameters. Below you see a default configuration file.
<captures>
<RaspiCamera>
<frameWidth type="number">800</frameWidth>
<frameHeight type="number">640</frameHeight>
<night type="number">60</night>
<day type="number">150</day>
</RaspiCamera>
</captures>
### Framewidth and -height
You can set the resolution of the camera module, make sure the resolution you've defined is valid.
### Night and day
The Raspberry Pi Camera module has additional parameters. Thanks to the MMAL library we can change the configuration of the Raspberry Pi Camera Module. The night and day parameters are gray thresholds. The night parameter defines the lower gray value/threshold; if the brightness of the image taken by the camera module will be lower than the night value, it will switch to night mode. Similar, if the brightness is higher than the day value, it will switch to day mode.
Notice that there is a kind of gray zone. If the brightness of the image is within those range, no reconfiguration will happen. This feature will be more advanced in future.

BIN
41_machinery/70_captures/2_ip-camera.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 20 KiB

34
41_machinery/70_captures/3_Raspberry_camera.md Normal file
View File

@@ -0,0 +1,34 @@
# Raspberry Camera
You can use the Raspberry Pi Camera Module with Kerberos. You just need to attach the camera module and you're ready to go. The Raspberry Pi Camera Module is enabled by default in the web interface.
## Web interface
![Raspberry PI Camera Module](3_raspi-camera.png)
## Parameters
The parameters of the Raspberry Pi Camera Module can be found in the *config/capture.xml* file, but you can also use the web interface to modify the parameters. Below you see a default configuration file.
<captures>
<RaspiCamera>
<frameWidth type="number">800</frameWidth>
<frameHeight type="number">640</frameHeight>
<delay type="number">0</delay>
<angle type="number">0</angle>
</RaspiCamera>
</captures>
### Framewidth and -height
You can set the resolution of the camera module, make sure the resolution you've defined is valid.
### Delay
You can provide a delay/interval (milliseconds) between two captures.
### Angle
By defining an angle (degrees), you can rotate the images taken by the capture device. For example if you would mount the camera upside down, than you could enter the value 180 as the angle; this will flip the images.

0
41_machinery/70_captures/2_raspi-camera.png → 41_machinery/70_captures/3_raspi-camera.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

25
41_machinery/84_Outputs/4_webhook.md Normal file
View File

@@ -0,0 +1,25 @@
# Webhook
Detailed information (a JSON object) is send as a POST request to a webhook. The JSON object contains the number of changes, the region, the URL of the image, etc.
**Make sure that the Webhook comes after the Disk device, otherwise the URL of the image is not included.**
## Web interface
![Webhook io](4_webhook.png)
## Parameters
The parameters of the webhook can be found in the config/io.xml file, but you can also use the web interface to modify the parameters. Below you see a default configuration file.
<ios>
<Webhook>
<url type="text">http://kerberos.web/api/v1/webhook</url>
</Webhook>
</ios>
### Url
This is the URL, to which Kerberos will send a JSON object (as a POST request).

BIN
41_machinery/84_Outputs/4_webhook.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 13 KiB

7
41_machinery/91_output.md
View File

@@ -3,6 +3,7 @@
* [Image](#image)
* [GPIO](#gpio)
* [TCP/IP client](#tcp-ip-client)
* [Webhook](#webhook)
If the heuristic determined that the evaluation was valid, one or more IO operations can be executed. You configure which IO operations that will be executed, by modifying the configuration file or using the web interface.
@@ -16,4 +17,8 @@ You can trigger a specific GPIO pin on the Raspberry Pi.
<a name="tcp-ip-client"></a>
## TCP/IP client
The TCP/IP client will send a TCP packet to a server.
The TCP/IP client will send a TCP packet to a server.
<a name="webhook"></a>
## Webhook
Detailed information (a JSON object) is send as a POST request to a webhook. The JSON object contains the number of changes, the region, the URL of the image, etc.

10
42_addons/2_Cloud.md
View File

@@ -20,20 +20,20 @@ The cloud application is attached to the production bucket, so only images that
If you installed Kerberos from the image, you don't need to follow this tutorial as the service is installed natively.
cd /home
cd /home
Create a new directory
mkdir cloud && cd cloud
mkdir cloud && cd cloud
Checkout sync repository
git clone https://github.com/kerberos-io/sync-s3 .
git clone https://github.com/kerberos-io/sync-s3 .
Install node plugins
npm install
npm install -g grunt-cli
npm install
npm install -g grunt-cli
npm install -g forever
## Auto-start grunt

23
4_release_notes.md
View File

@@ -1,10 +1,33 @@
# Release notes
* [1.1.0](#1-1-0)
* [1.0.3](#1-0-3)
* [1.0.2](#1-0-2)
* [1.0.1](#1-0-1)
* [1.0.0](#1-0-0)
<a name="1-1-0"></a>
## 1.1.0
#### Web
* Support IP camera's with MJPEG stream. [#3](https://github.com/kerberos-io/web/issues/3)
* Introduce new API methods to configure the machinery, using basic auth. [#4](https://github.com/kerberos-io/web/issues/4)
* Optimization of loading image and dashboard page, completely redesigned the retrieval of images. [#5](https://github.com/kerberos-io/web/issues/5)
* Optimization of settings page. [#5](https://github.com/kerberos-io/web/issues/5)
* Timebar gradient only works in Chrome. [#6](https://github.com/kerberos-io/web/issues/6)
* Minor CSS fixes for responsive layout.
#### Machinery
* Flip/rotate option for capture devices. [#5](https://github.com/kerberos-io/machinery/issues/1)
* Support IP camera's with MJPEG stream. [#4](https://github.com/kerberos-io/machinery/issues/4)
* Introduced webhook io device. [#5](https://github.com/kerberos-io/machinery/issues/5)
#### Cloud
* Fixed problem when syncing a huge amount of images. [#1](https://github.com/kerberos-io/sync-s3/issues/1)
<a name="1-0-3"></a>
## 1.0.3

22
5_FAQ.md
View File

@@ -281,22 +281,28 @@ You can backup your SD card, by typing following command in your terminal. This
When kerberos is installed with the image, you can edit the wireless.conf file on the SD card. Insert the SD card in your workstation and open the file **wireless.conf**. You will see a similar config like below, edit the ESSID property with the name of your WIFI connection and the property Key with the WIFI password. **Don't forget to match the Address and Gateway fields, with your internal network**.
Description='A simple WPA encrypted wireless connection'
Interface=wlan0
Connection=wireless
Security=wpa
ESSID='network-name'
Key='plain-text-password'
IP=static
Address='192.168.0.x/24'
##################
# WIFI credentials
Security=wpa
ESSID='YOUR-WIFI-SSID'
Key='YOUR-WIFI-PASSWORD'
#####################
# Static IP address
# (Don't forget to add the subnet at the end of the Address e.g. /24)
Address='192.168.0.11/24'
Gateway='192.168.0.1'
DNS=('192.168.0.1')
IP=static
# Uncomment this if your ssid is hidden
#Hidden=yes
### Installed Kerberos.io from source
#### Archlinux
@@ -391,4 +397,4 @@ Start cronjob that will run this bash script
Add following line
*/10 * * * * /bin/sh /home/bash/run.sh
*/10 * * * * /bin/sh /home/bash/run.sh