DEVICE MODBUS

The MODBUS^® protocol represents an industrial communication system distributed and developed by Gould-Modicon to integrate PLC’s, computers, terminals, inverter and other devices. MODBUS is a Master/Slave communication protocol where only one device can be Master and monitors all activities of the serial line or TCPIP. As for the serial line can be connected up to a maximum of 247 slave along the same lines. Each device is assigned an address that distinguishes it from all other connected devices.
The MODBUS device lets you choose which serial port use for connection. The features s of data transmission (number of device, baud rate, parity, stop bits) and the transmission mode must be selected on each station and cannot be changed during the operation.
With using a serial line, there are two modes of transmission used in the Modbus Protocol. Both ways allow the same communication skills. The mode is selected by the master and must be unique for all devices connected to the network. The modes are:

• ASCII (American Standard Code for Information Interchange)
• RTU, (Remote Terminal Unit.)

This manual is divided into two parts:
Part I - Operation as master
Part II - Operation as slave.

The modbus communication protocol standard defines 4 types of Exchange data:

• INPUT STATUS = Digital Inputs
• COIL STATUS = UDigital Outputs
• INPUT REGISTER = Analog Inputs
• HOLDING REGISTER. = Analog Outputs

Throughout the manual you have to take into account existing conventions.

Declaration of the used device (internal device): device name assigned, MODBUS, slot location and number of the device.

INTDEVICE
...
<device_name>      MODBUS    TCamp    channel
...

Where:

To declare the hardware used in the “BUS” section of the configuration unit you will have to refer to the firmware of the hardware itself.

Example

INTDEVICE
modbus             MODBUS     0002    1

NOTE 1: the “ iword1 ” is the most significant word of the “ ilong1 ” (long = double word), the “iword3” is the most significant word of the “ ilong2 ”, …
NOTE 2: the “ st_ibit0 ” parameter less significant bit (with weight 0) of the “ iword1 ”, while the “ st_ibit15 ” bit is the most significant (with weight 15) of the “ iword1 ”.

NOTE 1: the “ oword1 ” is the most significant word of the “ olong1 ” (long = double word), the “oword3” is the most significant word of the “ olong2 ”, …
NOTE 2: the “ st_obit0 ” parameter is the less significant bit (with weight 0) of the “ oword1 ”, while the “ st_obit15 ” bit is the most significant (with weight 15) of the “ oword1 ”.

The MODBUS device can use a serial port or TCPIP to communicate in master mode (parameter mode = 0). Allows (via parameters, states and commands) all instruments to be able to communicate with any equipment utilizing Modbus.
The device provides a data exchange area where the QCL can write or read values shared with the slaves on the network. This area is represented by a list of parameters of the device divided into two groups to differentiate the type of access of the data by the device. The first section is identified as INPUT the second as OUTPUT. The INPUT section, for master operation, is the storage area of reads data. It is used by all reader functions (parameter type = 1, 2, 3 o 4). The OUTPUT section, in the master operation, is the area of data storage that the master should transfer to the slaves. It is used by all writing functions (parameter type = 5, 6, 15 o 16). To facilitate the exchange of data between devices, the structure of the Exchange area includes data types commonly used in QCL namely WORD, LONG and FLAG. The “BYTE” type does not appear because the modbus usually uses the word size for each address registers. The modbus protocol selects data based on the number of access log register, while the QCL selects based on the parameter symbol, you create a reference table in which each QCL symbol find the corresponding number in the register of access in Modbus protocol. To obtain greater flexibility for addressing, the same area of Exchange data can be manipulated by the QCL with different dimension parameterized. All the symbols that appear in the same row of the table refer to the same memory locations.

The data input or coil type have in the modbus Protocol a bit size. To store this information in the table of data exchange is defined as follows mode: each register (and then every word parameter of the device) represents 16 elements that are numbered from left to right. For the Scriptures or multiple readings when bits read are higher than those contained in the register the operation continues in the next register.
The st_ibit0… and st_obit1… states are useful in order to facilitate access to information bit, only in the first table log.

The master mode is set with the mode parameter = 0. The card generates modbus messages only on QCL ordering and does not automatically. To “format” the modbus message string there are a number of parameters.
Using the two commands SEND or SENDSYC you send the read or write request to the slave, a number of States allow an audit on the operation being executed. We see in detail:

