exemys cLAN-MQ Series User Manual Download Page 57

Page: 57 / 74

Script Programming

Description

The GRD/cLAN with script programming support allows you to run user written scripts on the device,
making it more powerful and flexible.

The GRD/cLAN will continue working normally while the script is running.

Script Features

•

Math

operations

•

Logic

operations

•

Timing

functions

• Physical and Modbus channels readings
• Digital outputs control
•

SMS

sending and receiving (GRD only)

•

Serial port

data parsing

• Sending and receiving data using external

Satellite

modem (XF models only)

• Publish/subscribe

MQTT

data (MQ models only)

2020-11-20

cLAN-MQ User Manual

Scripts - Introduction

56 / 73

Summary of Contents for cLAN-MQ Series

Page 1: ...edded MODBUS master Configuration 36 Channels 39 Reports and Historical records 49 Remote Serial Port 49 Remote Serial Port over MQTT 50 Remote configuration 50 Remote configuration over MQTT 52 cLAN s Modbus Slave 56 Scripts Introduction 57 Scripts Publish Subscribe 59 Models 59 cLAN1205 MQ 61 cLAN1520 MQ 63 cLAN2205 MQ 66 cLAN3404 MQ 69 cLAN3524 MQ 71 Appendices 71 Troubleshooting 72 Serial Port...

Page 2: ...ote Access to serial port Remote serial port via MQTT broker Programmable protocol converter Serial port data using script programming Direct connection to SCADA using its Modbus TCP RTU slave Ethernet RTU Datalogger to MQTT broker There are hundreds of types of sensors that can be contacted directly to the cLAN MQ inputs to measure different types of variables Depending on the cLAN MQ model senso...

Page 3: ...dbus inputs outputs Configure the cLAN serial port Configure the Embedded Modbus master and the queries we want it to make Enable traps in case your SNMP manager can handle them Configure SNMP communities Remote serial port This procedure will allow you to send and receive data to and from the serial port RS232 RS485 using publish and subscribe For this type of solution the following procedure mus...

Page 4: ...O SI 10 1 10 1 10 1 SI External 10 to 30Vcc cLAN3404 XF 1 x RS232 SI 8 3 SI External 10 to 30Vcc cLAN3524 XF 2 x RS232 RS485 SI 16 2 8 8 8 2 SI External 10 to 30Vcc 1 The device has 10 terminals that can be configure as digital inputs or outputs All inputs can be used as pulse counters 2 Some digital inputs can be use as pulse inputs 3 Differential inputs Read the cLAN Model section to get serial ...

Page 5: ...the GRD Network yellow State of Ethernet port and IP configuration LINK green State of the connection between the cLAN and the Middleware We find below the detail of the indication of each LED independently and in combination cLAN MQ User Manual cLAN Installation 4 73 ...

Page 6: ...ial port Console Off Fast blinking Ethernet cable disconnected 90 ON 10 OFF Acquiring IP address using DHCP 10 ON 90 OFF IP address and Ethernet port are OK Titila muy rápido Connecting to the MW Encendido Connected to the MW Encendido Encendido Deleting the registers memory 2020 10 05 cLAN MQ User Manual cLAN Installation 5 73 ...

Page 7: ...een will be displayed then follow the instructions of the Installation program which will request the necessary information to complete the installation Click on Next to continue Destination folder Select the folder for the installation of the application program Wait for the installation program to copy all necessary files onto the hard disk and press Finish to end the installation process Once i...

Page 8: ...t of the Connect button and select Open Ethernet Connection If there are cLAN MQ devices connecter to your local network they will be listed showing their IP address If the device doesn t have an IP address yet it will show 0 0 0 0 If you press the config button you will be able to see edit the device network configuration If you enable DCHP and there s a DHCP server on your network these paramete...

Page 9: ...in the Advanced section on the MQTT tab Factory default is a blank password Establishing a local connection with the cLAN MQ To establish a local connection with the cLAN MQ LAN Ethernet your computer and the cLAN MQ mus be connected to the same network As described in the previous paragraph search the cLAN MQ pressing the Connect button after choosing Open Ethernet Connection and then double clic...

