Operation

Basic operation

The basic operations provides instructions on how to getting started with the most basic functionality and configurations of the CMe2100/CMi2110/CMi2130. After executing each step described, the product will be performing scheduled meter readouts and deliver customized Push Reports with meter values. Please read through each section carefully.

Starting up the product

On successful connection of power, the CMe2100 will be ready to use after undergoing a booting session of approximately 30 seconds to one minute.

Install meters

Before the CMe2100/CMi2110/CMi2130 can be able to read meters, meters will have to be installed. As part of the installation process, the CMe2100/CMi2110/CMi2130 will synchronize its time with a public time server. The product is set to use the NTP server se.pool.ntp.org for time synchronization as a default option.

The CMe2100/CMi2110/CMi2130 supports three different ways of addressing meters on the M-Bus: primary addressing, secondary addressing, and enhanced secondary addressing. A description of each mode is provided in the following table.

Addressing mode

Explanation

Primary addressing

The CMe2100/CMi2110/CMi2130 uses the primary address of the meter, set by the end-user when addressing meters on the M-Bus.

Note

Only applicable for wired M-Bus.

Secondary addressing

The CMe2100/CMi2110/CMi2130 uses the secondary address of the meter, set by the manufacturer when addressing meters on the M-Bus. The secondary addressing mode will be used by default and is the recommended option since it will ensure that each meter is addressed uniquely.

Note

Only applicable for wired M-Bus.

Enhanced secondary addressing

The CMe2100/CMi2110/CMi2130 combines the enhanced address of a Wireless M-Bus Receiver and the secondary address of a meter when addressing meters on the M-Bus.

Note

Only applicable for wireless M-Bus.

Tip

After the installation has been completed, the CMe2100/CMi2110/CMi2130 will automatically read all installed meters once every hour and deliver a Push Report to all default e-mail recipients at 00:00 every day. For information on configuring these default settings, see Schedule meter readouts and Configure Push report default settings.

Install Wired M-Bus meters

To install Wired M-Bus meters:

  • Send the following command to the product.

    install [expected numbers of meters]

    The product will respond with an SMS confirming that the installation has started.

    When the installation has finished, the product will send an additional SMS, informing about the number of meters that were installed and their addresses. The installation may take up to 20 minutes to complete, depending on the number of meters.

    As part of the installation process, the CMe2100/CMi2110/CMi2130 will synchronize the time with a public time server.

Variable

Explanation

Settings

Expected number of meters

This variable is optional to include. It sets the number of meters the CMe2100/CMi2110/CMi2130 should expect to find in the installation process. Including this variable might speed up the installation, by letting the product know when all meters have been found and the search for more meters should stop.

Arbitrary integer

CMe2100_Install_Wired_M-Bus_meters.png

Install Wireless M-Bus meters

CMe2100/CMi2110/CMi2130 communicates with Wireless M-Bus meters through one or several Wireless M-Bus Receivers by using an enhanced secondary address. The enhanced secondary address comprises a combination of the meter secondary address and the M-Bus Receiver enhanced address, thereby defining the complete communication chain.

To install Wireless M-Bus meters, the addressing mode needs to be set to “esecondary”. Besides that, the installation is identical to Wired M-Bus meters.

Tip

The CMe2100/CMi2110/CMi2130 will automatically use the Wireless M-Bus Receiver that has established the best connection with each specific meter.

To install Wireless M-Bus meters:

  1. Send the following command to the product to set its addressing mode to “enhanced secondary”.

    set common.device.mbus.searchmode=esecondary

    The product will respond with an SMS confirming that the addressing mode has been set.

  2. Send the following command to the product to start the installation.

    install [expected number of meters]

    The product will respond with an SMS confirming that the installation has started.

    When the installation has finished, the product will send an additional SMS, informing about the number of meters installed and their addresses. The installation may take up to 20 minutes to complete.

    As part of the installation, the CMe2100/CMi2110/CMi2130 will synchronize the time with a public time server.

Variable

Explanation

Settings

Expected number of meters

This variable is optional to include. It sets the number of meters the CMe2100/CMi2110/CMi2130 should expect to find in the installation process. Including this variable might speed up the installation, by letting the product know when all meters have been found and the search for more meters should stop.

Arbitrary integer

CMe2100_Install_Wireless_M-Bus_meters.png

Installing meters by using a Settings Command File

A meter installation can be performed by running a settings command file. The CMe2100/CMi2110/ CMi2130 will then connect to Elvaco’s server, download a CAD file, and synchronize its settings with it. In this way, a customized installation, including what settings to use and which meters to install, can easily be configured. Contact Elvaco for more information.

To perform an installation using a settings command file:

The product will respond with an SMS confirming that the installation has started.

When the installation has finished, the product will send an additional SMS, informing about the number of meters installed and their addresses. The installation may take up to 20 minutes to complete.

As part of the meter installation, the CMe2100/CMi2110/CMi2130 will synchronize the time with a public time server.

  • Send the following command to the product.

    install [expected number of meters] [cad file]

Variable

Explanation

Settings

Expected number of meters

The maximum number of meters the CMe2100/CMi2110/CMi2130 should expect to find in the installation process. This field needs to be included when performing an installation using a Settings Command File.

Arbitrary integer

CAD file

The name of the Settings Command File that the CMe2100/CMi2110/CMi2130100 will download and synchronize with. Contact Elvaco for more information.

Name of a valid CAD file

CMe2100_Install_by_using_a_Settings_Command_File.png

Schedule meter readouts

After the meter installation has been completed, the CMe2100/CMi2110/CMi2130 will by default read all meters once every hour. This default option can be configured by setting a new meter readout schedule.

A meter readout schedule can be selected from the following table or an arbitrary set using cron patterns. To learn more about cron patterns, see Specify schedules using cron patterns.

Time interval

Explanation

5-min

A meter readout is performed every 5th minute.

15-min

A meter readout is performed every 15 minutes.

1-hour

A meter readout is performed every hour.

12-hour

A meter readout is performed every 12th hour.

1-day

A meter readout is performed every day at 00:00.

1-week

A meter readout is performed every Monday at 00:00.

1-month

A meter readout is performed on the first day of every month at 00:00.

Setting a meter readout schedule

  • Send the command to the product.

    sch storevalue [time interval]

    The product will respond with an SMS confirming that the readout schedule has been set.

Variable

Explanation

Settings

Time interval

The schedule by which the CMe2100/CMi2110/CMi2130 will perform meter readouts.

5min, 15min, 1hour, 12hours, 1day, 1week, 1month

CMe2100_Set_a_meter_readout_schedule.png

Push report settings

Push reports deliver data from meter readouts to selected recipients by a chosen time schedule and report template. Push reports can be delivered by e-mail, SMS, uploaded as a downloadable file on an FTP server, or to a server running an HTTP web service. The first step is to set the default recipient option for each of the alternatives that will be used. A complete list of the configurable settings for each type of recipient can be found in Configurable settings.

Configuring e-mail push report default settings

  • Send the following command to the product.

    qset email [recipient] [e-mail server] [username] [password]

    Tip

    • Additional e-mail recipients can be added anytime by using the following command:

      qset email +[recipient]

    • By using the following commands copies and hidden copies can be added for a Push Report respectively:

      • set common.email.cc=[recipient]

      • set common.email.bcc=[recipient]

    The product will respond with an SMS confirming that the e-mail default settings have been configured.

