Webservice

ALGEMEEN

• Web Service Commando’s ondersteunen zowel interne als externe toegang.
• De huidige Miniserver ondersteunt ook HTTPS.

De structuur van een webservice commando is als volgt
http(s)://User:Password@IPAdressMiniserver/command/control/value

Daarom moeten bij gebruik van HTTP (Miniserver Gen.1) de toegangsgegevens voorlopig worden weggelaten wanneer in de adresregel een opdracht wordt ingevoerd.

De toegangsgegevens worden dan opgevraagd via een venster in de browser::

Sommige commando’s vereisen de toegangsgegevens van een gebruiker met volledige toegang.

Vervolgens wordt het commando uitgevoerd en wordt het resultaat in de browser weergegeven.
In het volgende voorbeeld zien we de huidige softwareversie van de miniserver:

Structuur in detail

• control: kan elke ingang of uitgang zijn, echt of virtueel. Uitgangen kunnen alleen worden gebruikt voor statusverzoeken.
• value: wanneer ‘waarde’ niet beschikbaar is, wordt de huidige controlewaarde geretourneerd.
  • De volgende waarden zijn toegestaan voor digitale waarden:
    • “Ein“, “On“, “Aus“, “Off“, “1“, “0“, “Impuls” of “Pulse“.
• Virtuele digitale ingangen met 2 uitgangen (omhoog-omlaag, links-rechts, vanaf versie 1.5.4.16), de volgende waarden zijn toegestaan.

• • De volgende waarden zijn toegestaan voor analoge ingangen:
    • (0-10V) ingangen werken binnen een bereik van 0 tot 10.00.
    • Er is geen formele limiet (bijvoorbeeld temperaturen van 21.5 of -5.2 zijn geldig).
    • Een punt (.) wordt gebruikt als decimale scheidingsteken.
  • De volgende waarden zijn toegestaan voor tekstinvoeren:
    • De Miniserver werkt met UTF-8, dus elk teken dat door UTF-8 wordt ondersteund, zou correct moeten werken.

Voorbeeld – Pulse

Voordat je een impuls naar het systeem stuurt, heeft je Miniserver een Virtuele ingang nodig die het commando accepteert.

Nu, zodra we onze Virtuele Ingang hebben toegevoegd en opgeslagen in de Miniserver, moet het commando worden verstuurd. Hieronder een voorbeeld van een 3e partij applicatie* die een impulscommando naar de Loxone Miniserver stuurt:

In dit voorbeeld hebben we de standaard referenties (gebruikersnaam: admin, wachtwoord: admin) en de virtuele ingang in het commando die de naam ‘Test Input’ heeft. Door op de knop ‘Send’ te drukken, zal de string het IP-adres gebruiken om de Miniserver in het netwerk te vinden, in te loggen en vervolgens het commando te verwerken.

Als het verzendcommando wordt geaccepteerd, zal het geretourneerde antwoord in XML-formaat zijn:

Je zult ook in Loxone Config zien dat de Virtuele Ingang een split second oplicht als ‘Live View’ actief is: 

*In deze voorbeelden wordt Postman gebruikt als de 3e partij app die de commando’s verstuurt.

STATUS EN CONTROLE

QUERY: STATUS VAN EEN BESTURINGSELEMENT

Statusopvraging via webservice is alleen mogelijk bij in- en uitgangen, niet bij bouwstenen.

Drukknop

Voorbeeld – Drukknop

Voordat een commando naar het systeem wordt verzonden, heeft je Miniserver een Drukknop functiebouwsteen nodig dat het commando accepteert.

Nu we de Drukknop hebben toegevoegd en opgeslagen op de Miniserver, moet het commando worden verzonden. Hieronder staat een voorbeeld van een externe applicatie* die een ‘On’-commando naar de Loxone Miniserver stuurt:

In dit voorbeeld hebben we de standaard referenties (gebruikersnaam: admin, wachtwoord: admin) en de Drukknop in het commando met de naam ‘Push-Button’. Door op de knop ‘Send’ te drukken, zal de string het IP-adres gebruiken om de Miniserver op het netwerk te vinden, in te loggen en het commando te verwerken. We kunnen het laatste deel van het commando aanpassen naar ‘On’ of ‘Off’, afhankelijk van de situatie.

Als het verzonden commando wordt geaccepteerd, is de geretourneerde reactie in XML-formaat:

Code “200” betekent dat het commando werd geaccepteerd en verwerkt.

Je zult ook zien dat de Drukknop in de Loxone App/Webinterface van staat verandert, afhankelijk van welk commando wordt verzonden (aan/uit).

*In dit voorbeeld wordt Postman gebruikt als externe applicatie om de commando’s te versturen.

QUERY: STATUSWIJZIGINGEN

Miniserver Configuratie, Statistieken & Commando’s

De volgende commando’s bieden systeemcontrole, PLC commando’s, netwerkstatistieken en configuratie commando’s voor de Miniserver.

1. PLC Commando’s (Programmable Logic Controller)

Deze commando’s stellen je in staat om het PLC-systeem te monitoren en te bedienen.

2. Configuratie Commando’s

Deze commando’s stellen je in staat om Miniserver-instellingen op te halen of te wijzigen.

3. Commando’s voor systeembewaking

Deze commando’s bieden informatie over de systeemprestaties en statistieken.

4. Datum- en tijdbeheer

Beheer systeemdatum- en tijdinstellingen.

5. Taakbewaking

Haal status en eigenschappen van systeemtaken op.

6. Systeembeheer en Bestandsbeheer

Deze commando’s maken het mogelijk om de Miniserver opnieuw op te starten en systeembestanden te beheren.

7. Systeemlogboeken en Statistieken

Haal logboeken en systeemsgegevens op.

8. Externe Webservice-uitvoering

Stuur webservice-aanvragen naar externe apparaten.

Commando’s voor Apparaten

Extensions

De volgende commando’s zijn van toepassing op Extensions.

Om ze uit te voeren, is een gebruiker met volledige toegangsrechten vereist.

Tree en Air Apparaten

De volgende commando’s zijn van toepassing op specifieke Air of Tree apparaten.

Om ze uit te voeren, is een gebruiker met volledige toegangsrechten vereist.

Gebruik van de Miniserver Webinterface in een iFrame

Standaard staat de Miniserver om veiligheidsredenen insluiting in een iFrame niet toe. Als u deze functionaliteit wilt inschakelen, moet u dit expliciet toestaan met het volgende webservicecommando:

http://<miniserver-ip>/dev/sys/allowhttpiframe/1