Deutsch (English below)
=======================

Anleitung zum aufspielen und starten von HALCON/HPEEK auf einem PHYTEC i.MX6 Board.
===================================================================================

Allgemein:
Diese Anleitung zeigt ihnen folgende Möglichkeiten mit HALCON/HPEEK zu arbeiten.
A) Verwendung der HPEEK Demoversion von Halcon (kein Dongle/Lizenz erforderlich)
B) Verwendung von HPEEK zum starten von hdev-Programmen und den phyCAM-Kamerademos (Dongle/Lizenz erforderlich) 

--------------------------------------------

Schritte:
1) BSP mit Window-Manager X11 compilieren (alternativ kann ein vorcompilierte Image verwendet werden, in diesem Fall kann bei Schritt 5 begonnen werden)
2) BSP auf SD-CARD aufspielen und starten
3) Speicher auf SD CARD anpassen 
4) HPEEK/HALCON installation 
5) HPEEK Demo starten
6) HPEEK/HALCON Demos mit phyCAM-Kameras starten


Voraussetzung:
- PD18.1.x, i.MX6 (phyBOARD Nunki, Mira oder phyFLEX)
- min. 1GB RAM
- SD-Card min. 2GB


Schritt 1)
==========
Damit Sie HALCON/HPEEK verwenden können, benötigen Sie einen Window Managers. Wir empfehlen einen X11 Server.
Entwicklungsumgebung entsprechend Quickstart einrichten und BSP zum compilieren vorbereiten.
Patches ("0001-recipe-images-Add-X11-to-vision-image", "0002-conf-distro-Add-yogurt-x11-distro") anwenden und BSP neu bauen:

A) BSP nach YOCTO Anleitung runterladen.

B) Vor dem ersten bauen mit bitbake die Patches apply'en in:
- cd sources/meta-yogurt
- git am <patch>

C) Weiterhin in der "conf/local.conf" folgenden Namen anpassen: 
- 'DISTRO ?= "yogurt"' ändern in 'DISTRO ?= "yogurt-x11"' 

D) Image bauen:
- bitbake phytec-vision-image


Schritt 2)
==========
Nachfolgend wird die Vorgehensweise mittels BSP auf SD-CARD beschrieben:
- Compilierte BSP (mit X11) auf SD-Card spielen (z.B. mit "Win32DiskImager")
- SD-Card einstecken und von SD booten (Bootjumperstellung abhängig von Plattform)
- Nachdem mittels "remove_qt_demo.sh" Qt abschaltet wurde erscheint das X11 Ausgabefenster
- Netzwerkverbindung herstellen


Schritt 3)
==========
Beim aufspielen des BSPs wird die SD-CARD üblicherweise nur mit der Größe des BSP formatiert.
Damit wir jedoch das HPEEK mit aufspielen können wird die volle Größe der SD-CARD benötigt. 
- Prüfen und einstellen der SD-CARD Größe.
  * Linux von SD-CARD booten und mittels "root" anmelden
  * <df> Speicher anzeigen lassen, dev/root soll verwendet werden und min. 2GB groß sein
  * <parted> eingeben
  * <print devices> eingeben
  Unter "/dev/mmcblk0" wird die eingestellte Speichergröße ausgegeben. 
  * <select /dev/mmcblk0> eingeben
  * <resizepart 2 2008MB>  (hier das Ende des Gesamtspeichers angeben, z.B 2GB)
  * <quit> parted verlassen
  * <resize2fs /dev/mmcblk0p2> neueinlesen des Speichers
  * <df> Speicher anzeigen lassen, dev/root sollte nun die neue Speichergröße haben


Schritt 4)
==========
- Eine aktuelle Version von HALCON/HPEEK finden Sie auf der Homepage der Firma MVTEC
https://www.mvtec.com/de/produkte/embedded-vision/
- Bevor Sie HALCON/HPEEK herunterladen können müssen Sie sich dort registrieren.

HPEEK/HALCON (mit und ohne Lizenz lauffähig):
- Wählen Sie Produkt->HALCON / Version->HPeek / Betriebssystem->Linux for ARM (32-Bit Version)
- Legen Sie auf dem phyCORE ein Verzeichnis ../usr/share/halcon an.
- Spielen Sie die "xxxarmv7a-linux-hpeek.tar.gz" Datei ins ../usr/share/halcon Verzeichnis (z.B. mittels WinSCP)
- Attribute setzen und auspacken:
  * chmod 755 halcon-19.05.0.0-armv7a-linux-hpeek.tar.gz
  * tar -xvf halcon-19.05.0.0-armv7a-linux-hpeek.tar.gz

