API

Die Time2Emphasize App erzeugt automatisch einen API-Key, der bei Verbindungen verwendet wird. Im folgenden ist dieser mit <customer> auszutauschen.

Ändern der Sprache

Die Time2Emphasize App öffnet sich in der Sprache, die auf dem Gerät erkannt und unterstützt wird. Über folgende Links kann die Sprache geändert werden in:

Export, Import und Zurücksetzen

In der Time2Emphasize App können Aufteilung (im JSON Format) und alle Erfassungen (im CSV Format) in dem Dialog "Export, Import und Zurücksetzen" exportiert (ein Backup anlegen) und importiert (ein Backup wieder einspielen) werden. Alle bisherigen Erfassungen können zudem bereinigt werden (Zurücksetzen durch Löschung).

Zurücksetzen aller Einstellungen

Die Time2Emphasize App kann über folgenden Link in ihren initialen Auslieferungszustand zurückgesetzt werden:

https://time2.emphasize.de?a=reset

Vorsicht: dies löscht die Feldaufteilung und alle erfassten Zeitdaten auf dem Gerät!

Verbindungen anlegen

Verbindungen können alternativ zu dem Öffnen der unten beschriebenen Links auch manuell im Dialog über Menü unter "Verbindungen" konfiguriert werden.

Verbindungen Dialog

Aktivitäten z.B. über Einscannen von QRCodes empfangen

https://time2.emphasize.de?m=e

Druckt man die Seite (Strg + P), wird eine Liste aller QRCodes ausgedruckt.

In der Toolbar erscheint mode qrcode der QRCode Modus, der alle QRCodes in den Feldern anzeigt. Die QRCode-Bilder haben zudem den Link hinterlegt. Kopiert man diesen Link, bekommt man den <channel> heraus, der im folgenden einzusetzen ist:

Figur setzen

GET https://time2.emphasize.de/connect/<channel>/push/<feldName>/<feldFarbe>

wobei /<feldFarbe> optional ist.

Figur absetzen

GET https://time2.emphasize.de/connect/<channel>/off

Info eintragen

GET https://time2.emphasize.de/connect/<channel>/info/<infoText>

Verbindung mit einem weiteren Gerät

https://time2.emphasize.de?m=a

Anschließend im Dialog über Menü unter "Verbindungen" den Link kopieren und diesen auf dem anderen Gerät öffnen. Ggf. das andere Gerät vorher Zurücksetzen.

Verbindung für einen Zuschauer

https://time2.emphasize.de?m=v

Anschließend im Dialog über Menü unter "Verbindungen" den Link kopieren und diesen dem Zuschauer zusenden. Öffnet der Zuschauer den Link, sieht er die Feldaufteilung und die jeweils aktuelle Position der Figur ohne selbst Änderungen vornehmen zu können.

Verbindung für eine Statusanzeige

https://time2.emphasize.de?m=p

Anschließend im Dialog über Menü unter "Verbindungen" den HTML Quellcode kopieren und in einer Webseite einfügen, um den aktuellen Status öffentlich zu Teilen.

time2emphasize-badge

Dabei können auch mehrere unterschiedliche Statusanzeigen von unterschiedlichen Time2Emphasize Instanzen eingebunden werden, dazu den <script>...</script> Teil nur einmal (am Ende vor dem schließenden Body Tag) einfügen. Ein Beispiel hierzu:

<!DOCTYPE html>
<html>
  <body>
    Person A Status:
    <a data-channel="y89h2je1vs" href="https://www.emphasize.de" title="free time-reporting tool" class="time2-badge"> Time2Emphasize <span class="time2-event">time-reporting tool</span></a>
    und Person B Status:
    <a data-channel="a9110wvv67" href="https://www.emphasize.de" title="free time-reporting tool" class="time2-badge"> Time2Emphasize <span class="time2-event">time-reporting tool</span></a>

    <script>...</script>
  </body>
</html>

Verbindung mit einem Speicherort

https://time2.emphasize.de?m=s&c=<customer>&d=<url>

Download zur Einrichtung eines Speicherort Servers: ZIP

Voraussetzung: Nginx, PHP und PDO-SQLite/-MySql verfügbar! Zum Prüfen der Voraussetzungen und ermitteln der <url> folgende Seite dann öffnen:

<url>/check_pdo.php

check_pdo.php kann anschließend vom Server entfernt werden.

Figur setzen