Variable

Explanation

Settings

Recipient

The e-mail addresses of all intended default recipients of Push Reports are separated by a comma.

List of valid e-mail addresses.

E-mail server

The SMTP (e-mail) server used by the CMe2100/CMi2110/CMi2130 to deliver e-mail Push Reports. Elvaco provides an SMTP server, which is free to use, and set by default for all CMe2100/CMi2110/CMi2130 products. This field is therefore optional to include.

Valid SMTP (e-mail) server

Username

The username is used by the CMe2100/CMi2110/CMi2130 to access the SMTP server.

Text

Password

The password used by the CMe2100/CMi2110/CMi2130 to access the SMTP server.

Text

CMe2100_Configure_e-mail_Push_Report_default_settings.png

Configuring FTP push report default settings

  • Send the following command to the product.

    qset ftp [ftp server][port] [username] [password] [remotedir]

    The product will respond with an SMS confirming that the FTP default settings have been configured.

Variable

Explanation

Settings

FTP server

The FTP server where FTP Push Reports will be uploaded. Contact your IT administrator for more information about what FTP server your company is using.

Valid FTP server.

Port

FTP server port number.

Valid port number

Username

The username is used by the CMe2100/CMi2110/CMi2130 to access the FTP server.

Arbitrary text

Password

The password used by the CMe2100/CMi2110/CMi2130 to access the FTP server.

Arbitrary text

Remotedir

The directory where FTP Push Reports will be uploaded.

Valid directory on the FTP server.

CMe2100_Configure_FTP_Push_Report_default_settings.png

Configuring HTTP push report default settings

  • Send the following command to the product.

    qset http [server url] [username] [password] [authmode]

    The product will respond with an SMS confirming that the HTTP default settings have been configured.

Variable

Explanation

Settings

Server URL

The URL of the HTTP server where HTTP Push Reports will be uploaded. Contact your IT administrator for more information about what HTTP server your company is using.

URL of valid HTTP server.

Username

The username is used by the CMe2100/CMi2110/CMi2130 to access the HTTP server.

Arbitrary text

Password

The password is used by the CMe2100/CMi2110/CMi2130 to access the HTTP server.

Arbitrary text

Authmode

The authentication mode is used when connecting to the HTTP server.

none, basic

CMe2100_Configure_HTTP_Push_Report_default_settings.png

Configuring SMS push report default settings

  • Send the following command to the product.

    set common.sms.to [phone numbers]

    The product will respond with an SMS confirming that the list of phone numbers has been set.

Variable

Explanation

Settings

Phone numbers

A list of phone numbers, separated by a comma, will be the default recipients of SMS Push Reports.

A list of valid phone numbers.

CMe2100_Configure_SMS_Push_Report_default_settings.png

Push reports and event reports

CMe2100/CMi2110/CMi2130 supports two types of reports, push reports and event reports. The difference between the two is explained in the following table. The CMe2100/CMi2110/CMi2130 supports four different report delivery protocols: HTTP, FTP, e-mail, and SMS. Each delivery protocol has several predefined report templates available, which will set by which protocol the report will be delivered. For example, by selecting an e-mail report template, the corresponding report will be delivered by e-mail.

Report template numbers always start with “1” for e-mail, a “2” for FTP, and “3” for HTTP. For example, selecting the e-mail report template 1101 (2101 for FTP, 3101 for HTTP) will structure all meter values in one single post while template, 1112 (2112 for FTP, 3112 for HTTP) will deliver the meter values in an Excel file. All FTP, HTTP, e-mail, and SMS report templates are listed in the Report templates.

Tip

To learn more about the different report templates, please visit http://www.elvaco.com and go to Downloads.

Table 3. Types of reports

Type of report

Explanation

Push report

Push reports deliver meter values by a selected report template and time schedule.

Event report

Event reports are triggered by a certain event taking place in the CMe2100/CMi2110/CMi2130. A schedule can therefore not be set for this type of report.


Scheduling push reports

There are five different push reports available report1 - report5. Each one is easily enabled and disabled using the set command. A push report schedule is set using the predefined time interval values from Table 4, “Push report schedule options” or by using cron patterns. To learn more about cron patterns, see Specify schedules using cron patterns.

Note

Recipient information added for individual push report will override default recipient settings. For example, setting an e-mail recipient for report1 will be used instead of the default e-mail recipient option.

Table 4. Push report schedule options

Time interval

Explanation

1min

A push report, containing all stored values from the last minute, is sent once every minute.

5min

A push report, containing all stored values from the last five minutes, is sent once every 5th minute.

10min

A push report, containing all stored values from the last ten minutes, is sent once every 10th minute.

15min

A push report, containing all stored values from the last 15 minutes, is sent once every 15th minute.

20min

A push report, containing all stored values from the last 20 minutes, is sent once every 20th minute.

30min

A push report, containing all stored values from the last 30 minutes, is sent once every 30th minute.

1hour

A push report, containing all stored values from the last hour, is sent once every hour.

12hour

A push report, containing all stored values from the last 12 hours, is sent once every 12th hour.

1day

A push report, containing all stored values from the last day, is sent at 00:00 each day.

1week

A push report, containing all stored values from the last week, is sent every Monday at 00:00.

1month

A push report, containing all stored values from the last month, is sent on the first day of each month at 00:00.


To schedule a push report:

  1. Send the following command to the product to have the push report delivered to the default recipients by the set schedule and template.

    sch [report] [schedule] [template]

    CMe2100_Schedule_Push_Reports__Step_1_.png
  2. By extending the following command, the default recipients will be overridden by the new recipient information added for the specific push report.

    sch [report] [schedule] [template] [type of recipient]= [recipient]

    CMe2100_Schedule_Push_Reports__Step_2_.png

    The product will respond with an SMS confirming that the push report schedule has been set.

Table 5. Scheduling push reports

Variable

Explanation

Settings

Report

The report is to be configured. There are five different push reports available.

report1, report2, report3, report4, report5

Schedule

The schedule by which the push report will be delivered.

A selected value from Table 4, “Push report schedule options”

Template

The number of a report template. The selected template will determine to what type of recipients the push report will be delivered. For example, setting the template to 1101 (e-mail template) will deliver the push report to e-mail recipients only. All report templates are available on the Elvaco website, http://www.elvaco.com

Valid report template number.

Type of recipient

The type of recipient the push report will be delivered to. See Table 6, “Push report protocols” for more information.

email.to, ftp.server, http.url, sms.to

Recipient

The addresses of the push report recipients.

Valid e-mail addresses, phone numbers, or server addresses.


Table 6. Push report protocols

Field

Explanation

email.to

Used to set up a list of e-mail addresses to receive the push report.

ftp.server

They are used to set up an FTP server where the push report will be uploaded as downloadable files.

http.url

Used to set up an HTTP server, where push reports will be uploaded.

sms.to

Used to set up a list of phone numbers to receive the push reports by SMS.


Enabling event reports

There are five different events available for CMe2100/CMi2110/CMi2130, each one described in Table 8, “List of events”. If an event is triggered, an event report will be delivered to all e-mail default recipients.

To enable an event report:

  • Send the following command.

    set [event].enabled=true

    The product will respond with an SMS confirming that the event report has been enabled.

Table 7. Enable event reports

Variable

Explanation

