---
title: "LumiScan Keryx auf einem PC"
description: "LumiScan Keryx unter Windows 11 und Ubuntu 24.04 - sein Broker, seine Adresse und Ports, automatischer Start, die Keryx-Seite, Dateien, Optionen und Umgebungsvariablen."
product: "LumiScan Keryx"
component: "lumiscan-keryx-de"
version: "1.0.0"
display_version: "1.0.0.7"
latest_version: true
language: "de"
url: "https://docs.hdvisionsystems.com/de/lumiscan-keryx-de/1.0.0/keryx.html"
---

# LumiScan Keryx auf einem PC

> [!NOTE]
> Auf ctrlX OS nutzen die Apps stattdessen den ctrlX Data Layer: siehe [ctrlX Data Layer auf ctrlX OS](https://docs.hdvisionsystems.com/de/lumiscan-keryx-de/1.0.0/ctrlx-data-layer.html).

**LumiScan Keryx** ist der Data Layer von HD Vision Systems für PCs. Er bietet dieselbe Schnittstelle wie der ctrlX Data Layer; der Name kommt vom griechischen *kēryx*, dem Herold.

Auf einem PC tauschen die LumiScan-Apps ihre Daten über LumiScan Keryx aus. Ein Programm, der **Broker**, verbindet sie: Jede App registriert dort ihre Knoten, und jeder Client - eine andere App, Cockpit, der OPC UA Connector, Ihr Programm - liest, schreibt und ruft über ihn auf.

## Der Broker {#broker}

|   |   |
| --- | --- |
| Programm | `krxsystem`, Teil von **LumiScan Keryx** |
| Standardadresse | `tcp://127.0.0.1:5555`. Der Broker verwendet außerdem den nächsten Port, 5556, für seine Benachrichtigungen |
| Erreichbar von | nur diesem PC (`127.0.0.1`): Der Broker hat keine Authentifizierung |
| Einer pro PC | Alle Apps einer Installation verwenden denselben Broker |

**Normalerweise starten Sie den Broker nicht selbst.** Wenn eine App startet und auf diesem PC kein Broker antwortet, startet sie `krxsystem` als separaten Prozess. Mehrere gleichzeitig gestartete Apps starten einen einzigen Broker. Der Broker läuft weiter, wenn die Apps enden, und die Apps starten ihn erneut, wenn er stoppt. Provider registrieren sich von selbst erneut und Abonnements werden von selbst erneuert, sobald der Broker antwortet.

Der erste Start dauert länger: Der Broker braucht einige Sekunden, bis er antwortet. Eine App, die in dieser Zeit startet, protokolliert, dass sie auf den Broker wartet, und verbindet sich, sobald er antwortet.

Der **OPC UA Connector** ist die Ausnahme: Er startet nie einen Broker. Starten Sie ihn nach den Apps, siehe [OPC UA Connector](https://docs.hdvisionsystems.com/de/lumiscan-keryx-de/1.0.0/opc-ua.html).

## Installation unter Windows {#installing}

1. Installieren Sie zuerst **LumiScan Keryx**, danach die Apps.
2. Führen Sie jedes Installationsprogramm als Administrator aus. Um dieselbe Version erneut zu installieren, deinstallieren Sie zuerst die alte: Ein Installationsprogramm akzeptiert nur eine höhere Version.
3. Öffnen Sie ein **neues** Terminal, bevor Sie eine App von der Kommandozeile starten.

Das Installationsprogramm von LumiScan Keryx setzt zwei systemweite Umgebungsvariablen, `HDV_KERYX_BROKER` und `HDV_KERYX_PAGE`. Sie teilen jeder App mit, welches Broker-Programm sie starten soll und welches Programm die Keryx-Seite anzeigt. Ein Programm oder Terminal, das bereits geöffnet war, sieht sie nicht. Ohne sie startet eine App das `krxsystem` neben ihrem eigenen Programm.

## Die Keryx-Seite {#data-layer-page}

Jeder Broker bringt eine Webseite mit, die seinen Baum zeigt: `http://127.0.0.1:7555/` für den Standard-Broker (Port des Brokers + 2000). Das Starten von **LumiScan Keryx** öffnet dieselbe Seite in einem Fenster und startet den Broker, falls keiner läuft.

- Wählen Sie einen Knoten aus, um seinen Wert, Typ und seine Berechtigungen zu sehen.
- Ein beschreibbarer Knoten hat einen Editor, eine Methode eine Schaltfläche **Invoke**.
- Eine Beobachtungsliste verfolgt Werte, während sie sich ändern.
- **Shut down broker** stoppt den Broker. Die Apps laufen weiter und warten: Sie starten ihn erst wieder, wenn Sie auf **Start broker** klicken, das LumiScan Keryx-Fenster öffnen, ein `krxsystem` von Hand starten oder den PC neu starten.

Das LumiScan Keryx-Fenster und die Keryx-Seite sind Teil der Windows-Installation.

## Die Apps starten {#start-order}

Starten Sie die Apps in beliebiger Reihenfolge. Warten Sie, bis jede App vollständig gestartet ist, bevor Sie sich auf ihre Knoten verlassen. Starten Sie den OPC UA Connector zuletzt.

Prüfen Sie den Start auf der Keryx-Seite (Windows) oder mit `krxclient tree hdvisionsystems --depth 1`: Der Baum zeigt den Ordner `hdvisionsystems` mit einem Ordner pro laufender App. Für jede App mit Modulen listet `hdvisionsystems/<app>/system/found-modules` diese auf. Ist eine Liste leer, nennt `hdvisionsystems/<app>/system/status-text` den Grund - meist eine Einstellungsdatei, die nicht geladen werden konnte, oder eine fehlende Lizenz.

Um eine App zu stoppen, drücken Sie Strg+C in ihrer Konsole. Der Broker läuft weiter.

## Speicherorte der Dateien {#files}

| Was | Wo |
| --- | --- |
| Programme | der im Installationsprogramm gewählte Installationsordner (`Program Files`) |
| Einstellungen einer App | `C:\ProgramData\HD Vision Systems GmbH\LumiScan Vision Suite\<program>\etc\<settings folder>`, oder `%APP_RESOURCE_DIR%\etc\<settings folder>`, wenn die Umgebungsvariable `APP_RESOURCE_DIR` gesetzt ist. Der Einstellungsordner jeder App ist in ihrem Handbuch genannt |
| Log, Aufzeichnungen und Einstellungen des Brokers (`broker.json`) | `C:\ProgramData\HD Vision Systems GmbH\LumiScan Keryx` |

Unter Ubuntu legt der Broker sein Log, seine Aufzeichnungen und Einstellungen in `/tmp/lumiscan-keryx` ab.

Jede App mit Einstellungen schreibt ein Beispiel davon in einen Ordner Ihrer Wahl und beendet sich:

```shell
lumiscan-cam-driver --generate-settings C:\work\cam-settings
```

Sie überschreibt nie eine Datei. Bearbeiten Sie das Beispiel, kopieren Sie es in den Einstellungsordner und starten Sie die App.

## Optionen und Umgebungsvariablen {#options}

Dieselben Optionen gelten für jede App.

| Option oder Variable | Wirkung |
| --- | --- |
| `--keryx-url <address>` | Der zu verwendende Broker. Standard `tcp://127.0.0.1:5555`. Übergeben Sie dieselbe Adresse an jede App, an Cockpit und an den OPC UA Connector |
| `LUMISCAN_KERYX_URL` | Dasselbe, für jedes Programm auf dem PC. Die Option hat Vorrang |
| `--no-keryx-autostart`, `LUMISCAN_KERYX_AUTOSTART=0` | Die App startet keinen Broker. Starten Sie selbst einen: `krxsystem --backend hdv --url <address>` |
| `HDV_KERYX_BROKER`, `HDV_KERYX_PAGE` | Vom Installationsprogramm von LumiScan Keryx gesetzt: das Broker-Programm und das Seitenprogramm |

Jede App nennt beim Start in ihrem Log die Broker-Adresse, die sie verwendet.

## Andere Adressen als die Standardadresse {#several-brokers}

- **Ein anderer Port**: `tcp://127.0.0.1:<port>`. Jeder Port ist ein eigener Broker, gestartet von der ersten App, die ihn benötigt. Ein Broker belegt seinen Port und den nächsten, daher müssen zwei Broker mindestens zwei Ports auseinanderliegen. Seine Keryx-Seite liegt auf dem Port + 2000.
- **Ein lokaler Socket**: `ipc://<name>`. Ein relativer Name bezieht sich auf den Ordner, in dem ein Programm startet: Starten Sie den Broker selbst und starten Sie jede App aus genau diesem Ordner.
- **Ein anderer PC**: Zu einer Adresse eines anderen Rechners wird nur eine Verbindung aufgebaut, dort wird nie ein Broker gestartet. Der Broker lauscht nur auf diesem PC, sofern seine Einstellungen nichts anderes festlegen, und er hat keine Authentifizierung. Der Betrieb von Apps auf mehreren PCs mit einem gemeinsamen Broker wird in diesem Handbuch nicht behandelt.

## Gut zu wissen {#limits}

- Werte tragen keinen eigenen Zeitstempel: Eine App, die einen benötigt, veröffentlicht ihn in einem Knoten oder im Ergebnis.
- Ein neuer Abonnent erhält keinen Anfangswert. Lesen Sie den Knoten einmal und abonnieren Sie ihn dann.
- Ein Methodenaufruf, der nach einem Timeout wiederholt wird, kann zweimal ausgeführt werden.