POST <url>/?topic=<customer>
PAYLOAD [{"s": %CURRENT_TIMESTAMP%, "n": "field name", "c": "#ffab11"}]

Die Feldbezeichnung "field name" und die Farbe "#ffab11" sind durch die Werte des entsprechenden, sichtbaren Feldes zu ersetzen.

Weiterführende Anmerkungen: 1

Figur absetzen

Das Absetzen der Figur vom Spielfeld erfolgt durch Begrenzen (im Beispiel unten der "e"-Wert) des vorherigen Feld setzen Ereignisses.

POST <url>/?topic=<customer>
PAYLOAD [{"s": 1704270072000, "n": "field name", "c": "#ffab11", "e": %CURRENT_TIMESTAMP%}]

Weiterführende Anmerkungen: 1

Info eintragen

POST <url>/?topic=<customer>
PAYLOAD [{"s": %CURRENT_TIMESTAMP%, "i": "some info"}]

Weiterführende Anmerkungen: 1

Feld Aufteilung setzen

POST <url>/?topic=<customer>
PAYLOAD [{"v":"2","format":"time.emphasize","r":{"s":[{"s":[{"n":"one","c":"#4aff00"},{"n":"two","c":"#ffaa11"}],"l":"h"},{"n":"three","c":"#308a11"}],"l":"v"}}]

Das Beispiel setzt eine Aufteilung mit 3 Feldern "one", "two" und "three".

Beispiel Aufteilung

Rechnungen erstellen

Über das Menü unter "Rechnungen erstellen" öffnet sich die Ansicht, um Rechnungen zu erzeugen. Die erzeugten Rechnungen sind ZUGFeRD (PDF mit XML-Anhang) kompatibel und können z.B. hier validiert werden.

Die Ansicht kann auch ohne die Zeiterfassung genutzt werden - wenn jedoch beides verwendet wird, können die Positionen der Rechnung automatisch aus den erfassten Zeit kommen!

Rechnung mit Positionen

Im unteren Bereich ist eine Leiste, welche die Eingabe der Rechnungsnummer zeigt und Symbole, über die weitere Eingabeseiten geöffnet werden können. Diese Leiste ist unter Umständen vertikal scrollbar, wenn der Anzeigebereich nicht breit genug ist:

Rechnungen Leiste ist unter Umständen scrollbar

Klickt man auf den Button "RECHNUNG GENERIEREN" öffnet sich bei fehlenden, wichtigen Eingaben einen Dialog, in dem diese beschrieben sind. Eine der betreffenden Eingabeseiten wird geöffnet, in der das entsprechende Eingabefeld dann rot umrandet ist. Sind alle Angaben vorhanden, wird das PDF generiert, angezeigt und kann gespeichert werden.

fehlende, wichtige Eingaben korrigieren

Die Eingabeseiten können auch ganz rechts in der Leiste über die Symbole geöffnet werden.

Eingabeseite für Verkäufer öffnen

Das Layout des Hauptbereichs und der Fußzeile können über das letzte Symbol geöffnet und bearbeitet werden. Neben der direkten Bearbeitung ist auch eine feinere Veränderung im Quellcode möglich.

Layout Code bearbeiten

Ist das Layout nicht mehr korrekt, kann man über den "Zurücksetzen" Button unterhalb des Eingabefeldes den initialen Stand wieder herstellen.

Layout Code zurücksetzen

Die Eingabedaten für generierte Rechnungen werden nur im Browser, bzw. auf dem Gerät gespeichert und können über die Auswahl im "Rechnungsnummer" Eingabefeld wieder geladen werden. Dann erscheint ein ⚠️ Symbol darin, welches warnt, dass die Rechnungsnummer bereits vorhanden ist. Klickt man auf das ⚠️ Symbol, wird automatisch eine bisher ungenutzte Rechnungsnummer generiert.

Alle Daten für bereits verwendete Kunden in der "Empfänger" Eingabeseite sind über die Auswahl im Feld "Name" schnell setzbar.

Die eingestellte Sprache wirkt sich ebenfalls auf den initialen Stand aus. Über folgende Links ist die Sprache daher auch für die "Rechnungen erstellen" Ansicht, Beispielwerte und Layoutvorlagen veränderbar:


Fußnoten

  1. Anstatt %CURRENT_TIMESTAMP% kann auch ein bestimmter UnixTimestamp verwendet werden (GMT mit Millisekundenanteil), z.B. 1704270072000 für den 3.1.2024 morgens. 2 3