1.Introduction
HS Monitor is a function that can be called up in the browser. It can send and receive telegrams from group addresses.
Every group address stands for either an internal or an external (EIB) communication object of the HS/FS that was released in the Expert software for use with HS Monitor.
The group addresses are shown in a list on the Communication objects mask which contains exactly one entry (one line) per group address. Besides the group address and the current value, this entry optionally contains the name of the communication object and other information.
In a second list in the Protocol mask, all the telegrams from group addresses previously marked by the user are logged. This list can be exported as a ".csv" file.
Every group address stands for either an internal or an external (EIB) communication object of the HS/FS that was released in the Expert software for use with HS Monitor.
The group addresses are shown in a list on the Communication objects mask which contains exactly one entry (one line) per group address. Besides the group address and the current value, this entry optionally contains the name of the communication object and other information.
In a second list in the Protocol mask, all the telegrams from group addresses previously marked by the user are logged. This list can be exported as a ".csv" file.
1.1.Requirements
The following is required for using the HS Monitor:
Hardware and software:
Hardware and software:
- HomeServer or FacilityServer with firmware version 4.7.x or later.
- Expert software version 4.7.x or later.
- Mozilla Firefox version 49 or later
- Google Chrome version 52 or later
- Microsoft Edge version 38 or later
- Microsoft Internet Explorer version 11 or later
- Google Chrome Android
- iOS Safari 10
1.2.Installation, setup, access and call
Important
If any of the following settings are changed in Expert, the project must be transferred again!
Access
To use HS Monitor, one of the following two settings must be activated in HS/FS Expert under Master data -> Project settings -> Interface:
Either
Either
- the All option must be activated,
- the User-defined option must be activated
and
the hsmonitor checkbox must be activated.
Setup
The Access via WebSocket setting must be activated in HS/FS Expert under Master data -> Project settings -> Network -> Communication object gateway!
The other options to be set under this item are described in the Expert help on the communication object gateway.
The other options to be set under this item are described in the Expert help on the communication object gateway.
Call
HS Monitor is called up in the browser under the following URL:
or
HTTPS://HS_IP/opt/hsmonitor/index.htmlor
HTTPS://HS_IP/opt/hsmonitor/index.html#key=[key]Login
When the HS Monitor is started, the login mask appears. The key for the communication object gateway data connection defined in the Expert project can be entered here.
HS Monitor remembers this key until the browser is exited.
HS Monitor demands that a key is entered the first time it is started, or if the key has changed, e.g., after a change in the project and its re-transfer.
The key can also be entered directly as a parameter in the URL when calling up the HS Monitor.
HS Monitor remembers this key until the browser is exited.
HS Monitor demands that a key is entered the first time it is started, or if the key has changed, e.g., after a change in the project and its re-transfer.
The key can also be entered directly as a parameter in the URL when calling up the HS Monitor.
Examples of calls
Example of a call on an HS/FS with the IP address 192.168.0.11 with secure communication:
The key can also be entered during the call (see Settings).
Example of the same call with entry of the key "my123key":
HTTPS://192.168.0.11/opt/hsmonitor/index.htmlThe key can also be entered during the call (see Settings).
Example of the same call with entry of the key "my123key":
HTTPS://192.168.0.11/opt/hsmonitor/index.html#key=my123key2.HS Monitor
The HS Monitor display is divided into three areas and a pop-up mask:
- Area 1: Header
- Area 2: Communication objects mask
- Area 3: Protocol mask
2.1.Header
The header forms the complete upper area of the website.
The tabs for switching the display are located here, the connection status indicator and the button for calling the help.
The tabs for switching the display are located here, the connection status indicator and the button for calling the help.
Communication objects tab
Shows the Communication objects mask with the list of the communication objects made available in the project and the action bar. HS Monitor starts with this display.
Protocol tab
Shows the Protocol mask.
Each entry in the list displays a telegram of one of the communication objects that was marked in the Communication object mask for logging (i.e. the checkbox of the communication object in question in the left column is activated).
If the Communication objects mask is currently active, a badge is displayed at the top right on the Protocol tab when a new telegram is received. This displays the number of new telegrams since the Protocol mask was exited (and/or the start of the HS Monitor if the protocol mask has not yet been called).
If the Protocol mask is displayed again, the badge is removed and counting begins again at '0'.
Each entry in the list displays a telegram of one of the communication objects that was marked in the Communication object mask for logging (i.e. the checkbox of the communication object in question in the left column is activated).
If the Communication objects mask is currently active, a badge is displayed at the top right on the Protocol tab when a new telegram is received. This displays the number of new telegrams since the Protocol mask was exited (and/or the start of the HS Monitor if the protocol mask has not yet been called).
If the Protocol mask is displayed again, the badge is removed and counting begins again at '0'.
Connection status
A symbol displaying two arrows is located on the left next to the text "HS Monitor". This symbol displays the current connection status between HS Monitor (in the browser) and HS/FS.
This symbol can have two colours:
This symbol can have two colours:
- Green: There is an active connection.
- Red: There is currently no connection.
Note
When reconnecting to the HS/FS, make sure that the checkbox for the protocol function is deactivated and the "Anz. / Count" column is set to '0'!
The protocol list is not deleted in the event of termination of the connection or reconnection!
The protocol list is not deleted in the event of termination of the connection or reconnection!
2.2.Communication objects mask
The list of the communication objects released for display in the current HS/FS project is displayed here.
Each communication object is represented by exactly one line in the list.
Information on the individual columns in the list can be found in the List of communication objects section.
Clicking a line can select it for special actions:
Each communication object is represented by exactly one line in the list.
Information on the individual columns in the list can be found in the List of communication objects section.
Clicking a line can select it for special actions:
2.2.1.List of communication objects
List of all communication objects released in the Expert project, sorted by group address.
Meaning of the individual columns:
Meaning of the individual columns:
| Column | Explanation |
|---|---|
| Column 1 | Checkbox for the designation for logging. Every communication object activated in this way is recorded in the Protokoll / Protocol. |
| Grp.-Adr. | Group address in the format x/y/z. |
| Name | Designation of the communication object. |
| Anz. / Count | Number of telegrams received since HS Monitor was started. |
| Zeit / Time | Time of the last telegram received. |
| Wert / Value | Current value of the communication object. |
| Typ(e) | Format of the communication object The following entries are possible:
|
| Min | Minimum The lowest possible value defined in Expert for the communication object. |
| Max | Maximum The highest possible value defined in Expert for the communication object. |
| S L | Stands for Schrittgröße / Step and Liste / List If a Schrittgröße / Step is defined in Expert for this communication object, an S is displayed here. If a Liste / List is defined in Expert for this communication, an L is displayed. |
2.2.2.Action bar
The action bar on the right-hand edge of the Communication objects mask offers the option of filtering the adjacent list and/or assigning new values to individual communication objects.
Exceptions are communication objects with the format "date" and "time" that cannot be changed with HS Monitor, but only displayed.
To change a communication object, the corresponding line must first be selected (clicked). The line is then shown with a grey background.
Exceptions are communication objects with the format "date" and "time" that cannot be changed with HS Monitor, but only displayed.
To change a communication object, the corresponding line must first be selected (clicked). The line is then shown with a grey background.
Filter (magnifying glass symbol)
The list of communication objects can be filtered, i.e. as soon as a filter is entered, only the communication objects matching the filter are shown.
- Filtering begins after entry of the first character.
- The filter is updated after the entry of each further character.
- Several filters separated by spaces can be entered that are applied AND-linked.
- The sequence of the specified filters is not important.
- The filter criteria are applied to the fields "Grp.-Adr." and "Name".
- To cancel filtering, the filter field has to be cleared.
Note
Selecting a line does not influence filtering.
The behaviour of communication objects with value assignments outside the min./max. limits defined for you is described in the Expert help in the "Communication objects” chapter.
The behaviour of communication objects with value assignments outside the min./max. limits defined for you is described in the Expert help in the "Communication objects” chapter.
Wert setzen / Send Value
First, a value has to be specified in the input field, then the value of the communication object is changed accordingly by clicking one of the two buttons:
- Absolut(e): The current value of the communication object is set to the entered value.
- Relativ(e): The entered value is added to the current value of the communication object.
Note
To subtract a value, enter a number with a "minus" character in front of it and click "Relativ(e)".
Schrittgröße / Step
Note
This input box is only visible if a step size was defined for the communication object in the project.
The step size is displayed.
Click on one of the two buttons ("+" or "-") to add the step size to the current value of the communication object ("+" button) or to subtract from it ("-" button).
Click on one of the two buttons ("+" or "-") to add the step size to the current value of the communication object ("+" button) or to subtract from it ("-" button).
2.3.Protocol mask
The list of the telegrams received is displayed in this mask.
You also have the possibility of deleting and/or exporting the list.
You also have the possibility of deleting and/or exporting the list.
2.3.1.List of telegrams received
| Column | Explanation |
|---|---|
| Zeit / Time | Time at which the value assignment took place. |
| Grp.-Adr. | Group address. |
| Wert / Value | The value that was assigned to the communication object. |
| Name | The designation of the communication object. |
| Typ(e) | Format of the communication object The following entries are possible:
|
Note
Deactivating one or more communication objects has no influence on the lines already displayed in this list at this time.
Note
An update of the browser, caused both manually and automatically (e.g. new transfer of project to the HS/FS), has no influence on the value assignments already displayed in the list at this time.
The deletion or change of communication objects in the project for which entries already exist in the list has no influence on these entries even after the project is transferred again.
The deletion or change of communication objects in the project for which entries already exist in the list has no influence on these entries even after the project is transferred again.
2.3.2.Processing toolbar
In the processing toolbar at the right-hand edge of the Protocol mask, you will find options for processing the list and for further processing of the displayed data.
3.FAQs
Problem: Only the group addresses and the values are displayed.
Solution: In Expert, the option "Transfer XML structure of communication objects to device" must be activated under Master data -> Project settings -> Network -> Communication object gateway.
Problem: No group addresses are displayed in the Communication objects mask.
There are several possible causes for this error:
- An error in the configuration for the access
- An error in the configuration for the setup
- The IP address of the device on which HS Monitor is running is not contained in the list of the permitted sender addresses:
- Expert: Master data -> Project settings -> Network -> Communication object gateway - The IP address of the device on which HS Monitor is running is contained in the list of the permitted sending addresses, but the key defined there is different from the one you entered in the browser.
- Call
- Settings
- Expert: Master data -> Project settings -> Network -> Communication object gateway
Problem: No group addresses are displayed in the Communication objects mask.
There are several possible causes for this error:
- Certain options are deactivated in Expert:
Under Master data -> Project settings -> Network -> Communication object gateway, one or two of the following options:- Activate receiving for all communication objects
- Activate sending for all communication objects
- Receive communication object gateway
- Send communication object gateway
Solution: For the individual communication objects, activate the options for "receive" and/or "send" to display exactly these communication objects, or activate the options for "receive" and/or "send" in the communication object gateway settings to display all communication objects with assigned group address, irrespective of the settings of the individual communication objects. - You have not assigned a group address to the "missing" communication objects:
Solution: Enter a group address for each desired communication object under Master data -> Communication objects.