xREL – ReadMe

ÜBERSICHT   –   FREISCHALTUNG  –   SCREENSHOTS

 

  1. Funktionsumfang
  2. Systemanforderungen
  3. Installation
  4. Befehlsreferenz

 

1. Funktionsumfang

Dieses Modul liest zyklisch die Informationen aus xREL aus. Außerdem kann man über eine Funktionen auf
die Daten zugreifen und die Daten werden in einer HTML-Tabelle im WebFront dargestellt. Zusätzlich
steht im WebFront eine Suchmaske zur Release-Suche zur Verfügung. Für Skripte gibt es ebenfalls
einige Funktionen (siehe Befehlsreferenz).

Einstellungsmöglichkeiten in der Instanz:

  • Release-Kategorie (für jede Kategorie muss eine eigene Modul-Instanz angelegt werden)
  • Release-Anzahl
  • Intervall zur Aktualisierung
  • Hintergrundfarbe (im HEX Format)
  • Schriftfarbe Titel (im HEX Format)
  • Schriftgröße Titel
  • Schriftfarbe Text (im HEX Format)
  • Schriftgröße Text

Die API von xREL hat folgende Limitierungen:

  • 300 API-Aufrufe je Stunde (Übersichten zu aktuellen Releases)
  • 2 Abfragen pro je Sekunden bei API-Suchanfragen (Detailinfos zu Releases)

 

2. Systemanforderungen

  • IP-Symcon ab Version 4.x

 

3. Installation

Über die Kern-Instanz „Module Control“ folgende URL hinzufügen:

https://GITLAB-BENUTZERNAME:GITLAB-PASSWORT@gitlab.com/BY-IPS-Module/xREL.git
Die neue Instanz findet ihr dort, wo ihr sie angelegt habt.

 

4. Befehlsreferenz

$result = xREL_Update($InstanzID);
Aktualisiert die Daten von xREL (aus der gewählten Kategorie) in der HTMLBox-Variable und gibt die Informationen als Array zurück.

$result = xREL_ReleaseInfo($InstanzID, string $ReleaseName);
Holt Informationen zu einem Release von xREL und gibt diese als Array zurück.

$result = xREL_ReleaseExtendedInfo(string $ReleaseID);
Holt detailierte Informationen zu einem Release von xREL und gibt diese als Array zurück.
Die Release-ID bekommt man über die Funktion „xREL_ReleaseInfo“.

$result = xREL_SearchReleases(string $Suchstring, boolean $Scene_Releases, boolean $P2P_Releases);
Sucht bei xREL nach Releases zum eingegebenen Suchbegriff (auch mehrere Wörter erlaubt) und gibt die Informationen in einer
HTMLBox-Variable aus und als Array zurück. Die Suche kann auf Scene-Releases und/oder P2P-Releases eingeschränkt werden.