Black Box EME160A Bedienungsanleitung

24/7 TECHNICAL SUPPORT AT 1.877.877.2269 OR VISIT BLACKBOX.COM

ALERTWERKS

PLUS MQTT

MANUAL

EME160A, EME161A-R2, EME164A, EME168A

USER MANUAL

TABLE OF CONTENTS

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

CHAPTER 1: INTRODUCTION .......................................................................................................................................................... 3

1.1 INTRODUCTION .......................................................................................................................................................................................3

1.1.1 WHAT IS MQTT ...................................................................................................................................................................................................3

CHAPTER 2: MQTT TOPICS ............................................................................................................................................................. 5

2.1 TOPIC PRINCIPLE ....................................................................................................................................................................................5

2.1.1 Single-Level Wildcard - Replaces One Topic Level ...................................................................................................................................... 5

2.1.2 Multi-Level Wildcard - Covers Many Topic Levels ......................................................................................................................................6

2.2 MQTT Cluster ..........................................................................................................................................................................................6

CHAPTER 3: ALERTWERKS PLUS MQTT FEATURES..................................................................................................................... 8

3.1 MQTT SUPPORTED FEATURES...............................................................................................................................................................8

3.1.1 MQT T Topics .......................................................................................................................................................................................................8

CHAPTER 4: SENSOR STATUS CODES............................................................................................................................................ 9

4.1 SENSOR STATUS CODES.........................................................................................................................................................................9

CHAPTER 5: ALERTWERKS PLUS MQTT CONFIGURATION ....................................................................................................... 10

5.1 CONFIGURATION PAGE .........................................................................................................................................................................10

5.2 MQTT SERVER PARAMETERS..............................................................................................................................................................11

5.3 MQTT SUPPORT (H7 UNITS ONLY) .....................................................................................................................................................11

CHAPTER 6: MQTT MONITORING ................................................................................................................................................. 14

6.1 MONITORING MQTT ..............................................................................................................................................................................14

6.2 HOW TO FIND SENSOR COMPOUND ID...............................................................................................................................................39

6.3 DETAILED EXPLANATION OF COMPOUND ID STRUCTURE..............................................................................................................42

APPENDIX A: UPLOADING SSL SECURITY CERTIFICATES ........................................................................................................ 43

APPENDIX B: REGULATORY INFORMATION ................................................................................................................................ 58

APPENDIX C: DISCLAIMER/TRADEMARKS ................................................................................................................................. 60

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

CONTENTS

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

CHAPTER 1: HEADLINE

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

CHAPTER : INTRODUCTION

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

. INTRODUCTION

MQTT is a new AlertWerks Plus feature, which allows you to send sensor values and status changes to up to four

MQTT servers.

The following “What is MQTT?” introduction information is based on the HiveMQ FAQ documentation.

.. WHAT IS MQTT?

MQTT is a standardized protocol for messaging and data exchange that was developed by OASIS, ISO/IEC 20922:2016.

The technology provides a scalable and cost-effective way to connect devices together with minimal protocol

overhead. It is able to deliver data over the Internet in near real-time and guarantee delivery.

MQTT was originally designed to connect sensor nodes over communication networks that are unreliable, high-

latency, or both. It is lightweight, which enables low-cost device communication.

MQTT uses TCP. Due to ordering requirements, MQTT over UDP is not possible.

Figure 1-1 illustrates the broker/client relationship.

FIGURE -: BROKER/CLIENT RELATIONSHIP

MQTT follows a Publish/Subscribe paradigm. The sender (Publisher) and receiver (Subscribers) of messages

communicate via topics and are decoupled from each other. The connection between them is handled by the MQTT

broker. The broker receives and filters all incoming messages, determines who is interested in each message, and

distributes messages correctly to the subscribers.

A client is any device that operates an MQTT library and connects to an MQTT broker over a network. A client doesn’t

have to pull the information it needs, since the broker pushes the information to the client whenever something new

is available.

CHAPTER 1: HEADLINE

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

CHAPTER : INTRODUCTION

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

For example, monitoring a temperature sensor via MQTT works according to Figure 1-2:

FIGURE -: DATA FLOW FROM SENSOR TO DEVICE

Reference Information:

HiveMQ Introduction to MQTT

https://www.youtube.com/watch?v=z4r4hIZcp40

MQTT Protocol – How it works

https://www.youtube.com/watch?v=4QWISyd7SOo

CHAPTER 1: HEADLINE

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