type = request type that you want to process (reading or writing word or bit).
idcard = address of the slave drive to which you want to send the request.
addr = the index from which to start reading or at which to start writing in the slave.
tabreg = for read operations (type = 1, 2, 3, 4), This parameter indicates the position in the “table of data read” where will store the read data on the slave. For write operations (type = 5, 6, 15, 16), this parameter indicates the position in the “table of data to be written” where is the data to be written on the slave. Are accepted values are between 1 and 512 for values of type parameter = 1, 2, 5, 15 (writing and reading of bits), while for type value = 3, 4, 6, 16 (writing and reading of word) the expected values are between 1 and 32.
num = number of values that are read or write (if the request type so provides). Are accepted values are between 1 and 128 for values of type parameter = 1, 2, (reading of bits), while for type value = 3, 4, 16 (multiple word reading and writing) the accepted value are between 1 and 32.

SEND sends the request message to the slave.
SENDSYC sends the request message to a QEM slave of MODBUS type and reports the operation concluded (st_sended) only when the slave executes the RECEIVED command.

When ended the message send operation, the status st_sended variable is set to 1. If you used the SEND command the state is set to 1 when the master receive the confirmation of the message being sent. If you have used the SENDSYC command in the master then this status will be set to 1 when the slave QEM will execute the RECEIVED command. In case of error, This status is still in set to 1 (After the toutsyc time) but the err parameter indicates the cause of the error (see the description of this parameter for details).
The SENDSYC coomand it becomes necessary when you want to synchronize master data packet writing by reading the same data from the slave (can be used when both master and slave are Qmove).

Bit read function. You want to read the bits of a slave (idcard). Sets the parameter type = 1.
You must set addr to indicate the address of the bit in the slave from which to start reading. The num parameter indicates the number of bits that are read. You must to set tabreg to indicate the index of the bit in the “data read table” the master from which you want to be written the read bits. The raedings value will be saved in the “data read table”. It is recommended to always meet the following two conditions:
(addr + num - 1) ⇐ 512 e (tabreg + num - 1) ⇐ 512 otherwise the request will fail (reporting by wcmd).

Bit read function. To read the bits of a slave (idcard). The function is equal to the “Read Coil”. Sets the parameter type = 2.
The meaning of the two functions is distinguished at the level of MODBUS protocol. Some slave can make available different memory areas depending if the bits are Coil or Input. In the case of slave Qmove the two requests have the same effect.

Word read function. For reading the word of the slave (idcard). Sets the parameter type = 3.
You must to set addr to indicate the address of the word in the slave from which to start reading. The num parameter indicates the number of word to be read. You must set tabreg to indicate the index of the word in the “read data table” of the master from which you want are writes the read words. The read values will be saved in the “read data table”. It is recommended to always meet the following two conditions:
(addr + num - 1) ⇐ 32 e (tabreg + num - 1) ⇐ 32 otherwise the request will fail (reporting by wcmd).

Word read function. For reading the bit of the slave (idcard). The function is equal to the “Read Holding Register”. sets the parameter type = 4.
The meaning of the two functions is distinguished at the level of MODBUS protocol. Some slave can make available different memory areas depending if the read word are Holding or Input. In the case of slave Qmove the two requests have the same effect.

Bit write function. For writing (force) the bit of the slave (idcard). Sets the parameter type = 5.
You must set addr to indicate the address of the bit in the slave that you want to write. You must set tabreg to indicate the index of the bit in the “write data table” that contains the value to be written.

Word write function. For write (force) the word of a slave (idcard). Sets the parameter type = 6.
You must set addr to indicate the address of the word in the slave that you intend to write. You must set tabreg to indicate the index of the word in the “data write table” that contains the value to be written.

Multiples bit write function. For write (force) the bit of a slave (idcard). Sets the parameter type = 15.
You must set addr to indicate the address of the bit in the slave that you intend to write. You must set in num the number of bits to write. You must set tabreg to indicate the bit index of the “data write table” from which to begin the values to be written. It is recommended to always meet the following two conditions:
(addr + num - 1) ⇐ 512 e (tabreg + num - 1) ⇐ 512 otherwise the request will fail (reporting by wcmd).