Page 10: ...in the parameters of the equipment you will have to press the Get Configuration button and all the cLAN MQ parameters will be displayed on the first screen the model Serial Number MAC address etc If the Configurator finds an unknown model it will not enable any of the screens Download the latest GRDconfig release from here http www exemys com GRDconfig cLAN MQ User Manual cLAN Configurator 9 73 ...

Page 11: ... to send to the cLAN MQ any change in the configuration press the Send Configuration button Monitoring To access the monitoring area where all the GRD parameters can be seen you should press the Monitor button cLAN MQ User Manual cLAN Configurator 10 73 ...

Page 12: ...een will be displayed in which we will be able to see the values of the input output channels the time quantity of accumulated Historicals the SIM in use and the states of connection of the equipment cLAN MQ User Manual cLAN Configurator 11 73 ...

Page 13: ...iding to have a duplicate To create and save a configuration we don t need to have a GRD connected only clicking in File New or on the icon a list of the models will be displayed from which we make the selection We then configure the parameters with File Save As or with the icon to load them later when the GRD is connected Once the configuration is saved we can open it and load to multiple GRDs en...

Page 14: ...2020 11 19 cLAN MQ User Manual cLAN Configurator 13 73 ...

Page 15: ...nnection with the broker When this option is enabled we tell the cLAN MQ to establish connection with the specified configuration If this option is disabled the cLAN MQ will not establish outgoing connections Host Port The IP address or URL of the server where the broker is running must be entered here The cLAN MQ can resolve URLs using DNS Unencrypted connections default port is 1883 Encrypted po...

Page 16: ...p alive message to keep the link alive in case there s no other MQTT message Certificates upload You must be connected to the cLAN to upload the certificates They are not included in the configuration After pressing the Certificates this window will pop up File format must be PEM Advanced Access password This password can be used to protect local configuration over the LAN cLAN MQ User Manual cLAN...

Page 17: ... filtered Connection Failed Host Unreachable and Connection Refused The 3 states imply that the connection to the broker was not possible but individually they indicate the reason why they occurred In general each one has a specific motive although it depends on the TCP connection on the server side for the indication to be correct even so any of the these 3 errors indicate a problem in the TCP co...

Page 18: ...master to expand the I Os Script To parse incomming data or send data from the script only on devices with script programming support Modbus Slave To use the Embedded Modbus slave to read write the device channels Physical Modbus or script Remote to access the serial remotely port using publish subscript Data output from MW transparent port It allows you to configure which serial port can be reach...

Page 19: ... 1000ms once data are received the device will wait in silence during this period before sending the packet through the network These criteria incorporate a delay in the transmission of the communication so care must be taken depending on the serial communication protocol being used End character 0 255 It is the end character of a serial stream before sending the data If the end character criteria...

Page 20: ...cal inputs and not to inputs from the Modbus queries For the configuration of the parameters you will have to enter the Inputs Outputs menu and then select the type of input output which are Digital inputs Digital outputs Analog inputs Digital inputs When we enter the configuration of a digital input we will see that we can configure 2 parameters one is the anti rebound to avoid noise and the coun...

Page 21: ... ms The counting divisor can take a value between 1 and 1000 On the cLAN2205 XF cLAN2205 MQ GRD3621 XF 3G GRD3621 MQ 3G GRD3625 XF 3G and GRD3625 MQ 3G you must configure wether a IO terminal will work as an input or as an output Take special care not to apply direct voltage to a terminal configured as an output and in ON state cLAN MQ User Manual Physical Inputs Outputs 20 73 ...

Page 22: ...Analog inputs cLAN MQ User Manual Physical Inputs Outputs 21 73 ...

Page 23: ...an select the operational mode depending on the GRD cLAN model this refers to whether we are going to measure voltage or current and its resolution The analog inputs can be configured as follows cLAN MQ User Manual Physical Inputs Outputs 22 73 ...