Settings

Event

The event that will trigger the event report.

An arbitrary command from Table 8, “List of events”


Table 8. List of events

Variable

Explanation

Command

Reboot event

Triggered when the CMe2100/CMi2110/CMi2130 undergoes a reboot.

rebootevent

Balance event

Triggered when the credit balance of the SIM card falls below a set limit.

balanceevent

Firmware update

Triggered when the firmware is updated for the CMe2100/CMi2110/CMi2130.

fwupdate

Software update

Triggered when the software is updated for the CMe2100/CMi2110/CMi2130.

swupdate

Software update synchronization

Triggered when the CMe2100/CMi2110/CMi2130 perform a synchronization as part of the software update process.

swupdatesynchandler


CMe2100_Enable_Event_Reports.png

For the balance event, the credit limit of the SIM card that will trigger the report can be set.

To set the balance event credit limit:

  • Send the following command to the product.

    set common.event.balance.low=[credit limit]

    The product will respond with an SMS confirming that the credit limit has been configured.

Table 9. Balance low credit limit

Variable

Explanation

Command

Credit limit

The credit limit will trigger the balance event report.

An arbitrary number.


CMe2100_Set_Balance_Event_credit_limit.png

Download a commission report

After performing a meter installation and setting push report schedules, a commission report should always be downloaded. It contains information about all current settings, including installed meters and push report recipients. Upon request, the commission report will be delivered to all default e-mail recipients. For more information on the commission report, see Sysreport – Execute a system report.

Requesting a commission report

  • Send an SMS with the following command to the product.

    sysreport

    The product will respond with an SMS confirming that the report has started, and the commission report will be delivered to all default e-mail recipients.

CMe2100_Request_a_Commission_Report.png

Common operation

When having the product up and running and you are comfortable with its basic operations, additional features and functions can enhance the operation of the product further.

Configuring settings by using a settings command file

A settings command file can be used to very quickly configure all desired settings of your product. The CMe2100/CMi2110/CMi2130 will connect to Elvaco’s server and download a CAD file to synchronize its settings with.

To configure product settings using a settings command file:

  • Send the following command to the product.

    sync [cad file]

    Tip

    Make sure to contact Elvaco before performing synchronization to make sure that a CAD file customized to your wants can be created.

    The product will respond with an SMS confirming that the synchronization was successful.

Table 10. Configure settings using a settings command file

Variable

Explanation

Settings

CAD file

The name of the settings command file that CMe2100/CMi2110/CMi2130 will download and synchronize its settings with. Contact Elvaco for more information.

The name of a valid CAD file.


CMe2100_Perform_a_synchronization_via_a_Settings_Command_File.png

Checking product and meter settings

Several commands can be used to check the current status and settings of the CMe2100/CMi2110/CMi2130. As main sources, you may use:

  • The status report provides information about time and network settings as well as coverage for the product. For more information about the status report, see Status – Request status information.

  • The system report provides information about product settings and current status, all installed meters, and all configurable variables. For more information about the system report, see Sysreport – Execute a system report.

Requesting a status report

  • Send the following command to the product.

    status

    For more information, see Status – Request status information. For the default status report, the information in Table 11, “Default status report” will be included.

    The product will respond with a status report. It is possible to customize the information that is included in the status report.

Table 11. Default status report

Field

Explanation

Time

The date and the time set for the product.

Uptime

The total time the product has been running since the last reboot.

Signal

A value between 1-10, describes the strength of the mobile network signal picked up by the product.

Provider

The name of the SIM card operator.

GPRS

Information about product GRPS coverage.

APN

The APN is used to connect to the mobile network.


CMe2100_Request_a_Status_Report.png

Requesting a system report

  • Send the following command to the product.

    sysreport

    The product will respond with an SMS confirming that the system report has started. An additional SMS will be sent when the system report has been delivered to all default e-mail recipients.

CMe2100_Request_a_System_Report.png

Checking current settings

By using the get command, individual settings of the CMe2100/CMi2110/CMi2130 can be easily checked, for example, the e-mail default recipients. For more information about the get command, see Get – Check configuration values.

To check individual current settings:

  • Send the following command to the product.

    get common.[product setting]

    A selection of settings that can be displayed with the get command is listed in Table 13, “Selection of configuration values”.

    The product will respond with an SMS, displaying the configuration value currently used for the specific setting.

Table 12. Getting product settings

Variable

Settings

Explanation

Product setting

The setting of the CMe2100/CMi2110/CMi2130 that you want to display.

An arbitrary command from Table 13, “Selection of configuration values”.


Table 13. Selection of configuration values

Variable

Explanation

Command

E-mail recipients

The e-mail default recipients are set to receive activated e-mail Push Reports.

common.email.to

E-mail server

The default e-mail server is set.

common.email.server

FTP server

The FTP server is set to receive activated FTP Push Reports.

common.ftp.server

HTTP server

The URL of the HTTP server is set to receive activated HTTP Push Reports.

common.http.url

SMS recipients

The list of phone numbers is set to receive activated Push Reports.

common.sms.to

Trusted phone numbers

The list of trusted phone numbers that are able to access the CMe2100/CMi2110/CMi2130.

common.security.nraccesslist

Trusted IP addresses

The list of trusted IP addresses which are able to access the CMe2100/CMi2110/CMi2130.

common.security.ipaccesslist

Search mode

The way meters are addressed on the M-Bus.

common.device.mbus.searchmode

Baud rate

The speed of communication at the M-Bus.

common.device.mbus.searchbaud

Product name

The name used by the CMe2100/CMi2110/CMi2130 to identify itself in Push Reports.

common.product.name


CMe2100_Check_current_settings.png

Checking the operational status of the system

CMe2100/CMi2110/CMi2130 uses a system log to log events taking place on the M-Bus. Each log entry corresponds to a severity level, which makes it possible to adjust the content of the system log by setting the minimum severity level of logged events. Table 14, “System Log severity levels” describes each level.

For example, by setting the severity level to “0”, all system events with a severity level of zero or higher will be logged. For more information about the system log, see Logreport – Execute a system log report.

Table 14. System Log severity levels

Value

Explanation

-2

Debug events

0

Info events

1

Warning events

2

Error events

3

Critical events

4

Exception events


Setting the minimum severity level of logged events

To change the minimum severity level of system log entries:

  • Send the following command to the product.

    set common.syslog.level=[minimum severity level]

    The product will respond with an SMS confirming that the minimum severity level has been set.

Note

It is highly recommended that debug log entries -2 are only logged in case of troubleshooting. If not, the system log will fill up very fast, and it might be hard to navigate. Logging debug log entries might also affect the performance of the CMe2100/CMi2110/CMi2130 negatively.

Variable

Explanation

Settings

Minimum severity level

The lower limit of the events that will be logged.

-2, -1, 0, 1, 2, 3, 4

CMe2100_Set_the_minimum_severity_level_of_logged_events.png

Requesting a system log report

  • Send the following command to the product.

    logreport

    The product will respond with an SMS confirming that the system log report has started. Another SMS will be sent when a system log report has been delivered to all default e-mail recipients set.

CMe2100_Request_a_System_Log_Report.png

Encryption keys for wireless meters

The CMe2100/CMi2110/CMi2130 has a built-in management system for wireless encryption keys, where a meter encryption key is registered in the product to enable the decryption of incoming messages.