Multiples word write function. For write (forzare) the word of a slave (idcard). Sets the parameter type = 16.
You must set addr to indicate the address of the word in the slave that you intend to write. You must set in num the number of word to write. You must set tabreg to indicate the index of the word in the “write data table” da cui iniziano i valori da scrivere. Si raccomanda di soddisfare sempre le seguenti due condizioni:
(addr + num - 1) ⇐ 32 e (tabreg + num - 1) ⇐ 32 altrimenti la richiesta non potrà essere eseguita (segnalazione mediante wcmd).

1) Impostazioni modbus e apertura del canale di comunicazione di tipo seriale

modbus.mode = 0                             ; modbus master
modbus.prot = 1                             ; RTU
modbus.brate = 57600                        ; baudrate
modbus.stopb = 1                            ; stop bits
modbus.par = 0                              ; parity
modbus.tout = 100                           ; timeout
 
modbus.OPENCOM
tm_opencom = 200                            ; timeout for OPENCOM command
WAIT modbus.st_opencom OR tm_opencom
IF NOT modbus.st_opencom
    OpenComError = 1                        ; com not opened
ENDIF

2) Impostazioni modbus e apertura del canale di comunicazione di tipo TCPIP

modbus.mode = 0                             ; modbus master
modbus.prot = 2                             ; TCPIP
modbus.tout = 100                           ; timeout
 
tcpip_port= 502                             ; number of tcpip port (default 502)
modbus.stopb = (tcpip_port ANDB &H0000FF00) / 256
modbus.par = tcpip_port ANDB &H000000FF
 
modbus.OPENCOM
tm_opencom = 500                            ; waiting time to have a correct response
WAIT tm_opencom
IF NOT modbus.st_opencom
    OpenComError = 1                        ; com not opened
ENDIF

3) Lettura del registro input nr.7 dello slave id 67

modbus.idcard = 67
modbus.addr = 7
modbus.tabreg = 7
modbus.num = 1
modbus.type = 4
modbus.SEND
WAIT modbus.st_sended
IF (modbus.err)
    CALL ErroreModbus
ENDIF
slVelocita = modbus.iword7

4) Lettura dei holding register dal nr.600 al nr.606 dello slave id 8
Siccome l’area di scambio dati QCL non supporta l’indirizzo 600, si utilizza il parametro tabreg per salvare i dati letti all’indirizzo 10

modbus.idcard = 8
modbus.addr = 600
modbus.num = 6
modbus.tabreg = 10
modbus.type = 3
modbus.SEND
WAIT modbus.st_sended
IF (modbus.err)
    CALL ErroreModbus
ENDIF
 
swTemp1 = modbus.iword10
slVelocita = modbus.ilong6
slPosiz = modbus.ilong7
swTemp1 = modbus.iword15

Il Broadcast è un messaggio speciale che viene inviato dal Master e viene ricevuto contemporaneamente da tutti gli slave connessi. La funzionalitá broadcast (idcard = 0) è supportata solamente in modo master e se viene usato un messaggio con type = 5, 6, 15 e 16 (solo scrittura). In questa modalità lo stato st_sended viene attivato appena terminata la trasmissione e non alla ricezione della conferma dallo slave. Infatti non esiste nessuna risposta degli slave per questo tipo di messaggi. Non è possibile utilizzare il comando SENDSYC.

La scheda quando funziona in modalità Master permette, con un speciale comando, di riconoscere se lo slave collegato è di tipo QEM. In caso affermativo determina anche il modello di slave connesso. Questo permette di realizzare una diagnostica sulla corretta configurazione della rete. Non è possibile estendere questo controllo a tutti i tipi di slave esistenti perché il protocollo non prevede una modalità standard di riconoscimento slave.
Il comando READSTYPE eseguito dopo aver opportunamente selezionato lo slave (tramite parametro idcard) invia allo slave una richiesta modbus nr.17 per il riconoscimento. Lo slave risponderà con un suo valore predefinito e potrà essere letto nel parametro stype del master. Nel caso lo slave non sia prodotto da QEM srl, il parametro avrà valore –1 ad indicare che lo slave è connesso ma non è possibile identificarlo.
Per il device MODBUS lo slave ID è diverso a seconda dello slave QEM utilizzato. Per una codifica degli slave in questo senso vedere il manuale Firmware dello slave utilizzato.