Page 24: ...ith 3 decimal digits 0 to 1V with 4 decimal digits 0 to 10V with 2 decimal digits 0 to 10V with 3 decimal digits Current 4 to 20mA with 2 decimal digits 4 to 20mA with 3 decimal digits Temperature PT100 GRD 3621 XF 3G and GRD 3621 MQ 3G only 199 to 849 ºC with decimal digit 2020 10 05 cLAN MQ User Manual Physical Inputs Outputs 23 73 ...

Page 25: ...t voltage 10 30 Vdc Average consumption 24 Vdc 12 Vdc 50 80 mA cLAN 3404 in XF and MQ versions Parameter Condition Minimum Maximum Units Input voltage 10 30 Vdc Average consumption 24 Vdc 12 Vdc 90 170 mA Digital inputs To activate the digital inputs a continuous voltage must be applied externally This source of power has to share the GND terminal with the power supply of the equipment If necessar...

Page 26: ...can clearly see that they must share the common Terminal Digital outputs Digital outputs are of the open collector type The load to be connected must be fed with an external power supply and they have to share the GND Terminal with the equipment power supply If necessary the same power supply used to feed the equipment can be used The output type is NPN Sourcing type Open collector cLAN 3524 in XF...

Page 27: ...feeding the relay The relay must be fed using an external power supply sharing the GND terminal with the power supply of the equipment or if necessary the same power supply feeding the cLAN can be used The following graph shows how to connect a relay to a digital output of the equipment Analog Inputs cLAN 3424 Analog inputs refer to the GND Terminal of the equipment consequently the power supply u...

Page 28: ...ersions Current inputs 4 20mA Parameter Value Units Full scale 20 mA Resolution 10 1 uA Shunt resistance 100 Ω The following two examples show the connection of a 4 20 mA sensor sharing the power supply with the equipment for passive sensors or for active sensors with independent power supply cLAN 3404 in XF and MQ versions Voltage inputs 0 10V 0 1V cLAN MQ User Manual Features of power supply and...

Page 29: ...s shown in the following figure cLAN 3404 in XF and MQ versions Current inputs 4 20mA Parameter Value Units Full scale 20 mA Resolution 10 1 uA Shunt resistance 62 Ω Analog inputs are diferential two terminals per input In this case sensors with current loop output 4 20mA can be connected to the device as shown in the following figure cLAN MQ User Manual Features of power supply and inputs outputs...

Page 30: ...2020 09 28 cLAN MQ User Manual Features of power supply and inputs outputs 29 73 ...

Page 31: ... parameters Each one of the queries can be mapped as an input output channel and be able to configure the generation of Historicals and reports In GRD Config you will find a tab called Modbus where you can configure the general characteristics of the Modbus master and Queries To use the Modbus master set the serial port in Modbus Master mode Configuration of the Modbus master Configure one serial ...

Page 32: ...Transmission mode It refers to the Modbus protocol to be used being RTU or ASCII cLAN MQ User Manual Embedded MODBUS master Configuration 31 73 ...

Page 33: ...id response before considering the value of the query as 0 while the quantity of retries is not met the master will maintain the previous value Configuration of the Modbus queries Once the master is configured we can add the desired queries entering the Modbus Queries menu and inside Modbus Inside the Modbus Queries a list will show us all the added queries and their parameters which we will be ab...

Page 34: ... will be able to configure all the parameters of the query Slave ID It is the address of the slave we wish to query Command Here we can configure the type of register to be queried INPUT REGISTER cLAN MQ User Manual Embedded MODBUS master Configuration 33 73 ...

Page 35: ...01 will get registers 40002 40001 FLOAT 32 BITS Address 40001 will get registers 40002 40001 INTEGER 64 BITS Address 40001 will get registers 40004 40001 FLOAT 64 BITS Address 40001 will get registers 40004 40001 Swapped Registers will be ordered in a diferent way in querys with register length greater than one INTEGER 32 BIT SIGNED Address 40001 will get registers 40001 40002 FLOAT 32 BITS Addres...

Page 36: ...GNED AN or PI FLOAT 32 BITS AN or PI 4 INTEGER 64 BITS FLOAT 64 BITS AN or PI Input Register 1 BIT WORD 0 to 15 I or O INTEGER AN or PI INTEGER SIGNED AN or PI 2 INTEGER 32 BITS SIGNED AN or PI FLOAT 32 BITS AN or PI 4 INTEGER 64 BITS FLOAT 64 BITS AN or PI 2020 11 20 cLAN MQ User Manual Embedded MODBUS master Configuration 35 73 ...

