Introduction

Functions read_io, write_io, read_str and write_str can be used to gain access to additional features. On this section the different sources and destinations per function are listed. Then they are grouped by feature.

Sources/destinations list

“read_io” sources

“write_io” destinations

“read_str” sources

“write_str” destinations

Read/Write Input/Output channels

Sources 0 to 3 will return the value of the different Input/Output channels. Use the index to point to a particular channel address.

Example: Read analog input channel #4 (AN4) value and save it in variable c

read_io 2,c,4;

Destination 0 allows you to change the value of the digital output channels. Use the index to point to a particular channel address.

Example: Turn digital output channel 3 off (O3)

write_io 1,3,0;

Destination 2 allows you to change the value of analog input channels linked to a Modbus query. Calling write_io will force a Modbus write command.

Destination 3 will support the same values the source linked to that channels supports (physical counters or Modbus querys with 2 registers length)

Sources 23 and 36 will convert Modbus 32bit floating point queries linked to pulse channels to integer values.

Channels memory

This volatile memory area with 100 positions can be used a Source for all the I/O channels.

It can accesed using read_io/write_io 305

This allows the user to free script variables used to map data on the I/O channels.

Read direct Modbus query value

Sources 270 y 271 can be used to get the Modbus Query result (value and state) without the need of mapping it in a channel.

Source 271 will return 0 if the master is not able to get the value from the slave, or 1 if it can.

Example: Get the value from Modbus query 4 and save it in variable c

read_io 270,c,4;

Real time clock reading

Source 7 will read the current date and time of the real time clock. This number can be converted to a friendly format using the convertion functions.

Example: Get the current month and store in the variable g

read_io 7,e,0;
month g,e;

Non-volatile memory access

For numbers

The source/destination 21 will allow you to read and write numbers from and into the non-volatile memory

In devices with firmware version 5.1.1 do not invoke this function permanently, only when you need to change the value (the non-volatile memory can be damage)

Example: Read the number stored in position 15 of the non-volatile memory and store it in the variable g

read_io 21,g,15;

For strings

Sources/Destinations 121 to 125 will allow read and write up to 5 strings from/into the non-volatile memory

Example: Write the string 'hello' into the 3rd position of the strings non-volatile memory

write_str 123,'hello';

Read GSM/GPRS/MW state and MW link configuration

State read

Sources 9,10,11 and 280 can be used to read the GSM, GPRS and MW link state. Below you'll find the possible values for each one.

GSM state (GRD only)

GPRS state (GRD only)

Middleware state

Middleware link configuration

Source/Destination 22 will allow you to enable/disable the MW link configuration.

Have in mind that this setting is stored in the device's configuration and that once the device is disconnected from the MW you won't be able to configure it remotely. If you are working with the GRD you can recover the link by using SMS commands.

Stop sending historical records to the Middleware

Source/Destination 48 will allow you to disable/enable the device sending historical records to the MW.

Have in mind that this setting is stored in the device's configuration. If you want the device to send records again to the MW you must enable this feature again.

This feature is useful if you are planning to read the historical records using and alternative method.

Example: Disable the device sending historical records to the MW.

write_io 48,0,1;;

Receiving/Sending SMS. Phonebook (GRD only)

Receiving

Sources 4 and 5 can be used to receive SMS. To check if there's an incoming SMS read source 4 until the length is greater than 0.

Example: Check if there's and incoming SMS

if 1 {
     read_str 4,a,v;
     read_str 5,b,w;
};
if a!0 {
     #Incomming SMS;
};

Sending

Destinations 4 and 5 can be used to send SMS. First write the recipients phone number on destination 5. Then write the text to send on destination 4.

If you want to answer and incoming SMS you can write the text on destination 4 without writing the phone number,

Example: Send an SMS

     write_str 5,'1166041241'; #Writes the recipients phone number;
     write_str 4,'Hello'; #Writes the text and sends the SMS;

Phonebook

Sources 101 to 108 will allow you to read the names on the GRDs phonebook

Sources 111 to 118 will allow you to read the phone numbers on the GRDs phonebook

These sources are useful if you want to edit an SMS recipient without having to edit the script but editing the GRD configuration only.

Example: Read phone number #5 on the phonebook and store it in variable v

read_str 115,a,v;

Sending/Receiving messages to the Script Programmer ("Traces")

Destination 35 will allow you to send messages that will be displayed on the Script Programmer's "Trace" window (available since Script Programmer V2.0).

There is a consideration about the underscore and spaces character. The space character will be replaced by the underscore character before reading with read_str 35. The underscore character will be replaced by the space character after sending with write_str 35.

If the Script Programmer is not connected to the device the text will be lost but will not affect the script performance.