Esempio d'identificazione dello slave nr.12:

modbus:idcard = 12
modbus.READSTYPE
WAIT modbus.st_sended
IF (modbus.err)
    sbConfig = 3             ; error: slave 12 not connected
ELSE
    IF (modbus.stype EQ 1)   ; Board CAM-AG-98
        sbConfig = 1         ; configuration OK
    ELSE
        sbConfig = 2         ; error in network configuration
    ENDIF
ENDIF

Il protocollo di comunicazione modbus standard definisce 4 tipi di dati di scambio:

• INPUT STATUS,
• COIL STATUS,
• INPUT REGISTER,
• HOLDING REGISTER.

Questi 4 tipi trattano i segnali tipo Digital Inputs, Digital Outputs, Analog Inputs, and Analog Outputs. I valori dei registri (sia INPUT REGISTERS che HOLDING REGISTERS), sono definiti come valori a 16 bit, ognuno con un unico indirizzo, (esempio INPUT REGISTER #1, INPUT REGISTER #2, INPUT REGISTER #3, ecc.).
Per permettere di suppportare tipi di dato di dimensione maggiore di 16 bit, è stata progettata una estensione al protocollo per trattare valori di dimensione long 32 bit. L’implementazione di questa funzionalitá mantiene la formattazione del messaggio standard modbus e utilizza il contenuto di due indirizzi consecutivi per rappresentare un valore 32 bit. Quando questa estensione è attiva (wider = 1), a seconda dell’indirizzo utilizzato lo slave risponderà con un valore a 16 bit o 32 bit per ogni richiesta di registro. Se l’indirizzo è superiore a 5000 verrà risposto con valore a 32 bit, se inferiore il protocollo rimane invariato con risposta a 16 bit.

Il nome del parametro, stato o comando viene riportato alla sinistra della tabella.

R
Indica se il relativo parametro o stato è ritentivo (al momento dell’inizializzazione del device mantiene lo stato precedentemente definito), oppure lo stato che assume al momento dell’inizializzazione del device.
Se il device non necessita di inizializzazione il campo “R” indica il valore che il parametro o stato assume all’accensione della scheda.
R = Ritentivo
0 = Al momento dell’inizializzazione del device il valore viene forzato a zero.
1 = Al momento dell’inizializzazione del device il valore viene forzato a uno.
- = Al momento dell’inizializzazione del device viene presentato il valore significativo.

D
Indica la dimensione del parametro.
F = Flag
B = Byte
W = Word
L = Long
S = Single Float

Vengono descritte tutte le condizioni necessarie affinché il parametro sia considerato corretto o perché il comando venga accettato.
In alcuni casi vengono specificati dei valori limite per l’accettazione del parametro: se vengono introdotti dei valori esterni ai limiti impostati, il dato viene comunque accettato; pertanto devono essere previsti opportuni controlli dell’applicativo tali da garantire il corretto funzionamento.
Per l’esecuzione di un comando, tutte le relative condizioni devono necessariamente essere soddisfatte; in caso contrario il comando non viene eseguito.

A
Indica la modalità di accesso.
R = Read (lettura).
W = Write (scrittura).
RW = Read / Write.

La possibilità di comunicare con il protocollo TCPIP è stata sviluppata in un tempo successivo rispetto alla nascita del device MODBUS. Per questo modivo l'impostazione della porta e dell'indirizzo IP viene eseguita mediante alcuni parametri che hanno un significato diverso.

Per configurare il numero della porta TCPIP è necessario andare a scrivere sui parametri stopb e par. Rispettivamente :

• stopb = tcpip_port / &H00000100
• par = tcpip_port ANDB &H000000FF

Per impostare lo slave TCPIP a cui si vuole eseguire la richiesta è necessario andare a scrivere sul parametro brate.
Un indirizzo IP può essere espresso come TcpAddr3.TcpAddr2.TcpAddr1.TcpAddr0 (per esempio 192.168.0.1).

• brate = (TcpAddr3 * &H01000000) + (TcpAddr2 * &H00010000) + (TcpAddr1 * &H00000100) + TcpAddr0

I comandi a disposizione per gestire il device sono elencati sotto in ordine di priorità decrescente.
Il device esegue tutti i comandi ricevuti entro lo stesso tempo di campionamento iniziando da quello con la priorità maggiore.
Per esempio se il device riceve nello stesso tempo di campionamento i comandi CLOSECOM e OPENCOM, per primo esegue il comando OPENCOM e poi quello di CLOSECOM lasciando perciò la porta di comunicazione chiusa.

La modalità slave viene impostata con il parametro mode = 1 o mode = 2. Bisogna introdurre nei parametri il codice dell’ID slave tramite il parametro idcard.

Impostazioni modbus e apertura del canale di comunicazione di tipo seriale

modbus.mode = 1                             ; modbus slave
modbus.prot = 1                             ; RTU
modbus.brate = 57600                        ; baudrate
modbus.stopb = 1                            ; stop bits
modbus.par = 0                              ; parity
modbus.idcard = 1                           ; slave id
 
modbus.OPENCOM
tm_opencom = 100                            ; timeout for OPENCOM command
WAIT modbus.st_opencom OR tm_opencom
IF NOT modbus.st_opencom
    OpenComError = 1                        ; com not opened
ENDIF

Impostazioni modbus e apertura del canale di comunicazione di tipo TCPIP

modbus.mode = 1                             ; modbus slave
modbus.prot = 2                             ; TCPIP
 
tcpip_port= 502                             ; number of tcpip port (default 502)
modbus.stopb = (tcpip_port ANDB &H0000FF00) / 256
modbus.par = tcpip_port ANDB &H000000FF
 
modbus.OPENCOM
tm_opencom = 100                            ; waiting time to have a correct response
WAIT (modbus.st_opencom OR timerOpencom)
IF NOT modbus.st_opencom
    OpenComError = 1                        ; com not opened
ENDIF

Le operazioni che spettano all’applicativo QCL sono essenzialmente due:

• aggiornare i parametri tipo owordNN, olongNN (che verranno poi letti dal master)
• processare i parametri tipo iwordNN, ilongNN (che sono stati scritti dal master)

Per aggiornare i parametri tipo owordNN il QCL deve scrivere i valori nei parametri quindi inviare il comando VALIDATE. L’utilizzo del comando si rende necessario per rendere disponibili alle letture del master i nuovi dati nello stesso istante, evitando così che possano venire letti solamente parte dei parametri aggiornati. Quindi l’assegnazione di un valore ad un parametro device NON SIGNIFICA che esso sia immediatamente disponibile per le letture del master. Sarà disponibile solamente dopo il comando VALIDATE.

Esempio

modbus.olong1 = anpos.speed
modbus.oword1 = npezzi
modbus.oword2 = npezzitot
modbus.oword3 = anpos.dir
modbus.olong2 = anpos.posit
modbus.VALIDATE

Per processare i parametri tipo iwordNN, invece, il QCL deve attendere che lo stato st_msgrx venga attivato. Questo significa che un messaggio di scrittura è stato inviato dal master. Per i messaggi di lettura nessun segnale viene riferito ai parametri QCL. Il QCL poi deve prelevare i valori dall’area scambio dati e al termine deve inviare il comando RECEIVED, solo allora lo stato st_msgrx viene disattivato.

Esempio

WAIT modbus.st_msgrx
anpos.speed = modbus.ilong1
anpos:posit = modbus.ilong2
npezzi = modbus.iword1
RECEIVED modbus

Naturalmente non esiste nessun controllo per evitare che durante la lettura dei parametri iwordNN il master erroneamente esegua un’altra scrittura, prima che il codice del progetto presente nello slave finisca il processo.
Inoltre il codice per la manipolazione del device modbus nell’applicativo è consigliato che sia raccolto in un unico task in modo da non creare accessi contemporanei ai device che potrebbero generare delle condizioni non valide in ogni singolo contesto.

Tutte le richieste di lettura che arrivano dal master MODBUS fanno riferimento ai dati di tipo owordNN accedendo quindi alla stessa area dati. Lo slave mette a disposizione i valori che il master leggerà nei parametri di tipo owordNN.
Tutte le richieste di scrittura che arrivano dal master MODBUS fanno riferimento ai dati di tipo iwordNN accedendo quindi alla stessa area dati. Lo slave mette a disposizione i parametri iwordNN dove il master potrà scrivere i dati.

Il nome del parametro, stato o comando è riportato alla sinistra della tabella.

R
Indica se il relativo parametro o stato è ritentivo (al momento dell’inizializzazione del device mantiene lo stato precedentemente definito), oppure lo stato che assume al momento dell’inizializzazione del device.
Se il device non necessita di inizializzazione il campo “R” indica il valore che il parametro o stato assume all’accensione della scheda.
R = Ritentivo
0 = Al momento dell’inizializzazione del device il valore è forzato a zero.
1 = Al momento dell’inizializzazione del device il valore è forzato ad uno.
- = Al momento dell’inizializzazione del device è presentato il valore significativo.

D
Indica la dimensione del parametro.
F = Flag
B = Byte
W = Word
L = Long
S = Single Float

Sono descritte tutte le condizioni necessarie affinché il parametro sia considerato corretto o perché il comando venga accettato.
In alcuni casi sono specificati dei valori limite per l’accettazione del parametro: se sono introdotti dei valori esterni ai limiti impostati, il dato è comunque accettato; pertanto devono essere previsti opportuni controlli dell’applicativo tali da garantire il corretto funzionamento.
Per l’esecuzione di un comando, tutte le relative condizioni devono necessariamente essere soddisfatte; in caso contrario il comando non è eseguito.

A
Indica la modalità d'accesso.
R = Read (lettura).
W = Write (scrittura).
RW = Read / Write.

I comandi a disposizione per gestire il device sono elencati sotto in ordine di priorità decrescente.
Il device esegue tutti i comandi ricevuti entro lo stesso tempo di campionamento iniziando da quello con la priorità maggiore.
Per esempio se il device riceve nello stesso tempo di campionamento i comandi CLOSECOM e OPENCOM, per primo esegue il comando OPENCOM e poi quello di CLOSECOM lasciando perciò la porta di comunicazione chiusa.

Il primo aspetto da tenere presente per la migrazione è il fatto che il device MODBUS01 è esterno mentre il MODBUS è interno. Questo implica che la dichiarazione del device deve essere eseguita nella sezione “INTDEVICE” dell’unità di configurazione del progetto. Inoltre, questo comporta la scelta, durante la definizione del device MODBUS, del tempo di campionamento. Il valore del tempo di campionamento che mantiene inalterate le prestazioni della comunicazione tra i due device è pari a 5 ms. Bisogna inoltre, in fase di definizione, selezionare la seriale da impegnare.
Il device MODBUS ha aumentato il numero di variabili di scambio (da 16 word a 32 word) ma questo non influenza il funzionamento per le impostazioni che utilizzano al massimo 16 word come sono quelle pensate per il device MODBUS01.
Il device MODBUS ha limitato la variabile “num” a 128, mentre per il device MODBUS01 il limite è 256. Questo si è reso necessario per permettere un’ottimizzazione del tempo di campionamento. La scelta è stata presa in considerazione del fatto che tali valori venivano impiegati unicamente per la gestione dei Coils, ma che perdeva di logica la lettura/scrittura di più di 128 coils consecutivi.
Il device MODBUS consente di controllare (mediante 2 nuovi comandi) l'impegno della seriale di comunicazione da parte del device. Questa nuova funzionalitá è interessante nell'eventualità che in un progetto Qview siano stati dichiarati altri devices che possono utilizzare la stessa seriale.
Se un applicativo era stato scritto per il device MODBUS01 bisogna aggiungere il comando OPENCOM (eseguito anche solo una volta) come mostrato nel seguente esempio.

; impostazione dei parametri di comunicazione
modbus.mode = 0
modbus.brate = 38400
...
modbus.OPENCOM
WAIT modbus.st_opencom
 
modbus.idcard = 8
modbus.addr = 600
modbus.num = 6
modbus.tabreg = 10
modbus.type = 3
modbus.SEND
WAIT modbus.st_sended
IF (modbus.err)
    CALL ErroreModbus
ENDIF