---

MQTT Broker – Configureren

Als er nog geen Domox of klant is geconfigureerd, volg dan eerste deze handleiding:

Als er nog geen Aritech Advanced paneel is geconfigureerd, volg dan eerste deze handleiding:

Aritech Advanced Alarm Configureren

 

MQTT device toevoegen aan de Domox

• Klik op Add Device :

 

• Selecteer MQTT Client/Broker :

 

• Configureer MQTT Broker/Client :

• Description (beschrijving van het MQTT apparaat).
• Selecteer Use Domox as MQTT broker (Domox start als deze is aangevinkt een MQTT broker bij het starten van de controller).
  De berichten die de Domox stuurt, worden namens een client verbinding verstuurt (Domox start een broker en een client)
• Broker IP / Hostname is 127.0.0.1 (lokale IP van de Domox controller  wordt automatisch ingevuld bij het aanvinken Domox as MQTT broker.
  MQTT clients verbinden met het IP adres van de Domox (het beste is om de Domox een fixed IP te geven via de router (op Mac adres).
• Broker port 1883 (standaard MQTT poort).
• Username (gebruikersnaam van de Domox broker voor toegang van externe MQTT clients).
• Password (gebruikersnaam van de Domox broker voor toegang van externe MQTT clients).
• MQTT ID (Alle berichten die Domox client naar de Domox broker stuurt worden namens dit ID verzonden)

MQTT koppelen met ATS Advanced

Alarm Areas (gebieden)

• Klik op devices → Alarm Areas → Alarm Area Discover :

• Klik op MQTT (status and control) → selecteer het MQTT device → Save (indien alle gebieden gekoppeld moeten worden):

Nu zijn alle gebieden voor status en control aan MQTT gekoppeld.
* Na Controls → Export to controller → Save pas doorgevoerd op de Domox controller.

MQTT topics – Area Status

Een ATS gebied heeft vele statussen, welke allemaal in een MQTT topic per gebied automatisch worden bijgewerkt.
Als een externe MQTT client met de Domox broker een verbinding maakt, zal van ieder gekoppeld gebied de huidige status in het bijbehorende topic worden bijgewerkt.

Topic van een status gebied 1 betreft: alarm/panel1Area1Status
De status van topic alarm/panel1Area1Status betreft een JSON object met daarin alle statussen van één gebied, zie voorbeeld hieronder:

{
“Id”: “returnSTAT.AREA”,
“objectID”: 1,
“AREV_AALARM”: false,
“AREV_ALARM”: false,
“AREV_ALARMACK”: false,
“AREV_AMRESET”: false,
“AREV_ATMDELAY”: false,
“AREV_ATMEXTTIME”: false,
“AREV_ATMTIME”: false,
“AREV_ATMWARNTIME”: false,
“AREV_AUTOARM”: false,
“AREV_BALARM”: false,
“AREV_BUZZER”: false,
“AREV_CODETAMPER”: false,
“AREV_DGPFAULT”: false,
“AREV_DGPTAMPER”: false,
“AREV_DOORBELL”: false,
“AREV_DURESS”: false,
“AREV_ENTRY”: false,
“AREV_ESIREN”: false,
“AREV_EXIT”: false,
“AREV_EXITFAULT”: false,
“AREV_FAULTACK”: false,
“AREV_FIRE”: false,
“AREV_FIREDOOR”: false,
“AREV_FIRERESET”: false,
“AREV_FSALARM”: false,
“AREV_FSDURESS”: false,
“AREV_FSFIRE”: false,
“AREV_FSFIREDOOR”: false,
“AREV_FSMEDICAL”: false,
“AREV_FSPANIC”: false,
“AREV_FSTAMPER”: false,
“AREV_FSTECHNICAL”: false,
“AREV_FTCALARM”: false,
“AREV_FTCDURESS”: false,
“AREV_FTCFIRE”: false,
“AREV_FTCFIREDOOR”: false,
“AREV_FTCMEDICAL”: false,
“AREV_FTCPANIC”: false,
“AREV_FTCTAMPER”: false,
“AREV_FTCTECHNICAL”: false,
“AREV_FULLSET”: false,
“AREV_HAALARM”: false,
“AREV_HBALARM”: false,
“AREV_ISIREN”: false,
“AREV_ISOLLIMITFAULT”: false,
“AREV_MEDICAL”: false,
“AREV_PANIC”: false,
“AREV_PARTSET”: false,
“AREV_PARTSET2”: false,
“AREV_PROHIBITUNSET”: false,
“AREV_PSALARM”: false,
“AREV_PSDOORBELL”: false,
“AREV_PSDURESS”: false,
“AREV_PSFIRE”: false,
“AREV_PSFIREDOOR”: false,
“AREV_PSMEDICAL”: false,
“AREV_PSPANIC”: false,
“AREV_PSTAMPER”: false,
“AREV_PSTECHNICAL”: false,
“AREV_RASFAULT”: false,
“AREV_RASTAMPER”: false,
“AREV_READERTAMPER”: false,
“AREV_RTS”: true,
“AREV_SCHDL”: false,
“AREV_SENSRESET”: false,
“AREV_SETFAULT”: false,
“AREV_SETOK”: false,
“AREV_SHUNTFAULT”: false,
“AREV_STROBE”: false,
“AREV_TAMPER”: false,
“AREV_TECHNICAL”: false,
“AREV_UNSET”: true,
“AREV_UNSETDELAYED”: false,
“AREV_UNSETOK”: false,
“AREV_USALARM”: false,
“AREV_USDOORBELL”: false,
“AREV_USDURESS”: false,
“AREV_USFIRE”: false,
“AREV_USFIREDOOR”: false,
“AREV_USMEDICAL”: false,
“AREV_USPANIC”: false,
“AREV_USTAMPER”: false,
“AREV_USTECHNICAL”: false,
“AREV_VOCFAULT”: false,
“AREV_VOCTAMPER”: false,
“AREV_WALK”: false,
“AREV_WALKZNACTV”: false,
“AREV_WARNING”: false,
“AREV_ZNACTIVE”: false,
“AREV_ZNAM”: false,
“AREV_ZNDSHUNT”: false,
“AREV_ZNDSHUNTWARN”: false,
“AREV_ZNFAULT”: false,
“AREV_ZNINHIBIT”: false,
“AREV_ZNINH_LIMIT”: false,
“AREV_ZNISOLATE”: false,
“AREV_ZNISOL_LIMIT”: false,
“AREV_ZNJAMFAIL”: false,
“AREV_ZNMAINSFAIL”: false,
“AREV_ZNSHT_LIMIT”: false,
“AREV_ZNSHUNT”: false,
“AREV_ZNTAMPER”: false
}

Beschrijving – Area Statussen

Hieronder staan alle mogelijke statussen met beschrijving:

• AALARM : A alarm from ACPO (reset after unset).
• ALARM : Alarm.
• ALARMACK : Alarms are waiting for ACK.
• AMRESET : Anti mask triggers Walktest on set attempt.
• ATMDELAY : Area in TimedUnset/ATM delay.
• ATMEXTTIME : Area in TimedUnset/ATM extended time.
• ATMTIME : Area in TimedUnset/ATM time.
• ATMWARNTIME : Area in TimedUnset/ATM warning time.
• AUTOARM : Area autoarm.
• BALARM : B alarm from ACPO (reset after unset/disarm).
• BUZZER : Buzzer Output active.
• CODETAMPER : Code Tamper from RAS (5sec).
• DGPFAULT : Any DGP in Fault state (DGP:Data Gathering Panel).
• DGPTAMPER : Any DGP in Tamper state (DGP:Data Gathering Panel).
• DOORBELL : At least one zone with doorbell option is active (2sec).
• DURESS : Duress code used in the area.
• ENTRY : Area in Entry state.
• ESIREN : External Siren active (no retriggering).
• EXIT : Area in Exit state.
• EXITFAULT : Alarm detected in Exit state.
• FIRE : Fire alarm.
• FIREDOOR : Firedoor alarm.
• FIRERESET : Active after Fire alarm ACK (10sec).
• FSALARM : Area full set/armed and in Alarm.
• FSDURESS : Area full set/armed and Duress.
• FSFIRE : Area full set and Fire.
• FSFIREDOOR : Area full set/armed and firedoor.
• FSMEDICAL : Area full set/armed and Medical alarm.
• FSPANIC : Area full set and panic alarm.
• FSTAMPER : Area full set and tamper alarm.
• FSTECHNICAL : Area full set and Technical alarm.
• FTCALARM : Area in Alarm and FTC (failed to communicate).
• FTCDURESS : Duress and FTC (failed to communicate).
• FTCFIRE : Fire and FTC (failed to communicate).
• FTCFIREDOOR : Firedoor and FTC (failed to communicate).
• FTCMEDICAL : Medical alarm and FTC (reset after unset).
• FTCPANIC : Panic alarm and FTC (failed to communicate).
• FTCTAMPER : Tamper alarm and FTC (failed to communicate).
• FTCTECHNICAL : Technical alarm and FTC (failed to communicate).
• FULLSET : Area full set.
• HAALARM : HA alarm from ACPO (reset after unset/disarm).
• HBALARM : HB alarm from ACPO (reset after unset/disarm).
• ISIREN : Internal Siren active (retriggering allowed).
• ISOLLIMITFAULT : Area isolate limit fault.
• MEDICAL : Medical alarm.
• PANIC : Panic alarm.
• PARTSET : Area part set/armed 1.
• PARTSET 2 : Area part set/armed 2.
• PROHIBITUNSET : Area in prohibit unset/disarmed state.
• PSALARM : Area part set/armed and in Alarm.
• PSDOORBELL : Area part set/armed and Doorbell.
• PSDURESS : Area part set/armed and Duress.
• PSFIRE : Area part set/armed and fire alarm.
• PSFIREDOOR : Area part set and firedoor.
• PSMEDICAL : Area part set and medical alarm.
• PSPANIC : Area part set/armed and Panic alarm.
• PSTAMPER : Area part set and Tamper.
• PSTECHNICAL : Area part set/armed and Technical alarm.
• RASFAULT : Any RAS in Fault state.
• RASTAMPER : Any RAS in Tamper state (RAS:Remote Arming Station).
• READERTAMPER : Any READER in Tamper state.
• RTS : Area Ready To Set/Arm (all conditions set).
• SCHDL : Schedule is assigned to area.
• SENSRESET : Active after burglary alarm ACK (10sec).
• SETFAULT : Set/arm not possible (30sec).
• SETOK : Exit time finished without alarms (30sec).
• SHUNTFAULT : Any zone Shunt fault active in area.
• STROBE : Strobe Output active (clear after unset/disarm).
• TAMPER : Tamper alarm.
• TECHNICAL : Technical alarm.
• UNSET : Area unset/disarmed.
• UNSETDELAYED : Area unset/disarm was delayed.
• UNSETOK : Area unset/disarmed OK (30sec).
• USALARM : Area uset/disarmed and in Alarm.
• USDOORBELL : Area unset/disarmed and Doorbell.
• USDURESS : Area unset/disarmed and Duress.
• USFIRE : Area unset/disarmed and fire alarm.
• USFIREDOOR : Area unset/disarmed and firedoor.
• USMEDICAL : Area unset/disarmed and Medical alarm.
• USPANIC : Area unset/disarmed and Panic alarm.
• USTAMPER : Area unset/disarmed and Tamper alarm.
• USTECHNICAL : Area unset/disarmed and Technical alarm.
• VOCFAULT : Any Audio device in Fault state.
• VOCTAMPER : Any Audio device in Tamper state.
• WALK : Area in Walk-Test.
• WALKZNACTV : Zone in Walk-Test is activated.
• WARNING : Area warning.
• ZNACTIVE : At least one zone in active state.
• ZNAM : At least one zone in AM state (AM:antimask).
• ZNDSHUNT : Area Door shunt activated.
• ZNDSHUNTWARN : Area Door shunt warning activated.
• ZNFAULT : At least one zone in Fault state.
• ZNINHIBIT : At least one zone in Inhibit state.
• ZNINH LIMIT : Area inhibit limit reached.
• ZNISOLATE : At least one zone in Isolate state.
• ZNISOL LIMIT : Area isolate limit reached.
• ZNSHT LIMIT : Area shunt limit reached.
• ZNSHUNT : Any zone shunt activated in area.
• ZNTAMPER : At least one zone in tamper state.

MQTT topic – Area Control

Vanuit MQTT kan een gebied ook ingeschakeld worden, hiervoor luistert de Domox naar “Set” topics per gebied.
Topic van een set gebied 1 betreft: alarm/panel1Area1Set

Een gebied kan op 4 manier “geschakeld” worden, namelijk:

• arm (inschakelen), stuur onderstaande json data vanuit de MQTT client naar topic alarm/panel1Area1Set :

{
“value”: “arm”,
“pin”: “1234”
}

• disarm (uitschakelen), stuur onderstaande json data vanuit de MQTT client naar topic alarm/panel1Area1Set :

{
“value”: “disarm”,
“pin”: “1234”
}

• partarm (gedeeltelijk inschakelen), stuur onderstaande json data vanuit de MQTT client naar topic alarm/panel1Area1Set :

{
“value”: “partarm”,
“pin”: “1234”
}

• partarm2 (gedeeltelijk 2 inschakelen), stuur onderstaande json data vanuit de MQTT client naar topic alarm/panel1Area1Set :

Nu zijn alle zones voor status aan MQTT gekoppeld.
* Na Controls → Export to controller → Save pas doorgevoerd op de Domox controller.

MQTT topic – Zone Status

Een ATS zone heeft vele statussen, welke allemaal in een MQTT topic per zone/ingang automatisch worden bijgewerkt.
Als een externe MQTT client met de Domox broker een verbinding maakt, zal van ieder gekoppelde zone de huidige status in het bijbehorende topic worden bijgewerkt.

Topic van een status zone 1 betreft: alarm/panel1Zone1Status
De status van topic alarm/panel1Zone1Status betreft een JSON object met daarin alle statussen van één zone, zie voorbeeld hieronder:

{
    “Id”: “returnSTAT.ZONE”,
    “objectID”: 1,
    “ZNEV_RFJAMFAULT”: false,
    “ZNEV_FAULT”: false,
    “ZNEV_LEARNED”: false,
    “ZNEV_HELDOPEN”: false,
    “ZNEV_DSHUNT_WARN”: false,
    “ZNEV_SHUNT”: false,
    “ZNEV_DIRTY”: false,
   “ZNEV_SVLONG”: false,
    “ZNEV_TAMPER”: false,
    “ZNEV_SVSHORT”: false,
    “ZNEV_SHUNT_FLT”: false,
    “ZNEV_MAINSFAIL”: false,
    “ZNEV_PRELEARNED”: false,
    “ZNEV_ACTIVE”: true,
    “ZNEV_ISOLATE”: false,
    “ZNEV_BATTFAIL”: false,
    “ZNEV_DSHUNT”: false,
    “ZNEV_AM”: false,
    “ZNEV_INHIBIT”: false,
    “ZNEV_SOAK”: false,
    “ZNEV_SET”: false,
    “ZNEV_ALARM”: false,
    “ZNEV_INVWT”: false
}

Beschrijving – Zone Statussen

• ACTIVE = Zone in active state.
• ALARM = Zone in alarm.
• AM = Zone in Anti-Mask state.
• BATTFAIL = Zone battery fault.
• DIRTY = Zone in dirty state.
• DSHUNT = Zone door shunted – zone shunted by RAS action, activated by dedicated RAS
• DSHUNTWARN = Zone door shunt warning time active – configurable time before door shunt expires
• FAULT = Zone in fault state.
• HELDOPEN = Zone held open too long
• INHIBIT = Zone inhibited.
• INVWT = Inverted Walk Test – zone not active for a certain time
• ISOLATE = Zone isolated.
• LEARNED = Zone has been learned.
• PRELEARNED = RF signal accept.
• SET = Zone in set mode.
• SHUNT = Zone shunted – if shunted then this shall be logged and zone shall not operate on active state
• SHUNT FLT = Zone shunt fault – zone active during unshunt action
• SOAK = Zone in soak test.
• SVLONG = Zone in supervision long.
• SVSHORT = Zone in supervision short.
• TAMPER = Zone in tamper state.

Alarm Triggers 

• Klik op devices → Alarm Triggers → Alarm Trigger Discover :

• Klik op MQTT (set trigger from mqtt) → selecteer het MQTT device → Save (indien alle triggers gekoppeld moeten worden):

MQTT topic – Trigger Control

Vanuit MQTT kan een trigger geactiveerd worden, hiervoor luistert de Domox naar “Set” topics per trigger.
Topic van een set trigger 1 betreft: alarm/panel1Trigger1Set

Een trigger kan op 4 manier “geschakeld” worden, namelijk:
 * de trigger zal met de Domox Superuser (hoofdgebruiker) geactiveerd worden.

• activate (Domox zet de trigger gelijk op actief).
  Stuur onderstaande json data vanuit de MQTT client naar topic alarm/panel1Trigger1Set :
  {

“value”: “activate”
}

• deactivate (Domox zet de trigger gelijk op inactief).
  Stuur onderstaande json data vanuit de MQTT client naar topic alarm/panel1Trigger1Set :

{
“value”: “deactivate”
}

• toggle (Domox zet de trigger op actief als de huidige status inactief is en omgekeerd).
  Stuur onderstaande json data vanuit de MQTT client naar topic alarm/panel1Trigger1Set :

{
“value”: “toggle”
}

• pulse (Domox zet de trigger gelijk op actief en na de opgeven tijd in ms weer op inactief.
  Stuur onderstaande json data vanuit de MQTT client naar topic alarm/panel1Trigger1Set :
  

{
“value”: “pulse”,
“time”: 1500,
}

* als time niet wordt opgegeven, zal de tijd automatisch 2000 ms worden.