Linking an encryption key to an individual meter

To add a meter encryption key:

  • Send the following command to the product.

    set key.[secondary address]=[encryption key]

    The product will respond with an SMS confirming that the encryption key will be used to decrypt information from the meter.

Variable

Settings

Explanation

Secondary address

The secondary address of the meter (set by the manufacturer and printed on the meter).

8-digit number

Encryption key

The 32-character hex format encryption key is used by the meter to encrypt messages.

32 characters in hexadecimal format

CMe2100_Set_Link_an_encryption_key_to_an_individual_meter.png

Displaying all registered encryption keys

To display all registered encryption keys the meters they correspond to:

  • Send the following command to the product.

    get.key.*

    CMe2100_Display_all_registered_encryption_keys__get_key_.png

    Note

    If the encryption key list is longer than 160 characters, it will not fit into an SMS. Therefore, if using many meters, the system log may have to be used to display encryption keys. A system log report can be requested using the following command and will be sent to all e-mail default recipients.

    logreport

    For more information, see Requesting a status report.

    CMe2100_Display_all_registered_encryption_keys__logreport_.png

    The product will respond with a list of all registered encryption keys and what meters are using them.

Configuring meter installation settings

The meter installation settings determine how the CMe2100/CMi2110/CMi2130 will perform meter installations. This includes handling of already-installed meters and the maximum number of meters the CMe2100/CMi2110/CMi2130 will install. For more information about meter installation settings, see Install – Find and install connected meters.

Setting how a meter installation is performed

  1. Send the following command to the product to delete already installed meters before performing a new installation.

    set common.device.mbus.clean=true

  2. Send the following command to the product to save the status of all installed meters before performing a new installation.

    set common.device.mbus.keepstatus=true

  3. Send the following command to the product to determine the maximum number of meters the CMe2100/CMi2110/CMi2130 will install.

    set common.device.mbus.maxdevices=[meter limit]

    The product will respond with an SMS confirming each command.

Variable

Explanation

Settings

Meter limit

The maximum number of meters the CMe2100/CMi2110/CMi2130 will be able to install.

Integer between 0 and 128 (CMe2100 gen.3, CMi2110, CMi2130)/between 0 and 256 (CMe2100 LTE). “-1” will disable the setting.

CMe2100_Set_how_to_perform_a_meter_installation.png

Configuring common push report settings

CMe2100/CMi2110/CMi2130 supports the following set of common push report configuration options:

  • Making changes to a push report schedule, template, and recipients without activating the push report.

  • Set a header to identify the CMe2100/CMi2110/CMi2130 in HTTP push reports.

  • Remove current push report recipients.

  • Disable activated push reports.

Changing the setting of an activated push report

Push report settings can be configured by using the cfg command. Contrary to the sch command, it enables changing settings without activating a push report (whereas the sch command always activates the configured push report). For more information about the cfg command, see Cfg – Change a command or an event configuration.

To configure the settings of a push report:

  • Send the following command to the product.

    cfg [report] [schedule] [template] [recipient]

    The product will respond with an SMS confirming that the settings of the push report have been changed.

Variable

Explanation

Settings

Report

The report is to be configured. There are five different push reports available.

report1, report2, report3, report4, report5

Schedule

The time schedule by which the push report will be delivered.

A selected value from Table 4, “Push report schedule options”.

Template

The number of a desired report template. The template will determine the protocol of the push report. For example, if choosing 1101 (e-mail template), the push report will be sent to e-mail recipients only. All report templates are listed in report templates. For more information, please visit the Elvaco website, http://www.elvaco.com/download.

Valid template number.

Recipient

The addresses of the intended recipients of the push report.

List of valid e-mail addresses, phone numbers, or a valid server address.

CMe2100_Change_the_setting_of_an_activated_Push_Report.png

Setting an HTTP push report header

An HTTP push report header can be used to identify the CMe2100/CMi2110/CMi2130 sending a push report. In this way, the end-user will not have to remember the secondary addresses of each CMe2100/CMi2110/CMi2130. The information to be included in an HTTP header can be selected arbitrarily.

To set the HTTP header for a CMe2100/CMi2110/CMi2130:

  • Send the following command to the product.

    set common.http.header=”[header]

    The product will respond with an SMS, confirming that the header has been set.

CMe2100_Set_a_HTTP_Push_Report_header.png

Removing all current push report recipients for a selected protocol

  • Send the following command to the product to remove all recipients of a specific push report.

    • set common.[protocol]=

    • set.[report].[protocol]=

    The product will respond with an SMS confirming that the recipients have been removed.

Variable

Explanation

Settings

Report

The push report will be configured. There are five different push reports available.

report1, report2, report3, report4, report5

Protocol

The recipient protocol that will be configured.

email.to, ftp.server, http.url, sms.to

CMe2100_Remove_all_current_Push_Report_recipients.png

Removing individual e-mail push report recipients

If more than one default recipient has been set for an e-mail push reports, individual recipients can be removed in the following way:

  • Send the following command to the product.

    qset email=-[recipient]

    The product will respond with an SMS confirming that the recipient was removed from the default recipient list.

Variable

Explanation

Settings

Recipient

The e-mail recipient will be removed as the default option.

E-mail address of a registered e-mail push report default recipient

CMe2100_Remove_individual_e-mail_Push_Report_recipients.png

Disabling an activated push report

  • Send the following command to the product.

    set [report].enabled=false

    The product will respond with an SMS confirming that the report has been disabled.

Variable

Explanation

Settings

Report

The report will be disabled. There are five different push reports available.

report1, report2, report3, report4, report5

CMe2100_Disable_an_activated_Push_Report.png

Configuring settings for an individual meter

In some cases, it might be desirable to use individual settings for a specific meter. It is done by using the device command. For more information about the device command, see Device – Send a command directly to a meter.

Setting the baud rate for communication with a specific meter

  • Send the following command to the product.

    device [secondary address] [baud rate]

    The product will respond with an SMS confirming that the baud rate has been set.

Variable

Settings

Explanation

Secondary address

The secondary address of the meter (printed on the meter).

8-digit number

Baud rate

The baud rate that should be used by the CMe2100/CMi2110/CMi2130 to communicate with the meter.

baud2400, baud9600

CMe2100_Set_the_baud_rate_for_communication_with_a_specific_meter.png

Advanced operation

CMe2100 is a highly versatile product that can be utilized in numerous settings and arrangements. Advanced operations describes functionality that is needed in complex and demanding situations. Thus, advanced operations are not typically used, and they are often not of interest for standard users.

Configuring time settings

For the CMe2100/CMi2110/CMi2130 to operate accurately, the clock must stay synchronized. This is ensured by having the product check a public time server two times per day. The CMe2100/CMi2110/CMi2130 uses a maximum accepted time difference, set to zero seconds by default. Thus, if the time of the product differs from the time of the server by more than zero seconds, the CMe2100/CMi2110/CMi2130 will adjust its time. In rare cases it might be desirable to change the time server, the time synchronization schedule, or the maximum accepted time difference. To learn more about the CMe2100/CMi2110/CMi2130 configurable time settings, see Time settings.

Synchronizing the time of the product with the time server manually

  • Send the following command to the product.

    timesync

    The product will respond with an SMS confirming that the time synchronization has started. An additional SMS will be sent when the synchronization has been completed.

