Benutzerverwaltung

warp1

users/config

Die Benutzerkonfiguration. Kann mit users/add, users/modify, users/remove und users/http_auth_update aktualisiert werden.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/users/config

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/users/config

{
  "users": [
    {
      "id": 0,
      "roles": 4294967295,
      "current": 32000,
      // Wird vom Webinterface durch "Unbekannter Benutzer" ersetzt.
      "display_name": "Anonymous",
      "username": "anonymous",
      "digest_hash": ""
    },
    {
      "id": 1,
      "roles": 65535,
      "current": 32000,
      "display_name": "Root",
      "username": "root",
      // null - Ein Passwort ist gesetzt, wird aber nicht zurückgegeben
      // -> Nutzer kann sich im Webinterface einloggen und die HTTP-API verwenden.
      "digest_hash": null
    },
    {
      "id": 3,
      "roles": 65535,
      "current": 32000,
      "display_name": "Benutzer 2",
      "username": "user2",
      // "" - kein Passwort gesetzt
      // -> Nutzer kann für die NFC-Freigabe und den Ladetracker verwendet werden
      //    kann sich aber nicht im Webinterface einloggen oder die HTTP-API verwenden.
      "digest_hash": ""
    }
  ],
  // Nutzer 2 und 4 wurden gelöscht.
  "next_user_id": 5,
  "http_auth_enabled": true
}

Name	Bedeutung
users object[17]	Die Benutzer [0..16] - Ein Benutzer Name Bedeutung id int ID des Benutzers (1-255) roles int Berechtigungen des Benutzers. Wird noch nicht verwendet. current int (mA) Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten display_name string Anzeigename des Benutzers. Wird auch im Ladetracker verwendet. username string Nutzername zum Anmelden im Webinterface und der HTTP-API. digest_hash string HTTP-Digest-Hash. Wird als leerer String zurückgegeben, falls die Anmeldung für diesen Nutzer deaktiviert ist. Wird als null zurückgegeben wenn die Anmeldung für diesen Nutzer aktiviert ist.
next_user_id int	ID des nächsten anzulegenden Nutzers.
http_auth_enabled bool	Gibt an ob zur Verwendung von Webinterface und HTTP-API Zugangsdaten nötig sein sollen. true - Falls Zugangsdaten verlangt werden sollen. false - Wenn nicht.

users/add

Fügt einen neuen Benutzer hinzu.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/users/add -d '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/add -m '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

Name	Bedeutung
id int	ID des anzulegenden Nutzers. Muss dem aktuellen Wert von next_user_id aus users/config entsprechen.
roles int	Berechtigungen des Benutzers. Wird noch nicht verwendet.
current int (mA)	Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten
display_name string	Anzeigename des Benutzers. Wird auch im Ladetracker verwendet.
username string	Nutzername zum Anmelden im Webinterface und der HTTP-API.
digest_hash string	HTTP-Digest-Hash des anzulegenden Nutzers. Ein leerer String verbietet das Anmelden im Webinterface.

users/remove

Löscht einen Benutzer.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/users/remove -d '{ "id": 4 }'

oder abgekürzt:

curl http://$HOST/users/remove -d '4'

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '{ "id": 4 }'

oder abgekürzt:

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '4'

Name	Bedeutung
id int	ID des zu löschenden Nutzers

users/modify

Modifiziert einen Benutzer.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/users/modify -d '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/modify -m '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

Name	Bedeutung
id int	ID des zu modifizierenden Nutzers.
roles int	Berechtigungen des Benutzers. Wird noch nicht verwendet.
current int (mA)	Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten
display_name string	Anzeigename des Benutzers. Wird auch im Ladetracker verwendet.
username string	Nutzername zum Anmelden im Webinterface und der HTTP-API.
digest_hash string	HTTP-Digest-Hash des Nutzers. Ein leerer String verbietet das Anmelden im Webinterface.

users/http_auth_update

Schreibt http_auth_enabled aus users/config.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/users/http_auth_update -d '{ "enabled": false }'

oder abgekürzt:

curl http://$HOST/users/http_auth_update -d 'false'

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m '{ "enabled": false }'

oder abgekürzt:

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m 'false'

Name	Bedeutung
enabled bool	Legt fest ob zur Verwendung von Webinterface und HTTP-API Zugangsdaten nötig sein sollen. true - Falls Zugangsdaten verlangt werden sollen. false - Wenn nicht.

users/all_usernames

