Wireless / WMbus
      Tillbaka till startsidan
      1. Knowledge Base
      2. FAQ - Databank
      3. Wireless / WMbus

      FX-AirReceiver commissioning with FX-series substations

      EcoGuard AirReceiver and wireless sensors (WMBus)

      Program download

       

      What you need:

      • Mini-UBS-cable 
      • Program to communicate serially or via telnet, e.g. Putty
      • Program to generate and export commands: "ARModbus Configurator" (Optional)
      • MS Excel (Optional)

      Configure Air Receiver

      Configure for Ethernet Fixed IP Address

      1. Connect with Mini-USB
        1. Putty or equivalent software
          1. Serial, COMx, 115200 (x=connected COM-port)
          2. Telnet
        2. Press Enter in command prompt (then you should see EcoGuard>)
      2. Type help to view all commands. (when you select text, it is automatically copied and pasted by clicking the right mouse button)
      3. Write login and press enter.

      Enter your password (Default password is unit’s serial number)

      1. Set ip address

      set_ethernet_ip XXX.XXX.XXX.XXX

      1. Setting up subnet mask

      set_ethernet_subnet_mask XXX.XXX.XXX.XXX

      1. Setting up Gateway

      set_ethernet_gateway XXX.XXX.XXX.XXX

      1. Setting up DNS

      set_ethernet_dns1 XXX.XXX.XXX.XXX

      1. Set static IP address

      set_ethernet_mode 1

      1. Turn off the GPRS modem

      set_gsm_mode 0

      1. 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)

      1. 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)

      1. 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

      1. Firmware update (applicable local mode)

      set_software_update_service_enabled 0

      1. Time synchronization (for local mode)

      set_time_synchronization_mode 0

      1. Save settings

      save_settings

      1. 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:

      1. Wireless M-bus
      2. 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>)

      Deletes either all stored sensor encryption keys, or the key for a specific sensor.

      [*]

      factory_reset

      fr

      Usage: factory_reset

      Loads the factory default settings to RAM, overwriting any unsaved changes.

      [*]

      force_sensor_data_transfer

      fsdt

      Usage: force_sensor_data_transfer

      Immediately perform a sensor data transfer (the Gateway-service must be enabled for anything to actually happen).

      [*]

      force_software_update

      fsu

      Usage: force_software_update

      Immediately check for new updates on the server (the Software Update service must be enabled).

      [ ]

      getGprsSignalStrength

      gs

      Usage: getGprsSignalStrength

      Requests and prints the current signal strength and ber

      [ ]

      getICC

      gc

      Usage: getICC

      Requests and prints the SIM Card ICC Number

      [ ]

      getIMEI

      gi

      Usage: getIMEI

      Requests and prints the GPRS module's IMEI number

      [ ]

      help

      		  

      Usage: help [<command>]

      Lists all available commands if called without arguments.
      If called with exactly one argument, then a help message will be displayed for the command passed as the argument.

      [ ]

      hwInfo

      		  

      Usage: CmdHwInfo

      Displays hardware information

      [*]

      load_settings

      ls

      Usage: load_settings

      Loads the stored settings to RAM, overwriting any unsaved changes.

      [ ]

      login

      		  

      Usage: login

      Logs in (you must do this in order to execute certain commands)

      [*]

      reboot

      		  

      Usage: reboot

      Immediately reboots the system.

      [*]

      save_settings

      ss

      Usage: save_settings

      Save the settings currently in RAM, overwriting any previously saved settings.

      [*]

      set_console_password

      Scp

      Usage: set_console_password

      Sets the password that must be supplied in order to log in.

      [*]

      set_custom_apn

      Sca

      Usage: set_custom_apn <apn>

      Sets the APN to use.

      [*]

      set_ethernet_dns1

      Sed1

      Usage: set_ethernet_dns1 <dns>

      Sets the primary DNS-server to use over Ethernet (if not configured to use DHCP).

      [*]

      set_ethernet_dns2

      Sed2

      Usage: set_ethernet_dns2 <dns>

      Sets the secondary DNS-server to use over Ethernet (if not configured to use DHCP).

      [*]

      set_ethernet_gateway

      Seg

      Usage: set_ethernet_gateway <ip>

      Set the IPv4 address of the gateway to use over Ethernet (if not configured to use DHCP).

      [*]

      set_ethernet_ip

      Sei

      Usage: set_ethernet_ip <ip>

      Set the IPv4 address to use over Ethernet (if not configured to use DHCP).

      [*]

      set_ethernet_mode

      Sem

      Usage: set_ethernet_mode <mode>

      Sets how the Ethernet-module should be configured. <mode> must be one of:
      0 = Off. Ethernet is not used.
      1 = Static IP-address configuration.
      2 = Automatic configuration via DHCP.

      [*]

      set_ethernet_subnet_mask

      Sesm

      Usage: set_ethernet_subnet_mask <subnet_mask>

      Set the subnet mask to use over Ethernet (if not configured to use DHCP).

      [*]

      set_gsm_mode

      Sgm

      Usage: set_gsm_mode <mode>

      Sets how the GSM-modem should be configured. <mode> must be one of:
      0 = No configuration. The GSM-modem is powered off.
      1 = Configure for, and use GPRS to send and receive data.

      [*]

      set_modbus_default_coil_register_value

      Smdcrv

      Usage: set_modbus_default_coil_register_value <port>

      Sets the default value to return if no proper value is available.

      [*]

      set_modbus_default_holding_register_value

      Smdhrv

      Usage: set_modbus_default_holding_register_value <port>

      Sets the default value to return if no proper value is available.

      [*]

      set_modbus_default_input_register_value

      Smdirv

      Usage: set_modbus_default_input_register_value <port>

      Sets the default value to return if no proper value is available.

      [*]

      set_modbus_register_aggregator_function

      Smraf

      Usage: set_modbus_register_aggregator_function <register> <function>

      Sets the function to use to aggregate multiple sensor values into one:
      0 = Returns the sensor reading with the lowest value in the group.
      1 = Returns the sensor reading with the highest value in the group.
      2 = Returns the average sensor readings of all the readings in the group.
      3 = Returns the median sensor readings of all the readings in the group.
      4 = Returns the variance of the sensor readings in the group.
      5 = Returns the sensor reading that was last received out of all the sensor readings in the group.
      6 = Returns the sensor reading that was received first out of all the sensor readings in the group.
      7 = Returns the number of sensor readings in the group.

      [*]

      set_modbus_register_enabled

      Smre

      Usage: set_modbus_register_enabled <register> <value>

      Set to 1 to enable this register. If not enabled, then the default value is always returned.

      [*]

      set_modbus_register_invert_coil

      Smric

      Usage: set_modbus_register_invert_coil <register> <value>

      Normally, if the associated Coil register reads as 1 then that means an error has occurred. If this setting is turned on then that behavior is inverted.

      [*]

      set_modbus_register_keep_old

      Smrko

      Usage: set_modbus_register_keep_old <register> <value>

      Sets whether to keep returning the last aggregated sensor value even after it gets older than 'maxAge' number of minutes instead of returning the default value.

      [*]

      set_modbus_register_max_age

      Smrma

      Usage: set_modbus_register_max_age <register> <minutes>

      Sets the upper age limit, in minutes, of the sensor readings to include during aggregation. A value of zero disables this filter.

      [*]

      set_modbus_register_msb_first

      Smrmf

      Usage: set_modbus_register_msb_first <register> <value>

      If set to 1, the upper 16-bits of the 32-bit value is served in the register with the lowest address, and the upper 16-bits in the following address. If 0, the reverse.

      [*]

      set_modbus_register_multiplier

      Smrm

      Usage: set_modbus_register_multiplier <register> <value>

      Multiply the result of the aggregator function by this value (must be an integer power of zero!).

      [*]

      set_modbus_register_sensor_record_add

      Smrsra

      Usage: set_modbus_register_sensor_record_add <register> <sensor> <record>

      Adds a sensor's record to the group of sensor records to aggregate. The sensor's identity shall be given either as serial number only (Ecoguard wireless only), or as a combination of the manufacturer code, serial number, medium and version like in Curves (example: EGD12345678-27-1).

      [*]

      set_modbus_register_sensor_record_delete

      Smrsrd

      Usage: set_modbus_register_sensor_record_delete <register> (*|<sensor> <record>)

      Either deletes all sensor records from the register (a * is passed after the Register Number), or deletes a sensor's record from the group of sensor records to aggregate. In the latter case, the sensor's identity shall be given either as serial number only (Ecoguard wireless only), or as a combination of the manufacturer code, serial number, medium and version like in Curves (example: EGD12345678-27-1).

      [*]

      set_modbus_register_trim_percent

      Smrtp

      Usage: set_modbus_register_trim_percent <register> <value>

      Remove the top and bottom this many percent of the sensor readings before aggregating them. Set to zero to disable this filter.

      [*]

      set_modbus_server_listening_interfaces

      Smsli

      Usage: set_modbus_server_listening_interfaces <interface>

      Sets the interface(s) the Modbus Server should listen on. <interface> must be one of:
      0 = None (the service is disabled).
      1 = Ethernet only
      2 = GPRS only
      3 = Both Ethernet and GPRS

      [*]

      set_modbus_server_port

      Smsp

      Usage: set_modbus_server_port <port>

      Sets which port the Modbus server should listen on (if enabled).

      [*]

      set_network_logger_filter

      Snlf

      Usage: set_network_logger_filter [<filter>] [<filter>] ...

      Sets which kinds of log codes to send to the server, if any. "filter" must be one of:
      "debug" = Send debug log codes to the server. Should only be used during development.
      "info" = Send info log codes to the server. Might be useful during troubleshooting.
      "warning" = Send warning log codes to the server. Will probably be useful during troubleshooting.
      "important" = Send important log codes to the server. Recommended!
      "error" = Send error log codes to the server. Strongly recommended!

      [*]

      set_network_logger_mode

      Snlm

      Usage: set_network_logger_mode <mode>

      Sets how log codes should be sent to a remote server. <mode> must be one of:
      0 = Network logging is disabled.
      1 = Log codes are sent as-is over UDP to a remote server.

      [*]

      set_network_logger_server_address

      Snlsa

      Usage: set_network_logger_server_address <address>

      Sets the address of the server to which to send log codes.

      [*]

      set_network_logger_server_port

      Snlsp

      Usage: set_network_logger_server_port <port>

      Sets the port of the server to which to send log codes.

      [*]

      set_radio_receiver_mode

      Srrm

      Usage: set_radio_receiver_mode <receiver> <freq> <mode>

      Configures the given radio receiver's mode.
      <receiver> must be either "vertical" or "horizontal".
      <freq> must be either "433mhz" or "868mhz".
      If <freq> is "433mhz" then <mode> must be either:
      "off" = The receiver will be turned off.
      "ecoguard_wireless_mode" = Ecoguard wireless, also know as EcoLink.
      "wmbus_f_mode" = wireless M-bus F-mode.
      If <freq> is "868mhz" then <mode> must be either:
      "off" = The receiver will be turned off.
      "wmbus_t_and_c_mode" = wireless M-bus T-mode and C-mode (simultaneously).
      "wmbus_s_mode" = wireless M-bus S-mode (only).

      [*]

      set_rtc

      Sr

      Usage: set_rtc <timestamp>

      Sets the current date and time (UNIX-timestamp).

      [*]

      set_sensor_data_gateway_service_enabled

      Ssdgse

      Usage: set_sensor_data_gateway_service_enabled <state>

      If <state> is 1, then the Sensor Data Gateway service will be enabled. If <state> is 0 then it will be disabled.

      [*]

      set_sensor_data_gateway_service_max_interval

      Ssdgsmi

      Usage: set_sensor_data_gateway_service_max_interval <interval>

      Sets the maximum interval between sensor data transfers, in seconds. Intervals up to 86400 seconds are accepted. Set to 0 to force transmission of received sensor data immediately after receiving it.

      [*]

      set_sensor_data_gateway_service_min_data_relay_interval

      Ssdgsmdri

      Usage: set_sensor_data_gateway_service_min_data_relay_interval <interval>

      Only relay sensor data to the server coming from the same sensor if data was relayed from said sensor more than this many seconds ago.

      [*]

      set_sensor_data_gateway_service_retransmission_attempts

      Ssdgsra

      Usage: set_sensor_data_gateway_service_retransmission_attempts <attempts>

      Retry to send sensor data this many times in case of error before giving up and discarding it.

      [*]

      set_sensor_data_gateway_service_server_address

      Ssdgssa

      Usage: set_sensor_data_gateway_service_server_address <address>

      Sets the address of the recipient server.

      [*]

      set_sensor_data_gateway_service_server_port

      Ssdgssp

      Usage: set_sensor_data_gateway_service_server_port <port>

      Sets which port on the server to send data to.

      [*]

      set_sensor_encryption_key

      Ssek

      Usage: set_sensor_encryption_key <sensor> <key>

      Set the key (in hex) to use when decrypting data from <sensor> (wireless M-bus only).

      [*]

      set_software_update_service_enabled

      Ssuse

      Usage: set_software_update_service_enabled <state>

      If <state> is 1, then the Software Update service will be enabled. If <state> is 0 then it will be disabled.

      [*]

      set_software_update_service_interval

      Ssusi

      Usage: set_software_update_service_interval <interval>

      Sets the interval between software update checks, in seconds.

      [*]

      set_software_update_service_server_address

      Ssussa

      Usage: set_software_update_service_server_address <url>

      Sets the http url to check for updates from.

      [*]

      set_status_report_sender_enabled

      Ssrse

      Usage: set_status_report_sender_enabled <state>

      If <state> is 1, then the Status Report Sender will be enabled. If <state> is 0 then it will be disabled.

      [*]

      set_status_report_sender_retransmission_attempts

      Ssrsra

      Usage: set_status_report_sender_retransmission_attempts <count>

      Retry to send the data this many times in case of error before giving up and discarding it.

      [*]

      set_status_report_sender_server_address

      Ssrssa

      Usage: set_status_report_sender_server_address <address>

      Sets the address of the recipient server.

      [*]

      set_status_report_sender_server_port

      Ssrssp

      Usage: set_status_report_sender_server_port <port>

      Sets which port on the server to send status reports to.

      [*]

      set_telnet_server_listening_interfaces

      Stsli

      Usage: set_telnet_server_listening_interfaces <interface>

      Sets the interface(s) the Telnet Server should listen on. <interface> must be one of:
      0 = None (the service is disabled).
      1 = Ethernet only
      2 = GPRS only
      3 = Both Ethernet and GPRS

      [*]

      set_telnet_server_port

      Stsp

      Usage: set_telnet_server_port <port>

      Sets which port the Telnet server should listen on (if enabled).

      [*]

      set_time_synchronization_min_sync_interval

      Stsmsi

      Usage: set_time_synchronization_min_sync_interval <interval>

      Sets the minimum interval between time synchronization attempts, in seconds. Intervals between 1 and 2592000 seconds are accepted.

      [*]

      set_time_synchronization_mode

      Stsm

      Usage: set_time_synchronization_mode <mode>

      Sets how this unit's clock should be synchronized with an external source. <mode> must be one of:
      0 = Time is not synchronized with an external source.
      1 = Time is synchronized using SNTP (using manually configured settings).
      2 = Time is synchronized using SNTP (using settings obtained via DHCP).

      [*]

      set_time_synchronization_server_address

      Stssa

      Usage: set_time_synchronization_server_address <address>

      Sets the address of the server to synchronize the time with.

      [*]

      set_time_synchronization_server_port

      Stssp

      Usage: set_time_synchronization_server_port <port>

      Sets the port of the server to synchronize the time with.

      [*]

      set_transport_compression_enabled

      Stce

      Usage: set_transport_compression_enabled <state>

      Set to 1 to enable data compression during transmission.

      [*]

      set_transport_encryption_enabled

      Stee

      Usage: set_transport_encryption_enabled <state>

      Set to 1 to enable data encryption during transmission.

      [*]

      set_transport_max_payload_size

      Stmps

      Usage: set_transport_max_payload_size <size>

      Sets the upper limit of the size of the payload in each transfer, in bytes. Must be at least 268 bytes.

      [*]

      set_transport_timeout

      Stt

      Usage: set_transport_timeout <timeout>

      Sets the number of seconds to wait (max 255) for the server to acknowledge a data transmission.

      [ ]

      show_current_dns_servers

      scds

      Usage: show_current_dns_servers

      Shows the DNS servers currently in use.

      [ ]

      show_custom_apn

      sca

      Usage: show_custom_apn

      Returns the manually configured APN to use, if one has been configured. If not configured then the correct APN will be determined automatically.

      [ ]

      show_ethernet_dns1

      sed1

      Usage: show_ethernet_dns1

      Shows the primary DNS-server to use over Ethernet (if not configured to use DHCP).

      [ ]

      show_ethernet_dns2

      sed2

      Usage: show_ethernet_dns2

      Shows the secondary DNS-server to use over Ethernet (if not configured to use DHCP).

      [ ]

      show_ethernet_gateway

      seg

      Usage: show_ethernet_gateway

      Returns the IPv4 address of the gateway to use over Ethernet (if not configured to use DHCP).

      [ ]

      show_ethernet_ip

      sei

      Usage: show_ethernet_ip

      Returns the IPv4 address to use over Ethernet (if not configured to use DHCP).

      [ ]

      show_ethernet_mac

      		  

      Usage: show_ethernet_mac

      Returns the MAC of the Ethernet interface.

      [ ]

      show_ethernet_mode

      sem

      Usage: show_ethernet_mode

      Shows how the Ethernet-module is configured:
      0 = Off. Ethernet is not used.
      1 = Static IP-address configuration.
      2 = Automatic configuration via DHCP.

      [ ]

      show_ethernet_subnet_mask

      sesm

      Usage: show_ethernet_subnet_mask

      Returns the subnet mask to use over Ethernet (if not configured to use DHCP).

      [ ]

      show_gsm_mode

      sgm

      Usage: show_gsm_mode

      Shows how the GSM-modem is configured:
      0 = No configuration. The GSM-modem is powered off.
      1 = Configure for, and use GPRS to send and receive data.

      [ ]

      show_hardware_version

      shv

      Usage: show_hardware_version

      Returns the version number of the hardware.

      [ ]

      show_last_power_loss

      slpl

      Usage: show_last_power_loss

      Shows the time elapsed since the last power loss.

      [ ]

      show_modbus_default_coil_register_value

      smdcrv

      Usage: show_modbus_default_coil_register_value

      Returns the default value to return if no proper value is available.

      [ ]

      show_modbus_default_holding_register_value

      smdhrv

      Usage: show_modbus_default_holding_register_value

      Returns the default value to return if no proper value is available.

      [ ]

      show_modbus_default_input_register_value

      smdirv

      Usage: show_modbus_default_input_register_value

      Returns the default value to return if no proper value is available.

      [ ]

      show_modbus_register_aggregator_function

      smraf

      Usage: show_modbus_register_aggregator_function <register>

      Returns the function that is used to aggregate multiple sensor values into one:
      0 = Returns the sensor reading with the lowest value in the group.
      1 = Returns the sensor reading with the highest value in the group.
      2 = Returns the average sensor readings of all the readings in the group.
      3 = Returns the median sensor readings of all the readings in the group.
      4 = Returns the variance of the sensor readings in the group.
      5 = Returns the sensor reading that was last received out of all the sensor readings in the group.
      6 = Returns the sensor reading that was received first out of all the sensor readings in the group.
      7 = Returns the number of sensor readings in the group.

      [ ]

      show_modbus_register_enabled

      smre

      Usage: show_modbus_register_enabled <register>

      Returns 1 if the register is enabled, else 0. If not enabled, then the default value is always returned on Modbus queries.

      [ ]

      show_modbus_register_invert_coil

      smric

      Usage: show_modbus_register_invert_coil <register>

      Normally, if the associated Coil register reads as 1 then that means an error has occurred. This command shows if this behavior is inverted for this register.

      [ ]

      show_modbus_register_keep_old

      smrko

      Usage: show_modbus_register_keep_old <register>

      Returns whether to keep returning the last aggregated sensor value even after it gets older than 'maxAge' number of minutes instead of returning the default value.

      [ ]

      show_modbus_register_max_age

      smrma

      Usage: show_modbus_register_max_age <register>

      Returns the upper age limit, in minutes, of the sensor readings to include during aggregation. A value of zero means this filter is disabled.

      [ ]

      show_modbus_register_msb_first

      smrmf

      Usage: show_modbus_register_msb_first <register>

      If is the returned value is 1, the upper 16-bits of the 32-bit value is served in the register with the lowest address, and the upper 16-bits in the following address. If 0, the reverse.

      [ ]

      show_modbus_register_multiplier

      smrm

      Usage: show_modbus_register_multiplier <register>

      The result of the aggregator function will be multiplied by this value (which must be an integer power of zero).

      [ ]

      show_modbus_register_sensor_records

      smrsr

      Usage: show_modbus_register_sensor_records [<register>]

      Returns which sensor records are aggregated for the given register. If no register number is supplied, then all all registers are returned.

      [ ]

      show_modbus_register_trim_percent

      smrtp

      Usage: show_modbus_register_trim_percent <register>

      Returns how many of the top and bottom number of the sensor readings are removed before aggregating them, in percent. If zero then this filter is disabled.

      [ ]

      show_modbus_server_listening_interfaces

      smsli

      Usage: show_modbus_server_listening_interfaces

      Returns which interface(s) the Modbus Server listens on:
      0 = None (the service is disabled).
      1 = Ethernet only
      2 = GPRS only
      3 = Both Ethernet and GPRS

      [ ]

      show_modbus_server_port

      smsp

      Usage: show_modbus_server_port

      Returns which port the Modbus server listens on (if enabled).

      [ ]

      show_network_interfaces

      sni

      Usage: show_network_interfaces

      Shows network interface information (IP-addresses, etc.).

      [ ]

      show_network_logger_filter

      snlf

      Usage: show_network_logger_filter

      Shows which kinds of log codes are being sent to the server:"debug" = Send debug log codes to the server. Should only be used during development.
      "info" = Send info log codes to the server. Useful only during troubleshooting.
      "warning" = Send warning log codes to the server. Recommended!
      "error" = Send error log codes to the server. Strongly recommended!

      [ ]

      show_network_logger_mode

      snlm

      Usage: show_network_logger_mode

      Shows how log codes should be sent to a remote server. <mode> must be one of:
      0 = Network logging is disabled.
      1 = Log codes are sent as-is over UDP to a remote server.

      [ ]

      show_network_logger_server_address

      snlsa

      Usage: show_network_logger_server_address

      Shows the address of the server to which to send log codes.

      [ ]

      show_network_logger_server_port

      snlsp

      Usage: show_network_logger_server_port

      Shows the port of the server to which to send log codes.

      [ ]

      show_product_id

      spi

      Usage: show_product_id

      Returns the product ID. This is not the same as this unit's serial number!

      [ ]

      show_radio_receiver_mode

      srrm

      Usage: show_radio_receiver_mode <receiver> <freq>

      Shows how the radio receiver listening on the given frequency is configured.<receiver> must be either "vertical" or "horizontal".
      <freq> must be either "433mhz" or "868mhz".
      If <freq> is "433mhz" then one of the following will be shown:
      "off" = The receiver will be turned off.
      "ecoguard_wireless_mode" = Ecoguard wireless, also know as EcoLink.
      "wmbus_f_mode" = wireless M-bus F-mode.
      If <freq> is "868mhz" then one of the following will be shown:
      "off" = The receiver will be turned off.
      "wmbus_t_and_c_mode" = wireless M-bus T-mode and C-mode (simultaneously).
      "wmbus_s_mode" = wireless M-bus S-mode (only).

      [ ]

      show_reboot_count

      src

      Usage: show_reboot_count

      Shows the number of times the system has rebooted.

      [ ]

      show_reboot_reason

      srr

      Usage: show_reboot_reason

      Shows what last caused the system to reset.

       

       

      Power on reset

      Enheten har inte startat om sedan den blev spänningssatt.

      External reset

      Någon tryckte på omstartsknappen.

      Low voltage detect reset

      Enheten startade om för att matningsspänningen var för låg för fortsatt drift.

      Watchdog reset

      Programmet hängde sig och systemet startade automatiskt om.

      Software reset

      Programmet startade frivilligt om systemet, till exempel för att färdigställa en mjukvaruuppdatering eller för att användaren körde kommandot "reboot"

      Lockup reset

      Programmet hängde sig och systemet startade automatiskt om.

      [ ]

      show_rtc

      sr

      Usage: get_rtc

      Prints the current UNIX-time.

      [ ]

      show_sensor_data_gateway_service_enabled

      ssdgse

      Usage: show_sensor_data_gateway_service_enabled

      Returns 1 if the Sensor Data Gateway service is enabled, else returns 0.

      [ ]

      show_sensor_data_gateway_service_max_interval

      ssdgsmi

      Usage: show_sensor_data_gateway_service_max_interval

      Returns the maximum interval between sensor data transfers, in seconds.

      [ ]

      show_sensor_data_gateway_service_min_data_relay_interval

      ssdgsmdri

      Usage: show_sensor_data_gateway_service_min_data_relay_interval

      Returns the maximum interval between sensor data transfers, in seconds.

      [ ]

      show_sensor_data_gateway_service_retransmission_attempts

      ssdgsra

      Usage: show_sensor_data_gateway_service_retransmission_attempts

      Will retry to send sensor data this many times in case of error before giving up and discarding it.

      [ ]

      show_sensor_data_gateway_service_server_address

      ssdgssa

      Usage: show_sensor_data_gateway_service_server_address

      Returns the address of the recipient server

      [ ]

      show_sensor_data_gateway_service_server_port

      ssdgssp

      Usage: show_sensor_data_gateway_service_server_port

      Returns which port on the server to send data to.

      [*]

      show_sensor_encryption_key

      ssek

      Usage: show_sensor_encryption_key (*|<sensor>)

      Shows either all stored sensor encryption keys, or the key for a specific sensor.

      [ ]

      show_sensor_list_entries

      ssle

      Usage: show_sensor_list_entries [-c]

      Shows which sensors has been received and with which signal strength, etc. If the optional parameter -c is given, then CSV output will be produced.

      [ ]

      show_serial_number

      ssn

      Usage: show_serial_number

      Returns this unit's serial number.

      [ ]

      show_software_update_service_enabled

      ssuse

      Usage: show_software_update_service_enabled

      Returns 1 if the Software Update service is enabled, else returns 0.

      [ ]

      show_software_update_service_interval

      ssusi

      Usage: show_software_update_service_interval

      Returns the interval between software update checks, in seconds.

      [ ]

      show_software_update_service_server_address

      ssussa

      Usage: show_software_update_service_server_address

      Returns the http url used to check updates from.

      [ ]

      show_software_version

      ssv

      Usage: show_software_version

      Returns the version number of the software.

      [ ]

      show_status_report_sender_enabled

      ssrse

      Usage: show_status_report_sender_enabled

      Returns 1 if the Status Report Sender is enabled, else returns 0.

      [ ]

      show_status_report_sender_retransmission_attempts

      ssrsra

      Usage: show_status_report_sender_retransmission_attempts

      Will retry to send data this many times in case of error before giving up and discarding it.

      [ ]

      show_status_report_sender_server_address

      ssrssa

      Usage: show_status_report_sender_server_address

      Returns the address of the recipient server.

      [ ]

      show_status_report_sender_server_port

      ssrssp

      Usage: show_status_report_sender_server_port

      Returns which port on the server to send status reports to.

      [ ]

      show_telnet_server_listening_interfaces

      stsli

      Usage: show_telnet_server_listening_interfaces

      Returns which interface(s) the Telnet Server listens on:
      0 = None (the service is disabled).
      1 = Ethernet only
      2 = GPRS only
      3 = Both Ethernet and GPRS

      [ ]

      show_telnet_server_port

      stsp

      Usage: show_telnet_server_port

      Returns which port the Telnet server listens on (if enabled).

      [ ]

      show_time_synchronization_min_sync_interval

      stsmsi

      Usage: show_time_synchronization_min_sync_interval

      Shows the minimum interval between time synchronization attempts, in seconds.

      [ ]

      show_time_synchronization_mode

      stsm

      Usage: show_time_synchronization_mode

      Shows how this unit's clock is synchronized with an external source:
      0 = Time is not synchronized with an external source.
      1 = Time is synchronized using SNTP (using manually configured settings).
      2 = Time is synchronized using SNTP (using settings obtained via DHCP).

      [ ]

      show_time_synchronization_server_address

      stssa

      Usage: show_time_synchronization_server_address

      Shows the address of the server to synchronize the time with.

      [ ]

      show_time_synchronization_server_port

      stssp

      Usage: show_time_synchronization_server_port

      Shows the port of the server to synchronize the time with.

      [ ]

      show_transport_compression_enabled

      stce

      Usage: show_transport_compression_enabled

      Returns 1 if data compression is enabled, else returns 0.

      [ ]

      show_transport_encryption_enabled

      stee

      Usage: show_transport_encryption_enabled

      Returns 1 if data encryption is enabled, else returns 0.

      [ ]

      show_transport_max_payload_size

      stmps

      Usage: show_transport_max_payload_size

      Returns the upper limit of the size of the payload in each transfer, in bytes.

      [ ]

      show_transport_timeout

      stt

      Usage: show_transport_timeout

      Returns the number of seconds to wait for the server to acknowledge a data transmission.

      [ ]

      show_uptime

      su

      Usage: show_uptime

      Shows the amount of time elapsed since the last reboot or power up.