Cme2100_Synchronize_the_time_with_the_time_server_manually.png

Changing the time server

To change the time server used by the CMe2100/CMi2110/CMi2130 for time synchronizations:

The CMe2100/CMi2110/CMi2130 will respond by SMS confirming that the type of time server and the time server used have been set.

  1. Send an SMS with the following command to set the type of time server to use.

    set common.time.mode=[server type]

  2. Send an SMS with the following command to set the IP address of the time server.

    set common.time.[server type].server=[IP address]

    Note

    Elvaco strongly recommends only using NTP which provides better accuracy, is more robust, and uses less network bandwidth.

Variable

Explanation

Settings

Server type

The type of server used by the CMe2100/CMi2110/CMi2130 for time synchronization.

ntp, daytime

IP address

The IP address of the time server that the CMe2100/CMi2110/CMi2130 will use to synchronize the time.

Valid IP address

CMe2100_Change_the_time_server.png

Changing the time synchronization schedule

To configure the schedule used by the CMe2100/CMi2110/CMi2130 to check the time server:

  • Send the following command to the product.

    set timesync.cron=”[cron pattern]

    The product will respond with an SMS confirming the schedule has been set.

Variable

Explanation

Settings

Cron pattern

A cron pattern representing the schedule by which the CMe2100/CMi2110/CMi2130 will check the time server. Each star needs to be separated by a blank space.

Valid cron pattern

Note

A failed time synchronization attempt will act as a warning for the CMe2100/CMi2110/CMi2130 that the network is not reachable. The product will then perform a reboot to reinitialize the network link.

Tip

The time synchronization schedule that should be used depends on how tightly the clocks need to be synchronized. Assuming that the maximum accepted time drift is in the order of one minute per month, utilizing a schedule of every 12th hour should ensure that the product has less than one second’s time difference (31 days * 24 hours = 744 hours, 60 seconds / 744 hours * 12 hours = 0.97 seconds). The default value will work well in most cases and allow for an ample timeout.

If the radio link between the product and the time server is of poor quality, the value might have to be increased until reliable operation is obtained. It is important to note that a poor-quality link will negatively affect the performance of the time synchronization as it relies on low-latency communication.

CMe2100_Change_the_time_synchronization_schedule.png

Setting maximum accepted time difference

To set the maximum accepted time difference the CMe2100/CMi2110/CMi2130 is allowed to have without adjusting its time:

  • Send the following command to the product.

    set common.time.acceptdiff=[maximum accepted time difference]

    The product will respond with an SMS confirming that the maximum accepted time difference has been set.

Variable

Explanation

Settings

Maximum accepted time difference

The maximum number of seconds the time of the CMe2100/CMi2110/CMi2130 is allowed to differ from the time server before performing a time synchronization.

0-86400

CMe2100_Set_maximum_accepted_time_difference.png

Configuring network settings

For the product to be able to connect to the mobile network, an access point name (APN) is needed. The product is by default running auto APN settings, so it will be detected and configured automatically. If the CMe2100/CMi2110/CMi2130 is unable to use the mobile network, you should verify that an APN has been set. To learn more about the product network settings, see Network settings.

Checking APN settings

To check the APN set for the CMe2100/CMi2110/CMi2130:

  • Send an SMS with the following command to the product.

    get common.net.apn

    The product will respond with an SMS presenting the APN set.

CMe2100_Check_APN_settings.png

Setting the APN manually

  1. Send an SMS with the following command to the product to disable automatic APN assignment.

    set common.net.autoapn=false

    The product will respond with an SMS confirming the action.

  2. Send an SMS with the following command to the product.

    set common.net.apn=[APN]

    The product will respond with an SMS confirming that the APN has been set.

Variable

Explanation

Settings

APN

APN information of your e-mail provider.

Valid APN

CMe2100_Set_the_APN_manually.png

Changing radio access technology (only applicable for CMe2100 LTE)

  • Send the following command to the product.

    set common.rat.mode=<param>

    The product will respond with an SMS confirming that the network mode has been changed.

Variable

Explanation

Settings

Change radio access technology

There are different modes to be used, Elvaco recommends using ALL (default), and then the module will use the best possible mode. In very special cases, the CMe2100LTE can be locked to different radio access technologies.

GSM,UMTS,GSM_UMTS,LTE, UMTS_LTE, GSM_UMTS, ALL

  • GSM = 2G

  • UMTS = 3G

  • LTE = 4G

  • GSM_UMTS = 2G,3G

  • GSM_LTE = 2G, 4G

  • UMTS_LTE = 3G, 4G

  • ALL = 2G,3G,4G

Requesting an on demand report

The on demand report can be used to perform a meter readout and deliver a report instantaneously, without having to wait for the next scheduled readout cycle. The on demand report will contain the momentaneous values of all installed meters, and be sent to all default recipients of a selected protocol. It is also possible to request an on demand report for chosen meters only. For more information about the on demand report, see Momreport – Execute an on demand report.

Requesting an on demand report for all meters

  • Send an SMS with the following command to the product.

    momreport [template]

    The product will respond with an SMS confirming that the on demand report has started. An additional SMS will be sent when the report has been delivered.

Variable

Explanation

Settings

Template

The number of selected report templates. The template will determine the protocol by which the on demand report will be delivered. For example, choosing 1101 (e-mail template) will have the on demand report delivered by e-mail. All templates are listed in the report templates. For more information, visit the Elvaco website.

Valid report template number.

CMe2100_Request_an_On_Demand_Report_for_all_meters.png

Requesting an on demand report for selected meters

  • Send an SMS with the following command to the product.

    momreport [template] [meter list]

    The product will send an SMS confirming that the on demand report has started. An additional SMS will be sent when the report has been delivered.

Variable

Explanation

Settings

Template

The number of selected report templates. The template will determine the protocol by which the on demand report will be delivered. For example, choosing 1101 (e-mail template) will have the on demand report delivered by e-mail. All templates are listed in the report templates. For more information, visit the Elvaco website.

Valid template number

Meter list

The secondary addresses of all meters will be included in the moment report.

8-digit numbers, separated by comma.

CMe2100_Request_an_On_Demand_Report_for_selected_meters.png

Security features

The CMe2100/CMi2110/CMi2130 offers a set of security features, including setting credentials to access different operations and adding lists of trusted clients that can access the product.

Setting passwords for security levels

Each operation of the CMe2100/CMi2110/CMi2130 corresponds to a security level. To set the credentials to operate on a certain security level:

  • Send the following command to the product.

    [current password];set common.security.password[level]=[new password]

    The product will respond with an SMS confirming that a new password has been set for that security level.

Variable

Explanation

Settings

Current password

The current password needs to be included in the command to set a new one. By default, the following passwords are used for the CMe2100/CMi2110/CMi2130: 1111 (level 1), 2222 (level 2) and 3333 (level 3).

Current password corresponding to the selected security level.

Level

The security level is to be configured. There are three different security levels available.

1,2,3

New password

The password that will be used to access operations of the specific security level.

0-8 characters. By setting the password to blank, no password will be used for the corresponding security level.

CMe2100_Set_passwords_for_security_levels.png

Adding a list of trusted phone numbers

By adding a list of trusted phone numbers, the users that are allowed to access the CMe2100/CMi2110/CMi2130 can be limited to the ones represented on that list. To add a list of trusted phone numbers:

  • Send the following command to the product.

    common.security.nraccesslist=[phone numbers]

    The product will respond with an SMS confirming that a list of trusted phone numbers has been set.

