Skip to content

Commit

Permalink
Update
Browse files Browse the repository at this point in the history
  • Loading branch information
Acgua committed Mar 19, 2023
1 parent 2544974 commit 1784762
Show file tree
Hide file tree
Showing 13 changed files with 305 additions and 236 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
![Logo](admin/fully-mqtt.png)
![Logo](admin/fully-mqtt_500.png)

# ioBroker.fully-mqtt

Expand All @@ -25,7 +25,8 @@ Unlike [ioBroker.fullybrowser](https://github.com/arteck/ioBroker.fullybrowser),

## Documentation

* [Documentation](./docs/en/README.md)
* [🇬🇧 English Documentation](./docs/en/README.md)
* [🇩🇪 Deutsche Dokumentation](./docs/de/README.md)

## ioBroker Forum Thread

Expand Down
Binary file added admin/fully-mqtt_500.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added admin/fully-mqtt_800.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions admin/i18n/en/translations.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@
"Device Name": "Device Name",
"Do not process published info more than every x seconds": "Do not process published info more than every x seconds",
"Do not verify user and password": "Do not verify user and password",
"Enabled": "Enabled",
"Enabled": "",
"Expert Settings": "Expert Settings",
"Fully Browser Devices": "Fully Browser Devices",
"Fully MQTT Adapter Documentation": "Fully MQTT Adapter Documentation",
"Fully MQTT Adapter Documentation": "",
"IP Address": "IP Address",
"Logs client and connection errors as 'info' and not as 'error'": "Logs client and connection errors as 'info' and not as 'error'",
"MQTT Configuration": "MQTT Configuration",
Expand Down
32 changes: 22 additions & 10 deletions admin/jsonConfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,23 @@
"marginTop": 0
}
},
"_documentationLink": {
"_documentationLinkGerman": {
"type": "staticLink",
"label": "Fully MQTT Adapter Documentation",
"label": "🇩🇪 Deutsche Dokumentation",
"button": true,
"href": "https://github.com/Acgua/ioBroker.fully-mqtt/blob/main/docs/de/README.md",
"sm": 12,
"md": 12,
"lg": 2,
"style": {
"fontSize": 16,
"marginTop": 0
}
},
"_documentationLinkEnglish": {
"type": "staticLink",
"label": "🇬🇧 English Documentation",
"button": true,
"icon": "info",
"href": "https://github.com/Acgua/ioBroker.fully-mqtt/blob/main/docs/en/README.md",
"sm": 12,
"md": 12,
Expand Down Expand Up @@ -61,6 +73,13 @@
"md": 12,
"lg": 12,
"items": [
{
"type": "checkbox",
"attr": "Enabled",
"width": "30px",
"title": "",
"default": true
},
{
"type": "text",
"title": "Device Name",
Expand Down Expand Up @@ -125,13 +144,6 @@
"width": "50px",
"title": "MQTT",
"default": true
},
{
"type": "checkbox",
"attr": "Enabled",
"width": "50px",
"title": "Enabled",
"default": true
}
]
},
Expand Down
4 changes: 2 additions & 2 deletions admin/words.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions build/main.js.map

Large diffs are not rendered by default.

Binary file added docs/_img/fully-browser-settings-mqtt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_img/fully-browser-settings-remote-admin.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
64 changes: 64 additions & 0 deletions docs/de/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
![Logo](../../admin/fully-mqtt_500.png)

## Über diesen Adapter

Mit diesem Adapter kann der [Fully Kiosk Browser](https://www.fully-kiosk.com) (mit Plus-Lizenz) gesteuert werden. Über die [REST API](https://www.fully-kiosk.com/en/#rest) können diverse Befehle wie "Bildschirm an/aus", "Bildschirmschoner an/aus", etc. an den Fully gesendet werden.

Zusätzlich – sofern dies in den Adapter-Optionen MQTT aktiviert ist – werden Events (wie z.B. "Bildschirm an") immer sofort an den Adapter mitgeteilt und in den entsprechenden Datenpunkten angezeigt. Außerdem sendet der Fully Browser bei aktivem [MQTT](https://www.fully-kiosk.com/en/#mqtt) sämtliche Geräteinformationen immer automatisch mindestens alle 60 Sekunden, welche entsprechend in die Info-Datenpunkte geschrieben werden. Ist MQTT deaktiviert, werden diese Infos manuell regelmäßig über die REST API abgeholt. Das Senden von Befehlen erfolgt übrigens bei aktiviertem MQTT über die REST API, da der Fully Browser das Senden über MQTT nicht unterstützt.

## Fully-Browser vorbereiten

### Remote Admin aktivieren
1. Auf dem Tablet die Fully Browser App öffnen und die Einstellungen (Settings) öffnen.
1. Menüpunkt **Remote Administration (PLUS)** aufrufen
1. **Enable Remote Administration** aktivieren
1. Bei **Remote Admin Password** ein Passwort vergeben
1. **Remote Admin from Local Network** aktivieren

![Logo](../_img/fully-browser-settings-remote-admin.png)

### MQTT aktivieren
1. Auf dem Tablet die Fully Browser App öffnen und die Einstellungen (Settings) öffnen. Alternativ kannst du den Remote Admin auch von einem anderen Endgerät (z.B. PC) von einem Browser aus aufrufen, die Basis-URL ist hierbei immer http://ip-address:2323, nach dem Aufruf wirst du nach dem oben vergebenen Passwort gefragt.
2. Im Menü aufrufen: **Settings** -> **Other Settings** -> **MQTT Integration (PLUS)**
3. **Enable MQTT**: aktivieren
4. **MQTT Broker URL**: Im Format `mqtt://iobroker-ip-address:3000` eingeben. Dabei entspricht `iobroker-ip-address` der IP-Adresse vom ioBroker, und `3000` die Port-Nummer, die für die MQTT-Verbindung verwendet wird.
5. **MQTT Broker Username**: hier kannst du optional einen Benutzernamen vergeben.
6. **MQTT Broker Password**: hier kannst du optional ein Passwort vergeben.
7. **MQTT Client ID**: kannst du leer lassen
8. **MQTT Device Info Topic**: hier kannst du die Voreinstellung so belassen, wird vom Adapter nicht weiter beachtet.
8. **MQTT Event Topic**: hier kannst du die Voreinstellung so belassen, wird vom Adapter nicht weiter beachtet.

![Logo](../_img/fully-browser-settings-mqtt.png)


## Adapter-Einstellungen

### Fully-Browser-Geräte
Fully-Browser-Gerät(e), also die Tablets, auf denen der Fully-Browser läuft, entsprechend hinzufügen, dabei:
1. **Gerätename**: Beliebiger Name des Tablets, wird gleichzeitig als Bestandteil der Objekte/Datenpunkte verwendet, z.B. aus `Tablet Flur` wird dann `fully-mqtt.0.Tablet-Flur`.
1. **Protokoll**: `http` so belassen. Falls `https` verwendet werden soll: siehe Hinweise unter [Remote Admin](https://www.fully-kiosk.com/en/#remoteadmin).
1. **Remote Admin Passwort**: das oben vergebene Passwort eintragen
1. **MQTT**: sollte aktiviert werden um alle Features des Adapters zu nutzen.

### MQTT-Konfiguration
* **Port**: Dieselbe Portnummer wie oben in den Fullybrowser MQTT-Einstellungen verwenden (z.B. `3000`).
* **Benutzername**: Optional
* **Passwort**: Optional
* **Benutzername und Passwort nicht verifizieren**: Damit kann die Überprüfung von Benutzernamen und Passwort deaktiviert werden.

### Experten-Einstellungen: Remote Admin (REST API)
* **Request Timeout**: Nach Anzahl dieser Millisekunden wird ein REST API Request abgebrochen, wenn nicht erfolgreich.
* **Request Interval**: Wie oft sollen die Geräte-Infos abgefragt werden (Batteriestand, u.v.m.)? Etwa 60 Sekunden sollten locker reichen, gerne auch ein höheres Intervall vergeben. *Hinweis*: Wenn MQTT aktiviert ist, wird dies ignoriert, da per MQTT automatisch mind. alle 60 Sekunden Infos empfangen werden.
* **Info-Datenpunkte immer aktualisieren**: Normalerweise werden alle Info-Datenpunkte nur dann neu gesetzt, wenn es eine Änderung gab. Ist dies aktiviert, werden diese immer aktualisiert (mit ack:true), auch wenn es keine Änderung zum vorherigen Wert gab.

### Experten-Einstellungen: MQTT
* **Publizierte Infos nicht öfter als alle x Sekunden verarbeiten**: Lt. [Fully-Dokumentation](https://www.fully-kiosk.com/en/#mqtt) werden Infos nur alle 60 Sekunden publiziert, in meinen Tests erfolgte dies aber deutlich öfter, also kann hiermit ein Limit gesetzt werden.
* **Info-Datenpunkte immer aktualisieren**: Normalerweise werden alle Info-Datenpunkte nur dann neu gesetzt, wenn es eine Änderung gab. Ist dies aktiviert, werden diese immer aktualisiert (mit ack:true), auch wenn es keine Änderung zum vorherigen Wert gab.
* **Client- und Connection-Fehler als info im Log**: Wenn aktiviert, werden Client- und Verbindungsfehler immer als Info und nicht als Error im Log ausgegeben. Dies dient dazu, das Log sauber zu halten und nicht unnötig zu füllen, nur weil sich mal kurzzeitig ein Tablet abmeldet und nach wenigen Sekunden wieder anmeldet. Längerzeitige Fehler und Warnungen werden immer im Log entsprechend angezeigt.


## Links

* [ioBroker-Forum: Adapter Fully Browser mit MQTT](https://forum.iobroker.net/topic/63705/)
* [fully-kiosk.com REST API](https://www.fully-kiosk.com/en/#rest)
* [fully-kiosk.com MQTT Integration](https://www.fully-kiosk.com/en/#mqtt)
17 changes: 3 additions & 14 deletions docs/en/README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,9 @@
![Logo](../../admin/fully-mqtt.png)
![Logo](../../admin/fully-mqtt_500.png)

# ioBroker.fully-mqtt

## Documentation

The documentation will be published here soon.
The English documentation will be published here soon.

In the meantime, you can check out the following forum post that describes the adapter and the installation and setup in detail.

**[ioBroker-Forum: Adapter Fully Browser mit MQTT](https://forum.iobroker.net/topic/63705/)**


## Dokumentation

Die Dokumentation wird demnächst hier veröffentlicht.

In der Zwischenzeit können Sie sich den folgenden Forenbeitrag ansehen, der den Adapter sowie die Installation und Einrichtung detailliert beschreibt.

**[ioBroker-Forum: Adapter Fully Browser mit MQTT](https://forum.iobroker.net/topic/63705/)**
In the meantime, you can check out [🇩🇪 Deutsche Dokumentation](../de/README.md) and translate with online tools accordingly.
Loading

0 comments on commit 1784762

Please sign in to comment.