extra
=====
- Bildschirmschoner X11 deaktivieren (Bei vorgefertigtem BSP schon enthalten)
 * Datei "X11_disable_screensaver.tar" in das Verzeichnis "/usr/share/X11/..." spielen.
 * chmod 755 X11_disable_screensaver.tar
 * tar -xvf X11_disable_screensaver.tar
 * neustart


Schritt 5)
==========
Voraussetzung:
	a) das von Ihnen erstellte X11 BSP mit HPEEK auf einer SD Karte
	b) oder Sie verwenden das bereitgestellte Image, welches Sie auf eine SD Karte spielen (z.B. mittels WinSCP)
- starten Sie das System und melden sich an ("root")
- wechsle ins Verzeichnis ../usr/share/halcon
- Setze die Umgebungsvariable fürs Display.
  * <export DISPLAY=:0.0>
- HPEEK starten
  * <./run_overview.sh>
  * <./run_deep_learning.sh>

HPEEK anpassen
- Anpassen Auflösung und Auswahl Demos:
/usr/share/halcon/examples/hpeek/config.txt öffnen

1) Auflösung des Bildschirms einstellen
WindowWidth     xxx (gewünschte Auflösung setzen)
WindowHeight    xxx (gewünschte Auflösung setzen)

2) demos an- und abwählen
setzen der Variablen, zB.:
  * show_intro 0 (intro aus)
  * show_intro 1 (intro an)


Schritt 6)
==========
Voraussetzung:
	a) das von Ihnen erstellte X11 BSP mit HPEEK/HALCON auf einer SD Karte
	b) oder Sie verwenden das bereitgestellte Image, welches Sie auf eine SD Karte spielen (z.B. mittels WinSCP)
	c) eine HALCON Lizenz/Dongle
- starten Sie das System und melden sich an ("root")
- spielen Sie ihre Lizenzdatei in den Pfad .../halcon/license/... und stecken den Dongle an.
- melden Sie die angeschlossenen Kamera an (siehe Dokument "phyCAM_with_xxx-iMX6_Getting_Started", 
  ftp://ftp.phytec.de/pub/ImageProcessing/<product-name>/Dokumentation/)
- Datei "halcon_examples.tar" in den Ordner ../usr/share/halcon/ spielen. (Bei vorgefertigtem BSP schon enthalten)
- Attribute setzen und auspacken:
  * chmod 755 halcon_examples.tar
  * tar -xvf halcon_examples.tar
- gehen Sie in das Verzeichnis ../usr/share/halcon/examples/phytec/
- Starten Sie die "start.sh"


Fehlersuche:
============
Sollte bei Ihnen der Fehler "Image acquisition: wrong port" erscheinen, so tauschen sie die "hAcqVideo4Linux2.so"
im Verzeichnis .../halcon/lid/armv7a-linux/... aus.


---------------------------------------------------------------------------------------------------------------------

English:
=======

How to install and start HALCON/HPEEK on a PHYTEC i.MX6 board.
==============================================================


General:
This tutorial shows you the following ways to work with HALCON/HPEEK.
A) Using the HPEEK demo version of Halcon (no dongle/license required)
B) Use of HPEEK for starting hdev-programs and phyCAM camera demos (dongle/license required)

--------------------------------------------


Steps:
1) Compile BSP with Window Manager X11 (if you want to use the precompiled image, you can start at step 5)
2) Move BSP to SD-CARD and start
3) Adjust memory to SD-CARD
4) HPEEK/HALCON installation
5) Start HPEEK demo
6) Start HPEEK/HALCON demos with phyCAM cameras


Requirements:
- PD18.1.x, i.MX6 (phyBOARD Nunki, Mira or phyFLEX)
- minimum. 1 GB RAM
- SD card min. 2 GB


Step 1)
=======
To use HPEEK, you need a Window Manager. We recommend an X11 server. Set up development environment according to the Quickstart and prepare the BSP for compilation.

Apply patches ("0001-recipe-images-Add-X11-to-vision-image", "0002-conf-distro-Add-yogurt-x11-distro") and rebuild BSP:

A) Download the BSP according to the YOCTO manual.