Variable

Explanation

Settings

Phone numbers

Phone numbers able to access the CMe2100/CMi2110/CMi2130.

List of valid phone numbers, separated by a comma. Leaving the field blank will remove all currently trusted phone numbers from the list.

Cme2100_Add_a_list_of_trusted_phone_numbers.png

Adding a list of trusted IP addresses

By adding a list of trusted IP addresses, the users that are allowed to access the CMe2100/CMi2110/CMi2130 can be limited to the ones represented on that list. To add a list of trusted IP addresses:

  • Send the following command to the product.

    set common.security.ipaccesslist=[IP addresses]

    The product will respond with an SMS confirming that a list of trusted IP addresses has been set.

Variable

Explanation

Settings

IP addresses

IP addresses able to access the CMe2100/CMi2110/CMi2130.

A list of valid IP addresses, separated by a comma. Leaving the field blank will remove all currently trusted IP addresses from the list.

CMe2100_Add_a_list_of_trusted_IP_addresses.png

Configuring M-Bus settings

When configuring the M-Bus settings used by the CMe2100/CMi2110/CMi2130, all the meters connected via the M-Bus will be affected. Such settings for example include: the addressing mode, the baud rate, and the way failed M-Bus requests are handled. To learn more about configurable M-Bus settings for the CMe2100/CMi2110/CMi2130, see M-Bus settings.

Setting the way meters are addressed

Setting the addressing mode will determine the way the CMe2100/CMi2110/CMi2130 addresses meters on the M-Bus. As previously mentioned, there are three different addressing modes available: primary addressing, secondary addressing, and enhanced secondary addressing (for wireless meters only).

To set the M-Bus addressing mode:

  • Send the following command to the product.

    set common.device.mbus.searchmode=[addressing mode]

    The product will respond with an SMS confirming that the addressing mode has been set.

Note

It is highly recommended that the secondary addressing mode is used for Wired M-Bus since it will make sure that duplicated addresses are avoided. The M-Bus addressing mode will be set to secondary by default for CMe2100/CMi2110/CMi2130.

Variable

Explanation

Settings

Addressing mode

The way meters are addressed on the M-Bus.

Primary, secondary, esecondary

CMe2100_Set_the_way_meters_are_addressed.png

Setting the baud rate used on the M-Bus

The baud rate determines the speed of communication used on the M-Bus.

To set the M-Bus baud rate:

  • Send the following command to the product.

    device.mbus.searchbaud=[baud rate]

    The product will respond with an SMS confirming the operation.

Variable

Explanation

Settings

Baud rate

The speed of communication on the M-Bus.

2400,9600

CMe2100_Set_the_baud_rate_used_on_the_M-Bus.png

Configuring M-Bus time and retry settings

The time and retry settings determine how the CMe2100/CMi2110/CMi2130 will act in different scenarios, for example when a collision has been detected on the M-Bus. The default settings will only have to be configured in very rare cases.

To configure a time and retry setting for CMe2100/CMi2110/CMi2130:

  • Send the following command to the product.

    set common.[command]=[setting]

    The product will respond with an SMS confirming the change of settings.

Variable

Explanation

Settings

Command

Select a command from Table 15, “Time and retry variables”, corresponding to the time/retry setting option you wish to configure.

Arbitrary command from Table 15, “Time and retry variables”.

Setting

Select a settings value from Table 15, “Time and retry variables”, corresponding to the command chosen.

Arbitrary setting from Table 15, “Time and retry variables”.

Table 15. Time and retry variables

Variable

Explanation

Settings

Command

Recovery time

The number of milliseconds of the CMe2100/CMi2110/CMi2130 will wait after detecting a collision on the M-Bus before making another attempt.

A number between 0 and 15000

device.mbus.busrecoverytime

Request idle time

The number of milliseconds the CMe2100/CMi2110/CMi2130 will wait between making two requests on the M-Bus.

A number between 500 and 15000

device.mbus.idleduration

Response timeout

The number of milliseconds the CMe2100/CMi2110/CMi2130 will wait for a response when requesting the M-Bus. The variable is automatically set to match the baud rate used.

A number between 0 and 15000

device.mbus.responsetimeout

Request retry

The maximum number of retries the CMe2100/CMi2110/CMi2130 will perform when requesting the M-Bus.

A number between 0 and 10

device.mbus.requestretry


CMe2100_Configure_M-Bus_time_and_retry_settings.png

Configuring M-Bus multi-telegram settings

The M-Bus multi-telegram settings determine the maximum amount of telegrams received by the CMe2100/CMi2110/CMi2130 for each meter readout. By setting a multi-telegram read limit, the product will receive a maximum of that many telegrams, regardless of whether a meter is trying to send additional ones. It is also possible to have the CMe2100/CMi2110/CMi2130 auto-detect the amount of telegram the meter is about to send and read all possible telegrams from the meter.

To configure the multi-telegram settings:

  1. By default, the CMe2100/CMi2110/CMi2130 will only read one telegram per readout. By setting the FCB bit, this value can be configured. To do this, send the following command to the product.

    set common.device.mbus.fcbmode=[multi telegram mode]

    The product will respond with an SMS confirming that the FCB bit has been set.

  2. Send the following command to the product to set the multi-telegram read limit.

    set common.device.mbus.telegramcount=[amount of telegrams]

    The product will respond with an SMS confirming that the multi-telegram read limit has been set.

Note

The FCB bit needs to be set to “counter” to be able to configure the multi-telegram read limit.

Variable

Explanation

Settings

Multi-telegram mode

The “off” setting will have the CMe2100/CMi2110/CMi2130 read one telegram (the first) per readout only. By setting the multi-telegram mode to “auto”, all available telegrams will be read. To set a multi-telegram read limit manually, set the mode to “counter”.

off, auto, counter

Amount of telegrams

The maximum amount of telegrams read for each meter. The settings only apply if the FCB bit is set to “counter”.

A number between 0 and 255.

CMe2100_Configure_M-Bus_multi_telegram_settings.png

Accessing M-Bus from a master device

The transparent M-Bus service enables a master device to communicate directly with meters on the M-Bus. It might for example be used in case of a debug or software update purposes. There are two different transparent M-Bus services available, Transparent M-Bus over TCP/IP and Transparent M-Bus over GSM. To learn more about the transparent M-Bus services, see Transparent M-Bus GSM and console GSM settings and Transparent M-Bus TCP settings.

Note

The SIM card used in the CMe2100/CMi2110/CMi2130 needs to have been assigned a public IP address for the transparent M-Bus service to be able to connect to the product.

Enabling the transparent M-Bus TCP/IP services

  • Send the following command to the product.

    set common.tcp.tmbus[id].enabled=true

    The product will respond with an SMS confirming that the transparent M-Bus service has been enabled.

Variable

Explanation

Settings

Id

The transparent M-Bus TCP/IP service is to be enabled. There are two such services available.

1, 2

CMe2100_Enable_the_Transparent_M-Bus_TCP-IP_services.png

Configuring transparent M-Bus TCP/IP settings

  • Send the following command to the product.

    set common.[command]=[setting]

    The product will respond with an SMS confirming the change of settings.

Variable

Explanation

Settings

Command