Page 37: ...nput PIx is a pulse input channel Beyond the most common way to link the channels like the previous example it can be done in a disordered manner or repeating them This means that you could create a channel I5 linked with the DI13 input and a channel I6 that is also linked to the DI13 input On GRD cLAN with serial port I O channels can be linked to Modbus queries if you use the embedded Modbus mas...

Page 38: ... you ll have the option to add or remove it is important to point out that within each channel only inputs and outputs compatible with that channel will appear You will now see an example of how to add a digital input channel cLAN MQ User Manual Channels 37 73 ...

Page 39: ... source called Mem is added This source is linked to a 100 position volatile memori that can be read and wrote from the script using read_io 305 and write_io 305 The signal level can be configured as analog channel source in GRD XF 2G with firmware 4 0 0 or higher This feature is available in all GRD 3G 2020 10 29 cLAN MQ User Manual Channels 38 73 ...

Page 40: ... GRD MQ and are sent to the broker If there is no connection the registers remain in the equipment until they are recovered Topics and formats to publish reports and historical records are configured on the MQTT tab Historicals and reports are configured on the channels Reports and historical records topics and formats You can configure a different topic format for reports for each channel type Th...

Page 41: ...4 A1 893 A2 41 A3 312 A4 1933 Historical record for analog input channel 2 at Feb21 2020 08 02 20pm with value 41 ts 1582315320000 values A2HT 41 Digital output channel 2 with value 1 Historical record for digital output channel 2 at Feb21 2020 08 05 34pm with value 1 ts 1582315534000 values O2HC 1 Reports We will now see the types of reports and how to configure them The reports are configured in...

Page 42: ... Report by time It defines the time in minutes which determines how often a report message is generated Let s suppose that we are interested in updating an input channel every five minutes independently of the changes that occur the only thing we need to do is to enable the report by time and configure in 5 minutes this will force the report message that will update the input value in the broker e...

Page 43: ... a configured absolute value Report by time It defines a time in minutes which determines how often a report message is generated Digital outputs channels reports In this case we only count on a temporary report the change report is always enabled this means that when a change occurs in one of the outputs it will be immediately reported The purpose of having the change report permanently enabled i...

Page 44: ...s channel by counts or by time Report by time It defines time in minutes which determines how often a report message is generated Historical records Historicals allow the device to store the events as changes in inputs or outputs being either on line or off line and then transmit them to the broker for further visualization and analysis These Historicals will let you know the value and number of a...

Page 45: ...re shows the screen to enable these Historicals Analog input channels historical records Just as in digital inputs it is possible to keep a Historical of analog inputs under two clearly defined criteria On one side we have an alarm type register of Historicals that allows monitoring the limits of tensions with a determined value of hysteresis On the other side we can create a register of Historica...

Page 46: ...tween both a Historical by normal value is generated In this manner we can follow the evolution of the input when it fluctuates between the specified limits In addition to the maximums and minimums a value of hysteresis must be defined to avoid continuous generation of Historicals when the analog signal oscillates above a threshold value In the following figure we can see how the hysteresis mechan...

Page 47: ...the register time is due when this happens a Historical is generated with the maximum value measured in this period Minimum Historical by time This Historical is similar to the maximum but only registers the minimum value in the time period Average Historical by time The concept is the same as in the previous ones but in this case it calculates an average of the value of the channel in the time pe...

Page 48: ...own in the following figure We can also decide if once the Historical is generated we want the counter reset to 0 or not Delete Historicals In the need of erasing Historical registers this can be done by means of the GRD Config in the monitor window with the Delete button located next to the indicator of stored Historicals cLAN MQ User Manual Reports and Historical records 47 73 ...

Page 49: ... is connected It is important to disable the Windows option Automatic time change according to daylight savings time In case of being in a region with no daylight savings time change the time zone and in an area with daylight savings time change the time zone to a region with it and disable it then return to your time zone 2020 11 20 cLAN MQ User Manual Reports and Historical records 48 73 ...