CHAPTER : MQTT TOPICS

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

. TOPIC PRINCIPLE

Communication in MQTT is based on the topic principle. An MQTT topic is a UTF-8 string that the broker uses to filter

messages for each connected client. To receive messages, the client must subscribe to the topic. A topic can have

one or more topic levels. Each topic level is separated by a slash.

Each topic must contain at least one character. The topic string permits empty spaces, and topics are case-sensitive.

Figure 2-1 illustrates a topic with multiple topic levels.

FIGURE -: TOPIC LEVELS

Topics support wildcard characters. When subscribing to a topic, the user can either subscribe to the exact topic of a

published message or can use wildcards to subscribe to multiple topics simultaneously. A wildcard can only be used

to subscribe to topics, not to publish a message. There are two different kinds of wildcards: single-level and multi-

level.

.. SINGLE-LEVEL WILDCARD - REPLACES ONE TOPIC LEVEL: +

A single-level wildcard replaces one topic level by using a “+” sign. Figure 2-2 illustrates a topic with a wildcard.

FIGURE -: WILDCARD EXAMPLE

CHAPTER 1: HEADLINE

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

CHAPTER : MQTT TOPICS

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

.. MULTI-LEVEL WILDCARD - COVERS MANY TOPIC LEVELS: #

A multi-level wildcard covers many topic levels. It only appears at the end of a topic string. Figure 2-3 illustrates a

multi-level wildcard.

FIGURE -: MULTI-LEVEL WILDCARD

. MQTT CLUSTER

In an MQTT cluster, multiple brokers are handling the same topics.

If a broker receives new data from a sensor or device, it will distribute the new data between all other MQTT brokers

for redundancy using inter-node communication channels.

In the event of a broker failure or communications problem, which is called a netsplit event, the data remains

available from other cluster members.

If the failed cluster member comes online again, the sensor data missed during the offline period will be replicated

from the other nodes.

The subscribed client will get the same data and same topics from any of the brokers participating in the cluster.

The publisher device or sensor can publish its data to any of the brokers participating in the cluster, knowing that the

data will be replicated automatically to other brokers.

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

Figure 2-4 illustrates a MQTT broker cluster.

FIGURE -: MQTT BROKER CLUSTER

CHAPTER : MQTT TOPICS

81. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

. MQTT SUPPORTED FEATURES

For AlertWerks Plus products, MQTT can be enabled in the Settings menu.

The current implementation supports MQTT v3.1.1 without encryption as described here:

https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.pdf

AlertWerks Plus products use JSON strings to relay sensor information. The MQTT Data type is JSON.

The following features are supported:

• sending sensor status change events on appropriate events from ALL sensors (wired, virtual, etc.)

• periodically sending (updating) all sensor values via MQTT

NOTE: The interval is set on WebUI.

• defining up to 4 MQTT servers in settings

NOTE: The device will randomly select a server to send the MQTT values

The AlertWerks Plus units can queue up to 1,020 MQTT messages if the connection to the MQTT server is lost. These

messages contain status and value changes for all online sensors.

The messages in the queue are saved even when the device is powered off. They will be re-sent to the MQTT server

once the connection has been reestablished.

.. MQTT TOPICS

AlertWerks Plus topics:

spp/<DEVICE_MAC_ADDRESS>/sensor/status_change/<SENSOR_COMPOUND_ID>

spp/<DEVICE_MAC_ADDRESS>/sensor/value_change/<SENSOR_COMPOUND_ID>

NOTE: These topics are used for ALL sensor types.

CHAPTER : ALERTWERKS PLUS MQTT FEATURES

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

CHAPTER : SENSOR STATUS CODES

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

. SENSOR STATUS CODES

The sensor statuses are sent in the MQTT packets, and they are represented by numbers.

Figure 4-1 shows an example of sensor status information, and Table 4-1 provides sensor status and description

information.

FIGURE -: SENSOR STATUS EXAMPLE

TABLE 4-1. SENSOR STATUS AND DESCRIPTION

STATUS DESCRIPTION

NOSTATUS = 1 Sensor is in an unknown or undefined state

SENSORNORMAL = 2 Sensor is in normal state

HIGHWARNING = 3 High warning state for analog sensor types

HIGHCRITICAL = 4 High critical state for analog sensor types

LOWWARNING = 5 Low warning state for analog sensor types

LOWCRITICAL = 6 Low critical state for analog sensor types

SENSORERROR = 7 Sensor error state