Select a command from Table 16, “Transparent M-Bus over TCP/IP configuration options”, corresponding to the Transparent M-Bus over the TCP/IP setting you wish to configure.

Arbitrary command from Table 16, “Transparent M-Bus over TCP/IP configuration options”.

Setting

Select a settings value from Table 16, “Transparent M-Bus over TCP/IP configuration options”, corresponding to the command chosen.

Arbitrary setting from Table 16, “Transparent M-Bus over TCP/IP configuration options”.

Table 16. Transparent M-Bus over TCP/IP configuration options

Variable

Explanation

Settings

Command

Baud rate

The speed of communication used for the transparent M-Bus TCP/IP service.

2400, 9600

tcp.tmbus1.baud

tcp.tmbus2.baud

Packing interval

The number of milliseconds of inactivity that needs to pass on the M-Bus line before the transparent M-Bus service will transfer data.

A number between 0 and 65535

tcp.tmbus1.packing.interval

tcp.tmbus2.packing.interval

TCP/IP port

The port that will be used by the transparent M-Bus service to connect to the CMe2100/CMi2110/CMi2130.

A number between 0 and 65535

tcp.tmbus1.port

tcp.tmbus2.port

Idle timeout

The number of seconds of inactivity that needs to pass before the connection with the transparent M-Bus TCP/IP service is closed.

A number between 0 and 86400

tcp.tmbus1.timeout

tcp.tmbus2.timeout


CMe2100_Configure_Transparent_M-Bus_TCP-IP_settings.png

Configuring the transparent M-Bus GSM service (only applicable for CMe2100 gen.3, CMi2110, CMi2130)

The transparent M-Bus GSM service will be enabled by default in the CMe2100/CMi21xx. To configure the transparent M-Bus GSM settings:

  • Send the following command to the product.

    set common.[command]=[setting]

    The product will respond with an SMS confirming that the settings have been changed.

Variable

Explanation

Settings

Command

Select a command from Table 17, “Transparent M-Bus over GSM configuration options”, corresponding to the setting you wish to configure.

Arbitrary command from Table 17, “Transparent M-Bus over GSM configuration options”.

Setting

Select a settings value from Table 17, “Transparent M-Bus over GSM configuration options”, corresponding to the command chosen.

Arbitrary setting from Table 17, “Transparent M-Bus over GSM configuration options”.

Table 17. Transparent M-Bus over GSM configuration options

Variable

Explanation

Settings

Command

Baud rate

The speed of communication used for the transparent M-Bus GSM service.

2400, 9600

csd.tmbus.baud

Packing interval

The number of milliseconds of inactivity that needs to pass on the M-Bus line before the transparent M-Bus service will transfer data.

A number between 0 and 65535

csd.tmbus.packing.interval

Idle timeout

The number of seconds of inactivity that needs to pass on before the connection with the transparent M-Bus GSM service is closed.

A number between 0 and 86400

csd.timeout


CMe2100_Configure_the_Transparent_M-Bus_GSM_service.png

Configuring advanced push report settings

There is a group of more advanced push report settings for the CMe2100/CMi2110/CMi2130. These include:

  • The value period determines how far back in time the metering gateway will include values when compiling a push report.

  • The value interval determines the time between each readout included in the push report.

  • The timeout value for each protocol determines how long a push report transmit attempt may linger before timing out.

To learn more about configurable push report settings, see Report1,…,report5 – Report commands.

Configuring the value period

The value period sets how far back in time the CMe2100/CMi2110/CMi2130 will look to include meter values in the push reports. It is configured by setting two variables:

  • filter.mode

  • filter.param

To configure the value period of the CMe2100/CMi2110/CMi2130:

  1. Send the following command to the product.

    set common.filter.mode=[time unit]

    This will set the time unit used by the product when determining how far back in time to include meter values in the push reports.

  2. Send the following command to the product.

    set common.filter.param=[time value]

    This will set the number of time units (set by filter.mode), and the product will go back in time to include meter values in the push reports.

Variable

Explanation

Settings

Time unit

The time unit used by the CMe2100/CMi2110/CMi2130 to determine how far back in time to include meter values in the push reports. Using the “auto” setting, all meter values read since the last push report will be included. Using “Interval” will let the user set a start date and an end date for meter values included in the push report.

minute, hour, day, month, interval, auto

Time value

The amount of time units (set by filter.mode) of the CMe2100/CMi2110/CMi2130 will go back in time to include meter values in the push report. For example, setting filter.param to “1” when filter.mode is set to “hour” will include all meter values from the last hour in the push report. If filter.mode is set to “interval”, meter values from a specific time period, set by a start and an end date can be included in the push report.

An arbitrary number of time units or a start date and an end date.

CMe2100_Configure_the_Value_Period.png

Configuring the value interval

The value interval determines the time between each meter value included in the push reports and is set using cron patterns. To learn more about how to use cron patterns, see Customize service and job schedules.

To configure the value interval of the CMe2100/CMi2110/CMi2130:

  • Send the following command to the product.

    set common.filter.value=”[cron pattern]”

    The product will respond with an SMS confirming that the value interval has been set.

Variable

Explanation

Settings

Cron pattern

Sets the time between each meter value included in the push reports.

A valid cron pattern. Each star needs to be separated by a blank space.

Configure_the_Value_Interval.png

Configuring push report timeout settings

For FTP and e-mail push reports, a timeout value can be set. It determines how long a push report attempt may linger before being marked as failed.

To configure the push report timeout settings:

  1. Send the following command to the product to set the timeout for FTP push reports.

    set common.ftp.timeout=[timeout value]

    The product will respond with an SMS confirming that the timeout settings have been changed.

  2. Send the following command to the product to set the timeout for email push reports.

    common.email.timeout=[timeout value]

    The product will respond with an SMS confirming that the timeout settings have been changed.

Variable

Explanation

Settings

Timeout value

The maximum number of seconds a push report attempt may linger before it is interrupted.

A number between 0 and 86400

Configure_the_Push_Report_timeout_settings.png

Configuring scheduled job retry settings

The job retry settings determine how the CMe2100/CMi2110/CMi2130 will perform retries for scheduled jobs, for example, a meter readout, if the first attempt should fail. These include the maximum number of times the product will attempt a job and the time between each such attempt.

Configuring retry settings for scheduled jobs

To configure the retry settings for scheduled jobs:

  1. Send the following command to the product.

    set common.schedule.retrymax=[maximum number of retries]

    The product will respond with an SMS confirming that the maximum number of retries has been set.

  2. Send the following command to the product.

    set common.schedule.retryoffset=[time between retries]

    The product will respond with an SMS confirming that the time between retries has been set.

Variable

Explanation

Settings

Maximum number of retries

The maximum number of retries the CMe2100/CMi2110/CMi2130 will perform for a scheduled task.

An integer between 0 and 10.

Retry offset

The time in seconds between each retry attempt.

A number between 0 and 86400.

Configure_retry_settings_for_scheduled.png

Accessing the product through a console application

The product can be accessed through a console application, i.e. by using a command-line interface. This service is normally only used in case of troubleshooting or for advanced operations. To learn more about the console application service, see Console TCP settings.

Note

The SIM card used needs to have been assigned a public IP address for the console application to connect to the product.

Enabling the console application

  • Send the following command to the product.

    set common.console.enabled=true

    The product will respond with an SMS confirming that the console application has been activated.