Page 50: ...ics and the format the payload will have Payload format b Binary data as received No data is filtered nor codified s Non printable ASCII values are filtered out ASCII 32 and ASCII 126 h String HEX ASCII Note If the serial port is configured in script mode publish subscribed data can still be access using read_str 25 and write_str 25 from the script 2020 11 20 cLAN MQ User Manual Remote Serial Port...

Page 51: ...the topic as explained later Configuration topic Identifying the device The device will add the ClientID to the base configuration topic Example Subscribe grdconfig enlace 1 clientID Publish grdconfig enlace 0 clientID Configuring the GRDconfig for remote MQTT configuration You must configure the broker access and the base configuration topic Go to Software Configuration MQTT Connection This base ...

Page 52: ... to configure Once the link is established use the Monitor Get Configuration and Send Configuration buttons MQTT connection parameters and GPRS on GRD can t be modified remotely 2020 11 19 cLAN MQ User Manual Remote configuration over MQTT 51 73 ...

Page 53: ...ice s channels One slave can be configured in one serial port Modbus RTU or Modbus ASCII The other one in it s Etherner port Modbus TCP Serial Modbus slave configuration To use the serial port Modbus slave configure one serial port in Modbus Slave mode Then go to the Modbus tab and select Modbus Slave cLAN MQ User Manual cLAN s Modbus Slave 52 73 ...

Page 54: ...Here you can configure the following paramaters Serial mode It refers to the Modbus protocol to be used being RTU or ASCII cLAN MQ User Manual cLAN s Modbus Slave 53 73 ...

Page 55: ...e second register Ethernet Modbus Modbus TCP slave configuration The Modbus TCP is always enabled The cLAN will answer the Modbus TCP queries on port 502 It can support up to four simultaneous connections Go to the Modbus tab and select Modbus Slave Here you can configure the following paramaters Slave ID The cLAN will answer when it receives a Modbus query to this Modbus slave ID Exceptions If en...

Page 56: ...s cLAN Channel Format 10001 10100 I1 a I100 Bit 00001 00100 O1 a O100 Bit 40001 40200 AN1 a AN100 32 Bits integer 40201 40400 PI1 a PI100 32 Bits integer Example On a cLAN 3524 XF or MQ with the default configuration the physical I Os are mapped like this Start Address End Address cLAN Channel 10001 10016 I1 a I16 00001 00008 O1 a O8 40001 40016 AN1 a AN8 40201 40216 PI1 a PI8 2020 10 05 cLAN MQ U...

Page 57: ...g normally while the script is running Script Features Math operations Logic operations Timing functions Physical and Modbus channels readings Digital outputs control SMS sending and receiving GRD only Serial port data parsing Sending and receiving data using external Satellite modem XF models only Publish subscribe MQTT data MQ models only 2020 11 20 cLAN MQ User Manual Scripts Introduction 56 73...

Page 58: ...be read To get the first message in the queue use read_str 1000 read_str 1000 c z z message text Script Publish You public message straight from the script code Go to the script programming manual for more information Before publishing it s suggest it to check if the broker connection is established read_io 1001 h 0 h 1 connection established Then set the topic to publish write_str 1001 v1 devices...

Page 59: ...2020 11 20 cLAN MQ User Manual Scripts Publish Subscribe 58 73 ...

Page 60: ... client Monitoring from SCADA Remote access to serial port Telemetry Controller Local Modbus I O control using the script programming feature Direct connection with SCADA using its Modbus RTU and Modbus TCP slaves Server link Ethernet Local network or using the Internet Satellital with external satellite modem XF model only Wiring Wiring Power supply Wiring RS232 port RS485 port The RS232 port is ...

Page 61: ...he RS485 RS422 is avaiable on 4 terminals Tb y Tb Rb y Rb To use it in RS485 mode put together Tb with Rb and Tb with Rb as shown in the following diagram 2020 09 28 cLAN MQ User Manual cLAN1205 MQ 60 73 ...