SWITCH_LOW_OUT = 8 Low state for switch sensor types

SWITCH_HIGH_OUT = 9 High state for switch sensor types

NO_VOLT_PRESENT = 10 No voltage detected

VOLT_PRESENT = 11 Voltage detected

SWITCH_TIMED_TO_ON = 12 Reserved for future use

STATUS_ACKED = 13 Sensor status is acknowledged

STATUS_OFFLINE = 14 Sensor status is offline

UNREACHABLE = 15 Sensor is unreachable

CHAPTER 1: HEADLINE

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

NEED HELP?

LE AVE THE TECH TO US

LIVE 24/7

TECHNICAL

SUPPORT

1. 8 7 7. 87 7. 2 2 6 9

1. 8 7 7. 8 7 7. 2 2 6 9 BLACKBOX.COM

. CONFIGURATION PAGE

To configure your AlertWerks Plus device:

1. Open Settings page -> MQTT.

2. Click on the check box to the left of Enable MQTT to select it.

3. Click on the check box to the left of Broadcast sensor values periodically to select it.

4. Set the broadcast interval by entering a value between 1-60 minutes in the corresponding field.

NOTE: Set 1 minute for quick updates and testing.

5. Set the network interface which MQTT will broadcast on by choosing a selection from the drop-down list box.

For wired networks, choose Ethernet. GSM (Modem) is also supported.

Figure 5-1 shows these options.

FIGURE -: MQTT CONFIGURATION PAGE

CHAPTER : ALERTWERKS PLUS MQTT CONFIGURATION

Dieses Handbuch passt für folgende Modelle

Inhaltsverzeichnis

Andere Black Box Tor Handbücher

Black Box

Black Box EME160A-UC Bedienungsanleitung

Black Box

Black Box AlertWerks AW3000 Bedienungsanleitung

Black Box

Black Box VOE102 Bedienungsanleitung

Black Box

Black Box Micro-MiniBuffer-64K Bedienungsanleitung

Black Box

Black Box ServSwitch Wizard DXS Bedienungsanleitung

Black Box

Black Box LRA1200A-S Bedienungsanleitung

Black Box

Black Box iCOMPEL EDS-S11 Bedienungsanleitung

Black Box

Black Box iCOMPEL EDS-S20 Bedienungsanleitung

Black Box

Black Box Optinet FE408005AA Bedienungsanleitung

Black Box

Black Box ServReach KVM Gate KVIP1000A Bedienungsanleitung

Black Box

Black Box VOE102 Bedienungsanleitung

Black Box

Black Box SAC510NA Bedienungsanleitung

Black Box

Black Box VOE101 Bedienungsanleitung

Black Box

Black Box ACR2004A Bedienungsanleitung

Black Box

Black Box LRA1200A-E Bedienungsanleitung

Black Box

Black Box IPBX424 Bedienungsanleitung

Black Box

Black Box VOE101 Bedienungsanleitung

Black Box

Black Box ALERTWERKS EME800A-US Bedienungsanleitung

Beliebte Tor Handbücher anderer Marken

LST

LST M500RFE-AS Bedienungsanleitung

Kinnex

Kinnex Media Gateway Bedienungsanleitung

2N Telekomunikace

2N Telekomunikace 2N StarGate Bedienungsanleitung

Mitsubishi Heavy Industries

Mitsubishi Heavy Industries Superlink SC-WBGW256 Bedienungsanleitung

ZyXEL Communications

ZyXEL Communications ZYWALL2 ET 2WE Bedienungsanleitung

Telsey

Telsey CPVA 500 - SIP Bedienungsanleitung

RTA

RTA 460A-NNA4 Technisches Datenblatt

Shaw

Shaw Gateway HDPVR Bedienungsanleitung

ABB

ABB VSN900 Kurzanleitung

Commander

Commander Pulse Bedienungsanleitung

2N Telekomunikace

2N Telekomunikace ATEUS EasyGate 501309E Bedienungsanleitung

NETGEAR

NETGEAR C6300BD Bedienungsanleitung

Amit

Amit CDW531AM Bedienungsanleitung

HMS

HMS Netbiter EasyConnect EC150 Bedienungsanleitung

Huawei

Huawei EchoLife HG620 Bedienungsanleitung

AT&T

AT&T U-verse 3801 Gebrauchs- und Pflegehandbuch

Logic IO

Logic IO RTCU MX2 turbo Bedienungsanleitung

Suttle

Suttle MediaMAX MXM-521 Bedienungsanleitung