HTTP (curl)

Für das Ladetracking werden die Anzeigenamen gelöschter Benutzer separat im Flash gespeichert. Diese Funktion gibt alle Anzeigenamen, die möglicherweise in den getrackten Ladevorgängen vorkommen in einem Binärformat aus.

MQTT (mosquitto)

Wird nur von der HTTP-API unterstützt

warp2

users/config

Die Benutzerkonfiguration. Kann mit users/add, users/modify, users/remove und users/http_auth_update aktualisiert werden.

Beispiel

HTTP (curl)

# $HOST z.B. warp2-AbCd

Lesen

curl http://$HOST/users/config

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/users/config

{
  "users": [
    {
      "id": 0,
      "roles": 4294967295,
      "current": 32000,
      // Wird vom Webinterface durch "Unbekannter Benutzer" ersetzt.
      "display_name": "Anonymous",
      "username": "anonymous",
      "digest_hash": ""
    },
    {
      "id": 1,
      "roles": 65535,
      "current": 32000,
      "display_name": "Root",
      "username": "root",
      // null - Ein Passwort ist gesetzt, wird aber nicht zurückgegeben
      // -> Nutzer kann sich im Webinterface einloggen und die HTTP-API verwenden.
      "digest_hash": null
    },
    {
      "id": 3,
      "roles": 65535,
      "current": 32000,
      "display_name": "Benutzer 2",
      "username": "user2",
      // "" - kein Passwort gesetzt
      // -> Nutzer kann für die NFC-Freigabe und den Ladetracker verwendet werden
      //    kann sich aber nicht im Webinterface einloggen oder die HTTP-API verwenden.
      "digest_hash": ""
    }
  ],
  // Nutzer 2 und 4 wurden gelöscht.
  "next_user_id": 5,
  "http_auth_enabled": true
}

Name	Bedeutung
users object[33]	Die Benutzer [0..32] - Ein Benutzer Name Bedeutung id int ID des Benutzers (1-255) roles int Berechtigungen des Benutzers. Wird noch nicht verwendet. current int (mA) Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten display_name string Anzeigename des Benutzers. Wird auch im Ladetracker verwendet. username string Nutzername zum Anmelden im Webinterface und der HTTP-API. digest_hash string HTTP-Digest-Hash. Wird als leerer String zurückgegeben, falls die Anmeldung für diesen Nutzer deaktiviert ist. Wird als null zurückgegeben wenn die Anmeldung für diesen Nutzer aktiviert ist.
next_user_id int	ID des nächsten anzulegenden Nutzers.
http_auth_enabled bool	Gibt an ob zur Verwendung von Webinterface und HTTP-API Zugangsdaten nötig sein sollen. true - Falls Zugangsdaten verlangt werden sollen. false - Wenn nicht.

users/add

Fügt einen neuen Benutzer hinzu.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp2-AbCd

Schreiben

curl http://$HOST/users/add -d '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/add -m '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

Name	Bedeutung
id int	ID des anzulegenden Nutzers. Muss dem aktuellen Wert von next_user_id aus users/config entsprechen.
roles int	Berechtigungen des Benutzers. Wird noch nicht verwendet.
current int (mA)	Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten
display_name string	Anzeigename des Benutzers. Wird auch im Ladetracker verwendet.
username string	Nutzername zum Anmelden im Webinterface und der HTTP-API.
digest_hash string	HTTP-Digest-Hash des anzulegenden Nutzers. Ein leerer String verbietet das Anmelden im Webinterface.

users/remove

Löscht einen Benutzer.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp2-AbCd

Schreiben

curl http://$HOST/users/remove -d '{ "id": 4 }'

oder abgekürzt:

curl http://$HOST/users/remove -d '4'

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '{ "id": 4 }'

oder abgekürzt:

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '4'

Name	Bedeutung
id int	ID des zu löschenden Nutzers

users/modify

Modifiziert einen Benutzer.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp2-AbCd

Schreiben

curl http://$HOST/users/modify -d '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/modify -m '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

Name	Bedeutung
id int	ID des zu modifizierenden Nutzers.
roles int	Berechtigungen des Benutzers. Wird noch nicht verwendet.
current int (mA)	Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten
display_name string	Anzeigename des Benutzers. Wird auch im Ladetracker verwendet.
username string	Nutzername zum Anmelden im Webinterface und der HTTP-API.
digest_hash string	HTTP-Digest-Hash des Nutzers. Ein leerer String verbietet das Anmelden im Webinterface.