Page 62: ...ls using script programming Operating modes XF model Monitoring by WEB page Database Ethernet datalogger MQ model MQTT client Monitoring from SCADA Remote access to serial port Telemetry Controller Local Modbus I O control using the script programming feature Direct connection with SCADA using its Modbus RTU and Modbus TCP slaves Server link Ethernet Local network or using the Internet Satellital ...

Page 63: ...ts connections The RS485 port is of the 2 wire type TR and TR and has a terminal board for its connections There s no need to configure whether you are going to use the port RS232 or RS485 Just connect the wires to the corresponding terminals 2020 09 28 cLAN MQ User Manual cLAN1520 MQ 62 73 ...

Page 64: ...Embedded Modbus slave Other protocols using script programming Operating modes XF model Monitoring by WEB page Database Ethernet datalogger MQ model MQTT client Monitoring from SCADA Remote access to serial port Telemetry Controller Local I O control using the script programming feature Direct connection with SCADA using its Modbus RTU and Modbus TCP slaves Server link Ethernet Local network or us...

Page 65: ...re type TR and TR and has a terminal board for its connections The RS485 RS422 is avaiable on 4 terminals Tb y Tb Rb y Rb To use it in RS485 mode put together Tb with Rb and Tb with Rb as shown in the following diagram Wiring Inputs Outputs cLAN MQ User Manual cLAN2205 MQ 64 73 ...

Page 66: ...2020 09 28 cLAN MQ User Manual cLAN2205 MQ 65 73 ...

Page 67: ...using script programming Operating modes XF model Monitoring by WEB page Database Ethernet datalogger MQ model MQTT client Monitoring from SCADA Remote access to serial port Telemetry Controller Local I O control using the script programming feature Direct connection with SCADA using its Modbus RTU and Modbus TCP slaves Server link Ethernet Local network or using the Internet Satellital with exter...

Page 68: ...be connected to the device as shown in the following image Current input wiring 4 20mA In this case sensors with current loop output 4 20mA can be connected to the device as shown in the following image The input impedance value of each track is 62Ω cLAN MQ User Manual cLAN3404 MQ 67 73 ...

Page 69: ...2020 09 28 cLAN MQ User Manual cLAN3404 MQ 68 73 ...

Page 70: ...EB page Database Ethernet datalogger MQ model MQTT client Monitoring from SCADA Remote access to serial port Telemetry Controller Local I O control using the script programming feature Direct connection with SCADA using its Modbus RTU and Modbus TCP slaves Server link Ethernet Local network or using the Internet Satellital with external satellite modem XF model only Wiring Wiring Power supply Wiri...

Page 71: ...w indicate the terminal board for the connection of inputs and outputs of the cLAN In this model it is not necessary to open the cLAN con switch between current and voltage inputs 2020 09 28 cLAN MQ User Manual cLAN3524 MQ 70 73 ...

Page 72: ...s attempting to connect are the correct ones That there is no reason why the server is rejecting the connection request ex That is requesting identification or authentication A connection is established and then it closes Verify that there is no reason why the server is rejecting the connection request ex That is requesting identification or authentication The connection is established but the com...

Page 73: ... to use Exemys terminal software that you can download from this link http www exemys com console RS232 cable pin out Entering command mode Open the terminal software and select the correct COM port Check the baud rate is configured at 9600 bps Power the device and press the CFG button until you see a welcome message You must do it within the first 7 seconds after powering the device on Welcome to...

Page 74: ...he RS232 cable must be assembled like this cLAN terminal block DB9 H connector TXa 2 TXa 3 DGND 5 Changing the password example To set to set the password to exemys you must this on the console PASSWORD exemys You will receive a message acknowledging the command Then type END to finish 2017 12 12 cLAN MQ User Manual Serial Port Console Blank Password 73 73 ...

Search results

Summary of Contents for cLAN-MQ Series

Reviews:

Related manuals for cLAN-MQ Series

Brands by name

Popular brands

exemys cLAN-MQ Series, User Manual

Search results

Summary of Contents for cLAN-MQ Series

Reviews:

Related manuals for cLAN-MQ Series

Brands by name

Popular brands