Remote Terminal Unit M717 User Guide
Copyright Notice Neither the whole nor any part of the information contained in this publication may be reproduced in any material form except with the prior written permission of the publisher. All trademarks used throughout this document are the property of their respective owners. Mention of third-party products is for informational purpose only and constitutes neither an endorsement, nor a recommendation. Metrilog assumes no responsibility with regard to the performance or use of these products.
Table Of Contents Table Of Contents .......................................................................................................................................1 1. Introduction ...........................................................................................................................................3 1.1. Product Overview ......................................................................................................................................3 1.2. Safety ............
.2.1. dacq ....................................................................................................................................................22 4.2.2. dacq info ...........................................................................................................................................22 4.2.3. dacq sample ....................................................................................................................................23 4.2.4. dacq retrieve ...............
1. Introduction 1.1. Product Overview The Remote Terminal Unit (RTU) model M717 is a low power GSM/GPRS/UMTS/LTE based communication device, that includes exible bus/serial interfaces and a data-logging unit. The M717 RTU supports following protocols and Input/Output (I/O) interfaces (see gure below): • SDI, can be switched under software control between SDI-12 native, RS-485 or CAN; • MPI, or Multi Protocol Interface; can be switched under software control between RS-232, RS-422 and RS-485; • USB micro AB.
1.2. Safety Please observe the following instructions: • Do not open the unit, except if so instructed by the Metrilog technical personnel! • Should it be necessary to open the unit (e.g., to replace the SIM card), the operation must be executed only in a moisture free environment. You will need a Philips screwdriver size PH2. Note that the screws remain attached to the lid, there is no need to remove them. Remove the lid slowly and carefully, because an antenna is xed on its back.
2. Installation This section describes the installation of a new unit. It is recommended rst to set-up the new RTU on the Metrilog M2M Gateway and then to proceed with the hardware installation. 2.1. Register the RTU to the M2M Gateway The M717 RTU has been designed to operate in conjunction with the Metrilog M2M Gateway and Metrilog M2M Services. Before installing a M717 RTU in the eld, it should be registered on the Metrilog M2M Gateway.
templates are available on the M2M Gateway, while new sensors/templates can be easily de ned by the user. 2.2. The SDI Connector The pin-out of the SDI-12/RS-485 connector is shown below. 2 1 3 4 1 Brown + Vin (6 to 30 Volt) 2 White - Vin and SDI-12 GND 3 Blue RS-485 A/CAN-L (unused in native SDI-12 mode) 4 Black SDI-12/RS-485 B/CAN-H Note: The colours given in the last column are valid for the standard Metrilog M12 cable (option). Pin 3 is not used in native SDI-12 mode. 2.3.
2.5. About the Data Acquisition Subsystem Depending on the interface to the input/output devices (sensors), the M717 RTU supports the following sensors and data loggers: • Sensors based on the SDI-12 protocol, version 1.3. It has various operating modes and can be con gured to accept a large variety of sensors both in native SDI-12 hardware interface and the RS-485 balanced interface. The RS-485 interface allows for longer cables, but unfortunately not many sensor manufacturers implement SDI-12 over RS-485.
• Log in to the M2M Gateway and in the left pane select the RTU you want to add a new sensor to. • In the right pane, click the “New Sensor” button. • Name your sensor, then from the drop down select the template corresponding to the sensor you want to add. • Click the "OK" button. The sensor will be added to the RTU. After the sensor has been added, select it in the left pane and click “Attributes” to complete or change some attributes.
• Log in to the M2M Gateway and in the left pane click and expand the “Admin” entry, then click the “Templates” entry. • Select an existing sensor template which is as much as possible close to the one you want to create. • In the right pane, click the “Save as Template” button. • In the following dialog box, enter the name of the new template and select the destination area (where the template will be saved on the server).
Note: The attribute names, as well as all the parameters must be entered exactly as written; where no value is given, the eld should be left empty. However, you may enter default values for the sdiAddress and sdiMethod (consult the sensor’s speci cations). After all the sensor’s attributes have been entered, you need to de ne and add the sensor’s tags. • Select the sensor and click the “New Tag” button. • Enter the name of the new sensor (e.g.
2.7. Interface to a Davis Vantage Pro Console The following instructions are valid when the M717 RTU is connected to a Vantage Pro weather station (manufactured by Davis Instruments). The M717 RTU can be installed both indoors and outdoors. Note: The M905 Connexion Box, the Davis Console, as well as the mains adapter are not intended for outdoors installation! To connect the M717 RTU to the Vantage Pro Console, a WeatherLink data cable from Davis Instruments is required.
• The attribute mpiMode determines the operation mode of the MPI interface: set to one of RS-232, RS-422 or RS-485, depending on the con guration of the data logger. • The attribute mpiTermination is e ective only in the RS-422 and RS-485 modes: if required, 120Ω termination resistors can be activated on the M717 RTU side of the bus. • After all attributes are properly set, click the “Save” button. To connect the 10 m M12 cable, you must open the Thies data logger and insert it through a free cable gland.
2.9. Mechanical Installation The M717 unit should be preferably mounted outdoors on a 40 mm diameter mast or support by means of an (optional) metallic mounting xture and a hose clamp. In this case fasten rst mounting xture to the M717 enclosure using two M6 screws and spacers (see the gure below). If the unit is not installed outdoors, rather placed on a table or in a cabinet, the metallic xture may not be required.
3. Con guration The M717 RTU is automatically con gured by the Metrilog M2M Gateway, therefore in most cases no user intervention is necessary. However, the operation of the RTU and the sensors can be customised to a certain extent. The preferred method is via the M2M Gateway, but for advanced users, and when the units are accessible via USB or telnet, a Command Line Interface (CLI) is available, as described in the following sections. 3.1.
Connect a micro-USB to A cable to a PC and use the new virtual serial port (COM or tty) registered in your system with the terminal program. You should see in your terminal program the RTU name followed by a login prompt: enter the RTU password (as set on the M2M Gateway, see also "Register an RTU" section) then the “:” prompt should appear. 3.3. MPI as Service Port An alternative to the USB Service port is the MPI Connector.
4. Commands The information in this chapter is intended for well trained technicians to pinpoint errors or other device malfunctions, to customise the functionality if the communication to the M2M Gateway is not possible, or for developers that wish to implement special software in conjunction with the M717 RTU. Before using any command described in this chapter, make sure you have a good understanding of what the command does. Improper use may render the RTU inoperable.
4.1.3. echo Description Enables/disables echoing the typed characters. Issued without a parameter, it returns the current state. Default for echo is ON. Examples : echo Echo is on : echo off 4.1.4. ps Description Shows the RTOS threads, their state, CPU load and memory available. This command is informative.
: date -c -30 -> the clock will run slower with -30 ppm of a second : date -tz “CET-1CEST-2,M3.5.0/02:00:00,M10.5.0/03:00:00" : date -r RTC's reference frequency 1.000058 Hz 4.1.6. log Description Shows log entries and log statistics.
4.1.7. attr Description Used to show/modify attributes. Usage attr [ -a | -s | -t | -h | -v ] to show attributes, -a for all, -s for all sensors, -t for all tags attr [ nodeid ] attrib_name [ attrib_value ] to show or modify a speci c attribute; if nodeid is not speci ed, the rtu node is assumed; if an attrib_value is speci ed, the attribute with attrib_name from the respective node_id will get the new value, otherwise the current value will be shown.
command is entered only once, normally in the factory, but may be necessary after e.g. a SIM card has been replaced. The -v option attaches a CRC to the command string and should only be used during communication with computers (e.g., during manufacturing). Example : pin PIN is set PUK is set 4.1.9. hwid Description Shows the hardware ID of the RTU. Usage hwID [ ID ], where ID is the ID to set Remarks The ID can be set only once; this is done during manufacturing.
: xfer -r m717_1_04.pack CCC : xfer -s test.json 4.1.12. fwupdate Description Initiate a rmware update. Usage fwupdate < lename> where < lename> is the name of the package le containing the rmware fwupdate -a to update to the latest o cial rmware version distributed by Metrilog. The RTU automatically searches and retrieves the package le over the Internet. Remarks When updating from a local le, it is essential that the package le has a .
Examples : reboot Are you sure? (y/n) y Please don't disconnect the power while the modem is shut down... Done. System will now restart 'Wagram' password: : reboot -c Are you sure? The configuration will be cleared (y/n): y Please don't disconnect the power while the modem is shut down... Done. System will now restart, the configuration has been cleared Type "help" for the list of available commands : 4.1.14. exit Description Exits the CLI.
4.2.3. dacq sample Description Used to sample and show sensor/logger data. Usage dacq sample [ date [ time ]] where is the ID of the sensor to sample, while the optional date and time parameters can be used to specify a point in time after which the data should be returned. Obviously, this is valid only for loggers, i.e., devices having storage possibilities (e.g., Thies loggers or Vantage Pro consoles); for SDI-12 sensors, these parameters are ignored.
The ID of a speci c sensor can be found using the attr -s command, under the section “sensor ID (index)”, it is the value given in parenthesis. If there is only one sensor con gured in the RTU, then the ID is always 0. Example : dacq abort 0 4.2.6. dacq date Description Use to set/synchronise the date/time of a sensor/logger. Usage dacq date where is the ID of the sensor to synchronise.
Davis consoles have their own proprietary protocols, for more details consult their respective user manuals. The ID of a speci c sensor can be found using the attr -s command, under the section “sensor ID (index)”, it is the value given in parenthesis. If there is only one sensor con gured in the RTU, then the ID is always 0. Example : dacq direct 0 Type to exit 4.2.9. dacq t Description Used to send a command transparently to a sensor.
5: 01/10/2020 : hist 5: 01/10/2020 5: 01/10/2020 5: 01/10/2020 […] 5: 01/10/2020 5: 01/10/2020 03:10:00 23.490000[0] 03:20:00 23.510000[0] 03:30:00 23.480000[0] 03:40:00 23.510000[0] 06:20:00 23.410000[0] 06:30:00 23.450001[0] 4.2.11. hist info Description Show the data interval stored for a speci c tag. Usage hist info where hist# is the historian for which to display the dates of the oldest and the newest record.
Remarks The command will display a table with the mapping of the historians to the sensor IDs, as well as their status (active/deleted). The stream to which a historian belongs will be also shown. A "deleted" historian is one that is no more active, it will be "recycled" when new sensor will be added after all historians have been used (currently 128). Note that deleted historians do not belong to any stream.
4.3.1. sdi t Description Used to issue a command in transparent mode to an SDI-12 sensor. Usage sdi t where is a standard SDI-12 command, including the sensor’s address and the exclamation point (!). Remarks The command implements the standard SDI-12 timing. Examples : sdi t AI! A13MetrilogM512rC1.4.1055#000000 : sdi t AM! A0048 : sdi t AD0! A+25.17+31.71+0+0+1+0+1+12.03 4.3.2. thi t Description Used to issue a command in transparent mode to a Thies data logger.
Windges. (75): 2.2 m/s Temperatur 2m: 20.6 Grad C Rel. Feuchte : 49.0 % Taupunkt : 9.5 Grad C Temperatur5cm: 20.5 Grad C Luftdruck (a):1009.6 hPa Niederschlag : 0.0 mm Nied.-Melder :0 Gl-Strahlung : 99 W/qm Sonne ja/nein:1 Sonnen.-Dauer: 500.5 min/d Temperatur(w): 24.7 Grad C Batteriesp. :13.4 V Luefterstrom :125 mA Heizungsstrom: 0.0 A SYNOP 1min : 0 SYNOP Niedersch.LNM: 0.0 mm ENDE : thi direct Type to exit OK Jun 3 2013 OK 3.
Usage net get Remark Only http und https protocols are currently supported. Example : net get https://update.metrilog.com/m717_update_102.pack firmware/ File transfer started, it may take some time... : File transfer succeeded, 336108 bytes downloaded : ls firmware -rw 336108 Jun 29 2020 17:00 - m717_update_102.pack Capacity: 0.01 GB (12288 KB), available: 0.01 GB (11600 KB). 4.4.3. net up Description Starts up the IP network (connect to the Internet). Usage net up Example : net up 4.
: modem Modem status: Operator: 23201 (automatic) Registered, home Network: LTE, LAC/CI: 426c/94901 (17004/608513) RSSI: -65dBm (23) Service: LTE (valid) Service setting: auto SIM card: present SIM CCID: 89430103317024015403 Modem model: ME909s-120 Modem version: 11.617.24.00.00 IMEI: 867377020122424 4.4.7. modem direct Description Opens a direct connection to the cellular modem.
Examples : modem pwrup : modem pwrup hard 4.4.10. modem reset Description Hard resets the cellular modem. Usage modem reset Remarks Avoid issuing this command, use it only when the modem is not responsive. Use the modem pwrdown/modem pwrup commands instead, and if the modem still does not react, try the modem pwrup hard command (see above). Example : modem reset 4.4.11. modem mode Description Shows if the modem is in sleep mode or not.
-rw 337408 Jun 29 2020 -rw 330199 Jun 29 2020 -rw 4194304 Aug 8 2020 Capacity: 0.01 GB (12288 16:54 - m717_1_03.pack 17:00 - m717_1_02.pack 17:15 - speedtest.bin KB), available: 0.01 GB (7504 KB). 4.5.2. mkdir Description Creates a new directory. Usage mkdir , where is the path to the directory to be created. Examples : mkdir new-directory : ls drw 0 Jun 26 2020 -rw 337408 Jun 29 2020 -rw 330199 Jun 29 2020 -rw 4194304 Aug 8 2020 drw 0 Aug 8 2020 Capacity: 0.
-rw 337408 Aug 8 2020 20:12 - m717_1_03.pack Capacity: 0.01 GB (12288 KB), available: 0.01 GB (6844 KB). 4.5.5. pwd Description Prints the working (current) directory. Usage pwd. Examples : pwd /flash/ : cd new-directory : pwd /flash/new-directory : cd ../firmware : pwd /flash/firmware : cd : pwd /flash/ 4.5.6. rm Description Used to remove a le or a directory. Usage rm , where is the path to the le/directory to be deleted.
"setToAddress": "5" }, { "name": "Lambrecht ARCO Wind Direction", "sdiID": "LMGmbH1514582D", "setToAddress": "6" }, { "name": "Tekbox Rain Gauge", "sdiID": "TEKBOXVNTBSRG", "setToAddress": "7", "configCommands": [ "7XSBV,+0.20!", "7M!", "#2", "7D0!" ] } ] } 4.6.
5. Attributes This section details the attributes used to de ne the RTU functionality. It is important rst to understand the function of a certain attribute before attempting to change its value, as improper manipulation of the attributes can lead to malfunction. Attribute’s values may be changed • either through the M2M Gateway User Interface, • or using the command attr in the CLI (see the attr command). It is not possible to directly add or delete attributes to/from an existing node.
Attribute cliPort Type r Description The port number on which the telnet server will listen (default 22). De nes the connection schedule of the RTU. It uses a cron syntax, ex: */10 means that the RTU should connect every ten minutes, starting with minute 0. A complete cron string may specify minutes, hours, days, months and the day of the week. The smallest unit that connectSchedule r can be set is therefore one minute.
Attribute Type Description Send SDI command(s) in pseudo-transparent mode to an SDI sensor. The attribute is intended to be updated through the M2M Gateway. More than one command can be sent in one string; while sdiMsg spaces between commands are optional, they improve readability. r/w If a delay is required between commands, it can be speci ed as \n, where n speci es the delay in seconds. Example: 0M! \5 0D0! The results returned by the sensor(s) are piped to the log.
Attribute Type Description The icon graphic that will be used to display the sensor on the M2M Gateway (default COMBO); the graphic must already exist on the iconName server (on the UI of the M2M Gateway, click the Info button, then r Icons). Note: this attribute is used only by the M2M Gateway and it does not exist in the RTU. lastDate r The date the sensor was sampled last time. The date of the sensor’s last values pushed unto the server (M2M putdataDate Gateway).
Attribute Type Description De nes how commands de ned by the sdiCommand attribute will be issued to output tags (default 2). Following modes are de ned: 0 – no commands, tag is disabled. commandMode 1 – not used. r/w 2 – commands will be sent in automatic mode, de ned by the commandSchedule attribute. This attribute is valid for SDI-12 actuators only. De nes the schedule to send commands de ned by the sdiCommand attribute to an output tag.
Attribute Type Description The string representing the command to be sent to an output tag; usually it is an X command (or a manufacturer custom command). The sdiCommand r/w address and the SDI-12 terminator (!) should be skipped (the address is de ned by the sdiAddress attribute). This attribute is valid for SDI-12 actuators only. See also the commandSchedule and commandMode attributes. De nes the position of the tag’s value in the string returned by a Dn or sdiIndex r/w Rn command.
6. Technical Speci cations Parameter Value Cellular modem GPRS/EDGE/WCDMA/LTE Cat 4 Interfaces RS-232, RS-422, RS-485, CAN, SDI-12, USB 2.0 Supported protocols TCP/IP, HTTP, HTTPS Internal storage 16 Mbytes, non-volatile Sensor sampling interval Programmable (minutes, hours, days, weeks) Communication interval Programmable (minutes, hours, days, weeks) Power supply External 6 to 30 Volt (M12 connectors); 5 Volt (USB) Power consumption Standby, receive enabled: typ. 2.