1.Introduction
HS Monitor is a function that can be called up in the browser. It can send and receive telegrams from group addresses.
Each group address stands for either an internal or external (KNX) communication object of the HS/FS that was released in the Expert software for use with HS Monitor.
The group addresses are displayed in a list on the C-OBJECTS tab, which contains exactly one entry (one line) for each group address. This entry contains the group address, the current value, the name of the communication object and other information.
In a second list, which can be called via the PROTOCOL tab, all telegrams from group addresses previously marked by the user are logged. You can export this list as a ".csv" file.
Each group address stands for either an internal or external (KNX) communication object of the HS/FS that was released in the Expert software for use with HS Monitor.
The group addresses are displayed in a list on the C-OBJECTS tab, which contains exactly one entry (one line) for each group address. This entry contains the group address, the current value, the name of the communication object and other information.
In a second list, which can be called via the PROTOCOL tab, all telegrams from group addresses previously marked by the user are logged. You can export this list as a ".csv" file.
1.1.Requirements
The following is required for using HS Monitor:
Hardware and software:
Hardware and software:
- HomeServer or FacilityServer with firmware version 4.7.x or higher.
- Expert software version 4.7.x or higher.
- Mozilla Firefox 59 or higher
- Google Chrome 65 or higher
- Microsoft Edge 41 or higher
- Microsoft Internet Explorer 11 or higher
- Google Chrome Android 66
- iOS Safari 11
1.2.Installation, setup, access and call
Important
If you change any of the following settings in Expert, you must transfer the project again!
Access
To use HS Monitor, you must activate one of the following two settings in the HS/FS Expert under Master data -> Project settings -> Interface:
Either
Either
- Activate the All option,
- activate the User-defined option
and
the hsmonitor checkbox.
Setup
Under Master data -> Project settings -> Network -> Communication object gateway in the HS/FS Expert, the following settings are important:
These and other options are described in the Expert help for the Communication object gateway.
| Setting | Mandatory / Optional | Comment |
|---|---|---|
| Activate WebSocket | Mandatory | |
| Load XML structure of communication objects on device | Mandatory | |
| Activate receiving for all communication objects | Optional | If activated, telegrams from all communication objects to which group addresses are assigned are received in the HS/FS, i.e., their values can be changed via HS Monitor. If not activated, only telegrams (with group addresses) can be received by communication objects for which the "Receive communication object gateway" option is activated. Important Only group addresses which may also be sent via the communication object gateway are displayed under Communication objects! |
| Activate sending for all communication objects | Optional | If activated, telegrams with value changes sent from the HS/FS can be received in the HS Monitor by all communication objects to which group addresses are assigned. If not activated, only telegrams (with group addresses) can be sent to communication objects for which the "Send communication object gateway" option is activated. |
Call
Call HS Monitor in the browser using the following URL:
or
HTTPS://HS_IP/opt/hsmonitor/index.htmlor
HTTPS://HS_IP/opt/hsmonitor/index.html#key=[key]Login
In some cases (see below), the login mask is displayed and you are required to enter a key before you can access HS Monitor. You must specify the key defined in the project for the communication object gateway data connection.
HS Monitor remembers this key until you exit the browser.
HS Monitor requires you to enter this key when starting MS Monitor for the first time or if the key has changed, e.g., after changes have been made to the project and it has been transferred again.
You can also specify the key directly as a parameter in the URL when calling HS Monitor (second of the call options described above).
HS Monitor remembers this key until you exit the browser.
HS Monitor requires you to enter this key when starting MS Monitor for the first time or if the key has changed, e.g., after changes have been made to the project and it has been transferred again.
You can also specify the key directly as a parameter in the URL when calling HS Monitor (second of the call options described above).
Examples of calls
Example of a call on an HS/FS with IP address 192.168.0.11 with secure communication:
You can specify the key during the call (see Login mask).
Example of the same call with entry of the key "my123key":
HTTPS://192.168.0.11/opt/hsmonitor/index.htmlYou can specify the key during the call (see Login mask).
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: List of the communication objects (C.-OBJECTS tab)
- Area 3: Protocol mask (PROTOCOL tab)
2.1.Header
The header spans the entire upper area of the website.
It contains the tabs for switching the display, the connection status indicator and the button for calling the help.
It contains the tabs for switching the display, the connection status indicator and the button for calling the help.
C-OBJECTS tab
Click the tab to display the List of the communication objects. HS Monitor starts with this display.
PROTOCOL tab
Click the tab to display the Protocol of the telegrams received.
Each entry in the list displays a telegram for one of the communication objects that was selected for logging in the List of communication objects (in other words, the checkbox for the communication object in question is activated in the column on the left).
Each entry in the list displays a telegram for one of the communication objects that was selected for logging in the List of communication objects (in other words, the checkbox for the communication object in question is activated in the column on the left).
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
Note that when HS Monitor reconnects to the HS/FS, the checkbox for the protocol function is deactivated for all communication objects and all values in the "Total" column are set to '0'.
The protocol list is not deleted if the connection is lost or re-established.
The protocol list is not deleted if the connection is lost or re-established.
2.2.C.-OBJECTS tab
Click the "C.-OBJECTS" tab to display the list of communication objects.
The input line for the group addresses filter is displayed at the very top.
Below this, the list of the communication objects released for display in the current HS/FS project is displayed.
Each communication object is represented by exactly one line in the list.
Information on the individual columns of the list can be found under the item List of communication objects.
By clicking a line, you can select it for different actions.
If the screen width of the display device or browser currently being used is greater than or equal to 1024 pixels, a box is displayed on the right next to the list of communication objects containing information on the communication object currently selected.
Otherwise, this box is displayed as a pop-up window instead.
The input line for the group addresses filter is displayed at the very top.
Below this, the list of the communication objects released for display in the current HS/FS project is displayed.
Each communication object is represented by exactly one line in the list.
Information on the individual columns of the list can be found under the item List of communication objects.
By clicking a line, you can select it for different actions.
If the screen width of the display device or browser currently being used is greater than or equal to 1024 pixels, a box is displayed on the right next to the list of communication objects containing information on the communication object currently selected.
Otherwise, this box is displayed as a pop-up window instead.
Filter (magnifying glass symbol)
You can filter the list of communication objects, in other words, as soon as you enter a filter, the communication objects that match the filter are displayed.
- Filtering begins as soon as you enter the first character.
- The filter updates each time you enter another character.
- You can specify several filters, separated by a space, which are applied using the AND operator.
- The sequence of the specified filters is not important.
- The filter criteria are applied in the "GA" and "Name" columns.
- To remove filtering, clear the filter field.
Note
Selecting a line has no effect on filtering.
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 |
|---|---|
[] | Checkbox for identifying communication objects for logging. Each telegram to this group address is recorded in the Protocol. If you click the checkbox in the header line, all communication objects currently displayed in the list (if the filter is active, this is only a part of the total quantity) are activated or deactivated. |
GA | Group address in the format x/y/z. |
Name | Name / designation of the communication object. |
Total | Number of telegrams received since starting HS Monitor. |
Timestamp | Time of the last telegram received. |
Value | Current value of the communication object. |
2.2.2.Communication object infobox
If the screen width of the display device or browser currently being used is greater than or equal to 1024 pixels, a box is displayed on the right next to the list of communication objects containing information on the communication object currently selected.
Otherwise, this box is displayed as a pop-up window when you click a line.
This box shows various additional information and offers a number of actions for the communication object currently selected.
Exceptions include communication objects with the "date" and "time" format (type), which can only be displayed using HS Monitor and cannot be changed.
To change a communication object, you must first click the corresponding line in the list of communication objects. The line is then shown with a grey background.
Otherwise, this box is displayed as a pop-up window when you click a line.
This box shows various additional information and offers a number of actions for the communication object currently selected.
Exceptions include communication objects with the "date" and "time" format (type), which can only be displayed using HS Monitor and cannot be changed.
To change a communication object, you must first click the corresponding line in the list of communication objects. The line is then shown with a grey background.
2.2.2.1.Data of the active communication object displayed
The name of the communication object is displayed in the box title.
If the box is displayed as a pop-up, a "Close" button is also available on the right.
The following information is displayed in the box:
If the box is displayed as a pop-up, a "Close" button is also available on the right.
The following information is displayed in the box:
GA | The group address of the communication object. |
|---|---|
Type | Format of the communication object The following entries are possible:
|
Min | Minimum The lowest possible defined value in Expert for the communication object. |
Max | Maximum The highest possible defined value in Expert for the communication object. |
Step | If a step is defined in Expert for this communication object, it is displayed here. Otherwise: 0 |
List | If a list containing permitted values is defined in Expert for this communication object, it is displayed here. Otherwise: (empty) |
2.2.2.2.Actions
You can carry out several actions for the active communication object using the box, depending on the communication object properties:
- Not for date or time type:
A telegram can be sent to the group address to change the value of the communication object.
Depending on the setting of the switch displayed, the sent value is either set directly or (only for "integer" and "number") type, added to the current value.
If you click the arrow on the right next to the "Send" input field, the telegram is sent to the HS/FS with the value change. - Only if a value greater than zero is specified in the communication object for "Step":
Using the "+ Step" and "- Step" buttons, which are visible in this case, you can send a telegram announcing that the communication object has changed by the value specified in the "Step" field. - Only if a value list is specified in the communication object for "List":
Using the "^ List" and "v List" buttons, which are visible in this case, you can send a telegram announcing that the communication object is set to the next highest or next lowest list value based on the current value.
Note
The behaviour of communication objects with value assignments outside the min./max. limits defined for you is described in the Expert help in the Chapter "Communication objects".
2.3.PROTOCOL tab
Click the "PROTOCOL" tab to display the protocol of the telegrams received.
A list of the telegrams received is displayed in this mask with value assignments for all communication objects which were activated in the C-OBJECTS mask using the checkbox in the "GA" column.
The list is restricted to 50,000 entries and is sorted by date received, with the most recent at the top. The current fill level is displayed at the top left.
Using the symbols on the right above the list, various options are available.
Using the search field above the list, you can search for entries in the list and you can move up and down in the list using the buttons on the right ("Arrow up" and "Arrow down").
A list of the telegrams received is displayed in this mask with value assignments for all communication objects which were activated in the C-OBJECTS mask using the checkbox in the "GA" column.
The list is restricted to 50,000 entries and is sorted by date received, with the most recent at the top. The current fill level is displayed at the top left.
Using the symbols on the right above the list, various options are available.
Using the search field above the list, you can search for entries in the list and you can move up and down in the list using the buttons on the right ("Arrow up" and "Arrow down").
2.3.1.Effects of actions on the list
If the further recording of telegrams is cancelled for a group address in the C.-OJBECTS mask (checkbox in the "GA" column is deactivated), this has no effect on the lines already displayed in the list for this group address at this time.
If the browser is updated, either manually or even automatically (e.g. if the project is transferred to the HS/FS again), this has no effect on the lines already displayed in the list at this time.
If communication objects in the project are deleted or changed and entries for these already exist in the list, this has (neither directly, nor after the project has been transferred again) no effect on the lines already displayed in the list for this group address at this time.
If the browser is updated, either manually or even automatically (e.g. if the project is transferred to the HS/FS again), this has no effect on the lines already displayed in the list at this time.
If communication objects in the project are deleted or changed and entries for these already exist in the list, this has (neither directly, nor after the project has been transferred again) no effect on the lines already displayed in the list for this group address at this time.
2.3.2.List operations
| Symbol | Explanation |
|---|---|
| [n] / 50000 | Current fill level of the list and maximum value. If the list if full, the oldest entry is removed when a new telegram is received. |
| Down arrow | Download the list. A file dialogue opens with which the current list can be saved as a ".csv" file. |
| Waste basket | Empties the list currently displayed. |
| Log | Using the slider, you can temporarily interrupt the logging of telegrams without changing the selection made in the "GA" column of the C.-OBJECTS mask. When switching logging on or off, the list is not cleared. |
2.3.3.List of telegrams received
All telegrams are recorded, in other words, telegrams are also displayed which assign the same value to a communication object that it already has.
Meaning of the individual columns:
Meaning of the individual columns:
| Column | Explanation |
|---|---|
Time | Time of the last telegram received. |
GA | Group address in the format x/y/z. |
Value | Current value of the communication object. |
Type | Format of the communication object The following entries are possible:
|
Name | Name / designation of the communication object. |
3.FAQ
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 List of communication objects.
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 the 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 the 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" in order to display exactly these communication objects, or activate the options for "receive" and/or "send" in the communication object gateway settings in order 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.