users/http_auth_update

Schreibt http_auth_enabled aus users/config.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp2-AbCd

Schreiben

curl http://$HOST/users/http_auth_update -d '{ "enabled": false }'

oder abgekürzt:

curl http://$HOST/users/http_auth_update -d 'false'

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp2/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m '{ "enabled": false }'

oder abgekürzt:

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m 'false'

Name	Bedeutung
enabled bool	Legt fest ob zur Verwendung von Webinterface und HTTP-API Zugangsdaten nötig sein sollen. true - Falls Zugangsdaten verlangt werden sollen. false - Wenn nicht.

users/all_usernames

HTTP (curl)

Für das Ladetracking werden die Anzeigenamen gelöschter Benutzer separat im Flash gespeichert. Diese Funktion gibt alle Anzeigenamen, die möglicherweise in den getrackten Ladevorgängen vorkommen in einem Binärformat aus.

MQTT (mosquitto)

Wird nur von der HTTP-API unterstützt

warp3

users/config

Die Benutzerkonfiguration. Kann mit users/add, users/modify, users/remove und users/http_auth_update aktualisiert werden.

Beispiel

HTTP (curl)

# $HOST z.B. warp3-AbCd

Lesen

curl http://$HOST/users/config

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/users/config

{
  "users": [
    {
      "id": 0,
      "roles": 4294967295,
      "current": 32000,
      // Wird vom Webinterface durch "Unbekannter Benutzer" ersetzt.
      "display_name": "Anonymous",
      "username": "anonymous",
      "digest_hash": ""
    },
    {
      "id": 1,
      "roles": 65535,
      "current": 32000,
      "display_name": "Root",
      "username": "root",
      // null - Ein Passwort ist gesetzt, wird aber nicht zurückgegeben
      // -> Nutzer kann sich im Webinterface einloggen und die HTTP-API verwenden.
      "digest_hash": null
    },
    {
      "id": 3,
      "roles": 65535,
      "current": 32000,
      "display_name": "Benutzer 2",
      "username": "user2",
      // "" - kein Passwort gesetzt
      // -> Nutzer kann für die NFC-Freigabe und den Ladetracker verwendet werden
      //    kann sich aber nicht im Webinterface einloggen oder die HTTP-API verwenden.
      "digest_hash": ""
    }
  ],
  // Nutzer 2 und 4 wurden gelöscht.
  "next_user_id": 5,
  "http_auth_enabled": true
}

Name	Bedeutung
users object[33]	Die Benutzer [0..32] - Ein Benutzer Name Bedeutung id int ID des Benutzers (1-255) roles int Berechtigungen des Benutzers. Wird noch nicht verwendet. current int (mA) Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten display_name string Anzeigename des Benutzers. Wird auch im Ladetracker verwendet. username string Nutzername zum Anmelden im Webinterface und der HTTP-API. digest_hash string HTTP-Digest-Hash. Wird als leerer String zurückgegeben, falls die Anmeldung für diesen Nutzer deaktiviert ist. Wird als null zurückgegeben wenn die Anmeldung für diesen Nutzer aktiviert ist.
next_user_id int	ID des nächsten anzulegenden Nutzers.
http_auth_enabled bool	Gibt an ob zur Verwendung von Webinterface und HTTP-API Zugangsdaten nötig sein sollen. true - Falls Zugangsdaten verlangt werden sollen. false - Wenn nicht.

users/add

Fügt einen neuen Benutzer hinzu.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp3-AbCd

Schreiben

curl http://$HOST/users/add -d '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/add -m '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

Name	Bedeutung
id int	ID des anzulegenden Nutzers. Muss dem aktuellen Wert von next_user_id aus users/config entsprechen.
roles int	Berechtigungen des Benutzers. Wird noch nicht verwendet.
current int (mA)	Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten
display_name string	Anzeigename des Benutzers. Wird auch im Ladetracker verwendet.
username string	Nutzername zum Anmelden im Webinterface und der HTTP-API.
digest_hash string	HTTP-Digest-Hash des anzulegenden Nutzers. Ein leerer String verbietet das Anmelden im Webinterface.

users/remove

Löscht einen Benutzer.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp3-AbCd

Schreiben

curl http://$HOST/users/remove -d '{ "id": 4 }'

oder abgekürzt:

curl http://$HOST/users/remove -d '4'

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '{ "id": 4 }'

