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 (EIB) 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 Communication objects mask, which contains exactly one entry (one line) for each group address. Besides the group address and the current value, this entry can also contain the name of the communication object and other information.
In a second list on the Protocol mask, 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 (EIB) 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 Communication objects mask, which contains exactly one entry (one line) for each group address. Besides the group address and the current value, this entry can also contain the name of the communication object and other information.
In a second list on the Protocol mask, 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
Caution
If you change any of the following settings in the Expert software, you must reload the project!
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 Access via WebSocket setting must be activated.
The other options that can be configured here are described in the Expert help for the Communication object gateway.
The other options that can be configured here are described in the Expert help for the Communication object gateway.
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
The login mask appears when HS Monitor is started. You can specify the key defined in the Expert project for the communication object gateway data connection here.
HS Monitor remembers this key until you quit the browser.
HS Monitor requires you to enter this key when starting HS 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 reloaded.
You can also specify the key directly as a parameter in the URL when calling HS Monitor.
HS Monitor remembers this key until you quit the browser.
HS Monitor requires you to enter this key when starting HS 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 reloaded.
You can also specify the key directly as a parameter in the URL when calling HS Monitor.
Examples of calls
Example of calling HS Monitor on a HS/FS with IP address 192.168.0.11 with secure communication:
You can specify the key during the call (see Settings).
Example of the same call together with the key “my123key”:
HTTPS://192.168.0.11/opt/hsmonitor/index.htmlYou can specify the key during the call (see Settings).
Example of the same call together with 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 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.
Communication objects tab
Displays the Communication objects mask with the list of the communication objects provided in the project and the action bar. HS Monitor starts with this display.
Protocol tab
Displays the Protocol mask.
Each entry in the list displays a telegram for one of the communication objects that was selected for logging in the Communication objects mask (in other words, the checkbox for the communication object in question is activated in the column on the left).
If the Communication objects mask is currently active, a badge is displayed at the top right of the Protocol tab when a new telegram is received, which displays the number of new telegrams received since exiting the Protocol mask (or since starting HS Monitor if you did not call the Protocol mask).
When you display the Protocol mask again, the badge is removed and the numbering is reset to '0'.
Each entry in the list displays a telegram for one of the communication objects that was selected for logging in the Communication objects mask (in other words, the checkbox for the communication object in question is activated in the column on the left).
If the Communication objects mask is currently active, a badge is displayed at the top right of the Protocol tab when a new telegram is received, which displays the number of new telegrams received since exiting the Protocol mask (or since starting HS Monitor if you did not call the Protocol mask).
When you display the Protocol mask again, the badge is removed and the numbering is reset to '0'.
Connection status
A symbol displaying two arrows is located on the left next to the “HS Monitor” text. This symbol displays the current connection status between HS Monitor (in the browser) and HS/FS.
It can have two colours:
It 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 the “Anz. / Count” column is reset 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.Communication objects mask
The list of 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.
You can find details on the individual columns in the list in the List of communication objects section.
By clicking a line, you can select it for specific actions:
Each communication object is represented by exactly one line in the list.
You can find details on the individual columns in the list in the List of communication objects section.
By clicking a line, you can select it for specific 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 identifying communication objects for logging. Each communication object activated with this checkbox is recorded in the Protokoll / Protocol. |
| Grp.-Adr. | Group address in x/y/z format. |
| Name | Name of the communication object. |
| Anz. / Count | Number of telegrams received since starting HS Monitor. |
| 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 smallest possible value defined in Expert for the communication object. |
| Max | Maximum The largest possible value defined in Expert for the communication object. |
| S L | Flag for Schrittgröße / Step and Liste / List If a step is defined in Expert for this communication object, S is displayed. If a list is defined in Expert for this communication object, L is displayed here. |
2.2.2.Action bar
The action bar on the right-hand edge of the Communication objects mask enables you to filter the adjacent list and/or assign new values to individual communication objects.
This does not apply to communication objects with the “date” and “time” format as they can only be viewed and not changed using HS Monitor.
To change a communication object, you must first select (click) the corresponding line. The line is then displayed with a grey background.
This does not apply to communication objects with the “date” and “time” format as they can only be viewed and not changed using HS Monitor.
To change a communication object, you must first select (click) the corresponding line. The line is then displayed with a grey background.
Filter (magnifying glass symbol)
You can filter the list of communication objects, in other words, as soon as you enter a filter, only 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 order of the specified filters is not important.
- The filter criteria are applied to the “Grp.-Adr.” and “Name” fields.
- To remove filtering, clear the filter field.
Note
Selecting a line has no effect on filtering.
The behaviour of communication objects when values outside the minimum/maximum limits defined for them are assigned is described in the “Communication objects” section of the Expert help.
The behaviour of communication objects when values outside the minimum/maximum limits defined for them are assigned is described in the “Communication objects” section of the Expert help.
Wert setzen / Send Value
When you specify a value in the input field, the value of the communication object changes accordingly when you click one of the following buttons:
- Absolut(e): The current value of the communication object is set to the value entered.
- Relativ(e): The value entered is added to the current value of the communication object.
Note
To subtract a value, enter a number with a “minus” sign in front of it and click “Relativ(e)”.
Schrittgröße / Step
Note
This input box is only visible if a step has been defined in the project for the communication object.
The step is displayed.
By clicking one of the two buttons (“+” or “-”), the step is added to the current value of the communication object (“+” button) or subtracted from it (“-” value).
By clicking one of the two buttons (“+” or “-”), the step is added to the current value of the communication object (“+” button) or subtracted from it (“-” value).
2.3.Protocol mask
This mask displays the list of telegrams received.
You can also delete the list and/or export it here.
You can also delete the list and/or export it here.
2.3.1.List of telegrams received
| Column | Explanation |
|---|---|
| Zeit / Time | Time when the value was assigned. |
| Grp.-Adr. | Group address. |
| Wert / Value | The value assigned to the communication object. |
| Name | The name of the communication object. |
| Typ(e) | Format of the communication object The following entries are possible:
|
Note
If you deactivate one or more communication objects, this does not affect the lines already displayed in the list at this point.
Note
If you refresh the browser manually, or if this is triggered automatically (e.g. when reloading the project on the HS/FS), this does not affect value assignments already displayed in the list at this point.
If you delete or change communication objects in the project for which entries already exist in the list, this does not affect these entries even after the project has been reloaded.
If you delete or change communication objects in the project for which entries already exist in the list, this does not affect these entries even after the project has been reloaded.
2.3.2.Processing toolbar
The processing toolbar on the right-hand edge of the Protocol mask provides options for editing the list and further processing the data displayed.
3.FAQ
Problem: Only the group addresses and the values are displayed.
Solution: Under Master data -> Project settings -> Network -> Communication object gateway in the Expert, the “Load XML structure of communication objects on device” option must be activated.
Problem: No group addresses are displayed in the Communication objects mask.
There are several possible causes of this error:
- An error in the access configuration
- An error in the setup configuration
- The IP address of the device on which HS Monitor is running is not included in the list of 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 included in the list of permitted sender addresses, but the key defined there is a different key to the one you specified in the browser:
- Call
- Settings
- Expert: Master data -> Project settings -> Network -> Communication object gateway
Problem: Some group addresses are missing in the Communication objects mask.
There are several possible causes of this error:
- Certain options are deactivated in Expert:
Under Master data -> Project settings -> Network -> Communication object gateway, one or both of the following options are deactivated:- Activate receiving for all communication objects
- Activate sending for all communication objects
- Receive communication object gateway
- Send communication object gateway
Solution: Activate the options for “Receiving” and/or “Sending” next to the individual communication objects to display precisely these communication objects, or activate the options for “Receiving” and/or “Sending” in the communication object gateway settings to display all communication objects with an assigned group address irrespective of the settings in the individual communication objects. - You have not assigned a group address to the “missing communication objects”:
Solution: Enter a group address for each required communication object under Master data -> Communication object.