B) Before the first build with bitbake, apply the patches in:
- cd sources/meta-yogurt
- git am <patch>

C) Continue to customize the name in conf / local.conf: 
- 'DISTRO ?= "yogurt"' change in 'DISTRO ?= "yogurt-x11"' 

D) Built image:
- bitbake phytec-vision-image


Step 2)
=======
The procedure is described below using the BSP on SD-CARD:
- Transfer compiled BSP (with X11) on SD-Card (e.g with "Win32DiskImager") 
- plugin SD-Card and boot from SD-Card (Bootjumper depend on baseboard)
- Register camera (see document "phyCAM_with_xxx-iMX6_Getting_Started", ftp://ftp.phytec.de/pub/ImageProcessing/<product-name>/Dokumentation/)
- After Qt has been switched off with "remove_qt_demo.sh" the X11 output window appears
- Set up network connectivity


Step 3)
=======
When installing the BSP, the SD-CARD is usually formatted only with the size of the BSP.
However, in order for us to be able to play the HPEEK, the full size of the SD-CARD is needed.
- Check and setup the SD-CARD size.
   * Boot Linux from SD-CARD and log in using "root"
   * Enter <df> Show memory,  "dev/root" should be used and min. 2GB in size
   * Enter <parted>
   * Enter <print devices>
   The set memory size is output under "/dev/mmcblk0".
   * Enter <select / dev / mmcblk0>
   * Enter <resizepart 2 2008MB> (specify here the end of the total memory, for example 2GB)
   * Enter <quit>  leave program "parted"
   * Enter <resize2fs / dev / mmcblk0p2> re-reading the memory
   * Enter <df> Show memory, dev / root should now have the new memory size


Step 4)
=======
- A current version of HPEEK is located on the homepage of company MVTEC:
https://www.mvtec.com/de/produkte/embedded-vision/
- Before you can download HPEEK, you need to register there.
- Select Product-> HALCON / Version-> HPeek / Operating System-> Linux for ARM (32-Bit Version)
- Create a directory ../usr/share/halcon on the phyCORE.
- Play the "xxxarmv7a-linux-hpeek.tar.gz" file into the ../usr/share/halcon directory (e.g. via WinSCP)
- Set attributes and unpack:
  * chmod 755 halcon-19.05.0.0-armv7a-linux-hpeek.tar.gz
  * tar -xvf halcon-19.05.0.0-armv7a-linux-hpeek.tar.gz


extra
=====
- turn off screen saver X11
 * copy file "xorg.conf" in to path "/etc/X11/..."
 * chmod 755 xorg.conf 
 * restart


Step 5)
=======
Requirements:
	a) the self compiled image with X11 and HPEEK on a SD-Card
	b) or you have written the precompiled image from PHYTEC on SD-CARD (eg via WinSCP).
- turn on the system and authorized you ("root")
- change into path ../usr/share/halcon
- set the environment for display
  * <export DISPLAY=:0.0>
- start HPEEK
  * <./run_overview.sh>
  * <./run_deep_learning.sh>

Adapt HPEEK:
- adapt resolution and choise demos:
open /usr/share/halcon/examples/hpeek/config.txt

1) setup the resolution of display
WindowWidth     xxx (set desired resolution)
WindowHeight    xxx (set desired resolution)

2) choise the demos
set the variablen, e.g.:
  * show_intro 0 (intro off)
  * show_intro 1 (intro on)


Step 6)
=======
Requirements:
	a) the self compiled image with X11 and HPEEK on a SD-Card
	b) or you have written the precompiled image from PHYTEC on SD-CARD (eg via WinSCP).
	c) an HALCON Licence/Dongle
- turn on the system and authorized you ("root")
- copy licence file into .../halcon/license/... path and stick the dongle in
- set up the connected camera (see document "phyCAM_with_xxx-iMX6_Getting_Started", 
  ftp://ftp.phytec.de/pub/ImageProcessing/<product-name>/Dokumentation/)
- copy "halcon_examples.tar" into path ../usr/share/halcon/  (is include at the precompiled image)
- set attributes and unpack:
  * chmod 755 halcon_examples.tar
  * tar -xvf halcon_examples.tar
- change into path ../usr/share/halcon/examples/phytec/
- call "start.sh"



Troubleshooting:
================
If the error message "Image acquisition: wrong port" is present, please exchange the "hAcqVideo4Linux2.so"
in the path .../halcon/lid/armv7a-linux/....