| Both sides previous revision Previous revision Next revision | Previous revision |
| en:software:devices:modbus [2016/12/23 16:51] – [6.1.1. Aggiornamento dei parametri tipo owordNN] qem103 | en:software:devices:modbus [2020/07/13 14:58] (current) – qem103 |
|---|
| ====== DEVICE MODBUS ====== | ====== DEVICE MODBUS ====== |
| ===== - Introduction ===== | ====== - Introduction ====== |
| |
| The MODBUS<sup>®</sup> 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<sup>®</sup> 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.\\ |
| </code> | </code> |
| |
| === - Processo dei parametri tipo iwordNN === | === - Process iwordNN parameters type === |
| 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** | To process the iwordNN parameters type, instead,the QCL must wait for the st_msgrx state is activated. This means that a write message was sent by the master. For the read message no signal reportedly to QCL parameters. The QCL then must take the values from the data exchange and at the end needs to send the RECEIVED command, only then the st_msgrx state is disabled. |
| | |
| | **Example** |
| <code QCL> | <code QCL> |
| WAIT modbus.st_msgrx | WAIT modbus.st_msgrx |
| RECEIVED modbus | RECEIVED modbus |
| </code> | </code> |
| 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 | There is no control to prevent when reading //iwordNN// parameters the master incorrectly execute another writing, before the project code present in the slave to finish the process.\\ |
| alla stessa area dati. Lo slave mette a disposizione i valori che il master leggerà nei parametri di tipo //owordNN//.\\ | Also the code for handling the modbus device in the application it is recommended that it is collected in a single task in order not to create simultaneous accesses to the device that could generate invalid conditions. |
| 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. | All read requests that arrive from the master MODBUS refer to the //owordNN// type data by accessing to the same data area. The slave provides the values that the master will read in the //owordNN// parameters type.\\ |
| ==== - Schema a blocchi ==== | All write requests arriving from the MODBUS master refer to the //iwordNN// type data aby accessing to the same data area. The slave provides the //iwordNN// parameters where the master will write data. |
| | ==== - Block diagram ==== |
| {{:software:devices:modbus:modbus_02.png?nolink400|}} | {{:software:devices:modbus:modbus_02.png?nolink400|}} |
| |
| ==== - Comandi e parametri ==== | ==== - Commands and parameters ==== |
| |
| === - Simbologia adottata === | === - Used symbols === |
| |
| Il nome del parametro, stato o comando è riportato alla sinistra della tabella. | The parameter name, condition or command is shown at the left of the table. |
| |
| **R**\\ | **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.\\ | Indicates if the parameter or state is retentive (upon initialization of the device maintains the previously defined state), or the state assumes upon initialization of the device.\\ |
| Se il device non necessita di inizializzazione il campo “R” indica il valore che il parametro o stato assume all’accensione della scheda.\\ | If the device does not need to initialize the “R” field indicates the value that the parameter or accept to the power up of the card.\\ |
| R = Ritentivo\\ | R = Retentive\\ |
| 0 = Al momento dell’inizializzazione del device il valore è forzato a zero.\\ | 0 = Upon initialization of the device the value is forced to zero.\\ |
| 1 = Al momento dell’inizializzazione del device il valore è forzato ad uno.\\ | 1 = Upon initialization of the device the value is forced to one.\\ |
| - = Al momento dell’inizializzazione del device è presentato il valore significativo. | - = Upon initialization of the device is presented significant value. |
| |
| **D**\\ | **D**\\ |
| Indica la dimensione del parametro.\\ | Indicates the size of the parameter.\\ |
| F = Flag\\ | F = Flag\\ |
| B = Byte\\ | B = Byte\\ |
| S = Single Float\\ | S = Single Float\\ |
| |
| == Condizioni == | == Conditions == |
| 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. | Describes all the conditions necessary so that the parameter is considered correct or because the command is accepted.\\ |
| | In some cases, limit values are specified for the acceptance of the parameter: if there are any values outside the limits set, the data is however accepted; therefore appropriate controls of the application must be provided to ensure the proper functioning.\\ To execute a command, all conditions must be met; otherwise the command is not executed. |
| |
| **A**\\ | **A**\\ |
| Indica la modalità d'accesso.\\ | Indicates the access mode.\\ |
| R = Read (lettura).\\ | R = Read.\\ |
| W = Write (scrittura).\\ | W = Write.\\ |
| RW = Read / Write. | RW = Read / Write. |
| |
| === - Parametri === | === - Parameters === |
| ^ Nome ^ D ^ R ^ A ^ Condizioni ^ Descrizione ^ | |
| | mode | B | R | R/W | - | **Mode**\\ (0 ÷ 2)\\ Definisce se la scheda deve funzionare come master o come slave.\\ **1** = slave con area di scambio dati fissa;\\ **2** = slave senza area di scambio dati fissa: ad ogni scrittura o lettura eseguita dal master viene messi a 1 il flag st_msgrx.\\ Contemporaneamente i parametri //type//, //addr// e //num// indicano le caratteristiche del messaggio ricevuto.\\ - **Type** indica il tipo di funzione che vuole fare ill master (lettura o scrittura),\\ - **addr** indica l'indirizzo dell'inizio del blocco di dati scritti o letti,\\ - **num** indica il numero di dati letti o scritti (a bit o a byte a seconda del valore di type).\\ Il device controllerà, in ricezione, solamente num (size di messaggio) che non sia superiore a 32word ma non più l'indirizzo che può essere ora qualsiasi.\\ Se è una scrittura (lo si capisce dal valore di type se è 5,6,15,16) vengono riportati i dati nelle variabili di scambio input (sempre a partire dalla prima word) ed il device attende il comando RECEIVED.\\ Se è una lettura il device attende che il QCL depositi i dati nelle word variabili di scambio output ed attende il comando VALIDATE. | | ^ Name ^ D ^ R ^ A ^ Conditions ^ Description ^ |
| | prot | B | R | R/W | - | **Protocol**\\ Definisce il tipo di protocollo Modbus da utilizzare.\\ **0** = ASCII,\\ **1** = RTU,\\ **2** = TCPIP. | | | mode | B | R | R/W | - | **Mode**\\ (0 ÷ 2)\\ Defines if the board should function as a master or slave.\\ **1** = slave with fixed data exchange area;\\ **2** = slave without fixed data exchange area: any writing or reading done by the master is put to 1 the st_msgrx flag.\\ At the same time the //type//, //addr// and //num// parameters indicate the features of the received message.\\ - **Type** indicates the type of function that wants to be the master (read or write),\\ - **addr** indicates the address of the beginning of the written or read data block,\\ - **num** indicates the read or written number of data (to bit or to byte depending on the value of type).\\ The device will check, in reception, only num (size of message) that does not exceed 32wordbut not the address that can now be any.\\ If it is a write (You can tell by the value of the type if it is 5,6,15,16) are shows the lists the data in variables of exchange input (always starting from the first word) and the device waits for the RECEIVED command.\\ If you read the device waits for the QCL stores data in word output exchange variables and waits for the VALIDATE command. | |
| | wider | B | R | R/W | - | **Wide Registers**\\ Indica se utilizzare l’estensione del protocollo per i registri a 32bit. Vedere capitolo “Estensione del protocollo”.\\ **0** = normale,\\ **1** = protocollo esteso. | | | prot | B | R | R/W | - | **Protocol**\\ Defines the type of Modbus Protocol to use.\\ **0** = ASCII,\\ **1** = RTU,\\ **2** = TCPIP. | |
| | idcard | W | R | R/W | - | **Identification Card**\\ ( 1 ÷ 255 per slave)\\ Nel funzionamento come slave è il numero che identifica l’apparecchio nella rete. | | | wider | B | R | R/W | - | **Wide Registers**\\ Indicates if to use the 32-bit registers protocol extension. See “Extension of the Protocol” section.\\ **0** = normal,\\ **1** = extended protocol. | |
| | brate | L | R | R/W | - | **Baud rate**\\ Baud rate della seriale.\\ Valori validi: 4800, 9600, 19200, 38400, 57600, 115200. | | | idcard | W | R | R/W | - | **Identification Card**\\ ( 1 ÷ 255 for slave)\\ In slave mode is the number that identifies the device on the network. | |
| | stopb | B | R | R/W | - | **Stop bit**\\ Valori validi: 1, 2. | | | brate | L | R | R/W | - | **Baud rate**\\ Baud rate of the serial.\\ Valid values: 4800, 9600, 19200, 38400, 57600, 115200. | |
| | | stopb | B | R | R/W | - | **Stop bit**\\ Valid values: 1, 2. | |
| | par | B | R | R/W | - | **Parity**\\ (0 ÷ 2)\\ **0** = none,\\ **1** = even,\\ **2** = odd. | | | par | B | R | R/W | - | **Parity**\\ (0 ÷ 2)\\ **0** = none,\\ **1** = even,\\ **2** = odd. | |
| | rdelay | W | R | R/W | - | **Reply delay**\\ (0 ÷ 9999 msec)\\ E' il tempo di attesa prima di trasmettere la risposta. | | | rdelay | W | R | R/W | - | **Reply delay**\\ (0 ÷ 9999 msec)\\ It is the time to wait before transmitting the reply. | |
| | iword1÷32 | W | 0 | R | - | **Input Word nr.** (1Input Long nr. (1÷16)32) | | | iword1÷32 | W | 0 | R | - | **Input Word nr.** (1Input Long nr. (1÷16)32) | |
| | st_ibit0÷15 | F | 0 | R | - | **Input bit nel parametro iword1** | | | st_ibit0÷15 | F | 0 | R | - | **Input bit in the iword1 parameter** | |
| | ilong1÷16 | L | 0 | R | - | **Input Long nr.** (1÷16) | | | ilong1÷16 | L | 0 | R | - | **Input Long nr.** (1÷16) | |
| | oword1÷32 | W | 0 | R/W | - | **Output Word nr.** (1÷32) | | | oword1÷32 | W | 0 | R/W | - | **Output Word nr.** (1÷32) | |
| | st_obit0÷15 | F | 0 | R/W | - | **Output bit nel parametro oword1** | | | st_obit0÷15 | F | 0 | R/W | - | **Output bit in the oword1 parameter** | |
| | olong1÷16 | L | 0 | R/W | - | **Output Long nr.** (1÷16) | | | olong1÷16 | L | 0 | R/W | - | **Output Long nr.** (1÷16) | |
| |
| |
| |
| === - Variabili === | === - Variables === |
| ^Nome^D^R^A^Condizioni^ Descrizione^ | |
| |serr|B|0|R/W|-|**Serial Errors**\\ Indica se sono stati riscontrati errori nella comunicazione seriale.\\ Il parametro viene aggiornato ad ogni errore rilevato. Il valore permane fino ad un successivo errore o ad una scrittura sullo stesso con il QCL.\\ **0** = nessun errore,\\ **1** = parity error,\\ **2** = framing error,\\ **3** = overrun error.| | |
| |
| === - Stati === | ^Name^D^R^A^Conditions^Description^ |
| ^Nome^D^R^A^Condizioni^ Descrizione^ | |serr|B|0|R/W|-|**Serial Errors**\\ Indicates if errors occurred in serial communication.\\ The parameter is updated for each error encountered. The value persists until a subsequent error or to a writing on the same with the QCL.\\ **0** = no errors,\\ **1** = parity error,\\ **2** = framing error,\\ **3** = overrun error.| |
| |st_msgrx|F|0|R||-|**Message received**\\ Stato utilizzato solo in modalitá slave. Indica che un messagio del master ha eseguito una scrittura nell’area scambio dati QCL. Lo stato viene resettato con il comando RECEIVED.| | |
| |st_opencom|F|0|R|-|**Open communication port**\\ L'attivazione indica che il device sta impegnando la porta di comunicazione seriale. Per settare questo stato usare il comando OPENCOM, per resettarlo CLOSECOM.| | |
| |wdata|F|0|R|-|**Warning Data**\\ Questo bit segnala che è stato tentato un inserimento di un valore non valido in un parametro.| | |
| |wcmd|F|0|R|-|**Warning Command**\\ Questo bit segnala che è non è stato eseguito un comando perchè mancano le condizioni necessarie.| | |
| |
| === - Comandi === | === - States === |
| 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.\\ | ^Name^D^R^A^Conditions^Description^ |
| 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. | |st_msgrx|F|0|R|-|**Message received**\\ State used only in slave mode. Indicates that a message from the master has executed a write in the QCL data exchange area. The state is reset with the RECEIVED command.| |
| ^ Nome ^ D ^ R ^ A ^ Condizioni ^ Descrizione ^ | |st_opencom|F|0|R|-|**Open communication port**\\ Activation indicates that the device is working with the serial communications port. To set this state use the OPENCOM command, for reset use CLOSECOM.| |
| | RECEIVED | - | - | - | st_msgrx = 1\\ mode = 1, 2\\ st_opencom = 1 | **Received**\\ Utilizzato solamente in modalitá slave. Indica che l’applicativo QCL ha processato le informazioni che il master ha inviato | | |wdata|F|0|R|-|**Warning Data**\\ This bit indicates that an attempt was made to insert an invalid value in a parameter.| |
| | VALIDATE | - | - | - | mode = 1, 2\\ st_opencom = 1 | **Validate**\\ Indica che i parametri di scambio dati QCL diventano disponibili al master. | | |wcmd|F|0|R|-|**Warning Command**\\ This bit indicates that it did not execute a command because they lack the necessary conditions.| |
| | CLRWDATA | - | - | - | - | **Clear Warning Data**\\ Azzera la segnalazione del parametro wdata | | |
| | CLRWCMD | - | - | - | - | **Clear Warning Command**\\ Azzera la segnalazione del parametro wcmd | | === - Commands === |
| | OPENCOM | - | - | - | st_opencom = 0 | **Open Serial communication**\\ Apre la comunicazione seriale (il device quindi impegna la porta di comunicazione). Lo stato //st_opencom// diventa 1. | | |
| | CLOSECOM | - | - | - | - | **Close Serial communication**\\ Chiude la comunicazione seriale (il device quindi non impegna piú la porta di comunicazione). Lo stato //st_opencom// diventa 0. | | The available commands to manage the device are listed below in descending order of priority.\\ |
| | The device executes all commands received within the same sampling time starting from the one with the highest priority.\\ |
| | For example if the device receives the same sampling time CLOSECOM and OPENCOM commands, first run the OPENCOM command and than to CLOSECOM leaving therefore the communication port closed. |
| | |
| | ^ Name ^ D ^ R ^ A ^ Conditions ^ Description ^ |
| | | RECEIVED | - | - | - | st_msgrx = 1\\ mode = 1, 2\\ st_opencom = 1 | **Received**\\ Used only in slave mode. Indicates that the QCL application has processed the information that the master has sent | |
| | | VALIDATE | - | - | - | mode = 1, 2\\ st_opencom = 1 | **Validate**\\ Indicates that the parameters of the QCL data exchange becomes available to the master. | |
| | | CLRWDATA | - | - | - | - | **Clear Warning Data**\\ Reset the wdata parameter reporting | |
| | | CLRWCMD | - | - | - | - | **Clear Warning Command**\\ Reset the wcmd parameter reporting | |
| | | OPENCOM | - | - | - | st_opencom = 0 | **Open Serial communication**\\ Open the serial communication (the device then committed the communications port). The //st_opencom// state changes to 1. | |
| | | CLOSECOM | - | - | - | - | **Close Serial communication**\\ Closes the serial communication (the device then does not commit more the communications port). The //st_opencom// state changes to 0. | |
| |
| |
| |
| ===== - Migrazione dal device MODBUS01 al device MODBUS ===== | ===== - Migration from MODBUS01 device to MODBUS device ===== |
| |
| Il primo aspetto da tenere presente per la migrazione è il fatto che il device MODBUS01 è esterno mentre il MODBUS è | The first thing to note for migration is the fact that the MODBUS01 device is external, while the MODBUS is internal. This implies that the device declaration must be done in “INTDEVICE” section in the configuration unit of the project. In addition, this entails choosing, when defining the MODBUS device, of the sampling time. The value of the sample time that keeps the performance of communication between the two devices is 5 ms. Being defined, you must select the serial port to be committed.\\ |
| interno. Questo implica che la dichiarazione del device deve essere eseguita nella sezione “INTDEVICE” dell’unità di | The MODBUS device increased the number of exchange variables (from 16 word to 32 word) but this does not affect the operation for settings that use the maximum 16 word How are those designed for the MODBUS01 device.\\ |
| configurazione del progetto. Inoltre, questo comporta la scelta, durante la definizione del device MODBUS, del tempo di | The MODBUS device has restricted the “num” variable to 128, while the MODBUS01 device the limit is 256. This was necessary to allow an optimization of sampling time. The decision was taken in view of the fact that those values were used only for Coils managing, but that was logic leaking more than read/write 128 consecutive coils.\\ |
| campionamento. Il valore del tempo di campionamento che mantiene inalterate le prestazioni della comunicazione tra i | The MODBUS device allows you to control (using 2 new commands) communication serial's commitment on the part of the device. This new functionality is interesting in the event that other devices have been declared in a project Qview that can use the same serial.\\ |
| due device è pari a 5 ms. Bisogna inoltre, in fase di definizione, selezionare la seriale da impegnare.\\ | If an application was written for the MODBUS01 device you must add the OPENCOM command (executed only once) as shown in the following example. |
| 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. | |
| |
| ==== Esempio: ==== | ==== Example: ==== |
| |
| <code QCL> | <code QCL> |
| ; impostazione dei parametri di comunicazione | ; setting communication parameters |
| modbus.mode = 0 | modbus.mode = 0 |
| modbus.brate = 38400 | modbus.brate = 38400 |
| WAIT modbus.st_sended | WAIT modbus.st_sended |
| IF (modbus.err) | IF (modbus.err) |
| CALL ErroreModbus | CALL ErrorModbus |
| ENDIF | ENDIF |
| </code> | </code> |
| |
| |