Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Productstyle icon link In te stellen onderdelen

REST API-koppeling

Voor elk apparaat dat met de Octalarm alarmmelder communiceert, stelt u een koppeling in. De REST API communiceert via periodieke watchdog-aanvragen. Geeft het externe apparaat geen reactie op deze aanvragen via Octalarm Link, dan ontvangt de ingestelde oproeplijst of servicegroep een watchdog-systeemstoring.

Locatie(s) en categorieën per locatie

U maakt één of meer locaties aan om alarmen per locatie of groep gericht af te handelen. Binnen deze locaties verdeelt u alarmen over verschillende categorieën.

U kunt locaties en categorieën op twee manieren beheren:

  1. MinimalConfig: locaties en categorieën automatisch beheren
    Met één API-methode maakt, wijzigt of verwijdert u locaties en categorieën. Dit is handig voor externe apparaten zoals PLC's, waarbij het niet mogelijk is om diverse API-calls handmatig in te stellen.

    Goed om te weten: werkt u met MinimalConfig? Dan voegt het systeem locaties en categorieën automatisch toe. U kunt deze stappen dan overslaan.

  2. CRUD: Create, Read, Update en Delete
    Kan uw externe apparaat werken met CRUD-bewerkingen? Maak dan gebruik van deze communicatie met de Touch Pro of ARA.

    Let op: met de CRUD-methode voegt u zelf locaties en categorieën toe. De benodigde API's vindt u bij Locaties en Categorieën.

Ingebruikname: stap voor stap

Tip: volg de volgorde van dit hoofdstuk voor een snelle en foutloze ingebruikname van de REST API. We leggen met een praktijkvoorbeeld uit:

  1. welke algemene methoden en responsen u gebruikt;

  2. hoe u de REST API koppelt, de locaties en categorieën implementeert via MinimalConfig of CRUD: Locaties | Categorieën;

  3. hoe u alarmmeldingen via de REST API start;

  4. hoe u de instellingen van de melder controleert.

Situatieschets praktijkvoorbeeld

In een kas met tomaten- en paprikateelt regelt een procescomputer klimaat, irrigatie en energie. Deze klimaatcomputer communiceert via de REST API met de Octalarm alarmmelder. Om alarmen per locatie anders af te handelen, maakt u verschillende locaties aan. U verdeelt de alarmen per locatie in teeltalarmen (urgent/niet-urgent) en technische alarmen (urgent/niet-urgent).

Image REST API voorbeeld