Serial port in text mode

Source/Destination 6 allows you sending and receiving strings to and from the serial port. To check if data has arrived to the serial port read source 6 until lenght is larger than 0

To send strings just write to destination 6

For this feature to work properly you must configure the serial port in "Script" mode

To send binary characters use the $ operator.

Example: Send an echo of the strings received on the serial port.

read_str 6,a,v;
if a!0 {
    write_str 6,v;
};

Serial port in binary mode

Source/Destination 37 and Source 38 allow you to get and parse binary data received at the serial port.

For this feature to work properly you must configure the serial port in "Script" mode

To send binary characters use write_str 6 and the $ operator.

Example: Wait until receiving 3 or more characters. Check if the third one is binary 126. Delete 3 bytes from the seriel port buffer.

read_io 37,a,0;
if a>2 {
    read_io 38,b,3;
    if b=126 {
        #The third byte is binary 126;
    };
    write_io 37,0,3;
};

Creating historical records

These destinations allow creating historical records from the script besides the regular historical records. The value of the record must be loaded in the value field.

Use with care to avoid generating historical records constantly.

Example: Create a "by time" record for AN2 channel every 10 seconds with the value 457

check_timer t
{
    timer t,10000;
    write_io 12,2,457;
};

Force sending reports

These destinations allow forcing sending reports from the script besides the regular reports. The reported value will be the one current value of the channel. The value field will be ignored.

Use with care to avoid generating GPRS traffic constantly (GRD only)

Example: Force a report for AN3 channel with its current value every 10 seconds

check_timer t
{
    timer t,10000;
    write_io 19,3,0;
};

Historical records memory access

These sources/destinations allow you to gain access to the historical records memory. The will be used in applications where you need to send this records using an alternative way (not using the MW).

Before reading a register you must check how many records are in the memory using read_io 8. Then you can invoke write_io 60 to read a particular register and read_io 61 to 65 to get the fields of the read register.

Finally use write_io 66 to delete the read records.

Example: Read all the records and send them to Script Programmer traces window.

read_io 8,a,0;
if a>0
{
    write_io 60,0,0; #Reads first record in memory (2nd zero points to first register);
    read_io 61,b,0; #Loads in b the channel type;
    read_io 62,c,0; #Loads in c the timestamp;
    read_io 63,d,0; #Loads in d the historical type;
    read_io 64,e,0; #Loads in e the channel type;
    read_io 65,f,0; #Loads in f the value;
    w=b,'-',b,'-',c,'-',d,'-',e,'-',f,$13,$10;
    write_str 35,w; #Sends the record to the traces window;
    write_io 66,0,1; #Deletes the first record in memory;
};

Satellite Modem

If you connect an SBD Iridium modem (EDGE/ITAS) to the GRD/cLAN serial port, you can send historical records to the MW using the Iridium satellite network. Read the device user's manual for more details.

Please check the satellite modem costs before using it.

Destination 54 initiates the device to send historical records in its memory using the satellite modem. The modem must be "ready to send" to start doing it. The GRD/cLAN will send all the records it can on a single satellite message.

Please check the satellite.sce example that you can download from here www.exemys.com/GRDscriptsExamples

FTP Client

These sources/destinations allow you to implement and FTP client to upload text files into an FTP server. You will usually use this feature to send the historical records in text format.

To send data using the FTP client the GRD must be attached to the GPRS network (GRD only)

Please check the ftp.sce example that you can download from here www.exemys.com/GRDscriptsExamples

CRC and checksums calculation

Use this destination to load the process buffer with a string

NMEA protocol

Source 51 will load the NMEA sentences previously loaded in the process buffer, adding the start/end characters and the NMEA checksum.

Use this source to implement an NMEA talker

Example: Send NMEA sentence GPMWV,145.8,R,87.2,K,A to the serial port after adding the start/end characters and the NMEA checksum.

write_str 50,'GPMWV,145.8,R,87.2,K,A';
read_str 51,a,w;
write_str 6,w;

MQTT Link state and publish (GRD-MQ and cLAN-MQ)

You can publish MQTT messages from the script

Example:

read_io 1001,h,0;

if h=1 {

   write_str 1001,'v1/devices/me/telemetry';

   write_str 1002,'{A1:52}';

};

MQTT subscription messages reception (GRD-MQ and cLAN-MQ)

You can get the messages linked to the topics subscribed using the GRD config software

It's possible to subscribe up to 10 topics.

Received messages are queued an must be read one by one.

Example:

read_io 1000,b,0; b

if b!0 {

   read_str 1003,c,y;

   read_str 1000,c,z;

};

z will hold the payload and the topic of the last message received

2025-01-23