oder abgekürzt:

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '4'

Name	Bedeutung
id int	ID des zu löschenden Nutzers

users/modify

Modifiziert einen Benutzer.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp3-AbCd

Schreiben

curl http://$HOST/users/modify -d '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/modify -m '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

Name	Bedeutung
id int	ID des zu modifizierenden Nutzers.
roles int	Berechtigungen des Benutzers. Wird noch nicht verwendet.
current int (mA)	Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten
display_name string	Anzeigename des Benutzers. Wird auch im Ladetracker verwendet.
username string	Nutzername zum Anmelden im Webinterface und der HTTP-API.
digest_hash string	HTTP-Digest-Hash des Nutzers. Ein leerer String verbietet das Anmelden im Webinterface.

users/http_auth_update

Schreibt http_auth_enabled aus users/config.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp3-AbCd

Schreiben

curl http://$HOST/users/http_auth_update -d '{ "enabled": false }'

oder abgekürzt:

curl http://$HOST/users/http_auth_update -d 'false'

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp3/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m '{ "enabled": false }'

oder abgekürzt:

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m 'false'

Name	Bedeutung
enabled bool	Legt fest ob zur Verwendung von Webinterface und HTTP-API Zugangsdaten nötig sein sollen. true - Falls Zugangsdaten verlangt werden sollen. false - Wenn nicht.

users/all_usernames

HTTP (curl)

Für das Ladetracking werden die Anzeigenamen gelöschter Benutzer separat im Flash gespeichert. Diese Funktion gibt alle Anzeigenamen, die möglicherweise in den getrackten Ladevorgängen vorkommen in einem Binärformat aus.

MQTT (mosquitto)

Wird nur von der HTTP-API unterstützt

wem

Auf dieser Hardware nicht unterstützt!

any

users/config

Die Benutzerkonfiguration. Kann mit users/add, users/modify, users/remove und users/http_auth_update aktualisiert werden.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Lesen

curl http://$HOST/users/config

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Lesen

mosquitto_sub -v -C 1 -h $BROKER -t $PREFIX/users/config

{
  "users": [
    {
      "id": 0,
      "roles": 4294967295,
      "current": 32000,
      // Wird vom Webinterface durch "Unbekannter Benutzer" ersetzt.
      "display_name": "Anonymous",
      "username": "anonymous",
      "digest_hash": ""
    },
    {
      "id": 1,
      "roles": 65535,
      "current": 32000,
      "display_name": "Root",
      "username": "root",
      // null - Ein Passwort ist gesetzt, wird aber nicht zurückgegeben
      // -> Nutzer kann sich im Webinterface einloggen und die HTTP-API verwenden.
      "digest_hash": null
    },
    {
      "id": 3,
      "roles": 65535,
      "current": 32000,
      "display_name": "Benutzer 2",
      "username": "user2",
      // "" - kein Passwort gesetzt
      // -> Nutzer kann für die NFC-Freigabe und den Ladetracker verwendet werden
      //    kann sich aber nicht im Webinterface einloggen oder die HTTP-API verwenden.
      "digest_hash": ""
    }
  ],
  // Nutzer 2 und 4 wurden gelöscht.
  "next_user_id": 5,
  "http_auth_enabled": true
}

Name	Bedeutung
users object[..]	Die Benutzer WARP 1: [0..16] - Ein Benutzer Name Bedeutung id int ID des Benutzers (1-255) roles int Berechtigungen des Benutzers. Wird noch nicht verwendet. current int (mA) Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten display_name string Anzeigename des Benutzers. Wird auch im Ladetracker verwendet. username string Nutzername zum Anmelden im Webinterface und der HTTP-API. digest_hash string HTTP-Digest-Hash. Wird als leerer String zurückgegeben, falls die Anmeldung für diesen Nutzer deaktiviert ist. Wird als null zurückgegeben wenn die Anmeldung für diesen Nutzer aktiviert ist. WARP 2 und WARP 3 und Energy Manager: [0..32] - Ein Benutzer Name Bedeutung id int ID des Benutzers (1-255) roles int Berechtigungen des Benutzers. Wird noch nicht verwendet. current int (mA) Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten display_name string Anzeigename des Benutzers. Wird auch im Ladetracker verwendet. username string Nutzername zum Anmelden im Webinterface und der HTTP-API. digest_hash string HTTP-Digest-Hash. Wird als leerer String zurückgegeben, falls die Anmeldung für diesen Nutzer deaktiviert ist. Wird als null zurückgegeben wenn die Anmeldung für diesen Nutzer aktiviert ist.
next_user_id int	ID des nächsten anzulegenden Nutzers.
http_auth_enabled bool	Gibt an ob zur Verwendung von Webinterface und HTTP-API Zugangsdaten nötig sein sollen. true - Falls Zugangsdaten verlangt werden sollen. false - Wenn nicht.

