TippvomTibb - Benutzerbeiträge [de]

WLAN Aktor Markise

2026-06-13T15:55:01Z

Chris T. Ludwig: /* Fehlerquellen */

=Allgemeines=
Leider hatte ich keinen Port mehr an den KNX-Rollladenaktoren zur Verfuegung, daher bin ich auf eine MQTT-WLAN-ESP-DuoRelais-Schaltung ausgewischen.

=Hardware=

=Software=

<syntaxhighlight lang="c" line>

//ShutterBlindsAwningFunction with LC-Relay-ESP01-2R-5V
//tested 2022-08-06

#include <ESP8266WiFi.h> // Include the Wi-Fi library
#include <PubSubClient.h> // MQTT
#include "ESPDateTime.h" // NTP
#include <ESP_EEPROM.h> // to store non-volatile variables
#include "CRC.h" // to check the reliability of the EEPROM-stored variables
#include "CRC8.h"

//CONFIGURATION
#define WLAN_SSID "XXX"
#define WLAN_PASSWORD "YYY"
#define MQTT_SERVER_IP "ZZZ" // better to use the ip, DNS will slow down the speed
#define MQTT_MSG_BUFFER_SIZE 50
#define MQTT_DEBUG_MSG_BUFFER_SIZE 50
#define MQTTT_BASE_TOPIC "home/basement/0_terrace/awning/" // my rooms are numbered so there is a consideration to replace the _ with / to use the 0 also for e.g. garden
#define MQTT_OUT_STATE MQTTT_BASE_TOPIC "state"
#define MQTT_OUT_RAW MQTTT_BASE_TOPIC "raw"
#define MQTT_OUT_ALIVE MQTTT_BASE_TOPIC "alive"
#define MQTT_OUT_RSSI MQTTT_BASE_TOPIC "RSSI"
#define MQTT_IN_TRIGGER MQTTT_BASE_TOPIC "trigger"
#define MQTT_IN_DIRECTION MQTTT_BASE_TOPIC "direction"
#define MQTT_IN_CONFIG MQTTT_BASE_TOPIC "config"

//#define SERIAL_DEBUG // used in an early stage of development; conflicts with UART output for relais control
#define MQTT_DEBUG_OUTPUT // the raw topic serves to output the values for debugging // TODO struct config
#define ALIVEINTERVAL 10000 // UpdateInterval in milliseconds of the topics 'alive' // TODO struct config

//WIFI
WiFiClient espClient;
const char * ssid = WLAN_SSID; // The SSID (name) of the Wi-Fi network you want to connect to
const char * password = WLAN_PASSWORD; // The password of the Wi-Fi network
String mac;

//MQTT
const char * MQTTServer = MQTT_SERVER_IP;
PubSubClient MQTTClient(espClient); //Constructor
unsigned long lastMsg = 0; // to remember the last timestamp of the 'ALVIE-publish' (heartbeat)
char msg[MQTT_MSG_BUFFER_SIZE]; // old style; sorry for mixing c and c++
char msgConfig[MQTT_DEBUG_MSG_BUFFER_SIZE]; // to store the config parameters; in setup there is no possibility to send out, so store it to send it in loop
long int value = 0; // don't needed anymore; its a counter replaced by DateTime

String topicBase = MQTTT_BASE_TOPIC ;
String inConfigTopic = MQTT_IN_CONFIG ;
String inTriggerTopic = MQTT_IN_TRIGGER ;
String inDirectionTopic = MQTT_IN_DIRECTION;
String outStateTopic = MQTT_OUT_STATE ;
String outRawTopic = MQTT_OUT_RAW ;
String outAliveTopic = MQTT_OUT_ALIVE ;
String outRSSITopic = MQTT_OUT_RSSI ;
String clientId;

//RELAIS
void sendRelaisCommand(unsigned int relais,boolean onoff); // forward declaration
volatile byte state; // 0 STOP (0,X); 1 EXTEND (1,1); 2 STOP (0,X); 3 RETRACT (1,0)
volatile boolean relaisState[] = {false,false};
struct EEPROMValues{ // use a struct to store and retrieve to/from EEPROM
//const char* mark="#"; // Before C++11, members of a struct could not be default initialized. Instead they must be initialized after an instance struct is created.
//EEPROM.put/get probably have issues with strings
byte mark; //or char mark;
unsigned long timeActiveDir1; // Milliseconds active till relaisstate[] falls back to {false,false}
unsigned long timeActiveDir2; // Milliseconds active till relaisstate[] false back to {false,false}
unsigned long checksum;
} settings;

//TIMER
unsigned long startTimeDir1 = 0; // Starttime if relais1 goes active
unsigned long startTimeDir2 = 0; // Starttime if relais1 goes active

//CRC
CRC8 crc;
unsigned int eepromAddr = 0; // address to store the config variables, mark and checksum (struct settings)

//CONFIG
boolean sendOutOneTime = false; // flag to output the stored config only once after powerup/reset

//CALLBACK The function is called when a new message arrives. All code to react within this function and/or transfer the parameter to outer variables.
// mosquitto_pub -h 192.168.178.x -t 'home/basement/0_terrace/awning/trigger' -m '1' // or -m 1 or -m 0
// mosquitto_pub -h 192.168.178.x -t 'home/basement/0_terrace/awning/config' -m '7000 8000'
// mosquitto_pub -h 192.168.178.x -t 'home/basement/0_terrace/awning/direction' -m 'up'
void callback(char* topic, byte* payload, unsigned int length) { // topic ends with direction or config // payload from -m within apostrophes // lentgh integer number of bytes of payload
#ifdef SERIAL_DEBUG
Serial.print("Message arrived [");
Serial.print(topic);
Serial.print("] ");
for (unsigned int i = 0; i < length; i++) {
Serial.print((char)payload[i]); // print out the payload array byte by byte
}
Serial.println();
#endif

String payloadStr; // to transfer the byte-array to a String
char* p = (char*)malloc(length); // copy the payload to the new buffer; actually not necessary
memcpy(p,payload,length); // play safe, it does no harm
payloadStr.concat(p,length); // String is better to do things like .toLowerCase();

// Trigger CONTROL
if (strcmp(inTriggerTopic.c_str(),topic) == 0 && (char)payload[0] == '1') { //1 for trigger // 0 or other are not handled
boolean stateSet = false; // if the state is detected and changed ignore all following state detections
// Relais 1 determines the direction
// Relais 2 switches on/off respectively move/stop
// activating means first switch on relay 1, pause, activate relay 2
// deactivating means first switch off relay 2, pause and only then relay 1 if necessary switch
// state 0 both relays off (relay 2 then 1) start condition
// state 1 relay 1 set relay 1 to move out/down postition, pause, activate relay 2
// state 2 both relays off (relay 2 then 1) intermediate condition
// state 3 relay 1 set relay 1 to move in/up postition, pause, activate relay 2
// recommendation for pausetime is 500 ms
if (!relaisState[0] && !relaisState[1] && state != 0 && state !=2 ){ //asynchron!!! correct it
state = 0;
stateSet = true;
}
if (!relaisState[0] && !relaisState[1] && !stateSet){
if(state==0){ // State 0->1
sendRelaisCommand(1,true); // extend
delay(100);
sendRelaisCommand(2,true); // activate
state=1;
startTimeDir1 = millis();
}
if(state==2){ // state 2->3
sendRelaisCommand(1,false); // retract
delay(100);
sendRelaisCommand(2,true); // activate
state=3;
startTimeDir2 = millis();
}
stateSet = true;
}
if (relaisState[0] && relaisState[1] && !stateSet){ // state 1->2
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false); //at this point the relais could be untouched, in state 1 and 3 it will be set again, to save energy switch both relays to off
state=2;
stateSet = true;
}
if (!relaisState[0] && relaisState[1] && !stateSet){ // state 3->0
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false); //at this point the relais could be untouched, in state 1 and 3 it will be set again, to save energy switch both relays to off
state=0;
stateSet = true;
}
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "%d",state);
#ifdef SERIAL_DEBUG
Serial.print("Publish message: ");
Serial.println(msg);
#endif
MQTTClient.publish(outStateTopic.c_str(), msg);
}

// Direction CONTROL
if (strcmp(inDirectionTopic.c_str(),topic) == 0) {
uint8_t direction=0; // 1 means down(out); 2 means up(in)
payloadStr.toLowerCase();
//MQTTClient.publish(outRawTopic.c_str(), payloadStr.c_str());

const char directions1[3][6]={"down","out","on"}; // to react to all of this commands
const char directions2[3][6]={"up","in","off"};
const char directions3[3][6]={"halt","stop","stopp"};

uint8_t number; // -Wunused-but-set-variable
number=sizeof(directions1)/sizeof(directions1[0]); // calculate the number of array members // Test!!! can be deleted
(void)number; // to suppress the warning
#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "%d",number);
MQTTClient.publish(outRawTopic.c_str(), msg);
#endif

// only one of this tests can be true // after this block direction is 1, 2 or 3 depending on command
for(uint8_t i=1;i<=(sizeof(directions1)/sizeof(directions1[0]));i++){
if (strcmp(payloadStr.c_str(),directions1[i-1])==0)direction=1;
}
for(uint8_t i=1;i<=(sizeof(directions2)/sizeof(directions2[0]));i++){
if (strcmp(payloadStr.c_str(),directions2[i-1])==0)direction=2;
}
for(uint8_t i=1;i<=(sizeof(directions3)/sizeof(directions3[0]));i++){
if (strcmp(payloadStr.c_str(),directions3[i-1])==0)direction=3;
}

if (direction == 1){
MQTTClient.publish(outRawTopic.c_str(), "DIR1");
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
sendRelaisCommand(1,true); // move out/down
delay(100);
sendRelaisCommand(2,true); // activate
startTimeDir1 = millis();
}
if (direction == 2){
MQTTClient.publish(outRawTopic.c_str(), "DIR2");
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
sendRelaisCommand(1,false);
delay(100);
sendRelaisCommand(2,true);
startTimeDir2 = millis();
}
if (direction == 3){
MQTTClient.publish(outRawTopic.c_str(), "DIR3");
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
}
}

// config CONTROL
if (strcmp(inConfigTopic.c_str(),topic) == 0){
unsigned long maxTime[] = {180,180};
const char* pL = payloadStr.c_str(); // get pointer to payload string // the payload is the combination of two integer space separated
char* end; // declare a pointer
for (uint8_t i = 1; i <= 2; i++){
maxTime[i-1] = strtol(pL,&end,10); // &end is the reference to an object of type char*, whose value is set by the function to the next character in str after the numerical value.
if (pL == end) break;
pL = end; // the space at the beginning of second number is seemingly not a problem
}
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "{%ld:%ld}",maxTime[0],maxTime[1]);
MQTTClient.publish(outRawTopic.c_str(), msg);
if (maxTime[0]>=0 && maxTime[0]<=1440000 && maxTime[1]>=0 && maxTime[1]<=1440000){
settings.timeActiveDir1=maxTime[0];
settings.timeActiveDir2=maxTime[1];
crc.reset();
crc.add(settings.timeActiveDir1);
crc.add(settings.timeActiveDir2);
settings.checksum=crc.getCRC();
#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "{EEPROMput:%c:%ld:%ld:%ld}",settings.mark,settings.timeActiveDir1,settings.timeActiveDir2,settings.checksum);
MQTTClient.publish(outRawTopic.c_str(), msg);
#endif
EEPROM.put(eepromAddr, settings); //write data to array in ram
EEPROM.commit(); //write data from ram to flash memory. Do nothing if there are no changes to EEPROM data in ram
}
}
}

void reconnect() {
// Loop until we're reconnected
while (!MQTTClient.connected()) {
#ifdef SERIAL_DEBUG
Serial.print("Attempting MQTT connection...");
#endif

// Attempt to connect
if (MQTTClient.connect(mac.c_str())) {
#ifdef SERIAL_DEBUG
Serial.println("connected");
#endif
// Once connected, publish an announcement...
MQTTClient.publish(topicBase.c_str(), "CON");
// ... and resubscribe
MQTTClient.subscribe(inTriggerTopic.c_str());
MQTTClient.subscribe(inDirectionTopic.c_str());
MQTTClient.subscribe(inConfigTopic.c_str());
} else {
#ifdef SERIAL_DEBUG
Serial.print("failed, rc=");
Serial.print(MQTTClient.state());
Serial.println(" try again in 5 seconds");
#endif
// Wait 5 seconds before retrying
delay(5000);
}
}
}

void sendRelaisCommand(unsigned int relais,boolean onoff){
//default for relais 1
byte commandOn[4]={160,1,1,162}; // A0 (160 Non-breaking space) command initiate, relay 1/2, on/off, checksum (Addition)
byte commandOff[4]={160,1,0,161};

//change commands for relais 2
if (relais==2){
commandOn[1]=2;
commandOff[1]=2;
commandOn[3]=163;
commandOff[3]=162;
}

if (onoff){
Serial.write(commandOn,4);
relaisState[relais-1]=true;
}else{
Serial.write(commandOff,4);
relaisState[relais-1]=false;
}

#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "RELAIS-%d_SET_%s",relais,onoff?"ON":"OFF");
#ifdef SERIAL_DEBUG
Serial.print("Publish message: ");
Serial.println(msg);
#endif
MQTTClient.publish(outRawTopic.c_str(),msg);
#endif
}

void setupDateTime() {
// setup this after wifi connected
// you can use custom timeZone,server and timeout
// DateTime.setTimeZone(-4);
// DateTime.setServer("asia.pool.ntp.org");
// DateTime.begin(15 * 1000);
DateTime.setServer("de.pool.ntp.org");
DateTime.setTimeZone("CEST");
DateTime.begin(); // ( const unsigned int timeOutMs = DEFAULT_TIMEOUT )
#ifdef SERIAL_DEBUG
if (!DateTime.isTimeValid()) {
Serial.println("Failed to get time from server.");
} else {
Serial.printf("Date Now is %s\n", DateTime.toISOString().c_str());
Serial.printf("Timestamp is %lld\n", DateTime.now());
}
#endif
}

//SETUP
void setup() {

//SERIAL
Serial.begin(115200); // Start the Serial communication to send messages to the computer
delay(10);
#ifdef SERIAL_DEBUG
Serial.println('\n');
#endif

//WIFI
WiFi.mode(WIFI_STA);// ist scheinbar der defaultwert wird in letzter Version nicht benutzt
WiFi.begin(ssid, password); // Connect to the network
#ifdef SERIAL_DEBUG
Serial.print("Connecting to ");
Serial.print(ssid); Serial.println(" ...");
#endif

while (WiFi.status() != WL_CONNECTED) { // Wait for the Wi-Fi to connect
delay(1000);
#ifdef SERIAL_DEBUG
int i = 0;
Serial.print(++i); Serial.print("->");
#endif
}
mac=WiFi.macAddress();
//clientId += String(random(0xffff), HEX);
clientId = "ESP01-" + mac;

randomSeed(micros());

#ifdef SERIAL_DEBUG
Serial.println('\n');
Serial.println("Connection established!");
Serial.print("IP address:\t");
Serial.println(WiFi.localIP()); // Send the IP address of the ESP8266 to the computer
#endif

//MQTT
MQTTClient.setServer(MQTTServer, 1883);
MQTTClient.setCallback(callback);

//DATETIME
setupDateTime();

//TIMESETTING
EEPROM.begin(sizeof(settings)); // 2 + 8 + 8 + 8
boolean reliable1 = false, reliable2 = false;
EEPROM.get(eepromAddr, settings); //read data from array in ram and cast it into struct called settings
#ifdef MQTT_DEBUG_OUTPUT
// in setup() MQTT isn't connected so store the values and publish it in loop()
snprintf (msgConfig, 50, "{EEPROMget:%c:%ld:%ld:%#lx}",settings.mark,settings.timeActiveDir1,settings.timeActiveDir2,settings.checksum);
#endif
//if (strcmp(settings.mark,"#") == 0){
if (settings.mark == 35){
crc.reset();
crc.add(settings.timeActiveDir1);
crc.add(settings.timeActiveDir2);
if (crc.getCRC()==settings.checksum) reliable1 = true;
}
if (settings.timeActiveDir1 >= 50 && // values less than 50 ms and greater than 24 hours are senseless
settings.timeActiveDir1 <= 1440000 &&
settings.timeActiveDir2 >= 50 &&
settings.timeActiveDir2 <= 1440000) reliable2 = true;

if (!(reliable1 && reliable2)){ // if the Content of EEPROM is undefined, set it
settings.mark = 35;
settings.timeActiveDir1 = 180 * 1000; // default 3 minutes to switch off
settings.timeActiveDir2 = 180 * 1000;
crc.reset();
crc.add(settings.timeActiveDir1);
crc.add(settings.timeActiveDir2);
settings.checksum=crc.getCRC();
EEPROM.put(eepromAddr, settings); //write data structure to ram
EEPROM.commit(); //write data from ram to flash memory. Do nothing if there are no changes to EEPROM data in ram
}

//RELAIS setup
Serial.write(0); // initialize the uContoller that controls the relays
}

// LOOP
void loop() {

if (!MQTTClient.connected()) {
reconnect();
}
MQTTClient.loop();

// send out one time after setup
if (!sendOutOneTime) {
#ifdef MQTT_DEBUG_OUTPUT
MQTTClient.publish(outRawTopic.c_str(), msgConfig);
snprintf (msgConfig, 50, "{config:%c:%ld:%ld:%#lx}",settings.mark,settings.timeActiveDir1,settings.timeActiveDir2,settings.checksum);
MQTTClient.publish(outRawTopic.c_str(), msgConfig);
sendOutOneTime = true;
#endif
}
unsigned long now = millis();

if (now - lastMsg > ALIVEINTERVAL) {
lastMsg = now;
++value;
snprintf (msg, MQTT_MSG_BUFFER_SIZE, "%s",DateTime.toISOString().c_str());
#ifdef SERIAL_DEBUG
Serial.print("Publish message: ");
Serial.println(msg);
#endif
MQTTClient.publish(outAliveTopic.c_str(), msg);
snprintf (msg, MQTT_MSG_BUFFER_SIZE, "%d",WiFi.RSSI());
#ifdef SERIAL_DEBUG
Serial.print("Publish message: ");
Serial.println(msg);
#endif
MQTTClient.publish(outRSSITopic.c_str(), msg);
}

if ((now - startTimeDir1 > settings.timeActiveDir1) && (startTimeDir1 != 0)){ // switch both relays to off after milliseconds defined in config (energy saving and safety aspects)
#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "{Fallback1:%ld:%ld:%ld}",now,startTimeDir1,settings.timeActiveDir1);
MQTTClient.publish(outRawTopic.c_str(), msg);
#endif
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
startTimeDir1 = 0;
}

if ((now - startTimeDir2 > settings.timeActiveDir2) && (startTimeDir2 != 0)){ // switch both relays to off after milliseconds defined in config (energy saving and safety aspects)
#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "{Fallback2:%ld:%ld:%ld}",now,startTimeDir2,settings.timeActiveDir2);
MQTTClient.publish(outRawTopic.c_str(), msg);
#endif
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
startTimeDir2 = 0;
}

}

</syntaxhighlight>

==Beschreibung==

Die Software ist eine Firmware für einen **ESP8266 (ESP-01)**, die über MQTT eine **motorisierte Markise** oder einen ähnlichen Sonnenschutz steuert.

## Hauptfunktion

Der ESP8266 verbindet sich mit WLAN und einem MQTT-Broker und steuert über eine serielle Relaisplatine zwei Relais:

* Relais 1 = Fahrtrichtung (Ausfahren / Einfahren)
* Relais 2 = Motor EIN/AUS

Die Steuerung erfolgt per MQTT-Befehlen.

---

## MQTT-Schnittstelle

Basis-Topic:

```text
home/basement/0_terrace/awning/
```

Eingehende Befehle:

| Topic | Funktion |
| --------- | ------------------------ |
| trigger | Zustandswechsel |
| direction | Richtung vorgeben |
| config | Laufzeiten konfigurieren |

Ausgehende Statusmeldungen:

| Topic | Inhalt |
| ----- | ------------------------- |
| state | aktueller Zustand |
| raw | Debug-Ausgaben |
| alive | Heartbeat mit Zeitstempel |
| RSSI | WLAN-Empfangsstärke |

---

## Zustandsautomat

Es existieren vier Zustände:

| Zustand | Bedeutung |
| ------- | --------- |
| 0 | Stopp |
| 1 | Ausfahren |
| 2 | Stopp |
| 3 | Einfahren |

Bei jedem MQTT-Trigger wird zum nächsten Zustand gewechselt.

```text
0 → 1 → 2 → 3 → 0
```

Dadurch genügt ein einziger Taster oder MQTT-Befehl zum Steuern der Markise.

---

## Richtungssteuerung

Per MQTT können direkte Befehle gesendet werden:

```text
down
out
on
```

→ Markise ausfahren

```text
up
in
off
```

→ Markise einfahren

```text
halt
stop
stopp
```

→ Motor stoppen

---

## Sicherheitsschaltung

Für beide Richtungen existiert eine maximale Laufzeit:

```cpp
timeActiveDir1
timeActiveDir2
```

Nach Ablauf dieser Zeit werden beide Relais automatisch abgeschaltet.

Standard:

```text
180 Sekunden
```

Damit wird verhindert, dass ein defekter MQTT-Befehl oder ein Softwarefehler den Motor dauerhaft laufen lässt.

---

## EEPROM-Speicherung

Die Laufzeiten werden dauerhaft gespeichert:

```cpp
struct EEPROMValues
```

Inhalt:

* Kennzeichen (`mark`)
* Laufzeit Richtung 1
* Laufzeit Richtung 2
* CRC-Prüfsumme

Beim Start prüft die Firmware die Daten auf Plausibilität und Integrität. Falls ungültig, werden Standardwerte erzeugt.

---

## Netzwerkfunktionen

Die Firmware:

* verbindet sich mit WLAN
* verbindet sich mit MQTT
* synchronisiert die Uhr per NTP
* sendet alle 10 Sekunden einen Heartbeat

Beispiel:

```text
2025-03-01T12:34:56+01:00
```

sowie die aktuelle WLAN-Feldstärke.

---

## Hardware

Aus dem Code lässt sich folgende Hardware ableiten:

```text
ESP8266 (ESP-01)
│
UART
│
2-Kanal Relaiscontroller
│
Markisenmotor
```

Die Relaisplatine wird über ein proprietäres 4-Byte-Protokoll gesteuert:

```text
A0 Relais Zustand Checksumme
```

Beispiel:

```text
A0 01 01 A2
```

= Relais 1 EIN.

---

## Zusammenfassung

Die Software ist ein **MQTT-gesteuerter Markisencontroller auf Basis eines ESP8266**, der:

* WLAN und MQTT nutzt,
* eine Markise ein- und ausfährt,
* Fahrzeiten im EEPROM speichert,
* automatisch abschaltet,
* Status- und Debuginformationen veröffentlicht,
* per Home Assistant, Node-RED oder FHEM steuerbar ist.

Der Aufbau wirkt wie ein typisches Smart-Home-Projekt zur Nachrüstung einer vorhandenen Funk- oder Tastersteuerung einer Terrasse-Markise.

==Fehlerquellen==

Ja, es gibt einige relevante Fehlerquellen:

1. **Speicherleck in `callback()`**
`malloc(length)` wird nie mit `free(p)` freigegeben. Bei jedem MQTT-Befehl geht RAM verloren. Außerdem wird kein Byte für `\0` reserviert. Besser ganz ohne `malloc`:

```cpp
String payloadStr((char*)payload, length);
```

2. **`state` ist nicht initialisiert**
`volatile byte state;` bekommt keinen Startwert. Beim ersten Trigger kann der Zustand undefiniert sein. Besser:

```cpp
volatile byte state = 0;
```

3. **Richtungsbefehl setzt `state` nicht passend**
Bei `direction == 1/2/3` werden Relais geschaltet, aber `state` wird nicht auf 1, 3 oder 0/2 gesetzt. Danach kann der nächste `trigger` falsch reagieren.

4. **Alte Timer laufen weiter**
Wenn Richtung 1 gestartet wurde und danach Richtung 2 kommt, wird `startTimeDir1` nicht gelöscht. Später kann der alte Fallback unerwartet beide Relais ausschalten. Gleiches umgekehrt.

5. **Prüfung `maxTime[0] >= 0` ist wirkungslos**
`maxTime` ist `unsigned long`, also nie negativ. Wenn `strtol()` einen negativen Wert liefert, wird er beim Speichern in `unsigned long` zu einem großen Wert.

6. **`sendRelaisCommand()` prüft Relaisnummer nicht**
Bei versehentlich `sendRelaisCommand(0, ...)` oder `3` greift `relaisState[relais-1]` außerhalb des Arrays. Besser am Anfang:

```cpp
if (relais < 1 || relais > 2) return;
```

7. **Blockierende `delay()`-Aufrufe**
Während `delay(500)` oder beim MQTT-Reconnect mit `delay(5000)` reagiert der Controller verzögert. Für eine Markise ist das noch akzeptabel, aber ein sofortiger Stopp kann dadurch verspätet kommen.

8. **MQTT ohne Authentifizierung**
Der Code verbindet sich nur mit `MQTTClient.connect(mac.c_str())`. Jeder im Netz, der die Topics kennt, könnte die Markise steuern.

Die wichtigsten Sofortkorrekturen wären: `state = 0`, `malloc` entfernen, Timer gegenseitig zurücksetzen, `state` bei Direktbefehlen aktualisieren und MQTT mit Benutzer/Passwort absichern.

WLAN Aktor Markise

2026-06-13T15:54:45Z

Chris T. Ludwig: /* Software-Beschreibung */

WLAN Aktor Markise

2026-06-13T15:52:37Z

Chris T. Ludwig: /* Software */

=Allgemeines=
Leider hatte ich keinen Port mehr an den KNX-Rollladenaktoren zur Verfuegung, daher bin ich auf eine MQTT-WLAN-ESP-DuoRelais-Schaltung ausgewischen.

=Hardware=

=Software=

<syntaxhighlight lang="c" line>

//ShutterBlindsAwningFunction with LC-Relay-ESP01-2R-5V
//tested 2022-08-06

#include <ESP8266WiFi.h> // Include the Wi-Fi library
#include <PubSubClient.h> // MQTT
#include "ESPDateTime.h" // NTP
#include <ESP_EEPROM.h> // to store non-volatile variables
#include "CRC.h" // to check the reliability of the EEPROM-stored variables
#include "CRC8.h"

//CONFIGURATION
#define WLAN_SSID "XXX"
#define WLAN_PASSWORD "YYY"
#define MQTT_SERVER_IP "ZZZ" // better to use the ip, DNS will slow down the speed
#define MQTT_MSG_BUFFER_SIZE 50
#define MQTT_DEBUG_MSG_BUFFER_SIZE 50
#define MQTTT_BASE_TOPIC "home/basement/0_terrace/awning/" // my rooms are numbered so there is a consideration to replace the _ with / to use the 0 also for e.g. garden
#define MQTT_OUT_STATE MQTTT_BASE_TOPIC "state"
#define MQTT_OUT_RAW MQTTT_BASE_TOPIC "raw"
#define MQTT_OUT_ALIVE MQTTT_BASE_TOPIC "alive"
#define MQTT_OUT_RSSI MQTTT_BASE_TOPIC "RSSI"
#define MQTT_IN_TRIGGER MQTTT_BASE_TOPIC "trigger"
#define MQTT_IN_DIRECTION MQTTT_BASE_TOPIC "direction"
#define MQTT_IN_CONFIG MQTTT_BASE_TOPIC "config"

//#define SERIAL_DEBUG // used in an early stage of development; conflicts with UART output for relais control
#define MQTT_DEBUG_OUTPUT // the raw topic serves to output the values for debugging // TODO struct config
#define ALIVEINTERVAL 10000 // UpdateInterval in milliseconds of the topics 'alive' // TODO struct config

//WIFI
WiFiClient espClient;
const char * ssid = WLAN_SSID; // The SSID (name) of the Wi-Fi network you want to connect to
const char * password = WLAN_PASSWORD; // The password of the Wi-Fi network
String mac;

//MQTT
const char * MQTTServer = MQTT_SERVER_IP;
PubSubClient MQTTClient(espClient); //Constructor
unsigned long lastMsg = 0; // to remember the last timestamp of the 'ALVIE-publish' (heartbeat)
char msg[MQTT_MSG_BUFFER_SIZE]; // old style; sorry for mixing c and c++
char msgConfig[MQTT_DEBUG_MSG_BUFFER_SIZE]; // to store the config parameters; in setup there is no possibility to send out, so store it to send it in loop
long int value = 0; // don't needed anymore; its a counter replaced by DateTime

String topicBase = MQTTT_BASE_TOPIC ;
String inConfigTopic = MQTT_IN_CONFIG ;
String inTriggerTopic = MQTT_IN_TRIGGER ;
String inDirectionTopic = MQTT_IN_DIRECTION;
String outStateTopic = MQTT_OUT_STATE ;
String outRawTopic = MQTT_OUT_RAW ;
String outAliveTopic = MQTT_OUT_ALIVE ;
String outRSSITopic = MQTT_OUT_RSSI ;
String clientId;

//RELAIS
void sendRelaisCommand(unsigned int relais,boolean onoff); // forward declaration
volatile byte state; // 0 STOP (0,X); 1 EXTEND (1,1); 2 STOP (0,X); 3 RETRACT (1,0)
volatile boolean relaisState[] = {false,false};
struct EEPROMValues{ // use a struct to store and retrieve to/from EEPROM
//const char* mark="#"; // Before C++11, members of a struct could not be default initialized. Instead they must be initialized after an instance struct is created.
//EEPROM.put/get probably have issues with strings
byte mark; //or char mark;
unsigned long timeActiveDir1; // Milliseconds active till relaisstate[] falls back to {false,false}
unsigned long timeActiveDir2; // Milliseconds active till relaisstate[] false back to {false,false}
unsigned long checksum;
} settings;

//TIMER
unsigned long startTimeDir1 = 0; // Starttime if relais1 goes active
unsigned long startTimeDir2 = 0; // Starttime if relais1 goes active

//CRC
CRC8 crc;
unsigned int eepromAddr = 0; // address to store the config variables, mark and checksum (struct settings)

//CONFIG
boolean sendOutOneTime = false; // flag to output the stored config only once after powerup/reset

//CALLBACK The function is called when a new message arrives. All code to react within this function and/or transfer the parameter to outer variables.
// mosquitto_pub -h 192.168.178.x -t 'home/basement/0_terrace/awning/trigger' -m '1' // or -m 1 or -m 0
// mosquitto_pub -h 192.168.178.x -t 'home/basement/0_terrace/awning/config' -m '7000 8000'
// mosquitto_pub -h 192.168.178.x -t 'home/basement/0_terrace/awning/direction' -m 'up'
void callback(char* topic, byte* payload, unsigned int length) { // topic ends with direction or config // payload from -m within apostrophes // lentgh integer number of bytes of payload
#ifdef SERIAL_DEBUG
Serial.print("Message arrived [");
Serial.print(topic);
Serial.print("] ");
for (unsigned int i = 0; i < length; i++) {
Serial.print((char)payload[i]); // print out the payload array byte by byte
}
Serial.println();
#endif

String payloadStr; // to transfer the byte-array to a String
char* p = (char*)malloc(length); // copy the payload to the new buffer; actually not necessary
memcpy(p,payload,length); // play safe, it does no harm
payloadStr.concat(p,length); // String is better to do things like .toLowerCase();

// Trigger CONTROL
if (strcmp(inTriggerTopic.c_str(),topic) == 0 && (char)payload[0] == '1') { //1 for trigger // 0 or other are not handled
boolean stateSet = false; // if the state is detected and changed ignore all following state detections
// Relais 1 determines the direction
// Relais 2 switches on/off respectively move/stop
// activating means first switch on relay 1, pause, activate relay 2
// deactivating means first switch off relay 2, pause and only then relay 1 if necessary switch
// state 0 both relays off (relay 2 then 1) start condition
// state 1 relay 1 set relay 1 to move out/down postition, pause, activate relay 2
// state 2 both relays off (relay 2 then 1) intermediate condition
// state 3 relay 1 set relay 1 to move in/up postition, pause, activate relay 2
// recommendation for pausetime is 500 ms
if (!relaisState[0] && !relaisState[1] && state != 0 && state !=2 ){ //asynchron!!! correct it
state = 0;
stateSet = true;
}
if (!relaisState[0] && !relaisState[1] && !stateSet){
if(state==0){ // State 0->1
sendRelaisCommand(1,true); // extend
delay(100);
sendRelaisCommand(2,true); // activate
state=1;
startTimeDir1 = millis();
}
if(state==2){ // state 2->3
sendRelaisCommand(1,false); // retract
delay(100);
sendRelaisCommand(2,true); // activate
state=3;
startTimeDir2 = millis();
}
stateSet = true;
}
if (relaisState[0] && relaisState[1] && !stateSet){ // state 1->2
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false); //at this point the relais could be untouched, in state 1 and 3 it will be set again, to save energy switch both relays to off
state=2;
stateSet = true;
}
if (!relaisState[0] && relaisState[1] && !stateSet){ // state 3->0
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false); //at this point the relais could be untouched, in state 1 and 3 it will be set again, to save energy switch both relays to off
state=0;
stateSet = true;
}
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "%d",state);
#ifdef SERIAL_DEBUG
Serial.print("Publish message: ");
Serial.println(msg);
#endif
MQTTClient.publish(outStateTopic.c_str(), msg);
}

// Direction CONTROL
if (strcmp(inDirectionTopic.c_str(),topic) == 0) {
uint8_t direction=0; // 1 means down(out); 2 means up(in)
payloadStr.toLowerCase();
//MQTTClient.publish(outRawTopic.c_str(), payloadStr.c_str());

const char directions1[3][6]={"down","out","on"}; // to react to all of this commands
const char directions2[3][6]={"up","in","off"};
const char directions3[3][6]={"halt","stop","stopp"};

uint8_t number; // -Wunused-but-set-variable
number=sizeof(directions1)/sizeof(directions1[0]); // calculate the number of array members // Test!!! can be deleted
(void)number; // to suppress the warning
#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "%d",number);
MQTTClient.publish(outRawTopic.c_str(), msg);
#endif

// only one of this tests can be true // after this block direction is 1, 2 or 3 depending on command
for(uint8_t i=1;i<=(sizeof(directions1)/sizeof(directions1[0]));i++){
if (strcmp(payloadStr.c_str(),directions1[i-1])==0)direction=1;
}
for(uint8_t i=1;i<=(sizeof(directions2)/sizeof(directions2[0]));i++){
if (strcmp(payloadStr.c_str(),directions2[i-1])==0)direction=2;
}
for(uint8_t i=1;i<=(sizeof(directions3)/sizeof(directions3[0]));i++){
if (strcmp(payloadStr.c_str(),directions3[i-1])==0)direction=3;
}

if (direction == 1){
MQTTClient.publish(outRawTopic.c_str(), "DIR1");
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
sendRelaisCommand(1,true); // move out/down
delay(100);
sendRelaisCommand(2,true); // activate
startTimeDir1 = millis();
}
if (direction == 2){
MQTTClient.publish(outRawTopic.c_str(), "DIR2");
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
sendRelaisCommand(1,false);
delay(100);
sendRelaisCommand(2,true);
startTimeDir2 = millis();
}
if (direction == 3){
MQTTClient.publish(outRawTopic.c_str(), "DIR3");
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
}
}

// config CONTROL
if (strcmp(inConfigTopic.c_str(),topic) == 0){
unsigned long maxTime[] = {180,180};
const char* pL = payloadStr.c_str(); // get pointer to payload string // the payload is the combination of two integer space separated
char* end; // declare a pointer
for (uint8_t i = 1; i <= 2; i++){
maxTime[i-1] = strtol(pL,&end,10); // &end is the reference to an object of type char*, whose value is set by the function to the next character in str after the numerical value.
if (pL == end) break;
pL = end; // the space at the beginning of second number is seemingly not a problem
}
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "{%ld:%ld}",maxTime[0],maxTime[1]);
MQTTClient.publish(outRawTopic.c_str(), msg);
if (maxTime[0]>=0 && maxTime[0]<=1440000 && maxTime[1]>=0 && maxTime[1]<=1440000){
settings.timeActiveDir1=maxTime[0];
settings.timeActiveDir2=maxTime[1];
crc.reset();
crc.add(settings.timeActiveDir1);
crc.add(settings.timeActiveDir2);
settings.checksum=crc.getCRC();
#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "{EEPROMput:%c:%ld:%ld:%ld}",settings.mark,settings.timeActiveDir1,settings.timeActiveDir2,settings.checksum);
MQTTClient.publish(outRawTopic.c_str(), msg);
#endif
EEPROM.put(eepromAddr, settings); //write data to array in ram
EEPROM.commit(); //write data from ram to flash memory. Do nothing if there are no changes to EEPROM data in ram
}
}
}

void reconnect() {
// Loop until we're reconnected
while (!MQTTClient.connected()) {
#ifdef SERIAL_DEBUG
Serial.print("Attempting MQTT connection...");
#endif

// Attempt to connect
if (MQTTClient.connect(mac.c_str())) {
#ifdef SERIAL_DEBUG
Serial.println("connected");
#endif
// Once connected, publish an announcement...
MQTTClient.publish(topicBase.c_str(), "CON");
// ... and resubscribe
MQTTClient.subscribe(inTriggerTopic.c_str());
MQTTClient.subscribe(inDirectionTopic.c_str());
MQTTClient.subscribe(inConfigTopic.c_str());
} else {
#ifdef SERIAL_DEBUG
Serial.print("failed, rc=");
Serial.print(MQTTClient.state());
Serial.println(" try again in 5 seconds");
#endif
// Wait 5 seconds before retrying
delay(5000);
}
}
}

void sendRelaisCommand(unsigned int relais,boolean onoff){
//default for relais 1
byte commandOn[4]={160,1,1,162}; // A0 (160 Non-breaking space) command initiate, relay 1/2, on/off, checksum (Addition)
byte commandOff[4]={160,1,0,161};

//change commands for relais 2
if (relais==2){
commandOn[1]=2;
commandOff[1]=2;
commandOn[3]=163;
commandOff[3]=162;
}

if (onoff){
Serial.write(commandOn,4);
relaisState[relais-1]=true;
}else{
Serial.write(commandOff,4);
relaisState[relais-1]=false;
}

#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "RELAIS-%d_SET_%s",relais,onoff?"ON":"OFF");
#ifdef SERIAL_DEBUG
Serial.print("Publish message: ");
Serial.println(msg);
#endif
MQTTClient.publish(outRawTopic.c_str(),msg);
#endif
}

void setupDateTime() {
// setup this after wifi connected
// you can use custom timeZone,server and timeout
// DateTime.setTimeZone(-4);
// DateTime.setServer("asia.pool.ntp.org");
// DateTime.begin(15 * 1000);
DateTime.setServer("de.pool.ntp.org");
DateTime.setTimeZone("CEST");
DateTime.begin(); // ( const unsigned int timeOutMs = DEFAULT_TIMEOUT )
#ifdef SERIAL_DEBUG
if (!DateTime.isTimeValid()) {
Serial.println("Failed to get time from server.");
} else {
Serial.printf("Date Now is %s\n", DateTime.toISOString().c_str());
Serial.printf("Timestamp is %lld\n", DateTime.now());
}
#endif
}

//SETUP
void setup() {

//SERIAL
Serial.begin(115200); // Start the Serial communication to send messages to the computer
delay(10);
#ifdef SERIAL_DEBUG
Serial.println('\n');
#endif

//WIFI
WiFi.mode(WIFI_STA);// ist scheinbar der defaultwert wird in letzter Version nicht benutzt
WiFi.begin(ssid, password); // Connect to the network
#ifdef SERIAL_DEBUG
Serial.print("Connecting to ");
Serial.print(ssid); Serial.println(" ...");
#endif

while (WiFi.status() != WL_CONNECTED) { // Wait for the Wi-Fi to connect
delay(1000);
#ifdef SERIAL_DEBUG
int i = 0;
Serial.print(++i); Serial.print("->");
#endif
}
mac=WiFi.macAddress();
//clientId += String(random(0xffff), HEX);
clientId = "ESP01-" + mac;

randomSeed(micros());

#ifdef SERIAL_DEBUG
Serial.println('\n');
Serial.println("Connection established!");
Serial.print("IP address:\t");
Serial.println(WiFi.localIP()); // Send the IP address of the ESP8266 to the computer
#endif

//MQTT
MQTTClient.setServer(MQTTServer, 1883);
MQTTClient.setCallback(callback);

//DATETIME
setupDateTime();

//TIMESETTING
EEPROM.begin(sizeof(settings)); // 2 + 8 + 8 + 8
boolean reliable1 = false, reliable2 = false;
EEPROM.get(eepromAddr, settings); //read data from array in ram and cast it into struct called settings
#ifdef MQTT_DEBUG_OUTPUT
// in setup() MQTT isn't connected so store the values and publish it in loop()
snprintf (msgConfig, 50, "{EEPROMget:%c:%ld:%ld:%#lx}",settings.mark,settings.timeActiveDir1,settings.timeActiveDir2,settings.checksum);
#endif
//if (strcmp(settings.mark,"#") == 0){
if (settings.mark == 35){
crc.reset();
crc.add(settings.timeActiveDir1);
crc.add(settings.timeActiveDir2);
if (crc.getCRC()==settings.checksum) reliable1 = true;
}
if (settings.timeActiveDir1 >= 50 && // values less than 50 ms and greater than 24 hours are senseless
settings.timeActiveDir1 <= 1440000 &&
settings.timeActiveDir2 >= 50 &&
settings.timeActiveDir2 <= 1440000) reliable2 = true;

if (!(reliable1 && reliable2)){ // if the Content of EEPROM is undefined, set it
settings.mark = 35;
settings.timeActiveDir1 = 180 * 1000; // default 3 minutes to switch off
settings.timeActiveDir2 = 180 * 1000;
crc.reset();
crc.add(settings.timeActiveDir1);
crc.add(settings.timeActiveDir2);
settings.checksum=crc.getCRC();
EEPROM.put(eepromAddr, settings); //write data structure to ram
EEPROM.commit(); //write data from ram to flash memory. Do nothing if there are no changes to EEPROM data in ram
}

//RELAIS setup
Serial.write(0); // initialize the uContoller that controls the relays
}

// LOOP
void loop() {

if (!MQTTClient.connected()) {
reconnect();
}
MQTTClient.loop();

// send out one time after setup
if (!sendOutOneTime) {
#ifdef MQTT_DEBUG_OUTPUT
MQTTClient.publish(outRawTopic.c_str(), msgConfig);
snprintf (msgConfig, 50, "{config:%c:%ld:%ld:%#lx}",settings.mark,settings.timeActiveDir1,settings.timeActiveDir2,settings.checksum);
MQTTClient.publish(outRawTopic.c_str(), msgConfig);
sendOutOneTime = true;
#endif
}
unsigned long now = millis();

if (now - lastMsg > ALIVEINTERVAL) {
lastMsg = now;
++value;
snprintf (msg, MQTT_MSG_BUFFER_SIZE, "%s",DateTime.toISOString().c_str());
#ifdef SERIAL_DEBUG
Serial.print("Publish message: ");
Serial.println(msg);
#endif
MQTTClient.publish(outAliveTopic.c_str(), msg);
snprintf (msg, MQTT_MSG_BUFFER_SIZE, "%d",WiFi.RSSI());
#ifdef SERIAL_DEBUG
Serial.print("Publish message: ");
Serial.println(msg);
#endif
MQTTClient.publish(outRSSITopic.c_str(), msg);
}

if ((now - startTimeDir1 > settings.timeActiveDir1) && (startTimeDir1 != 0)){ // switch both relays to off after milliseconds defined in config (energy saving and safety aspects)
#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "{Fallback1:%ld:%ld:%ld}",now,startTimeDir1,settings.timeActiveDir1);
MQTTClient.publish(outRawTopic.c_str(), msg);
#endif
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
startTimeDir1 = 0;
}

if ((now - startTimeDir2 > settings.timeActiveDir2) && (startTimeDir2 != 0)){ // switch both relays to off after milliseconds defined in config (energy saving and safety aspects)
#ifdef MQTT_DEBUG_OUTPUT
snprintf (msg, MQTT_DEBUG_MSG_BUFFER_SIZE, "{Fallback2:%ld:%ld:%ld}",now,startTimeDir2,settings.timeActiveDir2);
MQTTClient.publish(outRawTopic.c_str(), msg);
#endif
sendRelaisCommand(2,false);
delay(100);
sendRelaisCommand(1,false);
delay(500);
startTimeDir2 = 0;
}

}

</syntaxhighlight>

=Software-Beschreibung=

Die Software ist eine Firmware für einen **ESP8266 (ESP-01)**, die über MQTT eine **motorisierte Markise** oder einen ähnlichen Sonnenschutz steuert.

## Hauptfunktion

Der ESP8266 verbindet sich mit WLAN und einem MQTT-Broker und steuert über eine serielle Relaisplatine zwei Relais:

* Relais 1 = Fahrtrichtung (Ausfahren / Einfahren)
* Relais 2 = Motor EIN/AUS

Die Steuerung erfolgt per MQTT-Befehlen.

---

## MQTT-Schnittstelle

Basis-Topic:

```text
home/basement/0_terrace/awning/
```

Eingehende Befehle:

| Topic | Funktion |
| --------- | ------------------------ |
| trigger | Zustandswechsel |
| direction | Richtung vorgeben |
| config | Laufzeiten konfigurieren |

Ausgehende Statusmeldungen:

| Topic | Inhalt |
| ----- | ------------------------- |
| state | aktueller Zustand |
| raw | Debug-Ausgaben |
| alive | Heartbeat mit Zeitstempel |
| RSSI | WLAN-Empfangsstärke |

---

## Zustandsautomat

Es existieren vier Zustände:

| Zustand | Bedeutung |
| ------- | --------- |
| 0 | Stopp |
| 1 | Ausfahren |
| 2 | Stopp |
| 3 | Einfahren |

Bei jedem MQTT-Trigger wird zum nächsten Zustand gewechselt.

```text
0 → 1 → 2 → 3 → 0
```

Dadurch genügt ein einziger Taster oder MQTT-Befehl zum Steuern der Markise.

---

## Richtungssteuerung

Per MQTT können direkte Befehle gesendet werden:

```text
down
out
on
```

→ Markise ausfahren

```text
up
in
off
```

→ Markise einfahren

```text
halt
stop
stopp
```

→ Motor stoppen

---

## Sicherheitsschaltung

Für beide Richtungen existiert eine maximale Laufzeit:

```cpp
timeActiveDir1
timeActiveDir2
```

Nach Ablauf dieser Zeit werden beide Relais automatisch abgeschaltet.

Standard:

```text
180 Sekunden
```

Damit wird verhindert, dass ein defekter MQTT-Befehl oder ein Softwarefehler den Motor dauerhaft laufen lässt.

---

## EEPROM-Speicherung

Die Laufzeiten werden dauerhaft gespeichert:

```cpp
struct EEPROMValues
```

Inhalt:

* Kennzeichen (`mark`)
* Laufzeit Richtung 1
* Laufzeit Richtung 2
* CRC-Prüfsumme

Beim Start prüft die Firmware die Daten auf Plausibilität und Integrität. Falls ungültig, werden Standardwerte erzeugt.

---

## Netzwerkfunktionen

Die Firmware:

* verbindet sich mit WLAN
* verbindet sich mit MQTT
* synchronisiert die Uhr per NTP
* sendet alle 10 Sekunden einen Heartbeat

Beispiel:

```text
2025-03-01T12:34:56+01:00
```

sowie die aktuelle WLAN-Feldstärke.

---

## Hardware

Aus dem Code lässt sich folgende Hardware ableiten:

```text
ESP8266 (ESP-01)
│
UART
│
2-Kanal Relaiscontroller
│
Markisenmotor
```

Die Relaisplatine wird über ein proprietäres 4-Byte-Protokoll gesteuert:

```text
A0 Relais Zustand Checksumme
```

Beispiel:

```text
A0 01 01 A2
```

= Relais 1 EIN.

---

## Zusammenfassung

Die Software ist ein **MQTT-gesteuerter Markisencontroller auf Basis eines ESP8266**, der:

* WLAN und MQTT nutzt,
* eine Markise ein- und ausfährt,
* Fahrzeiten im EEPROM speichert,
* automatisch abschaltet,
* Status- und Debuginformationen veröffentlicht,
* per Home Assistant, Node-RED oder FHEM steuerbar ist.

Der Aufbau wirkt wie ein typisches Smart-Home-Projekt zur Nachrüstung einer vorhandenen Funk- oder Tastersteuerung einer Terrasse-Markise.

WLAN Aktor Markise

2026-06-13T15:49:28Z

Chris T. Ludwig: Die Seite wurde neu angelegt: „=Allgemeines= Leider hatte ich keinen Port mehr an den KNX-Rollladenaktoren zur Verfuegung, daher bin ich auf eine MQTT-WLAN-ESP-DuoRelais-Schaltung ausgewischen. =Hardware= =Software= <syntaxhighlight lang="c" line> //ShutterBlindsAwningFunction with LC-Relay-ESP01-2R-5V //tested 2022-08-06 #include <ESP8266WiFi.h> // Include the Wi-Fi library #include <PubSubClient.h> // MQTT #include "ESPDateTime.h" // NTP #include <ESP_EEPRO…“

PasswortSafe

2026-06-13T12:49:14Z

Chris T. Ludwig: /* pass (Password Store) */

=Allgemeines=
Für mich ist immer noch ein Stueck Papier, evtl. geordnet in einem Rolodex die beste und sicherste Art Passwoerter zu speichern.

Passwoerter die allerdings Zugang zu weniger sensiblen Daten erlauben im einem Stueck Software zu speichern macht das Handling etwas besser.

Passwortspeicher gehoeren nicht in die Cloud!
Wenn ueberhaupt dann entsprechend mit einer Zusatzverschluesselung.

So richtig anfreunden kann ich mich bisher nur mit KeePassXC, Bitwarden und pass (Password Store).

KDEWallet benutze ich nur wenn es unbedingt sein muss. Das Programm zickt bei mir zu oft rum.

=KeePassXC=

=pass (Password Store)=

zypper in password-store

Evtl. noch password-store-dmenu, QtPass, plasma-pass, ...

Das pass init eine gpg-id verlangt, erst mal einen Sschluessel erzeugen.

gpg --full-generate-key

(9) ECC (sign and encrypt) oder (16) ECC and Kyber (Erlaeuterung siehe unten)

(1) Curve 25519 *default*

<pre>
chris@worker:~/wordlists> gpg --full-generate-key
gpg (GnuPG) 2.5.5; Copyright (C) 2025 g10 Code GmbH
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Please select what kind of key you want:
(1) RSA and RSA
(2) DSA and Elgamal
(3) DSA (sign only)
(4) RSA (sign only)
(9) ECC (sign and encrypt) *default*
(10) ECC (sign only)
(14) Existing key from card
(16) ECC and Kyber
Your selection? 9
Please select which elliptic curve you want:
(1) Curve 25519 *default*
(4) NIST P-384
(6) Brainpool P-256
Your selection? 1
Please specify how long the key should be valid.
0 = key does not expire
<n> = key expires in n days
<n>w = key expires in n weeks
<n>m = key expires in n months
<n>y = key expires in n years
Key is valid for? (0) 0
Key does not expire at all
Is this correct? (y/N) y

GnuPG needs to construct a user ID to identify your key.

Real name: Chris ................
Email address: test@clx.de
Comment: ++++++++
You selected this USER-ID:
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
gpg: directory '/home/chris/.gnupg/openpgp-revocs.d' created
gpg: revocation certificate stored as '/home/chris/.gnupg/openpgp-revocs.d/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.rev'
public and secret key created and signed.
</pre>

Eigentlich ist pass so simpel, dass es nur fuer Passwoerter taugt, die man schnell in der Konsole/Clipboard parat haben will.
Als PasswortManager taugt es eher nicht, da man in der Regel URL,Kennung und Passwort in Kombination ablegt.

=Passphrase=

Eine sichere GPG-Passphrase schützt Ihren privaten Schlüssel. Sie sollte mindestens 20 bis 25 Zeichen lang sein, aus mehreren unzusammenhängenden Wörtern (Passphrase) bestehen und keine leicht erratbaren persönlichen Daten enthalten. Nutzen Sie zur Erstellung idealerweise einen Passwortmanager wie KeePassXC oder Bitwarden.

=Links=
[Hardware Security Keys]

PasswortSafe

2026-06-13T12:20:03Z

Chris T. Ludwig: /* pass (Password Store) */

=Allgemeines=
Für mich ist immer noch ein Stueck Papier, evtl. geordnet in einem Rolodex die beste und sicherste Art Passwoerter zu speichern.

Passwoerter die allerdings Zugang zu weniger sensiblen Daten erlauben im einem Stueck Software zu speichern macht das Handling etwas besser.

Passwortspeicher gehoeren nicht in die Cloud!
Wenn ueberhaupt dann entsprechend mit einer Zusatzverschluesselung.

So richtig anfreunden kann ich mich bisher nur mit KeePassXC, Bitwarden und pass (Password Store).

KDEWallet benutze ich nur wenn es unbedingt sein muss. Das Programm zickt bei mir zu oft rum.

=KeePassXC=

=pass (Password Store)=

zypper in password-store

Evtl. noch password-store-dmenu, QtPass, plasma-pass, ...

Das pass init eine gpg-id verlangt, erst mal einen Sschluessel erzeugen.

gpg --full-generate-key

(9) ECC (sign and encrypt) oder (16) ECC and Kyber (Erlaeuterung siehe unten)

(1) Curve 25519 *default*

<pre>
chris@worker:~/wordlists> gpg --full-generate-key
gpg (GnuPG) 2.5.5; Copyright (C) 2025 g10 Code GmbH
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Please select what kind of key you want:
(1) RSA and RSA
(2) DSA and Elgamal
(3) DSA (sign only)
(4) RSA (sign only)
(9) ECC (sign and encrypt) *default*
(10) ECC (sign only)
(14) Existing key from card
(16) ECC and Kyber
Your selection? 9
Please select which elliptic curve you want:
(1) Curve 25519 *default*
(4) NIST P-384
(6) Brainpool P-256
Your selection? 1
Please specify how long the key should be valid.
0 = key does not expire
<n> = key expires in n days
<n>w = key expires in n weeks
<n>m = key expires in n months
<n>y = key expires in n years
Key is valid for? (0) 0
Key does not expire at all
Is this correct? (y/N) y

GnuPG needs to construct a user ID to identify your key.

Real name: Chris ................
Email address: test@clx.de
Comment: ++++++++
You selected this USER-ID:
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
gpg: directory '/home/chris/.gnupg/openpgp-revocs.d' created
gpg: revocation certificate stored as '/home/chris/.gnupg/openpgp-revocs.d/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.rev'
public and secret key created and signed.
</pre>

=Passphrase=

Eine sichere GPG-Passphrase schützt Ihren privaten Schlüssel. Sie sollte mindestens 20 bis 25 Zeichen lang sein, aus mehreren unzusammenhängenden Wörtern (Passphrase) bestehen und keine leicht erratbaren persönlichen Daten enthalten. Nutzen Sie zur Erstellung idealerweise einen Passwortmanager wie KeePassXC oder Bitwarden.

=Links=
[Hardware Security Keys]

PasswortSafe

2026-06-13T12:19:42Z

Chris T. Ludwig: /* pass (Password Store) */

=Allgemeines=
Für mich ist immer noch ein Stueck Papier, evtl. geordnet in einem Rolodex die beste und sicherste Art Passwoerter zu speichern.

Passwoerter die allerdings Zugang zu weniger sensiblen Daten erlauben im einem Stueck Software zu speichern macht das Handling etwas besser.

Passwortspeicher gehoeren nicht in die Cloud!
Wenn ueberhaupt dann entsprechend mit einer Zusatzverschluesselung.

So richtig anfreunden kann ich mich bisher nur mit KeePassXC, Bitwarden und pass (Password Store).

KDEWallet benutze ich nur wenn es unbedingt sein muss. Das Programm zickt bei mir zu oft rum.

=KeePassXC=

=pass (Password Store)=

zypper in password-store

Evtl. noch password-store-dmenu, QtPass, plasma-pass, ...

Das pass init eine gpg-id verlangt, erst mal einen Sschluessel erzeugen.

gpg --full-generate-key

(9) ECC (sign and encrypt) oder (16) ECC and Kyber (Erlaeuterung siehe unten)

(1) Curve 25519 *default*

<pre>
chris@worker:~/wordlists> gpg --full-generate-key
gpg (GnuPG) 2.5.5; Copyright (C) 2025 g10 Code GmbH
This is free software: you are free to change and redistribute it.
There is NO WARRANTY, to the extent permitted by law.

Please select what kind of key you want:
(1) RSA and RSA
(2) DSA and Elgamal
(3) DSA (sign only)
(4) RSA (sign only)
(9) ECC (sign and encrypt) *default*
(10) ECC (sign only)
(14) Existing key from card
(16) ECC and Kyber
Your selection? 9
Please select which elliptic curve you want:
(1) Curve 25519 *default*
(4) NIST P-384
(6) Brainpool P-256
Your selection? 1
Please specify how long the key should be valid.
0 = key does not expire
<n> = key expires in n days
<n>w = key expires in n weeks
<n>m = key expires in n months
<n>y = key expires in n years
Key is valid for? (0) 0
Key does not expire at all
Is this correct? (y/N) y

GnuPG needs to construct a user ID to identify your key.

Real name: Chris ................
Email address: test@clx.de
Comment: ++++++++
You selected this USER-ID:
"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? O
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
We need to generate a lot of random bytes. It is a good idea to perform
some other action (type on the keyboard, move the mouse, utilize the
disks) during the prime generation; this gives the random number
generator a better chance to gain enough entropy.
gpg: directory '/home/chris/.gnupg/openpgp-revocs.d' created
gpg: revocation certificate stored as '/home/chris/.gnupg/openpgp-revocs.d/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX.rev'
public and secret key created and signed.
/pre>

=Passphrase=

Eine sichere GPG-Passphrase schützt Ihren privaten Schlüssel. Sie sollte mindestens 20 bis 25 Zeichen lang sein, aus mehreren unzusammenhängenden Wörtern (Passphrase) bestehen und keine leicht erratbaren persönlichen Daten enthalten. Nutzen Sie zur Erstellung idealerweise einen Passwortmanager wie KeePassXC oder Bitwarden.

=Links=
[Hardware Security Keys]

PasswortSafe

2026-06-13T10:56:59Z

Chris T. Ludwig: /* Allgemeines */

PasswortSafe

2026-06-13T10:56:27Z

Chris T. Ludwig: Die Seite wurde neu angelegt: „=Allgemeines= Für mich ist immer noch ein Stueck Papier, evtl. geordnet in einem Rolodex die beste und sicherste Art Passwoerter zu speichern. Passwoerter die allerdings Zugang zu weniger sensiblen Daten erlauben im einem Stueck Software zu speichern macht das Handling etwas besser. Passwortspeicher gehoeren nicht in die Cloud! Wenn ueberhaupt dann entsprechend mit einer Zusatzverschluesselung. So richtig anfreunden kann ich mich bisher nur mit Kee…“

Auvisio GVD510

2026-06-05T18:16:08Z

Chris T. Ludwig:

<pre>
Basic Info.
Trademark
Hostlord
Company Introduction: Shenzhen HostLord Technology Development Co., Ltd is a nongovemmental enterprise integrated in research, development, production and distribution since 1999. With out own research and development institution and factory, we're trying to be an international pioneer lf digital products. At present, our leading products are involving digital camera, PC Camera, Digital Video, MP3 player, digital pen-recorder, removable memory device (flash memory, SM\MMC\SD\CF, removable HD) and etc.
Specification
CE, FCC, UL,
Origin
China
Product Description
Video Glasses (GVD-510)
Product Profile:
With big screen and high resolution display
GVD Cyberman(TM) with 40" screen and 920K pixels resolution offers you clear and exquisite pictures, which makes your watching seem true.
3D stereoscopic viewing function:
GVD supports VGA signal switching formate, compatible for hot Direct 3D games and Open GL language 3D games, which makes game players enjoy an excellent viewing environment. Furthermore, if working with other stereo-driving software, you can also enjoy 3D movies, pictures or any others.
Lots of signal input mode:
GVD are available for VGA/ S-Video/ Video and many other input mode, which can be connected to Playstation, xBox console, DVD player, PCS and etc. It meets your different requirements.
Elaborate design and portable structure
Elaborate design, light and portable structure of GVD inherit from GVD, which enables enjoying entertainment and work in whatever pose.

Product Description
Video Glasses (GVD-510)3D Video/ DVD player video player/ portable video player-40" 2m Away Video Glasses
Specifications:

Product Features:
1. Display size: 40", 2m away
2. Pixels: 640H*480V*RGB(922K)
3. Angle of view: 28 degrees
4. Video input: NTSC/PAL Composite video
5. Sound function: double channel stereo
6. Adjustment function: variable volume, picture contrast and brightness
7. AC power supply: 100V-220V/50Hz (input through adapter)
8. Power input: 9V DC
9. Basic accessories: AC adapter, eye patches, cables
10. Optional accessories: LP1100 lithium battery, PC adapting cable, wireless devices.
11. Power Consumption: 1. 5W
12. Packing size: 285 x 200 x 85mm

Product Profile:
With big screen and high resolution display
GVD510 Cyberman™ with 40" screen and 920K pixels resolution offers you clear and exquisite pictures, which makes your watching seem true.
Two versions for your option
GVD510 has two versions AV and VGA for buyer's options according to different needs, which make GVD510 meet plenty of user groups. If you need to use it with AV player, choose AV version, on the contrary choose VGA version for computer usage.
Elaborate design and portable structure
Elaborate design, light and portable structure of GVD510 inherit from GVD310 and GVD410, which enables enjoying entertainment and work in whatever pose.
Hi-capacity lithium battery for permanent power supply and convenient usage
The lithium battery LP1100 can supply power for 5 consecutive hours, making the user more convenient while traveling.

Requirements for 3D stereoscopic function:
A) PC and related compatible system.
B) Must be operated under Windows XP system.
C) Must be using nVidia series 3D picture speeding-up graphic card.
D) ForceWare display driver and 3D stereoscopic driving.

Kopin Head-Mounted 3D Display

Kopin, the largest US manufacturer of microdisplays for mobile consumer and military electronics, has unveiled the CyberMan GVD510-3D stereoscopic head-mounted display (HMD).

The GVD510-3D enables gamers and movie buffs to experience immersive stereo 3D at an affordable price. The PC-compatible headset can be used with over a thousand games and is now available to consumers worldwide for $699 (£399).

The CyberMan GVD510-3D is built on the ‘Page Flipped 3D Stereo VGA’ signal format which was developed for the LCD shutter glass system. The headset uses a signal format that is available on nVidia-based graphics cards.

In addition, the product has a automatic scaling function that makes it compatible with various VGA display output formats and it can also accept composite video and S-Video, which can be driven by the Microsoft’s Xbox, including the new Xbox 360, and Sony’s PlayStation 2 videogames console.

The coolest feature of the GVD510 Cyberman HMD is that an image should look exactly like a 40-inch screen from 6-feet away. By utilising two high-resolution (920K pixels) LCD displays, the head mounted display promises a clear and detailed images, which should help to make the viewing experience realistic.

The GVD510 Cyberman HMD is available in two different versions, AV and VGA, which are specifically configured to perform optimally in each application. If you need to use the head mounted display with an AV player, choose the AV version. If you want to use it with a computer choose the VGA version. Each head-mounted display possess the same design.

An optional high-capacity Lithium battery and charger are also provided, and the battery should last around 5 hours - plenty of time to get through a whole Lord Of The Rings movie!

Technical specifications of the headset include a resolution of 640x480 pixels, 28-degree viewing angles, NTSC and PAL composite video inputs, 2-channel stereo sound (shame there’s no surround sound), and adjustment functions (variable volume, picture contrast and brightness). More details can be found here.
</pre>

=Links=
[https://www.youtube.com/watch?v=rLVTHe9Z-ts]

Auvisio GVD510

2026-06-05T17:59:25Z

Chris T. Ludwig:

Auvisio GVD510

2026-06-05T17:48:16Z

Chris T. Ludwig:

<pre>
Basic Info.
Trademark
Hostlord
Specification
CE, FCC, UL,
Origin
China
Product Description
Video Glasses (GVD-510)
Product Profile:
With big screen and high resolution display
GVD Cyberman(TM) with 40" screen and 920K pixels resolution offers you clear and exquisite pictures, which makes your watching seem true.
3D stereoscopic viewing function:
GVD supports VGA signal switching formate, compatible for hot Direct 3D games and Open GL language 3D games, which makes game players enjoy an excellent viewing environment. Furthermore, if working with other stereo-driving software, you can also enjoy 3D movies, pictures or any others.
Lots of signal input mode:
GVD are available for VGA/ S-Video/ Video and many other input mode, which can be connected to Playstation, xBox console, DVD player, PCS and etc. It meets your different requirements.
Elaborate design and portable structure
Elaborate design, light and portable structure of GVD inherit from GVD, which enables enjoying entertainment and work in whatever pose.

Requirements for 3D stereoscopic function:
A) PC and related compatible system.
B) Must be operated under Windows XP system.
C) Must be using nVidia series 3D picture speeding-up graphic card.
D) ForceWare display drive and 3D stereoscopic driving.
</pre>

Auvisio GVD510

2026-06-05T16:48:51Z

Chris T. Ludwig: Die Seite wurde neu angelegt: „ Basic Info. Trademark Hostlord Specification CE, FCC, UL, Origin China Product Description Video Glasses (GVD-510) Product Profile: With big screen and high resolution display GVD Cyberma with 40" screen and 920K pixels resolution offers you clear and exquisite pictures, which makes your watching seem true. 3D stereoscopic viewing funtion: GVD supports VGA signal switching formate, compatible for hot Direct 3D games and Open GL language 3D games, which m…“

Basic Info.
Trademark
Hostlord
Specification
CE, FCC, UL,
Origin
China
Product Description
Video Glasses (GVD-510)
Product Profile:
With big screen and high resolution display
GVD Cyberma with 40" screen and 920K pixels resolution offers you clear and exquisite pictures, which makes your watching seem true.
3D stereoscopic viewing funtion:
GVD supports VGA signal switching formate, compatible for hot Direct 3D games and Open GL language 3D games, which makes game players enjoy an excellent viewing environment. Furthermore, if working with other stereo-driving software, you can also enjoy 3D movies, pictures or any others.
Lots of signal input mode:
GVD are available for VGA/ S-Video/ Video and many other input mode, which can be connected to Playstation, xBox console, DVD player, PCS and etc. It meets your different requirements.
Elaborate design and portable structure
Elaborate design, light and portable structure of GVD inherit from GVD, which enables enjoying entertainment and work in whatever pose.

Requirements for 3D stereoscopic function:
A) PC and related compatible system.
B) Must be operated under Windows XP system.
C) Must be using nVidia series 3D picture speeding-up graphic card.
D) ForceWare display drive and 3D stereoscopic driving.

Reolink

2026-05-20T11:21:05Z

Chris T. Ludwig: /* RLC-810A */

=Kameras=

==RLC-810A==
* Build No.build 23062505
* Hardware No.IPC_56064M8MP
* Config Versionv3.1.0.0
* Firmware Versionv3.1.0.2368_23062505
* DetailsIPC_56064M8MPS18E1W03400000008

Die von den KIs vorgeschlagene Streaming-URLs

Main Stream
rtsp://admin:password@ip_address:554/h264Preview_01_main

Sub Stream
rtsp://admin:password@ip_address:554/h264Preview_01_sub

funktionieren bei mir.

mediamtx

rtsp://192.168.178.10:8889/cam

Paketmanager zypper

2026-05-17T17:39:03Z

Chris T. Ludwig:

=Allgemeines=
Sammlung meiner oft benutzten zypper-Kommandos

zypper lr -d # list repos with details man sieht so auch die Pfade

zypper -v install --force <package> # ueberinstallieren

zypper search-packages <package>

zypper mr --enable <#>

=Nebenbeibemerkt=

[https://www.cyberciti.biz/faq/how-to-convert-man-page-to-html-on-linux-and-unix/]
[https://pandoc.org/MANUAL.html pandoc]
[https://software.opensuse.org/package/hxtools?locale=cs hxtools (man2html)]

man zypper|man2html|pandoc -f html -t mediawiki -o zypper.wiki

==pandoc==

-s standalone mit html, head, body, usw.
-o output filename
-f from format
-t to format
-r read veraltet, durch -f ersetzt
-w write veraltet, durch -t ersetzt

=Manpage=

ZYPPER(8) ZYPPER ZYPPER(8) 
 
NAME zypper - Command-line interface to ZYpp system management library (libzypp) 
 
SYNOPSIS zypper [--global-opts] command [--command-opts] [command-arguments] 
 
zypper subcommand [--command-opts] [command-arguments] 
 
zypper help command 
 
DESCRIPTION zypper is a command-line interface to ZYpp system management library (libzypp). It can be used to install, update, remove software, manage repositories, perform various queries, and more. 
 
CONCEPTS Most of the following concepts are common for all applications based on the libzypp package management library, but there are some zypper specifics. 
 
System Packages The set of installed packages on a system is sometimes denoted as repository @System or System Packages. In contrast to available repositories providing packages which can be installed, @System provides packages which can only be deleted. Installed packages which are not provided by at least one of the available repositories (neither in different version or as renamed package) are often denoted as being unwanted, orphaned or dropped. 
 
Note: If you install packages which are not shipped within a repository - manually built or downloaded ones -, collect them within a local directory and add this directory as a plaindir repository to your system. This way the packages will not be seen as being orphaned and are protected during a dist-upgrade. 
 
Creating such a plaindir repo is quite easy: $ mkdir /LocalRepo $ zypper addrepo --refresh /LocalRepo LocalRepo 
 
If you need to make sure the package to install is taken from LocalRepo, simply use a REPO:PACKAGE style argument: $ cp example.rpm /LocalRepo $ zypper install LocalRepo:example 
 
Depending on the kind of packages you keep in a local repo you may want to adjust the way GPG signature checks are performed. See section GPG checks for details. 
 
Repositories Libzypp works with repository metadata, this is information about packages and their relations extracted from RPM packages and other data like patch information, pattern definitions, etc. These data are stored together with the RPM files in folders called repositories. Repositories can be placed on various media like an HTTP or FTP server, DVD, or a folder on a local disc. 
 
There is a special set of commands in zypper intended to manipulate repositories. Also many commands and options take a repository as an argument. See section COMMANDS, subsection Repository Management for more details. 
 
GPG checks Disabling GPG checks is not recommended. Signing data enables the recipient to verify that no modifications occurred after the data were signed. Accepting data with no, wrong or unknown signature can lead to a corrupted system and in extreme cases even to a system compromise. 
 
Zypp verifies the authenticity of repository metadata by checking their GPG signature. If the repository metadata are signed with a trusted key and successfully verified, packages from this repository are accepted for installation if they match the checksum provided in the metadata. Using unsigned repositories needs to be confirmed. 
 
If the repository metadata are not signed, the GPG signature of each downloaded rpm package is checked before accepting it for installation. Packages from unsigned repositories need a valid GPG signature. Using unsigned packages needs to be confirmed. 
 
The above is the default behavior defined by settings in /etc/zypp/zypp.conf. 
 
The addrepo and modifyrepo commands provide further options to tune the behavior per repository. It is for example possible to relax the need to confirm installing unsigned packages for a specific repository. But if you do so, you should be very certain that an attacker can hardly modify the package data within the repository or on the way to your machine. See section COMMANDS for details about the command options. 
 
Resource Identifiers (URI) To specify locations of repositories or other resources (RPM files, .repo files) you can use any type of URI supported by libzypp. In addition Zypper accepts a special URI identifying openSUSE Build Service (OBS) repositories in the addrepo command. These URIs have the form of obs://project/[platform]. 
 
See section COMMANDS, subsection Repository Management for a complete list and examples of supported URI formats. 
 
Refresh Refreshing a repository means downloading metadata of packages from the medium (if needed), storing it in local cache (typically under /var/cache/zypp/raw/alias directory) and preparsing the metadata into .solv files (building the solv cache), typically under /var/cache/zypp/solv/alias. 
 
The metadata get refreshed either automatically or on user request. An automatic refresh takes place right before reading metadata from the database if the auto-refresh is enabled for the repository and the metadata is reported to be out of date. If the auto-refresh is disabled, the repository will only be refreshed on user request. You can request a refresh by calling zypper refresh (see the documentation of the refresh command for details). 
 
The repository metadata are checked for changes before actually doing the refresh. A change is detected by downloading one or two metadata index files (small files) and comparing the checksums of the cached ones and the remote ones. If the files differ, the repository is out of date and will be refreshed. 
 
To delay the up-to-date check (and thus the automatic refresh) for a certain number of minutes, edit the value of the repo.refresh.delay attribute of ZYpp config file (/etc/zypp/zypp.conf). This means, zypper will not even try to download and check the index files, and you will be able to use zypper for operations like search or info without internet access or root privileges. 
 
HINT: zypper -vv ref will show the mirrors used to download the metadata. 
 
Services Services are one level above repositories and serve to manage repositories or to do some special tasks. Libzypp currently supports Repository Index Service (RIS) and Plugin Service. 
 
Repository Index Service (RIS) is a special type of repository which contains a list of other repositories. This list can be generated dynamically by the server according to some URI parameters or user name, or can be static. Once such service is added to your system, zypper takes care of adding, modifying, or removing these repositories on your system to reflect the current list. See section Service Management and https://en.opensuse.org/openSUSE:Standards_Repository_Index_Service for more details. 
 
Package Types Zypper works with several types of resource objects, called resolvables. A resolvable might be a package, patch, pattern, product; basically any kind of object with dependencies to other objects. 
 
package An ordinary RPM package. 
 
patch A released patch conflicts with the affected/vulnerable versions of a collection of packages. As long as any of these affected/vulnerable versions are installed, the conflict triggers and the patch is classified as needed, or as unwanted if the patch is locked. 
 
Selecting the patch, the conflict is resolved by updating all installed and affected/vulnerable packages to a version providing the fix. When updating the packages zypper always aims for the latest available version. Resolved patches are classified as either applied or not needed, depending on whether they refer to actually installed packages. 
 
So installation, update or removal of packages may change the classification of patches referring to these packages. Since libyzpp-17.23.0 the /var/log/zypp/history remembers if a committed transaction changes a patchs classification. If history data are available, patch tables show a column telling since when the patch is in it’s current state. 
 
Depending on the kind of defect, patches are classified by category and severity. Commonly used values for category are security, (recommended, bugfix), (optional, feature, enhancement) document or yast. Commonly used values for severity are critical, important, moderate, low or unspecified. Names listed in parentheses are used synonymously. 
 
Note that the patch command does not apply optional patches (category optional or feature) by default. If you actually want to consider all optional patches as being needed, say patch --with-optional. Specific patches can be applied using the install command (e.g. zypper install patch:openSUSE-2014-7). 
 
If the issuer decides to retract a released patch, the patch status will be shown as retracted. The packages provided by the retracted patch are still visible but also tagged as having been retracted (R). The resolver will avoid selecting retracted packages automatically. If you are sure that a retracted package should be installed on your system, you must explicitly select it. 
 
pattern A group of packages required or recommended to install some functionality. 
 
product A group of packages which are necessary to install a product. 
 
srcpackage Source code package (.src.rpm). This type works in search and install commands. 
 
application Legacy: Since libzypp-17.7.0 this type is no longer available. 
 
Throughout this manual we will often refer to resolvables simply as packages and to resolvable types as package type or kind. These type names can be used as arguments of --type option in several commands like install, info, or search. Commands should also allow one to specify resolvables as KIND:NAME (e.g. patch:openSUSE-2014-7). 
 
Package Dependencies Software packages depend on each other in various ways. Packages usually require or recommend other packages, but they can also conflict with them. Packages may support specific hardware or language settings. Zypper uses a dependency solver to find out which packages need to be installed to satisfy the user’s request. 
 
If you do not request a specific version of a package the solver will pick a reasonable one. The solvers general attitude when resolving a job is to focus on installing the best version of the requested package and to add or update dependencies as they are needed. Aside from this Focus on Job, which is the default, two other focus modes are available: 
 
In Focus on Installed mode the solver focuses on applying as little changes to the installed packages as needed. Choosing an older version of a requested package is valid if it’s dependencies require less changes to the system. The solver will try to avoid updating already installed packages. 
 
In Focus on Update mode the solver focuses on updating the requested package and all its dependencies as much as possible. Beware, installing a single package in this mode may easily lead to a mini system update. 
 
For a single command the focus mode can be set using the --solver-focus MODE switch. Valid modes are Job, Installed or Update. If you want to change the default mode for your system, set [/etc/zypp/zypp.conf:solver.focus] to the desired value. 
 
Automatically installed packages Packages added by the dependency solver in order to resolve a user’s request are remembered as having been automatically installed. They may later be removed, if no more user installed packages depend on them (e.g. by zypper remove --clean-deps). 
 
In the Status column the search command distinguishes between user installed packages (i+) and automatically installed packages (i). 
 
Package File Conflicts File conflicts happen when two packages attempt to install files with the same name but different contents. This may happen if you are installing a newer version of a package without erasing the older version, of if two unrelated packages each install a file with the same name. 
 
As checking for file conflicts requires access to the full filelist of each package being installed, zypper will be able to check for file conflicts only if all packages are downloaded in advance (see --download-in-advance). If you are doing a --dry-run no packages are downloaded, so the file conflict check will skip packages not available in the packages cache. To get a meaningful file conflict check use --dry-run together with --download-only. 
 
As the reason for file conflicts usually is a poor package design or lack of coordination between the people building the packages, they are not easy to resolve. By using the --replacefiles option you can force zypper to replace the conflicting files. Nevertheless this may damage the package whose file gets replaced. 
 
COMMANDS zypper provides a number of commands. Each command accepts the options listed in the GLOBAL OPTIONS section. These options must be specified before the command name. In addition, many commands have specific options, which are listed in this section. These command-specific options must be specified after the name of the command and before any of the command arguments. 
 
Zypper also provides limited support for writing extensions/subcommands in any language. See section SUBCOMMANDS for details. 
 
General Commands help [command] Shows help texts. If invoked without any argument (just zypper or zypper help), zypper displays global help text which lists all available global options and commands. 
 
If invoked with a command name argument, zypper displays help for the specified command, if such command exists. Long as well as short variants of the command names can be used. 
 
For your convenience, zypper help can also be invoked in any of the following ways: 
 
$ zypper -h|--help [command] 
 
$ zypper [command] -h|--help 
 
shell (sh) Starts a shell for entering multiple commands in one session. Exit the shell using exit, quit, or Ctrl-D. 
 
The shell support is not complete so expect bugs there. However, there’s no urgent need to use the shell since libzypp became so fast thanks to the SAT solver and its tools (openSUSE 11.0), but still, you’re welcome to experiment with it. 
 
Package Management Commands info (if) [options] name[-version[-release]]... Show detailed information for specified packages. By default, only packages that exactly match the provided names are shown. To include packages that partially match, use the --match-substrings option or wildcards (* or ?) within the name. 
 
If no version constraint is specified, information about the best available package is shown. Note that both the version and release numbers must always match exactly. 
 
If a query returns no results, zypper returns ZYPPER_EXIT_INF_CAP_NOT_FOUND unless the global option --ignore-unknown is set. 
 
-s, --match-substrings Include packages that partially match the provided names. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number or URI. This option can be used multiple times. 
 
-t, --type type Type of package (default: package). See section Package Types for list of available package types. 
 
--provides Show symbols the package provides. 
 
--requires Show symbols the package requires. 
 
--conflicts Show symbols the package conflicts with. 
 
--obsoletes Show symbols the package obsoletes. 
 
--recommends Show symbols the package recommends. 
 
--suggests Show symbols the package suggests. 
 
--supplements Show symbols the package supplements. 
 
--enhances Show symbols the package enhances. 
 
Examples: 
 
$ zypper info workrave Show information about package workrave 
 
$ zypper info -t patch libzypp Show information about patch libzypp 
 
$ zypper info -t pattern lamp_server Show information about pattern lamp_server 
 
install (in) [options] name|capability|rpm_file_uri... Install or update packages. 
 
The packages can be selected by their name or by a capability they provide. 
 
A capability is formed by "NAME[.ARCH][ OP EDITION]", where ARCH is an architecture code, OP is one of <, <=, =, >=, or > and EDITION is "VERSION[-RELEASE]". For example: zypper=0.8.8-2. 
 
The NAME component of a capability is not only a package name but any symbol provided by packages: /bin/vi, libcurl.so.3, perl(Time::ParseDate). Just remember to quote to protect the special characters from the shell, for example: zypper\>0.8.10 or 'zypper>0.8.10'. 
 
If EDITION is not specified, the newest installable version will be installed. This also means that if the package is already installed and newer versions are available, it will get upgraded to the newest installable version. 
 
If ARCH is not specified, or the last dot of the capability name string is not followed by known architecture, the solver will treat the whole string as a capability name. If the ARCH is known, the solver will select a package matching that architecture and complain if such package cannot be found. 
 
If you want to make sure a package from a specific REPOSITORY is picked, use REPOSITORY:PACKAGENAME as argument. 
 
Zypper is also able to install plain RPM files while trying to satisfy their dependencies using packages from defined repositories. You can install a plain RPM file by specifying its location in the install command arguments either as a local path or an URI. E.g.: 
 
$ zypper install ~/rpms/foo.rpm http://some.site/bar.rpm 
 
Zypper will report packages that it cannot find. Further, in interactive mode, zypper proceeds with installation of the rest of requested packages, and it will abort immediately in non-interactive mode. In both cases zypper returns ZYPPER_EXIT_INF_CAP_NOT_FOUND after finishing the operation. 
 
Zypper will collect the files in a temporary plaindir repository and mark the respective packages for installation. If --download-only is used, the downloaded packages will be available in /var/cache/zypper/RPMS until you actually install them or call zypper clean to clear the package caches. They will not become part of the global package cache at /var/cache/zypp/packages (see also the global --pkg-cache-dir option). 
 
In the install command, you can also specify packages you wish to remove by prepending their names by a - or ! character. For example: 
 
$ zypper install \!Firefox 
 
In contrast to zypper remove Firefox which removes Firefox and its dependent packages, the install command will try to keep dependent packages installed by looking for Firefox alternatives. 
 
Note that if you choose to use - with the first package you specify, you need to write -- before it to prevent its interpretation as a command option: 
 
$ zypper install -- -boring-game great-game great-game-manual 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number or URI. This option can be used multiple times. 
 
Using --repo is discouraged as it currently hides unmentioned repositories from the resolver, leading to inexpertly decisions. In the future --repo will become an alias for --from. 
 
If you want to install a package from a specific repository, use REPOSITORY:PACKAGENAME as argument. 
 
-t, --type type Type of package to install (default: package). See section Package Types for list of available package types. Use zypper se -t type [name] to look for available items of this type and zypper info -t type name to display more detailed information about the item. 
 
If patch is specified, zypper will install and/or remove packages to satisfy specified patch. This is a way to ensure that specific bug fix is installed. Use zypper list-patches to look for applicable patches. 
 
If product or pattern are specified, zypper ensures that all required (and optionally recommended) packages are installed. 
 
-n, --name Select packages by their name, don’t try to select by capabilities. 
 
-f, --force Install even if the item is already installed (reinstall), downgraded or changes vendor or architecture. 
 
--oldpackage Allows one to replace a newer item with an older one. Handy if you are doing a rollback. Unlike --force it will not enforce a reinstall, if the item is already installed with the requested version. 
 
--from alias|name|#|URI Select packages from specified repository. If strings specified as arguments to the install command match packages in repositories specified in this option, they will be marked for installation. This option currently implies --name, but allows using wildcards for specifying packages. 
 
-C, --capability Select packages by capabilities. 
 
-l, --auto-agree-with-licenses Automatically say yes to third party license confirmation prompt. By using this option, you choose to agree with licenses of all third-party software this command will install. This option is particularly useful for administrators installing the same set of packages on multiple machines (by an automated process) and have the licenses confirmed before. 
 
--auto-agree-with-product-licenses Automatically accept product licenses only. This is used by tools like SUSEconnect, which ask for confirmation before the product gets registered. So there’s no need to confirm the product license again at install time. 
 
--replacefiles Install the packages even if they replace files from other, already installed, packages. Default is to treat file conflicts as an error. --download-as-needed disables the file conflict check because access to all packages file lists is needed in advance in order to perform the check. 
 
-D, --dry-run Test the installation, do not actually install any package. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts). 
 
--details Show the detailed installation summary. 
 
-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command. 
 
--allow-unsigned-rpm Silently install unsigned .rpm packages given as commandline parameters. The option does not affect unsigned packages provided by repositories. To allow a repository to provide unsigned packages without explicit confirmation, set the repositories --gpgcheck-allow-unsigned-package option. See the addrepo and modifyrepo commands for details. 
 
Solver related options: 
 
--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report. 
 
--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking. 
 
In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments. 
 
The allowance to remove dependent packages is the default when removing packages (zypper remove). 
 
-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove). 
 
--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details. 
 
--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
Download-and-install mode options: 
 
-d, --download-only Only download the packages for later installation (see also the global --pkg-cache-dir option). 
 
If used together with --dry-run a meaningful file conflict check can be performed (see section Package File Conflicts). 
 
--download-in-advance First download all packages, then start installing. This is the default. 
 
--download-in-heaps Download a minimal set of packages that can be installed without leaving the system in broken state, and install them. Then download and install another heap until all are installed. This helps to keep the system in consistent state without the need to download all packages in advance, which combines the advantages of --download-in-advance and --download-as-needed. 
 
Note 
 
While the resolver is not capable of building heaps, this behaves the same as --download-in-advance. 
 
--download-as-needed Download one package, install it immediately, and continue with the rest until all are installed. 
 
--download mode Use the specified download-and-install mode. Available modes are: only, in-advance, in-heaps, as-needed. See corresponding --download-mode options for their description. 
 
Expert Options: Don’t use them unless you know you need them. 
 
--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables. 
 
--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed. 
 
--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables. 
 
--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa). 
 
Examples: 
 
$ zypper install -t pattern lamp_server Install lamp_server pattern. 
 
$ zypper install --no-recommends gv Install GhostScript viewer, but ignore recommended packages. 
 
$ zypper install virtualbox-ose-2.0.6 
 
$ zypper install virtualbox-ose=2.0.6 
 
$ zypper install virtualbox-ose = 2.0.6 Install version 2.0.6 of virtualbox-ose package. 
 
source-install (si) name... Install specified source packages and their build dependencies. If the name of a binary package is given, the corresponding source package is looked up and installed instead. 
 
This command will try to find the newest available versions of the source packages and uses rpm -i to install them, optionally together with all the packages that are required to build the source package. The default location where rpm installs source packages to is /usr/src/packages/{SPECS,SOURCES}, but the values can be changed in your local rpm configuration. In case of doubt try executing rpm --eval "%{_specdir} and %{_sourcedir}". 
 
Note that the source packages must be available in repositories you are using. You can check whether a repository contains any source packages using the following command: 
 
$ zypper search -t srcpackage -r alias|name|#|URI 
 
$ zypper search -t srcpackage -r alias|name|#|URI 
 
-d, --build-deps-only Install only build dependencies of specified packages. 
 
-D, --no-build-deps Don’t install build dependencies. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
--download-only Only download the packages, do not install. 
 
Examples: 
 
$ zypper si -d dbus-1 Install build dependencies of dbus-1 source package. 
 
verify (ve) [options] Check whether dependencies of installed packages are satisfied. 
 
In case that any dependency problems are found, zypper suggests packages to install or remove to fix them. 
 
-D, --dry-run Test the repair, do not actually do anything to the system. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts). 
 
--details Show the detailed installation summary. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command. 
 
Solver related options: 
 
--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report. 
 
--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking. 
 
In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments. 
 
The allowance to remove dependent packages is the default when removing packages (zypper remove). 
 
-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove). 
 
--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details. 
 
--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
Expert Options: Don’t use them unless you know you need them. 
 
--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables. 
 
--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed. 
 
--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables. 
 
--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa). 
 
This command also accepts the Download-and-install mode options described in the install command. 
 
install-new-recommends (inr) [options] Install newly added packages recommended by already installed ones. This command basically re-evaluates the recommendations of all installed packages and fills up the system accordingly. You don’t want to call this unconditionally on small or minimal systems, as it may easily add a large number of packages. 
 
Called as zypper inr --no-recommends, it restricts the command to just look for packages supporting available hardware, languages or filesystems. Useful after having added e.g. new hardware or driver repos. This is also the default behavior if you have set [zypp.conf:solver.onlyRequires]. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
-D, --dry-run Test the installation, do not actually install anything. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts). 
 
--details Show the detailed installation summary. 
 
Solver related options: 
 
--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report. 
 
--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking. 
 
In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments. 
 
The allowance to remove dependent packages is the default when removing packages (zypper remove). 
 
-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove). 
 
--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details. 
 
--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
Expert Options: Don’t use them unless you know you need them. 
 
--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables. 
 
--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed. 
 
--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables. 
 
--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa). 
 
This command also accepts the Download-and-install mode options described in the install command. 
 
remove (rm) [options] name... 
 
remove (rm) [options] --capability capability... Remove (uninstall) packages. 
 
The remove command will uninstall the selected and their dependent packages. It will not try to install alternatives in order to keep dependent packages installed. If you want this, use zypper install !name. 
 
The packages can be selected by their name or by a capability they provide. For details on package selection see the install command description. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
-t, --type type Type of package (default: package). See section Package Types for list of available package types. 
 
Since patches are not installed in sense of copying files or recording a database entry, they cannot be uninstalled, even though zypper shows them as installed. The installed status is determined solely based on the installed status of its required dependencies. If these dependencies are satisfied, the patch is rendered installed. 
 
-n, --name Select packages by their name (default). 
 
-C, --capability Select packages by capabilities. 
 
-D, --dry-run Test the removal of packages, do not actually remove anything. 
 
--details Show the detailed installation summary. 
 
-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command. 
 
Solver related options: 
 
--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report. 
 
--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking. 
 
In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments. 
 
The allowance to remove dependent packages is the default when removing packages (zypper remove). 
 
-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove). 
 
--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details. 
 
-u, --clean-deps Automatically remove dependencies which become unneeded after removal of requested packages. 
 
-U, --no-clean-deps No automatic removal of unneeded dependencies. 
 
removeptf (rmptf) [options] <PTF|CAPABILITY> ... Remove (not only) PTFs. 
 
A remove command which prefers replacing dependant packages to removing them as well. In fact this is a full featured install command with the remove modifier (-) applied to its plain arguments. So removeptf foo is the same as install — -foo. This is why the command accepts the same options as the install command. It is the recommended way to remove a PTF (Program Temporary Fix). 
 
A PTF is typically removed as soon as the fix it provides is applied to the latest official update of the dependant packages. But you don’t want the dependant packages to be removed together with the PTF, which is what the remove command would do. The removeptf command however will aim to replace the dependant packages by their official update versions. 
 
supports every option the install command supports 
 
purge-kernels [options] Autoremoves installed kernels. 
 
Automatically cleans up installed kernels according to the rules defined in [zypp.conf:multiversion.kernels] which can be given as <version>, latest[-N], running, oldest[+N]. 
 
--details Show the detailed installation summary. 
 
-D, --dry-run Test the removal of packages, do not actually remove anything. 
 
Update Management Commands list-updates (lu) [options] List available updates. 
 
This command will list only installable updates, i.e. updates which have no dependency problems, or which do not change package vendor. This list is what the update command will propose to install. To list all packages for which newer version are available, use --all option. 
 
-t, --type type Type of package (default: package). See section Package Types for list of available package types. 
 
If patch is specified, zypper acts as if the list-patches command was executed. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
-a, --all List all packages for which newer versions are available, regardless whether they are installable or not. 
 
--best-effort See the update command for description. 
 
Expert Options: Don’t use them unless you know you need them. 
 
--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables. 
 
--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed. 
 
--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables. 
 
--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa). 
 
update (up) [options] [packagename]... Update installed packages with newer versions, where possible. 
 
This command will not update packages which would require change of package vendor unless the vendor is specified in /etc/zypp/vendors.d, or which would require manual resolution of problems with dependencies. Such non-installable updates will then be listed in separate section of the summary as "The following package updates will NOT be installed:". 
 
To update individual packages, specify one or more package names. You can use the * and ? wildcard characters in the package names to specify multiple packages matching the pattern. 
 
-t, --type type Type of package (default: package). See section Package Types for list of available package types. 
 
If patch is specified, zypper acts as if the patches command was executed. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
--skip-interactive This will skip interactive patches, that is, those that need reboot, contain a message, or update a package whose license needs to be confirmed. 
 
--with-interactive Avoid skipping of interactive patches when in non-interactive mode. 
 
-l, --auto-agree-with-licenses Automatically say yes to third party license confirmation prompt. By using this option, you choose to agree with licenses of all third-party software this command will install. This option is particularly useful for administrators installing the same set of packages on multiple machines (by an automated process) and have the licenses confirmed before. 
 
--auto-agree-with-product-licenses Automatically accept product licenses only. This is used by tools like SUSEconnect, which ask for confirmation before the product gets registered. So there’s no need to confirm the product license again at install time. 
 
--replacefiles Install the packages even if they replace files from other, already installed, packages. Default is to treat file conflicts as an error. --download-as-needed disables the fileconflict check because access to all packages filelists is needed in advance in order to perform the check. 
 
-D, --dry-run Test the update, do not actually install or update any package. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts). 
 
--details Show the detailed installation summary. 
 
--best-effort Do a best effort approach to update. This method does not explicitly select packages with best version and architecture, but instead requests installation of a package with higher version than the installed one and leaves the rest on the dependency solver. This method is always used for packages, and is optional for products and patterns. It is not applicable to patches. 
 
-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command. 
 
Solver related options: 
 
--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report. 
 
--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking. 
 
In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments. 
 
The allowance to remove dependent packages is the default when removing packages (zypper remove). 
 
-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove). 
 
--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details. 
 
--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
Expert Options: Don’t use them unless you know you need them. 
 
--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables. 
 
--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed. 
 
--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables. 
 
--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa). 
 
This command also accepts the Download-and-install mode options described in the install command description. 
 
list-patches (lp) [options] List all applicable patches. 
 
This command is similar to zypper list-updates -t patch. 
 
Note that optional arguments of some of the following options must be specified using = instead of a space. 
 
-b, --bugzilla[=#[,...]] List applicable patches for all Bugzilla issues, or issues whose number matches the given string. 
 
--cve[=#[,...]] List applicable patches for all CVE issues, or issues whose number matches the given string. 
 
--date YYYY-MM-DD[,...] List only patches issued up to, but not including, the specified date. 
 
-g, --category category[,...] List only patches with this category. See section Package Types for a list of commonly used category values. 
 
--severity severity[,...] List only patches with this severity. See section Package Types for a list of commonly used severity values. 
 
--issue[=string[,...]] Look for issues whose number, summary, or description matches the specified string. Issues found by number are displayed separately from those found by descriptions. In the latter case, use zypper patch-info patchname to get information about issues the patch fixes. 
 
-a, *--all By default, only patches that are applicable on your system are listed. This option causes all available released patches to be listed. This option can be combined with all the rest of the list-updates command options. 
 
--with-optional, --without-optional Whether applicable optional patches should be treated as needed or be excluded. The default is to exclude optional patches. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
patch-check (pchk) Check for patches. Displays a count of applicable patches and how many of them have the security category. 
 
See also the EXIT CODES section for details on exit status of 0, 100, and 101 returned by this command. 
 
--updatestack-only Check only for patches which affect the package management itself. 
 
--with-optional, --without-optional Whether applicable optional patches should be treated as needed or be excluded. The default is to exclude optional patches. 
 
-r, --repo alias|name|#|URI Check for patches only in the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
patch [options] Install all available needed patches. 
 
When updating the affected/vulnerable packages described by a patch, zypper always aims for the latest available version. See section Package Types for more details about how patches operate. 
 
If there are patches that affect the package management itself, those will be installed first and you will be asked to run the patch command again. 
 
This command is similar to zypper update -t patch. 
 
--updatestack-only Install only patches which affect the package management itself and exit. 
 
--skip-not-applicable-patches Skip needed patches which do not apply without conflict. In normal operation mode those conflicts have to be resolved interactively, otherwise the patch command fails. 
 
In scripted and unattended environments it may be desired to try to apply at least as many patches as possible so the system is not left completely without updates. It is highly recommended to run zypper patch-check afterwards in order to see whether needed patches are still waiting to be resolved interactively. 
 
--with-update Additionally try to update all packages not covered by patches. This is basically the same as running zypper update afterwards. 
 
The option is ignored, if the patch command must update the update stack first, thus it can not be combined with the --updatestack-only option. 
 
--with-optional, --without-optional Whether applicable optional patches should be treated as needed or be excluded. The default is to exclude optional patches. 
 
-b, --bugzilla #[,...] Select applicable patches for a Bugzilla issue specified by number. Use list-patches --bugzilla command to get a list of applicable patches for specific issues. 
 
--cve #[,...] Select applicable patches for a MITRE’s CVE issue specified by number. Use list-patches --cve command to get a list of applicable patches for specific issues. 
 
--date YYYY-MM-DD[,...] Select only patches patches issued up to, but not including, the specified date. 
 
-g, --category category[,...] Select only patches with this category. Use list-patches --category command to get a list of available patches with a specific category. See section Package Types for a list of commonly used category values. 
 
--severity severity[,...] Select only patches with this severity. Use list-patches --severity command to get a list of available patches with a specific severity. See section Package Types for a list of commonly used severity values. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
--skip-interactive This will skip interactive patches, that is, those that need reboot, contain a message, or update a package whose license needs to be confirmed. 
 
--with-interactive Avoid skipping of interactive patches when in non-interactive mode. 
 
-l, --auto-agree-with-licenses Automatically say yes to third party license confirmation prompt. By using this option, you choose to agree with licenses of all third-party software this command will install. This option is particularly useful for administrators installing the same set of packages on multiple machines (by an automated process) and have the licenses confirmed before. 
 
--auto-agree-with-product-licenses Automatically accept product licenses only. This is used by tools like SUSEconnect, which ask for confirmation before the product gets registered. So there’s no need to confirm the product license again at install time. 
 
--replacefiles Install the packages even if they replace files from other, already installed, packages. Default is to treat file conflicts as an error. --download-as-needed disables the fileconflict check because access to all packages filelists is needed in advance in order to perform the check. 
 
-D, --dry-run Test the update, do not actually update. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts). 
 
--details Show the detailed installation summary. 
 
-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command. 
 
Solver related options: 
 
--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report. 
 
--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking. 
 
In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments. 
 
The allowance to remove dependent packages is the default when removing packages (zypper remove). 
 
-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove). 
 
--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details. 
 
--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
Expert Options: Don’t use them unless you know you need them. 
 
--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables. 
 
--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed. 
 
--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables. 
 
--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa). 
 
This command also accepts the Download-and-install mode options described in the install command description. 
 
dist-upgrade (dup) [options] Perform a distribution upgrade. This command applies the state of (specified) repositories onto the system; upgrades (or even downgrades) installed packages to versions found in repositories, removes packages that are no longer in the repositories and pose a dependency problem for the upgrade, handles package splits and renames, etc. 
 
If no repositories are specified via the --from option, zypper will do a global upgrade with all defined repositories. This global form of dup will also consider unchanged installed packages and re-evaluate their dependencies. This can be a problem if the system contains conflicting repositories, like repositories for two different distribution releases. This often happens if one forgets to remove an older release repository after adding a new one, say openSUSE 13.1 and openSUSE 13.2. 
 
For all repositories which have the distribution version within their URL (like https://download.opensuse.org/distribution/13.1/repo/oss) using the $releasever variable instead may be helpful (https://download.opensuse.org/distribution/$releasever/repo/oss). The variable is per default substituted by the current distributions version (13.1). 
 
This value can be temporarily overwritten in the current zypper command by using the --releasever global option. Calling zypper --releasever 13.2... will cause these repos to use the new location (https://download.opensuse.org/distribution/13.2/repo/oss) without the need to add/remove anything. But you’ll need to use --releasever 13.2 with every zypper command until the distribution upgrade was actually performed. Once the dup is done, $releasever will default to the new distribution version 13.2 and --releasever is no longer needed. 
 
It might be less tedious to persistently set $releasever to the target distribution value, so --releasever is not needed at all. See section Repository Management for more info about variable substitution and the definition of custom variables. 
 
Note: Performing a distribution upgrade will automatically create a solver test case at /var/log/updateTestcase-YYYY-MM-DD-hh-mm-ss (the date and time the command was executed). 
 
Note: distribution upgrades in openSUSE are currently only supported between consecutive releases. To upgrade multiple releases, upgrade each consecutive release one at a time. For more details see http://en.opensuse.org/SDB:System_upgrade and the openSUSE release notes at http://doc.opensuse.org/release-notes/. 
 
Note: Due to the treatment of orphaned packages dist-upgrade depends on a proper repository setup more than any other command. It must not continue if enabled repositories fail to refresh. This may severely damage the system. If a failing repository is actually not needed, it must be disabled. 
 
--from alias|name|#|URI The option can be used multiple times and restricts the upgrade to the specified repositories only. Nevertheless all enabled repositories are visible to the resolver and will be considered to satisfy dependency problems. 
 
--remove-orphaned Remove orphaned packages. Installed packages which are not provided by at least one of the available repositories are considered to be orphaned or dropped. dist-upgrade removes orphaned packages if they prevent the upgrade of wanted packages. With this option all unneeded orphaned packages are removed. 
 
'Note:' Packages which are not shipped within a repository - manually built or downloaded ones -, can be collected in a plaindir repository to prevent them from being treated as orphaned. See section *System Packages* for details. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. 
 
Using --repo is discouraged as it currently hides unmentioned repositories from the resolver, leading to inexpertly decisions. This is because packages originally installed from the hidden repos will now be treated as orphaned or dropped. They can be silently removed if involved in a dependency conflict. In the future --repo will become an alias for --from. 
 
-l, --auto-agree-with-licenses Automatically say yes to third party license confirmation prompt. By using this option, you choose to agree with licenses of all third-party software this command will install. This option is particularly useful for administrators installing the same set of packages on multiple machines (by an automated process) and have the licenses confirmed before. 
 
--auto-agree-with-product-licenses Automatically accept product licenses only. This is used by tools like SUSEconnect, which ask for confirmation before the product gets registered. So there’s no need to confirm the product license again at install time. 
 
--replacefiles Install the packages even if they replace files from other, already installed, packages. Default is to treat file conflicts as an error. --download-as-needed disables the fileconflict check because access to all packages filelists is needed in advance in order to perform the check. 
 
-D, --dry-run Test the upgrade, do not actually install or update any package. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts). 
 
-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command. 
 
--details Show the detailed installation summary. 
 
Solver related options: 
 
--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report. 
 
--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking. 
 
In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments. 
 
The allowance to remove dependent packages is the default when removing packages (zypper remove). 
 
-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove). 
 
--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details. 
 
--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires]. 
 
Expert Options: Don’t use them unless you know you need them. 
 
--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables. 
 
--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed. 
 
--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables. 
 
--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa). 
 
This command also accepts the Download-and-install mode options described in the install command description. 
 
Examples: 
 
$ zypper dup --from factory --from packman Upgrade the system to the latest versions provided by the factory and packman repositories. 
 
Query Commands search (se) [options] [querystring|capability]... Search for packages matching any of the given search strings. * and ? wildcard characters can be used within search strings. If the search string is enclosed in / (e.g. /^k.*e$/) it’s interpreted as a regular expression. See the install command for details about how to specify a capability. 
 
If the search string starts with a /, a filename is assumed and the search will automatically look into the file list of packages. Otherwise use -f to search in the packages file lists as well. 
 
Results of the search are printed in a table with columns Status, Name, Summary and Type of package. In case the query result is empty zypper returns ZYPPER_EXIT_INF_CAP_NOT_FOUND, unless the --ignore-unknown global option is set. 
 
In the detailed view (se -s) all available instances of matching packages are shown; each version in each repository on a separate line, with columns Status, Name, Type, Version, Architecture and Repository. For installed packages Repository shows either a repository that provides exactly the installed version of the package, or, if the exact version is not provided by any known repo, (System Packages) (or @System). Those installed packages not provided by any repo are often denoted as being unwanted, orphaned or dropped. 
 
The Status column can contain the following values: 
 
i+ installed by user request 
 
i installed automatically (by the resolver, see section Automatically installed packages) 
 
v a different version is installed 
 
empty neither of the above cases 
 
! a patch in needed state 
 
.l is shown in the 2nd column if the item is locked (see section Package Locks Management) 
 
.P is shown in the 2nd column if the item is part of a PTF (A program temporary fix which must be explicitly selected and will otherwise not be considered in dependency resolution). 
 
.R is shown in the 2nd column if the item has been retracted (see patch in section Package Types) 
 
The v status is only shown if the version or the repository matters (see --details or --repo), and the installed instance differs from the one listed in version or repository. 
 
The verbose view (se -v; implies -s) will also show the matches themselves within the packages metadata. 
 
This command accepts the following options: 
 
--match-substrings Matches for search strings may be partial words (default). 
 
--match-words Matches for search strings may only be whole words. 
 
-x, --match-exact Searches for an exact name of the package. 
 
--provides Search for packages which provide the search strings. 
 
--requires Search for packages which require the search strings. 
 
--recommends Search for packages which recommend the search strings. 
 
--suggests Search for packages which suggest the search strings. 
 
--conflicts Search for packages conflicting with the search strings. 
 
--obsoletes Search for packages which obsolete the search strings. 
 
--supplements Search for packages which supplement the search strings. 
 
--enhances Search for packages which enhances the search strings. 
 
--provides-pkg Search for all packages that provide any of the provides of the package(s) matched by the input parameters. 
 
--requires-pkg Search for all packages that require any of the provides of the package(s) matched by the input parameters. 
 
--recommends-pkg Search for all packages that recommend any of the provides of the package(s) matched by the input parameters. 
 
--supplements-pkg Search for all packages that supplement any of the provides of the package(s) matched by the input parameters. 
 
--conflicts-pkg Search for all packages that conflict with any of the package(s) matched by the input parameters. 
 
--obsoletes-pkg Search for all packages that obsolete any of the package(s) matched by the input parameters. 
 
--suggests-pkg Search for all packages that suggest any of the provides of the package(s) matched by the input parameters. 
 
--enhances-pkg Search for all packages that enhance any of the provides of the package(s) matched by the input parameters. 
 
-n, --name Useful together with dependency options, otherwise searching in package name is default. 
 
-f, --file-list Search in the file list of packages. Note that the full file list is available for installed packages only. For remote packages only an abstract of their file list is available within the metadata (files containing /etc/, /bin/, or /sbin/). 
 
-d, --search-descriptions Search also in summaries and descriptions. 
 
-C, --case-sensitive Perform case-sensitive search. 
 
-i, --installed-only Show only installed packages. 
 
-u, --not-installed-only Show only packages which are not installed. 
 
The old option name --uninstalled-only is still acceptable, but should be considered deprecated. 
 
-t, --type type Search only for packages of specified type. See section Package Types for a list of available package types. Multiple --type options are allowed. 
 
See also the type-specific query commands like packages, patterns, etc. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times. 
 
--sort-by-name Sort packages by name (default). 
 
--sort-by-repo Sort packages by repository, not by name. 
 
-s, --details Show all available versions of matching packages, each version in each repository on a separate line. 
 
-v, --verbose Like --details with additional information where the search has matched (useful when searching for dependencies, e.g. --provides). 
 
Examples: 
 
$ zypper se 'yast*' Search for YaST packages (quote the string to prevent the shell from expanding the wildcard). 
 
$ zypper se -s --match-exact kernel-default Show all available versions of package kernel-default 
 
$ zypper se -dC --match-words RSI Look for RSI acronym (case-sensitively), also in summaries and descriptions. 
 
packages (pa) [options] [repository]... List all available packages or all packages from specified repositories. Similar to zypper search -s -t package. 
 
-r, --repo alias|name|#|URI Just another means to specify repositories. 
 
-i, --installed-only Show only installed packages. 
 
-u, --not-installed-only Show only packages which are not installed. 
 
The old option name --uninstalled-only is still acceptable, but should be considered deprecated. 
 
*--autoinstalled Show installed packages which were automatically selected by the resolver. 
 
--userinstalled Show installed packages which were explicitly selected by the user. 
 
--system Show installed packages which are not provided by any repository. 
 
--orphaned Show system packages which are orphaned (without repository and without update candidate). If combined with --system, the status of orphaned packages is tagged with (o). 
 
--suggested Show packages which are suggested. 
 
--recommended Show packages which are recommended. 
 
--unneeded Show packages which are unneeded. 
 
patches (pch) [options] [repository]... List all available patches from specified repositories, including those not needed. Short for zypper lp -a. 
 
-r, --repo alias|name_|#|URI Just another means to specify repositories. 
 
patterns (pt) [options] [repository]... List all available patterns or all patterns from specified repositories. Similar to zypper search -s -t pattern. 
 
-r, --repo alias|name|#|URI Just another means to specify repositories. 
 
-i, --installed-only Show only installed patterns. 
 
-u, --not-installed-only Show only patterns which are not installed. 
 
The old option name --uninstalled-only is still acceptable, but should be considered deprecated. 
 
products (pd) [options] [repository]... List all available products or all products from specified repositories. Similar to zypper search -s -t product, but shows also the type of the product (base, add-on). 
 
-r, --repo alias|name|#|URI Just another means to specify repositories. 
 
-i, --installed-only Show only installed products. 
 
-u, --not-installed-only Show only products which are not installed. 
 
The old option name --uninstalled-only is still acceptable, but should be considered deprecated. 
 
--xmlfwd tag XML output only: Literally forward the XML tag, if it is found in an installed products .prod-file (in /etc/products.d). 
 
Using this option, for each installed product an <xmlfwd> node will be created inside the <product> output node of the product. 
 
Tag defines the name (or /-separated path) of a xml-tag inside an installed products .prod-file. If the tag is present inside the products .prod-file, the tag and it’s content is literally forwarded into the products <xmlfwd> output node. 
 
The option may be specified multiple times. 
 
Examples: 
 
$ zypper -x pd --xmlfwd name --xmlfwd register/target 
 
what-provides (wp) capability List all packages providing the specified capability (case-insensitive search). See also the install command for info about specifying capabilities. 
 
The command line is automatically transformed into the corresponding search command: 
 
$ zypper what-provides 'zypper>1.6' $ zypper search --provides --match-exact 'zypper>1.6' 
 
For a case-sensitive search call $ zypper search --provides --match-exact --case-sensitive 'zypper>1.6' 
 
Repository Management Zypper is able to work with YaST, RPM-MD (yum) software repositories, and plain directories containing .rpm files (no symlinks). 
 
Repositories are primarily identified using their URI or alias. Alias serves as a shorthand for the long URI or name of the repository. The name of the repository should briefly describe the repository and is shown to the user in tables and messages. The name is not required, and if not known, the alias is shown instead. The alias is required and uniquely identifies the repository on the system. 
 
The alias, name, URI, or the number from zypper repos list can be used to specify a repository as an argument of various zypper commands and options like refresh, --repo, or --from. 
 
Apart from the above, repositories have several other properties which can be set using the commands described in this section below, or by manually editing the repository definition files (.repo files, see section FILES). 
 
Variable substitution: You can use the following variables within a .repo or .service files name and URI values: 
 
$arch Use this variable to refer to the system’s CPU architecture. 
 
$basearch Use this variable to refer to the base architecture of the system. For example, iX86 machines have a base architecture of i386, while AMD64 and Intel64 have x86_64. 
 
$releasever, $releasever_major, $releasever_minor Use this variable to refer to the version of your openSUSE or SUSE Linux. The value is obtained from the /product/version XML-node in /etc/products.d/baseproduct. 
 
This is useful for related repositories like packman (http://ftp.gwdg.de/pub/linux/packman/suse/$releasever), which shall always fit the installed distribution, even after a distribution upgrade. 
 
To help performing a distribution upgrade, the value of $releasever can be persistently set to a user defined value by creating a custom variable with that name (see below). This way you can easily switch all repositories using $releasever to the new version (provided the server layouts did not change and new repos are already available). 
 
For a single zypper command the value of $releasever can be temporarily overwritten by using the --releasever global option. 
 
In addition $releasever_major will be set to the leading portion up to (but not including) the 1st dot; $releasever_minor to the trailing portion after the 1st dot. If there’s no dot in $releasever, $releasever_major is the same as $releasever and $releasever_minor is empty. 
 
Custom Variables A custom repository variable is defined by creating a file in /etc/zypp/vars.d. The variable name equals the file name. The files first line (up to but not including the newline character) defines the variables value. Valid variable(file) names consist of alphanumeric chars and underscore only. 
 
This is how you can set a custom variable, e.g. $releasever to a value of 99.0: echo "99.0" >/etc/zypp/vars.d/releasever 
 
To remove the custom variable, simply delete its file in /etc/zypp/vars.d: rm /etc/zypp/vars.d/releasever 
 
To check where you already use $releasever call: zypper --releasever @--HERE--@ lr -u 
 
Remember to protect the $ when using these variables on a shell command line: zypper ar -f http://ftp.gwdg.de/pub/linux/packman/suse/\$releasever packman 
 
If a variable is followed by an alphanumeric character or underscore it needs to be enclosed in {}: zypper ar -f http://ftp.gwdg.de/pub/linux/packman/suse/\${releasever}_packman 
 
Bash style definition of default ${variable:-word} and alternate ${variable:+word} values: SLE-${releasever_major}${releasever_minor:+-SP-$releasever_minor} 
 
NOTE: Variable substitution within an URIs authority is limited to host and port. Bash style definition of default and alternate values is not supported. No variables can be used in an URIs scheme, user and password. 
 
Supported URI formats: scheme:@]host[:port]]/path[?query][#fragment] Special characters occurring in URI components (like a '@' in a password) must be %-encoded ('%40'). 
 
CD or DVD drive Optionally with devices list for probing. 
 
• cd:/// dvd:/subdir?devices=/dev/sr0,/dev/sr1 
 
FTP/HTTP/HTTPS directory tree The ftp URL scheme supports absolute and relative paths to the default ftp server directory (RFC1738, Section 3.2.2). To use an absolute path, you have to prepend the path with an additional slash, what results in a /%2f combination (second / encoded to %2f) at the begin of the URL path. This is important, especially in user authenticated ftp, where the users home is usually the default directory of the server (except when the server chroots into the users home directory). 
 
Explicit proxy settings may be passed via optional parameters proxy, proxyport, proxyuser and proxypass. 
 
HTTP authentication methods to use can be defined as comma separated list via optional parameter auth. Valid methods are e.g. basic, digest, ntlm, negotiate. Note, that this list depends on the list of methods supported by the curl library. 
 
SSL verification behavior can be changed using the ssl_verify option (this should be used with care). Valid values are yes (the secure default), host, peer or no. Host just checks that the "Common Name" field or a "Subject Alternate Name" field in the servers certificate matches the host name in the URL. Peer just verifies whether the certificate provided by the server is authentic against the chain of digital signatures found in ssl_capath. No performs no checks at all. Yes is the secure default, performing host and peer check. 
 
For SSL client certificate authentication use the options ssl_clientcert to define the path to the ssl client certificate and ssl_clientkey to define the path to the SSL client key. Use ssl_capath to change the directory holding the CA certificates (default is /etc/ssl/certs). 
 
• ftp://user:pass@server/path/to/media/dir ftp://user:pass@server/%2fhome/user/path/to/media/dir http://user:pass@server/path https://user:pass@server/path?proxy=foo&proxyuser=me&proxypass=pw https://server/path?ssl_clientcert=/entitlement/1234.pem&ssl_clientkey=/entitlement/1234-key.pem 
 
Disk volume (partition) Mandatory device parameter specifying the name of the block device to mount. The name of the optional filesystem defaults to "auto". 
 
• hd:/subdir?device=/dev/sda1&filesystem=reiserfs 
 
Local directory tree 
 
• dir:/directory/name 
 
Media in an ISO image (loopback mounted) Mandatory iso parameter specifying the name of the iso file. Optional url parameter specifying the URL to the directory containing the iso file. Optional mnt parameter specifying the preferred attach point for the source media url. Optional filesystem name of the filesystem used in the iso file. Defaults to "auto". 
 
• iso:/?iso=CD1.iso&url=nfs://server/path/to/media iso:/?iso=CD1.iso&url=hd:/?device=/dev/hda iso:/subdir?iso=DVD1.iso&url=nfs://nfs-server/directory&mnt=/nfs/attach/point&filesystem=udf 
 
NFS exported directory tree To use NFSv4 either use schema tnfsv4:// or pass an optional parameter type=nfs4. Additional mountoptions can be passed as comma separated list. Defaults to "ro". 
 
• nfs://nfs-server/exported/path nfs://nfs-server/exported/path?mountoptions=ro&type=nfs4 nfs4://nfs-server/exported/path?mountoptions=ro 
 
CIFS/SMB directory tree There is no difference between cifs and smb scheme (any more). In both cases the cifs filesystem is used. Additional mountoptions can be passed as comma separated list. Defaults to "ro,guest". Specify "noguest" to turn off "guest". This is necessary if Samba is configured to reject guest connections. 
 
Optional workgroup or domain parameter set the name of the workgroup. As alternative to passing username:password in the URI authority the parameters user and pass can be used. 
 
• smb://servername/share/path/on/the/share cifs://usern:passw@servername/share/path/on/the/share?mountoptions=ro,noguest cifs://usern:passw@servername/share/path/on/the/share?workgroup=mygroup cifs://servername/share/path/on/the/share?user=usern&pass=passw 
 
OpenSUSE Build Build Service (OBS) repositories Zypper also accepts special URIs identifying openSUSE Build Service (OBS) repositories in the addrepo command. These URIs have the form of obs://project/[platform], where project is the name of the OBS project and platform is the target platform (OS) for which the repository is intended. 
 
If platform is omitted, openSUSE_$releasever is used unless a value for obs.platform is defined in zypper.conf. If you are following openSUSE_Factory or openSUSE_Tumbleweed you may need to set these as your default platform. But we can only guess, how the directory containing the repository that fits your distribution is named on the server. In case of doubt you need to look up the right URL in a browser. 
 
• obs://zypp:Head/ obs://zypp:Head/openSUSE_Factory obs://zypp:Head/openSUSE_Factory_Staging_Gcc49_standard 
 
Commands: addrepo (ar) [options] URI alias 
 
addrepo (ar) [options] FILE*.repo* Add a new repository specified by URI and assign specified alias to it or specify URI to a .repo file. 
 
Newly added repositories have auto-refresh disabled by default (except for repositories imported from a .repo, having the auto-refresh enabled). To enable auto-refresh use addrepo -f, or the --refresh option of the modifyrepo command. 
 
Also, this command does not automatically refresh the newly added repositories. The repositories will get refreshed when used for the first time, or you can use the refresh command after finishing your modifications with *repo commands. 
 
-r, --repo file.repo Read URI and alias from specified .repo file 
 
-c, --check Probe given URI. 
 
-C, --no-check Don’t probe URI, probe later during refresh. 
 
-n, --name name Specify descriptive name for the repository. 
 
-e, --enable Enable the repository (the default). 
 
-d, --disable Add the repository as disabled. Repositories are added as enabled by default. 
 
-f, --refresh Enable autorefresh of the repository. The autorefresh is disabled by default when adding new repositories. 
 
-F, --no-refresh Disable auto-refresh for the repository. 
 
-p, --priority [1-2147483647]|0 Set the priority of the repository. Priority of 1 is the highest, and 2147483647 is the lowest. -p 0 will set the priority back to the default (99). Packages from repositories with higher priority will be used even if there are better versions available in a repository with a lower priority. 
 
-k, --keep-packages Enable RPM files caching for the repository. 
 
-K, --no-keep-packages Disable RPM files caching. 
 
-g, --gpgcheck Enable GPG check for this repository. The behavior as described in section GPG checks. 
 
--gpgcheck-strict Enable strict GPG check for this repository. Even packages from signed repositories need a valid GPG signature and using unsigned packages must be confirmed. 
 
--gpgcheck-allow-unsigned Short hand for --gpgcheck-allow-unsigned-repo --gpgcheck-allow-unsigned-package 
 
--gpgcheck-allow-unsigned-repo Enable GPG check but allow the repository metadata to be unsigned. 
 
--gpgcheck-allow-unsigned-package Enable GPG check but allow installing unsigned packages from this repository. 
 
-G, --no-gpgcheck Disable GPG check for this repository. 
 
Disabling GPG checks is not recommended. Signing data enables the recipient to verify that no modifications occurred after the data were signed. Accepting data with no, wrong or unknown signature can lead to a corrupted system and in extreme cases even to a system compromise. 
 
--default-gpgcheck Use the global GPG check settings defined in /etc/zypp/zypp.conf. This is the default. 
 
Unless you have modified your zypp.conf settings, this is the same as --gpgcheck, the behavior as described in section GPG checks. 
 
Examples: 
 
$ zypper ar -c -n 'Packman 11.1 repo' http://packman.iu-bremen.de/suse/11.1 packman Add a HTTP repository, probe it, name it Packman 11.1 repo, and use packman as alias. 
 
$ zypper ar https://download.opensuse.org/repositories/zypp:/svn/openSUSE_Factory/zypp:svn.repo 
 
$ zypper ar myreposbackup.repo Add repositories from a .repo file. 
 
removerepo (rr) [options] alias|name|#|URI... Delete repositories specified by aliases, names, numbers, URIs or one of the aggregate options. 
 
--loose-auth Ignore user authentication data in the URI 
 
--loose-query Ignore query string in the URI 
 
-a, --all Apply changes to all repositories. 
 
-l, --local Apply changes to all local repositories. 
 
-t, --remote Apply changes to all remote repositories (http/https/ftp). 
 
-m, --medium-type type Apply changes to repositories of specified type. The type corresponds to the repository URI scheme identifier like http, dvd, etc. You can find complete list of valid types at http://en.opensuse.org/openSUSE:Libzypp_URIs. 
 
repos (lr) [options] [repo]... List all defined repositories or show detailed information about those specified as arguments 
 
The following data can be printed for each repository found on the system: # (repository number), Alias (unique identifier), Name, Enabled (whether the repository is enabled), GPG Check (whether GPG check for repository metadata (r) and/or downloaded rpm packages (p) is enabled), Refresh (whether auto-refresh is enabled for the repository), Priority, Type (repository meta-data type: rpm-md, yast2, plaindir). Which of the data is shown is determined by command line options listed below and the main.repoListColumns setting from zypper.conf. By default, #, Alias, Name, Enabled, GPG Check and Refresh is shown. 
 
Repository number is a unique identifier of the repository in current set of repositories. If you add, remove or change a repository, the numbers may change. Keep that in mind when using the numbers with the repository handling commands. On the other hand, using the alias instead of the number is always safe. 
 
To show detailed information about specific repositories, specify them as arguments, either by alias, name, number from simple zypper lr, or by URI; e.g. fB zypper lr factory, or zypper lr 2. 
 
-e, --export FILE.repo|- This option causes zypper to write repository definition of all defined repositories into a single file in repo file format. If - is specified instead of a file name, the repositories will be written to the standard output. 
 
-a, --alias Add alias column to the output. 
 
-n, --name Add name column to the output. 
 
-u, --uri Add base URI column to the output. 
 
-p, --priority Add repository priority column to the output. 
 
-r, --refresh Add the autorefresh column to the output. 
 
-k, --keep-packages Add the keep-packages column to the output. The column will show a Yes if keep-packages is explicitly enabled for this repository. Otherwise a - or a + if a .keep_packages file in the pkg-cache directory exists. (see section FILES) 
 
-d, --details Show more information like URI, priority, type, etc. 
 
-E, --show-enabled-only Show enabled repositories only. 
 
-U, --sort-by-uri Add base URI column and sort the list it. 
 
-P, --sort-by-priority Add repository priority column and sort the list by it. 
 
-A, --sort-by-alias Sort the list by alias. 
 
-N, --sort-by-name Sort the list by name. 
 
Examples: 
 
$ zypper repos -e myreposbackup.repo Backup your repository setup: 
 
$ zypper lr -pu List repositories with their URIs and priorities: 
 
renamerepo (nr) alias|name|#|URI new-alias Assign new alias to the repository specified by alias, name, number, or URI. 
 
Examples: 
 
$ zypper nr 8 myrepo Rename repository number 8 to myrepo (useful if the repo has some dreadful alias which is not usable on the command line). 
 
modifyrepo (mr) options alias|name|#|URI... 
 
modifyrepo (mr) options --all|--remote|--local|--medium-type Modify properties of repositories specified by alias, name, number, or URI or one of the aggregate options. 
 
-n, --name name Set a descriptive name for the repository. 
 
-e, --enable Enable the repository. 
 
-d, --disable Disable the repository. 
 
-f, --refresh (legacy: -r) Enable auto-refresh for the repository. 
 
-F, --no-refresh (legacy: -R) Disable auto-refresh for the repository. 
 
-p, --priority [1-2147483647]|0 Set the priority of the repository. Priority of 1 is the highest, and 2147483647 is the lowest. -p 0 will set the priority back to the default (99). Packages from repositories with higher priority will be used even if there are better versions available in a repository with a lower priority. 
 
-k, --keep-packages Enable RPM files caching. 
 
-K, --no-keep-packages Disable RPM files caching. 
 
-g, --gpgcheck Enable GPG check for this repository. The behavior as described in section GPG checks. 
 
--gpgcheck-strict Enable strict GPG check for this repository. Even packages from signed repositories need a valid GPG signature and using unsigned packages must be confirmed. 
 
--gpgcheck-allow-unsigned Short hand for --gpgcheck-allow-unsigned-repo --gpgcheck-allow-unsigned-package 
 
--gpgcheck-allow-unsigned-repo Enable GPG check but allow the repository metadata to be unsigned. 
 
--gpgcheck-allow-unsigned-package Enable GPG check but allow installing unsigned packages from this repository. 
 
-G, --no-gpgcheck Disable GPG check for this repository. 
 
Disabling GPG checks is not recommended. Signing data enables the recipient to verify that no modifications occurred after the data were signed. Accepting data with no, wrong or unknown signature can lead to a corrupted system and in extreme cases even to a system compromise. 
 
--default-gpgcheck Use the global GPG check settings defined in /etc/zypp/zypp.conf. This is the default. 
 
Unless you have modified your zypp.conf settings, this is the same as --gpgcheck, the behavior as described in section GPG checks. 
 
-a, --all Apply changes to all repositories. 
 
-l, --local Apply changes to all local repositories. 
 
-t, --remote Apply changes to all remote repositories (http/https/ftp). 
 
-m, --medium-type type Apply changes to repositories of specified type. The type corresponds to the repository URI scheme identifier like http, dvd, etc. You can find complete list of valid types at http://en.opensuse.org/openSUSE:Libzypp_URIs. 
 
Examples: 
 
$ zypper mr -kt Enable keeping of packages for all remote repositories. 
 
$ zypper mr -er updates Enable repository updates and switch on autorefresh for the repo. 
 
$ zypper mr -da Disable all repositories. 
 
refresh (ref) [alias|name|#|URI]... Refresh repositories specified by their alias, name, number, or URI. If no repositories are specified, all enabled repositories will be refreshed. 
 
-f, --force Force a complete refresh of specified repositories. This option will cause both the download of raw metadata and parsing of the metadata to be forced even if everything indicates a refresh is not needed. 
 
-b, --force-build Force only reparsing of cached metadata and rebuilding of the database. Raw metadata download will not be forced. 
 
-d, --force-download Force only download of current copy of repository metadata. Parsing and rebuild of the database will not be forced. 
 
-B, --build-only Only parse the metadata and build the database, don’t download raw metadata into the cache. This will enable you to repair damaged database from cached data without accessing network at all. 
 
-D, --download-only Only download the raw metadata, don’t parse it or build the database. 
 
--include-all-archs Multi-Arch repos: Download raw metadata for all offered architectures even if the repo supports filtering. Otherwise we’d download only the metadata for architectures compatible with the local system. You do not need this unless you want zypper to provide the full metadata for the purpose of mirroring the repository. 
 
-s, --services Refresh also services before refreshing repositories. 
 
clean (cc) [options] [alias|name|#|URI]... Clean the local caches for all known or specified repositories. By default, only caches of downloaded packages are cleaned. 
 
-m, --metadata Clean repository metadata cache instead of package cache. 
 
-M, --raw-metadata Clean repository raw metadata cache instead of package cache. 
 
-a, --all Clean both repository metadata and package caches. 
 
Service Management The services, addservice, removeservice, modifyservice, and refresh-services commands serve for manipulating services. A service is specified by its URI and needs to have a unique alias defined (among both services and repositories). 
 
Standalone repositories (not belonging to any service) are treated like services, too. The ls command will list them, ms command will modify them, etc. Repository specific options, like --keep-packages are not available here, though. You can use repository handling commands to manipulate them. 
 
addservice (as) [options] URI alias Adds a service specified by URI to the system. The alias must be unique and serves to identify the service. If a service with the same alias and URI already exists, the command behaves like modifyservice and updates the settings accordingly. 
 
Newly added services are not refreshed automatically. Use the refresh-services command to refresh them. Zypper does not access the service URI when adding the service, so the type of the services is unknown until it is refreshed. 
 
-n, --name name Specify descriptive name for the service. 
 
-e, --enable Enable the service (this is the default). 
 
-d, --disable Add the service as disabled. 
 
-f, --refresh Enable auto-refresh of the service. 
 
-F, --no-refresh Disable auto-refresh of the service. 
 
removeservice (rs) [options] alias|name|#|URI... Remove specified service from the system. Removing a service will also remove of all of its repositories. 
 
--loose-auth Ignore user authentication data in the URI. 
 
--loose-query Ignore query string in the URI. 
 
modifyservice (ms) options alias|name|#|URI 
 
modifyservice (ms) options --all|--remote|--local|--medium-type Modify properties of specified services. 
 
Common Options These options are common to all types of services and repositories. 
 
-n, --name name Set a descriptive name for the service. 
 
-e, --enable Enable a disabled service. 
 
-d, --disable Disable the service (but don’t remove it). 
 
-f, --refresh (legacy: -r) Enable auto-refresh of the service. 
 
-F, --no-refresh (legacy: -R) Disable auto-refresh of the service. 
 
-a, --all Apply changes to all services. 
 
-l, --local Apply changes to all local services. 
 
-t, --remote Apply changes to all remote services. 
 
-m, --medium-type type Apply changes to services of specified type. 
 
RIS Service Specific Options These options are ignored by services other than Repository Index Services. 
 
-i, --ar-to-enable alias Schedule an RIS service repository to be enabled at next service refresh. 
 
-I, --ar-to-disable alias Schedule an RIS service repository to be disabled at next service refresh. 
 
-j, --rr-to-enable alias Remove a RIS service repository to enable. 
 
-J, --rr-to-disable alias Remove a RIS service repository to disable. 
 
-k, --cl-to-enable Clear the list of RIS repositories to enable. 
 
-K, --cl-to-disable Clear the list of RIS repositories to disable. 
 
services (ls) [options] List services defined on the system. 
 
-u, --uri Show also base URI of repositories. 
 
-p, --priority Show also repository priority. 
 
-d, --details Show more information like URI, priority, type. 
 
-r, --with-repos Show also repositories belonging to the services. 
 
-P, --sort-by-priority Sort the list by repository priority. 
 
-E, --show-enabled-only Show enabled services only. If used together with --with-repos a disabled services owning (manually) enabled repositories are shown as well. 
 
-U, --sort-by-uri Sort the list by URI. 
 
-N, --sort-by-name Sort the list by name. 
 
refresh-services (refs) [options] alias|name|#|URI... Refreshing a service means executing the service’s special task. 
 
RIS services add, remove, or modify repositories on your system based on current content of the repository index. A differing enabled/disabled state caused by manually calling modify-repo on a service repository however will not be reverted unless the --restore-status option is used, or the repository index explicitly requests the change. 
 
Services only manage defined repositories, they do not refresh them. To refresh also repositories, use --with-repos option or the refresh command. 
 
-f, --force Force a complete refresh of specified services. This option will cause both the download of raw metadata and parsing of the metadata to be forced even if everything indicates a refresh is not needed. 
 
-r, --with-repos Refresh also the service repositories. 
 
-R, --restore-status Also restore service repositories enabled/disabled state to the repository index default. Useful after you manually changed some service repositories enabled state. 
 
Package Locks Management Package locks serve the purpose of preventing changes to the set of installed packages on the system. Locks are stored as queries in /etc/zypp/locks file (see also locks(5)). Packages matching a query are then forbidden to change their installed status; an installed package can’t be removed or upgraded, not installed package can’t be installed. When requesting to install, upgrade or remove such locked package, you will get a dependency problem dialog. 
 
A lock-spec is formed by "NAME [OP EDITION]", where NAME may also be a glob pattern using * and ? wildcard characters. Non-package types may to have their kind-string prepended (e.g. patch:foo or product:baa) or use the commands --type option. 
 
The basic form will lock all editions of the matching items. You can optionally restrict the lock to match a specific edition or edition range using =, <, <=, >, >= or != followed by the edition. 
 
Note 
 
If you use blanks around the operator you need to quote the string or escape the blanks according to the rules of the shell you are using. 
 
locks (ll) List currently active package locks. 
 
-m, --matches Show the number of resolvables matched by each lock. This option requires loading the repositories. 
 
-s, --solvables List the resolvables matched by each lock. This option requires loading the repositories. 
 
addlock (al) [options] lock-spec... Add a package lock. Specify packages to lock as explained above. 
 
-r, --repo alias|name|#|URI Restrict the lock to the specified repository. 
 
-t, --type type Lock only packages of specified type (default: package). See section Package Types for list of available package types. 
 
-m, --comment comment Add a comment for package lock. 
 
removelock (rl) [options] lock-number|lock-spec... Remove a package lock. Specify the lock to remove by its number obtained with zypper locks or by the lock-spec. 
 
-r, --repo alias|name|#|URI Restrict the lock to the specified repository. 
 
-t, --type type Restrict the lock to packages of specified type (default: package). See section Package Types for list of available package types. 
 
cleanlocks (cl) Remove unused locks. 
 
This command looks for locks that do not currently (with regard to repositories used) lock any package and for each such lock it asks user whether to remove it. 
 
Locale Management These commands give information about requested locales and the possibility to manage those. A locale is defined by a language code. For many packages there are locale dependent packages available which provide translations or dictionaries. To get these installed, the locale for the desired language must be marked as requested by the package manager library. 
 
locales (lloc) [OPTIONS] [LOCALE] ... List requested locales. Called without argument, lists the locales which are already marked as requested. Specifying certain locale(s) prints information only for this(these). 
 
-a, --all List all available locales. 
 
-p, --packages Show corresponding packages. 
 
addlocale (aloc) [OPTIONS] <LOCALE> ... Add specified locale(s) to the list of requested locales.. 
 
-n, --no-packages Do not install corresponding packages. 
 
removelocale (rloc) [OPTIONS] <LOCALE> ... Remove specified locale(s) from the list of requested locales.. 
 
-n, --no-packages Do not remove corresponding packages. 
 
Examples: 
 
$ zypper locales List requested locales. 
 
$ zypper locales --packages de en Get the lists of packages which are available for de and en (exact match). 
 
$ zypper locales en_ Get all locales with lang code en that have their own country code, excluding the fallback en. 
 
$ zypper locales en* Get all locales with lang code en with or without country code. 
 
$ zypper aloc --packages de_CH Request de_CH and install language dependent packages. 
 
Other Commands system-architecture Print the detected system architecture. 
 
versioncmp (vcmp) VERSION1 VERSION2 Compare the versions supplied as arguments and tell whether VERSION1 is older or newer than VERSION2 or the two version strings match. The exit code is 0 if the versions are equal, 11 if VERSION1 is newer, and 12 if VERSION2 is newer. 
 
The default output is in human-friendly form. If --terse global option is used, the result is an integer number, negative/positive if VERSION1 is older/newer than VERSION2, zero if they match. 
 
-m, --match Takes missing release number as any release. 
 
For example: 
 
$ zypper vcmp -m 0.15.3 0.15.3-2 0.15.3 matches 0.15.3-2 
 
$ zypper vcmp 0.15.3 0.15.3-2 0.15.3 is older than 0.15.3-2 
 
targetos (tos) Shows the ID string of the target operating system. The string is defined by the XPath:/product/register/target entry in (current-rootdir)/etc/products.d/baseproduct. 
 
If the baseproduct does not provide this entry, or if no baseproduct is installed at all, the value is empty if the --terse global option is used. 
 
In not-terse mode the distribution label is shown instead of an empty value, if a baseproduct is installed. 
 
-l, --label Show the baseproducts distribution and short label instead. 
 
licenses Prints a report about licenses and EULA's of installed packages to standard output. 
 
First, a list of all packages and their licenses and/or EULAs is shown. This is followed by a summary, including the total number of installed packages, the number of installed packages with EULAs that required a confirmation from the user. Since the EULAs are not stored on the system and can only be read from repository metadata, the summary includes also the number of installed packages that have their counterpart in repositories. The report ends with a list of all licenses uses by the installed packages. 
 
This command can be useful for companies redistributing a custom distribution (like appliances) to figure out what licenses they are bound by. 
 
download [OPTIONS] Download rpms specified on the commandline to a local directory. 
 
Per default packages are downloaded to the libzypp package cache (/var/cache/zypp/packages; for non-root users $XDG_CACHE_HOME/zypp/packages), but this can be changed by using the global --pkg-cache-dir option. 
 
Parsable XML-output produced by zypper --xmlout will include a <download-result> node for each package zypper tried to download. Upon success the location of the downloaded package is found in the path attribute of the <localfile> subnode (xpath: download-result/localpath@path): 
 
<download-result> <solvable> <kind>package</kind> <name>zypper</name> <edition epoch="0" version="1.9.17" release="26.1"/> <arch>x86_64</arch> <repository name="repo-oss-update (13.1)" alias="openSUSE:repo-oss-update"/> </solvable> <localfile path="/var/cache/zypp/pac.../zypper-1.9.17-26.1.x86_64.rpm"/> </download-result> 
 
--all-matches Download all versions matching the commandline arguments. Otherwise only the best version of each matching package is downloaded. 
 
--dry-run Don’t download any package, just report what would be done. 
 
-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number or URI. This option can be used multiple times. 
 
--from alias|name|#|URI Select packages from the specified repository only. This option can be used multiple times. 
 
source-download [OPTIONS] Download source rpms for all installed packages to a local directory. 
 
-d, --directory dir Download all source rpms to this directory. Default is /var/cache/zypper/source-download. 
 
--delete Delete extraneous source rpms in the local directory. This is the default. 
 
--no-delete Do not delete extraneous source rpms. 
 
--status Don’t download any source rpms, but show which source rpms are missing or extraneous. 
 
ps [OPTIONS] After each upgrade or removal of packages, there may be running processes on the system which continue to use meanwhile deleted files. zypper ps lists all processes using deleted files, together with the corresponding files, and a service name hint, in case it’s a known service. This gives a hint which services may need to be restarted after an update. Usually programs which continue to use deleted shared libraries. The list contains the following information: 
 
PID ID of the process 
 
PPID ID of the parent process 
 
UID ID of the user running the process 
 
Login Login name of the user running the process 
 
Command Command used to execute the process 
 
Service Service name, if command is associated with a system service 
 
Files The list of the deleted files 
 
-s, --short Create a short table not showing the deleted files. Given twice, show only processes which are associated with a system service. Given three times, list the associated system service names only. 
 
--print format For each associated system service print format on the standard output, followed by a newline. Any %s directive in format is replaced by the system service name. 
 
-d, --debugFile filename Output a file with all proc entries that make it into the final set of used open files. This can be submitted as additional information in a bug report. 
 
Examples: 
 
$ zypper ps -ss Show only processes associated with a system service. 
 
$ zypper ps -sss Short for zypper ps --print "%s"; list services which might need a restart. 
 
$ zypper ps --print "systemctl status %s" Let zypper print the commands to retrieve status information for services which might need a restart. 
 
needs-rebooting Checks if the reboot-needed flag was set by a previous update or install of a core library or service. 
 
The reboot-needed flag is set if a package that provides installhint(reboot-needed) is updated or installed. Additionally there is a predefined list (/etc/zypp/needreboot) of well-known packages which cause the reboot-needed flag being set unconditionally. The exit code ZYPPER_EXIT_INF_REBOOT_NEEDED indicates that a reboot is suggested, otherwise the exit code is set to ZYPPER_EXIT_OK. 
 
It is recommended for scripts to use this command to test whether a system reboot is suggested. Use --quiet to suppress the normal output. 
 
Subcommands subcommand Lists available subcommands in /usr/lib/zypper/commands and from elsewhere on your $PATH. See section SUBCOMMANDS for details. 
 
GLOBAL OPTIONS -h, --help Help. If a command is specified together with --help option, command specific help is displayed. 
 
-V, --version Print zypper version number and exit. 
 
-c, --config file Use the specified zypper config file instead of the default zypper.conf. Other command line options specified together with --config and having their counterpart in the zypper config file are still preferred. 
 
The order of preference with --config is as follows: 
 
1. Command line options 
 
2. --config file 
 
3. [/etc/zypp/zypp.conf] (system-wide defaults for all libzypp based applications) 
 
Note 
 
Use and location of the system-wide /etc/zypp/zypp.conf can not be changed this way. It’s mentioned here just because some zypper command line options allow one to overwrite system-wide defaults defined in zypp.conf. 
 
See also FILES section for more information. 
 
-v, --verbose Increase verbosity. For debugging output specify this option twice. zypper -vv ref for example will show the mirrors used to download the metadata. 
 
-q, --quiet Suppress normal output. Brief (esp. result notification) messages and error messages will still be printed, though. If used together with conflicting --verbose option, the --verbose option takes preference. 
 
--color, --no-color Whether to use colors in output if tty supports it. For details see the [color] section in zypper.conf. 
 
-A, --no-abbrev Do not abbreviate text in tables. By default zypper will try to abbreviate texts in some columns so that the table fits the width of the screen. If you need to see the whole text, use this option. 
 
-t, --terse Terse output for machine consumption. Implies --no-abbrev and --no-color. 
 
-s, --table-style integer Choose among different predefined line drawing character sets to use when drawing a table. The table style is identified by an integer number. Style 0 is the default, styles 1-9 use combinations of different box drawing characters whose shape may depend on the font the terminal is using. Style 10 separates columns by a colon and style 11 draws no lines at all. 
 
-n, --non-interactive Switches to non-interactive mode. In this mode zypper doesn’t ask user to type answers to various prompts, but uses default answers automatically. Those default answers also depend on other options like --no-gpg-checks or --ignore-unknown. 
 
--non-interactive-include-reboot-patches In non-interactive mode do not skip patches which have the rebootSuggested-flag set. Otherwise these patches are considered to be interactive, like patches including a licenses or some message to confirm. NOTE: This option does not turn on non-interactive mode. 
 
-x, --xmlout Switches to XML output. This option is useful for scripts or graphical frontends using zypper. 
 
-i, --ignore-unknown Ignore unknown packages. This option is useful for scripts, because when installing in --non-interactive mode zypper expects each command line argument to match at least one known package. Unknown names or globbing expressions with no match are treated as an error unless this option is used. 
 
For search and info commands the option makes zypper return ZYPPER_EXIT_OK rather than ZYPPER_EXIT_INF_CAP_NOT_FOUND if the query did not produce at least one match. 
 
-D, --reposd-dir dir Use the specified directory to look for the repository definition (.repo) files. The default value is /etc/zypp/repos.d. 
 
-C, --cache-dir dir Use an alternative root directory for all caches. The default value is /var/cache/zypp. 
 
--raw-cache-dir dir Use the specified directory for storing raw copies of repository metadata files. The default value is /var/cache/zypp/raw. 
 
--solv-cache-dir dir Use the specified directory to store the repository metadata cache database files (solv files). The default value is /var/cache/zypp/solv. 
 
--pkg-cache-dir dir Use the specified directory for storing rpm packages downloaded from repositories (see addrepo --keep-packages). The default value is /var/cache/zypp/packages. + Packages are stored in subdirectories named after the repositories alias and using the same path as on the repositories medium. 
 
--userdata string User data is expected to be a simple string without special chars or embedded newlines and may serve as transaction id. It will be written to all install history log entries created throughout this specific zypper call. It will also be passed on to zypp plugins executed during commit. This will enable e.g. a btrfs plugin to tag created snapshots with this string. For zypper itself this string has no special meaning. 
 
Repository Options: 
 
--no-gpg-checks Ignore GPG check failures and continue. If a GPG issue occurs when using this option zypper prints and logs a warning and automatically continues without interrupting the operation. Use this option with caution, as you can easily overlook security problems by using it. (see section GPG checks) 
 
--gpg-auto-import-keys If new repository signing key is found, do not ask what to do; trust and import it automatically. This option causes that the new key is imported also in non-interactive mode, where it would otherwise got rejected. 
 
-p, --plus-repo URI Use an additional repository for this operation. The repository aliased tmp# and named by the specified URI will be added for this operation and removed at the end. You can specify this option multiple times. 
 
--plus-content tag Additionally use disabled repositories denoted by tag for this operation. If tag matches a repositories alias, name or URL, or is a keyword defined in the repositories metadata, the repository will be temporarily enabled for this operation. The repository will then be refreshed and used according to the commands rules. You can specify this option multiple times. 
 
If a disabled repositories metadata are not available in the local cache, they will be downloaded to scan for matching keywords. Otherwise the keyword scan will use the metadata available in the local cache. Only if used together with the refresh command, a keyword scan will refresh all disabled repositories. 
 
To refresh all disabled repositories metadata: zypper --plus-content '' ref 
 
To include a disabled repository repo-debug in a search: zypper --plus-content repo-debug search ... 
 
To search only in a disabled repository repo-debug: zypper --plus-content repo-debug search -r repo-debug ... 
 
To enable all repos providing the debug keyword: zypper in --plus-content debug some -debuginfo or -debugsource package 
 
--disable-repositories Do not read metadata from repositories. This option will prevent loading of packages from repositories, thus making zypper work only with the installed packages (if --disable-system-resolvables was not specified). 
 
--no-refresh Do not auto-refresh repositories (ignore the auto-refresh setting). Useful to save time when doing operations like search, if there is not a need to have a completely up to date metadata. 
 
--no-cd Ignore CD/DVD repositories. When this option is specified, zypper acts as if the CD/DVD repositories were not defined at all. 
 
--no-remote Ignore remote repositories like http, ftp, smb and similar. This makes using zypper easier when being offline. When this option is specified, zypper acts as if the remote repositories were not defined at all. 
 
--releasever version For the current command set the value of the $releasever repository variable to version. This can be used to switch to new distribution repositories when performing a distribution upgrade. See the dist-upgrade (dup) command and section Repository Management for more details about using the $releasever repository variable. 
 
To check where you already use $releasever call: zypper --releasever @--HERE--@ lr -u 
 
Target Options: 
 
-R, --root dir Operates on a different root directory. This option influences the location of the repos.d directory and the metadata cache directory and also causes rpm to be run with the --root option to do the actual installation or removal of packages. See also the FILES section. 
 
--installroot dir Behaves like --root but shares the repositories with the host system. 
 
--disable-system-resolvables This option serves mainly for testing purposes. It will cause zypper to act as if there were no packages installed in the system. Use with caution as you can damage your system using this option. 
 
SUBCOMMANDS Zypper subcommands are inspired by git(1). Subcommands are standalone executables that live in the zypper_execdir (/usr/lib/zypper/commands). For subcommands zypper provides a wrapper that knows where the subcommands live, and runs them by passing command options and arguments to them. If a subcommand is not found in the zypper_execdir, the wrapper will look in the rest of your $PATH for it. Thus, it’s possible to write local zypper extensions that don’t live in system space. This can be disabled by setting "subcommand.seachSubcommandInPath" to "no" in the zypper.conf. 
 
This is how to add your own subcommand zypper mytask: 
 
• The executable must be named zypper-mytask. 
 
• The executable must be located your $PATH. 
 
• A manpage for zypper-mytask should be provided and explaining the commands options and return values. It will be shown when calling zypper help mytask. 
 
• Zypper built-in commands take precedence over subcommands with the same name. 
 
• It’s fine to call zypper or use libzypp from within your subcommand. 
 
You can use the built-in zypper subcommand command to get a list of all subcommands in zypper_execdir and from elsewhere on your $PATH. 
 
Using zypper global-options together with subcommands, as well as executing subcommands in zypper shell is currently not supported. 
 
FILES /etc/zypp/zypper.conf, $HOME/.zypper.conf Global (system-wide) and user’s configuration file for zypper. These files are read when zypper starts up and --config option is not used. 
 
User’s settings are preferred over global settings. Similarly, command line options override the settings in either of these files. To sum it up, the order of preference is as follows (from highest to lowest): 
 
1. Command line options 
 
2. $HOME/.zypper.conf 
 
3. /etc/zypp/zypper.conf 
 
4. [/etc/zypp/zypp.conf] (system-wide defaults for all libzypp based applications) 
 
See the comments in /etc/zypp/zypper.conf for a list and description of available options. 
 
Note 
 
The system-wide /etc/zypp/zypp.conf is mentioned here just because some zypper command line options allow one to overwrite system-wide defaults defined there. zypp.conf and zypper.conf have different content and serve different purpose. 
 
/etc/zypp/zypp.conf ZYpp configuration file affecting all libzypp based applications. See the comments in the file for description of configurable properties. Many locations of files and directories listed in this section are configurable via zypp.conf. The location for this file itself can be redefined only by setting $ZYPP_CONF in the environment. 
 
/etc/zypp/locks File with package lock definitions. The package lock commands (locks, addlock, removelock, etc.) should be used to manipulate this file. 
 
This file is used by all ZYpp-based applications. 
 
/etc/zypp/repos.d Directory containing repository definition (*.repo) files. You can use the Repository Management commands to manipulate these files, or you can edit them yourself. In either case, after doing the modifications, executing *zypper refresh* is strongly recommended. 
 
You can use the --reposd-dir global option to use an alternative directory for this purpose or the --root option to make this directory relative to the specified root directory. 
 
This directory is used by all ZYpp-based applications. 
 
/etc/zypp/services.d Directory containing service definition (*.service) files. You can use the Service Management Commands to manipulate these files, or you can edit them yourself. Running *zypper refs* is recommended after modifications have been done. 
 
This directory is used by all ZYpp-based applications. 
 
/usr/lib/zypper/commands System directory containing zypper extensions (see section SUBCOMMANDS) 
 
/var/cache/zypp/raw Directory for storing raw metadata contained in repositories. Use the --raw-cache-dir global option to use an alternative directory for this purpose or the --root option to make this directory relative to the specified root directory. 
 
This directory is used by all ZYpp-based applications. 
 
/var/cache/zypp/solv Directory containing preparsed metadata in form of solv files. 
 
This directory is used by all ZYpp-based applications. 
 
/var/cache/zypp/packages If the keep-packages property is set for a repository (see the modifyrepo command), all the RPM file downloaded during installation will be kept here. Packages are stored in subdirectories named after their repositories alias. 
 
Subdirectories of removed or otherwise unknown repositories are cleaned automatically. This auto-cleanup can be prevented by creating a file named .no_auto_prune in the pkg-cache directory. 
 
Creating a .keep_packages file in the pkg-cache directory will keep downloaded packages for all repos cached here, overwriting the repositories keep-packages property. 
 
See also the clean command for cleaning these cache directories. 
 
This directory is used by all ZYpp-based applications. 
 
/var/log/zypper.log Zypper log file. It should be attached to all bugreports. (see also zypper-log(8)). 
 
/var/log/zypper.solverTestCase Solver testcase created by using the --debug-solver option. 
 
/var/log/updateTestcase-YYYY-MM-DD-hh-mm-ss Solver testcase auto created when performing a zypper dup. 
 
/var/log/zypp/history Installation history log. 
 
~/.zypper_history Command history for the zypper shell (see the shell command). 
 
/etc/zypp/needreboot File with a list of packages that will set the reboot-needed flag when installed or upgraded. 
 
/etc/zypp/needreboot.d Directory that can be used to define packages that trigger the reboot-needed flag by adding additional files containing the required package names. 
 
EXIT CODES There are several exit codes defined for zypper built-in commands for use e.g. within scripts. These codes are defined in header file src/zypper-main.h found in zypper source package. Codes below 100 denote an error, codes above 100 provide a specific information, 0 represents a normal successful run. Following is a list of these codes with descriptions: 
 
0 - ZYPPER_EXIT_OK Successful run of zypper with no special info. 
 
1 - ZYPPER_EXIT_ERR_BUG Unexpected situation occurred, probably caused by a bug. 
 
2 - ZYPPER_EXIT_ERR_SYNTAX zypper was invoked with an invalid command or option, or a bad syntax. 
 
3 - ZYPPER_EXIT_ERR_INVALID_ARGS Some of provided arguments were invalid. E.g. an invalid URI was provided to the addrepo command. 
 
4 - ZYPPER_EXIT_ERR_ZYPP A problem is reported by ZYPP library. 
 
5 - ZYPPER_EXIT_ERR_PRIVILEGES User invoking zypper has insufficient privileges for specified operation. 
 
6 - ZYPPER_EXIT_NO_REPOS No repositories are defined. 
 
7 - ZYPPER_EXIT_ZYPP_LOCKED The ZYPP library is locked, e.g. packagekit is running. 
 
8 - ZYPPER_EXIT_ERR_COMMIT An error occurred during installation or removal of packages. You may run zypper verify to repair any dependency problems. 
 
100 - ZYPPER_EXIT_INF_UPDATE_NEEDED Returned by the patch-check command if there are patches available for installation. 
 
101 - ZYPPER_EXIT_INF_SEC_UPDATE_NEEDED Returned by the patch-check command if there are security patches available for installation. 
 
102 - ZYPPER_EXIT_INF_REBOOT_NEEDED Returned by the needs-rebooting command, if a system reboot is suggested. 
 
Legacy: Returned after the successful installation of a patch which requires reboot of computer. This legacy behavior is kept, but it’s drawback is that it covers patches only, no packages. The new needs-rebooting command is the recommended way to test whether a system reboot is suggested. 
 
103 - ZYPPER_EXIT_INF_RESTART_NEEDED Returned after a successful installation of a patch which requires restart of the package manager itself. This means that one of patches to be installed affects the package manager itself and the command used (e.g. zypper update) needs to be executed once again to install any remaining patches. 
 
104 - ZYPPER_EXIT_INF_CAP_NOT_FOUND Returned by the install and the remove command in case any of the arguments does not match any of the available (or installed) package names or other capabilities. In search and info commands it indicates that no match was found. See also the --ignore-unknown global option. 
 
105 - ZYPPER_EXIT_ON_SIGNAL Returned upon exiting after receiving a SIGINT or SIGTERM. 
 
106 - ZYPPER_EXIT_INF_REPOS_SKIPPED Some repository had to be disabled temporarily because it failed to refresh. You should check your repository configuration (e.g. zypper ref -f). 
 
107 - ZYPPER_EXIT_INF_RPM_SCRIPT_FAILED Installation basically succeeded, but some of the packages %post install scripts returned an error. These packages were successfully unpacked to disk and are registered in the rpm database, but due to the failed install script they may not work as expected. The failed scripts output might reveal what actually went wrong. Any scripts output is also logged to /var/log/zypp/history. 
 
Zypper subcommands (see section SUBCOMMANDS) may return different codes which should be described in the commands man page. Call zypper help subcommand to see the subcommands man page if one is provided. 
 
HOMEPAGE https://github.com/openSUSE/zypper 
 
AUTHORS The zypper project was started by Martin Vidner, Jan Kupec, Michael Andres, Duncan Mac-Vicar Prett, Josef Reidinger and Stanislav Visnovsky. Many people have later contributed to it. 
 
SEE ALSO locks(5), zypper-log(8), YaST2(8) 
 
SUSE Linux 2026-03-06 ZYPPER(8)

Paketmanager zypper

2026-05-17T17:01:10Z

Chris T. Ludwig: Die Seite wurde neu angelegt: „=Allgemeines= Sammlung meiner oft benutzten zypper-Kommandos zypper lr -d # list repos with details man sieht so auch die Pfade zypper -v install --force <package> # ueberinstallieren zypper search-packages <package> zypper mr --enable <#> =Manpage= ZYPPER(8) ZYPPER ZYPPER(8) NAME zypper - Command-line interface to ZYpp system management library (libzypp) SYNOPSIS zypper [--global-opts] command [--command-opts] [command-arguments] zypper sub…“

=Allgemeines=
Sammlung meiner oft benutzten zypper-Kommandos

zypper lr -d # list repos with details man sieht so auch die Pfade

zypper -v install --force <package> # ueberinstallieren

zypper search-packages <package>

zypper mr --enable <#>

=Manpage=

ZYPPER(8) ZYPPER ZYPPER(8)

NAME zypper - Command-line interface to ZYpp system management library (libzypp)

SYNOPSIS zypper [--global-opts] command [--command-opts] [command-arguments]

zypper subcommand [--command-opts] [command-arguments]

zypper help command

DESCRIPTION zypper is a command-line interface to ZYpp system management library (libzypp). It can be used to install, update, remove software, manage repositories, perform various queries, and more.

CONCEPTS Most of the following concepts are common for all applications based on the libzypp package management library, but there are some zypper specifics.

System Packages The set of installed packages on a system is sometimes denoted as repository @System or System Packages. In contrast to available repositories providing packages which can be installed, @System provides packages which can only be deleted. Installed packages which are not provided by at least one of the available repositories (neither in different version or as renamed package) are often denoted as being unwanted, orphaned or dropped.

Note: If you install packages which are not shipped within a repository - manually built or downloaded ones -, collect them within a local directory and add this directory as a plaindir repository to your system. This way the packages will not be seen as being orphaned and are protected during a dist-upgrade.

Creating such a plaindir repo is quite easy: $ mkdir /LocalRepo $ zypper addrepo --refresh /LocalRepo LocalRepo

If you need to make sure the package to install is taken from LocalRepo, simply use a REPO:PACKAGE style argument: $ cp example.rpm /LocalRepo $ zypper install LocalRepo:example

Depending on the kind of packages you keep in a local repo you may want to adjust the way GPG signature checks are performed. See section GPG checks for details.

Repositories Libzypp works with repository metadata, this is information about packages and their relations extracted from RPM packages and other data like patch information, pattern definitions, etc. These data are stored together with the RPM files in folders called repositories. Repositories can be placed on various media like an HTTP or FTP server, DVD, or a folder on a local disc.

There is a special set of commands in zypper intended to manipulate repositories. Also many commands and options take a repository as an argument. See section COMMANDS, subsection Repository Management for more details.

GPG checks Disabling GPG checks is not recommended. Signing data enables the recipient to verify that no modifications occurred after the data were signed. Accepting data with no, wrong or unknown signature can lead to a corrupted system and in extreme cases even to a system compromise.

Zypp verifies the authenticity of repository metadata by checking their GPG signature. If the repository metadata are signed with a trusted key and successfully verified, packages from this repository are accepted for installation if they match the checksum provided in the metadata. Using unsigned repositories needs to be confirmed.

If the repository metadata are not signed, the GPG signature of each downloaded rpm package is checked before accepting it for installation. Packages from unsigned repositories need a valid GPG signature. Using unsigned packages needs to be confirmed.

The above is the default behavior defined by settings in /etc/zypp/zypp.conf.

The addrepo and modifyrepo commands provide further options to tune the behavior per repository. It is for example possible to relax the need to confirm installing unsigned packages for a specific repository. But if you do so, you should be very certain that an attacker can hardly modify the package data within the repository or on the way to your machine. See section COMMANDS for details about the command options.

Resource Identifiers (URI) To specify locations of repositories or other resources (RPM files, .repo files) you can use any type of URI supported by libzypp. In addition Zypper accepts a special URI identifying openSUSE Build Service (OBS) repositories in the addrepo command. These URIs have the form of obs://project/[platform].

See section COMMANDS, subsection Repository Management for a complete list and examples of supported URI formats.

Refresh Refreshing a repository means downloading metadata of packages from the medium (if needed), storing it in local cache (typically under /var/cache/zypp/raw/alias directory) and preparsing the metadata into .solv files (building the solv cache), typically under /var/cache/zypp/solv/alias.

The metadata get refreshed either automatically or on user request. An automatic refresh takes place right before reading metadata from the database if the auto-refresh is enabled for the repository and the metadata is reported to be out of date. If the auto-refresh is disabled, the repository will only be refreshed on user request. You can request a refresh by calling zypper refresh (see the documentation of the refresh command for details).

The repository metadata are checked for changes before actually doing the refresh. A change is detected by downloading one or two metadata index files (small files) and comparing the checksums of the cached ones and the remote ones. If the files differ, the repository is out of date and will be refreshed.

To delay the up-to-date check (and thus the automatic refresh) for a certain number of minutes, edit the value of the repo.refresh.delay attribute of ZYpp config file (/etc/zypp/zypp.conf). This means, zypper will not even try to download and check the index files, and you will be able to use zypper for operations like search or info without internet access or root privileges.

HINT: zypper -vv ref will show the mirrors used to download the metadata.

Services Services are one level above repositories and serve to manage repositories or to do some special tasks. Libzypp currently supports Repository Index Service (RIS) and Plugin Service.

Repository Index Service (RIS) is a special type of repository which contains a list of other repositories. This list can be generated dynamically by the server according to some URI parameters or user name, or can be static. Once such service is added to your system, zypper takes care of adding, modifying, or removing these repositories on your system to reflect the current list. See section Service Management and https://en.opensuse.org/openSUSE:Standards_Repository_Index_Service for more details.

Package Types Zypper works with several types of resource objects, called resolvables. A resolvable might be a package, patch, pattern, product; basically any kind of object with dependencies to other objects.

package An ordinary RPM package.

patch A released patch conflicts with the affected/vulnerable versions of a collection of packages. As long as any of these affected/vulnerable versions are installed, the conflict triggers and the patch is classified as needed, or as unwanted if the patch is locked.

Selecting the patch, the conflict is resolved by updating all installed and affected/vulnerable packages to a version providing the fix. When updating the packages zypper always aims for the latest available version. Resolved patches are classified as either applied or not needed, depending on whether they refer to actually installed packages.

So installation, update or removal of packages may change the classification of patches referring to these packages. Since libyzpp-17.23.0 the /var/log/zypp/history remembers if a committed transaction changes a patchs classification. If history data are available, patch tables show a column telling since when the patch is in it’s current state.

Depending on the kind of defect, patches are classified by category and severity. Commonly used values for category are security, (recommended, bugfix), (optional, feature, enhancement) document or yast. Commonly used values for severity are critical, important, moderate, low or unspecified. Names listed in parentheses are used synonymously.

Note that the patch command does not apply optional patches (category optional or feature) by default. If you actually want to consider all optional patches as being needed, say patch --with-optional. Specific patches can be applied using the install command (e.g. zypper install patch:openSUSE-2014-7).

If the issuer decides to retract a released patch, the patch status will be shown as retracted. The packages provided by the retracted patch are still visible but also tagged as having been retracted (R). The resolver will avoid selecting retracted packages automatically. If you are sure that a retracted package should be installed on your system, you must explicitly select it.

pattern A group of packages required or recommended to install some functionality.

product A group of packages which are necessary to install a product.

srcpackage Source code package (.src.rpm). This type works in search and install commands.

application Legacy: Since libzypp-17.7.0 this type is no longer available.

Throughout this manual we will often refer to resolvables simply as packages and to resolvable types as package type or kind. These type names can be used as arguments of --type option in several commands like install, info, or search. Commands should also allow one to specify resolvables as KIND:NAME (e.g. patch:openSUSE-2014-7).

Package Dependencies Software packages depend on each other in various ways. Packages usually require or recommend other packages, but they can also conflict with them. Packages may support specific hardware or language settings. Zypper uses a dependency solver to find out which packages need to be installed to satisfy the user’s request.

If you do not request a specific version of a package the solver will pick a reasonable one. The solvers general attitude when resolving a job is to focus on installing the best version of the requested package and to add or update dependencies as they are needed. Aside from this Focus on Job, which is the default, two other focus modes are available:

In Focus on Installed mode the solver focuses on applying as little changes to the installed packages as needed. Choosing an older version of a requested package is valid if it’s dependencies require less changes to the system. The solver will try to avoid updating already installed packages.

In Focus on Update mode the solver focuses on updating the requested package and all its dependencies as much as possible. Beware, installing a single package in this mode may easily lead to a mini system update.

For a single command the focus mode can be set using the --solver-focus MODE switch. Valid modes are Job, Installed or Update. If you want to change the default mode for your system, set [/etc/zypp/zypp.conf:solver.focus] to the desired value.

Automatically installed packages Packages added by the dependency solver in order to resolve a user’s request are remembered as having been automatically installed. They may later be removed, if no more user installed packages depend on them (e.g. by zypper remove --clean-deps).

In the Status column the search command distinguishes between user installed packages (i+) and automatically installed packages (i).

Package File Conflicts File conflicts happen when two packages attempt to install files with the same name but different contents. This may happen if you are installing a newer version of a package without erasing the older version, of if two unrelated packages each install a file with the same name.

As checking for file conflicts requires access to the full filelist of each package being installed, zypper will be able to check for file conflicts only if all packages are downloaded in advance (see --download-in-advance). If you are doing a --dry-run no packages are downloaded, so the file conflict check will skip packages not available in the packages cache. To get a meaningful file conflict check use --dry-run together with --download-only.

As the reason for file conflicts usually is a poor package design or lack of coordination between the people building the packages, they are not easy to resolve. By using the --replacefiles option you can force zypper to replace the conflicting files. Nevertheless this may damage the package whose file gets replaced.

COMMANDS zypper provides a number of commands. Each command accepts the options listed in the GLOBAL OPTIONS section. These options must be specified before the command name. In addition, many commands have specific options, which are listed in this section. These command-specific options must be specified after the name of the command and before any of the command arguments.

Zypper also provides limited support for writing extensions/subcommands in any language. See section SUBCOMMANDS for details.

General Commands help [command] Shows help texts. If invoked without any argument (just zypper or zypper help), zypper displays global help text which lists all available global options and commands.

If invoked with a command name argument, zypper displays help for the specified command, if such command exists. Long as well as short variants of the command names can be used.

For your convenience, zypper help can also be invoked in any of the following ways:

$ zypper -h|--help [command]

$ zypper [command] -h|--help

shell (sh) Starts a shell for entering multiple commands in one session. Exit the shell using exit, quit, or Ctrl-D.

The shell support is not complete so expect bugs there. However, there’s no urgent need to use the shell since libzypp became so fast thanks to the SAT solver and its tools (openSUSE 11.0), but still, you’re welcome to experiment with it.

Package Management Commands info (if) [options] name[-version[-release]]... Show detailed information for specified packages. By default, only packages that exactly match the provided names are shown. To include packages that partially match, use the --match-substrings option or wildcards (* or ?) within the name.

If no version constraint is specified, information about the best available package is shown. Note that both the version and release numbers must always match exactly.

If a query returns no results, zypper returns ZYPPER_EXIT_INF_CAP_NOT_FOUND unless the global option --ignore-unknown is set.

-s, --match-substrings Include packages that partially match the provided names.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number or URI. This option can be used multiple times.

-t, --type type Type of package (default: package). See section Package Types for list of available package types.

--provides Show symbols the package provides.

--requires Show symbols the package requires.

--conflicts Show symbols the package conflicts with.

--obsoletes Show symbols the package obsoletes.

--recommends Show symbols the package recommends.

--suggests Show symbols the package suggests.

--supplements Show symbols the package supplements.

--enhances Show symbols the package enhances.

Examples:

$ zypper info workrave Show information about package workrave

$ zypper info -t patch libzypp Show information about patch libzypp

$ zypper info -t pattern lamp_server Show information about pattern lamp_server

install (in) [options] name|capability|rpm_file_uri... Install or update packages.

The packages can be selected by their name or by a capability they provide.

A capability is formed by "NAME[.ARCH][ OP EDITION]", where ARCH is an architecture code, OP is one of <, <=, =, >=, or > and EDITION is "VERSION[-RELEASE]". For example: zypper=0.8.8-2.

The NAME component of a capability is not only a package name but any symbol provided by packages: /bin/vi, libcurl.so.3, perl(Time::ParseDate). Just remember to quote to protect the special characters from the shell, for example: zypper>0.8.10 or 'zypper>0.8.10'.

If EDITION is not specified, the newest installable version will be installed. This also means that if the package is already installed and newer versions are available, it will get upgraded to the newest installable version.

If ARCH is not specified, or the last dot of the capability name string is not followed by known architecture, the solver will treat the whole string as a capability name. If the ARCH is known, the solver will select a package matching that architecture and complain if such package cannot be found.

If you want to make sure a package from a specific REPOSITORY is picked, use REPOSITORY:PACKAGENAME as argument.

Zypper is also able to install plain RPM files while trying to satisfy their dependencies using packages from defined repositories. You can install a plain RPM file by specifying its location in the install command arguments either as a local path or an URI. E.g.:

$ zypper install ~/rpms/foo.rpm http://some.site/bar.rpm

Zypper will report packages that it cannot find. Further, in interactive mode, zypper proceeds with installation of the rest of requested packages, and it will abort immediately in non-interactive mode. In both cases zypper returns ZYPPER_EXIT_INF_CAP_NOT_FOUND after finishing the operation.

Zypper will collect the files in a temporary plaindir repository and mark the respective packages for installation. If --download-only is used, the downloaded packages will be available in /var/cache/zypper/RPMS until you actually install them or call zypper clean to clear the package caches. They will not become part of the global package cache at /var/cache/zypp/packages (see also the global --pkg-cache-dir option).

In the install command, you can also specify packages you wish to remove by prepending their names by a - or ! character. For example:

$ zypper install !Firefox

In contrast to zypper remove Firefox which removes Firefox and its dependent packages, the install command will try to keep dependent packages installed by looking for Firefox alternatives.

Note that if you choose to use - with the first package you specify, you need to write -- before it to prevent its interpretation as a command option:

$ zypper install -- -boring-game great-game great-game-manual

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number or URI. This option can be used multiple times.

Using --repo is discouraged as it currently hides unmentioned repositories from the resolver, leading to inexpertly decisions. In the future --repo will become an alias for --from.

If you want to install a package from a specific repository, use REPOSITORY:PACKAGENAME as argument.

-t, --type type Type of package to install (default: package). See section Package Types for list of available package types. Use zypper se -t type [name] to look for available items of this type and zypper info -t type name to display more detailed information about the item.

If patch is specified, zypper will install and/or remove packages to satisfy specified patch. This is a way to ensure that specific bug fix is installed. Use zypper list-patches to look for applicable patches.

If product or pattern are specified, zypper ensures that all required (and optionally recommended) packages are installed.

-n, --name Select packages by their name, don’t try to select by capabilities.

-f, --force Install even if the item is already installed (reinstall), downgraded or changes vendor or architecture.

--oldpackage Allows one to replace a newer item with an older one. Handy if you are doing a rollback. Unlike --force it will not enforce a reinstall, if the item is already installed with the requested version.

--from alias|name|#|URI Select packages from specified repository. If strings specified as arguments to the install command match packages in repositories specified in this option, they will be marked for installation. This option currently implies --name, but allows using wildcards for specifying packages.

-C, --capability Select packages by capabilities.

-l, --auto-agree-with-licenses Automatically say yes to third party license confirmation prompt. By using this option, you choose to agree with licenses of all third-party software this command will install. This option is particularly useful for administrators installing the same set of packages on multiple machines (by an automated process) and have the licenses confirmed before.

--auto-agree-with-product-licenses Automatically accept product licenses only. This is used by tools like SUSEconnect, which ask for confirmation before the product gets registered. So there’s no need to confirm the product license again at install time.

--replacefiles Install the packages even if they replace files from other, already installed, packages. Default is to treat file conflicts as an error. --download-as-needed disables the file conflict check because access to all packages file lists is needed in advance in order to perform the check.

-D, --dry-run Test the installation, do not actually install any package. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts).

--details Show the detailed installation summary.

-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command.

--allow-unsigned-rpm Silently install unsigned .rpm packages given as commandline parameters. The option does not affect unsigned packages provided by repositories. To allow a repository to provide unsigned packages without explicit confirmation, set the repositories --gpgcheck-allow-unsigned-package option. See the addrepo and modifyrepo commands for details.

Solver related options:

--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report.

--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking.

In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments.

The allowance to remove dependent packages is the default when removing packages (zypper remove).

-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove).

--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details.

--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

Download-and-install mode options:

-d, --download-only Only download the packages for later installation (see also the global --pkg-cache-dir option).

If used together with --dry-run a meaningful file conflict check can be performed (see section Package File Conflicts).

--download-in-advance First download all packages, then start installing. This is the default.

--download-in-heaps Download a minimal set of packages that can be installed without leaving the system in broken state, and install them. Then download and install another heap until all are installed. This helps to keep the system in consistent state without the need to download all packages in advance, which combines the advantages of --download-in-advance and --download-as-needed.

Note

While the resolver is not capable of building heaps, this behaves the same as --download-in-advance.

--download-as-needed Download one package, install it immediately, and continue with the rest until all are installed.

--download mode Use the specified download-and-install mode. Available modes are: only, in-advance, in-heaps, as-needed. See corresponding --download-mode options for their description.

Expert Options: Don’t use them unless you know you need them.

--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables.

--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed.

--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables.

--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa).

Examples:

$ zypper install -t pattern lamp_server Install lamp_server pattern.

$ zypper install --no-recommends gv Install GhostScript viewer, but ignore recommended packages.

$ zypper install virtualbox-ose-2.0.6

$ zypper install virtualbox-ose=2.0.6

$ zypper install virtualbox-ose = 2.0.6 Install version 2.0.6 of virtualbox-ose package.

source-install (si) name... Install specified source packages and their build dependencies. If the name of a binary package is given, the corresponding source package is looked up and installed instead.

This command will try to find the newest available versions of the source packages and uses rpm -i to install them, optionally together with all the packages that are required to build the source package. The default location where rpm installs source packages to is /usr/src/packages/{SPECS,SOURCES}, but the values can be changed in your local rpm configuration. In case of doubt try executing rpm --eval "%{_specdir} and %{_sourcedir}".

Note that the source packages must be available in repositories you are using. You can check whether a repository contains any source packages using the following command:

$ zypper search -t srcpackage -r alias|name|#|URI

$ zypper search -t srcpackage -r alias|name|#|URI

-d, --build-deps-only Install only build dependencies of specified packages.

-D, --no-build-deps Don’t install build dependencies.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

--download-only Only download the packages, do not install.

Examples:

$ zypper si -d dbus-1 Install build dependencies of dbus-1 source package.

verify (ve) [options] Check whether dependencies of installed packages are satisfied.

In case that any dependency problems are found, zypper suggests packages to install or remove to fix them.

-D, --dry-run Test the repair, do not actually do anything to the system. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts).

--details Show the detailed installation summary.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command.

Solver related options:

--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report.

--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking.

In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments.

The allowance to remove dependent packages is the default when removing packages (zypper remove).

-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove).

--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details.

--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

Expert Options: Don’t use them unless you know you need them.

--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables.

--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed.

--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables.

--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa).

This command also accepts the Download-and-install mode options described in the install command.

install-new-recommends (inr) [options] Install newly added packages recommended by already installed ones. This command basically re-evaluates the recommendations of all installed packages and fills up the system accordingly. You don’t want to call this unconditionally on small or minimal systems, as it may easily add a large number of packages.

Called as zypper inr --no-recommends, it restricts the command to just look for packages supporting available hardware, languages or filesystems. Useful after having added e.g. new hardware or driver repos. This is also the default behavior if you have set [zypp.conf:solver.onlyRequires].

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

-D, --dry-run Test the installation, do not actually install anything. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts).

--details Show the detailed installation summary.

Solver related options:

--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report.

--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking.

In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments.

The allowance to remove dependent packages is the default when removing packages (zypper remove).

-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove).

--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details.

--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

Expert Options: Don’t use them unless you know you need them.

--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables.

--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed.

--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables.

--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa).

This command also accepts the Download-and-install mode options described in the install command.

remove (rm) [options] name...

remove (rm) [options] --capability capability... Remove (uninstall) packages.

The remove command will uninstall the selected and their dependent packages. It will not try to install alternatives in order to keep dependent packages installed. If you want this, use zypper install !name.

The packages can be selected by their name or by a capability they provide. For details on package selection see the install command description.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

-t, --type type Type of package (default: package). See section Package Types for list of available package types.

Since patches are not installed in sense of copying files or recording a database entry, they cannot be uninstalled, even though zypper shows them as installed. The installed status is determined solely based on the installed status of its required dependencies. If these dependencies are satisfied, the patch is rendered installed.

-n, --name Select packages by their name (default).

-C, --capability Select packages by capabilities.

-D, --dry-run Test the removal of packages, do not actually remove anything.

--details Show the detailed installation summary.

-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command.

Solver related options:

--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report.

--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking.

In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments.

The allowance to remove dependent packages is the default when removing packages (zypper remove).

-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove).

--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details.

-u, --clean-deps Automatically remove dependencies which become unneeded after removal of requested packages.

-U, --no-clean-deps No automatic removal of unneeded dependencies.

removeptf (rmptf) [options] <PTF|CAPABILITY> ... Remove (not only) PTFs.

A remove command which prefers replacing dependant packages to removing them as well. In fact this is a full featured install command with the remove modifier (-) applied to its plain arguments. So removeptf foo is the same as install — -foo. This is why the command accepts the same options as the install command. It is the recommended way to remove a PTF (Program Temporary Fix).

A PTF is typically removed as soon as the fix it provides is applied to the latest official update of the dependant packages. But you don’t want the dependant packages to be removed together with the PTF, which is what the remove command would do. The removeptf command however will aim to replace the dependant packages by their official update versions.

supports every option the install command supports

purge-kernels [options] Autoremoves installed kernels.

Automatically cleans up installed kernels according to the rules defined in [zypp.conf:multiversion.kernels] which can be given as <version>, latest[-N], running, oldest[+N].

--details Show the detailed installation summary.

-D, --dry-run Test the removal of packages, do not actually remove anything.

Update Management Commands list-updates (lu) [options] List available updates.

This command will list only installable updates, i.e. updates which have no dependency problems, or which do not change package vendor. This list is what the update command will propose to install. To list all packages for which newer version are available, use --all option.

-t, --type type Type of package (default: package). See section Package Types for list of available package types.

If patch is specified, zypper acts as if the list-patches command was executed.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

-a, --all List all packages for which newer versions are available, regardless whether they are installable or not.

--best-effort See the update command for description.

Expert Options: Don’t use them unless you know you need them.

--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables.

--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed.

--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables.

--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa).

update (up) [options] [packagename]... Update installed packages with newer versions, where possible.

This command will not update packages which would require change of package vendor unless the vendor is specified in /etc/zypp/vendors.d, or which would require manual resolution of problems with dependencies. Such non-installable updates will then be listed in separate section of the summary as "The following package updates will NOT be installed:".

To update individual packages, specify one or more package names. You can use the * and ? wildcard characters in the package names to specify multiple packages matching the pattern.

-t, --type type Type of package (default: package). See section Package Types for list of available package types.

If patch is specified, zypper acts as if the patches command was executed.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

--skip-interactive This will skip interactive patches, that is, those that need reboot, contain a message, or update a package whose license needs to be confirmed.

--with-interactive Avoid skipping of interactive patches when in non-interactive mode.

-l, --auto-agree-with-licenses Automatically say yes to third party license confirmation prompt. By using this option, you choose to agree with licenses of all third-party software this command will install. This option is particularly useful for administrators installing the same set of packages on multiple machines (by an automated process) and have the licenses confirmed before.

--auto-agree-with-product-licenses Automatically accept product licenses only. This is used by tools like SUSEconnect, which ask for confirmation before the product gets registered. So there’s no need to confirm the product license again at install time.

--replacefiles Install the packages even if they replace files from other, already installed, packages. Default is to treat file conflicts as an error. --download-as-needed disables the fileconflict check because access to all packages filelists is needed in advance in order to perform the check.

-D, --dry-run Test the update, do not actually install or update any package. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts).

--details Show the detailed installation summary.

--best-effort Do a best effort approach to update. This method does not explicitly select packages with best version and architecture, but instead requests installation of a package with higher version than the installed one and leaves the rest on the dependency solver. This method is always used for packages, and is optional for products and patterns. It is not applicable to patches.

-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command.

Solver related options:

--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report.

--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking.

In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments.

The allowance to remove dependent packages is the default when removing packages (zypper remove).

-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove).

--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details.

--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

Expert Options: Don’t use them unless you know you need them.

--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables.

--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed.

--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables.

--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa).

This command also accepts the Download-and-install mode options described in the install command description.

list-patches (lp) [options] List all applicable patches.

This command is similar to zypper list-updates -t patch.

Note that optional arguments of some of the following options must be specified using = instead of a space.

-b, --bugzilla[=#[,...]] List applicable patches for all Bugzilla issues, or issues whose number matches the given string.

--cve[=#[,...]] List applicable patches for all CVE issues, or issues whose number matches the given string.

--date YYYY-MM-DD[,...] List only patches issued up to, but not including, the specified date.

-g, --category category[,...] List only patches with this category. See section Package Types for a list of commonly used category values.

--severity severity[,...] List only patches with this severity. See section Package Types for a list of commonly used severity values.

--issue[=string[,...]] Look for issues whose number, summary, or description matches the specified string. Issues found by number are displayed separately from those found by descriptions. In the latter case, use zypper patch-info patchname to get information about issues the patch fixes.

-a, *--all By default, only patches that are applicable on your system are listed. This option causes all available released patches to be listed. This option can be combined with all the rest of the list-updates command options.

--with-optional, --without-optional Whether applicable optional patches should be treated as needed or be excluded. The default is to exclude optional patches.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

patch-check (pchk) Check for patches. Displays a count of applicable patches and how many of them have the security category.

See also the EXIT CODES section for details on exit status of 0, 100, and 101 returned by this command.

--updatestack-only Check only for patches which affect the package management itself.

--with-optional, --without-optional Whether applicable optional patches should be treated as needed or be excluded. The default is to exclude optional patches.

-r, --repo alias|name|#|URI Check for patches only in the repository specified by the alias, name, number, or URI. This option can be used multiple times.

patch [options] Install all available needed patches.

When updating the affected/vulnerable packages described by a patch, zypper always aims for the latest available version. See section Package Types for more details about how patches operate.

If there are patches that affect the package management itself, those will be installed first and you will be asked to run the patch command again.

This command is similar to zypper update -t patch.

--updatestack-only Install only patches which affect the package management itself and exit.

--skip-not-applicable-patches Skip needed patches which do not apply without conflict. In normal operation mode those conflicts have to be resolved interactively, otherwise the patch command fails.

In scripted and unattended environments it may be desired to try to apply at least as many patches as possible so the system is not left completely without updates. It is highly recommended to run zypper patch-check afterwards in order to see whether needed patches are still waiting to be resolved interactively.

--with-update Additionally try to update all packages not covered by patches. This is basically the same as running zypper update afterwards.

The option is ignored, if the patch command must update the update stack first, thus it can not be combined with the --updatestack-only option.

--with-optional, --without-optional Whether applicable optional patches should be treated as needed or be excluded. The default is to exclude optional patches.

-b, --bugzilla #[,...] Select applicable patches for a Bugzilla issue specified by number. Use list-patches --bugzilla command to get a list of applicable patches for specific issues.

--cve #[,...] Select applicable patches for a MITRE’s CVE issue specified by number. Use list-patches --cve command to get a list of applicable patches for specific issues.

--date YYYY-MM-DD[,...] Select only patches patches issued up to, but not including, the specified date.

-g, --category category[,...] Select only patches with this category. Use list-patches --category command to get a list of available patches with a specific category. See section Package Types for a list of commonly used category values.

--severity severity[,...] Select only patches with this severity. Use list-patches --severity command to get a list of available patches with a specific severity. See section Package Types for a list of commonly used severity values.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

--skip-interactive This will skip interactive patches, that is, those that need reboot, contain a message, or update a package whose license needs to be confirmed.

--with-interactive Avoid skipping of interactive patches when in non-interactive mode.

-l, --auto-agree-with-licenses Automatically say yes to third party license confirmation prompt. By using this option, you choose to agree with licenses of all third-party software this command will install. This option is particularly useful for administrators installing the same set of packages on multiple machines (by an automated process) and have the licenses confirmed before.

--auto-agree-with-product-licenses Automatically accept product licenses only. This is used by tools like SUSEconnect, which ask for confirmation before the product gets registered. So there’s no need to confirm the product license again at install time.

--replacefiles Install the packages even if they replace files from other, already installed, packages. Default is to treat file conflicts as an error. --download-as-needed disables the fileconflict check because access to all packages filelists is needed in advance in order to perform the check.

-D, --dry-run Test the update, do not actually update. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts).

--details Show the detailed installation summary.

-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command.

Solver related options:

--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report.

--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking.

In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments.

The allowance to remove dependent packages is the default when removing packages (zypper remove).

-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove).

--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details.

--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

Expert Options: Don’t use them unless you know you need them.

--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables.

--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed.

--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables.

--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa).

This command also accepts the Download-and-install mode options described in the install command description.

dist-upgrade (dup) [options] Perform a distribution upgrade. This command applies the state of (specified) repositories onto the system; upgrades (or even downgrades) installed packages to versions found in repositories, removes packages that are no longer in the repositories and pose a dependency problem for the upgrade, handles package splits and renames, etc.

If no repositories are specified via the --from option, zypper will do a global upgrade with all defined repositories. This global form of dup will also consider unchanged installed packages and re-evaluate their dependencies. This can be a problem if the system contains conflicting repositories, like repositories for two different distribution releases. This often happens if one forgets to remove an older release repository after adding a new one, say openSUSE 13.1 and openSUSE 13.2.

For all repositories which have the distribution version within their URL (like https://download.opensuse.org/distribution/13.1/repo/oss) using the $releasever variable instead may be helpful (https://download.opensuse.org/distribution/$releasever/repo/oss). The variable is per default substituted by the current distributions version (13.1).

This value can be temporarily overwritten in the current zypper command by using the --releasever global option. Calling zypper --releasever 13.2... will cause these repos to use the new location (https://download.opensuse.org/distribution/13.2/repo/oss) without the need to add/remove anything. But you’ll need to use --releasever 13.2 with every zypper command until the distribution upgrade was actually performed. Once the dup is done, $releasever will default to the new distribution version 13.2 and --releasever is no longer needed.

It might be less tedious to persistently set $releasever to the target distribution value, so --releasever is not needed at all. See section Repository Management for more info about variable substitution and the definition of custom variables.

Note: Performing a distribution upgrade will automatically create a solver test case at /var/log/updateTestcase-YYYY-MM-DD-hh-mm-ss (the date and time the command was executed).

Note: distribution upgrades in openSUSE are currently only supported between consecutive releases. To upgrade multiple releases, upgrade each consecutive release one at a time. For more details see http://en.opensuse.org/SDB:System_upgrade and the openSUSE release notes at http://doc.opensuse.org/release-notes/.

Note: Due to the treatment of orphaned packages dist-upgrade depends on a proper repository setup more than any other command. It must not continue if enabled repositories fail to refresh. This may severely damage the system. If a failing repository is actually not needed, it must be disabled.

--from alias|name|#|URI The option can be used multiple times and restricts the upgrade to the specified repositories only. Nevertheless all enabled repositories are visible to the resolver and will be considered to satisfy dependency problems.

--remove-orphaned Remove orphaned packages. Installed packages which are not provided by at least one of the available repositories are considered to be orphaned or dropped. dist-upgrade removes orphaned packages if they prevent the upgrade of wanted packages. With this option all unneeded orphaned packages are removed.

'Note:' Packages which are not shipped within a repository - manually built or downloaded ones -, can be collected in a plaindir repository to prevent them from being treated as orphaned. See section *System Packages* for details.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI.

Using --repo is discouraged as it currently hides unmentioned repositories from the resolver, leading to inexpertly decisions. This is because packages originally installed from the hidden repos will now be treated as orphaned or dropped. They can be silently removed if involved in a dependency conflict. In the future --repo will become an alias for --from.

-l, --auto-agree-with-licenses Automatically say yes to third party license confirmation prompt. By using this option, you choose to agree with licenses of all third-party software this command will install. This option is particularly useful for administrators installing the same set of packages on multiple machines (by an automated process) and have the licenses confirmed before.

--auto-agree-with-product-licenses Automatically accept product licenses only. This is used by tools like SUSEconnect, which ask for confirmation before the product gets registered. So there’s no need to confirm the product license again at install time.

--replacefiles Install the packages even if they replace files from other, already installed, packages. Default is to treat file conflicts as an error. --download-as-needed disables the fileconflict check because access to all packages filelists is needed in advance in order to perform the check.

-D, --dry-run Test the upgrade, do not actually install or update any package. If used together with --download-only a meaningful file conflict check can be performed (see section Package File Conflicts).

-y, --no-confirm Don’t require user interaction. It’s recommended to use the --non-interactive global option instead. Global options are passed before the command (zypper --non-interactive COMMAND ...). Unlike the no-confirm command option, the global option can be used together with any zypper command.

--details Show the detailed installation summary.

Solver related options:

--debug-solver Create solver test case for debugging. Use this option if you think the dependencies were not solved correctly. When using this option no packages will be installed or removed. Instead a solver test case is written to /var/log/zypper.solverTestCase. You can pack the directory and attach it to your bug report.

--force-resolution Force the solver to find a solution (even an aggressive one) rather than asking.

In order to perform the requested job the solver is allowed to violate any otherwise active policy. This includes the allowance to remove packages but also not to respect even explicitly set policies (by --no-allow-policy or in config files). It is not recommended to use this option in unattended environments.

The allowance to remove dependent packages is the default when removing packages (zypper remove).

-R, --no-force-resolution Do not force the solver to find a solution. Instead, report dependency problems and prompt the user to resolve them manually. This is the default except when removing packages (zypper remove).

--solver-focus MODE Set the solvers general attitude when resolving a job. Valid modes are Job, Installed or Update. See section Package Dependencies for details.

--recommends Install also recommended packages in addition to the required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

--no-recommends Do not install recommended packages, but only required ones. The default behavior is determined by [zypp.conf:solver.onlyRequires].

Expert Options: Don’t use them unless you know you need them.

--allow-downgrade, --no-allow-downgrade Whether to allow downgrading installed resolvables.

--allow-name-change, --no-allow-name-change Whether to allow changing the names of installed resolvables. Setting this to no will not replace packages which have been renamed.

--allow-arch-change, --no-allow-arch-change Whether to allow changing the architecture of installed resolvables.

--allow-vendor-change, --no-allow-vendor-change Whether to allow changing the vendor of installed resolvables. Setting this to no might be useful if you do not want packages from foreign repos being changed to the distributions version (or vice versa).

This command also accepts the Download-and-install mode options described in the install command description.

Examples:

$ zypper dup --from factory --from packman Upgrade the system to the latest versions provided by the factory and packman repositories.

Query Commands search (se) [options] [querystring|capability]... Search for packages matching any of the given search strings. * and ? wildcard characters can be used within search strings. If the search string is enclosed in / (e.g. /^k.*e$/) it’s interpreted as a regular expression. See the install command for details about how to specify a capability.

If the search string starts with a /, a filename is assumed and the search will automatically look into the file list of packages. Otherwise use -f to search in the packages file lists as well.

Results of the search are printed in a table with columns Status, Name, Summary and Type of package. In case the query result is empty zypper returns ZYPPER_EXIT_INF_CAP_NOT_FOUND, unless the --ignore-unknown global option is set.

In the detailed view (se -s) all available instances of matching packages are shown; each version in each repository on a separate line, with columns Status, Name, Type, Version, Architecture and Repository. For installed packages Repository shows either a repository that provides exactly the installed version of the package, or, if the exact version is not provided by any known repo, (System Packages) (or @System). Those installed packages not provided by any repo are often denoted as being unwanted, orphaned or dropped.

The Status column can contain the following values:

i+ installed by user request

i installed automatically (by the resolver, see section Automatically installed packages)

v a different version is installed

empty neither of the above cases

! a patch in needed state

.l is shown in the 2nd column if the item is locked (see section Package Locks Management)

.P is shown in the 2nd column if the item is part of a PTF (A program temporary fix which must be explicitly selected and will otherwise not be considered in dependency resolution).

.R is shown in the 2nd column if the item has been retracted (see patch in section Package Types)

The v status is only shown if the version or the repository matters (see --details or --repo), and the installed instance differs from the one listed in version or repository.

The verbose view (se -v; implies -s) will also show the matches themselves within the packages metadata.

This command accepts the following options:

--match-substrings Matches for search strings may be partial words (default).

--match-words Matches for search strings may only be whole words.

-x, --match-exact Searches for an exact name of the package.

--provides Search for packages which provide the search strings.

--requires Search for packages which require the search strings.

--recommends Search for packages which recommend the search strings.

--suggests Search for packages which suggest the search strings.

--conflicts Search for packages conflicting with the search strings.

--obsoletes Search for packages which obsolete the search strings.

--supplements Search for packages which supplement the search strings.

--enhances Search for packages which enhances the search strings.

--provides-pkg Search for all packages that provide any of the provides of the package(s) matched by the input parameters.

--requires-pkg Search for all packages that require any of the provides of the package(s) matched by the input parameters.

--recommends-pkg Search for all packages that recommend any of the provides of the package(s) matched by the input parameters.

--supplements-pkg Search for all packages that supplement any of the provides of the package(s) matched by the input parameters.

--conflicts-pkg Search for all packages that conflict with any of the package(s) matched by the input parameters.

--obsoletes-pkg Search for all packages that obsolete any of the package(s) matched by the input parameters.

--suggests-pkg Search for all packages that suggest any of the provides of the package(s) matched by the input parameters.

--enhances-pkg Search for all packages that enhance any of the provides of the package(s) matched by the input parameters.

-n, --name Useful together with dependency options, otherwise searching in package name is default.

-f, --file-list Search in the file list of packages. Note that the full file list is available for installed packages only. For remote packages only an abstract of their file list is available within the metadata (files containing /etc/, /bin/, or /sbin/).

-d, --search-descriptions Search also in summaries and descriptions.

-C, --case-sensitive Perform case-sensitive search.

-i, --installed-only Show only installed packages.

-u, --not-installed-only Show only packages which are not installed.

The old option name --uninstalled-only is still acceptable, but should be considered deprecated.

-t, --type type Search only for packages of specified type. See section Package Types for a list of available package types. Multiple --type options are allowed.

See also the type-specific query commands like packages, patterns, etc.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number, or URI. This option can be used multiple times.

--sort-by-name Sort packages by name (default).

--sort-by-repo Sort packages by repository, not by name.

-s, --details Show all available versions of matching packages, each version in each repository on a separate line.

-v, --verbose Like --details with additional information where the search has matched (useful when searching for dependencies, e.g. --provides).

Examples:

$ zypper se 'yast*' Search for YaST packages (quote the string to prevent the shell from expanding the wildcard).

$ zypper se -s --match-exact kernel-default Show all available versions of package kernel-default

$ zypper se -dC --match-words RSI Look for RSI acronym (case-sensitively), also in summaries and descriptions.

packages (pa) [options] [repository]... List all available packages or all packages from specified repositories. Similar to zypper search -s -t package.

-r, --repo alias|name|#|URI Just another means to specify repositories.

-i, --installed-only Show only installed packages.

-u, --not-installed-only Show only packages which are not installed.

The old option name --uninstalled-only is still acceptable, but should be considered deprecated.

*--autoinstalled Show installed packages which were automatically selected by the resolver.

--userinstalled Show installed packages which were explicitly selected by the user.

--system Show installed packages which are not provided by any repository.

--orphaned Show system packages which are orphaned (without repository and without update candidate). If combined with --system, the status of orphaned packages is tagged with (o).

--suggested Show packages which are suggested.

--recommended Show packages which are recommended.

--unneeded Show packages which are unneeded.

patches (pch) [options] [repository]... List all available patches from specified repositories, including those not needed. Short for zypper lp -a.

-r, --repo alias|name_|#|URI Just another means to specify repositories.

patterns (pt) [options] [repository]... List all available patterns or all patterns from specified repositories. Similar to zypper search -s -t pattern.

-r, --repo alias|name|#|URI Just another means to specify repositories.

-i, --installed-only Show only installed patterns.

-u, --not-installed-only Show only patterns which are not installed.

The old option name --uninstalled-only is still acceptable, but should be considered deprecated.

products (pd) [options] [repository]... List all available products or all products from specified repositories. Similar to zypper search -s -t product, but shows also the type of the product (base, add-on).

-r, --repo alias|name|#|URI Just another means to specify repositories.

-i, --installed-only Show only installed products.

-u, --not-installed-only Show only products which are not installed.

The old option name --uninstalled-only is still acceptable, but should be considered deprecated.

--xmlfwd tag XML output only: Literally forward the XML tag, if it is found in an installed products .prod-file (in /etc/products.d).

Using this option, for each installed product an <xmlfwd> node will be created inside the <product> output node of the product.

Tag defines the name (or /-separated path) of a xml-tag inside an installed products .prod-file. If the tag is present inside the products .prod-file, the tag and it’s content is literally forwarded into the products <xmlfwd> output node.

The option may be specified multiple times.

Examples:

$ zypper -x pd --xmlfwd name --xmlfwd register/target

what-provides (wp) capability List all packages providing the specified capability (case-insensitive search). See also the install command for info about specifying capabilities.

The command line is automatically transformed into the corresponding search command:

$ zypper what-provides 'zypper>1.6' $ zypper search --provides --match-exact 'zypper>1.6'

For a case-sensitive search call $ zypper search --provides --match-exact --case-sensitive 'zypper>1.6'

Repository Management Zypper is able to work with YaST, RPM-MD (yum) software repositories, and plain directories containing .rpm files (no symlinks).

Repositories are primarily identified using their URI or alias. Alias serves as a shorthand for the long URI or name of the repository. The name of the repository should briefly describe the repository and is shown to the user in tables and messages. The name is not required, and if not known, the alias is shown instead. The alias is required and uniquely identifies the repository on the system.

The alias, name, URI, or the number from zypper repos list can be used to specify a repository as an argument of various zypper commands and options like refresh, --repo, or --from.

Apart from the above, repositories have several other properties which can be set using the commands described in this section below, or by manually editing the repository definition files (.repo files, see section FILES).

Variable substitution: You can use the following variables within a .repo or .service files name and URI values:

$arch Use this variable to refer to the system’s CPU architecture.

$basearch Use this variable to refer to the base architecture of the system. For example, iX86 machines have a base architecture of i386, while AMD64 and Intel64 have x86_64.

$releasever, $releasever_major, $releasever_minor Use this variable to refer to the version of your openSUSE or SUSE Linux. The value is obtained from the /product/version XML-node in /etc/products.d/baseproduct.

This is useful for related repositories like packman (http://ftp.gwdg.de/pub/linux/packman/suse/$releasever), which shall always fit the installed distribution, even after a distribution upgrade.

To help performing a distribution upgrade, the value of $releasever can be persistently set to a user defined value by creating a custom variable with that name (see below). This way you can easily switch all repositories using $releasever to the new version (provided the server layouts did not change and new repos are already available).

For a single zypper command the value of $releasever can be temporarily overwritten by using the --releasever global option.

In addition $releasever_major will be set to the leading portion up to (but not including) the 1st dot; $releasever_minor to the trailing portion after the 1st dot. If there’s no dot in $releasever, $releasever_major is the same as $releasever and $releasever_minor is empty.

Custom Variables A custom repository variable is defined by creating a file in /etc/zypp/vars.d. The variable name equals the file name. The files first line (up to but not including the newline character) defines the variables value. Valid variable(file) names consist of alphanumeric chars and underscore only.

This is how you can set a custom variable, e.g. $releasever to a value of 99.0: echo "99.0" >/etc/zypp/vars.d/releasever

To remove the custom variable, simply delete its file in /etc/zypp/vars.d: rm /etc/zypp/vars.d/releasever

To check where you already use $releasever call: zypper --releasever @--HERE--@ lr -u

Remember to protect the $ when using these variables on a shell command line: zypper ar -f http://ftp.gwdg.de/pub/linux/packman/suse/$releasever packman

If a variable is followed by an alphanumeric character or underscore it needs to be enclosed in {}: zypper ar -f http://ftp.gwdg.de/pub/linux/packman/suse/${releasever}_packman

Bash style definition of default ${variable:-word} and alternate ${variable:+word} values: SLE-${releasever_major}${releasever_minor:+-SP-$releasever_minor}

NOTE: Variable substitution within an URIs authority is limited to host and port. Bash style definition of default and alternate values is not supported. No variables can be used in an URIs scheme, user and password.

Supported URI formats: scheme:@]host[:port]]/path[?query][#fragment] Special characters occurring in URI components (like a '@' in a password) must be %-encoded ('%40').

CD or DVD drive Optionally with devices list for probing.

• cd:/// dvd:/subdir?devices=/dev/sr0,/dev/sr1

FTP/HTTP/HTTPS directory tree The ftp URL scheme supports absolute and relative paths to the default ftp server directory (RFC1738, Section 3.2.2). To use an absolute path, you have to prepend the path with an additional slash, what results in a /%2f combination (second / encoded to %2f) at the begin of the URL path. This is important, especially in user authenticated ftp, where the users home is usually the default directory of the server (except when the server chroots into the users home directory).

Explicit proxy settings may be passed via optional parameters proxy, proxyport, proxyuser and proxypass.

HTTP authentication methods to use can be defined as comma separated list via optional parameter auth. Valid methods are e.g. basic, digest, ntlm, negotiate. Note, that this list depends on the list of methods supported by the curl library.

SSL verification behavior can be changed using the ssl_verify option (this should be used with care). Valid values are yes (the secure default), host, peer or no. Host just checks that the "Common Name" field or a "Subject Alternate Name" field in the servers certificate matches the host name in the URL. Peer just verifies whether the certificate provided by the server is authentic against the chain of digital signatures found in ssl_capath. No performs no checks at all. Yes is the secure default, performing host and peer check.

For SSL client certificate authentication use the options ssl_clientcert to define the path to the ssl client certificate and ssl_clientkey to define the path to the SSL client key. Use ssl_capath to change the directory holding the CA certificates (default is /etc/ssl/certs).

• ftp://user:pass@server/path/to/media/dir ftp://user:pass@server/%2fhome/user/path/to/media/dir http://user:pass@server/path https://user:pass@server/path?proxy=foo&proxyuser=me&proxypass=pw https://server/path?ssl_clientcert=/entitlement/1234.pem&ssl_clientkey=/entitlement/1234-key.pem

Disk volume (partition) Mandatory device parameter specifying the name of the block device to mount. The name of the optional filesystem defaults to "auto".

• hd:/subdir?device=/dev/sda1&filesystem=reiserfs

Local directory tree

• dir:/directory/name

Media in an ISO image (loopback mounted) Mandatory iso parameter specifying the name of the iso file. Optional url parameter specifying the URL to the directory containing the iso file. Optional mnt parameter specifying the preferred attach point for the source media url. Optional filesystem name of the filesystem used in the iso file. Defaults to "auto".

• iso:/?iso=CD1.iso&url=nfs://server/path/to/media iso:/?iso=CD1.iso&url=hd:/?device=/dev/hda iso:/subdir?iso=DVD1.iso&url=nfs://nfs-server/directory&mnt=/nfs/attach/point&filesystem=udf

NFS exported directory tree To use NFSv4 either use schema tnfsv4:// or pass an optional parameter type=nfs4. Additional mountoptions can be passed as comma separated list. Defaults to "ro".

• nfs://nfs-server/exported/path nfs://nfs-server/exported/path?mountoptions=ro&type=nfs4 nfs4://nfs-server/exported/path?mountoptions=ro

CIFS/SMB directory tree There is no difference between cifs and smb scheme (any more). In both cases the cifs filesystem is used. Additional mountoptions can be passed as comma separated list. Defaults to "ro,guest". Specify "noguest" to turn off "guest". This is necessary if Samba is configured to reject guest connections.

Optional workgroup or domain parameter set the name of the workgroup. As alternative to passing username:password in the URI authority the parameters user and pass can be used.

• smb://servername/share/path/on/the/share cifs://usern:passw@servername/share/path/on/the/share?mountoptions=ro,noguest cifs://usern:passw@servername/share/path/on/the/share?workgroup=mygroup cifs://servername/share/path/on/the/share?user=usern&pass=passw

OpenSUSE Build Build Service (OBS) repositories Zypper also accepts special URIs identifying openSUSE Build Service (OBS) repositories in the addrepo command. These URIs have the form of obs://project/[platform], where project is the name of the OBS project and platform is the target platform (OS) for which the repository is intended.

If platform is omitted, openSUSE_$releasever is used unless a value for obs.platform is defined in zypper.conf. If you are following openSUSE_Factory or openSUSE_Tumbleweed you may need to set these as your default platform. But we can only guess, how the directory containing the repository that fits your distribution is named on the server. In case of doubt you need to look up the right URL in a browser.

• obs://zypp:Head/ obs://zypp:Head/openSUSE_Factory obs://zypp:Head/openSUSE_Factory_Staging_Gcc49_standard

Commands: addrepo (ar) [options] URI alias

addrepo (ar) [options] FILE*.repo* Add a new repository specified by URI and assign specified alias to it or specify URI to a .repo file.

Newly added repositories have auto-refresh disabled by default (except for repositories imported from a .repo, having the auto-refresh enabled). To enable auto-refresh use addrepo -f, or the --refresh option of the modifyrepo command.

Also, this command does not automatically refresh the newly added repositories. The repositories will get refreshed when used for the first time, or you can use the refresh command after finishing your modifications with *repo commands.

-r, --repo file.repo Read URI and alias from specified .repo file

-c, --check Probe given URI.

-C, --no-check Don’t probe URI, probe later during refresh.

-n, --name name Specify descriptive name for the repository.

-e, --enable Enable the repository (the default).

-d, --disable Add the repository as disabled. Repositories are added as enabled by default.

-f, --refresh Enable autorefresh of the repository. The autorefresh is disabled by default when adding new repositories.

-F, --no-refresh Disable auto-refresh for the repository.

-p, --priority [1-2147483647]|0 Set the priority of the repository. Priority of 1 is the highest, and 2147483647 is the lowest. -p 0 will set the priority back to the default (99). Packages from repositories with higher priority will be used even if there are better versions available in a repository with a lower priority.

-k, --keep-packages Enable RPM files caching for the repository.

-K, --no-keep-packages Disable RPM files caching.

-g, --gpgcheck Enable GPG check for this repository. The behavior as described in section GPG checks.

--gpgcheck-strict Enable strict GPG check for this repository. Even packages from signed repositories need a valid GPG signature and using unsigned packages must be confirmed.

--gpgcheck-allow-unsigned Short hand for --gpgcheck-allow-unsigned-repo --gpgcheck-allow-unsigned-package

--gpgcheck-allow-unsigned-repo Enable GPG check but allow the repository metadata to be unsigned.

--gpgcheck-allow-unsigned-package Enable GPG check but allow installing unsigned packages from this repository.

-G, --no-gpgcheck Disable GPG check for this repository.

Disabling GPG checks is not recommended. Signing data enables the recipient to verify that no modifications occurred after the data were signed. Accepting data with no, wrong or unknown signature can lead to a corrupted system and in extreme cases even to a system compromise.

--default-gpgcheck Use the global GPG check settings defined in /etc/zypp/zypp.conf. This is the default.

Unless you have modified your zypp.conf settings, this is the same as --gpgcheck, the behavior as described in section GPG checks.

Examples:

$ zypper ar -c -n 'Packman 11.1 repo' http://packman.iu-bremen.de/suse/11.1 packman Add a HTTP repository, probe it, name it Packman 11.1 repo, and use packman as alias.

$ zypper ar https://download.opensuse.org/repositories/zypp:/svn/openSUSE_Factory/zypp:svn.repo

$ zypper ar myreposbackup.repo Add repositories from a .repo file.

removerepo (rr) [options] alias|name|#|URI... Delete repositories specified by aliases, names, numbers, URIs or one of the aggregate options.

--loose-auth Ignore user authentication data in the URI

--loose-query Ignore query string in the URI

-a, --all Apply changes to all repositories.

-l, --local Apply changes to all local repositories.

-t, --remote Apply changes to all remote repositories (http/https/ftp).

-m, --medium-type type Apply changes to repositories of specified type. The type corresponds to the repository URI scheme identifier like http, dvd, etc. You can find complete list of valid types at http://en.opensuse.org/openSUSE:Libzypp_URIs.

repos (lr) [options] [repo]... List all defined repositories or show detailed information about those specified as arguments

The following data can be printed for each repository found on the system: # (repository number), Alias (unique identifier), Name, Enabled (whether the repository is enabled), GPG Check (whether GPG check for repository metadata (r) and/or downloaded rpm packages (p) is enabled), Refresh (whether auto-refresh is enabled for the repository), Priority, Type (repository meta-data type: rpm-md, yast2, plaindir). Which of the data is shown is determined by command line options listed below and the main.repoListColumns setting from zypper.conf. By default, #, Alias, Name, Enabled, GPG Check and Refresh is shown.

Repository number is a unique identifier of the repository in current set of repositories. If you add, remove or change a repository, the numbers may change. Keep that in mind when using the numbers with the repository handling commands. On the other hand, using the alias instead of the number is always safe.

To show detailed information about specific repositories, specify them as arguments, either by alias, name, number from simple zypper lr, or by URI; e.g. fB zypper lr factory, or zypper lr 2.

-e, --export FILE.repo|- This option causes zypper to write repository definition of all defined repositories into a single file in repo file format. If - is specified instead of a file name, the repositories will be written to the standard output.

-a, --alias Add alias column to the output.

-n, --name Add name column to the output.

-u, --uri Add base URI column to the output.

-p, --priority Add repository priority column to the output.

-r, --refresh Add the autorefresh column to the output.

-k, --keep-packages Add the keep-packages column to the output. The column will show a Yes if keep-packages is explicitly enabled for this repository. Otherwise a - or a + if a .keep_packages file in the pkg-cache directory exists. (see section FILES)

-d, --details Show more information like URI, priority, type, etc.

-E, --show-enabled-only Show enabled repositories only.

-U, --sort-by-uri Add base URI column and sort the list it.

-P, --sort-by-priority Add repository priority column and sort the list by it.

-A, --sort-by-alias Sort the list by alias.

-N, --sort-by-name Sort the list by name.

Examples:

$ zypper repos -e myreposbackup.repo Backup your repository setup:

$ zypper lr -pu List repositories with their URIs and priorities:

renamerepo (nr) alias|name|#|URI new-alias Assign new alias to the repository specified by alias, name, number, or URI.

Examples:

$ zypper nr 8 myrepo Rename repository number 8 to myrepo (useful if the repo has some dreadful alias which is not usable on the command line).

modifyrepo (mr) options alias|name|#|URI...

modifyrepo (mr) options --all|--remote|--local|--medium-type Modify properties of repositories specified by alias, name, number, or URI or one of the aggregate options.

-n, --name name Set a descriptive name for the repository.

-e, --enable Enable the repository.

-d, --disable Disable the repository.

-f, --refresh (legacy: -r) Enable auto-refresh for the repository.

-F, --no-refresh (legacy: -R) Disable auto-refresh for the repository.

-p, --priority [1-2147483647]|0 Set the priority of the repository. Priority of 1 is the highest, and 2147483647 is the lowest. -p 0 will set the priority back to the default (99). Packages from repositories with higher priority will be used even if there are better versions available in a repository with a lower priority.

-k, --keep-packages Enable RPM files caching.

-K, --no-keep-packages Disable RPM files caching.

-g, --gpgcheck Enable GPG check for this repository. The behavior as described in section GPG checks.

--gpgcheck-strict Enable strict GPG check for this repository. Even packages from signed repositories need a valid GPG signature and using unsigned packages must be confirmed.

--gpgcheck-allow-unsigned Short hand for --gpgcheck-allow-unsigned-repo --gpgcheck-allow-unsigned-package

--gpgcheck-allow-unsigned-repo Enable GPG check but allow the repository metadata to be unsigned.

--gpgcheck-allow-unsigned-package Enable GPG check but allow installing unsigned packages from this repository.

-G, --no-gpgcheck Disable GPG check for this repository.

Disabling GPG checks is not recommended. Signing data enables the recipient to verify that no modifications occurred after the data were signed. Accepting data with no, wrong or unknown signature can lead to a corrupted system and in extreme cases even to a system compromise.

--default-gpgcheck Use the global GPG check settings defined in /etc/zypp/zypp.conf. This is the default.

Unless you have modified your zypp.conf settings, this is the same as --gpgcheck, the behavior as described in section GPG checks.

-a, --all Apply changes to all repositories.

-l, --local Apply changes to all local repositories.

-t, --remote Apply changes to all remote repositories (http/https/ftp).

-m, --medium-type type Apply changes to repositories of specified type. The type corresponds to the repository URI scheme identifier like http, dvd, etc. You can find complete list of valid types at http://en.opensuse.org/openSUSE:Libzypp_URIs.

Examples:

$ zypper mr -kt Enable keeping of packages for all remote repositories.

$ zypper mr -er updates Enable repository updates and switch on autorefresh for the repo.

$ zypper mr -da Disable all repositories.

refresh (ref) [alias|name|#|URI]... Refresh repositories specified by their alias, name, number, or URI. If no repositories are specified, all enabled repositories will be refreshed.

-f, --force Force a complete refresh of specified repositories. This option will cause both the download of raw metadata and parsing of the metadata to be forced even if everything indicates a refresh is not needed.

-b, --force-build Force only reparsing of cached metadata and rebuilding of the database. Raw metadata download will not be forced.

-d, --force-download Force only download of current copy of repository metadata. Parsing and rebuild of the database will not be forced.

-B, --build-only Only parse the metadata and build the database, don’t download raw metadata into the cache. This will enable you to repair damaged database from cached data without accessing network at all.

-D, --download-only Only download the raw metadata, don’t parse it or build the database.

--include-all-archs Multi-Arch repos: Download raw metadata for all offered architectures even if the repo supports filtering. Otherwise we’d download only the metadata for architectures compatible with the local system. You do not need this unless you want zypper to provide the full metadata for the purpose of mirroring the repository.

-s, --services Refresh also services before refreshing repositories.

clean (cc) [options] [alias|name|#|URI]... Clean the local caches for all known or specified repositories. By default, only caches of downloaded packages are cleaned.

-m, --metadata Clean repository metadata cache instead of package cache.

-M, --raw-metadata Clean repository raw metadata cache instead of package cache.

-a, --all Clean both repository metadata and package caches.

Service Management The services, addservice, removeservice, modifyservice, and refresh-services commands serve for manipulating services. A service is specified by its URI and needs to have a unique alias defined (among both services and repositories).

Standalone repositories (not belonging to any service) are treated like services, too. The ls command will list them, ms command will modify them, etc. Repository specific options, like --keep-packages are not available here, though. You can use repository handling commands to manipulate them.

addservice (as) [options] URI alias Adds a service specified by URI to the system. The alias must be unique and serves to identify the service. If a service with the same alias and URI already exists, the command behaves like modifyservice and updates the settings accordingly.

Newly added services are not refreshed automatically. Use the refresh-services command to refresh them. Zypper does not access the service URI when adding the service, so the type of the services is unknown until it is refreshed.

-n, --name name Specify descriptive name for the service.

-e, --enable Enable the service (this is the default).

-d, --disable Add the service as disabled.

-f, --refresh Enable auto-refresh of the service.

-F, --no-refresh Disable auto-refresh of the service.

removeservice (rs) [options] alias|name|#|URI... Remove specified service from the system. Removing a service will also remove of all of its repositories.

--loose-auth Ignore user authentication data in the URI.

--loose-query Ignore query string in the URI.

modifyservice (ms) options alias|name|#|URI

modifyservice (ms) options --all|--remote|--local|--medium-type Modify properties of specified services.

Common Options These options are common to all types of services and repositories.

-n, --name name Set a descriptive name for the service.

-e, --enable Enable a disabled service.

-d, --disable Disable the service (but don’t remove it).

-f, --refresh (legacy: -r) Enable auto-refresh of the service.

-F, --no-refresh (legacy: -R) Disable auto-refresh of the service.

-a, --all Apply changes to all services.

-l, --local Apply changes to all local services.

-t, --remote Apply changes to all remote services.

-m, --medium-type type Apply changes to services of specified type.

RIS Service Specific Options These options are ignored by services other than Repository Index Services.

-i, --ar-to-enable alias Schedule an RIS service repository to be enabled at next service refresh.

-I, --ar-to-disable alias Schedule an RIS service repository to be disabled at next service refresh.

-j, --rr-to-enable alias Remove a RIS service repository to enable.

-J, --rr-to-disable alias Remove a RIS service repository to disable.

-k, --cl-to-enable Clear the list of RIS repositories to enable.

-K, --cl-to-disable Clear the list of RIS repositories to disable.

services (ls) [options] List services defined on the system.

-u, --uri Show also base URI of repositories.

-p, --priority Show also repository priority.

-d, --details Show more information like URI, priority, type.

-r, --with-repos Show also repositories belonging to the services.

-P, --sort-by-priority Sort the list by repository priority.

-E, --show-enabled-only Show enabled services only. If used together with --with-repos a disabled services owning (manually) enabled repositories are shown as well.

-U, --sort-by-uri Sort the list by URI.

-N, --sort-by-name Sort the list by name.

refresh-services (refs) [options] alias|name|#|URI... Refreshing a service means executing the service’s special task.

RIS services add, remove, or modify repositories on your system based on current content of the repository index. A differing enabled/disabled state caused by manually calling modify-repo on a service repository however will not be reverted unless the --restore-status option is used, or the repository index explicitly requests the change.

Services only manage defined repositories, they do not refresh them. To refresh also repositories, use --with-repos option or the refresh command.

-f, --force Force a complete refresh of specified services. This option will cause both the download of raw metadata and parsing of the metadata to be forced even if everything indicates a refresh is not needed.

-r, --with-repos Refresh also the service repositories.

-R, --restore-status Also restore service repositories enabled/disabled state to the repository index default. Useful after you manually changed some service repositories enabled state.

Package Locks Management Package locks serve the purpose of preventing changes to the set of installed packages on the system. Locks are stored as queries in /etc/zypp/locks file (see also locks(5)). Packages matching a query are then forbidden to change their installed status; an installed package can’t be removed or upgraded, not installed package can’t be installed. When requesting to install, upgrade or remove such locked package, you will get a dependency problem dialog.

A lock-spec is formed by "NAME [OP EDITION]", where NAME may also be a glob pattern using * and ? wildcard characters. Non-package types may to have their kind-string prepended (e.g. patch:foo or product:baa) or use the commands --type option.

The basic form will lock all editions of the matching items. You can optionally restrict the lock to match a specific edition or edition range using =, <, <=, >, >= or != followed by the edition.

Note

If you use blanks around the operator you need to quote the string or escape the blanks according to the rules of the shell you are using.

locks (ll) List currently active package locks.

-m, --matches Show the number of resolvables matched by each lock. This option requires loading the repositories.

-s, --solvables List the resolvables matched by each lock. This option requires loading the repositories.

addlock (al) [options] lock-spec... Add a package lock. Specify packages to lock as explained above.

-r, --repo alias|name|#|URI Restrict the lock to the specified repository.

-t, --type type Lock only packages of specified type (default: package). See section Package Types for list of available package types.

-m, --comment comment Add a comment for package lock.

removelock (rl) [options] lock-number|lock-spec... Remove a package lock. Specify the lock to remove by its number obtained with zypper locks or by the lock-spec.

-r, --repo alias|name|#|URI Restrict the lock to the specified repository.

-t, --type type Restrict the lock to packages of specified type (default: package). See section Package Types for list of available package types.

cleanlocks (cl) Remove unused locks.

This command looks for locks that do not currently (with regard to repositories used) lock any package and for each such lock it asks user whether to remove it.

Locale Management These commands give information about requested locales and the possibility to manage those. A locale is defined by a language code. For many packages there are locale dependent packages available which provide translations or dictionaries. To get these installed, the locale for the desired language must be marked as requested by the package manager library.

locales (lloc) [OPTIONS] [LOCALE] ... List requested locales. Called without argument, lists the locales which are already marked as requested. Specifying certain locale(s) prints information only for this(these).

-a, --all List all available locales.

-p, --packages Show corresponding packages.

addlocale (aloc) [OPTIONS] <LOCALE> ... Add specified locale(s) to the list of requested locales..

-n, --no-packages Do not install corresponding packages.

removelocale (rloc) [OPTIONS] <LOCALE> ... Remove specified locale(s) from the list of requested locales..

-n, --no-packages Do not remove corresponding packages.

Examples:

$ zypper locales List requested locales.

$ zypper locales --packages de en Get the lists of packages which are available for de and en (exact match).

$ zypper locales en_ Get all locales with lang code en that have their own country code, excluding the fallback en.

$ zypper locales en* Get all locales with lang code en with or without country code.

$ zypper aloc --packages de_CH Request de_CH and install language dependent packages.

Other Commands system-architecture Print the detected system architecture.

versioncmp (vcmp) VERSION1 VERSION2 Compare the versions supplied as arguments and tell whether VERSION1 is older or newer than VERSION2 or the two version strings match. The exit code is 0 if the versions are equal, 11 if VERSION1 is newer, and 12 if VERSION2 is newer.

The default output is in human-friendly form. If --terse global option is used, the result is an integer number, negative/positive if VERSION1 is older/newer than VERSION2, zero if they match.

-m, --match Takes missing release number as any release.

For example:

$ zypper vcmp -m 0.15.3 0.15.3-2 0.15.3 matches 0.15.3-2

$ zypper vcmp 0.15.3 0.15.3-2 0.15.3 is older than 0.15.3-2

targetos (tos) Shows the ID string of the target operating system. The string is defined by the XPath:/product/register/target entry in (current-rootdir)/etc/products.d/baseproduct.

If the baseproduct does not provide this entry, or if no baseproduct is installed at all, the value is empty if the --terse global option is used.

In not-terse mode the distribution label is shown instead of an empty value, if a baseproduct is installed.

-l, --label Show the baseproducts distribution and short label instead.

licenses Prints a report about licenses and EULA's of installed packages to standard output.

First, a list of all packages and their licenses and/or EULAs is shown. This is followed by a summary, including the total number of installed packages, the number of installed packages with EULAs that required a confirmation from the user. Since the EULAs are not stored on the system and can only be read from repository metadata, the summary includes also the number of installed packages that have their counterpart in repositories. The report ends with a list of all licenses uses by the installed packages.

This command can be useful for companies redistributing a custom distribution (like appliances) to figure out what licenses they are bound by.

download [OPTIONS] Download rpms specified on the commandline to a local directory.

Per default packages are downloaded to the libzypp package cache (/var/cache/zypp/packages; for non-root users $XDG_CACHE_HOME/zypp/packages), but this can be changed by using the global --pkg-cache-dir option.

Parsable XML-output produced by zypper --xmlout will include a <download-result> node for each package zypper tried to download. Upon success the location of the downloaded package is found in the path attribute of the <localfile> subnode (xpath: download-result/localpath@path):

<download-result> <solvable> <kind>package</kind> <name>zypper</name> <edition epoch="0" version="1.9.17" release="26.1"/> <arch>x86_64</arch> <repository name="repo-oss-update (13.1)" alias="openSUSE:repo-oss-update"/> </solvable> <localfile path="/var/cache/zypp/pac.../zypper-1.9.17-26.1.x86_64.rpm"/> </download-result>

--all-matches Download all versions matching the commandline arguments. Otherwise only the best version of each matching package is downloaded.

--dry-run Don’t download any package, just report what would be done.

-r, --repo alias|name|#|URI Work only with the repository specified by the alias, name, number or URI. This option can be used multiple times.

--from alias|name|#|URI Select packages from the specified repository only. This option can be used multiple times.

source-download [OPTIONS] Download source rpms for all installed packages to a local directory.

-d, --directory dir Download all source rpms to this directory. Default is /var/cache/zypper/source-download.

--delete Delete extraneous source rpms in the local directory. This is the default.

--no-delete Do not delete extraneous source rpms.

--status Don’t download any source rpms, but show which source rpms are missing or extraneous.

ps [OPTIONS] After each upgrade or removal of packages, there may be running processes on the system which continue to use meanwhile deleted files. zypper ps lists all processes using deleted files, together with the corresponding files, and a service name hint, in case it’s a known service. This gives a hint which services may need to be restarted after an update. Usually programs which continue to use deleted shared libraries. The list contains the following information:

PID ID of the process

PPID ID of the parent process

UID ID of the user running the process

Login Login name of the user running the process

Command Command used to execute the process

Service Service name, if command is associated with a system service

Files The list of the deleted files

-s, --short Create a short table not showing the deleted files. Given twice, show only processes which are associated with a system service. Given three times, list the associated system service names only.

--print format For each associated system service print format on the standard output, followed by a newline. Any %s directive in format is replaced by the system service name.

-d, --debugFile filename Output a file with all proc entries that make it into the final set of used open files. This can be submitted as additional information in a bug report.

Examples:

$ zypper ps -ss Show only processes associated with a system service.

$ zypper ps -sss Short for zypper ps --print "%s"; list services which might need a restart.

$ zypper ps --print "systemctl status %s" Let zypper print the commands to retrieve status information for services which might need a restart.

needs-rebooting Checks if the reboot-needed flag was set by a previous update or install of a core library or service.

The reboot-needed flag is set if a package that provides installhint(reboot-needed) is updated or installed. Additionally there is a predefined list (/etc/zypp/needreboot) of well-known packages which cause the reboot-needed flag being set unconditionally. The exit code ZYPPER_EXIT_INF_REBOOT_NEEDED indicates that a reboot is suggested, otherwise the exit code is set to ZYPPER_EXIT_OK.

It is recommended for scripts to use this command to test whether a system reboot is suggested. Use --quiet to suppress the normal output.

Subcommands subcommand Lists available subcommands in /usr/lib/zypper/commands and from elsewhere on your $PATH. See section SUBCOMMANDS for details.

GLOBAL OPTIONS -h, --help Help. If a command is specified together with --help option, command specific help is displayed.

-V, --version Print zypper version number and exit.

-c, --config file Use the specified zypper config file instead of the default zypper.conf. Other command line options specified together with --config and having their counterpart in the zypper config file are still preferred.

The order of preference with --config is as follows:

1. Command line options

2. --config file

3. [/etc/zypp/zypp.conf] (system-wide defaults for all libzypp based applications)

Note

Use and location of the system-wide /etc/zypp/zypp.conf can not be changed this way. It’s mentioned here just because some zypper command line options allow one to overwrite system-wide defaults defined in zypp.conf.

See also FILES section for more information.

-v, --verbose Increase verbosity. For debugging output specify this option twice. zypper -vv ref for example will show the mirrors used to download the metadata.

-q, --quiet Suppress normal output. Brief (esp. result notification) messages and error messages will still be printed, though. If used together with conflicting --verbose option, the --verbose option takes preference.

--color, --no-color Whether to use colors in output if tty supports it. For details see the [color] section in zypper.conf.

-A, --no-abbrev Do not abbreviate text in tables. By default zypper will try to abbreviate texts in some columns so that the table fits the width of the screen. If you need to see the whole text, use this option.

-t, --terse Terse output for machine consumption. Implies --no-abbrev and --no-color.

-s, --table-style integer Choose among different predefined line drawing character sets to use when drawing a table. The table style is identified by an integer number. Style 0 is the default, styles 1-9 use combinations of different box drawing characters whose shape may depend on the font the terminal is using. Style 10 separates columns by a colon and style 11 draws no lines at all.

-n, --non-interactive Switches to non-interactive mode. In this mode zypper doesn’t ask user to type answers to various prompts, but uses default answers automatically. Those default answers also depend on other options like --no-gpg-checks or --ignore-unknown.

--non-interactive-include-reboot-patches In non-interactive mode do not skip patches which have the rebootSuggested-flag set. Otherwise these patches are considered to be interactive, like patches including a licenses or some message to confirm. NOTE: This option does not turn on non-interactive mode.

-x, --xmlout Switches to XML output. This option is useful for scripts or graphical frontends using zypper.

-i, --ignore-unknown Ignore unknown packages. This option is useful for scripts, because when installing in --non-interactive mode zypper expects each command line argument to match at least one known package. Unknown names or globbing expressions with no match are treated as an error unless this option is used.

For search and info commands the option makes zypper return ZYPPER_EXIT_OK rather than ZYPPER_EXIT_INF_CAP_NOT_FOUND if the query did not produce at least one match.

-D, --reposd-dir dir Use the specified directory to look for the repository definition (.repo) files. The default value is /etc/zypp/repos.d.

-C, --cache-dir dir Use an alternative root directory for all caches. The default value is /var/cache/zypp.

--raw-cache-dir dir Use the specified directory for storing raw copies of repository metadata files. The default value is /var/cache/zypp/raw.

--solv-cache-dir dir Use the specified directory to store the repository metadata cache database files (solv files). The default value is /var/cache/zypp/solv.

--pkg-cache-dir dir Use the specified directory for storing rpm packages downloaded from repositories (see addrepo --keep-packages). The default value is /var/cache/zypp/packages. + Packages are stored in subdirectories named after the repositories alias and using the same path as on the repositories medium.

--userdata string User data is expected to be a simple string without special chars or embedded newlines and may serve as transaction id. It will be written to all install history log entries created throughout this specific zypper call. It will also be passed on to zypp plugins executed during commit. This will enable e.g. a btrfs plugin to tag created snapshots with this string. For zypper itself this string has no special meaning.

Repository Options:

--no-gpg-checks Ignore GPG check failures and continue. If a GPG issue occurs when using this option zypper prints and logs a warning and automatically continues without interrupting the operation. Use this option with caution, as you can easily overlook security problems by using it. (see section GPG checks)

--gpg-auto-import-keys If new repository signing key is found, do not ask what to do; trust and import it automatically. This option causes that the new key is imported also in non-interactive mode, where it would otherwise got rejected.

-p, --plus-repo URI Use an additional repository for this operation. The repository aliased tmp# and named by the specified URI will be added for this operation and removed at the end. You can specify this option multiple times.

--plus-content tag Additionally use disabled repositories denoted by tag for this operation. If tag matches a repositories alias, name or URL, or is a keyword defined in the repositories metadata, the repository will be temporarily enabled for this operation. The repository will then be refreshed and used according to the commands rules. You can specify this option multiple times.

If a disabled repositories metadata are not available in the local cache, they will be downloaded to scan for matching keywords. Otherwise the keyword scan will use the metadata available in the local cache. Only if used together with the refresh command, a keyword scan will refresh all disabled repositories.

To refresh all disabled repositories metadata: zypper --plus-content '' ref

To include a disabled repository repo-debug in a search: zypper --plus-content repo-debug search ...

To search only in a disabled repository repo-debug: zypper --plus-content repo-debug search -r repo-debug ...

To enable all repos providing the debug keyword: zypper in --plus-content debug some -debuginfo or -debugsource package

--disable-repositories Do not read metadata from repositories. This option will prevent loading of packages from repositories, thus making zypper work only with the installed packages (if --disable-system-resolvables was not specified).

--no-refresh Do not auto-refresh repositories (ignore the auto-refresh setting). Useful to save time when doing operations like search, if there is not a need to have a completely up to date metadata.

--no-cd Ignore CD/DVD repositories. When this option is specified, zypper acts as if the CD/DVD repositories were not defined at all.

--no-remote Ignore remote repositories like http, ftp, smb and similar. This makes using zypper easier when being offline. When this option is specified, zypper acts as if the remote repositories were not defined at all.

--releasever version For the current command set the value of the $releasever repository variable to version. This can be used to switch to new distribution repositories when performing a distribution upgrade. See the dist-upgrade (dup) command and section Repository Management for more details about using the $releasever repository variable.

To check where you already use $releasever call: zypper --releasever @--HERE--@ lr -u

Target Options:

-R, --root dir Operates on a different root directory. This option influences the location of the repos.d directory and the metadata cache directory and also causes rpm to be run with the --root option to do the actual installation or removal of packages. See also the FILES section.

--installroot dir Behaves like --root but shares the repositories with the host system.

--disable-system-resolvables This option serves mainly for testing purposes. It will cause zypper to act as if there were no packages installed in the system. Use with caution as you can damage your system using this option.

SUBCOMMANDS Zypper subcommands are inspired by git(1). Subcommands are standalone executables that live in the zypper_execdir (/usr/lib/zypper/commands). For subcommands zypper provides a wrapper that knows where the subcommands live, and runs them by passing command options and arguments to them. If a subcommand is not found in the zypper_execdir, the wrapper will look in the rest of your $PATH for it. Thus, it’s possible to write local zypper extensions that don’t live in system space. This can be disabled by setting "subcommand.seachSubcommandInPath" to "no" in the zypper.conf.

This is how to add your own subcommand zypper mytask:

• The executable must be named zypper-mytask.

• The executable must be located your $PATH.

• A manpage for zypper-mytask should be provided and explaining the commands options and return values. It will be shown when calling zypper help mytask.

• Zypper built-in commands take precedence over subcommands with the same name.

• It’s fine to call zypper or use libzypp from within your subcommand.

You can use the built-in zypper subcommand command to get a list of all subcommands in zypper_execdir and from elsewhere on your $PATH.

Using zypper global-options together with subcommands, as well as executing subcommands in zypper shell is currently not supported.

FILES /etc/zypp/zypper.conf, $HOME/.zypper.conf Global (system-wide) and user’s configuration file for zypper. These files are read when zypper starts up and --config option is not used.

User’s settings are preferred over global settings. Similarly, command line options override the settings in either of these files. To sum it up, the order of preference is as follows (from highest to lowest):

1. Command line options

2. $HOME/.zypper.conf

3. /etc/zypp/zypper.conf

4. [/etc/zypp/zypp.conf] (system-wide defaults for all libzypp based applications)

See the comments in /etc/zypp/zypper.conf for a list and description of available options.

Note

The system-wide /etc/zypp/zypp.conf is mentioned here just because some zypper command line options allow one to overwrite system-wide defaults defined there. zypp.conf and zypper.conf have different content and serve different purpose.

/etc/zypp/zypp.conf ZYpp configuration file affecting all libzypp based applications. See the comments in the file for description of configurable properties. Many locations of files and directories listed in this section are configurable via zypp.conf. The location for this file itself can be redefined only by setting $ZYPP_CONF in the environment.

/etc/zypp/locks File with package lock definitions. The package lock commands (locks, addlock, removelock, etc.) should be used to manipulate this file.

This file is used by all ZYpp-based applications.

/etc/zypp/repos.d Directory containing repository definition (*.repo) files. You can use the Repository Management commands to manipulate these files, or you can edit them yourself. In either case, after doing the modifications, executing *zypper refresh* is strongly recommended.

You can use the --reposd-dir global option to use an alternative directory for this purpose or the --root option to make this directory relative to the specified root directory.

This directory is used by all ZYpp-based applications.

/etc/zypp/services.d Directory containing service definition (*.service) files. You can use the Service Management Commands to manipulate these files, or you can edit them yourself. Running *zypper refs* is recommended after modifications have been done.

This directory is used by all ZYpp-based applications.

/usr/lib/zypper/commands System directory containing zypper extensions (see section SUBCOMMANDS)

/var/cache/zypp/raw Directory for storing raw metadata contained in repositories. Use the --raw-cache-dir global option to use an alternative directory for this purpose or the --root option to make this directory relative to the specified root directory.

This directory is used by all ZYpp-based applications.

/var/cache/zypp/solv Directory containing preparsed metadata in form of solv files.

This directory is used by all ZYpp-based applications.

/var/cache/zypp/packages If the keep-packages property is set for a repository (see the modifyrepo command), all the RPM file downloaded during installation will be kept here. Packages are stored in subdirectories named after their repositories alias.

Subdirectories of removed or otherwise unknown repositories are cleaned automatically. This auto-cleanup can be prevented by creating a file named .no_auto_prune in the pkg-cache directory.

Creating a .keep_packages file in the pkg-cache directory will keep downloaded packages for all repos cached here, overwriting the repositories keep-packages property.

See also the clean command for cleaning these cache directories.

This directory is used by all ZYpp-based applications.

/var/log/zypper.log Zypper log file. It should be attached to all bugreports. (see also zypper-log(8)).

/var/log/zypper.solverTestCase Solver testcase created by using the --debug-solver option.

/var/log/updateTestcase-YYYY-MM-DD-hh-mm-ss Solver testcase auto created when performing a zypper dup.

/var/log/zypp/history Installation history log.

~/.zypper_history Command history for the zypper shell (see the shell command).

/etc/zypp/needreboot File with a list of packages that will set the reboot-needed flag when installed or upgraded.

/etc/zypp/needreboot.d Directory that can be used to define packages that trigger the reboot-needed flag by adding additional files containing the required package names.

EXIT CODES There are several exit codes defined for zypper built-in commands for use e.g. within scripts. These codes are defined in header file src/zypper-main.h found in zypper source package. Codes below 100 denote an error, codes above 100 provide a specific information, 0 represents a normal successful run. Following is a list of these codes with descriptions:

0 - ZYPPER_EXIT_OK Successful run of zypper with no special info.

1 - ZYPPER_EXIT_ERR_BUG Unexpected situation occurred, probably caused by a bug.

2 - ZYPPER_EXIT_ERR_SYNTAX zypper was invoked with an invalid command or option, or a bad syntax.

3 - ZYPPER_EXIT_ERR_INVALID_ARGS Some of provided arguments were invalid. E.g. an invalid URI was provided to the addrepo command.

4 - ZYPPER_EXIT_ERR_ZYPP A problem is reported by ZYPP library.

5 - ZYPPER_EXIT_ERR_PRIVILEGES User invoking zypper has insufficient privileges for specified operation.

6 - ZYPPER_EXIT_NO_REPOS No repositories are defined.

7 - ZYPPER_EXIT_ZYPP_LOCKED The ZYPP library is locked, e.g. packagekit is running.

8 - ZYPPER_EXIT_ERR_COMMIT An error occurred during installation or removal of packages. You may run zypper verify to repair any dependency problems.

100 - ZYPPER_EXIT_INF_UPDATE_NEEDED Returned by the patch-check command if there are patches available for installation.

101 - ZYPPER_EXIT_INF_SEC_UPDATE_NEEDED Returned by the patch-check command if there are security patches available for installation.

102 - ZYPPER_EXIT_INF_REBOOT_NEEDED Returned by the needs-rebooting command, if a system reboot is suggested.

Legacy: Returned after the successful installation of a patch which requires reboot of computer. This legacy behavior is kept, but it’s drawback is that it covers patches only, no packages. The new needs-rebooting command is the recommended way to test whether a system reboot is suggested.

103 - ZYPPER_EXIT_INF_RESTART_NEEDED Returned after a successful installation of a patch which requires restart of the package manager itself. This means that one of patches to be installed affects the package manager itself and the command used (e.g. zypper update) needs to be executed once again to install any remaining patches.

104 - ZYPPER_EXIT_INF_CAP_NOT_FOUND Returned by the install and the remove command in case any of the arguments does not match any of the available (or installed) package names or other capabilities. In search and info commands it indicates that no match was found. See also the --ignore-unknown global option.

105 - ZYPPER_EXIT_ON_SIGNAL Returned upon exiting after receiving a SIGINT or SIGTERM.

106 - ZYPPER_EXIT_INF_REPOS_SKIPPED Some repository had to be disabled temporarily because it failed to refresh. You should check your repository configuration (e.g. zypper ref -f).

107 - ZYPPER_EXIT_INF_RPM_SCRIPT_FAILED Installation basically succeeded, but some of the packages %post install scripts returned an error. These packages were successfully unpacked to disk and are registered in the rpm database, but due to the failed install script they may not work as expected. The failed scripts output might reveal what actually went wrong. Any scripts output is also logged to /var/log/zypp/history.

Zypper subcommands (see section SUBCOMMANDS) may return different codes which should be described in the commands man page. Call zypper help subcommand to see the subcommands man page if one is provided.

HOMEPAGE https://github.com/openSUSE/zypper

AUTHORS The zypper project was started by Martin Vidner, Jan Kupec, Michael Andres, Duncan Mac-Vicar Prett, Josef Reidinger and Stanislav Visnovsky. Many people have later contributed to it.

SEE ALSO locks(5), zypper-log(8), YaST2(8)

SUSE Linux 2026-03-06 ZYPPER(8)

(LINUX) systemctl

2026-05-14T11:05:16Z

Chris T. Ludwig: /* Grafische Oberflaeche */

=Allgemeines=
Eigentlich koennte ich diese Seite in eine neue Kategorie 'weird things' packen.

Um systemctl und damit systemd besser einordnen zu koennen, dient vielleicht folgender [https://www.linux-magazin.de/ausgaben/2011/11/init-systeme/ Artikel].

=Motivation=
Ich habe 08/2021 meinen Server auf eine neue alte Hardware umgezogen. Da die Server-Hardware (XW8400 auf XW8600; ja ich geb es zu, alt ist gar kein Ausdruck, aber 8 Kerne und 16 GB RAM sind fuer meinen Server ausreichend; vorerst;-)) sich unwesentlich geaendert hat, war es fast damit getan die Festplatten umzustecken. Die wesentlichen Anpassungen bezogen sich auf BIOS und Netzwerk. Nur die grafische Oberflaeche wollte partout nicht starten, daher der Titel.

=BIOS=
TODO

=Netzwerk=
Da die Zuordnung der Netzdevices ueber die MAC-Adresse geschieht, waren die erwartungsgemaesz falsch. Ich hatte nach dem Start eth3, eth4 und eth5 anstatt eth0-2. BTW: Die dritte Karte ist eine LWL-Karte zur direkten Anbindung an das Backbone.
Die Zuordnungsdatei ist bei OpenSuse 15.3 unter
# /etc/udev/rules.d/70-persistent-net.rules
zu finden.
Dort habe ich die alten Eintraege geloescht/auskommentiert(#) und die neuen Zuordnungen eingetragen.
Die Uebernahme war nach einem Reboot richtig. Vielleicht waere es auch ohne Reboot gegangen, evtl. mit udevadm trigger

Bei der Gelegenheit bin ich noch ueber eine Beschriftung der unteren der beiden RJ45-Netzwerkbuchsen mit ASF gestolpert. ASF steht fuer [https://en.wikipedia.org/wiki/Alert_Standard_Format Alert Standard Format] der DMTF nicht zu verwechseln mit DTMF;-)

=Grafische Oberflaeche=

Es sei erwaehnt, dass ein startx mit einem User zum Erfolg fuehrt, aber das ist ja keine Dauerloseung.
Es handelt sich also nicht um die mit jedem Update/Upgrade auftauchenden NVIDA-Treiber Probleme.

Erst einmal das default target kontrolliert.
server:~ # systemctl get-default
graphical.target
Das stimmt soweit. Wenn ein target "sein Ziel" nicht erreicht liegt es oft an fehlerhaften Services.

systemctl list-dependencies graphical.target

In der Ausgabe (Liste von Abhaengigkeiten) sind Dienste, etc. mit einer "farbigen" Markierung versehen.
* gruen in Ordnung
* rot Fehler
* schwarz/grau nicht aktiv(iert)

Ich habe alle "roten Dienste" disabled. z.B.
systemctl disable dhcpd

Aber obwohl danach alle Abhaengigkeiten gruen oder schwarz waren, hat es nicht den gewuenschten Erfolg gebracht.

Dann mal weitersuchen. Wo hat systemd seine configs versteckt?

server:~ # pkg-config systemd --variable=systemdsystemconfdir
/etc/systemd/system

In der Regel in /usr/local/lib/systemd/system und /usr/lib/systemd/system

Full list of directories is provided in systemd.unit(5).

In dem Verzeichnis /etc/systemd/system gibt es ein Verzeichnis graphical.target.wants in dem sich eine Service-Datei befindet.
server:/etc/systemd/system # ll graphical.target.wants/
insgesamt 0
lrwxrwxrwx 1 root root 47 28. Apr 2019 display-manager.service -> /usr/lib/systemd/system/display-manager.service

Daraufhin mal den Status gescheckt.
systemctl status display-manager.service
Und weird#unknown display-manager active and running. Mit Alt-F7 sieht man tatsaechlich einen Cursor blinken.

The Simple Desktop Display Manager (SDDM) a display manager. It is the recommended display manager for the KDE Plasma and LXQt desktop environments.

Next weird#
server:/etc/systemd/system # psgrep sddm
1747 ? Sl 0:00 /usr/bin/sddm

server:/etc/systemd/system # systemctl status sddm
● sddm.service - Simple Desktop Display Manager
Loaded: loaded (/usr/lib/systemd/system/sddm.service; disabled; vendor preset: disabled)
Active: inactive (dead)
Docs: man:sddm(1)
man:sddm.conf(5)

Grrrrrrrrr!

Zurueck auf Anfang. Bei ersten Booten (mit fehlerhaften Diensten) ist das System im Emegency-Mode gelandet.

Emergency and rescue targets
Both of these shells require the root password. The emergency target keeps the root ﬁle system mounted read-only, while rescue. target waits for sysinit. target to complete ﬁrst so that more of the system will be initialized, for example, logging, ﬁle systems, etc.

server:/etc/systemd/system # systemctl --failed
UNIT LOAD ACTIVE SUB DESCRIPTION
0 loaded units listed.

Bei OpenSuse gibt es keine Xwrapper.config -> weird#++

=lircd=
2026-05-14
Heute wollte ich mal meinen lircd-Start automatisieren.
Da ich noch so eine alte Homebrew Loesung am Start habe, muss ich zum Aktivieren folgende Schritte ausfuehren.

systemctl stop lircd
setserial /dev/ttyS0 uart none
modprobe serial_ir
systemctl start lircd
irexec /etc/lirc/irexec.lircrc

Der letzte Befehl dient mir als eine Art IR-Proxy. Die Befehle der IR-Fernbedienung werden entgegengenommen und per IP oder IR weitergegegeben.

Um es gleich vorweg zu nehmen, ChatGPT hat (fast) auf ganzer Linie versagt.

Der erste Vorschlag von ChatGPT die Befehle in eine Script zu packen, empfand ich zwar nicht so prickelnd, waere aber in der Nachbetrachtung der einfachere Weg gewesen.

Datei erstellen:

sudo nano /usr/local/bin/lirc-init.sh

Inhalt:
<pre>
#!/bin/bash

# UART deaktivieren
setserial /dev/ttyS0 uart none

# IR-Treiber laden
modprobe serial_ir

# kurzen Moment warten
sleep 1

# lircd starten
systemctl start lircd.service

# irexec starten
irexec /etc/lirc/irexec.lircrc &

Ausführbar machen:

sudo chmod +x /usr/local/bin/lirc-init.sh
</pre>

Auch einen eigenen systemd Service zu erstellen waere denkbar gewesen.

<pre>
Datei:

sudo nano /etc/systemd/system/lirc-init.service

Inhalt:

[Unit]
Description=LIRC Initialisierung
Before=lircd.service
After=multi-user.target

[Service]
Type=oneshot
ExecStart=/usr/local/bin/lirc-init.sh
RemainAfterExit=yes

[Install]
WantedBy=multi-user.target
</pre>

Am elegantesten fand die ich den folgenden Loesungsvorschlag.
Um es vorweg zu nehmen, so hat es nicht funktioniert.

<pre>
1. Override-Datei erzeugen
sudo systemctl edit lircd.service

Dadurch öffnet sich ein Editor.

2. Folgenden Inhalt einfügen
[Service]
ExecStartPre=/usr/bin/setserial /dev/ttyS0 uart none
ExecStartPre=/usr/sbin/modprobe serial_ir
ExecStartPost=/usr/bin/irexec /etc/lirc/irexec.lircrc
3. systemd neu laden
sudo systemctl daemon-reload
4. Dienst neu starten
sudo systemctl restart lircd.service
5. Prüfen

Status anzeigen:

systemctl status lircd.service

Logs ansehen:

journalctl -u lircd.service
</pre>

Auch ExecStartPost zu ersetzen war irgendwie nicht mein Ding.

ExecStartPost=/usr/bin/bash -c '/usr/bin/irexec /etc/lirc/irexec.lircrc &'

Bei der ganzen Aktion habe ich doch tatsaechlich eine neue Befehlsvarianten kennengelernt.

sudo systemctl edit lircd.service

Ich habe das irexec in einen eigenen service gepackt.

<pre>
[Unit]
Description=LIRC irexec
After=lircd.service
Wants=lircd.service

[Service]
ExecStart=/usr/bin/irexec /etc/lirc/irexec.lircrc
Restart=always
RestartSec=3

[Install]
WantedBy=multi-user.target
</pre>

Danach..

sudo systemctl daemon-reload
sudo systemctl restart lircd.service
sudo systemctl restart irexec.service

Und dann eine Fehlermeldung, die mich locker eine Stunde gekostet hatte. ChatGPT war keine grosze Hilfe, hat aber an einer Stelle etwas ausgespuckt, was mich auf die richtige Faehrte gefuehrt hat.

modprobe: FATAL: Module serial_ir not found in directory /lib/modules/6.4.0-150600.23.84-default

Modprobe aus der Kommandozeile funktionierte, aber als ExecStartPre-Parameter nicht. Die Fehlermeldung ist irrefuehrend und hat auch ChatGPT den Fehler staendig bei falschen Pfaden, Dateinamen, Kernelversionen, ... suchen lassen.

Der Fehler lag in der eingeschraenkten Berechtigung (!!!) durch den Parameter ProtectKernelModules.

Sobald ich den Parameter auf no gestellt hatte, tat auch modprobe seinen Dienst.

ProtectKernelModules=no #!!!!!!!

Warum ChatGPT nicht gleich den Hinweis "Schaue nach dem Parameter ProtectKernelModules!" oder warum modprobe nicht den Fehler "Permission denied!" ausgibt, bleibt fuer mich unbeantwortet.

(LINUX) systemctl

2026-05-14T10:32:16Z

Chris T. Ludwig: /* Grafische Oberflaeche */

(LINUX) systemctl

2026-05-14T10:28:02Z

Chris T. Ludwig: /* Grafische Oberflaeche */

(LINUX) systemctl

2026-05-14T10:25:51Z

Chris T. Ludwig: /* Motivation */

Hauptseite

2026-05-14T10:20:51Z

Chris T. Ludwig:

[[Datei:SchimpansenProgrammierer.png|200px|rechts|5-jaehriger Schimpanse|link=5-jaehriger Schimpanse]]

==Allgemeines==
Dieses Wiki erhaelt permanent Erweiterungen. Derzeit beinhaltet dieses Wiki {{NUMBEROFARTICLES}} Artikel. Ich nutze dieses Wiki als persoenliche Informationsquelle zu fast allen Dingen mit denen ich mich so beschaeftige, um sie einfach oeffentlich und schnell zur Hand zu haben. Viele Seiten befinden sich noch im Intranet-Wiki und lassen sich aufgrund von Urheberrechtsbestimmungen nicht ohne Ueberarbeitung in dieses oeffentliche Wiki uebertragen. Wenn also Fragen auftauchen, dann schreibt das bitte in die Kommentare. Ich pruefe dann gezielt, ob ich hierzu einen Beitrag freischalten kann.

Meine Site ist '''bannerfree''' und '''genderfree'''. Es gibt keine Affiliate-Links und maximal, wenn man eine Empfehlung so deuten will, mal Schleichwerbung. An einem Verzicht auf Umlaute und scharfes S (SZ) arbeite ich.

===Hinweis zu Suchanfragen===

Sinnvoll ist es bei der Wikisuche mindestens '''4''' Buchstaben mit voran- und nachgestelltem * (Wildcard) nutzen.
Zum Beispiel "*Ardu*", "*FHEM*", "*ENC2*".
Woerter mit 3 Buchstaben findet man auch. Grosz- und Kleinschreibung wird nicht unterschieden. In den runden Klammern vor dem eigentlichen WikiBeitrag steht ein Gruppenname, so sind zusammengehoerende Beitraege besser erkennbar.

[[Spezial:Alle_Seiten|Alle Seiten im Ueberblick]]

==CLX LAB==
Heute habe ich die Idee eines virtuellen Labors mal verankert. So richtig weisz ich noch nicht wie es genau funktionieren soll, aber der Anfang ist gemacht.
Einfach ne eMail an tibb(at)clx.de und schon kann's losgehen. Notwendiges Hardware-Equipment kann ich zur Verfueggung stellen.

[[Datei:CLXLAB Icon.webp|mini]]

Ich suche Mitarbeitende für folgende Projekte:
- Insect Detect
- Meshtastic
- Fox ESS API
- Victon Energy Cerbo GX Programming
uvm.

Fundierte Hard- und Softwarekenntnisse sind Voraussetzung.

20260101

Einen Gedanken, den ich ab 2026 mal intensiver verfolgen werde, ist die, ich nenne sie mal, "'''Selbstlernautomation'''".
Nach meiner aktuellen Vorstellung bedeutet dies, die Realisierung eines Systemes (Regelungssystem, Roboter, Rover, ), welches bei moeglichst optimaler Hardwareanpassung (Aktuatoren, Sensoren) an die Umgebung und Aufgabe, unter zuhilfenahme von Erfahrungsdaten (Datenarchive, Wetterprognosen, ...), einen KI-basierten Regelungsmechanismus nutzt, um die gestellte Aufgabe besser als ein darauf geschulter Mensch zu erfuellen. Weiter geht's auf der Einstiegsseite im CLXLAB zu [[(CLXLAB) Selbstlernautomation|Selbstlernautomation]].

==Fundstueck der Woche==
2026-01-04

Sehr informative Wetterseite. [https://www.ventusky.com/de Ventusky]

2025-12-03
Und schon wieder Apple. Bei der Firma hat man wohl zu viele Sammeltassen im Schrank. Im Einstellungstest wird angeblich folgendes gefragt: In einer Klasse sind 24 Mädchen und 36 Jungen. Zusammen sind es 100. Wie kann das sein?
Da ist eine Personalchefin wohl übers Ziel hinausgeschossen. Mit mathematisch formal korrekten Angaben (Kennzeichnung der Wertangabe durch einen vertikalen Strich mit Hinweis auf das verwendete Zahlensystem) ist die Loesung simpel. Scheinbar knacken Schimpansen den Apple-Einstellungstest am besten.

2025-12-01
Und da sind sie wieder die Schimpansen. Diesmal bei Apple. Das kommt davon wenn man als Programmierer nur noch KlickiBuntis einstellt.

Bug in iOS: Bei iOS 16–17 gab es mehrfach das Problem, dass nur wenige Einträge angezeigt wurden, die Liste aber viel länger war.

2025-10-07
SuS kommen nach der 4. Stunde zum Lehrer. "Wir koennen unmoeglich jetzt den GLN schreiben!" "Unser Mathelehrer hat uns die ersten 4 Stunden gequaelt." "Wir sind jetzt zu keinem klaren Gedanken mehr faehig!"
Lehrer: "Ach Gott, was hat er denn mit euch gemacht?" SuS: "Irgendetwas mit 'T'!"
Lehrer: "Tangente?" SuS: "Nee, ich glaub Integral oder so."

2025-09-06

Schenkelklopfer im Buch "Factfulness" [https://en.wikipedia.org/wiki/Factfulness] erstes Kapitel: "Wissenschaftler, Schimpansen und Sie". Puh, nochmal Glueck gehabt.

2025-08-17

Nach Jahren mit [https://app.diagrams.net/ draw.io], [https://lucidchart.com lucidcharts], [https://miro.com/ miro] u. v. a. habe ich heute zum ersten Mal hier im Wiki ein Flussdigramm mit [https://www.mermaidchart.com/ mermaid] und [https://graphviz.org/ GraphViz] mit Hilfe der [https://www.mediawiki.org/wiki/Extension:Kroki Kroki-Extension] integriert. Ich bin begeistert.

2025-06-20

1234 ist kein Passwort! Es ist eine PIN! lol

2025-06-08

Free Online OCR [https://tools.pdf24.org/de/ocr-pdf] Zum Konvertieren von Foto/Grafik nach Dokument, ohne sensiblen Inhalt, sehr praktikabel.

2025-05-25

Die genialste Erfindung der Chinesen war die GDPR (General Data Protection Regulation, DSGVO). Seit sie diese in die europaeischen Koepfe gepflanzt haben, ist ihr Technologievorsprung nicht mehr einzuholen.

2025-05-04

Online Tester fuer htaccess [https://htaccess.madewithlove.com/]

2025-01-05

Langweilst Du dich auch so, wie mich.

2025-01-03

So viel Schwachsinn hab ich in meinem Leben noch nicht gesehen und die meinen noch sie machens besonders gudd.
2024-09-06

The oldest computer was owned by Adam and Eve. It was an Apple. Only one wrong byte and everything was crashed!

2024-07-13

Der drollige Troll: trollig oder drollig?
*Trollig von Troll (nordisches Fabelwesen (ungehobelt, grob oder ungeschickt)) Hat eine leicht negative oder scherzhafte Konnotation.
*Drollig von Drol(l) (altdeutsch Possenreißer, Spaszmacher, (Hof-)Narr, Clown) Hat eine positive, niedliche oder humorvolle Bedeutung.

2024-06-28

Suno AI Explore [https://suno.com/explore] eignet sich durchaus als Radioersatz!.

2024-01-01

Nach einer (sehr) langen Suche nach einem (dauerhaft) hoerbaren Sender aus dem Groszraum Los Angeles:
Popstar!Radio Hollywood https://streaming.live365.com/a40380

2023-04-24

Ausbildungsklasse: Mechatroniker 
Thema: Kräftezerlegung 
Schuelerreaktion: Geben Sie (Lehrer) sich keine Muehe, Physik habe ich noch nie verstanden!

2023-04-21

Verzweifelter Lehrer im Lehrerzimmer nach der Korrektur eines Leistungsnachweises: 
Jetzt habe ich mit denen wochenlang Kraefteparallelogramme geuebt und die geben mir in der Klassenarbeit lauder Drache ab. Arrrrrr!

2023-01-28

"Meine Erfahrung zeigt, dass auf den groeszten Haufen immer noch einer drauf geschissen wird."

2022-11-16

„Wir leben alle unter dem gleichen Himmel, aber wir haben nicht alle den gleichen Horizont.“ Konrad Adenauer

2022-10-02

Logik-Simulator: [https://academo.org/demos/logic-gate-simulator/]

2022-08-04

Die Selbsthilfegruppe „UTF-8-Probleme“ trifft sich diesmal abweichend im grÃƒÂ¼nen Saal.

2021-04-03

"Bildung im 3D-Raum ist um einiges besser als Unterricht per Zoom-Call", sagt Ball. Cybersecurity-Experte Baggili stimmt dem zu: "Der wahre Mehrwert des Metaverses zeigt sich vor allem dann, wenn es dafür eingesetzt wird, unser Leben zu bereichern", sagt er.

[[Fundstücke Archiv]]

==Weisheiten aus dem Schulalltag==

'''Lehrer''': Lest euch zur Eingewoehnung in das neue Thema im Buch einmal die Seiten 42 bis 45 durch.

'''Schüler''': Wie 4 Seiten lesen! Das ist nicht Ihr Ernst.

'''Schüler''': Herr ... ! Das was Sie mit uns machen ist Quaelerei!
Frueher habe ich 3 Kopien bekommen, musste die für die Arbeit auswendig lernen, habe meine 1 bekommen und gut war.
Heute muss ich mir den Stoff selbst erarbeiten und den Quatsch fuer die Arbeit auch noch verstehen!

mehr -> [[Schenkelklopfer]]

==Die Leiden des Supporters==

[[Datei:LED Rotation Daumenhoch 7Seg 200.gif|mini]]

'''Kunde''': Das Ding tut nicht was es soll!

'''Supporter''': Haben Sie im Handbuch die Anleitung gelesen?

'''Kunde''': JA! Ziehen Sie den Nippel durch die Lasche und dann noch 10 Seiten Blabla.

'''Supporter''': Ja genau! Ihre Lösung steht im Blabla!

==Die drei großen Lügen der EDV-Administratoren==

# Ich weiß woran es liegt!
# Ich komme sofort!
# Jetzt funktioniert es wieder!

Variante 2:

1) Ich glaub, ich weiß, woran das liegt.

2) Ich komme gleich vorbei.

3) Jetzt sollte es funktionieren.

==3 Arten von Fehlern==
* '''Heisenbugs''': Fehler, die verschwinden, wenn man versucht, sie zu debuggen.
* '''Schrödingbugs''': Fehler, die nur auftauchen, wenn man versucht, etwas anderes zu debuggen.
* '''Mandelbugs''': komplexe Fehler, die sich mehr und mehr ins Chaotische steigern, je genauer man hinsieht.
Quelle: Damian Conway: Perl - Best Practices

==Elektrikerweisheit==

Strom macht ganz schnell klein, schwarz und haesslich ;)

==Ich werd bekloppt!==

Seit Jahren kämpfe ich als (Mathematik-)Lehrer gegen eine zunehmende Seuche, in der Sekundarstufe 2 (Klassen 10+). Jahr für Jahr können immer weniger Schueler mit mathematischen Formeln und Termen umgehen. Seit ein paar Jahren kommt noch hinzu, dass durch die Handy- und Tablet-Seuche immer weniger Schueler etwas mit einem PC anfangen koennen und das logische Denken beim Entwickeln von Algorithmen viele voellig ueberfordert. Folglich sind die Schuelerzahlen im Bereich Technik und Informatik stark ruecklaeufig.

Und jetzt finde ich durch Zufall diesen [https://scienceblogs.de/mathlog/2020/03/13/macht-mengenlehre-krank/ Artikel], weil einer meiner letzten Ideen war, mich notgedrungen in Mathematik von Zahlen und Buchstaben zu trennen und eine abstrakte Form des Umgangs mit (mathematischen) Zusammenhaengen zu suchen. Ich erinnerte mich an meine Grundschulzeit und die Mengenlehre.

Ich profitiere heute noch davon, in der Grundschule diesen "Mathematikunterricht" gehabt zu haben. Und wenn man die Kommentare unter dem Artikel liest, sind nicht wenige meiner Meinung und erstaunlicherweise viele scheinbar auch im Bereich der Softwareentwicklung taetig.
Ich lehne mich mal weit aus dem Fenster: "In der Grundschule braucht man in Mathematik nur Mengenlehre und Kopfrechnen als gesunde Basis!"

==Weisheiten zum Nachdenken==

Mit deinem Gehirn waere mir langweilig.

Neid ist die höchste Form der Anerkennung.

Geruechte sind oft Luegen mit Widerhaken.

Nichtbeachtung ist die hoechste Form der Missachtung.

==Spruch des Tages==

Beim Nutzen von KI basierten Systemen gelten aehnliche Prinzipien wie in der Finanzwelt: Die Gebildeten machen Quantenspruenge der Erkenntnis, so wie die Reichen immer reicher werden, während Kreti und Plethi über zu wenig Geld jammern und stolz wie Oskar sind, wenn sie mithilfe von Bildgeneratoren einem Frosch Schamhaare auf den Kopf gezaubert haben.

Der o. g. Spruch kommt mir vor wie eine angepasste Form von: Der Laie staunt, der Fachmann wundert sich.

Holt mal einer den Pfarrer fuer die Reste des Deputys

Trivialitaeten sind des Kleingeists Himmelreich

==Kaffeespende==

Wer bei mir mal vorbei kommen moechte, dem spendiere ich einen Kaffee.

[https://citymapper.com/directions?startcoord=&endcoord=49.400455%2C7.17435&endname=%2F%2F%2Fbeginn.krippe.ortschaft BECOMEACOFFEE ;-)]

Wer unbedingt Geld los werden will, sollte das lieber jemandem geben, der es dringender benoetigt.

z.B. [https://www.paypal.com/DE/fundraiser/charity/3961454 world's education for kids e.V.]

Und nein ich stehe nicht in Verbindung mit einer der Spendenorganisationen und auch nicht mit [https://www.paypal.com/fundraiser/hub Paypal Spenden].

==Request for Comments==

<comments />

Aermotor Wires Tracker

2026-05-09T06:55:46Z

Chris T. Ludwig: /* Allgmeines */

=Allgmeines=
Ich bin beim Ali ueber das Geraet gestoplert und habe mir gedacht, fuer 12 Euro kann ich das mal ausprobieren.

TODO

[[File:AermotorWiresTracker.jpg|400px]]

Bei einem drahtlosen Tracker von Aermotor (wie dem AER102 oder EM415PRO) bezeichnen die Begriffe „Tone“ und „Cont“ (oft fälschlicherweise als „Count“ gelesen) die beiden primären Betriebsmodi des Senders. [1, 2, 3]

==Tone (Tracing Mode)==
Die Tonfunktion dient zum aktiven Aufspüren eines bestimmten Kabels. [2, 4]

* Funktionsweise: Der Sender sendet ein hochfrequentes Audiosignal (entweder einen einzelnen Dauerton oder zwei abwechselnde Töne) durch das Kabel.

* Anwendung: Wenn der Sender auf „Ton“ eingestellt ist, scannen Sie mit der Handsonde des Empfängers die Nähe des Kabels. Der Empfänger gibt einen Piepton oder ein vibrierendes Geräusch aus, das lauter wird, je näher Sie dem richtigen Kabel oder der Bruchstelle kommen. [1, 2, 3, 4, 5, 6, 7]

==Cont / Continuity (Testing Mode)==
Die Einstellung CONT (kurz für Durchgangsprüfung) dient zur Überprüfung, ob ein Stromkreis geschlossen oder unterbrochen ist. [3, 8, 9]

* Funktion: Sie prüft den Stromkreis zwischen den beiden Klemmen des Senders.

* Interpretation der LED:

* Geschlossener Stromkreis: Bei geschlossenem Stromkreis (keine Unterbrechung) leuchtet die „CONT“-LED am Sender in der Regel hell (oft grün oder rot, abhängig von der Polarität).

* Unterbrechung: Leuchtet die LED nicht oder nur schwach, deutet dies auf eine Unterbrechung oder einen hohen Widerstand im Kabel hin.

=Zusammenfassung=
Tabelle TODO

| Feature [1, 2, 3, 10] | Meaning | Primary Use |

|---|---|---|

| Tone | Signal Transmission | Tracing wires behind panels or finding a specific wire in a bundle. |

| Cont | Continuity Check | Checking for breaks (open circuits) or shorts without needing the receiver. |

=Links=

[1] [https://www.aliexpres.com](https://www.aliexpres.com/item/1005005757654493.html)

[2] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

[3] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

[4] [https://www.aliexpres.com](https://www.aliexpres.com/item/1005005757654493.html)

[5] [https://www.youtube.com](https://www.youtube.com/watch?v=qQHcZgMC-Iw&t=29)

[6] [https://www.flukenetworks.com](https://www.flukenetworks.com/knowledge-base/dtx-cableanalyzer/tone-generator-dtx-cableanalyzer)

[7] [https://www.triplett.com](https://www.triplett.com/blogs/news/a-step-by-step-guide-to-use-a-wire-tracer)

[8] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/downloads/TIS888InstructionManual.pdf)

[9] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/downloads/TIS888InstructionManual.pdf)

[10] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/knowledgebase-article/what-is-a-circuit-tester-or-tone-generator)

[11] [https://images-na.ssl-images-amazon.com](https://images-na.ssl-images-amazon.com/images/I/71oGZIKeXPL.pdf)

[12] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

Aermotor Wires Tracker

2026-05-09T06:55:13Z

Chris T. Ludwig: /* Zusammenfassung */

=Allgmeines=
Ich bin beim Ali ueber das Geraet gestoplert und mir gedacht, fuer 12 Euro kann ich das mal ausprobieren.

TODO

[[File:AermotorWiresTracker.jpg|400px]]

Bei einem drahtlosen Tracker von Aermotor (wie dem AER102 oder EM415PRO) bezeichnen die Begriffe „Tone“ und „Cont“ (oft fälschlicherweise als „Count“ gelesen) die beiden primären Betriebsmodi des Senders. [1, 2, 3]

==Tone (Tracing Mode)==
Die Tonfunktion dient zum aktiven Aufspüren eines bestimmten Kabels. [2, 4]

* Funktionsweise: Der Sender sendet ein hochfrequentes Audiosignal (entweder einen einzelnen Dauerton oder zwei abwechselnde Töne) durch das Kabel.

* Anwendung: Wenn der Sender auf „Ton“ eingestellt ist, scannen Sie mit der Handsonde des Empfängers die Nähe des Kabels. Der Empfänger gibt einen Piepton oder ein vibrierendes Geräusch aus, das lauter wird, je näher Sie dem richtigen Kabel oder der Bruchstelle kommen. [1, 2, 3, 4, 5, 6, 7]

==Cont / Continuity (Testing Mode)==
Die Einstellung CONT (kurz für Durchgangsprüfung) dient zur Überprüfung, ob ein Stromkreis geschlossen oder unterbrochen ist. [3, 8, 9]

* Funktion: Sie prüft den Stromkreis zwischen den beiden Klemmen des Senders.

* Interpretation der LED:

* Geschlossener Stromkreis: Bei geschlossenem Stromkreis (keine Unterbrechung) leuchtet die „CONT“-LED am Sender in der Regel hell (oft grün oder rot, abhängig von der Polarität).

* Unterbrechung: Leuchtet die LED nicht oder nur schwach, deutet dies auf eine Unterbrechung oder einen hohen Widerstand im Kabel hin.

=Zusammenfassung=
Tabelle TODO

| Feature [1, 2, 3, 10] | Meaning | Primary Use |

|---|---|---|

| Tone | Signal Transmission | Tracing wires behind panels or finding a specific wire in a bundle. |

| Cont | Continuity Check | Checking for breaks (open circuits) or shorts without needing the receiver. |

=Links=

[1] [https://www.aliexpres.com](https://www.aliexpres.com/item/1005005757654493.html)

[2] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

[3] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

[4] [https://www.aliexpres.com](https://www.aliexpres.com/item/1005005757654493.html)

[5] [https://www.youtube.com](https://www.youtube.com/watch?v=qQHcZgMC-Iw&t=29)

[6] [https://www.flukenetworks.com](https://www.flukenetworks.com/knowledge-base/dtx-cableanalyzer/tone-generator-dtx-cableanalyzer)

[7] [https://www.triplett.com](https://www.triplett.com/blogs/news/a-step-by-step-guide-to-use-a-wire-tracer)

[8] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/downloads/TIS888InstructionManual.pdf)

[9] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/downloads/TIS888InstructionManual.pdf)

[10] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/knowledgebase-article/what-is-a-circuit-tester-or-tone-generator)

[11] [https://images-na.ssl-images-amazon.com](https://images-na.ssl-images-amazon.com/images/I/71oGZIKeXPL.pdf)

[12] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

Aermotor Wires Tracker

2026-05-09T06:54:35Z

Chris T. Ludwig: Die Seite wurde neu angelegt: „=Allgmeines= Ich bin beim Ali ueber das Geraet gestoplert und mir gedacht, fuer 12 Euro kann ich das mal ausprobieren. TODO 400px Bei einem drahtlosen Tracker von Aermotor (wie dem AER102 oder EM415PRO) bezeichnen die Begriffe „Tone“ und „Cont“ (oft fälschlicherweise als „Count“ gelesen) die beiden primären Betriebsmodi des Senders. [1, 2, 3] ==Tone (Tracing Mode)== Die Tonfunktion dient zum aktiven Auf…“

=Allgmeines=
Ich bin beim Ali ueber das Geraet gestoplert und mir gedacht, fuer 12 Euro kann ich das mal ausprobieren.

TODO

[[File:AermotorWiresTracker.jpg|400px]]

Bei einem drahtlosen Tracker von Aermotor (wie dem AER102 oder EM415PRO) bezeichnen die Begriffe „Tone“ und „Cont“ (oft fälschlicherweise als „Count“ gelesen) die beiden primären Betriebsmodi des Senders. [1, 2, 3]

==Tone (Tracing Mode)==
Die Tonfunktion dient zum aktiven Aufspüren eines bestimmten Kabels. [2, 4]

* Funktionsweise: Der Sender sendet ein hochfrequentes Audiosignal (entweder einen einzelnen Dauerton oder zwei abwechselnde Töne) durch das Kabel.

* Anwendung: Wenn der Sender auf „Ton“ eingestellt ist, scannen Sie mit der Handsonde des Empfängers die Nähe des Kabels. Der Empfänger gibt einen Piepton oder ein vibrierendes Geräusch aus, das lauter wird, je näher Sie dem richtigen Kabel oder der Bruchstelle kommen. [1, 2, 3, 4, 5, 6, 7]

==Cont / Continuity (Testing Mode)==
Die Einstellung CONT (kurz für Durchgangsprüfung) dient zur Überprüfung, ob ein Stromkreis geschlossen oder unterbrochen ist. [3, 8, 9]

* Funktion: Sie prüft den Stromkreis zwischen den beiden Klemmen des Senders.

* Interpretation der LED:

* Geschlossener Stromkreis: Bei geschlossenem Stromkreis (keine Unterbrechung) leuchtet die „CONT“-LED am Sender in der Regel hell (oft grün oder rot, abhängig von der Polarität).

* Unterbrechung: Leuchtet die LED nicht oder nur schwach, deutet dies auf eine Unterbrechung oder einen hohen Widerstand im Kabel hin.

=Zusammenfassung=
Tabelle TODO

| Feature [1, 2, 3, 10] | Meaning | Primary Use |
|---|---|---|
| Tone | Signal Transmission | Tracing wires behind panels or finding a specific wire in a bundle. |
| Cont | Continuity Check | Checking for breaks (open circuits) or shorts without needing the receiver. |

=Links=

[1] [https://www.aliexpres.com](https://www.aliexpres.com/item/1005005757654493.html)

[2] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

[3] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

[4] [https://www.aliexpres.com](https://www.aliexpres.com/item/1005005757654493.html)

[5] [https://www.youtube.com](https://www.youtube.com/watch?v=qQHcZgMC-Iw&t=29)

[6] [https://www.flukenetworks.com](https://www.flukenetworks.com/knowledge-base/dtx-cableanalyzer/tone-generator-dtx-cableanalyzer)

[7] [https://www.triplett.com](https://www.triplett.com/blogs/news/a-step-by-step-guide-to-use-a-wire-tracer)

[8] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/downloads/TIS888InstructionManual.pdf)

[9] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/downloads/TIS888InstructionManual.pdf)

[10] [https://www.testinstrumentsolutions.co.uk](https://www.testinstrumentsolutions.co.uk/knowledgebase-article/what-is-a-circuit-tester-or-tone-generator)

[11] [https://images-na.ssl-images-amazon.com](https://images-na.ssl-images-amazon.com/images/I/71oGZIKeXPL.pdf)

[12] [https://m.tvcmall.com](https://m.tvcmall.com/details/aermotor-aer102-em415pro-car-circuit-tester-line-checker-detector-monitoring-tool-sku671200683a.html)

Datei:AermotorWiresTracker.jpg

2026-05-09T06:47:44Z

Chris T. Ludwig: Datei hochgeladen mit MsUpload

Datei hochgeladen mit MsUpload

Reolink

2026-05-03T05:59:22Z

Chris T. Ludwig: Die Seite wurde neu angelegt: „=Kameras= ==RLC-810A== Build No.build 23062505 Hardware No.IPC_56064M8MP Config Versionv3.1.0.0 Firmware Versionv3.1.0.2368_23062505 DetailsIPC_56064M8MPS18E1W03400000008 Die von den KIs vorgeschlagene Streaming-URLs Main Stream rtsp://admin:password@ip_address:554/h264Preview_01_main Sub Stream rtsp://admin:password@ip_address:554/h264Preview_01_sub funktionieren bei mir“

=Kameras=

==RLC-810A==
Build No.build 23062505
Hardware No.IPC_56064M8MP
Config Versionv3.1.0.0
Firmware Versionv3.1.0.2368_23062505
DetailsIPC_56064M8MPS18E1W03400000008

Die von den KIs vorgeschlagene Streaming-URLs

Main Stream
rtsp://admin:password@ip_address:554/h264Preview_01_main

Sub Stream
rtsp://admin:password@ip_address:554/h264Preview_01_sub

funktionieren bei mir

(FHEM) FTUI 3 Components

2026-05-02T13:06:03Z

Chris T. Ludwig: /* grid.components.js */

=grid.components.js=

Irgendwie wird die Flaeche durch eine falsche Grid-Anzahl nicht voll ausgenutzt.
Zum Testen habe ich in configureGrid() mal folgende Zeilen eingefuegt.
Durch (col-1) wurde der Fehler behoben.

<pre>
cols = (this.cols > 0) ? this.cols : highestCol;
rows = (this.rows > 0) ? this.rows : highestRow;
console.log("Cols: "+cols+" highest: "+highestCol);
console.log("Rows: "+rows+" highest: "+highestRow);
baseWidth = (this.baseWidth > 0) ? this.baseWidth : (this.clientWidth - this.margin) / (cols-1); //!!!!!!!!
baseHeight = (this.baseHeight > 0) ? this.baseHeight : (this.clientHeight - this.margin) / rows;
console.log("baseWidth: "+baseWidth+" calc: "+this.baseWidth+"/"+this.clientWidth+"/"+this.margin);
console.log("baseHeight: "+baseHeight+" calc: "+this.baseHeight+"/"+this.clientHeight+"/"+this.margin);
</pre>

=element.components.js=

Deklaration der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`.

Sie kuemmert sich um:

* automatische IDs
* Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding`
* Verbindung zwischen Attributen und JavaScript-Properties
* Shadow DOM
* Change-Events für FTUI-Bindings
* Hooks für abgeleitete Komponenten

==Kurzueberblick==

<pre>
export class FtuiElement extends HTMLElement
</pre>

`FtuiElement` erweitert den nativen Browser-Typ `HTMLElement`. Dadurch wird daraus die gemeinsame Basis für eigene HTML-Tags wie:

<pre>
<ftui-button></ftui-button>
<ftui-label></ftui-label>
</pre>

==Import==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';
</pre>

Es werden drei Hilfsfunktionen verwendet:
* isNumeric() prüft, ob ein Wert numerisch ist
* toKebabCase() wandelt z.B. "baseWidth" in "base-width"
* log() schreibt Debug-Ausgaben

==UID-Zähler==

<pre>
const uids = {};
</pre>

Damit bekommt jedes FTUI-Element automatisch eine ID, falls keine gesetzt wurde.

Beispiel:

<pre>
<ftui-label></ftui-label>
</pre>

wird intern etwa zu:

<pre>
<ftui-label id="ftui_label_1"></ftui-label>
</pre>

==Constructor==

<pre>
constructor(properties) {
super();
</pre>

`super()` ruft den Konstruktor von `HTMLElement` auf. Das ist bei Webcomponents Pflicht.

<pre>
if (!this.id) {
...
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}
</pre>

Falls das Element keine ID hat, wird automatisch eine erzeugt.

<pre>
this.properties = Object.assign(FtuiElement.properties, properties);
</pre>

Hier werden die Standard-Properties der Basisklasse mit den Properties der konkreten Komponente gemischt.

Beispiel:

<pre>
FtuiElement.properties = {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: ''
}
</pre>

Ein `ftui-button` könnte zusätzlich `value`, `color`, `fill` usw. definieren.

Achtung: `Object.assign(FtuiElement.properties, properties)` verändert das Objekt `FtuiElement.properties`. Sauberer wäre oft:

<pre>
Object.assign({}, FtuiElement.properties, properties)
</pre>

Sonst können Properties versehentlich global vermischt werden.

<pre>
this.initProperties(this.properties);
</pre>

Erzeugt für jede Property Getter/Setter und initialisiert die passenden HTML-Attribute.

<pre>
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}
</pre>

Wenn die konkrete Komponente eine Methode `template()` besitzt, wird daraus ein Shadow DOM erzeugt.

<pre>
this.isActiveChange = {};
</pre>

Merker für aktive Änderungen, wichtig für Two-Way-Binding.

<pre>
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
</pre>

Wenn die FTUI-App bereits existiert, wird das Element mit dem FTUI-Binding-System verbunden.

==Shadow DOM==

<pre>
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}
</pre>

Diese Methode baut das interne DOM der Komponente.

Beispiel:

<pre>
template() {
return `<button><slot></slot></button>`;
}
</pre>

wird zu einem Shadow DOM innerhalb des Elements.

`mode: 'open'` bedeutet: Man kann von außen per JavaScript darauf zugreifen:

<pre>
element.shadowRoot
</pre>

==Standard-Properties==

<pre>
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}
</pre>

Jedes FTUI-Element bekommt diese Attribute:

<pre>
<ftui-button hidden></ftui-button>
<ftui-button disabled></ftui-button>
<ftui-button readonly></ftui-button>
<ftui-button margin="1"></ftui-button>
<ftui-button padding="0.5"></ftui-button>
</pre>

==observedAttributes==

<pre>
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}
</pre>

Der Browser ruft `attributeChangedCallback()` nur für Attribute auf, die hier stehen.

Wichtig: Hier werden nur die Basiseigenschaften beobachtet. Abgeleitete Komponenten müssen wahrscheinlich selbst `observedAttributes` erweitern, sonst werden ihre eigenen Attribute nicht automatisch beobachtet.

==convertToAttributes==

<pre>
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}
</pre>

Hilfsfunktion, um Property-Namen in HTML-Attributnamen umzuwandeln.

Beispiel:

<pre>
baseWidth
</pre>

wird zu:

<pre>
base-width
</pre>

==connectedCallback==

<pre>
connectedCallback() {
this.updateProperties();
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}
</pre>

Diese Methode wird automatisch vom Browser aufgerufen, wenn das Element in die Seite eingefügt wird.

Ablauf:

1. Standardwerte werden verarbeitet.

2. Falls die konkrete Komponente `onConnected()` definiert, wird diese Hook-Funktion ausgeführt.

Beispiel in einer Kindklasse:

<pre>
onConnected() {
console.log('Button ist im DOM');
}
</pre>

==attributeChangedCallback==

<pre>
attributeChangedCallback(name, oldValue, newValue) {
</pre>

Wird aufgerufen, wenn ein beobachtetes Attribut geändert wird.

<pre>
log(3, `${this.id} - attributeChangedCallback ...`)
</pre>

Debug-Ausgabe.

<pre>
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}
</pre>

Hook für Kindklassen.

Danach behandelt die Basisklasse ihre Standardattribute:

#==hidden

<pre>
case 'hidden':
this.style.display = hasValue ? 'none' : '';
</pre>

Wenn `hidden` gesetzt ist, wird das Element ausgeblendet.

#==disabled

<pre>
case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Optisch ausgegraut und nicht anklickbar.

#==readonly

<pre>
case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Nicht bedienbar, aber ohne optischen Filter.

#==margin

<pre>
case 'margin':
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
</pre>

Wenn numerisch:

<pre>
margin="1"
</pre>

wird zu:

<pre>
margin: 1em;
</pre>

Wenn nicht numerisch:

<pre>
margin="10px"
</pre>

bleibt:

<pre>
margin: 10px;
</pre>

Für `FTUI-GRID` wird `margin` hier nicht gesetzt, vermutlich weil `ftui-grid` sein eigenes Margin-Verhalten hat.

#==padding

<pre>
case 'padding':
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
</pre>

Analog zu `margin`.

==submitChange==

<pre>
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}
</pre>

Das ist wichtig für FTUI-Bindings.

Wenn eine Komponente intern einen Wert ändert, etwa ein Button oder Slider, ruft sie:

<pre>
this.submitChange('value', newValue);
</pre>

Dann passiert:

1. Änderung wird als aktiv markiert.
2. Property wird gesetzt.
3. Ein Event `valueChange` wird ausgelöst.

Dieses Event kann FTUI dann nutzen, um per `(value)` oder `[(value)]` etwas an FHEM zu senden.

==emitChangeEvent und emitEvent==

<pre>
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}
</pre>

Aus `value` wird:

</pre>text
valueChange
</pre>

<pre>
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}
</pre>

Es wird ein normales DOM-Event ausgelöst.

Beispiel:

<pre>
this.emitChangeEvent('value', 'on');
</pre>

erzeugt:

<pre>
new CustomEvent('valueChange', { detail: 'on' })
</pre>

==initProperties==

<pre>
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
</pre>

Für jede Property wird automatisch ein passender Getter/Setter erzeugt.

Beispiel:

<pre>
hidden: false
</pre>

wird zu:

<pre>
element.hidden
</pre>

und HTML-Attribut:

<pre>
hidden
</pre>

#==Boolean

<pre>
if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);
}
</pre>

Boolean-Attribute funktionieren nach HTML-Logik:

<pre>
<ftui-button disabled></ftui-button>
</pre>

bedeutet `true`.

#==Number

<pre>
else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Wird beim Lesen in `Number(...)` umgewandelt.

#==String

<pre>
else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Normale String-Attribute.

==initAttribute==

<pre>
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}
</pre>

Wenn das Attribut noch nicht im HTML steht, wird der Default gesetzt.

Beispiel:

<pre>
padding: ''
</pre>

führt zu:

<pre>
padding=""
</pre>

==initBooleanAttribute==

<pre>
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}
</pre>

Boolean-Attribute werden nur gesetzt, wenn der Default `true` ist.

Da `hidden`, `disabled`, `readonly` alle `false` sind, werden sie standardmäßig nicht gesetzt.

==defineBooleanProperty==

<pre>
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
</pre>

Damit kann man schreiben:

<pre>
element.disabled = true;
</pre>

und bekommt im HTML:

<pre>
<ftui-button disabled></ftui-button>
</pre>

Bei:

<pre>
element.disabled = false;
</pre>

wird das Attribut entfernt.

Interessant:

<pre>
disabled="false"
</pre>

wird als `false` interpretiert. Das ist etwas komfortabler als natives HTML, wo ein vorhandenes Boolean-Attribut normalerweise immer wahr ist.

==defineNumberProperty==

<pre>
get() { return Number(this.getAttribute(attr)); },
set(value) { this.setAttribute(attr, value); },
</pre>

Beispiel:

<pre>
<ftui-grid-tile row="2"></ftui-grid-tile>
</pre>

<pre>
element.row
</pre>

liefert Zahl `2`.

==defineStringProperty==

<pre>
get() { return this.getAttribute(attr); },
set(value) { this.setAttribute(attr, value); },
</pre>

Normale Abbildung:

<pre>
element.text = 'Hallo';
</pre>

wird zu:

<pre>
text="Hallo"
</pre>

==updateProperties==

<pre>
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);
if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
})
}
</pre>

Beim Einfügen ins DOM werden Standardattribute nochmal verarbeitet.

Warum?
Wenn ein Attribut schon beim Erzeugen gesetzt wurde, kann es sein, dass die Style-Logik noch nicht gelaufen ist. `updateProperties()` erzwingt deshalb die Behandlung der Defaultwerte.

==Kommentierte Version==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';

// Zähler für automatisch erzeugte IDs pro Elementtyp
const uids = {};

// Basisklasse aller FTUI-Webcomponents
export class FtuiElement extends HTMLElement {

constructor(properties) {
super();

// Falls keine ID vorhanden ist, automatisch eine eindeutige ID erzeugen
if (!this.id) {
if (!uids[this.localName]) {
uids[this.localName] = 1;
}
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}

// Standardproperties der Basisklasse mit Komponentenproperties kombinieren
this.properties = Object.assign(FtuiElement.properties, properties);

// Für alle Properties Getter/Setter und Default-Attribute anlegen
this.initProperties(this.properties);

// Wenn die Komponente ein Template besitzt, Shadow DOM erzeugen
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}

// Merker für aktive Änderungen, wichtig für Output-/Two-Way-Bindings
this.isActiveChange = {};

// Element beim globalen FTUI-Binding-System anmelden
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
}

// Erzeugt Shadow DOM aus einem HTML-Template-String
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}

// Standardattribute, die jedes FTUI-Element besitzt
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}

// Attribute, bei deren Änderung attributeChangedCallback ausgelöst wird
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}

// Wandelt Property-Namen in HTML-Attributnamen um
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}

// Wird vom Browser aufgerufen, wenn das Element in den DOM eingefügt wurde
connectedCallback() {
this.updateProperties();

// Hook für abgeleitete Komponenten
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}

// Wird aufgerufen, wenn sich ein beobachtetes Attribut ändert
attributeChangedCallback(name, oldValue, newValue) {
log(3, `${this.id} - attributeChangedCallback name=${name}, oldValue=${oldValue}, newValue=${newValue}`);

// Hook für abgeleitete Komponenten
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}

const hasValue = newValue !== null && newValue !== false;

// Standardattribute behandeln
switch (name) {
case 'hidden':
this.style.display = hasValue ? 'none' : '';
break;

case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'margin': {
// ftui-grid behandelt margin selbst
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
break;
}

case 'padding': {
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
break;
}
}
}

// Wird von Komponenten genutzt, wenn ein Benutzerwert geändert wurde
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}

// Erzeugt z.B. valueChange aus value
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}

// Löst ein DOM CustomEvent aus
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}

// Initialisiert Properties abhängig vom Typ des Defaultwerts
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);

} else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);

} else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
});
}

// Setzt Default-Attribut, wenn es noch nicht existiert
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}

// Setzt Boolean-Attribut nur, wenn Default true ist
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}

// Definiert Boolean-Property mit HTML-Attribut-Synchronisierung
defineBooleanProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
}

// Definiert Number-Property
defineNumberProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return Number(this.getAttribute(attr));
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Definiert String-Property
defineStringProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.getAttribute(attr);
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Behandelt Defaultwerte beim Einfügen des Elements in den DOM
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
});
}
}
</pre>

==Mögliche Schwachstellen / Besonderheiten==

1. **`Object.assign(FtuiElement.properties, properties)` mutiert die statischen Basiseigenschaften.**
Sicherer wäre:

<pre>
this.properties = Object.assign({}, FtuiElement.properties, properties);
</pre>

2. **`observedAttributes` enthält nur Basiseigenschaften.**
Kindklassen müssen eigene Attribute selbst hinzufügen.

3. **Boolean-Erkennung `newValue !== false` ist etwas ungenau.**
Attribute liefern normalerweise Strings oder `null`, nicht echtes `false`. Bei `disabled="false"` funktioniert der Getter zwar korrekt, aber `attributeChangedCallback()` behandelt `"false"` trotzdem als vorhanden.

4. **`initAttribute()` setzt auch leere Default-Strings als Attribute.**
Dadurch entstehen Attribute wie:

<pre>
margin=""
padding=""
</pre>

Das ist nicht falsch, aber kann unnötige `attributeChangedCallback()`-Aufrufe erzeugen.

5. **`createShadowRoot()` nutzt `innerHTML`.**
Das ist normal für Templates, aber Template-Inhalte sollten kontrolliert sein.

==Merksatz==

Dieses Programm macht aus einer normalen Webcomponent eine **FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events**.

(FHEM) FTUI 3 Components

2026-05-01T07:20:43Z

Chris T. Ludwig: /* element.components.js */

=grid.components.js=

Irgendwie wird die Flaeche durch eine falsche Grid-Anzahl nicht voll ausgenutzt.
Zum Testen habe ich in configureGrid() mal folgende Zeilen eingefuegt.
Durch (col-1) wurde der Fehler behoben.

<pre>
cols = (this.cols > 0) ? this.cols : highestCol;
rows = (this.rows > 0) ? this.rows : highestRow;
console.log("Cols: "+cols+" highest: "+highestCol);
console.log("Rows: "+rows+" highest: "+highestRow);
baseWidth = (this.baseWidth > 0) ? this.baseWidth : (this.clientWidth - this.margin) / (cols-1);
baseHeight = (this.baseHeight > 0) ? this.baseHeight : (this.clientHeight - this.margin) / rows;
console.log("baseWidth: "+baseWidth+" calc: "+this.baseWidth+"/"+this.clientWidth+"/"+this.margin);
console.log("baseHeight: "+baseHeight+" calc: "+this.baseHeight+"/"+this.clientHeight+"/"+this.margin);
</pre>

=element.components.js=

Deklaration der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`.

Sie kuemmert sich um:

* automatische IDs
* Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding`
* Verbindung zwischen Attributen und JavaScript-Properties
* Shadow DOM
* Change-Events für FTUI-Bindings
* Hooks für abgeleitete Komponenten

==Kurzueberblick==

<pre>
export class FtuiElement extends HTMLElement
</pre>

`FtuiElement` erweitert den nativen Browser-Typ `HTMLElement`. Dadurch wird daraus die gemeinsame Basis für eigene HTML-Tags wie:

<pre>
<ftui-button></ftui-button>
<ftui-label></ftui-label>
</pre>

==Import==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';
</pre>

Es werden drei Hilfsfunktionen verwendet:
* isNumeric() prüft, ob ein Wert numerisch ist
* toKebabCase() wandelt z.B. "baseWidth" in "base-width"
* log() schreibt Debug-Ausgaben

==UID-Zähler==

<pre>
const uids = {};
</pre>

Damit bekommt jedes FTUI-Element automatisch eine ID, falls keine gesetzt wurde.

Beispiel:

<pre>
<ftui-label></ftui-label>
</pre>

wird intern etwa zu:

<pre>
<ftui-label id="ftui_label_1"></ftui-label>
</pre>

==Constructor==

<pre>
constructor(properties) {
super();
</pre>

`super()` ruft den Konstruktor von `HTMLElement` auf. Das ist bei Webcomponents Pflicht.

<pre>
if (!this.id) {
...
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}
</pre>

Falls das Element keine ID hat, wird automatisch eine erzeugt.

<pre>
this.properties = Object.assign(FtuiElement.properties, properties);
</pre>

Hier werden die Standard-Properties der Basisklasse mit den Properties der konkreten Komponente gemischt.

Beispiel:

<pre>
FtuiElement.properties = {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: ''
}
</pre>

Ein `ftui-button` könnte zusätzlich `value`, `color`, `fill` usw. definieren.

Achtung: `Object.assign(FtuiElement.properties, properties)` verändert das Objekt `FtuiElement.properties`. Sauberer wäre oft:

<pre>
Object.assign({}, FtuiElement.properties, properties)
</pre>

Sonst können Properties versehentlich global vermischt werden.

<pre>
this.initProperties(this.properties);
</pre>

Erzeugt für jede Property Getter/Setter und initialisiert die passenden HTML-Attribute.

<pre>
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}
</pre>

Wenn die konkrete Komponente eine Methode `template()` besitzt, wird daraus ein Shadow DOM erzeugt.

<pre>
this.isActiveChange = {};
</pre>

Merker für aktive Änderungen, wichtig für Two-Way-Binding.

<pre>
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
</pre>

Wenn die FTUI-App bereits existiert, wird das Element mit dem FTUI-Binding-System verbunden.

==Shadow DOM==

<pre>
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}
</pre>

Diese Methode baut das interne DOM der Komponente.

Beispiel:

<pre>
template() {
return `<button><slot></slot></button>`;
}
</pre>

wird zu einem Shadow DOM innerhalb des Elements.

`mode: 'open'` bedeutet: Man kann von außen per JavaScript darauf zugreifen:

<pre>
element.shadowRoot
</pre>

==Standard-Properties==

<pre>
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}
</pre>

Jedes FTUI-Element bekommt diese Attribute:

<pre>
<ftui-button hidden></ftui-button>
<ftui-button disabled></ftui-button>
<ftui-button readonly></ftui-button>
<ftui-button margin="1"></ftui-button>
<ftui-button padding="0.5"></ftui-button>
</pre>

==observedAttributes==

<pre>
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}
</pre>

Der Browser ruft `attributeChangedCallback()` nur für Attribute auf, die hier stehen.

Wichtig: Hier werden nur die Basiseigenschaften beobachtet. Abgeleitete Komponenten müssen wahrscheinlich selbst `observedAttributes` erweitern, sonst werden ihre eigenen Attribute nicht automatisch beobachtet.

==convertToAttributes==

<pre>
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}
</pre>

Hilfsfunktion, um Property-Namen in HTML-Attributnamen umzuwandeln.

Beispiel:

<pre>
baseWidth
</pre>

wird zu:

<pre>
base-width
</pre>

==connectedCallback==

<pre>
connectedCallback() {
this.updateProperties();
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}
</pre>

Diese Methode wird automatisch vom Browser aufgerufen, wenn das Element in die Seite eingefügt wird.

Ablauf:

1. Standardwerte werden verarbeitet.

2. Falls die konkrete Komponente `onConnected()` definiert, wird diese Hook-Funktion ausgeführt.

Beispiel in einer Kindklasse:

<pre>
onConnected() {
console.log('Button ist im DOM');
}
</pre>

==attributeChangedCallback==

<pre>
attributeChangedCallback(name, oldValue, newValue) {
</pre>

Wird aufgerufen, wenn ein beobachtetes Attribut geändert wird.

<pre>
log(3, `${this.id} - attributeChangedCallback ...`)
</pre>

Debug-Ausgabe.

<pre>
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}
</pre>

Hook für Kindklassen.

Danach behandelt die Basisklasse ihre Standardattribute:

#==hidden

<pre>
case 'hidden':
this.style.display = hasValue ? 'none' : '';
</pre>

Wenn `hidden` gesetzt ist, wird das Element ausgeblendet.

#==disabled

<pre>
case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Optisch ausgegraut und nicht anklickbar.

#==readonly

<pre>
case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Nicht bedienbar, aber ohne optischen Filter.

#==margin

<pre>
case 'margin':
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
</pre>

Wenn numerisch:

<pre>
margin="1"
</pre>

wird zu:

<pre>
margin: 1em;
</pre>

Wenn nicht numerisch:

<pre>
margin="10px"
</pre>

bleibt:

<pre>
margin: 10px;
</pre>

Für `FTUI-GRID` wird `margin` hier nicht gesetzt, vermutlich weil `ftui-grid` sein eigenes Margin-Verhalten hat.

#==padding

<pre>
case 'padding':
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
</pre>

Analog zu `margin`.

==submitChange==

<pre>
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}
</pre>

Das ist wichtig für FTUI-Bindings.

Wenn eine Komponente intern einen Wert ändert, etwa ein Button oder Slider, ruft sie:

<pre>
this.submitChange('value', newValue);
</pre>

Dann passiert:

1. Änderung wird als aktiv markiert.
2. Property wird gesetzt.
3. Ein Event `valueChange` wird ausgelöst.

Dieses Event kann FTUI dann nutzen, um per `(value)` oder `[(value)]` etwas an FHEM zu senden.

==emitChangeEvent und emitEvent==

<pre>
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}
</pre>

Aus `value` wird:

</pre>text
valueChange
</pre>

<pre>
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}
</pre>

Es wird ein normales DOM-Event ausgelöst.

Beispiel:

<pre>
this.emitChangeEvent('value', 'on');
</pre>

erzeugt:

<pre>
new CustomEvent('valueChange', { detail: 'on' })
</pre>

==initProperties==

<pre>
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
</pre>

Für jede Property wird automatisch ein passender Getter/Setter erzeugt.

Beispiel:

<pre>
hidden: false
</pre>

wird zu:

<pre>
element.hidden
</pre>

und HTML-Attribut:

<pre>
hidden
</pre>

#==Boolean

<pre>
if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);
}
</pre>

Boolean-Attribute funktionieren nach HTML-Logik:

<pre>
<ftui-button disabled></ftui-button>
</pre>

bedeutet `true`.

#==Number

<pre>
else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Wird beim Lesen in `Number(...)` umgewandelt.

#==String

<pre>
else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Normale String-Attribute.

==initAttribute==

<pre>
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}
</pre>

Wenn das Attribut noch nicht im HTML steht, wird der Default gesetzt.

Beispiel:

<pre>
padding: ''
</pre>

führt zu:

<pre>
padding=""
</pre>

==initBooleanAttribute==

<pre>
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}
</pre>

Boolean-Attribute werden nur gesetzt, wenn der Default `true` ist.

Da `hidden`, `disabled`, `readonly` alle `false` sind, werden sie standardmäßig nicht gesetzt.

==defineBooleanProperty==

<pre>
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
</pre>

Damit kann man schreiben:

<pre>
element.disabled = true;
</pre>

und bekommt im HTML:

<pre>
<ftui-button disabled></ftui-button>
</pre>

Bei:

<pre>
element.disabled = false;
</pre>

wird das Attribut entfernt.

Interessant:

<pre>
disabled="false"
</pre>

wird als `false` interpretiert. Das ist etwas komfortabler als natives HTML, wo ein vorhandenes Boolean-Attribut normalerweise immer wahr ist.

==defineNumberProperty==

<pre>
get() { return Number(this.getAttribute(attr)); },
set(value) { this.setAttribute(attr, value); },
</pre>

Beispiel:

<pre>
<ftui-grid-tile row="2"></ftui-grid-tile>
</pre>

<pre>
element.row
</pre>

liefert Zahl `2`.

==defineStringProperty==

<pre>
get() { return this.getAttribute(attr); },
set(value) { this.setAttribute(attr, value); },
</pre>

Normale Abbildung:

<pre>
element.text = 'Hallo';
</pre>

wird zu:

<pre>
text="Hallo"
</pre>

==updateProperties==

<pre>
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);
if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
})
}
</pre>

Beim Einfügen ins DOM werden Standardattribute nochmal verarbeitet.

Warum?
Wenn ein Attribut schon beim Erzeugen gesetzt wurde, kann es sein, dass die Style-Logik noch nicht gelaufen ist. `updateProperties()` erzwingt deshalb die Behandlung der Defaultwerte.

==Kommentierte Version==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';

// Zähler für automatisch erzeugte IDs pro Elementtyp
const uids = {};

// Basisklasse aller FTUI-Webcomponents
export class FtuiElement extends HTMLElement {

constructor(properties) {
super();

// Falls keine ID vorhanden ist, automatisch eine eindeutige ID erzeugen
if (!this.id) {
if (!uids[this.localName]) {
uids[this.localName] = 1;
}
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}

// Standardproperties der Basisklasse mit Komponentenproperties kombinieren
this.properties = Object.assign(FtuiElement.properties, properties);

// Für alle Properties Getter/Setter und Default-Attribute anlegen
this.initProperties(this.properties);

// Wenn die Komponente ein Template besitzt, Shadow DOM erzeugen
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}

// Merker für aktive Änderungen, wichtig für Output-/Two-Way-Bindings
this.isActiveChange = {};

// Element beim globalen FTUI-Binding-System anmelden
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
}

// Erzeugt Shadow DOM aus einem HTML-Template-String
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}

// Standardattribute, die jedes FTUI-Element besitzt
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}

// Attribute, bei deren Änderung attributeChangedCallback ausgelöst wird
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}

// Wandelt Property-Namen in HTML-Attributnamen um
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}

// Wird vom Browser aufgerufen, wenn das Element in den DOM eingefügt wurde
connectedCallback() {
this.updateProperties();

// Hook für abgeleitete Komponenten
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}

// Wird aufgerufen, wenn sich ein beobachtetes Attribut ändert
attributeChangedCallback(name, oldValue, newValue) {
log(3, `${this.id} - attributeChangedCallback name=${name}, oldValue=${oldValue}, newValue=${newValue}`);

// Hook für abgeleitete Komponenten
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}

const hasValue = newValue !== null && newValue !== false;

// Standardattribute behandeln
switch (name) {
case 'hidden':
this.style.display = hasValue ? 'none' : '';
break;

case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'margin': {
// ftui-grid behandelt margin selbst
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
break;
}

case 'padding': {
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
break;
}
}
}

// Wird von Komponenten genutzt, wenn ein Benutzerwert geändert wurde
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}

// Erzeugt z.B. valueChange aus value
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}

// Löst ein DOM CustomEvent aus
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}

// Initialisiert Properties abhängig vom Typ des Defaultwerts
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);

} else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);

} else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
});
}

// Setzt Default-Attribut, wenn es noch nicht existiert
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}

// Setzt Boolean-Attribut nur, wenn Default true ist
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}

// Definiert Boolean-Property mit HTML-Attribut-Synchronisierung
defineBooleanProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
}

// Definiert Number-Property
defineNumberProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return Number(this.getAttribute(attr));
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Definiert String-Property
defineStringProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.getAttribute(attr);
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Behandelt Defaultwerte beim Einfügen des Elements in den DOM
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
});
}
}
</pre>

==Mögliche Schwachstellen / Besonderheiten==

1. **`Object.assign(FtuiElement.properties, properties)` mutiert die statischen Basiseigenschaften.**
Sicherer wäre:

<pre>
this.properties = Object.assign({}, FtuiElement.properties, properties);
</pre>

2. **`observedAttributes` enthält nur Basiseigenschaften.**
Kindklassen müssen eigene Attribute selbst hinzufügen.

3. **Boolean-Erkennung `newValue !== false` ist etwas ungenau.**
Attribute liefern normalerweise Strings oder `null`, nicht echtes `false`. Bei `disabled="false"` funktioniert der Getter zwar korrekt, aber `attributeChangedCallback()` behandelt `"false"` trotzdem als vorhanden.

4. **`initAttribute()` setzt auch leere Default-Strings als Attribute.**
Dadurch entstehen Attribute wie:

<pre>
margin=""
padding=""
</pre>

Das ist nicht falsch, aber kann unnötige `attributeChangedCallback()`-Aufrufe erzeugen.

5. **`createShadowRoot()` nutzt `innerHTML`.**
Das ist normal für Templates, aber Template-Inhalte sollten kontrolliert sein.

==Merksatz==

Dieses Programm macht aus einer normalen Webcomponent eine **FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events**.

(FHEM) FTUI 3

2026-05-01T07:16:25Z

Chris T. Ludwig: /* Formatierung/Layout */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── element.components.js Macht aus einer normalen Webcomponent eine FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events.
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── (insgesamt 37 siehe unten)
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==
Es gibt insgesamt 37 Komponenten:
<pre>
badge
button
cell
chart
checkbox
circlemenu
clock
colorpicker
column
content
departure
dropdown
grid
icon
image
input
knob
label
main
map
medialist
menu
meter
nav
popup
rotor
row
segment
slider
solar
speak
swiper
switch
tab
timeset
view
weather
</pre>

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
</pre>

Der '''View''' ist die Basis fuer:
* Toolbar
* Stage
* Sheet
* Section
* Item

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

==Links==
[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"

[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"

[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"

[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"

[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Die Breite eines ftui-grid-tile wird im ftui-grid (Parent) berechnet
→ über base-width, width, margin
→ und dann als CSS (grid/flex/inline-style) umgesetzt

Die Breite der Grid-Tiles wird irgendwie falsch berechnet.
Dadurch entsteht faelschlicherweise eine leere Flaeche an der rechten Seite.
Siehe [[(FHEM) FTUI 3 Components]].

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-05-01T05:39:28Z

Chris T. Ludwig: /* Formatierung/Layout */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── element.components.js Macht aus einer normalen Webcomponent eine FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events.
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── (insgesamt 37 siehe unten)
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==
Es gibt insgesamt 37 Komponenten:
<pre>
badge
button
cell
chart
checkbox
circlemenu
clock
colorpicker
column
content
departure
dropdown
grid
icon
image
input
knob
label
main
map
medialist
menu
meter
nav
popup
rotor
row
segment
slider
solar
speak
swiper
switch
tab
timeset
view
weather
</pre>

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
</pre>

Der '''View''' ist die Basis fuer:
* Toolbar
* Stage
* Sheet
* Section
* Item

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

==Links==
[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"

[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"

[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"

[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"

[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Die Breite eines ftui-grid-tile wird im ftui-grid (Parent) berechnet
→ über base-width, width, margin
→ und dann als CSS (grid/flex/inline-style) umgesetzt

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-27T16:47:21Z

Chris T. Ludwig: /* Komponentenprogramme */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── element.components.js Macht aus einer normalen Webcomponent eine FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events.
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── (insgesamt 37 siehe unten)
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==
Es gibt insgesamt 37 Komponenten:
<pre>
badge
button
cell
chart
checkbox
circlemenu
clock
colorpicker
column
content
departure
dropdown
grid
icon
image
input
knob
label
main
map
medialist
menu
meter
nav
popup
rotor
row
segment
slider
solar
speak
swiper
switch
tab
timeset
view
weather
</pre>

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
</pre>

Der '''View''' ist die Basis fuer:
* Toolbar
* Stage
* Sheet
* Section
* Item

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

==Links==
[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"

[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"

[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"

[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"

[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3 Components

2026-04-26T15:44:03Z

Chris T. Ludwig: /* initBooleanAttribute */

=element.components.js=

Deklaration der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`.

Sie kuemmert sich um:

* automatische IDs
* Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding`
* Verbindung zwischen Attributen und JavaScript-Properties
* Shadow DOM
* Change-Events für FTUI-Bindings
* Hooks für abgeleitete Komponenten

==Kurzueberblick==

<pre>
export class FtuiElement extends HTMLElement
</pre>

`FtuiElement` erweitert den nativen Browser-Typ `HTMLElement`. Dadurch wird daraus die gemeinsame Basis für eigene HTML-Tags wie:

<pre>
<ftui-button></ftui-button>
<ftui-label></ftui-label>
</pre>

==Import==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';
</pre>

Es werden drei Hilfsfunktionen verwendet:
* isNumeric() prüft, ob ein Wert numerisch ist
* toKebabCase() wandelt z.B. "baseWidth" in "base-width"
* log() schreibt Debug-Ausgaben

==UID-Zähler==

<pre>
const uids = {};
</pre>

Damit bekommt jedes FTUI-Element automatisch eine ID, falls keine gesetzt wurde.

Beispiel:

<pre>
<ftui-label></ftui-label>
</pre>

wird intern etwa zu:

<pre>
<ftui-label id="ftui_label_1"></ftui-label>
</pre>

==Constructor==

<pre>
constructor(properties) {
super();
</pre>

`super()` ruft den Konstruktor von `HTMLElement` auf. Das ist bei Webcomponents Pflicht.

<pre>
if (!this.id) {
...
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}
</pre>

Falls das Element keine ID hat, wird automatisch eine erzeugt.

<pre>
this.properties = Object.assign(FtuiElement.properties, properties);
</pre>

Hier werden die Standard-Properties der Basisklasse mit den Properties der konkreten Komponente gemischt.

Beispiel:

<pre>
FtuiElement.properties = {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: ''
}
</pre>

Ein `ftui-button` könnte zusätzlich `value`, `color`, `fill` usw. definieren.

Achtung: `Object.assign(FtuiElement.properties, properties)` verändert das Objekt `FtuiElement.properties`. Sauberer wäre oft:

<pre>
Object.assign({}, FtuiElement.properties, properties)
</pre>

Sonst können Properties versehentlich global vermischt werden.

<pre>
this.initProperties(this.properties);
</pre>

Erzeugt für jede Property Getter/Setter und initialisiert die passenden HTML-Attribute.

<pre>
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}
</pre>

Wenn die konkrete Komponente eine Methode `template()` besitzt, wird daraus ein Shadow DOM erzeugt.

<pre>
this.isActiveChange = {};
</pre>

Merker für aktive Änderungen, wichtig für Two-Way-Binding.

<pre>
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
</pre>

Wenn die FTUI-App bereits existiert, wird das Element mit dem FTUI-Binding-System verbunden.

==Shadow DOM==

<pre>
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}
</pre>

Diese Methode baut das interne DOM der Komponente.

Beispiel:

<pre>
template() {
return `<button><slot></slot></button>`;
}
</pre>

wird zu einem Shadow DOM innerhalb des Elements.

`mode: 'open'` bedeutet: Man kann von außen per JavaScript darauf zugreifen:

<pre>
element.shadowRoot
</pre>

==Standard-Properties==

<pre>
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}
</pre>

Jedes FTUI-Element bekommt diese Attribute:

<pre>
<ftui-button hidden></ftui-button>
<ftui-button disabled></ftui-button>
<ftui-button readonly></ftui-button>
<ftui-button margin="1"></ftui-button>
<ftui-button padding="0.5"></ftui-button>
</pre>

==observedAttributes==

<pre>
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}
</pre>

Der Browser ruft `attributeChangedCallback()` nur für Attribute auf, die hier stehen.

Wichtig: Hier werden nur die Basiseigenschaften beobachtet. Abgeleitete Komponenten müssen wahrscheinlich selbst `observedAttributes` erweitern, sonst werden ihre eigenen Attribute nicht automatisch beobachtet.

==convertToAttributes==

<pre>
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}
</pre>

Hilfsfunktion, um Property-Namen in HTML-Attributnamen umzuwandeln.

Beispiel:

<pre>
baseWidth
</pre>

wird zu:

<pre>
base-width
</pre>

==connectedCallback==

<pre>
connectedCallback() {
this.updateProperties();
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}
</pre>

Diese Methode wird automatisch vom Browser aufgerufen, wenn das Element in die Seite eingefügt wird.

Ablauf:

1. Standardwerte werden verarbeitet.

2. Falls die konkrete Komponente `onConnected()` definiert, wird diese Hook-Funktion ausgeführt.

Beispiel in einer Kindklasse:

<pre>
onConnected() {
console.log('Button ist im DOM');
}
</pre>

==attributeChangedCallback==

<pre>
attributeChangedCallback(name, oldValue, newValue) {
</pre>

Wird aufgerufen, wenn ein beobachtetes Attribut geändert wird.

<pre>
log(3, `${this.id} - attributeChangedCallback ...`)
</pre>

Debug-Ausgabe.

<pre>
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}
</pre>

Hook für Kindklassen.

Danach behandelt die Basisklasse ihre Standardattribute:

#==hidden

<pre>
case 'hidden':
this.style.display = hasValue ? 'none' : '';
</pre>

Wenn `hidden` gesetzt ist, wird das Element ausgeblendet.

#==disabled

<pre>
case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Optisch ausgegraut und nicht anklickbar.

#==readonly

<pre>
case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Nicht bedienbar, aber ohne optischen Filter.

#==margin

<pre>
case 'margin':
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
</pre>

Wenn numerisch:

<pre>
margin="1"
</pre>

wird zu:

<pre>
margin: 1em;
</pre>

Wenn nicht numerisch:

<pre>
margin="10px"
</pre>

bleibt:

<pre>
margin: 10px;
</pre>

Für `FTUI-GRID` wird `margin` hier nicht gesetzt, vermutlich weil `ftui-grid` sein eigenes Margin-Verhalten hat.

#==padding

<pre>
case 'padding':
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
</pre>

Analog zu `margin`.

==submitChange==

<pre>
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}
</pre>

Das ist wichtig für FTUI-Bindings.

Wenn eine Komponente intern einen Wert ändert, etwa ein Button oder Slider, ruft sie:

<pre>
this.submitChange('value', newValue);
</pre>

Dann passiert:

1. Änderung wird als aktiv markiert.
2. Property wird gesetzt.
3. Ein Event `valueChange` wird ausgelöst.

Dieses Event kann FTUI dann nutzen, um per `(value)` oder `[(value)]` etwas an FHEM zu senden.

==emitChangeEvent und emitEvent==

<pre>
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}
</pre>

Aus `value` wird:

</pre>text
valueChange
</pre>

<pre>
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}
</pre>

Es wird ein normales DOM-Event ausgelöst.

Beispiel:

<pre>
this.emitChangeEvent('value', 'on');
</pre>

erzeugt:

<pre>
new CustomEvent('valueChange', { detail: 'on' })
</pre>

==initProperties==

<pre>
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
</pre>

Für jede Property wird automatisch ein passender Getter/Setter erzeugt.

Beispiel:

<pre>
hidden: false
</pre>

wird zu:

<pre>
element.hidden
</pre>

und HTML-Attribut:

<pre>
hidden
</pre>

#==Boolean

<pre>
if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);
}
</pre>

Boolean-Attribute funktionieren nach HTML-Logik:

<pre>
<ftui-button disabled></ftui-button>
</pre>

bedeutet `true`.

#==Number

<pre>
else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Wird beim Lesen in `Number(...)` umgewandelt.

#==String

<pre>
else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Normale String-Attribute.

==initAttribute==

<pre>
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}
</pre>

Wenn das Attribut noch nicht im HTML steht, wird der Default gesetzt.

Beispiel:

<pre>
padding: ''
</pre>

führt zu:

<pre>
padding=""
</pre>

==initBooleanAttribute==

<pre>
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}
</pre>

Boolean-Attribute werden nur gesetzt, wenn der Default `true` ist.

Da `hidden`, `disabled`, `readonly` alle `false` sind, werden sie standardmäßig nicht gesetzt.

==defineBooleanProperty==

<pre>
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
</pre>

Damit kann man schreiben:

<pre>
element.disabled = true;
</pre>

und bekommt im HTML:

<pre>
<ftui-button disabled></ftui-button>
</pre>

Bei:

<pre>
element.disabled = false;
</pre>

wird das Attribut entfernt.

Interessant:

<pre>
disabled="false"
</pre>

wird als `false` interpretiert. Das ist etwas komfortabler als natives HTML, wo ein vorhandenes Boolean-Attribut normalerweise immer wahr ist.

==defineNumberProperty==

<pre>
get() { return Number(this.getAttribute(attr)); },
set(value) { this.setAttribute(attr, value); },
</pre>

Beispiel:

<pre>
<ftui-grid-tile row="2"></ftui-grid-tile>
</pre>

<pre>
element.row
</pre>

liefert Zahl `2`.

==defineStringProperty==

<pre>
get() { return this.getAttribute(attr); },
set(value) { this.setAttribute(attr, value); },
</pre>

Normale Abbildung:

<pre>
element.text = 'Hallo';
</pre>

wird zu:

<pre>
text="Hallo"
</pre>

==updateProperties==

<pre>
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);
if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
})
}
</pre>

Beim Einfügen ins DOM werden Standardattribute nochmal verarbeitet.

Warum?
Wenn ein Attribut schon beim Erzeugen gesetzt wurde, kann es sein, dass die Style-Logik noch nicht gelaufen ist. `updateProperties()` erzwingt deshalb die Behandlung der Defaultwerte.

==Kommentierte Version==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';

// Zähler für automatisch erzeugte IDs pro Elementtyp
const uids = {};

// Basisklasse aller FTUI-Webcomponents
export class FtuiElement extends HTMLElement {

constructor(properties) {
super();

// Falls keine ID vorhanden ist, automatisch eine eindeutige ID erzeugen
if (!this.id) {
if (!uids[this.localName]) {
uids[this.localName] = 1;
}
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}

// Standardproperties der Basisklasse mit Komponentenproperties kombinieren
this.properties = Object.assign(FtuiElement.properties, properties);

// Für alle Properties Getter/Setter und Default-Attribute anlegen
this.initProperties(this.properties);

// Wenn die Komponente ein Template besitzt, Shadow DOM erzeugen
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}

// Merker für aktive Änderungen, wichtig für Output-/Two-Way-Bindings
this.isActiveChange = {};

// Element beim globalen FTUI-Binding-System anmelden
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
}

// Erzeugt Shadow DOM aus einem HTML-Template-String
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}

// Standardattribute, die jedes FTUI-Element besitzt
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}

// Attribute, bei deren Änderung attributeChangedCallback ausgelöst wird
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}

// Wandelt Property-Namen in HTML-Attributnamen um
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}

// Wird vom Browser aufgerufen, wenn das Element in den DOM eingefügt wurde
connectedCallback() {
this.updateProperties();

// Hook für abgeleitete Komponenten
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}

// Wird aufgerufen, wenn sich ein beobachtetes Attribut ändert
attributeChangedCallback(name, oldValue, newValue) {
log(3, `${this.id} - attributeChangedCallback name=${name}, oldValue=${oldValue}, newValue=${newValue}`);

// Hook für abgeleitete Komponenten
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}

const hasValue = newValue !== null && newValue !== false;

// Standardattribute behandeln
switch (name) {
case 'hidden':
this.style.display = hasValue ? 'none' : '';
break;

case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'margin': {
// ftui-grid behandelt margin selbst
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
break;
}

case 'padding': {
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
break;
}
}
}

// Wird von Komponenten genutzt, wenn ein Benutzerwert geändert wurde
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}

// Erzeugt z.B. valueChange aus value
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}

// Löst ein DOM CustomEvent aus
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}

// Initialisiert Properties abhängig vom Typ des Defaultwerts
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);

} else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);

} else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
});
}

// Setzt Default-Attribut, wenn es noch nicht existiert
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}

// Setzt Boolean-Attribut nur, wenn Default true ist
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}

// Definiert Boolean-Property mit HTML-Attribut-Synchronisierung
defineBooleanProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
}

// Definiert Number-Property
defineNumberProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return Number(this.getAttribute(attr));
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Definiert String-Property
defineStringProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.getAttribute(attr);
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Behandelt Defaultwerte beim Einfügen des Elements in den DOM
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
});
}
}
</pre>

==Mögliche Schwachstellen / Besonderheiten==

1. **`Object.assign(FtuiElement.properties, properties)` mutiert die statischen Basiseigenschaften.**
Sicherer wäre:

<pre>
this.properties = Object.assign({}, FtuiElement.properties, properties);
</pre>

2. **`observedAttributes` enthält nur Basiseigenschaften.**
Kindklassen müssen eigene Attribute selbst hinzufügen.

3. **Boolean-Erkennung `newValue !== false` ist etwas ungenau.**
Attribute liefern normalerweise Strings oder `null`, nicht echtes `false`. Bei `disabled="false"` funktioniert der Getter zwar korrekt, aber `attributeChangedCallback()` behandelt `"false"` trotzdem als vorhanden.

4. **`initAttribute()` setzt auch leere Default-Strings als Attribute.**
Dadurch entstehen Attribute wie:

<pre>
margin=""
padding=""
</pre>

Das ist nicht falsch, aber kann unnötige `attributeChangedCallback()`-Aufrufe erzeugen.

5. **`createShadowRoot()` nutzt `innerHTML`.**
Das ist normal für Templates, aber Template-Inhalte sollten kontrolliert sein.

==Merksatz==

Dieses Programm macht aus einer normalen Webcomponent eine **FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events**.

(FHEM) FTUI 3 Components

2026-04-26T15:42:37Z

Chris T. Ludwig: /* connectedCallback */

=element.components.js=

Deklaration der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`.

Sie kuemmert sich um:

* automatische IDs
* Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding`
* Verbindung zwischen Attributen und JavaScript-Properties
* Shadow DOM
* Change-Events für FTUI-Bindings
* Hooks für abgeleitete Komponenten

==Kurzueberblick==

<pre>
export class FtuiElement extends HTMLElement
</pre>

`FtuiElement` erweitert den nativen Browser-Typ `HTMLElement`. Dadurch wird daraus die gemeinsame Basis für eigene HTML-Tags wie:

<pre>
<ftui-button></ftui-button>
<ftui-label></ftui-label>
</pre>

==Import==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';
</pre>

Es werden drei Hilfsfunktionen verwendet:
* isNumeric() prüft, ob ein Wert numerisch ist
* toKebabCase() wandelt z.B. "baseWidth" in "base-width"
* log() schreibt Debug-Ausgaben

==UID-Zähler==

<pre>
const uids = {};
</pre>

Damit bekommt jedes FTUI-Element automatisch eine ID, falls keine gesetzt wurde.

Beispiel:

<pre>
<ftui-label></ftui-label>
</pre>

wird intern etwa zu:

<pre>
<ftui-label id="ftui_label_1"></ftui-label>
</pre>

==Constructor==

<pre>
constructor(properties) {
super();
</pre>

`super()` ruft den Konstruktor von `HTMLElement` auf. Das ist bei Webcomponents Pflicht.

<pre>
if (!this.id) {
...
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}
</pre>

Falls das Element keine ID hat, wird automatisch eine erzeugt.

<pre>
this.properties = Object.assign(FtuiElement.properties, properties);
</pre>

Hier werden die Standard-Properties der Basisklasse mit den Properties der konkreten Komponente gemischt.

Beispiel:

<pre>
FtuiElement.properties = {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: ''
}
</pre>

Ein `ftui-button` könnte zusätzlich `value`, `color`, `fill` usw. definieren.

Achtung: `Object.assign(FtuiElement.properties, properties)` verändert das Objekt `FtuiElement.properties`. Sauberer wäre oft:

<pre>
Object.assign({}, FtuiElement.properties, properties)
</pre>

Sonst können Properties versehentlich global vermischt werden.

<pre>
this.initProperties(this.properties);
</pre>

Erzeugt für jede Property Getter/Setter und initialisiert die passenden HTML-Attribute.

<pre>
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}
</pre>

Wenn die konkrete Komponente eine Methode `template()` besitzt, wird daraus ein Shadow DOM erzeugt.

<pre>
this.isActiveChange = {};
</pre>

Merker für aktive Änderungen, wichtig für Two-Way-Binding.

<pre>
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
</pre>

Wenn die FTUI-App bereits existiert, wird das Element mit dem FTUI-Binding-System verbunden.

==Shadow DOM==

<pre>
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}
</pre>

Diese Methode baut das interne DOM der Komponente.

Beispiel:

<pre>
template() {
return `<button><slot></slot></button>`;
}
</pre>

wird zu einem Shadow DOM innerhalb des Elements.

`mode: 'open'` bedeutet: Man kann von außen per JavaScript darauf zugreifen:

<pre>
element.shadowRoot
</pre>

==Standard-Properties==

<pre>
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}
</pre>

Jedes FTUI-Element bekommt diese Attribute:

<pre>
<ftui-button hidden></ftui-button>
<ftui-button disabled></ftui-button>
<ftui-button readonly></ftui-button>
<ftui-button margin="1"></ftui-button>
<ftui-button padding="0.5"></ftui-button>
</pre>

==observedAttributes==

<pre>
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}
</pre>

Der Browser ruft `attributeChangedCallback()` nur für Attribute auf, die hier stehen.

Wichtig: Hier werden nur die Basiseigenschaften beobachtet. Abgeleitete Komponenten müssen wahrscheinlich selbst `observedAttributes` erweitern, sonst werden ihre eigenen Attribute nicht automatisch beobachtet.

==convertToAttributes==

<pre>
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}
</pre>

Hilfsfunktion, um Property-Namen in HTML-Attributnamen umzuwandeln.

Beispiel:

<pre>
baseWidth
</pre>

wird zu:

<pre>
base-width
</pre>

==connectedCallback==

<pre>
connectedCallback() {
this.updateProperties();
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}
</pre>

Diese Methode wird automatisch vom Browser aufgerufen, wenn das Element in die Seite eingefügt wird.

Ablauf:

1. Standardwerte werden verarbeitet.

2. Falls die konkrete Komponente `onConnected()` definiert, wird diese Hook-Funktion ausgeführt.

Beispiel in einer Kindklasse:

<pre>
onConnected() {
console.log('Button ist im DOM');
}
</pre>

==attributeChangedCallback==

<pre>
attributeChangedCallback(name, oldValue, newValue) {
</pre>

Wird aufgerufen, wenn ein beobachtetes Attribut geändert wird.

<pre>
log(3, `${this.id} - attributeChangedCallback ...`)
</pre>

Debug-Ausgabe.

<pre>
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}
</pre>

Hook für Kindklassen.

Danach behandelt die Basisklasse ihre Standardattribute:

#==hidden

<pre>
case 'hidden':
this.style.display = hasValue ? 'none' : '';
</pre>

Wenn `hidden` gesetzt ist, wird das Element ausgeblendet.

#==disabled

<pre>
case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Optisch ausgegraut und nicht anklickbar.

#==readonly

<pre>
case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Nicht bedienbar, aber ohne optischen Filter.

#==margin

<pre>
case 'margin':
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
</pre>

Wenn numerisch:

<pre>
margin="1"
</pre>

wird zu:

<pre>
margin: 1em;
</pre>

Wenn nicht numerisch:

<pre>
margin="10px"
</pre>

bleibt:

<pre>
margin: 10px;
</pre>

Für `FTUI-GRID` wird `margin` hier nicht gesetzt, vermutlich weil `ftui-grid` sein eigenes Margin-Verhalten hat.

#==padding

<pre>
case 'padding':
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
</pre>

Analog zu `margin`.

==submitChange==

<pre>
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}
</pre>

Das ist wichtig für FTUI-Bindings.

Wenn eine Komponente intern einen Wert ändert, etwa ein Button oder Slider, ruft sie:

<pre>
this.submitChange('value', newValue);
</pre>

Dann passiert:

1. Änderung wird als aktiv markiert.
2. Property wird gesetzt.
3. Ein Event `valueChange` wird ausgelöst.

Dieses Event kann FTUI dann nutzen, um per `(value)` oder `[(value)]` etwas an FHEM zu senden.

==emitChangeEvent und emitEvent==

<pre>
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}
</pre>

Aus `value` wird:

</pre>text
valueChange
</pre>

<pre>
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}
</pre>

Es wird ein normales DOM-Event ausgelöst.

Beispiel:

<pre>
this.emitChangeEvent('value', 'on');
</pre>

erzeugt:

<pre>
new CustomEvent('valueChange', { detail: 'on' })
</pre>

==initProperties==

<pre>
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
</pre>

Für jede Property wird automatisch ein passender Getter/Setter erzeugt.

Beispiel:

<pre>
hidden: false
</pre>

wird zu:

<pre>
element.hidden
</pre>

und HTML-Attribut:

<pre>
hidden
</pre>

#==Boolean

<pre>
if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);
}
</pre>

Boolean-Attribute funktionieren nach HTML-Logik:

<pre>
<ftui-button disabled></ftui-button>
</pre>

bedeutet `true`.

#==Number

<pre>
else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Wird beim Lesen in `Number(...)` umgewandelt.

#==String

<pre>
else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Normale String-Attribute.

==initAttribute==

<pre>
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}
</pre>

Wenn das Attribut noch nicht im HTML steht, wird der Default gesetzt.

Beispiel:

<pre>
padding: ''
</pre>

führt zu:

<pre>
padding=""
</pre>

==initBooleanAttribute==

<pre>
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}
</pre>

Boolean-Attribute werden nur gesetzt, wenn der Default `true` ist.

Da `hidden`, `disabled`, `readonly` alle `false` sind, werden sie standardmäßig nicht gesetzt.

==defineBooleanProperty

<pre>
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
</pre>

Damit kann man schreiben:

<pre>
element.disabled = true;
</pre>

und bekommt im HTML:

<pre>
<ftui-button disabled></ftui-button>
</pre>

Bei:

<pre>
element.disabled = false;
</pre>

wird das Attribut entfernt.

Interessant:

<pre>
disabled="false"
</pre>

wird als `false` interpretiert. Das ist etwas komfortabler als natives HTML, wo ein vorhandenes Boolean-Attribut normalerweise immer wahr ist.

==defineNumberProperty

<pre>
get() { return Number(this.getAttribute(attr)); },
set(value) { this.setAttribute(attr, value); },
</pre>

Beispiel:

<pre>
<ftui-grid-tile row="2"></ftui-grid-tile>
</pre>

<pre>
element.row
</pre>

liefert Zahl `2`.

==defineStringProperty

<pre>
get() { return this.getAttribute(attr); },
set(value) { this.setAttribute(attr, value); },
</pre>

Normale Abbildung:

<pre>
element.text = 'Hallo';
</pre>

wird zu:

<pre>
text="Hallo"
</pre>

==updateProperties

<pre>
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);
if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
})
}
</pre>

Beim Einfügen ins DOM werden Standardattribute nochmal verarbeitet.

Warum?
Wenn ein Attribut schon beim Erzeugen gesetzt wurde, kann es sein, dass die Style-Logik noch nicht gelaufen ist. `updateProperties()` erzwingt deshalb die Behandlung der Defaultwerte.

==Kommentierte Version==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';

// Zähler für automatisch erzeugte IDs pro Elementtyp
const uids = {};

// Basisklasse aller FTUI-Webcomponents
export class FtuiElement extends HTMLElement {

constructor(properties) {
super();

// Falls keine ID vorhanden ist, automatisch eine eindeutige ID erzeugen
if (!this.id) {
if (!uids[this.localName]) {
uids[this.localName] = 1;
}
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}

// Standardproperties der Basisklasse mit Komponentenproperties kombinieren
this.properties = Object.assign(FtuiElement.properties, properties);

// Für alle Properties Getter/Setter und Default-Attribute anlegen
this.initProperties(this.properties);

// Wenn die Komponente ein Template besitzt, Shadow DOM erzeugen
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}

// Merker für aktive Änderungen, wichtig für Output-/Two-Way-Bindings
this.isActiveChange = {};

// Element beim globalen FTUI-Binding-System anmelden
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
}

// Erzeugt Shadow DOM aus einem HTML-Template-String
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}

// Standardattribute, die jedes FTUI-Element besitzt
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}

// Attribute, bei deren Änderung attributeChangedCallback ausgelöst wird
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}

// Wandelt Property-Namen in HTML-Attributnamen um
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}

// Wird vom Browser aufgerufen, wenn das Element in den DOM eingefügt wurde
connectedCallback() {
this.updateProperties();

// Hook für abgeleitete Komponenten
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}

// Wird aufgerufen, wenn sich ein beobachtetes Attribut ändert
attributeChangedCallback(name, oldValue, newValue) {
log(3, `${this.id} - attributeChangedCallback name=${name}, oldValue=${oldValue}, newValue=${newValue}`);

// Hook für abgeleitete Komponenten
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}

const hasValue = newValue !== null && newValue !== false;

// Standardattribute behandeln
switch (name) {
case 'hidden':
this.style.display = hasValue ? 'none' : '';
break;

case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'margin': {
// ftui-grid behandelt margin selbst
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
break;
}

case 'padding': {
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
break;
}
}
}

// Wird von Komponenten genutzt, wenn ein Benutzerwert geändert wurde
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}

// Erzeugt z.B. valueChange aus value
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}

// Löst ein DOM CustomEvent aus
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}

// Initialisiert Properties abhängig vom Typ des Defaultwerts
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);

} else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);

} else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
});
}

// Setzt Default-Attribut, wenn es noch nicht existiert
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}

// Setzt Boolean-Attribut nur, wenn Default true ist
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}

// Definiert Boolean-Property mit HTML-Attribut-Synchronisierung
defineBooleanProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
}

// Definiert Number-Property
defineNumberProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return Number(this.getAttribute(attr));
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Definiert String-Property
defineStringProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.getAttribute(attr);
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Behandelt Defaultwerte beim Einfügen des Elements in den DOM
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
});
}
}
</pre>

==Mögliche Schwachstellen / Besonderheiten==

1. **`Object.assign(FtuiElement.properties, properties)` mutiert die statischen Basiseigenschaften.**
Sicherer wäre:

<pre>
this.properties = Object.assign({}, FtuiElement.properties, properties);
</pre>

2. **`observedAttributes` enthält nur Basiseigenschaften.**
Kindklassen müssen eigene Attribute selbst hinzufügen.

3. **Boolean-Erkennung `newValue !== false` ist etwas ungenau.**
Attribute liefern normalerweise Strings oder `null`, nicht echtes `false`. Bei `disabled="false"` funktioniert der Getter zwar korrekt, aber `attributeChangedCallback()` behandelt `"false"` trotzdem als vorhanden.

4. **`initAttribute()` setzt auch leere Default-Strings als Attribute.**
Dadurch entstehen Attribute wie:

<pre>
margin=""
padding=""
</pre>

Das ist nicht falsch, aber kann unnötige `attributeChangedCallback()`-Aufrufe erzeugen.

5. **`createShadowRoot()` nutzt `innerHTML`.**
Das ist normal für Templates, aber Template-Inhalte sollten kontrolliert sein.

==Merksatz==

Dieses Programm macht aus einer normalen Webcomponent eine **FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events**.

(FHEM) FTUI 3 Components

2026-04-26T15:39:41Z

Chris T. Ludwig: /* observedAttributes */

=element.components.js=

Deklaration der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`.

Sie kuemmert sich um:

* automatische IDs
* Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding`
* Verbindung zwischen Attributen und JavaScript-Properties
* Shadow DOM
* Change-Events für FTUI-Bindings
* Hooks für abgeleitete Komponenten

==Kurzueberblick==

<pre>
export class FtuiElement extends HTMLElement
</pre>

`FtuiElement` erweitert den nativen Browser-Typ `HTMLElement`. Dadurch wird daraus die gemeinsame Basis für eigene HTML-Tags wie:

<pre>
<ftui-button></ftui-button>
<ftui-label></ftui-label>
</pre>

==Import==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';
</pre>

Es werden drei Hilfsfunktionen verwendet:
* isNumeric() prüft, ob ein Wert numerisch ist
* toKebabCase() wandelt z.B. "baseWidth" in "base-width"
* log() schreibt Debug-Ausgaben

==UID-Zähler==

<pre>
const uids = {};
</pre>

Damit bekommt jedes FTUI-Element automatisch eine ID, falls keine gesetzt wurde.

Beispiel:

<pre>
<ftui-label></ftui-label>
</pre>

wird intern etwa zu:

<pre>
<ftui-label id="ftui_label_1"></ftui-label>
</pre>

==Constructor==

<pre>
constructor(properties) {
super();
</pre>

`super()` ruft den Konstruktor von `HTMLElement` auf. Das ist bei Webcomponents Pflicht.

<pre>
if (!this.id) {
...
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}
</pre>

Falls das Element keine ID hat, wird automatisch eine erzeugt.

<pre>
this.properties = Object.assign(FtuiElement.properties, properties);
</pre>

Hier werden die Standard-Properties der Basisklasse mit den Properties der konkreten Komponente gemischt.

Beispiel:

<pre>
FtuiElement.properties = {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: ''
}
</pre>

Ein `ftui-button` könnte zusätzlich `value`, `color`, `fill` usw. definieren.

Achtung: `Object.assign(FtuiElement.properties, properties)` verändert das Objekt `FtuiElement.properties`. Sauberer wäre oft:

<pre>
Object.assign({}, FtuiElement.properties, properties)
</pre>

Sonst können Properties versehentlich global vermischt werden.

<pre>
this.initProperties(this.properties);
</pre>

Erzeugt für jede Property Getter/Setter und initialisiert die passenden HTML-Attribute.

<pre>
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}
</pre>

Wenn die konkrete Komponente eine Methode `template()` besitzt, wird daraus ein Shadow DOM erzeugt.

<pre>
this.isActiveChange = {};
</pre>

Merker für aktive Änderungen, wichtig für Two-Way-Binding.

<pre>
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
</pre>

Wenn die FTUI-App bereits existiert, wird das Element mit dem FTUI-Binding-System verbunden.

==Shadow DOM==

<pre>
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}
</pre>

Diese Methode baut das interne DOM der Komponente.

Beispiel:

<pre>
template() {
return `<button><slot></slot></button>`;
}
</pre>

wird zu einem Shadow DOM innerhalb des Elements.

`mode: 'open'` bedeutet: Man kann von außen per JavaScript darauf zugreifen:

<pre>
element.shadowRoot
</pre>

==Standard-Properties==

<pre>
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}
</pre>

Jedes FTUI-Element bekommt diese Attribute:

<pre>
<ftui-button hidden></ftui-button>
<ftui-button disabled></ftui-button>
<ftui-button readonly></ftui-button>
<ftui-button margin="1"></ftui-button>
<ftui-button padding="0.5"></ftui-button>
</pre>

==observedAttributes==

<pre>
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}
</pre>

Der Browser ruft `attributeChangedCallback()` nur für Attribute auf, die hier stehen.

Wichtig: Hier werden nur die Basiseigenschaften beobachtet. Abgeleitete Komponenten müssen wahrscheinlich selbst `observedAttributes` erweitern, sonst werden ihre eigenen Attribute nicht automatisch beobachtet.

==convertToAttributes==

<pre>
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}
</pre>

Hilfsfunktion, um Property-Namen in HTML-Attributnamen umzuwandeln.

Beispiel:

<pre>
baseWidth
</pre>

wird zu:

<pre>
base-width
</pre>

==connectedCallback==

<pre>
connectedCallback() {
this.updateProperties();
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}
</pre>

Diese Methode wird automatisch vom Browser aufgerufen, wenn das Element in die Seite eingefügt wird.

Ablauf:

1. Standardwerte werden verarbeitet.
2. Falls die konkrete Komponente `onConnected()` definiert, wird diese Hook-Funktion ausgeführt.

Beispiel in einer Kindklasse:

<pre>
onConnected() {
console.log('Button ist im DOM');
}
</pre>

==attributeChangedCallback

<pre>
attributeChangedCallback(name, oldValue, newValue) {
</pre>

Wird aufgerufen, wenn ein beobachtetes Attribut geändert wird.

<pre>
log(3, `${this.id} - attributeChangedCallback ...`)
</pre>

Debug-Ausgabe.

<pre>
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}
</pre>

Hook für Kindklassen.

Danach behandelt die Basisklasse ihre Standardattribute:

#==hidden

<pre>
case 'hidden':
this.style.display = hasValue ? 'none' : '';
</pre>

Wenn `hidden` gesetzt ist, wird das Element ausgeblendet.

#==disabled

<pre>
case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Optisch ausgegraut und nicht anklickbar.

#==readonly

<pre>
case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Nicht bedienbar, aber ohne optischen Filter.

#==margin

<pre>
case 'margin':
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
</pre>

Wenn numerisch:

<pre>
margin="1"
</pre>

wird zu:

<pre>
margin: 1em;
</pre>

Wenn nicht numerisch:

<pre>
margin="10px"
</pre>

bleibt:

<pre>
margin: 10px;
</pre>

Für `FTUI-GRID` wird `margin` hier nicht gesetzt, vermutlich weil `ftui-grid` sein eigenes Margin-Verhalten hat.

#==padding

<pre>
case 'padding':
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
</pre>

Analog zu `margin`.

==submitChange==

<pre>
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}
</pre>

Das ist wichtig für FTUI-Bindings.

Wenn eine Komponente intern einen Wert ändert, etwa ein Button oder Slider, ruft sie:

<pre>
this.submitChange('value', newValue);
</pre>

Dann passiert:

1. Änderung wird als aktiv markiert.
2. Property wird gesetzt.
3. Ein Event `valueChange` wird ausgelöst.

Dieses Event kann FTUI dann nutzen, um per `(value)` oder `[(value)]` etwas an FHEM zu senden.

==emitChangeEvent und emitEvent==

<pre>
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}
</pre>

Aus `value` wird:

</pre>text
valueChange
</pre>

<pre>
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}
</pre>

Es wird ein normales DOM-Event ausgelöst.

Beispiel:

<pre>
this.emitChangeEvent('value', 'on');
</pre>

erzeugt:

<pre>
new CustomEvent('valueChange', { detail: 'on' })
</pre>

==initProperties==

<pre>
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
</pre>

Für jede Property wird automatisch ein passender Getter/Setter erzeugt.

Beispiel:

<pre>
hidden: false
</pre>

wird zu:

<pre>
element.hidden
</pre>

und HTML-Attribut:

<pre>
hidden
</pre>

#==Boolean

<pre>
if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);
}
</pre>

Boolean-Attribute funktionieren nach HTML-Logik:

<pre>
<ftui-button disabled></ftui-button>
</pre>

bedeutet `true`.

#==Number

<pre>
else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Wird beim Lesen in `Number(...)` umgewandelt.

#==String

<pre>
else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Normale String-Attribute.

==initAttribute==

<pre>
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}
</pre>

Wenn das Attribut noch nicht im HTML steht, wird der Default gesetzt.

Beispiel:

<pre>
padding: ''
</pre>

führt zu:

<pre>
padding=""
</pre>

==initBooleanAttribute==

<pre>
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}
</pre>

Boolean-Attribute werden nur gesetzt, wenn der Default `true` ist.

Da `hidden`, `disabled`, `readonly` alle `false` sind, werden sie standardmäßig nicht gesetzt.

==defineBooleanProperty

<pre>
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
</pre>

Damit kann man schreiben:

<pre>
element.disabled = true;
</pre>

und bekommt im HTML:

<pre>
<ftui-button disabled></ftui-button>
</pre>

Bei:

<pre>
element.disabled = false;
</pre>

wird das Attribut entfernt.

Interessant:

<pre>
disabled="false"
</pre>

wird als `false` interpretiert. Das ist etwas komfortabler als natives HTML, wo ein vorhandenes Boolean-Attribut normalerweise immer wahr ist.

==defineNumberProperty

<pre>
get() { return Number(this.getAttribute(attr)); },
set(value) { this.setAttribute(attr, value); },
</pre>

Beispiel:

<pre>
<ftui-grid-tile row="2"></ftui-grid-tile>
</pre>

<pre>
element.row
</pre>

liefert Zahl `2`.

==defineStringProperty

<pre>
get() { return this.getAttribute(attr); },
set(value) { this.setAttribute(attr, value); },
</pre>

Normale Abbildung:

<pre>
element.text = 'Hallo';
</pre>

wird zu:

<pre>
text="Hallo"
</pre>

==updateProperties

<pre>
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);
if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
})
}
</pre>

Beim Einfügen ins DOM werden Standardattribute nochmal verarbeitet.

Warum?
Wenn ein Attribut schon beim Erzeugen gesetzt wurde, kann es sein, dass die Style-Logik noch nicht gelaufen ist. `updateProperties()` erzwingt deshalb die Behandlung der Defaultwerte.

==Kommentierte Version==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';

// Zähler für automatisch erzeugte IDs pro Elementtyp
const uids = {};

// Basisklasse aller FTUI-Webcomponents
export class FtuiElement extends HTMLElement {

constructor(properties) {
super();

// Falls keine ID vorhanden ist, automatisch eine eindeutige ID erzeugen
if (!this.id) {
if (!uids[this.localName]) {
uids[this.localName] = 1;
}
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}

// Standardproperties der Basisklasse mit Komponentenproperties kombinieren
this.properties = Object.assign(FtuiElement.properties, properties);

// Für alle Properties Getter/Setter und Default-Attribute anlegen
this.initProperties(this.properties);

// Wenn die Komponente ein Template besitzt, Shadow DOM erzeugen
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}

// Merker für aktive Änderungen, wichtig für Output-/Two-Way-Bindings
this.isActiveChange = {};

// Element beim globalen FTUI-Binding-System anmelden
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
}

// Erzeugt Shadow DOM aus einem HTML-Template-String
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}

// Standardattribute, die jedes FTUI-Element besitzt
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}

// Attribute, bei deren Änderung attributeChangedCallback ausgelöst wird
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}

// Wandelt Property-Namen in HTML-Attributnamen um
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}

// Wird vom Browser aufgerufen, wenn das Element in den DOM eingefügt wurde
connectedCallback() {
this.updateProperties();

// Hook für abgeleitete Komponenten
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}

// Wird aufgerufen, wenn sich ein beobachtetes Attribut ändert
attributeChangedCallback(name, oldValue, newValue) {
log(3, `${this.id} - attributeChangedCallback name=${name}, oldValue=${oldValue}, newValue=${newValue}`);

// Hook für abgeleitete Komponenten
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}

const hasValue = newValue !== null && newValue !== false;

// Standardattribute behandeln
switch (name) {
case 'hidden':
this.style.display = hasValue ? 'none' : '';
break;

case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'margin': {
// ftui-grid behandelt margin selbst
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
break;
}

case 'padding': {
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
break;
}
}
}

// Wird von Komponenten genutzt, wenn ein Benutzerwert geändert wurde
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}

// Erzeugt z.B. valueChange aus value
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}

// Löst ein DOM CustomEvent aus
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}

// Initialisiert Properties abhängig vom Typ des Defaultwerts
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);

} else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);

} else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
});
}

// Setzt Default-Attribut, wenn es noch nicht existiert
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}

// Setzt Boolean-Attribut nur, wenn Default true ist
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}

// Definiert Boolean-Property mit HTML-Attribut-Synchronisierung
defineBooleanProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
}

// Definiert Number-Property
defineNumberProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return Number(this.getAttribute(attr));
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Definiert String-Property
defineStringProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.getAttribute(attr);
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Behandelt Defaultwerte beim Einfügen des Elements in den DOM
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
});
}
}
</pre>

==Mögliche Schwachstellen / Besonderheiten==

1. **`Object.assign(FtuiElement.properties, properties)` mutiert die statischen Basiseigenschaften.**
Sicherer wäre:

<pre>
this.properties = Object.assign({}, FtuiElement.properties, properties);
</pre>

2. **`observedAttributes` enthält nur Basiseigenschaften.**
Kindklassen müssen eigene Attribute selbst hinzufügen.

3. **Boolean-Erkennung `newValue !== false` ist etwas ungenau.**
Attribute liefern normalerweise Strings oder `null`, nicht echtes `false`. Bei `disabled="false"` funktioniert der Getter zwar korrekt, aber `attributeChangedCallback()` behandelt `"false"` trotzdem als vorhanden.

4. **`initAttribute()` setzt auch leere Default-Strings als Attribute.**
Dadurch entstehen Attribute wie:

<pre>
margin=""
padding=""
</pre>

Das ist nicht falsch, aber kann unnötige `attributeChangedCallback()`-Aufrufe erzeugen.

5. **`createShadowRoot()` nutzt `innerHTML`.**
Das ist normal für Templates, aber Template-Inhalte sollten kontrolliert sein.

==Merksatz==

Dieses Programm macht aus einer normalen Webcomponent eine **FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events**.

(FHEM) FTUI 3 Components

2026-04-26T15:34:35Z

Chris T. Ludwig: /* Import */

=element.components.js=

Deklaration der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`.

Sie kuemmert sich um:

* automatische IDs
* Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding`
* Verbindung zwischen Attributen und JavaScript-Properties
* Shadow DOM
* Change-Events für FTUI-Bindings
* Hooks für abgeleitete Komponenten

==Kurzueberblick==

<pre>
export class FtuiElement extends HTMLElement
</pre>

`FtuiElement` erweitert den nativen Browser-Typ `HTMLElement`. Dadurch wird daraus die gemeinsame Basis für eigene HTML-Tags wie:

<pre>
<ftui-button></ftui-button>
<ftui-label></ftui-label>
</pre>

==Import==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';
</pre>

Es werden drei Hilfsfunktionen verwendet:
* isNumeric() prüft, ob ein Wert numerisch ist
* toKebabCase() wandelt z.B. "baseWidth" in "base-width"
* log() schreibt Debug-Ausgaben

==UID-Zähler==

<pre>
const uids = {};
</pre>

Damit bekommt jedes FTUI-Element automatisch eine ID, falls keine gesetzt wurde.

Beispiel:

<pre>
<ftui-label></ftui-label>
</pre>

wird intern etwa zu:

<pre>
<ftui-label id="ftui_label_1"></ftui-label>
</pre>

==Constructor==

<pre>
constructor(properties) {
super();
</pre>

`super()` ruft den Konstruktor von `HTMLElement` auf. Das ist bei Webcomponents Pflicht.

<pre>
if (!this.id) {
...
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}
</pre>

Falls das Element keine ID hat, wird automatisch eine erzeugt.

<pre>
this.properties = Object.assign(FtuiElement.properties, properties);
</pre>

Hier werden die Standard-Properties der Basisklasse mit den Properties der konkreten Komponente gemischt.

Beispiel:

<pre>
FtuiElement.properties = {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: ''
}
</pre>

Ein `ftui-button` könnte zusätzlich `value`, `color`, `fill` usw. definieren.

Achtung: `Object.assign(FtuiElement.properties, properties)` verändert das Objekt `FtuiElement.properties`. Sauberer wäre oft:

<pre>
Object.assign({}, FtuiElement.properties, properties)
</pre>

Sonst können Properties versehentlich global vermischt werden.

<pre>
this.initProperties(this.properties);
</pre>

Erzeugt für jede Property Getter/Setter und initialisiert die passenden HTML-Attribute.

<pre>
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}
</pre>

Wenn die konkrete Komponente eine Methode `template()` besitzt, wird daraus ein Shadow DOM erzeugt.

<pre>
this.isActiveChange = {};
</pre>

Merker für aktive Änderungen, wichtig für Two-Way-Binding.

<pre>
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
</pre>

Wenn die FTUI-App bereits existiert, wird das Element mit dem FTUI-Binding-System verbunden.

==Shadow DOM==

<pre>
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}
</pre>

Diese Methode baut das interne DOM der Komponente.

Beispiel:

<pre>
template() {
return `<button><slot></slot></button>`;
}
</pre>

wird zu einem Shadow DOM innerhalb des Elements.

`mode: 'open'` bedeutet: Man kann von außen per JavaScript darauf zugreifen:

<pre>
element.shadowRoot
</pre>

==Standard-Properties==

<pre>
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}
</pre>

Jedes FTUI-Element bekommt diese Attribute:

<pre>
<ftui-button hidden></ftui-button>
<ftui-button disabled></ftui-button>
<ftui-button readonly></ftui-button>
<ftui-button margin="1"></ftui-button>
<ftui-button padding="0.5"></ftui-button>
</pre>

==observedAttributes==

<pre>
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}
</pre>

Der Browser ruft `attributeChangedCallback()` nur für Attribute auf, die hier stehen.

Wichtig: Hier werden nur die Basiseigenschaften beobachtet. Abgeleitete Komponenten müssen wahrscheinlich selbst `observedAttributes` erweitern, sonst werden ihre eigenen Attribute nicht automatisch beobachtet.

==convertToAttributes

<pre>
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}
</pre>

Hilfsfunktion, um Property-Namen in HTML-Attributnamen umzuwandeln.

Beispiel:

<pre>
baseWidth
</pre>

wird zu:

<pre>
base-width
</pre>

==connectedCallback==

<pre>
connectedCallback() {
this.updateProperties();
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}
</pre>

Diese Methode wird automatisch vom Browser aufgerufen, wenn das Element in die Seite eingefügt wird.

Ablauf:

1. Standardwerte werden verarbeitet.
2. Falls die konkrete Komponente `onConnected()` definiert, wird diese Hook-Funktion ausgeführt.

Beispiel in einer Kindklasse:

<pre>
onConnected() {
console.log('Button ist im DOM');
}
</pre>

==attributeChangedCallback

<pre>
attributeChangedCallback(name, oldValue, newValue) {
</pre>

Wird aufgerufen, wenn ein beobachtetes Attribut geändert wird.

<pre>
log(3, `${this.id} - attributeChangedCallback ...`)
</pre>

Debug-Ausgabe.

<pre>
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}
</pre>

Hook für Kindklassen.

Danach behandelt die Basisklasse ihre Standardattribute:

#==hidden

<pre>
case 'hidden':
this.style.display = hasValue ? 'none' : '';
</pre>

Wenn `hidden` gesetzt ist, wird das Element ausgeblendet.

#==disabled

<pre>
case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Optisch ausgegraut und nicht anklickbar.

#==readonly

<pre>
case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Nicht bedienbar, aber ohne optischen Filter.

#==margin

<pre>
case 'margin':
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
</pre>

Wenn numerisch:

<pre>
margin="1"
</pre>

wird zu:

<pre>
margin: 1em;
</pre>

Wenn nicht numerisch:

<pre>
margin="10px"
</pre>

bleibt:

<pre>
margin: 10px;
</pre>

Für `FTUI-GRID` wird `margin` hier nicht gesetzt, vermutlich weil `ftui-grid` sein eigenes Margin-Verhalten hat.

#==padding

<pre>
case 'padding':
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
</pre>

Analog zu `margin`.

==submitChange==

<pre>
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}
</pre>

Das ist wichtig für FTUI-Bindings.

Wenn eine Komponente intern einen Wert ändert, etwa ein Button oder Slider, ruft sie:

<pre>
this.submitChange('value', newValue);
</pre>

Dann passiert:

1. Änderung wird als aktiv markiert.
2. Property wird gesetzt.
3. Ein Event `valueChange` wird ausgelöst.

Dieses Event kann FTUI dann nutzen, um per `(value)` oder `[(value)]` etwas an FHEM zu senden.

==emitChangeEvent und emitEvent==

<pre>
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}
</pre>

Aus `value` wird:

</pre>text
valueChange
</pre>

<pre>
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}
</pre>

Es wird ein normales DOM-Event ausgelöst.

Beispiel:

<pre>
this.emitChangeEvent('value', 'on');
</pre>

erzeugt:

<pre>
new CustomEvent('valueChange', { detail: 'on' })
</pre>

==initProperties==

<pre>
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
</pre>

Für jede Property wird automatisch ein passender Getter/Setter erzeugt.

Beispiel:

<pre>
hidden: false
</pre>

wird zu:

<pre>
element.hidden
</pre>

und HTML-Attribut:

<pre>
hidden
</pre>

#==Boolean

<pre>
if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);
}
</pre>

Boolean-Attribute funktionieren nach HTML-Logik:

<pre>
<ftui-button disabled></ftui-button>
</pre>

bedeutet `true`.

#==Number

<pre>
else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Wird beim Lesen in `Number(...)` umgewandelt.

#==String

<pre>
else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Normale String-Attribute.

==initAttribute==

<pre>
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}
</pre>

Wenn das Attribut noch nicht im HTML steht, wird der Default gesetzt.

Beispiel:

<pre>
padding: ''
</pre>

führt zu:

<pre>
padding=""
</pre>

==initBooleanAttribute==

<pre>
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}
</pre>

Boolean-Attribute werden nur gesetzt, wenn der Default `true` ist.

Da `hidden`, `disabled`, `readonly` alle `false` sind, werden sie standardmäßig nicht gesetzt.

==defineBooleanProperty

<pre>
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
</pre>

Damit kann man schreiben:

<pre>
element.disabled = true;
</pre>

und bekommt im HTML:

<pre>
<ftui-button disabled></ftui-button>
</pre>

Bei:

<pre>
element.disabled = false;
</pre>

wird das Attribut entfernt.

Interessant:

<pre>
disabled="false"
</pre>

wird als `false` interpretiert. Das ist etwas komfortabler als natives HTML, wo ein vorhandenes Boolean-Attribut normalerweise immer wahr ist.

==defineNumberProperty

<pre>
get() { return Number(this.getAttribute(attr)); },
set(value) { this.setAttribute(attr, value); },
</pre>

Beispiel:

<pre>
<ftui-grid-tile row="2"></ftui-grid-tile>
</pre>

<pre>
element.row
</pre>

liefert Zahl `2`.

==defineStringProperty

<pre>
get() { return this.getAttribute(attr); },
set(value) { this.setAttribute(attr, value); },
</pre>

Normale Abbildung:

<pre>
element.text = 'Hallo';
</pre>

wird zu:

<pre>
text="Hallo"
</pre>

==updateProperties

<pre>
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);
if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
})
}
</pre>

Beim Einfügen ins DOM werden Standardattribute nochmal verarbeitet.

Warum?
Wenn ein Attribut schon beim Erzeugen gesetzt wurde, kann es sein, dass die Style-Logik noch nicht gelaufen ist. `updateProperties()` erzwingt deshalb die Behandlung der Defaultwerte.

==Kommentierte Version==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';

// Zähler für automatisch erzeugte IDs pro Elementtyp
const uids = {};

// Basisklasse aller FTUI-Webcomponents
export class FtuiElement extends HTMLElement {

constructor(properties) {
super();

// Falls keine ID vorhanden ist, automatisch eine eindeutige ID erzeugen
if (!this.id) {
if (!uids[this.localName]) {
uids[this.localName] = 1;
}
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}

// Standardproperties der Basisklasse mit Komponentenproperties kombinieren
this.properties = Object.assign(FtuiElement.properties, properties);

// Für alle Properties Getter/Setter und Default-Attribute anlegen
this.initProperties(this.properties);

// Wenn die Komponente ein Template besitzt, Shadow DOM erzeugen
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}

// Merker für aktive Änderungen, wichtig für Output-/Two-Way-Bindings
this.isActiveChange = {};

// Element beim globalen FTUI-Binding-System anmelden
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
}

// Erzeugt Shadow DOM aus einem HTML-Template-String
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}

// Standardattribute, die jedes FTUI-Element besitzt
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}

// Attribute, bei deren Änderung attributeChangedCallback ausgelöst wird
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}

// Wandelt Property-Namen in HTML-Attributnamen um
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}

// Wird vom Browser aufgerufen, wenn das Element in den DOM eingefügt wurde
connectedCallback() {
this.updateProperties();

// Hook für abgeleitete Komponenten
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}

// Wird aufgerufen, wenn sich ein beobachtetes Attribut ändert
attributeChangedCallback(name, oldValue, newValue) {
log(3, `${this.id} - attributeChangedCallback name=${name}, oldValue=${oldValue}, newValue=${newValue}`);

// Hook für abgeleitete Komponenten
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}

const hasValue = newValue !== null && newValue !== false;

// Standardattribute behandeln
switch (name) {
case 'hidden':
this.style.display = hasValue ? 'none' : '';
break;

case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'margin': {
// ftui-grid behandelt margin selbst
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
break;
}

case 'padding': {
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
break;
}
}
}

// Wird von Komponenten genutzt, wenn ein Benutzerwert geändert wurde
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}

// Erzeugt z.B. valueChange aus value
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}

// Löst ein DOM CustomEvent aus
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}

// Initialisiert Properties abhängig vom Typ des Defaultwerts
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);

} else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);

} else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
});
}

// Setzt Default-Attribut, wenn es noch nicht existiert
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}

// Setzt Boolean-Attribut nur, wenn Default true ist
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}

// Definiert Boolean-Property mit HTML-Attribut-Synchronisierung
defineBooleanProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
}

// Definiert Number-Property
defineNumberProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return Number(this.getAttribute(attr));
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Definiert String-Property
defineStringProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.getAttribute(attr);
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Behandelt Defaultwerte beim Einfügen des Elements in den DOM
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
});
}
}
</pre>

==Mögliche Schwachstellen / Besonderheiten==

1. **`Object.assign(FtuiElement.properties, properties)` mutiert die statischen Basiseigenschaften.**
Sicherer wäre:

<pre>
this.properties = Object.assign({}, FtuiElement.properties, properties);
</pre>

2. **`observedAttributes` enthält nur Basiseigenschaften.**
Kindklassen müssen eigene Attribute selbst hinzufügen.

3. **Boolean-Erkennung `newValue !== false` ist etwas ungenau.**
Attribute liefern normalerweise Strings oder `null`, nicht echtes `false`. Bei `disabled="false"` funktioniert der Getter zwar korrekt, aber `attributeChangedCallback()` behandelt `"false"` trotzdem als vorhanden.

4. **`initAttribute()` setzt auch leere Default-Strings als Attribute.**
Dadurch entstehen Attribute wie:

<pre>
margin=""
padding=""
</pre>

Das ist nicht falsch, aber kann unnötige `attributeChangedCallback()`-Aufrufe erzeugen.

5. **`createShadowRoot()` nutzt `innerHTML`.**
Das ist normal für Templates, aber Template-Inhalte sollten kontrolliert sein.

==Merksatz==

Dieses Programm macht aus einer normalen Webcomponent eine **FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events**.

(FHEM) FTUI 3 Components

2026-04-26T15:33:56Z

Chris T. Ludwig: /* element.components.js */

=element.components.js=

Deklaration der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`.

Sie kuemmert sich um:

* automatische IDs
* Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding`
* Verbindung zwischen Attributen und JavaScript-Properties
* Shadow DOM
* Change-Events für FTUI-Bindings
* Hooks für abgeleitete Komponenten

==Kurzueberblick==

<pre>
export class FtuiElement extends HTMLElement
</pre>

`FtuiElement` erweitert den nativen Browser-Typ `HTMLElement`. Dadurch wird daraus die gemeinsame Basis für eigene HTML-Tags wie:

<pre>
<ftui-button></ftui-button>
<ftui-label></ftui-label>
</pre>

==Import==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';
</pre>

Es werden drei Hilfsfunktionen verwendet:

</pre>text
isNumeric() prüft, ob ein Wert numerisch ist
toKebabCase() wandelt z.B. "baseWidth" in "base-width"
log() schreibt Debug-Ausgaben
</pre>

==UID-Zähler==

<pre>
const uids = {};
</pre>

Damit bekommt jedes FTUI-Element automatisch eine ID, falls keine gesetzt wurde.

Beispiel:

<pre>
<ftui-label></ftui-label>
</pre>

wird intern etwa zu:

<pre>
<ftui-label id="ftui_label_1"></ftui-label>
</pre>

==Constructor==

<pre>
constructor(properties) {
super();
</pre>

`super()` ruft den Konstruktor von `HTMLElement` auf. Das ist bei Webcomponents Pflicht.

<pre>
if (!this.id) {
...
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}
</pre>

Falls das Element keine ID hat, wird automatisch eine erzeugt.

<pre>
this.properties = Object.assign(FtuiElement.properties, properties);
</pre>

Hier werden die Standard-Properties der Basisklasse mit den Properties der konkreten Komponente gemischt.

Beispiel:

<pre>
FtuiElement.properties = {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: ''
}
</pre>

Ein `ftui-button` könnte zusätzlich `value`, `color`, `fill` usw. definieren.

Achtung: `Object.assign(FtuiElement.properties, properties)` verändert das Objekt `FtuiElement.properties`. Sauberer wäre oft:

<pre>
Object.assign({}, FtuiElement.properties, properties)
</pre>

Sonst können Properties versehentlich global vermischt werden.

<pre>
this.initProperties(this.properties);
</pre>

Erzeugt für jede Property Getter/Setter und initialisiert die passenden HTML-Attribute.

<pre>
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}
</pre>

Wenn die konkrete Komponente eine Methode `template()` besitzt, wird daraus ein Shadow DOM erzeugt.

<pre>
this.isActiveChange = {};
</pre>

Merker für aktive Änderungen, wichtig für Two-Way-Binding.

<pre>
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
</pre>

Wenn die FTUI-App bereits existiert, wird das Element mit dem FTUI-Binding-System verbunden.

==Shadow DOM==

<pre>
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}
</pre>

Diese Methode baut das interne DOM der Komponente.

Beispiel:

<pre>
template() {
return `<button><slot></slot></button>`;
}
</pre>

wird zu einem Shadow DOM innerhalb des Elements.

`mode: 'open'` bedeutet: Man kann von außen per JavaScript darauf zugreifen:

<pre>
element.shadowRoot
</pre>

==Standard-Properties==

<pre>
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}
</pre>

Jedes FTUI-Element bekommt diese Attribute:

<pre>
<ftui-button hidden></ftui-button>
<ftui-button disabled></ftui-button>
<ftui-button readonly></ftui-button>
<ftui-button margin="1"></ftui-button>
<ftui-button padding="0.5"></ftui-button>
</pre>

==observedAttributes==

<pre>
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}
</pre>

Der Browser ruft `attributeChangedCallback()` nur für Attribute auf, die hier stehen.

Wichtig: Hier werden nur die Basiseigenschaften beobachtet. Abgeleitete Komponenten müssen wahrscheinlich selbst `observedAttributes` erweitern, sonst werden ihre eigenen Attribute nicht automatisch beobachtet.

==convertToAttributes

<pre>
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}
</pre>

Hilfsfunktion, um Property-Namen in HTML-Attributnamen umzuwandeln.

Beispiel:

<pre>
baseWidth
</pre>

wird zu:

<pre>
base-width
</pre>

==connectedCallback==

<pre>
connectedCallback() {
this.updateProperties();
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}
</pre>

Diese Methode wird automatisch vom Browser aufgerufen, wenn das Element in die Seite eingefügt wird.

Ablauf:

1. Standardwerte werden verarbeitet.
2. Falls die konkrete Komponente `onConnected()` definiert, wird diese Hook-Funktion ausgeführt.

Beispiel in einer Kindklasse:

<pre>
onConnected() {
console.log('Button ist im DOM');
}
</pre>

==attributeChangedCallback

<pre>
attributeChangedCallback(name, oldValue, newValue) {
</pre>

Wird aufgerufen, wenn ein beobachtetes Attribut geändert wird.

<pre>
log(3, `${this.id} - attributeChangedCallback ...`)
</pre>

Debug-Ausgabe.

<pre>
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}
</pre>

Hook für Kindklassen.

Danach behandelt die Basisklasse ihre Standardattribute:

#==hidden

<pre>
case 'hidden':
this.style.display = hasValue ? 'none' : '';
</pre>

Wenn `hidden` gesetzt ist, wird das Element ausgeblendet.

#==disabled

<pre>
case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Optisch ausgegraut und nicht anklickbar.

#==readonly

<pre>
case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Nicht bedienbar, aber ohne optischen Filter.

#==margin

<pre>
case 'margin':
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
</pre>

Wenn numerisch:

<pre>
margin="1"
</pre>

wird zu:

<pre>
margin: 1em;
</pre>

Wenn nicht numerisch:

<pre>
margin="10px"
</pre>

bleibt:

<pre>
margin: 10px;
</pre>

Für `FTUI-GRID` wird `margin` hier nicht gesetzt, vermutlich weil `ftui-grid` sein eigenes Margin-Verhalten hat.

#==padding

<pre>
case 'padding':
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
</pre>

Analog zu `margin`.

==submitChange==

<pre>
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}
</pre>

Das ist wichtig für FTUI-Bindings.

Wenn eine Komponente intern einen Wert ändert, etwa ein Button oder Slider, ruft sie:

<pre>
this.submitChange('value', newValue);
</pre>

Dann passiert:

1. Änderung wird als aktiv markiert.
2. Property wird gesetzt.
3. Ein Event `valueChange` wird ausgelöst.

Dieses Event kann FTUI dann nutzen, um per `(value)` oder `[(value)]` etwas an FHEM zu senden.

==emitChangeEvent und emitEvent==

<pre>
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}
</pre>

Aus `value` wird:

</pre>text
valueChange
</pre>

<pre>
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}
</pre>

Es wird ein normales DOM-Event ausgelöst.

Beispiel:

<pre>
this.emitChangeEvent('value', 'on');
</pre>

erzeugt:

<pre>
new CustomEvent('valueChange', { detail: 'on' })
</pre>

==initProperties==

<pre>
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
</pre>

Für jede Property wird automatisch ein passender Getter/Setter erzeugt.

Beispiel:

<pre>
hidden: false
</pre>

wird zu:

<pre>
element.hidden
</pre>

und HTML-Attribut:

<pre>
hidden
</pre>

#==Boolean

<pre>
if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);
}
</pre>

Boolean-Attribute funktionieren nach HTML-Logik:

<pre>
<ftui-button disabled></ftui-button>
</pre>

bedeutet `true`.

#==Number

<pre>
else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Wird beim Lesen in `Number(...)` umgewandelt.

#==String

<pre>
else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Normale String-Attribute.

==initAttribute==

<pre>
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}
</pre>

Wenn das Attribut noch nicht im HTML steht, wird der Default gesetzt.

Beispiel:

<pre>
padding: ''
</pre>

führt zu:

<pre>
padding=""
</pre>

==initBooleanAttribute==

<pre>
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}
</pre>

Boolean-Attribute werden nur gesetzt, wenn der Default `true` ist.

Da `hidden`, `disabled`, `readonly` alle `false` sind, werden sie standardmäßig nicht gesetzt.

==defineBooleanProperty

<pre>
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
</pre>

Damit kann man schreiben:

<pre>
element.disabled = true;
</pre>

und bekommt im HTML:

<pre>
<ftui-button disabled></ftui-button>
</pre>

Bei:

<pre>
element.disabled = false;
</pre>

wird das Attribut entfernt.

Interessant:

<pre>
disabled="false"
</pre>

wird als `false` interpretiert. Das ist etwas komfortabler als natives HTML, wo ein vorhandenes Boolean-Attribut normalerweise immer wahr ist.

==defineNumberProperty

<pre>
get() { return Number(this.getAttribute(attr)); },
set(value) { this.setAttribute(attr, value); },
</pre>

Beispiel:

<pre>
<ftui-grid-tile row="2"></ftui-grid-tile>
</pre>

<pre>
element.row
</pre>

liefert Zahl `2`.

==defineStringProperty

<pre>
get() { return this.getAttribute(attr); },
set(value) { this.setAttribute(attr, value); },
</pre>

Normale Abbildung:

<pre>
element.text = 'Hallo';
</pre>

wird zu:

<pre>
text="Hallo"
</pre>

==updateProperties

<pre>
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);
if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
})
}
</pre>

Beim Einfügen ins DOM werden Standardattribute nochmal verarbeitet.

Warum?
Wenn ein Attribut schon beim Erzeugen gesetzt wurde, kann es sein, dass die Style-Logik noch nicht gelaufen ist. `updateProperties()` erzwingt deshalb die Behandlung der Defaultwerte.

==Kommentierte Version==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';

// Zähler für automatisch erzeugte IDs pro Elementtyp
const uids = {};

// Basisklasse aller FTUI-Webcomponents
export class FtuiElement extends HTMLElement {

constructor(properties) {
super();

// Falls keine ID vorhanden ist, automatisch eine eindeutige ID erzeugen
if (!this.id) {
if (!uids[this.localName]) {
uids[this.localName] = 1;
}
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}

// Standardproperties der Basisklasse mit Komponentenproperties kombinieren
this.properties = Object.assign(FtuiElement.properties, properties);

// Für alle Properties Getter/Setter und Default-Attribute anlegen
this.initProperties(this.properties);

// Wenn die Komponente ein Template besitzt, Shadow DOM erzeugen
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}

// Merker für aktive Änderungen, wichtig für Output-/Two-Way-Bindings
this.isActiveChange = {};

// Element beim globalen FTUI-Binding-System anmelden
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
}

// Erzeugt Shadow DOM aus einem HTML-Template-String
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}

// Standardattribute, die jedes FTUI-Element besitzt
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}

// Attribute, bei deren Änderung attributeChangedCallback ausgelöst wird
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}

// Wandelt Property-Namen in HTML-Attributnamen um
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}

// Wird vom Browser aufgerufen, wenn das Element in den DOM eingefügt wurde
connectedCallback() {
this.updateProperties();

// Hook für abgeleitete Komponenten
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}

// Wird aufgerufen, wenn sich ein beobachtetes Attribut ändert
attributeChangedCallback(name, oldValue, newValue) {
log(3, `${this.id} - attributeChangedCallback name=${name}, oldValue=${oldValue}, newValue=${newValue}`);

// Hook für abgeleitete Komponenten
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}

const hasValue = newValue !== null && newValue !== false;

// Standardattribute behandeln
switch (name) {
case 'hidden':
this.style.display = hasValue ? 'none' : '';
break;

case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'margin': {
// ftui-grid behandelt margin selbst
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
break;
}

case 'padding': {
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
break;
}
}
}

// Wird von Komponenten genutzt, wenn ein Benutzerwert geändert wurde
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}

// Erzeugt z.B. valueChange aus value
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}

// Löst ein DOM CustomEvent aus
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}

// Initialisiert Properties abhängig vom Typ des Defaultwerts
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);

} else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);

} else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
});
}

// Setzt Default-Attribut, wenn es noch nicht existiert
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}

// Setzt Boolean-Attribut nur, wenn Default true ist
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}

// Definiert Boolean-Property mit HTML-Attribut-Synchronisierung
defineBooleanProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
}

// Definiert Number-Property
defineNumberProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return Number(this.getAttribute(attr));
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Definiert String-Property
defineStringProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.getAttribute(attr);
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Behandelt Defaultwerte beim Einfügen des Elements in den DOM
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
});
}
}
</pre>

==Mögliche Schwachstellen / Besonderheiten==

1. **`Object.assign(FtuiElement.properties, properties)` mutiert die statischen Basiseigenschaften.**
Sicherer wäre:

<pre>
this.properties = Object.assign({}, FtuiElement.properties, properties);
</pre>

2. **`observedAttributes` enthält nur Basiseigenschaften.**
Kindklassen müssen eigene Attribute selbst hinzufügen.

3. **Boolean-Erkennung `newValue !== false` ist etwas ungenau.**
Attribute liefern normalerweise Strings oder `null`, nicht echtes `false`. Bei `disabled="false"` funktioniert der Getter zwar korrekt, aber `attributeChangedCallback()` behandelt `"false"` trotzdem als vorhanden.

4. **`initAttribute()` setzt auch leere Default-Strings als Attribute.**
Dadurch entstehen Attribute wie:

<pre>
margin=""
padding=""
</pre>

Das ist nicht falsch, aber kann unnötige `attributeChangedCallback()`-Aufrufe erzeugen.

5. **`createShadowRoot()` nutzt `innerHTML`.**
Das ist normal für Templates, aber Template-Inhalte sollten kontrolliert sein.

==Merksatz==

Dieses Programm macht aus einer normalen Webcomponent eine **FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events**.

(FHEM) FTUI 3 Components

2026-04-26T15:20:13Z

Chris T. Ludwig: Die Seite wurde neu angelegt: „=element.components.js= Definition der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`. Sie kuemmert sich um: * automatische IDs * Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding` * Verbindung zwischen Attributen und JavaScript-Properties * Shadow DOM * Change-Events für FTUI-Bindings * Hooks für abgeleitete Komponenten =…“

=element.components.js=

Definition der '''Basisklasse''' für alle FTUI-v3-Webcomponents. Jede Komponente wie `ftui-button`, `ftui-label`, `ftui-icon` usw. erbt vermutlich von `FtuiElement`.

Sie kuemmert sich um:

* automatische IDs
* Standardattribute wie `hidden`, `disabled`, `readonly`, `margin`, `padding`
* Verbindung zwischen Attributen und JavaScript-Properties
* Shadow DOM
* Change-Events für FTUI-Bindings
* Hooks für abgeleitete Komponenten

==Kurzueberblick==

<pre>
export class FtuiElement extends HTMLElement
</pre>

`FtuiElement` erweitert den nativen Browser-Typ `HTMLElement`. Dadurch wird daraus die gemeinsame Basis für eigene HTML-Tags wie:

<pre>
<ftui-button></ftui-button>
<ftui-label></ftui-label>
</pre>

==Import==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';
</pre>

Es werden drei Hilfsfunktionen verwendet:

</pre>text
isNumeric() prüft, ob ein Wert numerisch ist
toKebabCase() wandelt z.B. "baseWidth" in "base-width"
log() schreibt Debug-Ausgaben
</pre>

==UID-Zähler==

<pre>
const uids = {};
</pre>

Damit bekommt jedes FTUI-Element automatisch eine ID, falls keine gesetzt wurde.

Beispiel:

<pre>
<ftui-label></ftui-label>
</pre>

wird intern etwa zu:

<pre>
<ftui-label id="ftui_label_1"></ftui-label>
</pre>

==Constructor==

<pre>
constructor(properties) {
super();
</pre>

`super()` ruft den Konstruktor von `HTMLElement` auf. Das ist bei Webcomponents Pflicht.

<pre>
if (!this.id) {
...
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}
</pre>

Falls das Element keine ID hat, wird automatisch eine erzeugt.

<pre>
this.properties = Object.assign(FtuiElement.properties, properties);
</pre>

Hier werden die Standard-Properties der Basisklasse mit den Properties der konkreten Komponente gemischt.

Beispiel:

<pre>
FtuiElement.properties = {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: ''
}
</pre>

Ein `ftui-button` könnte zusätzlich `value`, `color`, `fill` usw. definieren.

Achtung: `Object.assign(FtuiElement.properties, properties)` verändert das Objekt `FtuiElement.properties`. Sauberer wäre oft:

<pre>
Object.assign({}, FtuiElement.properties, properties)
</pre>

Sonst können Properties versehentlich global vermischt werden.

<pre>
this.initProperties(this.properties);
</pre>

Erzeugt für jede Property Getter/Setter und initialisiert die passenden HTML-Attribute.

<pre>
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}
</pre>

Wenn die konkrete Komponente eine Methode `template()` besitzt, wird daraus ein Shadow DOM erzeugt.

<pre>
this.isActiveChange = {};
</pre>

Merker für aktive Änderungen, wichtig für Two-Way-Binding.

<pre>
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
</pre>

Wenn die FTUI-App bereits existiert, wird das Element mit dem FTUI-Binding-System verbunden.

==Shadow DOM==

<pre>
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}
</pre>

Diese Methode baut das interne DOM der Komponente.

Beispiel:

<pre>
template() {
return `<button><slot></slot></button>`;
}
</pre>

wird zu einem Shadow DOM innerhalb des Elements.

`mode: 'open'` bedeutet: Man kann von außen per JavaScript darauf zugreifen:

<pre>
element.shadowRoot
</pre>

==Standard-Properties==

<pre>
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}
</pre>

Jedes FTUI-Element bekommt diese Attribute:

<pre>
<ftui-button hidden></ftui-button>
<ftui-button disabled></ftui-button>
<ftui-button readonly></ftui-button>
<ftui-button margin="1"></ftui-button>
<ftui-button padding="0.5"></ftui-button>
</pre>

==observedAttributes==

<pre>
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}
</pre>

Der Browser ruft `attributeChangedCallback()` nur für Attribute auf, die hier stehen.

Wichtig: Hier werden nur die Basiseigenschaften beobachtet. Abgeleitete Komponenten müssen wahrscheinlich selbst `observedAttributes` erweitern, sonst werden ihre eigenen Attribute nicht automatisch beobachtet.

==convertToAttributes

<pre>
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}
</pre>

Hilfsfunktion, um Property-Namen in HTML-Attributnamen umzuwandeln.

Beispiel:

<pre>
baseWidth
</pre>

wird zu:

<pre>
base-width
</pre>

==connectedCallback==

<pre>
connectedCallback() {
this.updateProperties();
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}
</pre>

Diese Methode wird automatisch vom Browser aufgerufen, wenn das Element in die Seite eingefügt wird.

Ablauf:

1. Standardwerte werden verarbeitet.
2. Falls die konkrete Komponente `onConnected()` definiert, wird diese Hook-Funktion ausgeführt.

Beispiel in einer Kindklasse:

<pre>
onConnected() {
console.log('Button ist im DOM');
}
</pre>

==attributeChangedCallback

<pre>
attributeChangedCallback(name, oldValue, newValue) {
</pre>

Wird aufgerufen, wenn ein beobachtetes Attribut geändert wird.

<pre>
log(3, `${this.id} - attributeChangedCallback ...`)
</pre>

Debug-Ausgabe.

<pre>
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}
</pre>

Hook für Kindklassen.

Danach behandelt die Basisklasse ihre Standardattribute:

#==hidden

<pre>
case 'hidden':
this.style.display = hasValue ? 'none' : '';
</pre>

Wenn `hidden` gesetzt ist, wird das Element ausgeblendet.

#==disabled

<pre>
case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Optisch ausgegraut und nicht anklickbar.

#==readonly

<pre>
case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
</pre>

Nicht bedienbar, aber ohne optischen Filter.

#==margin

<pre>
case 'margin':
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
</pre>

Wenn numerisch:

<pre>
margin="1"
</pre>

wird zu:

<pre>
margin: 1em;
</pre>

Wenn nicht numerisch:

<pre>
margin="10px"
</pre>

bleibt:

<pre>
margin: 10px;
</pre>

Für `FTUI-GRID` wird `margin` hier nicht gesetzt, vermutlich weil `ftui-grid` sein eigenes Margin-Verhalten hat.

#==padding

<pre>
case 'padding':
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
</pre>

Analog zu `margin`.

==submitChange==

<pre>
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}
</pre>

Das ist wichtig für FTUI-Bindings.

Wenn eine Komponente intern einen Wert ändert, etwa ein Button oder Slider, ruft sie:

<pre>
this.submitChange('value', newValue);
</pre>

Dann passiert:

1. Änderung wird als aktiv markiert.
2. Property wird gesetzt.
3. Ein Event `valueChange` wird ausgelöst.

Dieses Event kann FTUI dann nutzen, um per `(value)` oder `[(value)]` etwas an FHEM zu senden.

==emitChangeEvent und emitEvent==

<pre>
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}
</pre>

Aus `value` wird:

</pre>text
valueChange
</pre>

<pre>
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}
</pre>

Es wird ein normales DOM-Event ausgelöst.

Beispiel:

<pre>
this.emitChangeEvent('value', 'on');
</pre>

erzeugt:

<pre>
new CustomEvent('valueChange', { detail: 'on' })
</pre>

==initProperties==

<pre>
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
</pre>

Für jede Property wird automatisch ein passender Getter/Setter erzeugt.

Beispiel:

<pre>
hidden: false
</pre>

wird zu:

<pre>
element.hidden
</pre>

und HTML-Attribut:

<pre>
hidden
</pre>

#==Boolean

<pre>
if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);
}
</pre>

Boolean-Attribute funktionieren nach HTML-Logik:

<pre>
<ftui-button disabled></ftui-button>
</pre>

bedeutet `true`.

#==Number

<pre>
else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Wird beim Lesen in `Number(...)` umgewandelt.

#==String

<pre>
else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
</pre>

Normale String-Attribute.

==initAttribute==

<pre>
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}
</pre>

Wenn das Attribut noch nicht im HTML steht, wird der Default gesetzt.

Beispiel:

<pre>
padding: ''
</pre>

führt zu:

<pre>
padding=""
</pre>

==initBooleanAttribute==

<pre>
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}
</pre>

Boolean-Attribute werden nur gesetzt, wenn der Default `true` ist.

Da `hidden`, `disabled`, `readonly` alle `false` sind, werden sie standardmäßig nicht gesetzt.

==defineBooleanProperty

<pre>
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
</pre>

Damit kann man schreiben:

<pre>
element.disabled = true;
</pre>

und bekommt im HTML:

<pre>
<ftui-button disabled></ftui-button>
</pre>

Bei:

<pre>
element.disabled = false;
</pre>

wird das Attribut entfernt.

Interessant:

<pre>
disabled="false"
</pre>

wird als `false` interpretiert. Das ist etwas komfortabler als natives HTML, wo ein vorhandenes Boolean-Attribut normalerweise immer wahr ist.

==defineNumberProperty

<pre>
get() { return Number(this.getAttribute(attr)); },
set(value) { this.setAttribute(attr, value); },
</pre>

Beispiel:

<pre>
<ftui-grid-tile row="2"></ftui-grid-tile>
</pre>

<pre>
element.row
</pre>

liefert Zahl `2`.

==defineStringProperty

<pre>
get() { return this.getAttribute(attr); },
set(value) { this.setAttribute(attr, value); },
</pre>

Normale Abbildung:

<pre>
element.text = 'Hallo';
</pre>

wird zu:

<pre>
text="Hallo"
</pre>

==updateProperties

<pre>
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);
if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
})
}
</pre>

Beim Einfügen ins DOM werden Standardattribute nochmal verarbeitet.

Warum?
Wenn ein Attribut schon beim Erzeugen gesetzt wurde, kann es sein, dass die Style-Logik noch nicht gelaufen ist. `updateProperties()` erzwingt deshalb die Behandlung der Defaultwerte.

==Kommentierte Version==

<pre>
import { isNumeric, toKebabCase, log } from '../modules/ftui/ftui.helper.js';

// Zähler für automatisch erzeugte IDs pro Elementtyp
const uids = {};

// Basisklasse aller FTUI-Webcomponents
export class FtuiElement extends HTMLElement {

constructor(properties) {
super();

// Falls keine ID vorhanden ist, automatisch eine eindeutige ID erzeugen
if (!this.id) {
if (!uids[this.localName]) {
uids[this.localName] = 1;
}
this.id = `${this.localName.replace(/-/g, '_')}_${uids[this.localName]++}`;
}

// Standardproperties der Basisklasse mit Komponentenproperties kombinieren
this.properties = Object.assign(FtuiElement.properties, properties);

// Für alle Properties Getter/Setter und Default-Attribute anlegen
this.initProperties(this.properties);

// Wenn die Komponente ein Template besitzt, Shadow DOM erzeugen
if (typeof this.template === 'function') {
this.createShadowRoot(this.template());
}

// Merker für aktive Änderungen, wichtig für Output-/Two-Way-Bindings
this.isActiveChange = {};

// Element beim globalen FTUI-Binding-System anmelden
if (window.ftuiApp) {
ftuiApp.attachBinding(this);
}
}

// Erzeugt Shadow DOM aus einem HTML-Template-String
createShadowRoot(content) {
const elemTemplate = document.createElement('template');
elemTemplate.innerHTML = content;
this.attachShadow({ mode: 'open' });
this.shadowRoot.appendChild(elemTemplate.content.cloneNode(true));
}

// Standardattribute, die jedes FTUI-Element besitzt
static get properties() {
return {
hidden: false,
disabled: false,
readonly: false,
margin: '',
padding: '',
};
}

// Attribute, bei deren Änderung attributeChangedCallback ausgelöst wird
static get observedAttributes() {
return [...Object.keys(FtuiElement.properties)];
}

// Wandelt Property-Namen in HTML-Attributnamen um
static convertToAttributes(properties) {
return Object.keys(properties).map(property => toKebabCase(property));
}

// Wird vom Browser aufgerufen, wenn das Element in den DOM eingefügt wurde
connectedCallback() {
this.updateProperties();

// Hook für abgeleitete Komponenten
if (typeof this.onConnected === 'function') {
this.onConnected();
}
}

// Wird aufgerufen, wenn sich ein beobachtetes Attribut ändert
attributeChangedCallback(name, oldValue, newValue) {
log(3, `${this.id} - attributeChangedCallback name=${name}, oldValue=${oldValue}, newValue=${newValue}`);

// Hook für abgeleitete Komponenten
if (typeof this.onAttributeChanged === 'function') {
this.onAttributeChanged(name, newValue, oldValue);
}

const hasValue = newValue !== null && newValue !== false;

// Standardattribute behandeln
switch (name) {
case 'hidden':
this.style.display = hasValue ? 'none' : '';
break;

case 'disabled':
this.style.filter = hasValue ? 'sepia(1) saturate(0) blur(1px)' : '';
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'readonly':
this.style.pointerEvents = hasValue ? 'none' : '';
break;

case 'margin': {
// ftui-grid behandelt margin selbst
if (this.tagName !== 'FTUI-GRID') {
this.style.margin = isNumeric(newValue) ? newValue + 'em' : newValue;
}
break;
}

case 'padding': {
this.style.padding = isNumeric(newValue) ? newValue + 'em' : newValue;
break;
}
}
}

// Wird von Komponenten genutzt, wenn ein Benutzerwert geändert wurde
submitChange(property, value) {
this.isActiveChange[property] = true;
this[property] = value;
this.emitChangeEvent(property, value);
}

// Erzeugt z.B. valueChange aus value
emitChangeEvent(attribute, value) {
this.emitEvent(attribute + 'Change', value);
}

// Löst ein DOM CustomEvent aus
emitEvent(name, value) {
const event = new CustomEvent(name, { detail: value });
this.dispatchEvent(event);
}

// Initialisiert Properties abhängig vom Typ des Defaultwerts
initProperties(properties) {
Object.entries(properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (typeof properties[name] === 'boolean') {
this.defineBooleanProperty(name, attr);
this.initBooleanAttribute(attr, defaultValue);

} else if (typeof properties[name] === 'number') {
this.defineNumberProperty(name, attr);
this.initAttribute(attr, defaultValue);

} else {
this.defineStringProperty(name, attr);
this.initAttribute(attr, defaultValue);
}
});
}

// Setzt Default-Attribut, wenn es noch nicht existiert
initAttribute(attr, value) {
if (!this.hasAttribute(attr)) {
this.setAttribute(attr, value);
}
}

// Setzt Boolean-Attribut nur, wenn Default true ist
initBooleanAttribute(attr, value) {
if (!this.hasAttribute(attr) && value) {
this.setAttribute(attr, '');
}
}

// Definiert Boolean-Property mit HTML-Attribut-Synchronisierung
defineBooleanProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.hasAttribute(attr)
&& this.getAttribute(attr) !== 'false';
},
set(value) {
if (value) {
this.setAttribute(attr, '');
} else {
this.removeAttribute(attr);
}
},
});
}

// Definiert Number-Property
defineNumberProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return Number(this.getAttribute(attr));
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Definiert String-Property
defineStringProperty(name, attr) {
Object.defineProperty(this, name, {
get() {
return this.getAttribute(attr);
},
set(value) {
this.setAttribute(attr, value);
},
});
}

// Behandelt Defaultwerte beim Einfügen des Elements in den DOM
updateProperties() {
Object.entries(this.properties).forEach(([name, defaultValue]) => {
const attr = toKebabCase(name);

if (this.getAttribute(attr) === String(defaultValue)) {
this.attributeChangedCallback(attr, null, defaultValue);
}
});
}
}
</pre>

==Mögliche Schwachstellen / Besonderheiten==

1. **`Object.assign(FtuiElement.properties, properties)` mutiert die statischen Basiseigenschaften.**
Sicherer wäre:

<pre>
this.properties = Object.assign({}, FtuiElement.properties, properties);
</pre>

2. **`observedAttributes` enthält nur Basiseigenschaften.**
Kindklassen müssen eigene Attribute selbst hinzufügen.

3. **Boolean-Erkennung `newValue !== false` ist etwas ungenau.**
Attribute liefern normalerweise Strings oder `null`, nicht echtes `false`. Bei `disabled="false"` funktioniert der Getter zwar korrekt, aber `attributeChangedCallback()` behandelt `"false"` trotzdem als vorhanden.

4. **`initAttribute()` setzt auch leere Default-Strings als Attribute.**
Dadurch entstehen Attribute wie:

<pre>
margin=""
padding=""
</pre>

Das ist nicht falsch, aber kann unnötige `attributeChangedCallback()`-Aufrufe erzeugen.

5. **`createShadowRoot()` nutzt `innerHTML`.**
Das ist normal für Templates, aber Template-Inhalte sollten kontrolliert sein.

==Merksatz==

Dieses Programm macht aus einer normalen Webcomponent eine **FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events**.

(FHEM) FTUI 3

2026-04-26T15:08:08Z

Chris T. Ludwig: /* Hauptstruktur */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── element.components.js Macht aus einer normalen Webcomponent eine FTUI-kompatible Komponente mit Attributbindung, Defaultwerten, Shadow DOM und Change-Events.
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── (insgesamt 37 siehe unten)
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==
Es gibt insgesamt 37 Komponenten:
<pre>
badge
button
cell
chart
checkbox
circlemenu
clock
colorpicker
column
content
departure
dropdown
grid
icon
image
input
knob
label
main
map
medialist
menu
meter
nav
popup
rotor
row
segment
slider
solar
speak
swiper
switch
tab
timeset
view
weather
</pre>

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
</pre>

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

==Links==
[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"

[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"

[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"

[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"

[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T15:06:36Z

Chris T. Ludwig: /* Komponentenprogramme */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── element.components.js
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── (insgesamt 37 siehe unten)
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==
Es gibt insgesamt 37 Komponenten:
<pre>
badge
button
cell
chart
checkbox
circlemenu
clock
colorpicker
column
content
departure
dropdown
grid
icon
image
input
knob
label
main
map
medialist
menu
meter
nav
popup
rotor
row
segment
slider
solar
speak
swiper
switch
tab
timeset
view
weather
</pre>

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
</pre>

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

==Links==
[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"

[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"

[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"

[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"

[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T15:02:23Z

Chris T. Ludwig: /* Hauptstruktur */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── element.components.js
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── (insgesamt 37 siehe unten)
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
components/row/row.component.js
components/column/column.component.js
components/tab/tab.component.js
components/view/view.component.js
</pre>

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

==Links==
[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"

[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"

[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"

[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"

[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T14:50:57Z

Chris T. Ludwig: /* Hauptstruktur */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── element.components.js
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── ...
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
components/row/row.component.js
components/column/column.component.js
components/tab/tab.component.js
components/view/view.component.js
</pre>

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

==Links==
[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"

[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"

[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"

[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"

[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T14:47:46Z

Chris T. Ludwig: /* Custom HTML Tags */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── ...
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
components/row/row.component.js
components/column/column.component.js
components/tab/tab.component.js
components/view/view.component.js
</pre>

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

==Links==
[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"

[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"

[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"

[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"

[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T11:02:52Z

Chris T. Ludwig: /* Kleiner Demo-View mit FHEM-Kommunikation */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── ...
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
components/row/row.component.js
components/column/column.component.js
components/tab/tab.component.js
components/view/view.component.js
</pre>

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

<pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T11:01:58Z

Chris T. Ludwig: /* Ueberblick */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── ...
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

==Kernprogramme==

Tabelle TODO

| Datei | Aufgabe | Abhängigkeiten |

| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |

| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |

| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |

| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |

| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |

| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |

| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |

| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant.

| `ftui.helper.js` |

| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten.

| Chart-Komponenten |

| `iro.js` | externe Farbpicker-Bibliothek.

| Color-Komponenten |

| `rangeable/*` | externe Slider-Bibliothek.

| Slider/Range-Komponenten |

| `vanilla-notify/*` | Toast-Meldungen für Debug/Error.

| `ftui.app.js` |

==Datenfluss==

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

==FHEM-Kommunikation==

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

==Komponentenprogramme==

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
components/row/row.component.js
components/column/column.component.js
components/tab/tab.component.js
components/view/view.component.js
</pre>

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

==Kleiner Demo-View mit FHEM-Kommunikation==

</pre>
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

==Wichtigster Zusammenhang==

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T07:37:20Z

Chris T. Ludwig: /* Allgemeines */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Ueberblick=
Das Projekt ist ein '''ES2020-Web-Components-Framework''' für FHEM/Home Assistant; FTUI v3 ist nicht kompatibel mit FTUI v1/v2 und unterstützt mehrere Backends. ([GitHub][1])

==1. Hauptstruktur==

<pre>
www/ftui/
├── ftui.js Startdatei
├── modules/
│ ├── ftui/
│ │ ├── ftui.app.js App-Initialisierung
│ │ ├── backend.service.js Backend-Router FHEM/HA
│ │ ├── fhem.service.js Kommunikation mit FHEM
│ │ ├── ha.service.js Home-Assistant-Backend
│ │ ├── ftui.binding.js Binding-System [ ], ( ), [( )]
│ │ └── ftui.helper.js Hilfsfunktionen, Pipes, Observer
│ ├── chart.js Chart-Bibliothek
│ ├── iro.js Farbpicker-Bibliothek
│ ├── hocon/ Parser für map/step-ähnliche Syntax
│ ├── rangeable/ Slider-Hilfsbibliothek
│ └── vanilla-notify/ Toast/Notify
└── components/
├── button/
├── label/
├── icon/
├── grid/
├── row/
├── column/
├── tab/
├── view/
└── ...
</pre>

Die zentrale Komponenten-Ladung passiert dynamisch: `ftui.app.js` sucht unbekannte `ftui-*` Elemente und lädt daraus automatisch Dateien nach dem Muster `components/<gruppe>/<name>.component.js`. ([GitHub][2])

## 2. Kernprogramme

| Datei | Aufgabe | Abhängigkeiten |
| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `ftui.js` | Einstiegspunkt. Lädt `ftui.app.js`, setzt `window.ftuiApp`, startet `init()` und registriert Online/Offline/Visibility/Error-Handler. | `ftui.app.js` |
| `ftui.app.js` | Liest Meta-Tags, bestimmt `fhemDir`, lädt Komponenten, startet Binding und Backend. | `backend.service.js`, `ftui.binding.js`, `ftui.helper.js`, `vanilla-notify` |
| `backend.service.js` | Vermittler zwischen UI und Backend. Entscheidet: FHEM oder Home Assistant. Leitet Reads/Writes weiter. | `fhem.service.js`, `ha.service.js`, `ftui.helper.js` |
| `fhem.service.js` | FHEM-Kommunikation: `jsonlist2` Refresh, WebSocket/`inform`, `sendCommand`, CSRF-Handling, Reading-Cache. | `backend.service.js`, `ftui.helper.js` |
| `ftui.binding.js` | Parst `[attr]`, `(attr)`, `[(attr)]`, `@click`, Pipes wie `map`, `step`, `append`. Verknüpft Readings mit DOM-Properties. | `backend.service.js`, `ftui.helper.js`, `hocon` |
| `ftui.helper.js` | Utility-Funktionen: Regex-Matching, `map`, `step`, Datum, Zahlen, DOM-Helfer, `Subject` Observer. | keine zentrale Abhängigkeit |
| `ha.service.js` | Backend analog zu `fhem.service.js`, aber für Home Assistant. | `ftui.helper.js` |
| `chart.js` | externe Chart-Bibliothek für FTUI-Chart-Komponenten. | Chart-Komponenten |
| `iro.js` | externe Farbpicker-Bibliothek. | Color-Komponenten |
| `rangeable/*` | externe Slider-Bibliothek. | Slider/Range-Komponenten |
| `vanilla-notify/*` | Toast-Meldungen für Debug/Error. | `ftui.app.js` |

## 3. Datenfluss

<pre>
HTML:
<ftui-label [text]="RL_AZC:status2bit">

→ ftui.app.js erkennt ftui-label
→ lädt components/label/label.component.js
→ ftui.binding.js liest [text]
→ backend.service.js registriert Reading
→ fhem.service.js erzeugt Filter
→ fhem.service.js holt initial per jsonlist2
→ fhem.service.js öffnet WebSocket mit inform
→ Änderung in FHEM
→ WebSocket Event
→ Reading-Cache wird aktualisiert
→ Binding setzt label.text
→ DOM aktualisiert sich
</pre>

FTUI verwendet für Eingaben/Ausgaben diese Richtungen:

<pre>
[attr] Backend → Widget
(attr) Widget → Backend
[(attr)] Backend ↔ Widget
@click JavaScript/Event → z.B. sendFhem(...)
</pre>

## 4. FHEM-Kommunikation

`fhem.service.js` macht drei Dinge:

<pre>
1. Initialwerte:
sendCommand("jsonlist2 <filter>")

2. Live-Updates:
WebSocket auf:
/fhem?XHR=1&inform=type=status;filter=...;fmt=JSON

3. Schreibbefehle:
/fhem?cmd=<befehl>&fwcsrf=<token>&XHR=1
</pre>

Der aktuelle Code enthält `ensureCSrf()` und `fetchCSrf()`: Vor `sendCommand()` wird ein CSRF-Token geholt, falls noch keines gesetzt ist. ([GitHub][3])

## 5. Komponentenprogramme

Die Komponenten liegen jeweils als Web Component in `components/<name>/...component.js`.

Beispiele:

<pre>
components/button/button.component.js
components/button/button-nice.component.js
components/label/label.component.js
components/icon/icon.component.js
components/grid/grid.component.js
components/row/row.component.js
components/column/column.component.js
components/tab/tab.component.js
components/view/view.component.js
</pre>

Für `button` zeigt das Repository z.B. `button.component.js`, `button-nice.component.js` und CSS. ([GitHub][4])
Für `label` gibt es `label.component.js`. ([GitHub][5])

## 6. Kleiner Demo-View mit FHEM-Kommunikation

</pre>html
<!DOCTYPE html>
<html>
<head>
<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">
<meta name="debug" content="4">

<script src="ftui.js"></script>
<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
</head>

<body>

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">

<ftui-row>
<ftui-label text="Rollladen AZC"></ftui-label>

<ftui-icon
[name]="RL_AZC:status2bit | map('0:user_icons\/fts_shutter_0,1:user_icons\/fts_shutter_updown,2:user_icons\/fts_shutter_40,3:user_icons\/fts_shutter_100')"
size="3">
</ftui-icon>

<ftui-label [text]="RL_AZC:status2bit"></ftui-label>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-grid-tile>

</ftui-grid>

</body>
</html>
</pre>

Was dabei passiert:

<pre>
[text]="RL_AZC:status2bit"
→ registriert Reading RL_AZC-status2bit

[name]="RL_AZC:status2bit | map(...)"
→ liest dasselbe Reading
→ setzt abhängig vom Wert das Icon

@click="sendFhem('set RL_AZC up')"
→ ruft backendService.sendUpdate()
→ fhem.service.js sendCommand()
→ FHEM bekommt set RL_AZC up
</pre>

## 7. Wichtigster Zusammenhang

<pre>
ftui.js
└── ftui.app.js
├── lädt Komponenten dynamisch
├── startet FtuiBinding
└── backend.service.js
├── fhem.service.js
│ ├── jsonlist2
│ ├── WebSocket inform
│ ├── CSRF
│ └── sendCommand()
└── ha.service.js
</pre>

Für eine echte vollständige Datei-für-Datei-Kommentierung aller Komponenten wäre ein lokaler Checkout oder ZIP des Repositories sinnvoll, weil GitHub die komplette Komponentenliste im Web-Tree nicht vollständig zuverlässig ausliefert.

[1]: https://github.com/knowthelist/ftui "GitHub - knowthelist/ftui: FTUI version 3 · GitHub"
[2]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/ftui.app.js "raw.githubusercontent.com"
[3]: https://raw.githubusercontent.com/knowthelist/ftui/master/www/ftui/modules/ftui/fhem.service.js "raw.githubusercontent.com"
[4]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/button "ftui/www/ftui/components/button at master · knowthelist/ftui · GitHub"
[5]: https://github.com/knowthelist/ftui/tree/master/www/ftui/components/label "ftui/www/ftui/components/label at master · knowthelist/ftui · GitHub"

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T06:26:11Z

Chris T. Ludwig: /* Tag-List */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

===Local Bindung und Events===

Die schiebe ich mal nach hinten.

===Pipes===
Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

===Formatierung/Layout===

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T06:24:04Z

Chris T. Ludwig: /* Tag-List */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es funktioniert auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

Local Bindung und Events schiebe ich mal nach hinten.

Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

====Formatierung/Layout====

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-26T06:23:22Z

Chris T. Ludwig: /* Tag-List */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von get-value und set-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es gehen auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

Local Bindung und Events schiebe ich mal nach hinten.

Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

====Formatierung/Layout====

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-25T13:12:45Z

Chris T. Ludwig: /* Fehler nach Update */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von set-value und get-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es gehen auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

Local Bindung und Events schiebe ich mal nach hinten.

Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

====Formatierung/Layout====

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

Antwort:

<pre>
HTTP/1.1 400 Bad Request
Content-Length: 0
Cache-Control: no-cache, no-store, must-revalidate
X-FHEM-csrfToken: csrf_19345435345346
Content-Type: text/html; charset=UTF-8
</pre>

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />

(FHEM) FTUI 3

2026-04-25T09:42:21Z

Chris T. Ludwig: /* Beispiele */

=Allgemeines=
Seit 2000 (Beginn noch unbestaetigt) gibt es eine neue Variante 'FHEM Tablet User Interface Version 3', oder kurz FTUI3 genannt.

Der Entwickler hat seine bisherige Arbeit bei [https://github.com/knowthelist/ftui Github] eingestellt. Es gibt keine offizelle Release, also alles noch 'Under Construction'

UI builder framework for FHEM — http://fhem.de/fhem.html with a clear intention: Keep it short and simple!

FTUI 3 uses Web Components technologies in pure ES2020 javascript.

Diese zwei Aussagen und mein Eindruck, dass die Version 2 doch recht sperrig ist, haben mich dazu bewogen es mit FTIU3 mal zu probieren.

FTUI V2 hat bei mir zwar funktioniert, war aber einfach auf einem Tablet zu langsam. Bei einer Seite mit mehr als 20 Widgets konnte man dem mühsamen Aufbau zuschauen. An einen schnellen Seitenwechsel ist nicht zu denken. Da war mein ASCII-Tablet (MT701) aus den 2000er deutlich schneller.

Im [https://forum.fhem.de/index.php?action=search2 FHEM-Forum] gibt es 118 Beitraege (Stand082022) zum Thema FTUI3

=Custom HTML Tags=

[https://matthewjamestaylor.com/custom-tags Einstieg]

Das ganze Framework arbeitet mit eigenen HTML-Tags die alle mit <ftui-...> eingeleitet werden.

Mit meinem fing-Befehl

alias fing='function _fing(){ find "$1" -type f -exec grep -l "$2" {} \; ; }; _fing'

kann ich relativ schnell herausfinden wo das custom-tag ueberall drinsteckt. z. B.

<pre>
fhem:/opt/fhem/www/ftui # fing /opt/fhem/www/ftui "<ftui-button"
/opt/fhem/www/ftui/index.html
/opt/fhem/www/ftui/examples/meter.html
/opt/fhem/www/ftui/examples/colors.html
/opt/fhem/www/ftui/examples/button.html
/opt/fhem/www/ftui/examples/circlemenu.html
/opt/fhem/www/ftui/examples/badge.html
/opt/fhem/www/ftui/examples/swiper.html
/opt/fhem/www/ftui/examples/binding.html
/opt/fhem/www/ftui/examples/button-nice.html
/opt/fhem/www/ftui/examples/tab.html
/opt/fhem/www/ftui/examples/speak.html
/opt/fhem/www/ftui/examples/icon.html
/opt/fhem/www/ftui/examples/popup.html
/opt/fhem/www/ftui/examples/themes.html
/opt/fhem/www/ftui/examples/grid.html
/opt/fhem/www/ftui/examples/contents/content-view2.html
/opt/fhem/www/ftui/examples/contents/mobile-shutter.html
/opt/fhem/www/ftui/examples/contents/mobile-view-sonos.html
/opt/fhem/www/ftui/examples/mobile_full.html
/opt/fhem/www/ftui/examples/label.html
/opt/fhem/www/ftui/components/button/button-nice.component.js
</pre>

Neben den 3 Dateien
ftui.js
ftui.css

index.html

gibt es noch 5 Verzeichnisse
components
modules

themes
icons

examples

Das Verzeihnis components enthaelt die Definitionen der Custom-Tags.
Modules weisz ich noch nicht.

Themes und icons enthalten das was man erwartet, bis auf die Datei demo.html. Mit deren Hilfe werden alle Icons angezeigt.

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

=Inhalt=
Neben den 3 Dateien
ftui.css
ftui.js
index.html

verteilt sich der Rest auf 5 Verzeichnisse
compnents
modules

icons
themes

examples

In components befinden sich alle Kompnenten die per Tag benutzt werden koennen.
Die Bedeutung von modules ist mir noch unklar.

In themes und icons steckt genau das drin was man vermutet, auszer in icons gibt es noch eine demo.html

http://fhem.clx.local:8083/fhem/ftui/icons/demo.html

==ftui.js==
Mit 1326 Bytes ja richtig bescheiden.

TODO

===Tag-List===

Die eckigen [] und runden () Klammern um die Attribute sind die Kurzformen von set-value und get-value.

Aus <ftui-label get-color="dummy1:color">demo</ftui-label> wird dann <ftui-label [color]="dummy1:color">demo</ftui-label> wenn die Farbe aus dem FHEM-Device dummy1 das Reading color uebernommen werden soll.

Aus <ftui-button set-value="dummy1"></ftui-button> wird dann <ftui-button (value)="dummy1"></ftui-button> wenn der (?) Wert des FHEM-Devices dummy1 gesetzt werden soll.

Es gehen auch Hin- und Rueckweg kombiniert.

Aus <ftui-button getset-value="dummy1"></ftui-button> wird dann <ftui-button [(value)]="dummy1"></ftui-button> In dem Beispiel aus der Doku kann ich aber nicht mehr die Funktion erkennen.

Local Bindung und Events schiebe ich mal nach hinten.

Pipes sind recht hilfreich wenn der Wert aus einem FHEM-Device-Reading und der Wert fuer das FTUI-Attribut nicht kompatibel sind. Dann kann man durch die Pipes eine Anpassung realisieren.

part(number)
toDate(string)
toBool(string|number)
toInt(number)
format(string)
round(number)
add(number)
multiply(number)
divide(number)
replace(find, replace)
map('in1:out1,in2:out2,...')
step('1:ok,6:warning,10:alert')
scale(minIn, maxIn, minOut, maxOut)

====Formatierung/Layout====

Alignment and margins can be changed by the attributes

align-item (top, bottom, left, right, center, around, stretch)
margin
padding

Tab <ftui-tab view="View1" title="Home" active>
<ftui-tab fill="clear" direction="vertical" view="View1" title="Tab1" active>
<ftui-tab-view id="View1" [hidden]="ftuitest | isNot('1')">
<ftui-tab-title text-align="left"></ftui-tab-title>
<ftui-segment [(value)]="ftuitest">

Grid <ftui-grid base-width="150" base-height="120">
<ftui-grid base-width="75" base-height="75" shape="round" margin="2">
<ftui-grid-tile row="1" col="1" height="1" width="3">
<ftui-grid-tile row="1" col="1" height="1" width="4" color="translucent">
<ftui-grid-tile row="3" col="3" height="1000" width="1" color="red">
<ftui-grid-header>ROUND</ftui-grid-header>

Circlemenu <ftui-circlemenu circle-radius="4" keep-open>
<ftui-circlemenu keep-open direction="horizontal-right" opacity="0.2">

Row <ftui-row align-items="center" class="size-3"><ftui-row align-items="top" margin="1" width="80%" height="33%">
<ftui-row color="ok-warning-alert">ok-warning-alert</ftui-row>
<ftui-row slot="end" align-items="stretch"><ftui-row color="red">red</ftui-row>

Column <ftui-column width="10%" height="70%">RGB</ftui-column>
<ftui-column shape="round" color="light">light</ftui-column>
class="big" align-items="top|left|right|stretch|around|dark" class="size-3"

Cell <ftui-cell class="size-7" style="height: 1250px">Tab2</ftui-cell> <ftui-cell slot="end" width="70px"><ftui-cell align-items="left">

View<ftui-view-toolbar slot="header"> <ftui-view id="view-1"> <ftui-view-sheet shape="round">

ViewStage <ftui-view-stage>

ViewSection <ftui-view-section>

ViewItem <ftui-view-item target="details-1">Item 2-1</ftui-view-item> wird haeufig mit FHEM-Devices kombiniert: Decke, Wand, Desktop, Fenster, ...

Swiper <ftui-swiper scrollbar auto-play interval="2"> <ftui-swiper id="swiper3" dots auto-play interval="3"> <ftui-swiper id="swiper2" [(value)]=local:swiper2 dots> <ftui-swiper id="swiper1" scrollbar>

====Design====
Die sogenannten 'fixed theme colors' die zur Verfuegung stehen, koennen [https://knowthelist.github.io/ftui/www/ftui/examples/colors.html hier] betrachtet werden.

====Komponenten/Elemente====

[https://github.com/knowthelist/ftui#label Label]x
[https://github.com/knowthelist/ftui#Icon Icon](x)
[https://github.com/knowthelist/ftui#button Button]x
[https://github.com/knowthelist/ftui#SegmentedButton SegmentedButton]
[https://github.com/knowthelist/ftui#Knob Knob]
[https://github.com/knowthelist/ftui#Slider Slider]
[https://github.com/knowthelist/ftui#Checkbox Checkbox]
[https://github.com/knowthelist/ftui#Weather Weather]
[https://github.com/knowthelist/ftui#Dropdown Dropdown]
[https://github.com/knowthelist/ftui#Colorpicker Colorpicker]x
[https://github.com/knowthelist/ftui#Image Image]x
[https://github.com/knowthelist/ftui#Badge Badge]x
[https://github.com/knowthelist/ftui#Clock Clock]
[https://github.com/knowthelist/ftui#Chart Chart]x
[https://github.com/knowthelist/ftui#Medialist Medialist]

<ftui-slider margin="-34px 0 0 0" class="size-0"
<ftui-button (value)="ftuitest" states="0,4,10,45,75,90,100">Try</ftui-button>
<ftui-icon margin="-10px 0 0 0" name="circle" class="size-0"
<ftui-dropdown nochevron class="size-3"
<ftui-meter value="50" min="1" max="200">
<ftui-input [(value)]="ftuitest" min="1" max="100" type="number" size="4"></ftui-input>
<ftui-departure [list]="depDummy:HBF" icon="bus" getinterval="120" station="Default" alternate>
<ftui-segment-button value="1">
<ftui-chart title="demo-chart" y-label="Heizung" y1-label="Außen" y-unit="°C" y1-unit="°C">
<ftui-chart-data label="Außen" color="warning" log="FileLog_AgroWeather" spec="4:AgroWeather.temperature"
<ftui-chart-controls units="day, week"></ftui-chart-controls>

====Miscellaneous====

[https://github.com/knowthelist/ftui#speak Speak]x

===Attribute===

Alle Elemente verfuegen ueber diese Attribute:

hidden
disabled
readonly
margin
padding

=Objekthierarchie=

Hier ist ein praktischer **Objektbaum für FTUI v3** mit den typischen erlaubten Eltern-Kind-Beziehungen.

FTUI stellt Layout-Komponenten wie **Grid**, **Row**, **Column** und **Tab/View-Strukturen** bereit; die offiziellen Beispiele zeigen `ftui-grid` mit `ftui-grid-tile`, darin `ftui-grid-header`, `ftui-row` und `ftui-column`. ([GitHub][1])

<pre>
<body>
└── ftui-tab-view optional: eine Seite / ein Tab-Inhalt
└── ftui-grid Hauptlayout einer Seite
├── ftui-grid-tile Kachel im Grid
│ ├── ftui-grid-header Kopfzeile/Titel der Kachel
│ ├── ftui-row horizontale Anordnung
│ │ ├── ftui-column vertikale Untergruppe
│ │ │ ├── ftui-label
│ │ │ ├── ftui-icon
│ │ │ └── ftui-button
│ │ ├── ftui-icon
│ │ └── ftui-label
│ ├── ftui-column vertikale Anordnung
│ │ ├── ftui-row
│ │ │ ├── ftui-label
│ │ │ └── ftui-icon
│ │ ├── ftui-label
│ │ └── ftui-button
│ ├── ftui-label
│ ├── ftui-icon
│ └── ftui-button
└── ftui-grid-tile
└── ...
</pre>

Die wichtigsten Regeln:

<pre>
ftui-tab-view
└── darf enthalten:
├── ftui-grid
├── ftui-row
├── ftui-column
└── normale Widgets / HTML
</pre>

<pre>
ftui-grid
└── sollte hauptsächlich enthalten:
└── ftui-grid-tile
</pre>

<pre>
ftui-grid-tile
└── darf enthalten:
├── ftui-grid-header
├── ftui-row
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-grid-header
└── sollte innerhalb von ftui-grid-tile stehen
</pre>

<pre>
ftui-row
└── darf enthalten:
├── ftui-column
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

<pre>
ftui-column
└── darf enthalten:
├── ftui-row
├── ftui-label
├── ftui-icon
├── ftui-button
└── andere Widgets
</pre>

Ein sauberes Beispiel (html):

<pre>
<ftui-tab-view id="rollladen">

<ftui-grid base-width="100" base-height="100" margin="10">

<ftui-grid-tile row="1" col="1" width="4" height="2">
<ftui-grid-header>Arbeitszimmer</ftui-grid-header>

<ftui-column>

<ftui-row>
<ftui-label text="Rollladen"></ftui-label>
<ftui-icon name="user_icons/fts_shutter_100"></ftui-icon>
</ftui-row>

<ftui-row>
<ftui-button @click="sendFhem('set RL_AZC up')">Auf</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC stop')">Stop</ftui-button>
<ftui-button @click="sendFhem('set RL_AZC down')">Ab</ftui-button>
</ftui-row>

</ftui-column>
</ftui-grid-tile>

</ftui-grid>

</ftui-tab-view>
</pre>

Kurz gesagt: **`ftui-grid` ordnet Kacheln an, `ftui-grid-tile` ist die Kachel, `ftui-row` und `ftui-column` strukturieren den Inhalt der Kachel.**

[1]: https://github.com/knowthelist/ftui?utm_source=chatgpt.com "knowthelist/ftui: FTUI version 3"

=Beispiele=
Fangen wir mal klein an. Zu Beginn erst einmal das Grundgeruest.

<div class="toccolours mw-collapsible mw-collapsed" style="width:600px; overflow:auto;">
<div style="font-weight:bold;line-height:1.6;">FTUI Grundgeruest</div>
<div class="mw-collapsible-content">
<syntaxhighlight lang="html" line>
<!DOCTYPE html>
<html>

<head>

<script src="ftui.js"></script>

<link href="ftui.css" rel="stylesheet">
<link href="themes/ftui-theme.css" rel="stylesheet">
<link href="favicon.ico" rel="icon" type="image/x-icon" />


<meta name="viewport" content="width=device-width">

<meta name="mobile-web-app-capable" content="yes">
<meta name="toast_position" content="topLeft">


<meta name="debug" content="0">

<title>FTUI Example</title>
</head>

<body>

</body>

</html>
</syntaxhighlight>
</div></div>

Zum Testen habe ich jetzt umeinander die Code-Bloecke im <body> einkopiert.

HINWEIS: Um die Toast-Meldungen ab-/anzuschalten folgendes einfuegen
<meta name="toast" content="0">

<pre>
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</pre>

Da passiert nix, auszer dass 'DummyFTUI' auf dem Bildschirm steht, aber kein Button nix.
Mal einen View drumbauen.

<pre>
<ftui-view id="View1">
<ftui-button (value)="set dummyFTUI off" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="angle-up" class="size-1" height="90%"></ftui-icon>
<ftui-label>DummyFTUI</ftui-label>
</ftui-button>
</ftui-view>
</pre>

Immer noch nix.

In den Beispielen war oft auszenherum eine Grid.

Immer noch nix.

Ganz anderer Fehler!

Ich habe mein Beispiel in Verzeichnis examples abgelegt und folgenden Eintrag vergessen.
<base href="../" />

D.h. erst ma muss man den Pfad zum FTUI-root Verzeichnis richtig einstellen.

<pre>
<body>

<ftui-icon name="window-shutter" class="size-4"></ftui-icon>
<ftui-button @click="sendFhem('{setJalousieNight()}')" direction="vertical" color="current" fill="none"
margin="-1em">
<ftui-icon name="angle-down" class="size-1" height="90%"></ftui-icon>
<ftui-label>Nacht</ftui-label>
</ftui-button>

</body>
</pre>

Jetzt sieht man einen Button ueber die gesamte Bildschirmbreite wobei man den Pfeil nach unten und das Label Nacht bedienen kann und auch eine Aktion ausloest. Das Rollladen-Ikon ist nicht zum clicken.
Es liegt auch auszerhalb des Button-Tags.

HINWEIS: Bei der Vergabe von eigenen ID-Namen immer alles in/nur Kleinbuchstaben und maximal einen Unterstrich.

So jetzt geht's an Grid, um Einfluss auf Position und Groesze der Komponenten nehmen zu koennen.

https://www.ionos.de/digitalguide/websites/webseiten-erstellen/css-grid/

HINWEIS: cols und rows gibt es auch nicht mehr beim Grid, nur noch base-width und base-height - mit jeweils 140 als default. « Letzte Änderung: 07 Februar 2022, 19:47:25 von [https://forum.fhem.de/index.php?topic=115259.2130 setstate] »

Das konnte ich aber so nicht direkt finden. Im Code (grid.component.js) steht im Konstruktor:

constructor() {
const properties = {
minX: 0,
minY: 0,
baseWidth: 0,
baseHeight: 0,
margin: 8,
resize: false,
responsive: false,
};

Weiter unten folgt dann in Kombination mit dem Attribut 'responsive':
:host([responsive]) {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(140px, 1fr));
grid-template-rows: repeat(auto-fill, minmax(140px, 1fr));
grid-auto-flow: dense;
grid-auto-columns: 25%;
grid-auto-rows: 25%;
gap: ${this.margin}px;
margin: ${this.margin}px;
}

HINWEIS: Die Attributnamen werden im Code von der 'Bindestrichschreibweise' in die 'CamelCase-Schreibweise' gewandelt. Bsp (s.o.): base-width -> baseWidth

An dieser Stelle gebe ich mal nur meinen Testcode an. Alle Kombinationen der Einstellungen von base-height, base-width, margin, row, col, height und width anzugeben ist natuerlich nicht moeglich. Jeder sollte mal selbst rumspielen.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="2" col="2" height="2" width="2" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-3" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>
<ftui-grid base-width="10" base-height="10" margin="0" shape="round">
<ftui-grid-tile row="31" col="1" height="10" width="10" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-1" height="100%"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
</ftui-button>
</ftui-grid-tile>
<ftui-grid-tile row="41" col="5" height="20" width="20" shape="round"
[color]="dummy.state | map('on:warning, off:ok')">
<ftui-button (value)="set dummy" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon name="lightbulb-o" class="size-5" height="100%"></ftui-icon>
<ftui-label>Dummy2</ftui-label>
</ftui-button>
</ftui-grid-tile>

<ftui-grid>>
</pre>

HINWEIS: Fuer row und col sind sogar 0 und negative Werte moeglich. Mit z.B. margin=0 rutscht der Button aus dem Fenster. Die kleinste sinnvolle Groesze ist 1.

HINWEIS: Mit base-height und base-width kann man gemeinsam mit height und width die Groesze des Button und damit das Verhaeltnis zum Icon /Label beeinflussen.

Mal zum Rechnen von row und col wird 1 abgezogen und dann mit base multipliziert. height und width werden direkt mit der base multipliziert und ergeben die Groesze des Buttons. Ein Button 100:1 hat die gleiche Groesze wie ein 10:10.
Zwei Grids auf einer Seite sind keine gute Idee, dann muss man noch mehr rechnen (s.o.).
Fuer den Einstieg reicht mir das beim Layout. Jetzt machen wir mal noch Funktion dazu.

<pre>
<ftui-grid base-width="100" base-height="100" margin="0" shape="round">
<ftui-grid-tile row="1" col="1" height="1" width="1" shape="round"
[color]="test | map('on:red, off:orange')">
<ftui-button (value)="set test" direction="vertical" color="current" fill="none" margin="-1em">
<ftui-icon [name]="test | map('on:lightbulb-on, off:lightbulb')" class="size-1" height="100%" [color]="test | map('on:yellow, off:primary')"></ftui-icon>
<ftui-label>Dummy1</ftui-label>
<ftui-content [content]="test:state"></ftui-content>
</ftui-button>
</ftui-grid-tile>
</pre>
HINWEIS: Das state-Reading darf nicht angegeben werden. Siehe Beispiel oben. Weder beim set () noch beim get [] ist ein test.state angegeben.
Das kommt mir trotzdem komisch vor. Ich werde weiter testen.

Das Beispiel waechst weiter und die Anpassung meiner FHEM-Instanz an meine Tablets funktioniert praechtig.

Jetzt besteht der Wunsch nach passenden Icons. Mit

fing /opt/fhem/www/ftui "icons/"

dass in den Beipielen Repositpries von 'bas' und 'kleinklima' genutzt werden.

Bas ist [https://basmilius.github.io/weather-icons/ unter] zu finden und mit

wget -r -A svg -nd -nH -l 1 https://github.com/basmilius/weather-icons/tree/dev/production/fill/svg

habe ich mir mal die svg in das Verzeichnis ftui/icons/wether/basmilius geholt. Wer will kann noch einen Softlink im Verzeichnis ftui/icons/weather mit dem Namen bas darauf legen.

ln -s basmilius bas

Es ist nicht schwer einzelne passende Icons zu finden, aber ein Paket herunterzuladen spart halt doch Zeit. Fundstellen bitte gerne in die Kommentare.

Die Icons in den Unterordnern eine eine map einzubinden hat mich Nerven gekostet.

Einen Eintrag

<meta name="ftui_iconpath" content="path/to/your/icons/">
oder
<meta name="iconPath" content="path/to/your/icons/">

scheint es in FTUI nicht (mehr) zu geben und die Pfadangabe in der map-Umgebung wird nicht (richtig) ausgewertet.

Das Escapen den Slashes hat nur bedingt funktioniert. Erst das Quoten mit z. B. ` hat dann geklappt.

<ftui-icon [name]="RL_AZC:status2bit | map('0:`user_icons/fts_shutter_0`,1:`user_icons/fts_shutter_updown`,2:`user_icons/fts_shutter_40`,3:`user_icons/fts_shutter_100`')" size="3"></ftui-icon>

=Kleiner Ausflug in mein KNX=

FHEM unterstuetzt nur fogende Datentypen

<pre>
dpt1
dpt1.000
dpt1.001
dpt1.002
dpt1.003
dpt1.004
dpt1.005
dpt1.006
dpt1.007
dpt1.008
dpt1.009
dpt1.010
dpt1.011
dpt1.012
dpt1.013
dpt1.014
dpt1.015
dpt1.016
dpt1.017
dpt1.018
dpt1.019
dpt1.021
dpt1.022
dpt1.023
dpt2
dpt232 ???
dpt3
dpt3.007
dpt5
dpt5.001
dpt5.003
dpt5.004
dpt6
dpt6.001
dpt7
dpt7.001
dpt7.005
dpt7.006
dpt7.007
dpt7.012
dpt7.013
dpt8
dpt8.005
dpt8.010
dpt8.011
dpt9
dpt9.001
dpt9.004
dpt9.005
dpt9.006
dpt9.007
dpt9.008
dpt9.009
dpt9.010
dpt9.020
dpt9.021
dpt9.024
dpt9.025
dpt9.026
dpt9.028
dpt10
dpt11
dpt12
dpt13
dpt13.010
dpt13.013
dpt14
dpt14.019
dpt14.027
dpt14.033
dpt14.056
dpt14.057
dpt14.068
dpt14.076
dpt16
dpt16.000
dpt16.001
dpt17.001
dpt18.001
dpt19
</pre>

=Fehler nach Update=

Im "sendcommand" ist auf einmal der wfcsrf Parameter leer.

Fehlermeldung

fhem command failed syntaxerror: json.parse: unexpected end of data at line 1 column 1 of the json data

Spurensuche:

curl -i "http://127.0.0.1:8083/fhem?cmd=jsonlist2&XHR=1"

<meta name="fhemweb_url" content="http://fhem.clx.local:8083/fhem">

In fhem.service.js wurde durch das Versionupdate die Zeilen:

<pre>
// init FhemService
fhemService.setConfig(this.config);
fhemService.debugEvents.subscribe(text => this.toast(text));
fhemService.errorEvents.subscribe(text => this.toast(text, 'error'));
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
</pre>

ersetzt durch

<pre>
// initialize backend service
await this.initBackends();
</pre>

In initBackends steht folgendes:

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

Der BackendService wurde erzeugt um auch die Anbindung an HA in einem Aufwasch zu realisieren.
Es haette aber gereicht fhemService.setConfig(this.config); zu ersetzen. Stattdessen wurde

<pre>
this.fhemService = fhemService;

// init Page after CSFS Token has been retrieved
await fhemService.fetchCSrf()
</pre>
gleich mit geloescht aber nicht ersetzt.

Nach der Korrektur von initBackends() in der ftui.app.js hatten meine Seiten wieder Zugriff auf FHEM.

<pre>
// initialize backend services
async initBackends() {
try {
// Initialize backend service
backendService.setConfig(this.config);
backendService.debugEvents.subscribe(text => this.toast(text));
backendService.errorEvents.subscribe(text => this.toast(text, 'error'));

this.fhemService = fhemService;
await fhemService.fetchCSrf()

await this.initPage();

// call health check periodically
setInterval(() => {
this.checkConnection();
}, this.config.updateCheckInterval * 60 * 1000);
} catch (err) {
ftui.error('[ftuiApp] initBackends error - ' + err);
}
}
</pre>

=Request for Comments=

<comments />