1. Manuals
  2. Brands
  3. YDOC Manuals
  4. Data Loggers
  5. ML 17 Series
  6. Manual

YDOC ML 17 Series Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
Low power 2G/3G/4G data loggers
Title
:
User Manual ML-x17
Version
:
FW V4.6B4
Manufacturers of low power instruments
ML-x17 DATA LOGGER MANUAL
Type ML-x17
page 1
Date
:
July-2022

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the ML 17 Series and is the answer not in the manual?

Questions and answers

Subscribe to Our Youtube Channel

Related Manuals for YDOC ML 17 Series

Summary of Contents for YDOC ML 17 Series

  • Page 1 ML-x17 DATA LOGGER MANUAL Type ML-x17 Low power 2G/3G/4G data loggers Title Date User Manual ML-x17 July-2022 Version FW V4.6B4 Manufacturers of low power instruments page 1...
  • Page 2 We recommend reading this manual carefully before installation of the data logger. Warranty All YDOC instruments are warranted for 3 years against defective materials and workmanship. Any questions with respect to the warranty mentioned above should be taken up with your YDOC Distributor. Manufacturers of low power instruments page 2...

  • Page 3: Table Of Contents

    ML-x17 DATA LOGGER MANUAL Table of Contents Product description ..........................11 Models and Editions ........................12 Getting started ............................. 14 Vibration ............................14 Do’s & Don’ts ..........................14 Inserting the SIM-card ........................ 14 Power on for the First time......................15 Connect to a PC, tablet or smart phone ..................
  • Page 4 ML-x17 DATA LOGGER MANUAL 4.5.13 Summer time........................33 Modem Settings .......................... 33 4.6.1 Provider Selection ........................33 4.6.2 Technology ..........................34 4.6.3 APN settings ........................... 34 4.6.4 Network signal test ......................... 34 4.6.5 APN login test ......................... 35 NTP time update ......................... 35 4.7.1 Time Update ...........................
  • Page 5 ML-x17 DATA LOGGER MANUAL 4.12.9 Counter ..........................42 4.12.10 Quantity ..........................42 4.12.11 Mean-, Max- and Min Rate ....................42 4.12.12 Activity period ........................42 4.13 Digital inputs - Alarm trigger ....................... 42 4.13.1 Trigger delay ........................43 4.13.2 Register value ........................43 Digital inputs –...
  • Page 6 ML-x17 DATA LOGGER MANUAL 4.18.8.2 lt(x;y;q;p) ........................52 4.18.8.3 le(x;y;q;p) ........................52 4.18.8.4 gt(x;y;q;p) ........................52 4.18.8.5 ge(x;y;q;p) ........................52 4.18.9 Various supportive functions:....................52 4.18.9.1 pi ..........................52 4.18.9.2 time ..........................52 4.19 Serial Port ........................... 53 4.19.1 RS232 ..........................53 4.19.2 Generic Modbus .........................
  • Page 7 ML-x17 DATA LOGGER MANUAL 4.20.3.5 Backup mode ......................64 4.20.3.6 Message format ......................64 4.20.4 Swarm Satellite ........................65 4.20.4.1 Send interval ....................... 65 4.20.4.2 Data transpond ......................66 4.20.4.3 Message format ......................66 4.20.4.4 Backup mode ......................66 4.20.4.5 Swarm time update .....................
  • Page 8 ML-x17 DATA LOGGER MANUAL 4.25.2 Port ............................. 80 4.25.3 Security ..........................80 4.25.4 Root topic ..........................80 4.25.5 Client ID ..........................81 4.25.6 Clean Session ........................81 4.25.7 Data format ......................... 81 4.25.8 Max Payload ........................81 4.25.9 Input Parameters ........................ 81 4.25.10 Remote configuration and firmware upgrade ..............
  • Page 9 ML-x17 DATA LOGGER MANUAL 4.36.2 Common mode noise rejection ................... 97 4.36.3 Using Load Cells ......................... 98 4.36.4 Bridge of Wheatstone ......................98 4.37 Potentiometer input ........................98 4.38 Digital inputs ..........................100 4.38.1 Pull up type ........................100 4.38.2 Pull down type ........................
  • Page 10 ML-x17 DATA LOGGER MANUAL 4.47.2 Digital Pulse Sensor ......................120 4.47.2.1 Example configuration Rain Measurement ............... 120 4.47.2.2 Counter ........................122 4.47.2.3 Quantity ........................122 4.47.2.4 Rate .......................... 122 4.48 Power supply ..........................123 4.48.1 Internal RTC backup battery ..................... 123 4.48.2 Power consumption &...

  • Page 11: Product Description

    ML-x17 DATA LOGGER MANUAL 1. Product description The data logger is designed to retrieve, and store data from various sensors. This data is logged onto the embedded / removable SD-card. Also, the stored data can be send from the data logger to any remote computer you like.

  • Page 12: Models And Editions

    ML-x17 DATA LOGGER MANUAL 1.1 Models and Editions The ML-x17 data logger is a small, ultra-low power, cost effective data logger with built-in 2G/3G/4G cellular modem available for the EMEA, APAC and NA regions. This small data logger, is the same as mlx-15, with the addition of an option port for expansion of possibilities.
  • Page 13 ML-x17 DATA LOGGER MANUAL 1) Mounting bus for option board 2) Main Fuse (2A Fast Acting) 3) 3V6 Power Supply Connector 4) SIM(2FF) & Micro SD-card Holder 5) Accessory port (TFT, CAM, etc.) 6) Analog input port 7) RS232/RS485/SDI-12 Port 8) Digital input port 9) 12 V Sensor Power Output &...

  • Page 14: Getting Started

    ML-x17 DATA LOGGER MANUAL 2 Getting started 2.1 Vibration At all times the data logger must be protected against vibrations. These vibrations can harm the performance of the data logger. Especially the real-time clock can be harmed by long-lasting vibrations 2.2 Do’s &...

  • Page 15: Power On For The First Time

    2.5 Connect to a PC, tablet or smart phone OS compatibility: The data logger can be connected by USB2.0 to a Windows PC or Android tablet or smart phone. ydocTerminal for Windows can be downloaded from www.ydoc.biz, ydocTerminal for Android can be downloaded from the Android Playstore.

  • Page 16: Operating Basics

    Connect the logger to a free USB port on your computer and open with a terminal emulator the virtual COM-port (e.g. COM7) as assigned by Windows to the logger. The first time Windows will ask (if not already installed) for an USB-driver, which can be installed by installing ‘YDOC-Terminal’. When the terminal emulator has opened the COM-port, press: <Ctrl>A<Shift>M<Ctrl>D to enter the configuration menu.
  • Page 17 ML-x17 DATA LOGGER MANUAL You’ll see this screen: Configuration setup First Rename your Device by [0] Exit Selecting option 1 [1] General settings >> YDOC (General Settings) [2] Modem settings [3] NTP time update >> Not used [4] Alarm messages >> Not used [5] Option boards >>...
  • Page 18 ML-x17 DATA LOGGER MANUAL Next type 7 for Analog inputs Analog inputs [0] Exit [1] Port 1 (mA) >> Analog1 [2] Port 2 (mA) >> Not used [3] Port 3 (V) >> Not used [4] Port 4 (V) >> Not used [5] Potentiometer >>...
  • Page 19 ML-x17 DATA LOGGER MANUAL but just two different points within the range of the sensor. (e.g. a measurement at 1m water level and a measurement at 2m water level, while the sensors range is 0...10m) 5. If necessary option 9 can be used to perform an offset correction by measuring a single calibration point.
  • Page 20 ML-x17 DATA LOGGER MANUAL MODBUS sensor [0] Exit [1] Name >> MODBUS [2] Port settings >> RS485 8N1; 19200 Baud; Address 1 [3] Sensor power >> Disabled [4] Sample interval >> Data log interval [5] Protocol type >> RTU [6] Measurement commands >> Not used [7] Register type >>...
  • Page 21 ML-x17 DATA LOGGER MANUAL First, perform [T] an APN login test. If successful you can leave [0] this menu without specifying any APN- settings manually. Note: In case of several successive failures it might be because your SIM requires manual APN settings, please ask your provider for the correct settings first.
  • Page 22 [8] Originator address >> r.kleine@provider.com [9] Destination address >> your@provider.com [A] Subject >> YDOC upper stream [R] Remove [T] EMAIL test >> Not Done > Now perform an Email test and check if it is working right.

  • Page 23: Reference

    Principle of Operation 4.1.1 Intervals Your YDOC data logger is capable of collecting and storing data of multiple sensors. To accomplish this, many tasks are performed. These “tasks” are scheduled and executed on their specified time. The timing of this process is very important and is determined by the internal scheduler. This scheduler keeps track of all the internal states of the various tasks and assigns processor time to the different tasks.

  • Page 24: Send Interval

    ML-x17 DATA LOGGER MANUAL This interval determines when a data value, obtained by the sample interval-task, is stored onto the SD- card. This type of interval is ALWAYS valid. So, even when the data logger is in sleep-mode, it will wake up when the Data logging Interval has reached its count.

  • Page 25: Output Type

    ML-x17 DATA LOGGER MANUAL 4.1.2.2 Output type Per output driver you can specify which type of data you want to output: 1) All logged data since the previous successful transmission, 2) Just the last know sampled actual values or 3) a heartbeat message. The primary output is normally chosen for transmission of the logged data.

  • Page 26: Name

    ML-x17 DATA LOGGER MANUAL Parameter Settings [0] Exit [1] Name >> Analog [2] Code >> AIN [3] Unit >> meter [4] Value factor >> [5] Value offset >> 0 [6] Decimals >> [7] Data log >> On [8] Data output >>...

  • Page 27: Alarm Message

    ML-x17 DATA LOGGER MANUAL 4.2.9 Alarm message Here, the user can select whether he wants to receive an alarm message on this parameter (in alarming conditions) or not. Alarm messages are send by SMS, e-Mail or MQTT. 4.2.10 Alarm log Setting which enables the storage of the alarm condition of the parameter to the SD card.

  • Page 28: Configuration Menu Settings

    4.3 Configuration Menu Settings This Chapter describes the details of the configuration-settings of your data logger. The configuration menu is entered by using YDOC-terminal and typing <Ctrl>A<Shift>M<Ctrl>D. 4.3.1 Date & Time This section allows you to set date and time manually. If pressed enter, the existing system data/time is displayed.

  • Page 29: Configuration Setup

    ML-x17 DATA LOGGER MANUAL 4.4 Configuration Setup This menu-section allows you to configure your data logger for your specific task. This section is divided into logical items, which contains more settings will be discussed next: Below a screenshot of the configuration setup is displayed: Configuration setup...
  • Page 30 ML-x17 DATA LOGGER MANUAL General settings [0] Exit [1] System name >> [2] Data log interval >> 00:01:00 [3] Timestamp round down >> Not used [4] Avoid equal timestamps >> Off [5] Continuous alarm sampling >> Off [6] Direct data output on data alarm >> Off [7] Alarm output port >>...

  • Page 31: General Settings

    ML-x17 DATA LOGGER MANUAL General Settings Here you enter your global settings, like data log interval etc. These are the settings: 4.5.1 Exit Exits the menu 4.5.2 System Name Allows the user to give a name to the data logger (up to 32 characters). This name will be used in the data files, produced by the logger.

  • Page 32: Alarm Output Port

    ML-x17 DATA LOGGER MANUAL mode, changes this. When the sample interval of concerned sensor is set to i.e. 1 minute, the data logger will wake every minute, and take a measurement, but NOT store this on the SD Card. So, the user ends up with a normal data file, with every 10 minutes a new data record, and the system is responding within 1-minute max.

  • Page 33: Daily Operating Time Slot

    This section allows the user to setup the communication with the 2G/3G/LTE network, according to the settings, received from the service provider. Please consult your service provider for the right settings, before consulting your YDOC dealer. Modem settings [0] Exit...

  • Page 34: Technology

    ML-x17 DATA LOGGER MANUAL Provider selection AT+COPS=3,0;+COPS? +COPS: 0,0,"NL KPN",2 AT+COPS=? +COPS: (2,"NL KPN",,"20408",2),(2,"NL KPN",,"20408",0),(1,"T-Mobile NL",,"20416",2),(1,"vodafone NL",,"20404",2),(1,"T-Mobile NL",,"20416",0),(1,"vodafone NL",, "20404",0),,(0-4),(0,2) [0] Exit [A] Automatic selection >> On [1] NL KPN (3G) >> Automatic selected [2] NL KPN (2G) >> Automatic selected [3] T-Mobile NL (3G) [4] Vodafone NL (3G) [5] T-Mobile NL (2G)

  • Page 35: Apn Login Test

    ML-x17 DATA LOGGER MANUAL 4.6.5 APN login test You should test the APN login after changing APN settings, in order to verify the network connection. 4.7 NTP time update This feature enables the automatic synchronization of the internal clock, by means of a Network Time Protocol (NTP) server on the internet.

  • Page 36: Option Boards

    ML-x17 DATA LOGGER MANUAL 4.9 Option boards Option boards can be used to add additional inputs, outputs, ports to an ML-x17 data logger or to perform signal conditioning. You can mechanically stack up to 3 option boards, but only one board per category ID (CID, internal bus address).

  • Page 37: Ml-Oi-Ad-Pt1000

    ML-x17 DATA LOGGER MANUAL 4. Perform a 1 point calibration (See chapter: Analog inputs – Determine linear offset). For the calibration point enter the expected physical value when the sensor output signal is zero. (e.g. 0W/m2 for a pyranometer). 4.9.2 ML-OI-AD-PT1000 This board provides two PT1000 temperature sensor inputs using a “bridge of wheatsone”...

  • Page 38: Battery Replaced

    ML-x17 DATA LOGGER MANUAL 4.10.4 Battery Replaced The user must select this when he installs a new lithium battery. The calculations of the rest capacity will be reset (battery rest capacity 100%) 4.10.5 Rest Capacity Remaining capacity of the lithium battery. In percentage of a full battery. 4.10.6 Rest power Same parameter, but in mAh Attention: the battery-full parameters are only representative when used in lithium battery-only...

  • Page 39: Analog Inputs

    ML-x17 DATA LOGGER MANUAL 4.11 Analog inputs Analog input [0] Exit [1] Name >> Water height [2] Sensor power switch >> Enabled; Warm up 00:00:02 [3] Sample interval >> Data log interval [4] Port mode >> Port 1; 4-20 mA [5] Parameter settings >>...

  • Page 40: Digital Inputs - Pulse Counter

    ML-x17 DATA LOGGER MANUAL 4.12 Digital inputs – Pulse counter This section describes the operation of digital inputs, NOT to be confused with serial sensors, which also is a digital technique. A digital input is an input which measures the digital value of the input signal. This is a discrete value “0”...

  • Page 41: Sample Interval

    ML-x17 DATA LOGGER MANUAL 4.12.1 Sample interval This is exactly the same feature as in other menu’s, although there is something interesting to notice about the sample interval of a digital input (pulse sensor). With analog inputs, the sample rate defines how many times an input is sampled.

  • Page 42: Log Each Counter Change

    ML-x17 DATA LOGGER MANUAL 4.12.8 Log each counter change This is only possible with low frequency sensors. The event is logged and a timestamp is added. I.e. if you like to count the customers, visiting your store, and you like to make a nice statistical graph, this feature is convenient (you can see busy hours, slow hours etc.).

  • Page 43: Trigger Delay

    ML-x17 DATA LOGGER MANUAL 4.13.1 Trigger delay The amount of time the data logger waits before changing to the alarm state (when the input condition is true). When the logger measures an alarming input-condition it enters the pre-alarming mode. This mode will change into alarming mode when the trigger delay has finished.

  • Page 44: Total On-Time

    ML-x17 DATA LOGGER MANUAL Digital state input [0] Exit [1] Name >> Digital state [2] Port mode >> Port 2; Internal pull up [3] Digital input >> Low active [4] Register value >> 0 hour [5] Register reset >> Not used [6] Total on-time >>...

  • Page 45: Independent Data Log

    ML-x17 DATA LOGGER MANUAL Network signal sensor Exit [1] Name >> Network signal [2] Independent data log >> On [3] Sample log interval >> 06:00:00 [4] Signal bars (0-5) >> Signal [5] Signal quality (0-7) >> Not used [6] Signal (dB) >>...

  • Page 46: Aggregation Channels

    ML-x17 DATA LOGGER MANUAL 4.17 Aggregation Channels The logger is equipped with 8 aggregation channels which can be used to record aggregated values (average, minimum, maximum, gust and standard deviation) calculated over a period of your choosing. The number of samples taken into account during the aggregation period is depending on the period duration and the ‘Sample interval’...

  • Page 47: Average, Minimum, Maximum, Gust, Standard Deviation & Change

    ML-x17 DATA LOGGER MANUAL E.g. a northern wind flapping between 340 and 10 degrees will result in an average northern wind of 355 instead of a faulty 175 degrees southern wind. Some values (like Noise) are expressed in dB and as dB is a logarithmic value the individual values have to be linearized first before averaging (e.g.
  • Page 48 ML-x17 DATA LOGGER MANUAL Configuration setup Exit [1] General settings >> YDOC6721BK [2] Modem settings [3] NTP time update >> Used [4] Alarm SMS >> Not used [5] Option boards >> Not used [6] Internal sensors >> Internal [7] Analog sensors >>...

  • Page 49: Syntax

    ML-x17 DATA LOGGER MANUAL 4.18.1 Syntax Within the data logger each sensed/calculated parameter/channel has a parameter code chosen by the user (e.g. TEMPC for a temperature in Celsius, Attention: codes should not contain any spaces or signs). These parameter codes can be used in equations by preceding them with a colon (:). When It’s possible to calculating the parameter codes will be substituted with the last recent measured values.

  • Page 50: Supported Mathematical Functions With One Argument

    ML-x17 DATA LOGGER MANUAL 4.18.5 Supported mathematical functions with one argument: 4.18.5.1 abs(x) returns the absolute value of x Example: abs(-10.7) returns 10.7 4.18.5.2 sqrt(x) returns the square root of x 4.18.5.3 ln(x) returns the natural logarithm of x 4.18.5.4 exp(x) calculates the exponent of e to x 4.18.5.5...

  • Page 51: Torad(Degrees)

    ML-x17 DATA LOGGER MANUAL 4.18.5.12 torad(degrees) converts degrees to radians 4.18.5.13 todeg(radians) converts radians to degrees 4.18.5.14 floor(x) returns the largest integer not greater than x, example: floor(10.7 returns 10 4.18.5.15 ceil(x) returns the smallest integer not less than x, example: ceil(10.3) returns 11 4.18.5.16 round(x) rounds to the nearest integer 4.18.6 Supported mathematical functions with multiple...

  • Page 52: Supported Comparisons With 4 Arguments

    ML-x17 DATA LOGGER MANUAL Example: ge(10;11) returns 11; Synonym: If (x>=y) return x; else return y 4.18.8 Supported comparisons with 4 arguments: 4.18.8.1 eq(x;y;q;p) returns q if x is equal to y else return p Example: eq(10;11;0;3) returns 0; Synonym: If (x==y) return y; else return p 4.18.8.2 lt(x;y;q;p) returns q if x smaller than y else return p...

  • Page 53: Serial Port

    ML-x17 DATA LOGGER MANUAL 4.19 Serial Port The serial port of your data logger provides different forms of serial communications. This chapter describes the details of this communication. 4.19.1 RS232 This mode allows to connect to RS232 sensors, see RS232 for details of the electrical properties._RS232 Below a menu-settings screen is shown, for an RS232 sensor.

  • Page 54: Register Type

    ML-x17 DATA LOGGER MANUAL 4.19.2.3 Register type Consult the manual of your sensor for this. 3 types are supported: Bit register Holding register (default register) Input register 4.19.2.4 Register Start address MODBUS is a protocol to read from and write data to a memory map of a device, which is constructed of a list of 16 bit registers.

  • Page 55: Measurement Commands

    ML-x17 DATA LOGGER MANUAL 4.19.2.8 Measurement commands Some sensors do not automatically start sampling after power on or might require a maintenance cycle now and then (e.g. wiping a lens of a turbidity sensor). If necessary measurement and maintenance commands can be configured with the menu shown below: MODBUS Measurement commands [0] Exit [1] Start maintenance command >>...

  • Page 56: Generic Ascii

    ML-x17 DATA LOGGER MANUAL 4.19.3 Generic ASCII This is based upon a serial device that autonomous outputs sentences of data, like an GPS device. The user can capture this data, split it into various parameters, by specifying a separator character and by specifying the start and stop characters of a data sentence.

  • Page 57: Parameters

    ML-x17 DATA LOGGER MANUAL 4.19.3.6 Parameters These are the values you want to get recorded from the data sentence(s). Each parameter has 3 properties. Serial parameter input settings [0] Exit [1] Sentence filter >> MWV [2] Field position >> [3] Field type >>...

  • Page 58: Gps

    ML-x17 DATA LOGGER MANUAL 4.19.4.1 $GPGGA,172814.0,3723.46587704,N,12202.26957864,W,2,6,1.2,18.893,M,-25.669,M,2.0,0031*4F When using the ‘Generic NMEA’ driver instead of the ‘GPS’ driver to input GPS coordinates you might need to do a conversion from dddmm.mmmm N/S/E/W format to +/- ddd.dddddd format. This can be accomplished by using a calculated channel for both the latitude and the longitude. Latitude formula: (floor(:GGA2/100)+((:GGA2/100)-floor(:GGA2/100))/0.6)*eq(:GGA3;83;-1;1) Longitude formula:...

  • Page 59: Measurement Command

    ML-x17 DATA LOGGER MANUAL 4.19.6.1 Measurement command The user can choose between concurrent measurements (c), or non-concurrent (m). When the sensor supports concurrent measurements, we strongly advise to use it. Because it saves a lot of energy. (all sensors are measuring simultaneously). The command number is asked by the firmware, for retrieving the right data value.

  • Page 60: Serial Port Tunnel

    ML-x17 DATA LOGGER MANUAL 4.19.7 Serial port tunnel If you have connected a serial device, but it’s not used to record measurements, then you can access this device thru a serial port tunnel (e.g. thru the COM-port terminal in the Maintenance-menu). You can configure the parameter of the serial device thru the screens below: COM port tunnel settings [0] Exit...

  • Page 61: Accessory Port

    ML-x17 DATA LOGGER MANUAL 4.20 Accessory port This is a serial port which is used for supporting special serial devices, called accessory port modules. The accessory port is only equipped on the MLx17-ADS models. Below a list of supported accessories is shown.

  • Page 62: Send Interval

    ML-x17 DATA LOGGER MANUAL Radio settings [0] Exit [1] Name >> Radio [2] Port settings >> RS232 8N1; 4800 Baud [3] Module power switch >> Enabled; Warm up 00:00:01 [4] Send interval >> 00:00:10 [5] Send delay >> Not used [6] Power down delay >>...

  • Page 63: Iridium Satellite

    This option is for using satellite communication for data transfer. Not all satellite modems can be used on the data logger. It is designed to work with modems based on Iridium SBD 960x transceivers. We recommend the: http://www.ydoc.biz/datalogger-EDGE-satellite-transceiver.html as it supports RS-232 and has a weatherproof enclosure with integrated antenna.

  • Page 64: Settings Menu

    See chapter: “Compacted Data Format” for a description of the “Compacted” SBD message format. When using ydocInsights you should ask your Iridium provider to use IPDirect and pass SBD messages to the same IP-address/domain and TCP-port as used for 2G/3G/4G TCP-output from common YDOC data loggers.

  • Page 65: Swarm Satellite

    Hive by implementing the Swarm API in your own platform and decode the compacted messages or run our SwarmDataCollector Java jar (see: https://ydoc.biz/download/YDOC-SwarmCollector manual.pdf We have implemented two flavours of satellite messages: “Text” and “Compacted”.

  • Page 66: Data Transpond

    ML-x17 DATA LOGGER MANUAL powered till all enqueued messages are transferred. To minimize power consumption and latencies its recommended to have a 360 degrees clear view to the sky with the smallest possible angle to the horizon (the higher the antenna the better). Note: only parameters which are configured to output data to Satellite will be included in an enqueued message.

  • Page 67: Gps

    This is the driver for a standard NMEA-GPS. Some settings are discussed below. Although every standard NMEA-GPS can be used, it is convenient to use an YDOC–GPS, because it can be powered from the accessory port also. For info about the YDOC GPS receiver read: http://www.ydoc.biz/data...

  • Page 68: Gps Time Update

    ML-x17 DATA LOGGER MANUAL user has to work with the coordinates, coming from the GPS, and they are not comprehensive at all. Also, very often, the user has a good idea about the maximum allowable drift of the buoy, but NOT yet the starting location of it.

  • Page 69: Camera

    ML-x17 DATA LOGGER MANUAL 4.20.6 Camera This is used to connect an YDOC camera only. It shoots a picture and stores it on the SD-card for transmission to the host. More info on this camera’s is found here: http://www.ydoc.biz/data logger- accessories.html...

  • Page 70: Display

    ML-x17 DATA LOGGER MANUAL 4.20.7 Display This driver is intended for the operation of an YDOC display unit. With this display unit, the measurements can be consulted, locally, in a graphical way. The YDOC display unit is a 3.5” colour resistive touch screen display with a resolution of 320*240 pixels.

  • Page 71: Order Of Parameters

    ML-x17 DATA LOGGER MANUAL 4.20.7.2 Order of parameters The display can show up to 6 parameters simultaneously organized in two columns and three rows. ‘Next’- and ‘Previous’-buttons can be used to shift columns in & out of view when having more than 6 parameters. The columns are ordered from left to right and their row items from top to bottom.

  • Page 72: Accessory Port Tunnel

    ML-x17 DATA LOGGER MANUAL 4.20.1 Accessory port tunnel If you have connected a serial device, but it’s not used during normal operation, then you can access this device thru the accessory port tunnel (e.g. thru the COM-port terminal in the Maintenance-menu). You can configure the parameter of the serial device thru the screens below: COM port tunnel settings [0] Exit...

  • Page 73: Modem Output - Email

    ML-x17 DATA LOGGER MANUAL 4.21 Modem output - Email This output driver is used to send the collected data from the SD Card to a mailbox of the user. The data is included in an attachment of the email. Below the settings are shown: Some of its settings are commented below, other settings are generic and covered before in this manual.

  • Page 74: Modem Output - Ftp

    FTP settings [0] Exit [1] Name >> FTP [2] Send interval >> 01:00:00 [3] Send delay >> Not used [4] Server >> collector.ydoc.biz [5] Port >> 21 [6] FTP mode >> Active [7] Security >> TLS(explicit) [8] Username >> YDOC [9] Password >>...

  • Page 75: Verification

    ML-x17 DATA LOGGER MANUAL When all possible substitution tokens (9) are used you will have just 7 characters left to customize the file name, but you could manipulate the file by specifying the “system/driver” names wisely. i.e. use the “system name” for unique system identification and the “driver name” as a common file name part. 4.22.7 Verification To check if the file is fully transferred the data logger will verify if the transferred file has the expected file size.

  • Page 76: Remote Access

    Explicit TLS or Active FTP with Explicit TLS. Server address: Specify the same server and directory as used by the data logger (e.g. ydoc.biz/logfiles) User/Password: Specify the exact same credentials as used by the data logger as they are a/o used in the encryption keys.

  • Page 77: Modem Output - Http

    >> your-data-our-server.com/datacollector/ [5] Extended path >> [6] Port >> 80 [7] Security >> Basic [8] Username >> YDOC [9] Password >> ****** [A] Output type >> Log data [B] Data format >> JSON [C] Max payload >> 1000 kB [D] Data filter >>...

  • Page 78: Remote Access

    This is the Server servicing the secure and encrypted channel between data logger and ydocTerminal. Standard our server is used (tunnel.ydoc.biz), don’t worry we can’t eavesdrop your data as the communication is ‘Peer-to-Peer’ encrypted by security keys not know to the tunnel server. If having doubts, please feel free to run your own tunnel server, please ask our staff how to do it.

  • Page 79: Modem Output - Http Azure-Iot

    ML-x17 DATA LOGGER MANUAL 4.24 Modem Output – HTTP Azure-IoT This is the same driver as the HTTP(S)-driver as described above, but used in a special Azure-IoT security mode generating the “Shared Access Token”. To enable this mode, please select security mode “Azure-IoT SAS”.

  • Page 80: Data Output - Mqtt

    Within the data logger you can define a “Root topic”, which is used as prefix for all "Sub topics". The default “Root topic” is "YDOC/<device serial number>", but it can be changed according to your wishes. E.g. you could define a "Root topic" starting with your own company identification code, followed by some device classification code and your own chosen station identification code.

  • Page 81: Client Id

    ACME and when a logger publishes for the first time, then your system could create a profile for "STATION_001" based on the specified "METEOSTATIONS" classification. Clearing the ‘Root topic’ will set it back to the default YDOC/<SN> The logger uses the following publishing topics: •...

  • Page 82: Remote Configuration And Firmware Upgrade

    YDOC/<SN>/fw/set where the payload should contain the contents of a FW file. • YDOC/<SN>/cfg/set where the payload should contain the contents of a complete binary config file or just some changes by means of tiny configuration snippets (See chapter configuration snippets).

  • Page 83: Remote Access

    This is the Server servicing the secure and encrypted channel between data logger and ydocTerminal. Standard our server is used (tunnel.ydoc.biz), don’t worry we can’t eavesdrop your data as the communication is ‘Peer-to-Peer’ encrypted by security keys not know to the tunnel server. If having doubts, please feel free to run your own tunnel server, please ask our staff how to do it.

  • Page 84: Com-Tunnel

    MQTT message with the full 1 to 1 (binary) reply as the payload. 4.25.12.1 Topics An MQTT-client should format a command publishing topic as follows: “YDOC/<device serial number>/comtx/<port>[/<client defined sup-topics]” (QoS=1) Where <port> can be (if installed and configured in the data logger): “sp1”, the serial sensor port on the main PCB “ap1”, the accessory port on the main PCB...

  • Page 85: Data Output - Tcp

    Port on which the TCP-server is listening, which is 37 by default. When running your own TCP-server for data collection (e.g. the one that comes with ydoc-Insights) make sure that the chosen port is forwarded by your internet router to the local IP-address of the system/computer running your TCP-server.

  • Page 86: Sms Output

    ML-x17 DATA LOGGER MANUAL 4.27 SMS output This output driver is used to send the collected data from the SD Card to a cell phone number by SMS. As an SMS is limited in size transferring data by SMS has some limitations too. We recommend to use this driver only if other alternatives are not feasible.

  • Page 87: Parameter Overview

    ML-x17 DATA LOGGER MANUAL 4.29 Parameter overview The parameter overview is used to generate an overview of the configuration. It enables the user to evaluate the settings of the logger in an easy way as well as order the order of parameters, it consists of multiple lists: Parameter overview [0] Exit...

  • Page 88: Measurement List

    ML-x17 DATA LOGGER MANUAL 4.29.3 Measurement list This gives an overview of used measurements and its sample rates etc. Measurement list Parameter Sample interval Alarm interval Factor Offset Decimals [1] AVGVi 00:00:05 Not used [2] AVGCi 00:00:05 Not used [3] OCi 00:00:05 Not used [0] Exit...

  • Page 89: Alarm List

    ML-x17 DATA LOGGER MANUAL 4.29.5 Alarm list This gives an overview of all alarms used. See example below: Alarm list Code Alarm SMS Alarm log Alarm output Alarm samples Disabled Disabled Disabled Disabled Disabled Disabled Disabled MINVi Disabled Disabled Disabled Disabled Disabled Disabled...

  • Page 90: Maintenance Menu

    ML-x17 DATA LOGGER MANUAL 4.30 Maintenance Menu This menu is used to perform several diagnostic tests and includes tools for the maintenance of the data logger. Below the maintenance menu is shown: It is recommended that the user first consult this menu and run Maintenance some tests, before deployment.

  • Page 91: Sd Card Test

    ML-x17 DATA LOGGER MANUAL 4.30.1.3 SD card test Use this feature to test the SD card. There will be data written on the card, and afterwards erased. Below a screenshot is given: SD card test Data log file size = 4578 KB The information from this test is very important.

  • Page 92: Data Download

    The configuration of the data logger can be retrieved via the USB or remotely through TCP Terminal. Use YDOC-Terminal for retrieving the config from your data logger. When you like to retrieve a configuration-file from the data logger, select the option “configuration download”...

  • Page 93: Firmware Upgrade

    ML-x17 DATA LOGGER MANUAL A very practical method of configuring YDOC data loggers is to use one configuration-file to configure the data logger and afterwards personalize the logger with a unique system name manually. 4.30.1.9 Firmware Upgrade Select this option for upgrading firmware. More on FW upgrade see:...

  • Page 94: Hardware

    ML-x17 DATA LOGGER MANUAL 4.32 SDI-12 The ML-x17DS or ML-x17ADS is provided with and SDI-12 port, but it is shared with the RS-232 and RS- 485 port. You can add an (additional) SDI-12 port to any ML-x17 by means of an ML-OI-COM-SDI12 option board.
  • Page 95 SDI-12 port. The real SDI-12 port is aware of the exact protocol-timings and after the last character it switches to RX-mode immediately, without the delay. Therefore, no replies are missing. Your YDOC data logger has a true SDI-12 port. For more information on the SDI-12 protocol: see www.sdi-12.org...
  • Page 96 ML-x17 DATA LOGGER MANUAL Figure 1: RS485 Wiring RS485 is often used with MODBUS/RTU-sensors, and is less susceptible for Electrical interference than RS232. Your data logger has one RS485 port which is capable of driving multiple sensors (maximum number of sensors depends on specs from the manufacturer of the sensor, a practical figure is 10.

  • Page 97: Analog Inputs (0/4

    NOT covered in this manual, and the user may not seek for support from YDOC on this topic. You can add additional 0..10V inputs to any ML-x17 by means of an ML-OI-AD-10V option board.

  • Page 98: Using Load Cells

    ML-x17 DATA LOGGER MANUAL on the leads. Since the input acts like a differential amplifier, the noise on the negative input is subtracted from the noise on the positive input. What is left is the sensor-signal. 4.36.3 Using Load Cells The ML-x17 when equipped with differential inputs is very suitable for connecting load cells and other resistive elements.
  • Page 99 ML-x17 DATA LOGGER MANUAL outer terminals is changing with the angle of the potentiometer. Very often potentiometers are used to regulate a voltage from 0% to 100 % of the input voltage. In the next figure this well know circuit is drawn. The output voltage is adjustable from 0% to 100% of Vin, in this case.

  • Page 100: Digital Inputs

    ML-x17 DATA LOGGER MANUAL 4.38 Digital inputs The ML-x17 is equipped with 3 digital input(s). These inputs are interrupt-driven what means that they activate the data logger to wake up when sleeping, and that a signal-change on the input is never missed. So, these inputs are ideal to use for counting events (like the pulses from an energy-meter or a rain gage), or to set an Alarm state (e.g.

  • Page 101: Alarming

    ML-x17 DATA LOGGER MANUAL 4.39 Alarming In some circumstances, normal data-logging is not sufficient for managing your process. For keeping track of certain, often critical, conditions, the data logger is equipped with direct alarming options. Alarming-limits and hysteresis are used to manage these special events. The table below shows the different types of alarming-limits.
  • Page 102 ML-x17 DATA LOGGER MANUAL So, the entry of an alarm state is NOT affected by a hysteresis. Hysteresis is only used for switching back to the normal mode. The amount of hysteresis has an effect on the “sensibility” of the alarming. It is strongly advised to use a certain amount of hysteresis to prevent from multiple alarming warnings.

  • Page 103: Advanced Alarming

    ML-x17 DATA LOGGER MANUAL 4.39.2 Advanced Alarming From firmware-version V2.1B1 and above, we implemented an extended alarming feature that enables the use of calculated channels. This feature was implemented to calculate meaningful engineering values derived from raw sensor input values, however they could also be used for advanced alarming using multiple input conditions.

  • Page 104: Firmware Upgrade

    In time however, the need for additional features may arise. For example, a new serial sensor is introduced on the market and a customer wants to connect this sensor to the data logger. When YDOC has extended the firmware to support that sensor, a new version of the firmware is released. After the user has performed the firmware upgrade, his “old”...

  • Page 105: Power Switch Limitations

    This can be done with the modem mounted on the board (in circuit programming). The procedure of upgrading modem firmware is not covered in this manual. For more information, consult your local YDOC dealer. 4.41 SD-card The SD-card used with the data logger is an 8GB type micro SD-Card, but can be replaced by smaller or bigger SD-cards up to 32GB.

  • Page 106: Native Txt Data Format

    ML-x17 DATA LOGGER MANUAL 4.42 Native TXT Data Format The log file data format uses different records for data output. There are two types of data records: - D-records - S-records 4.42.1.1 Header: In every log file, first a header is transmitted. This header contains all information about the data following in the next records.

  • Page 107: D-Records

    ML-x17 DATA LOGGER MANUAL 4.42.2 D-Records Most of the data is logged into D-records. D-records stand for Data records. The syntax of this record is; <’D’> <’;’>,<Timestamp> <’;’> [ <Parameter Code> <’;’> < Parameter Value >[<Data Modifier>] <’;’>] So, the D-record consists of a ‘D’ character followed by a timestamp, and after that, one or more series of parameter code and parameter name.

  • Page 108: Data Modifiers

    ML-x17 DATA LOGGER MANUAL Example S-records: S;110922202054;CFG_RESET S;110922202054;CFG_CHANGED;Brasil_3002389 S;110922202124;MODEM_WDT;STATE 10 4.42.4 Data Modifiers Normally a data value, presented in D-records is recorded without a Data Modifiers, but in case of a malfunction, or rare circumstances, a Data Modifier is added to the data value. See table below: Data Description Remarks...

  • Page 109: Json Data Format

    ML-x17 DATA LOGGER MANUAL 4.43 JSON Data Format The JSON Data Format contains about the same info as our native TXT data format, but formatted in JavaScript Object Notation (JSON) format. This format is preferred by web developers as the data can be easily accessed by JavaScript or other scripting languages like PHP.

  • Page 110: Compacted Data Format

    ML-x17 DATA LOGGER MANUAL 4.44 Compacted Data Format The compacted data format is meant for use in case of message size constrained or payload expensive communication, like satellite communication. Compacting is required to get sufficient measurements in a size constrained message or to reduce expensive payload costs.

  • Page 111: Records

    ML-x17 DATA LOGGER MANUAL 4.44.1 Records A record can have a length from one to 6 bytes. 4.44.1.1 First byte of record Bit 7 Type of record Sign bit Scaling bits The most significant nibble of the first byte describes the type of record, the least significant nibble its scaling and sign.

  • Page 112: Time-Record

    ML-x17 DATA LOGGER MANUAL 4.44.1.3 Time-record Bit 7 Type of record=0 Sign Single byte Scaling value When the most significant nibble of the first record byte equals 0, then the record specifies a change in timestamp for all following value records. Bit 0 &...

  • Page 113: Sparkplug-B Data Format

    As well, this chapter details how you can specify ‘group_id’, ‘edge_node_id’, ‘Metrics’ and ‘Properties’, where its assumed that the reader is already familiar with how to configure an YDOC data logger. 4.45.1 Configuring the MQTT-driver How to configure the MQTT-driver is already described in a previous chapter, so only the items concerning Sparkplug-B will be detailed.

  • Page 114: Data Output

    “Metrics”. 4.45.3 Metrics An YDOC data logger, depending on the edition and installed options, can acquire physical signals by current loop, voltage and digital inputs as well as capture readings from serial sensors by MODBUS, NMEA, SDI-12 or ASCII protocols. It’s also equipped with a calculation and aggregation engine.

  • Page 115: Datatype

    All parameters will be exposed as datatype 10 (double) even totalizers and digital inputs. 4.45.5 Message examples Please find below examples of YDOC NBIRTH, NDEATH and NDATA messages. Sparkplug-B payload is formatted in Google Protocol Buffer format and therefor human unreadable. We have represented the examples below in JSON format for readability purpose only.

  • Page 116: Ndeath

    ML-x17 DATA LOGGER MANUAL 4.45.5.2 NDEATH Topic: spBv1.0/sp-grp-x/NDEATH/5025064 Please find below an example of the NDEATH message in JSON. "timestamp": 1486144902122, "metrics": { "name":"bdSeq", "timestamp":1486144902122, "dataType":"Uint64", "value":0 } 4.45.5.3 NDATA Topic: spBv1.0/sp-grp-x/NDATA/5025064 This payload will contain all values recorded between now and a previously succeeded transfer session. To keep the payload limited the recorded values will be referred to by their aliases as given in the preceding NBIRTH payload.

  • Page 117: Configuration Snippets

    ML-x17 DATA LOGGER MANUAL 4.46 Configuration snippets A data logger can be configured manually through the terminal interface or by loading a file containing a complete configuration in binary format. For fast deployment you could build up a list of configuration files for your different classes of monitoring stations (e.g.

  • Page 118: Driver Settings

    ML-x17 DATA LOGGER MANUAL 4.46.1.2 Driver Settings The following members can be included in a driver settings object: • “id” a “string” to identify the concerned driver by its name in the current active configuration. • “dn” a “string” of max 31 tokens providing the new driver name. •...

  • Page 119: Payload Example

    ML-x17 DATA LOGGER MANUAL 4.46.2 Payload example Please find below an example containing multiple snippets. Note that the comment // is include for informative purpose only and should not be included in real JSON. "gs": // Global Settings "dn":"Station 1", //New device name "ni":60, //New normal data log interval in seconds...

  • Page 120: Input-Drivers

    A warm up time of 5 minutes is possible and can be used in rare situations, but the battery-life will be shortened enormously. In such rare cases, consult your local YDOC-supplier for a calculation of battery-life, before exploiting your data logger.
  • Page 121 ML-x17 DATA LOGGER MANUAL Digital pulse sensor [0] Exit [1] Name >> Rain [2] Sample interval >> Data log interval [3] Port mode >> Port 1; Internal pull up [4] Register mode >> Pulse (low frequency) [5] Units per pulse >>...

  • Page 122: Counter

    ML-x17 DATA LOGGER MANUAL i.e. when your rain-gauge has a tipping bucket with a size of 0.2 mm rain, enter 0.2 Units per Pulse. You can reset the counter-value, caused by the previous test, if you like. You can do this by entering zero into the register via option 6.

  • Page 123: Power Supply

    When using the cover with integrated NiMH AA solar charger, we recommend to use LSD (long self- discharge) NiMH AA rechargeable batteries with at least a capacity of 2000mAh (e.g. GP Recyko, Sony Eneloop or Vapex Instant). Please consult the www.ydoc.biz website for an online power consumption calculator. Manufacturers of low power instruments page 123...

  • Page 124: Pin Configuration

    ML-x17 DATA LOGGER MANUAL 5 Pin configuration Connector Name Description 0..20mA, input 1 Positive terminal analog input 1 0..20mA, input 2 Positive terminal analog input 2 0..10V, input 3 Positive terminal analog input 3 0..10V, input 4 Positive terminal analog input 4 GNDs Ground 0..100% (0..3300mV), input 5...

  • Page 125: Pin Descriptions

    ML-x17 DATA LOGGER MANUAL 5.1 Pin descriptions 5.1.1 Analog Inputs 5.1.1.1 0/4..20mA inputs Analog Input 1 to 2 (ML-x17AD/ADS/TFT) These are Current-inputs, with an input impedance of 15 ohms. The range is 4 .. 20 mA. The circuits are equipped with over current-protection. To use this input connect the + of the sensor to the + of the power switch and the –...

  • Page 126: 3V6

    ML-x17 DATA LOGGER MANUAL 5.1.8 +3V6 This is a power output. It is used to power external sensors or a potentiometer. It has a voltage of 3.6 Volts and is capable of driving up to 100 mA. 5.1.9 Antenna placement and field strength An antenna is required for 2G/3G/4G and GSM operation.

  • Page 127: Maintenance And Repair

    –support. The real time clock is also calibrated during the manufacturing process, and has very good long life stability (see spec. sheet). Also, when operating in a harsh environment, the need for a recalibration can be applicable. YDOC can perform overall calibrations any time you like. 6.3 XRAY In the uncommon event of exposure to XRAY, extra precautions are needed.

  • Page 128: Safety

    ML-x17 DATA LOGGER MANUAL 7 Safety Don’t work on the wiring of the data logger when powered from an external supply. 7.1 Power supply The data logger is protected against reversed polarity of the battery power. The mains power supply is protected by a 4AT fuse type TR5.

  • Page 129: Appendix

    ML-x17 DATA LOGGER MANUAL 10 Appendix 10.1 Specifications Power Supply Protection Overvoltage and reverse polarity protection ( by transorp and Fuse) Input Range 3.3 ~ 5 Vdc Type of Power Battery Power Consumption * Sleep mode Operating mode Send mode 360 uW 100 uA @ 3.6 Volts 180 mW...

  • Page 130: Ce Declarations Of Conformity

    ML-x17 DATA LOGGER MANUAL 10.2 CE Declarations of Conformity Manufacturers of low power instruments page 130...

  • Page 131: Open Collector Output

    The user can choose his own voltage level, because the transistor only acts as a switch and NOT supplying any voltage. In your YDOC data logger the maximum “supply voltage” for the o.c. switch is limited to 40 volts DC.

  • Page 132: Trouble Shooting

    10.4 Trouble shooting If you encounter problems with the data logger, you can start checking the following. First try to set up a connection, via USB, and use the program, YDOC-terminal, to communicate with it. If that doesn’t work, you have to check the battery-power, so you have to open the case. Do this in a dry and clean environment, NOT in the field.

  • Page 133: System Messages

    ML-x17 DATA LOGGER MANUAL 10.5 System messages Meaning of the System messages (S-records in TXT and CSV or $Msg-lines in JSON data log files) A System message contains a message code, an optional supplemental code/text and an optional explanatory text. Please find below a list with possible System messages.
  • Page 134 ML-x17 DATA LOGGER MANUAL NETWORK_REG Error while trying to register on a (Temporarily) no network coverage, or network SIM subscription failure (inactive/invalid/blocked or black listed) APN_OPEN Error while trying to find an APN access point name wrong internet access point APN_LOGIN Error while trying to login to the APN user or password wrong, or...

Table of Contents