users/add

Fügt einen neuen Benutzer hinzu.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/users/add -d '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/add -m '{
    "id": 5,
    "roles": 65535,
    "current": 32000,
    "display_name": "Neuer Benutzer",
    "username": "testuser",
    "digest_hash": "926011006c2686471698e86690b7e500"
  }'

id muss der next_user_id aus users/config entsprechen, damit der Nutzer angelegt wird. digest_hash = MD5("testuser:esp32-lib:testpass")

Name	Bedeutung
id int	ID des anzulegenden Nutzers. Muss dem aktuellen Wert von next_user_id aus users/config entsprechen.
roles int	Berechtigungen des Benutzers. Wird noch nicht verwendet.
current int (mA)	Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten
display_name string	Anzeigename des Benutzers. Wird auch im Ladetracker verwendet.
username string	Nutzername zum Anmelden im Webinterface und der HTTP-API.
digest_hash string	HTTP-Digest-Hash des anzulegenden Nutzers. Ein leerer String verbietet das Anmelden im Webinterface.

users/remove

Löscht einen Benutzer.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/users/remove -d '{ "id": 4 }'

oder abgekürzt:

curl http://$HOST/users/remove -d '4'

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '{ "id": 4 }'

oder abgekürzt:

mosquitto_pub -h $BROKER -t $PREFIX/users/remove -m '4'

Name	Bedeutung
id int	ID des zu löschenden Nutzers

users/modify

Modifiziert einen Benutzer.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/users/modify -d '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/modify -m '{
    "id": 5,
    "roles": null,
    "current": null,
    "display_name": "Neuer Benutzer (ohne Login)",
    "username": null,
    "digest_hash": ""
  }'

Ändert beispielsweise nur den Anzeigenamen vom Benutzer mit der ID 5 und löscht dessen Passwort. Dieser Nutzer kann sich dann nicht mehr im Webinterface einloggen oder die HTTP-API verwenden.

Name	Bedeutung
id int	ID des zu modifizierenden Nutzers.
roles int	Berechtigungen des Benutzers. Wird noch nicht verwendet.
current int (mA)	Diesem Benutzer erlaubter Ladestrom 6000 (=6 Ampere) bis 32000 (=32 Ampere) oder 0 um diesem Nutzer das Laden zu verbieten
display_name string	Anzeigename des Benutzers. Wird auch im Ladetracker verwendet.
username string	Nutzername zum Anmelden im Webinterface und der HTTP-API.
digest_hash string	HTTP-Digest-Hash des Nutzers. Ein leerer String verbietet das Anmelden im Webinterface.

users/http_auth_update

Schreibt http_auth_enabled aus users/config.

http

mqtt

Löst eine einmalige Aktion aus. Nachrichten, die über den Broker retained wurden, werden ignoriert.

Beispiel

HTTP (curl)

# $HOST z.B. warp-AbCd

Schreiben

curl http://$HOST/users/http_auth_update -d '{ "enabled": false }'

oder abgekürzt:

curl http://$HOST/users/http_auth_update -d 'false'

MQTT (mosquitto)

# $BROKER z.B. my_mosquitto.localdomain
# $PREFIX z.B. warp/AbCd

Schreiben

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m '{ "enabled": false }'

oder abgekürzt:

mosquitto_pub -h $BROKER -t $PREFIX/users/http_auth_update -m 'false'

Name	Bedeutung
enabled bool	Legt fest ob zur Verwendung von Webinterface und HTTP-API Zugangsdaten nötig sein sollen. true - Falls Zugangsdaten verlangt werden sollen. false - Wenn nicht.

users/all_usernames

HTTP (curl)

Für das Ladetracking werden die Anzeigenamen gelöschter Benutzer separat im Flash gespeichert. Diese Funktion gibt alle Anzeigenamen, die möglicherweise in den getrackten Ladevorgängen vorkommen in einem Binärformat aus.

MQTT (mosquitto)

Wird nur von der HTTP-API unterstützt