EcoGuard AirReceiver ja langattomat anturit (WMBus)
Ohjelmien lataus
Tarvitset:
- Mini-UBS kaapeli
- Sarjaliikenne kommmunikointi ohjelma, esim. Putty
- Ohjelman komentojen luomiseen ja viemiseen: " ARModbus Configurator" (valinnainen)
- MS Excel (valinnainen)
Määritä Air Receiver
Määritä Ethernet Fixed IP osoite
- Yhdistä Mini_UBS:llä
- Putty tai vastaava ohjelmisto
- Serial, COMx, 115200 (x=connected COM-port)
- Telnet
- Paina "Enter" komentokehotteessa (silloin sinun pitäisi nähdä EcoGuard>)
- Putty tai vastaava ohjelmisto
- Kirjoita help nähdäksesi kaikki komennot (when you select text, it is automatically copied and pasted by clicking the right mouse button)
- Write login and press enter.
Enter your password (Default password is unit’s serial number)
- Set ip address
set_ethernet_ip XXX.XXX.XXX.XXX
- Setting up subnet mask
set_ethernet_subnet_mask XXX.XXX.XXX.XXX
- Setting up Gateway
set_ethernet_gateway XXX.XXX.XXX.XXX
- Setting up DNS
set_ethernet_dns1 XXX.XXX.XXX.XXX
- Set static IP address
set_ethernet_mode 1
- Turn off the GPRS modem
set_gsm_mode 0
- Air Receiver transmission interval in seconds
set_sensor_data_gateway_service_max_interval 5 (applies to Local mode)
set_sensor_data_gateway_service_max_interval 900 (applies to Curves mode)
- The number of seconds that already collected sensors values are ignored to be sent to the server.
set_sensor_data_gateway_service_min_data_relay_interval 0 (applies to Local mode)
set_sensor_data_gateway_service_min_data_relay_interval 890 (applies to Curves mode)
- The IP address of the metric receiver (NOTE applies only to EcoCom/Navigator or Curves)
set_sensor_data_gateway_service_server_address XXX.XXX.XXX.XXX
- Firmware update (applicable local mode)
set_software_update_service_enabled 0
- Time synchronization (for local mode)
set_time_synchronization_mode 0
- Save settings
save_settings
- Restart your device to activate changes
reboot
Export to Modbus TCP – configuration file
If the sensor is encrypted, you must add the encryption key to the Air Receiver. The encryption keys are added under the tab: "Sensor encryption keys"
The secondary address can be written in two ways: It does not matter if the secondary address contains zeros, for example, 00012345. Excel removed them but it still works.
Export settings for sensors
Modbus registers are allocated in pairs, i.e., you can only register odd numbers, for example 1, 3, 5, etc. This is to be able to present 32-bit numbers across two registry addresses. All numbers have 10 as base except the encryption key that is hexadecimal.
Sensors have different records that can be exported, such as temperature and humidity. To be sure which record to export please check the data in the respective manufacturer's data sheet.
The sensors can be exported to individual modbus registers or grouped to perform calculations, e.g., an average from several temperature sensors.
Under the tab "Sensor records" you decide which sensor and record to export on the respective Modbus register. " Notes" is only for custom notes.
Register number: Determines which register the sensor's record should send its value to
Sensor type: Determines the type of sensor serial number corresponds to
The type specified in the "Sensor Type" column mustbe spelled correctly, upper and lower case does not matter:
- Wireless M-bus
- EcoGuard Wireless
Manufacturer:
Serial number:
Device type: Type of sensor
Version:
Record number: Which record to export.
Notes: Custom Notes, not saved in the Air Receiver.
The example below adds one sensor per registry. The first meter has three records that are exported to three different tables. Here, too, you can write the secondary address in two different ways.
This example adds 4 temp sensors to modbus register 9. This registry address automatically forms a group that can then be made calculations.
Register settings.
The " Register settings "tab determines what the registry addresses should do.
Register number: Register address 1-255 (odd number only)
Enabled: Default 1. 1=on, 0=off
Aggregator function: Default minimum
minimum = Returns the sensor value with the lowest value in the group.
maximum = Returns the sensor value with the highest value in the group.
average = Returns the mean calculated on the group.
median = Returns the median calculated on the group.
variance = Returns the variation of the sensor values from the group.
latest = Returns the last value received.
oldest = Returns the first value entered in the group.
count = Returns the number of valid sensors in the group. (max_age and trim_count affect this)
MSB first (Most significant byte): Default 0. Returns the lowest bytes in the first table and the highest bytes in the second table.
Invert coil: Default 0. If a value of 0 = If the value is 1, the registry indicates that the value is too old. If the setting is set to 1 = If the value is 1, the registry indicates that the value is valid.
Maximum age: Maximum approved age in minutes
Keep old: Default 1. Retains last value even after maximum age is exceeded.
Trim percentage: Default 0. Percent outliers that are calculated when calculating, for example, average.
Multiplier: Default 1. Returns the value without decimal. (example: 10 returns with one decimal, etc.)
Notes: Custom notes, not saved in the Air Receiver.
The example below showing registry address 1-8 exports the last value (used when viewing only one individual sensor per registry address). Register address 9 calculates the average minus 10% the highest and lowest values from the sensor associated with the registry address.
Send settings to Air Receiver
To generate a file with commands or send commands directly to the Air Receiver, you can use the software "ar_modbus_configurator.exe".
"ar_modbus_configurator.exe" can run with the following switches:
input_file |
path to file containing settings |
-h, --help |
displays help text and closes the program |
-d, --use-default-password |
uses default password to log in (default: None) |
-p PASSWORD, --password PASSWORD |
use this password to log in (default: None) |
-l LOGFILE, --logfile LOGFILE |
logs all messages to this file (default: None) |
-m {telnet,serial,file}, --mode {telnet,serial,file} |
how the commands are exported (default: None) |
-o OUTPUT, --output OUTPUT |
where to export the output (default: None) |
-q, --quiet |
does not print any messages (default) |
-r, --reset-current-sensor-record-list |
removes all transducers from registry addresses before applying the new settings (default: None) |
-R, --reset-current-sensor-encryption-key-list |
removes all saved encryption keys before applying the new ones (default: None) |
-v, --version |
view the version number of the application and exit the program |
Example, direct connection via USB:
ar_modbus_configurator.exe "C:\temp\AR Modbus Configurator\Example configuration instructions.xlsx" ^
--password=12345678 ^
--mode=serial ^
--output=COM3 ^
--logfile="C:\temp\AR Modbus Configurator\log\log.txt"
pause
For example, output to file:
ar_modbus_configurator.exe "C:\temp\AR Modbus Configurator\Example configuration instructions.xlsx" ^
--mode=file ^
--output="c:\temp\AR Modbus Configurator\output.txt" ^
--logfile="C:\temp\AR Modbus Configurator\log\log.txt"
pause
Commands
List of command and keyboard shortcut in parentheses, commands with a star in front require login:
Login |
Command |
Alias |
Help |
||||||||||||
[*] |
delete_sensor_encryption_key |
dsek |
Usage: delete_sensor_encryption_key (*|<sensor>) |
||||||||||||
[*] |
factory_reset |
fr |
Usage: factory_reset |
||||||||||||
[*] |
force_sensor_data_transfer |
fsdt |
Usage: force_sensor_data_transfer |
||||||||||||
[*] |
force_software_update |
fsu |
Usage: force_software_update |
||||||||||||
[ ] |
getGprsSignalStrength |
gs |
Usage: getGprsSignalStrength |
||||||||||||
[ ] |
getICC |
gc |
Usage: getICC |
||||||||||||
[ ] |
getIMEI |
gi |
Usage: getIMEI |
||||||||||||
[ ] |
help |
Usage: help [<command>] |
|||||||||||||
[ ] |
hwInfo |
Usage: CmdHwInfo |
|||||||||||||
[*] |
load_settings |
ls |
Usage: load_settings |
||||||||||||
[ ] |
login |
Usage: login |
|||||||||||||
[*] |
reboot |
Usage: reboot |
|||||||||||||
[*] |
save_settings |
ss |
Usage: save_settings |
||||||||||||
[*] |
set_console_password |
Scp |
Usage: set_console_password |
||||||||||||
[*] |
set_custom_apn |
Sca |
Usage: set_custom_apn <apn> |
||||||||||||
[*] |
set_ethernet_dns1 |
Sed1 |
Usage: set_ethernet_dns1 <dns> |
||||||||||||
[*] |
set_ethernet_dns2 |
Sed2 |
Usage: set_ethernet_dns2 <dns> |
||||||||||||
[*] |
set_ethernet_gateway |
Seg |
Usage: set_ethernet_gateway <ip> |
||||||||||||
[*] |
set_ethernet_ip |
Sei |
Usage: set_ethernet_ip <ip> |
||||||||||||
[*] |
set_ethernet_mode |
Sem |
Usage: set_ethernet_mode <mode> |
||||||||||||
[*] |
set_ethernet_subnet_mask |
Sesm |
Usage: set_ethernet_subnet_mask <subnet_mask> |
||||||||||||
[*] |
set_gsm_mode |
Sgm |
Usage: set_gsm_mode <mode> |
||||||||||||
[*] |
set_modbus_default_coil_register_value |
Smdcrv |
Usage: set_modbus_default_coil_register_value <port> |
||||||||||||
[*] |
set_modbus_default_holding_register_value |
Smdhrv |
Usage: set_modbus_default_holding_register_value <port> |
||||||||||||
[*] |
set_modbus_default_input_register_value |
Smdirv |
Usage: set_modbus_default_input_register_value <port> |
||||||||||||
[*] |
set_modbus_register_aggregator_function |
Smraf |
Usage: set_modbus_register_aggregator_function <register> <function> |
||||||||||||
[*] |
set_modbus_register_enabled |
Smre |
Usage: set_modbus_register_enabled <register> <value> |
||||||||||||
[*] |
set_modbus_register_invert_coil |
Smric |
Usage: set_modbus_register_invert_coil <register> <value> |
||||||||||||
[*] |
set_modbus_register_keep_old |
Smrko |
Usage: set_modbus_register_keep_old <register> <value> |
||||||||||||
[*] |
set_modbus_register_max_age |
Smrma |
Usage: set_modbus_register_max_age <register> <minutes> |
||||||||||||
[*] |
set_modbus_register_msb_first |
Smrmf |
Usage: set_modbus_register_msb_first <register> <value> |
||||||||||||
[*] |
set_modbus_register_multiplier |
Smrm |
Usage: set_modbus_register_multiplier <register> <value> |
||||||||||||
[*] |
set_modbus_register_sensor_record_add |
Smrsra |
Usage: set_modbus_register_sensor_record_add <register> <sensor> <record> |
||||||||||||
[*] |
set_modbus_register_sensor_record_delete |
Smrsrd |
Usage: set_modbus_register_sensor_record_delete <register> (*|<sensor> <record>) |
||||||||||||
[*] |
set_modbus_register_trim_percent |
Smrtp |
Usage: set_modbus_register_trim_percent <register> <value> |
||||||||||||
[*] |
set_modbus_server_listening_interfaces |
Smsli |
Usage: set_modbus_server_listening_interfaces <interface> |
||||||||||||
[*] |
set_modbus_server_port |
Smsp |
Usage: set_modbus_server_port <port> |
||||||||||||
[*] |
set_network_logger_filter |
Snlf |
Usage: set_network_logger_filter [<filter>] [<filter>] ... |
||||||||||||
[*] |
set_network_logger_mode |
Snlm |
Usage: set_network_logger_mode <mode> |
||||||||||||
[*] |
set_network_logger_server_address |
Snlsa |
Usage: set_network_logger_server_address <address> |
||||||||||||
[*] |
set_network_logger_server_port |
Snlsp |
Usage: set_network_logger_server_port <port> |
||||||||||||
[*] |
set_radio_receiver_mode |
Srrm |
Usage: set_radio_receiver_mode <receiver> <freq> <mode> |
||||||||||||
[*] |
set_rtc |
Sr |
Usage: set_rtc <timestamp> |
||||||||||||
[*] |
set_sensor_data_gateway_service_enabled |
Ssdgse |
Usage: set_sensor_data_gateway_service_enabled <state> |
||||||||||||
[*] |
set_sensor_data_gateway_service_max_interval |
Ssdgsmi |
Usage: set_sensor_data_gateway_service_max_interval <interval> |
||||||||||||
[*] |
set_sensor_data_gateway_service_min_data_relay_interval |
Ssdgsmdri |
Usage: set_sensor_data_gateway_service_min_data_relay_interval <interval> |
||||||||||||
[*] |
set_sensor_data_gateway_service_retransmission_attempts |
Ssdgsra |
Usage: set_sensor_data_gateway_service_retransmission_attempts <attempts> |
||||||||||||
[*] |
set_sensor_data_gateway_service_server_address |
Ssdgssa |
Usage: set_sensor_data_gateway_service_server_address <address> |
||||||||||||
[*] |
set_sensor_data_gateway_service_server_port |
Ssdgssp |
Usage: set_sensor_data_gateway_service_server_port <port> |
||||||||||||
[*] |
set_sensor_encryption_key |
Ssek |
Usage: set_sensor_encryption_key <sensor> <key> |
||||||||||||
[*] |
set_software_update_service_enabled |
Ssuse |
Usage: set_software_update_service_enabled <state> |
||||||||||||
[*] |
set_software_update_service_interval |
Ssusi |
Usage: set_software_update_service_interval <interval> |
||||||||||||
[*] |
set_software_update_service_server_address |
Ssussa |
Usage: set_software_update_service_server_address <url> |
||||||||||||
[*] |
set_status_report_sender_enabled |
Ssrse |
Usage: set_status_report_sender_enabled <state> |
||||||||||||
[*] |
set_status_report_sender_retransmission_attempts |
Ssrsra |
Usage: set_status_report_sender_retransmission_attempts <count> |
||||||||||||
[*] |
set_status_report_sender_server_address |
Ssrssa |
Usage: set_status_report_sender_server_address <address> |
||||||||||||
[*] |
set_status_report_sender_server_port |
Ssrssp |
Usage: set_status_report_sender_server_port <port> |
||||||||||||
[*] |
set_telnet_server_listening_interfaces |
Stsli |
Usage: set_telnet_server_listening_interfaces <interface> |
||||||||||||
[*] |
set_telnet_server_port |
Stsp |
Usage: set_telnet_server_port <port> |
||||||||||||
[*] |
set_time_synchronization_min_sync_interval |
Stsmsi |
Usage: set_time_synchronization_min_sync_interval <interval> |
||||||||||||
[*] |
set_time_synchronization_mode |
Stsm |
Usage: set_time_synchronization_mode <mode> |
||||||||||||
[*] |
set_time_synchronization_server_address |
Stssa |
Usage: set_time_synchronization_server_address <address> |
||||||||||||
[*] |
set_time_synchronization_server_port |
Stssp |
Usage: set_time_synchronization_server_port <port> |
||||||||||||
[*] |
set_transport_compression_enabled |
Stce |
Usage: set_transport_compression_enabled <state> |
||||||||||||
[*] |
set_transport_encryption_enabled |
Stee |
Usage: set_transport_encryption_enabled <state> |
||||||||||||
[*] |
set_transport_max_payload_size |
Stmps |
Usage: set_transport_max_payload_size <size> |
||||||||||||
[*] |
set_transport_timeout |
Stt |
Usage: set_transport_timeout <timeout> |
||||||||||||
[ ] |
show_current_dns_servers |
scds |
Usage: show_current_dns_servers |
||||||||||||
[ ] |
show_custom_apn |
sca |
Usage: show_custom_apn |
||||||||||||
[ ] |
show_ethernet_dns1 |
sed1 |
Usage: show_ethernet_dns1 |
||||||||||||
[ ] |
show_ethernet_dns2 |
sed2 |
Usage: show_ethernet_dns2 |
||||||||||||
[ ] |
show_ethernet_gateway |
seg |
Usage: show_ethernet_gateway |
||||||||||||
[ ] |
show_ethernet_ip |
sei |
Usage: show_ethernet_ip |
||||||||||||
[ ] |
show_ethernet_mac |
Usage: show_ethernet_mac |
|||||||||||||
[ ] |
show_ethernet_mode |
sem |
Usage: show_ethernet_mode |
||||||||||||
[ ] |
show_ethernet_subnet_mask |
sesm |
Usage: show_ethernet_subnet_mask |
||||||||||||
[ ] |
show_gsm_mode |
sgm |
Usage: show_gsm_mode |
||||||||||||
[ ] |
show_hardware_version |
shv |
Usage: show_hardware_version |
||||||||||||
[ ] |
show_last_power_loss |
slpl |
Usage: show_last_power_loss |
||||||||||||
[ ] |
show_modbus_default_coil_register_value |
smdcrv |
Usage: show_modbus_default_coil_register_value |
||||||||||||
[ ] |
show_modbus_default_holding_register_value |
smdhrv |
Usage: show_modbus_default_holding_register_value |
||||||||||||
[ ] |
show_modbus_default_input_register_value |
smdirv |
Usage: show_modbus_default_input_register_value |
||||||||||||
[ ] |
show_modbus_register_aggregator_function |
smraf |
Usage: show_modbus_register_aggregator_function <register> |
||||||||||||
[ ] |
show_modbus_register_enabled |
smre |
Usage: show_modbus_register_enabled <register> |
||||||||||||
[ ] |
show_modbus_register_invert_coil |
smric |
Usage: show_modbus_register_invert_coil <register> |
||||||||||||
[ ] |
show_modbus_register_keep_old |
smrko |
Usage: show_modbus_register_keep_old <register> |
||||||||||||
[ ] |
show_modbus_register_max_age |
smrma |
Usage: show_modbus_register_max_age <register> |
||||||||||||
[ ] |
show_modbus_register_msb_first |
smrmf |
Usage: show_modbus_register_msb_first <register> |
||||||||||||
[ ] |
show_modbus_register_multiplier |
smrm |
Usage: show_modbus_register_multiplier <register> |
||||||||||||
[ ] |
show_modbus_register_sensor_records |
smrsr |
Usage: show_modbus_register_sensor_records [<register>] |
||||||||||||
[ ] |
show_modbus_register_trim_percent |
smrtp |
Usage: show_modbus_register_trim_percent <register> |
||||||||||||
[ ] |
show_modbus_server_listening_interfaces |
smsli |
Usage: show_modbus_server_listening_interfaces |
||||||||||||
[ ] |
show_modbus_server_port |
smsp |
Usage: show_modbus_server_port |
||||||||||||
[ ] |
show_network_interfaces |
sni |
Usage: show_network_interfaces |
||||||||||||
[ ] |
show_network_logger_filter |
snlf |
Usage: show_network_logger_filter |
||||||||||||
[ ] |
show_network_logger_mode |
snlm |
Usage: show_network_logger_mode |
||||||||||||
[ ] |
show_network_logger_server_address |
snlsa |
Usage: show_network_logger_server_address |
||||||||||||
[ ] |
show_network_logger_server_port |
snlsp |
Usage: show_network_logger_server_port |
||||||||||||
[ ] |
show_product_id |
spi |
Usage: show_product_id |
||||||||||||
[ ] |
show_radio_receiver_mode |
srrm |
Usage: show_radio_receiver_mode <receiver> <freq> |
||||||||||||
[ ] |
show_reboot_count |
src |
Usage: show_reboot_count |
||||||||||||
[ ] |
show_reboot_reason |
srr |
Usage: show_reboot_reason |
||||||||||||
|
|
|
|||||||||||||
[ ] |
show_rtc |
sr |
Usage: get_rtc |
||||||||||||
[ ] |
show_sensor_data_gateway_service_enabled |
ssdgse |
Usage: show_sensor_data_gateway_service_enabled |
||||||||||||
[ ] |
show_sensor_data_gateway_service_max_interval |
ssdgsmi |
Usage: show_sensor_data_gateway_service_max_interval |
||||||||||||
[ ] |
show_sensor_data_gateway_service_min_data_relay_interval |
ssdgsmdri |
Usage: show_sensor_data_gateway_service_min_data_relay_interval |
||||||||||||
[ ] |
show_sensor_data_gateway_service_retransmission_attempts |
ssdgsra |
Usage: show_sensor_data_gateway_service_retransmission_attempts |
||||||||||||
[ ] |
show_sensor_data_gateway_service_server_address |
ssdgssa |
Usage: show_sensor_data_gateway_service_server_address |
||||||||||||
[ ] |
show_sensor_data_gateway_service_server_port |
ssdgssp |
Usage: show_sensor_data_gateway_service_server_port |
||||||||||||
[*] |
show_sensor_encryption_key |
ssek |
Usage: show_sensor_encryption_key (*|<sensor>) |
||||||||||||
[ ] |
show_sensor_list_entries |
ssle |
Usage: show_sensor_list_entries [-c] |
||||||||||||
[ ] |
show_serial_number |
ssn |
Usage: show_serial_number |
||||||||||||
[ ] |
show_software_update_service_enabled |
ssuse |
Usage: show_software_update_service_enabled |
||||||||||||
[ ] |
show_software_update_service_interval |
ssusi |
Usage: show_software_update_service_interval |
||||||||||||
[ ] |
show_software_update_service_server_address |
ssussa |
Usage: show_software_update_service_server_address |
||||||||||||
[ ] |
show_software_version |
ssv |
Usage: show_software_version |
||||||||||||
[ ] |
show_status_report_sender_enabled |
ssrse |
Usage: show_status_report_sender_enabled |
||||||||||||
[ ] |
show_status_report_sender_retransmission_attempts |
ssrsra |
Usage: show_status_report_sender_retransmission_attempts |
||||||||||||
[ ] |
show_status_report_sender_server_address |
ssrssa |
Usage: show_status_report_sender_server_address |
||||||||||||
[ ] |
show_status_report_sender_server_port |
ssrssp |
Usage: show_status_report_sender_server_port |
||||||||||||
[ ] |
show_telnet_server_listening_interfaces |
stsli |
Usage: show_telnet_server_listening_interfaces |
||||||||||||
[ ] |
show_telnet_server_port |
stsp |
Usage: show_telnet_server_port |
||||||||||||
[ ] |
show_time_synchronization_min_sync_interval |
stsmsi |
Usage: show_time_synchronization_min_sync_interval |
||||||||||||
[ ] |
show_time_synchronization_mode |
stsm |
Usage: show_time_synchronization_mode |
||||||||||||
[ ] |
show_time_synchronization_server_address |
stssa |
Usage: show_time_synchronization_server_address |
||||||||||||
[ ] |
show_time_synchronization_server_port |
stssp |
Usage: show_time_synchronization_server_port |
||||||||||||
[ ] |
show_transport_compression_enabled |
stce |
Usage: show_transport_compression_enabled |
||||||||||||
[ ] |
show_transport_encryption_enabled |
stee |
Usage: show_transport_encryption_enabled |
||||||||||||
[ ] |
show_transport_max_payload_size |
stmps |
Usage: show_transport_max_payload_size |
||||||||||||
[ ] |
show_transport_timeout |
stt |
Usage: show_transport_timeout |
||||||||||||
[ ] |
show_uptime |
su |
Usage: show_uptime |