Enable_the_console_application.png

Configuring the console application settings

  1. Send the following command to the product to determine what port the console application will connect to.

    set common.tcp.console.port=[port number]

    The product will respond with an SMS confirming that the port has been set.

  2. Send the following command to the product to determine the timeout value for the console application.

    set common.tcp.console.timeout=[timeout value]

    The product will respond with an SMS confirming that the timeout value has been set.

Variable

Explanation

Settings

Port number

The port number used by the console application to connect to the CMe2100/CMi2110/CMi2130.

An integer between 0 and 65635.

Timeout value

The time in seconds of inactivity that needs to pass before a connection with the console application is closed.

A number between 0 and 86400.

Configure_the_console_application_settings.png

Requesting a meter readout and push report manually

By using the following commands, meter readouts can be performed and selected push reports can be executed manually.

  • storevalue

  • report

Performing a manual meter readout

  • Send the following command to the product.

    storevalue

    The product will respond with an SMS confirming that all installed meters will be read.

Perform_a_manual_meter_readout.png

Running a push report manually

Through a manual request, a user can customize a single push report, without affecting the settings of future push reports. To learn more about configurable settings for push reports, see Report1,…,report5 – Report commands.

To run a push report manually:

  • Send the following command to the product.

    report[report id] [schedule] [template id]

    • The product will send an SMS, confirming that the report has started.

    • A push report will be delivered to the default recipients of the selected protocol.

Variable

Explanation

Settings

Report id

The id of the push report. There are five different push reports available.

1,2,3,4,5

Schedule

Setting this field will determine the values included in the push report. However, it will not make any changes actual push report schedule.

An arbitrary value from Table 4, “Push report schedule options”.

Template id

The desired template id for the requested push report. The template will determine by which protocol the push report will be delivered. For example, selecting 1101 (e-mail template) will have the push report delivered by e-mail. All available templates are listed in Report templates. To learn more about the templates, please visit the Elvaco website, http://www.elvaco.com/download.

Valid template id number

Run_a_Push_report_manually.png

Configuring identity settings

The identity set for the CMe2100/CMi2110/CMi2130 will be included in all push reports sent by the product and can be chosen arbitrarily. Similarly, branding settings are used to include various information in push reports, for example, telephone number and address. The localization settings determine the language and the separator used for decimal numbers.

Customizing the identity settings

To set the identity:

  • Send the following command to the product.

    set common.product.name=[product name]

    The product will respond with an SMS, confirming that its name has been changed.

Variable

Explanation

Settings

Product name

The product name, which will be included in all push reports.

Arbitrary text.

Customize_the_CMe2100-CMi2110-CMi2130_identity_settings.png

Configuring localization settings for push reports

To set the localization settings of the CMe2100/CMi2110/CMi2130:

  1. Send the following command to the product to set the language for the product.

    set common.product.culture=[language]

    The product will respond with an SMS confirming that the language has been set.

  2. Send the following command to the product that should be used for decimal numbers.

    set common.product.culture.decimalseparator=[decimal separator]

    The product will respond with an SMS confirming that the decimal separator has been set.

Variable

Explanation

Settings

Language

The language used by the CMe2100/CMi2110/CMi2130

en

Decimal separator

The separator is used for decimal numbers.

Arbitrary character.

Configure_localization_settings_for_Push_Reports.png

Configuring branding settings

The branding settings let the user include addressing information in push reports, for example, address and telephone number. To learn more about the branding settings of the CMe2100/CMi2110/CMi2130, see Branding settings.

To set the branding information that will be included in push reports:

  • Send the following command to the product.

    set common.[branding information]=[branding value]

    The product will respond with an SMS confirming that the settings have been changed.

Variable

Explanation

Settings

Branding information

The type of information to be included or configured for the push reports.

Arbitrary command from Branding configuration options.

Branding value

The value that will be used for the selected branding information.

Arbitrary settings value from Branding configuration options.

Table 18. Branding configuration options

Variable

Explanation

Settings

Command

Company name

The name of the company.

Arbitrary text inside of quotation marks.

branding.company

Company address

The address of the company.

Arbitrary text inside of quotation marks.

  • branding.address1

  • branding.address2

  • branding.address3

  • branding.address4

Company telephone number

The telephone number of the company.

Arbitrary telephone number.

  • branding.tel1

  • branding.tel2

Company e-mail address

The e-mail address of the company.

Arbitrary e-mail address.

branding.email

Company logo

The logo used by the company.

URL to the company logo.

branding.logourl

Company website

The website of the company.

Link to the company website.

branding.web


Configure_branding_settings.png

Configuring service and job schedules using cron patterns

For scheduled jobs, e.g., meter readouts and push reports, cron patterns can be used to customize the time interval by which the jobs will be performed. It is done by setting up to five different time variables, each one represented by a star. Replace each star with a number to set a specific job execution schedule.

Cron pattern

Illustration of cron pattern

The “/” character is used to set periodic values, i.e., schedule a job with a recurrent time interval. The “?” character is used to generate a random value. Lastly, using the “|” character allows to combine several cron patterns. See the following example table including a list of chosen cron patterns.

Table 19. Examples of different cron patterns

Cron pattern

Description

15 * * * *

Schedule a job 15 minutes past every hour, i.e., 00:15, 01:15, 02:15 etc.

*/15 * * * *

Schedule a job every 15th minute, i.e., 00:00, 00:15, 00:30, etc.

* * * * *

Schedule a job every minute, i.e., 00:01, 00:02, 00:03, etc.

* 12 * * mon

Schedule a job every minute during the 12th hour of every Monday.

* 12 16 * mon

Schedule a job every minute during the 12th hour of every Monday if the day is the 16th of the month.

59 11 * * 1,2,3,4,5

Schedule a job 11:59 on Monday, Tuesday, Wednesday, Thursday, and Friday.

59 11 * * 1-5

Schedule a job 11:59 on Monday, Tuesday, Wednesday, Thursday, and Friday.

*/15 9-17 * * *

Schedule a job every 15th minute between the 9th and the 17th hour of the day, i.e., 09:00, 09:15, 09:30, etc.

* 12 10-16/2 * *

Schedule a job every minute during the 12th hour of the day, if the day is the 10th, the 12th, the 14th, or the 16th of the month.

* 12 1-15,17,20-25 * *

Schedule a job every minute during the 12th hour of the day, if the day is between the 1th and the 15th, the 17th or between the 20th and 25th day of the month.

0 5 * * *|8 10 * * *|22 17 * * *

Schedule a job every day at 05:00, 10:08 and 17:22.

?1-30 0 * * *

Schedule a job at a random chosen minute during the first 30 minutes of every hour.


Rebooting the product

In rare cases, e.g. in case of troubleshooting, a reboot might have to be performed.

To perform a reboot:

  • Send the following command to the product.

    reboot

    The product will respond with an SMS, confirming that the reboot has started.

Perform_reboot.jpg

Performing factory reset

The CMe2100 will restart and the settings will be reset to factory default.

  • Press and hold the push button.

The reset can also be performed remotely by following the step below:

The product will respond with an SMS, confirming that the factory reset has started.

  • Send the command

    3333:factoryreset

Was this article helpful?

0 out of 0 found this helpful
Have more questions? Submit a request

Comments (0 comments)

Article is closed for comments.