Configuration
The CMe3100 is equipped with a USB slave port to make it able to connect to a computer and install the integrated web interface. By using the web interface, device and M-Bus settings are conveniently configured.
-
Connect the included USB cable between a computer and the USB slave port on the CMe3100.
-
Wait for about 30 seconds for a new removable disk is available on the computer.
-
Open the folder on the removable disk.
-
Run the file CMe3100-SETUP.EXE and follow the instructions. See CMe3100-SETUP.EXE for the setup file.
-
Wait for the installation to complete and the web browser opens along with a login page. If the browser fails to do so, enter the IP address for the device USB port manually. For firmware versions older than 1.6.0, the IP address 192.168.100.1 is used. For firmware version 1.6.0 or later, use the IP address 169.254.254.1.
-
Login using the following credentials:
Username: admin
Password: admin
After logging in for the first time, a new password will have to be registered. Use a strong password with at least 8 characters consisting of both letters and numbers. The password is case sensitive. Make sure to write your credentials down, since the only way of resetting the password is through a factory reset of the product.
Note
If the SETUP.EXE utility has already been run once on the computer, it will not have to be run again. The utility has installed a driver that creates a virtual TCP/IP connection on the computer which accesses the CMe3100 using the local IP address.
For the device to operate accurately, it is important to set the correct time and make sure that the clock stays synchronized. This is done by synchronizing it with a time server at a fixed time interval and selecting the maximum accepted time difference the device’s clock is allowed to have.
-
Go to Date & Time from the Basic setup window of the Installation panel.
-
Enter the time and select the time zone.
-
Set the Schedule for how often time will be synchronized and the maximum Accepted time difference.
-
Enter the address of the NTP (Network Time Protocol) time server in NTP server hostname or IP address
-
Enter a value in NTP server timeout. The timeout determines how long the Metering gateway will wait for the time server to respond during a time synchronization attempt before interrupting the action.
-
Select Save.
Note
The time synchronizing schedule to be used depends on how precisely the clocks need to be synchronized. If the maximum acceptable time drift is about one minute per month, a schedule of every 12 hours should ensure the product has less than one second of time difference (31 days × 24 hours = 744 hours; 60 seconds ÷ 744 hours × 12 hours ≈ 0.97 seconds). The default value is suitable for most cases and provides ample time for synchronization.
If the radio link between the product and the time server is of inadequate quality, the value might have to be increased until reliable operation is obtained. It is important to note that a radio link with inadequate quality will negatively affect the performance of the time synchronization as it relies on low latency communication.
Note
You may disable the use of time synchronization and manually enter time and date in the product if the long-term accuracy is not a concern. However, be aware of:
-
The product has a built-in supercapacitor that can maintain the time and date during a power outage for up to approximately 24 hours. After that, the clock will stop running, and the time will be offset accordingly.
-
The built-in clock will drift over time, with a theoretical worst-case scenario of about one minute per month. However, this drift will be smaller in practice and will vary due to factors such as temperature, tolerances, and the age of components
-
If you are using multiple products for collecting meter values, it is strongly advised that you configure the products to use time synchronization to ensure that measurements from several sources are aligned with regards to time and date.
Configuring the basic network settings will enable the Metering Gateway to connect to the network. This is necessary to enable the Metering Gateway to connect to servers and deliver its collected meter data.
There are two types of IP address assignment options available, the static and the dynamic option. Using a static IP address enables assignment of the IP address manually. It will thereafter stay constant over time. By using dynamic IP addressing instead, an available IP address is automatically assigned to the Metering Gateway through a DHCP server, which must be available on the local network.
-
Go to Network settings from the Basic setup window in the Installation panel or via Configuration > Network
-
Choose Dynamic (DHCP) or Static IP address assignment. If selecting the static option, enter IP-addresses and a netmask.
-
Select Save.
Note
It is highly recommended to use dynamic IP-address assignment to avoid mistakenly duplicated IP-addresses and make IP-address administration as easy as possible. Refer to your IT administrator for details and/or more information about what network settings to use.
The hostname setting determines which name the Metering gateway will use to identify itself on the network. If not changed, a default name based on the product name and serial number will be used, e.g., “cme3100–0016002383”. The hostname is ONLY used for network addressing and should not be confused with the product’s name, the latter is used to identify the product in e.g., Push Reports. For more information about how to configure the device name used in Push Reports, see Configuring identity settings for Push Reports
-
Go to Network settings from the Basic setup window in the Installation panel or via Configuration > Network
-
Enter the Hostname that will be assigned the Metering gateway.
-
Select Save
Note
Your DHCP server must have enabled support for dynamic DNS update to support resolution of the hostname to an IP-address. Refer to your IT administrator for details and/or more information about what features that are supported.
The Domain Name Server (DNS) is used to find and retrieve information about the IP address corresponding to a certain domain name. DNS information can be configured manually or be obtained from a Dynamic Host Configuration Protocol (DHCP) server.
The Meter List contains information about all meters that the device will read and needs to be uploaded to the web interface before meters can be installed.
The Meter List template is available for download directly from the web interface under Meters > Install
Template of Meter List
Table 96. Meter list fields
|
Column |
Explanation |
|---|---|
|
Position |
The position represents the name that will be used to identify the meter in the Meter List of the web interface. It may be arbitrarily chosen, but it is recommended to assign the field a name that relates to the meter’s function, e.g., its position in the metering system. |
|
SecondaryAddress |
The secondary address is set by the manufacturer and is printed on the meter. This address is unique for each device and expressed as an 8-digit number. |
|
BaudRate |
The Baud rate determines the speed of communication between the Metering Gateway and the meters. Set the field to “300” or “2400” (bit/s), but make sure that all meters support the baud rate selected. |
|
AddressingMode |
The addressing mode sets the way meters are addressed by the Metering Gateway. There are three options: the primary and the secondary addressing mode used for Wired M-Bus and the enhanced secondary addressing mode used for Wireless M-Bus. Set this field to one of:
|
|
Primary Address (optional) |
The primary address is assigned to the meter by the user as a number between 0 and 255. The column is optional to fill out. However, if using primary addressing mode, it will have to be included. |
|
Enhanced Address (optional) |
The enhanced address is only used when communication with the meters is held through a Wireless M-Bus Receiver. Nothing needs to be added to this column. |
If not aware of the addresses of the meters, it is possible to perform an automatic search and installation of meters without uploading a Meter List. However, this also means that you will have to verify that the correct meters have been installed after the installation has completed.
When the installation has been completed, all installed meters will be displayed in the Meter List of the web interface, under Meters > Meter List. A Commission Report should always be downloaded after the installation to help ensure it was successful.
Note
Make sure that your license matches the number of meters included in the Meter List. If you try to install more meters than your license supports, some will be marked as passive. By going to Meters > Meter List and check Show passive meters, passive meters will be displayed.
When using Wired M-Bus, each meter is addressed using either its primary or secondary address. It is recommended to use the secondary addressing mode, since this will ensure that each meter is addressed in a unique way.
-
Go to Meters > Install.
-
Select a Meter List, structured as comma-separated values (CSV format) to upload. The Meter List can be created in Excel and saved as a CSV file. The template can be downloaded from the web interface.
-
Select Install to upload the Meter List to the web interface and install the included meters.
Example file of wired Meter List
When using Wireless M-Bus, the Metering gateway communicates with meters through one or several Wireless M-Bus Receivers. Each Elvaco Wireless M-Bus Receiver will assign itself an enhanced address and by combining it with the secondary address of the meter, the communication chain is specified. The Metering gateway will automatically communicate with each meter through the Wireless M-Bus Receiver that has established the best connection.
-
Go to Meters > Install.
-
Select a Meter List, structured as comma-separated values (CSV format) to upload. The Meter List can be created in Excel and saved as a CSV file. The template can be downloaded from the web interface.
-
Select Install to upload the Meter List to the web interface and install the included meters.
Example file of wireless Meter List
Note
If conditions have changed since the last installation, for example if a meter has been moved, another Wireless M-Bus Receiver might be able to establish a better connection with that meter. By performing a reinstallation, communication will then be held through that Wireless M-Bus Receiver instead. To perform a reinstallation, go to Meters > Reinstall > Reinstall
After installing meters, a commission report should always be downloaded. This report contains information about the settings of all installed meters and will help ensure that the installation was successful.
-
Select Export commission report in the Meter list window of the Installation panel.
A download of the document will start.
-
Open the downloaded document.
There are up to five different files in the commission report. The first one provides an overview of the Metering gateway settings, the second file contains an overview of installed slave devices, the third file displays the latest value for each measurement series, the fourth file provides an overview of what slave devices that have Modbus enabled, and the fifth file provides an M-Bus to BACnet mappings if BACnet license is activated.
When all meters have been installed, a readout schedule can be set. It will determine the time interval by which the Metering Gateway will perform readouts of the meters in its Meter List.
When all meters have been installed and the readout schedule has been set, Push Reports can be enabled. The Push Reports structure the data from the meter readouts by a chosen template and are delivered by a set schedule and protocol.
The Push Reports can be delivered by e-mail (SMTP), as a downloadable file (FTP), uploaded to a server running a HTTP web service or published to an MQTT broker (MQTT). The first step is to set the default recipient option for the alternatives that will be used. All activated Push Reports will be sent to the default recipient if not overridden in the settings of an individual Push Report.
-
Go to Configuration > Push Reports > MQTT settings.
-
Specify the URL and port of your MQTT broker where Push Reports will be sent.
-
Secure connection (SSL/TLS): server.domain.com or ssl://server.domain.com (Default port: 8883).
-
Unsecure connection (TCP): tcp://server.domain.com (Default port: 1883).
-
-
[Optional] Set a Base topic to prepend to the MQTT topic structure.
-
Set the Client ID of the CMe3100 for the MQTT broker.
-
Provide user credentials (Username and Password) if the MQTT broker require it. Otherwise leave fields empty.
-
If using a secure connection, insert the MQTT JKS (Java KeyStore) file for SSL/TLS encryption.
-
Select Save or press Enter.
Note
Elvaco strongly recommends using a secure connection.
After the Push Report default settings have been made, individual reports can be configured. Go to Configuration > Push Report for an overview of all available reports and their status is provided. There are two types of reports available, Push Reports and Event Reports.
Table 97. Type of reports
|
Type of report |
Explanation |
|---|---|
|
Push Report |
Push Reports are used to deliver meter values by a set time interval, structured according to a selected template. |
|
Event Report |
The Event Report is triggered by a certain event taking place in the Metering Gateway. A schedule does therefore not have to be set for this type of report. |
By default, the Metering gateway supports four protocols for delivering reports:
-
E-mail
-
FTP
-
HTTP
-
MQTT
Each delivery protocol has several predefined Report Templates available. Report template names starts with a unique number depending on the protocol used for transporting the report:
-
E-mail reports
-
FTP reports
-
HTTP reports
-
MQTT reports
E.g., report *101, a report with all meter values collected in one single post, will be named:
-
1101 when sent as an E-mail report
-
2101 when sent to an FTP server
-
3101 when sent to an HTTP server
-
4101 when sent to an MQTT broker using csv format
-
4201 when sent to an MQTT broker using JSON format
-
Go to Configuration > Push Report and select an arbitrary Push Report.
-
Set what type of report to use (e-mail, FTP, HTTP or MQTT) and the desired template.
-
Set the Report schedule, preferably by using one of the preset options available. It will determine the time interval by which the Push Report will be sent.
-
Set the Value Period to Auto to ensure that all new meter values that have failed to be transmitted will be included in the next successful Push Report, thus also providing an automatic recovery mechanism.
-
Set the Value Interval to All values to include all available meter readouts in the Push Reports (as defined by the readout schedule).
-
Add recipients of the report. If no recipient is added, the default option will be used.
-
Select Save. By selecting Save & Send test report or Save & Download test report, you will receive a copy of the Push Report, structured according to the template you have selected. In this way, you may test different templates to find the one you wish to use.
Save the report on disk (HTTP and FTP)
It is possible to save the report on disk. It will be stored on the CMe3100 and available for download.
-
Perform the procedure described in above.
-
Before clicking on the chosen saving option, make sure to check the box Save the report on disk.
-
If command.report.local is enabled: the report will be both stored and uploaded to FTP-server.
Note
The maximum storage on disk is 50M. If the total storage exceeds 50MB, the system will start deleting reports until storage is below 50MB. The oldest reports will be deleted first.
A configuration file contains all non-device specific settings such as readout schedule and Push Report configurations (but excludes IP address, etc.). By using a configuration file, settings may be restored on an individual device or duplicated to a group of devices without having to go through all steps manually. Therefore, a configuration file should always be saved before performing an update to be able to restore the settings of the Metering Gateway if something should go wrong.
A backup file contains all meter values stored by the Metering gateway and all settings including device specific settings. By using a backup file, the settings and stored data of a device may be completely restored and is suitable for restoring a device if the hardware is replaced. However, it should not be used to duplicate settings into different devices as it contains device specific settings such as IP address.
Note
Backup files can take a long time to create and restore settings and data from. They also consume a lot of storage space. It is therefore not recommended to keep more than one backup file in the device’s repository at a given time. You may however of course choose to download backup files and keep them safe using another media.
The minimum severity level for an event that gets stored in the System log is configurable but should not be adjusted without good reasons as it may cause vital information to be lost or the log to become very extensive.
-
Go to System > System log > Filter settings.
-
Choose a minimum severity level of the logs that should be saved. By choosing 0", all events except the debug events are logged. By choosing -1, all events including the debug events are logged.
-
Select Save.
Note
It is highly recommended that the debug log entries are only logged in case of troubleshooting. If not, the System Log will fill up fast, and it might be hard to navigate. Activating debug log entries might also affect the performance of the Metering gateway in a negative way.
Note
In firmware version 1.15.0, to confirm that your MQTT publish to the broker was successfully completed, you need to set the system log filtering level to -1 (debug). This will allow you to see in the log that the source MQTTReportSender was executed successfully.
Important! Remember to reset the log filtering settings back after received the confirmation for optimal performance of your CME3100.
It is possible to control when information about M-Bus status byte is logged to the meter log.
The CMe3100 has a built-in management system for wireless encryption keys. The meter encryption key is registered in the web interface and will be used by the Metering gateway to enable decryption of incoming messages.
Encryption keys are uploaded in an encryption key file (CSV or Excel 97-2003), or registered directly in the web interface. The encryption key file contains the matching criteria for each key which defines a filter for what meters the encryption key will be applied to.
Template of encryption key file
Table 98. Encryption key file fields
|
Encryption key field |
Explanation |
|---|---|
|
Address |
This field contains the secondary address of the meter that the encryption key will be applied to. Set -1 to exclude this field from the matching criteria. |
|
Key |
This field contains the actual encryption key that will be used, consisting of 32 characters in hex format. |
|
Manufacturer |
This field contains the manufacturer of the meter that the encryption key will be applied to. To find a list of the different manufacturers, and their initials, go to Meters > Encryption keys > Add new key. Uncheck the Manufacturer box and use the list. Use “*” character to exclude this field from the matching criteria. |
|
DeviceType |
This field contains the type of meters which the encryption key will be applied to. To find a list of the different device types, go to Meters > Encryption keys > Add new key. Uncheck the Type box and use the list. Use -1 to exclude this field from the matching criteria. |
|
Version |
This field contains the version of the meter that the encryption key will be applied to. Use -1 to exclude this field from the matching criteria. |
-
Go to Meters > Encryption keys. Here, a list of all registered encryption keys is displayed.
-
Select Import list and select the file. To download the template, select Download example file.
-
Select Save.
Encryption key example file
The Metering gateway supports linking encryption keys to individual meters. Using this option will make the device apply the key to decrypt information from the linked meters only.
In some cases, it might be desired to configure individual settings of a specific meter. This might for example include changing the Measurement Object Identification (MOID), switching the state of the meter from active to passive (which will exclude it from the meter readout cycle) or changing the interface used by the Metering gateway when communicating with the meter.
The MOID is used to identify the meter in the Meter List and is preferably set to display the function or the location of the meter.
Switching a meter’s status from active to passive means that it will no longer be included in the meter readout process. If more meters are installed than the software license supports, the latest installed meters will automatically be set to passive.
The meter access settings determine which interface will be used by the M-Bus Metering gateway to access a specific meter. Normally, all meters are connected directly or indirectly to the integrated M-Bus master (by 2-wire M-Bus or the IR interface)
Comments (0 comments)