Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision Next revisionBoth sides next revision | ||
en:software:devices:modbus [2016/12/22 16:28] – [5.9. Estensione del protocollo] qem103 | en:software:devices:modbus [2016/12/23 17:05] – [6.3. Comandi e parametri] qem103 | ||
---|---|---|---|
Line 320: | Line 320: | ||
To allow support for datatypes larger than 16 bit, has been designed an extension to the protocol to treat long 32 bit dimension values. Implementing this feature preserves the formatting of the message standard modbus it uses the contents of two consecutive addresses to represent a 32 bit value. When this extension is enabled (wider = 1), depending on the address used the slave responds with a 16-bit or 32-bit value for each log request. If the address is greater than 5000 will be returned a 32-bit value, if under the Protocol remains unchanged with response to 16 bits. | To allow support for datatypes larger than 16 bit, has been designed an extension to the protocol to treat long 32 bit dimension values. Implementing this feature preserves the formatting of the message standard modbus it uses the contents of two consecutive addresses to represent a 32 bit value. When this extension is enabled (wider = 1), depending on the address used the slave responds with a 16-bit or 32-bit value for each log request. If the address is greater than 5000 will be returned a 32-bit value, if under the Protocol remains unchanged with response to 16 bits. | ||
- | ==== - Comandi e parametri | + | ==== - Commands and parameters |
- | === - Simbologia adottata | + | === - Used symbols |
- | Il nome del parametro, stato o comando viene riportato alla sinistra della tabella. | + | |
+ | The parameter name, condition or command is taken back to the left side of the table. | ||
**R**\\ | **R**\\ | ||
- | Indica se il relativo parametro o stato è ritentivo | + | Indicates if the parameter or state is retentive |
- | Se il device | + | If the device |
- | R = Ritentivo\\ | + | R = Retentive\\ |
- | 0 = Al momento dell’inizializzazione del device | + | 0 = Upon initialization of the device |
- | 1 = Al momento dell’inizializzazione del device | + | 1 = Upon initialization of the device |
- | - = Al momento dell’inizializzazione del device | + | - = Upon initialization of the device |
**D**\\ | **D**\\ | ||
- | Indica la dimensione del parametro.\\ | + | Indicates the size of the parameter.\\ |
F = Flag\\ | F = Flag\\ | ||
B = Byte\\ | B = Byte\\ | ||
Line 341: | Line 342: | ||
S = Single Float | S = Single Float | ||
- | == Condizioni | + | == Conditions |
- | 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 | + | Describes all the conditions necessary for the parameter so that the parameter is considered correct or because the command is accepted.\\ |
- | ai limiti impostati, il dato viene comunque accettato; pertanto devono essere previsti opportuni controlli dell’applicativo tali | + | In some cases, limit values are specified for the acceptance of the parameter: if any values outside the limits set are introduced, the data is however accepted; therefore appropriate controls of the application must be provided to ensure the proper functioning.\\ |
- | da garantire il corretto funzionamento.\\ | + | To execute a command, all conditions must be met; otherwise the command does not execute. |
- | Per l’esecuzione di un comando, tutte le relative condizioni devono necessariamente essere soddisfatte; in caso contrario | + | |
- | il comando non viene eseguito. | + | |
**A**\\ | **A**\\ | ||
- | Indica la modalità di 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 | + | |
- | | mode | B | R | R/W | - | **Mode**\\ (0 ÷ 2)\\ Definisce se la scheda deve funzionare come master | + | ^ Name ^ D ^ R ^ A ^ Conditions |
- | | prot | B | R | R/W | - | **Protocol**\\ (0 ÷ 1)\\ 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 |
- | | wider | B | R | R/W | - | **Wide Registers**\\ (0 ÷ 1)\\ Indica se utilizzare l’estensione del protocollo per i registri a 32bit. Vedere capitolo | + | | prot | B | R | R/W | - | **Protocol**\\ (0 ÷ 1)\\ Defines the type of modbus protocol to use.\\ **0** = ASCII,\\ **1** = RTU,\\ **2** = TCPIP | |
- | | idcard | + | | wider | B | R | R/W | - | **Wide Registers**\\ (0 ÷ 1)\\ Indicates if to use the 32-bit registers protocol extension. See the “Extension of the Protocol” section |
- | | type | B | 1 | R/W | - | **Type**\\ | + | | idcard |
- | | addr | L | 1 | R/W | - | **Address**\\ (1 ÷ 65535)\\ | + | | type | B | 1 | R/W | - | **Type**\\ |
- | | tabreg | + | | addr | L | 1 | R/W | - | **Address**\\ (1 ÷ 65535)\\ |
- | | num | W | 1 | R/W | - | **Number**\\ (1 ÷ 512)\\ | + | | tabreg |
- | | brate | L | R | R/W | - | **Baud rate**\\ Baud rate della seriale.\\ Valori validi: 4800, 9600, 19200, 38400, 57600, 115200. | + | | num | W | 1 | R/W | - | **Number**\\ (1 ÷ 512)\\ |
- | | stopb | B | R | R/W | - | **Stop bit**\\ | + | | brate | L | R | R/W | - | **Baud rate**\\ |
- | | par | B | R | R/W | - | **Parity**\\ (0 ÷ 2)\\ **0** = none (nessuna),\\ **1** = odd (dispari),\\ **2** = even (pari). | | + | | stopb | B | R | R/W | - | **Stop bit**\\ |
- | | tout | W | R | R/W | - | **Timeout**\\ (0 ÷ 9999 msec)\\ | + | | par | B | R | R/W | - | **Parity**\\ (0 ÷ 2)\\ **0** = none,\\ **1** = odd,\\ **2** = even. | |
- | | toutsyc | + | | tout | W | R | R/W | - | **Timeout**\\ (0 ÷ 9999 msec)\\ |
+ | | toutsyc | ||
| iword1÷32 | | iword1÷32 | ||
- | | st_ibit0÷15 | + | | st_ibit0÷15 |
| ilong1÷16 | | ilong1÷16 | ||
| oword1÷32 | | oword1÷32 | ||
- | | st_obit0÷15 | + | | st_obit0÷15 |
| olong1÷16 | | olong1÷16 | ||
- | La possibilità di comunicare con il protocollo | + | The ability to communicate with the TCPIP protocol It was developed at a later time than the birth of the MODBUS |
- | Per configurare il numero della porta TCPIP è necessario andare a scrivere sui parametri | + | To configure the TCPIP port number You must go and write about the // |
* **stopb** = tcpip_port / & | * **stopb** = tcpip_port / & | ||
* **par** = tcpip_port ANDB & | * **par** = tcpip_port ANDB & | ||
- | Per impostare lo slave TCPIP a cui si vuole eseguire la richiesta è necessario andare a scrivere sul parametro | + | To set the TCPIP slave to which you want to execute the request you must go to write on the// |
- | Un indirizzo | + | An IP address can be expressed as TcpAddr3.TcpAddr2.TcpAddr1.TcpAddr0 (for example |
* **brate** = (TcpAddr3 * & | * **brate** = (TcpAddr3 * & | ||
- | === - Variabili | + | === - Variables |
- | ^ Nome ^ D ^ R ^ A ^ Condizioni | + | |
- | | err | B | 0 | R | - | **Errors**\\ Indica se sono stati riscontrati errori nel protocollo.\\ In modalità master il parametro viene aggiornato in coincidenza dell’attivazione dello stato // | + | |
- | | 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;\\ - alla scrittura di uno dei seguenti parametri: mode, prot, wider, brate, stopb, par;\\ - ad una scrittura sullo stesso (qualsiasi valore lo azzera).\\ **0** = nessun errore,\\ **1** = parity error,\\ **2** = framing error,\\ **3** = overrun error. | + | |
- | | stype | W | 0 | R | - | **Slave type**\\ Indica il tipo di slave connesso. Il parametro viene aggiornato quando il parametro // | + | |
+ | ^ Name ^ D ^ R ^ A ^ Conditions | ||
+ | | err | B | 0 | R | - | **Errors**\\ Indicates if errors occurred in the protocol.\\ In master mode the parameter is updated to coincide the activation of the // | ||
+ | | 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:\\ - under a subsequent error;\\ - the writing of one of the following parameters: mode, prot, wider, brate, stopb, par;\\ - writing about himself (any value will reset).\\ **0** = no errors,\\ **1** = parity error,\\ **2** = framing error,\\ **3** = overrun error. | ||
+ | | stype | W | 0 | R | - | **Slave type**\\ Indicates the type of slave connected. The parameter is updated when the // | ||
- | === - Stati === | ||
- | ^Nome^D^R^A^Condizioni^Descrizione^ | ||
- | |st_sended|F|0|R|-|**Sended**\\ Stato utilizzato solo in modalità master. L’attivazione indica il completamento della trasmissione di un messaggio. Lo stato viene resettato con i comandi SEND o SENDSYC.| | ||
- | |st_opencom|F|0|R|-|**Open communication port**\\ L' | ||
- | |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.\\ | + | |
- | 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. | + | |
- | ^Nome^D^R^A^Condizioni^Descrizione^ | + | ^Name^D^R^A^Conditions^Description^ |
- | |SEND|-|-|-|mode = 0\\ 0 < num <= 128\\ st_sended = 1\\ st_opencom = 1|**Sended**\\ Determina la trasmissione del messaggio verso lo slave selezionato.| | + | |st_sended|F|0|R|-|**Sended**\\ State only been used in master |
- | |SENDSYC|-|-|-|mode = 0\\ 0 < num <= 128\\ st_sended = 1\\ st_opencom = 1|**Send synchronize**\\ Utilizzabile solo in modo master | + | |st_opencom|F|0|R|-|**Open communication port**\\ Activation indicates that the device is working the serial communications port. To set this state use the OPENCOM command, to reset CLOSECOM.| |
- | |READSTYPE|-|-|-|mode = 0\\ st_sended = 1\\ st_opencom = 1|**Read slave type**\\ Richiesta lettura informazione type sullo slave specificato in idcard. La risposta verrá segnalata sul parametro stype quando lo stato st_sended diventa 1.| | + | |wdata|F|0|R|-|**Warning Data**\\ |
- | |CLRWDATA|-|-|-|-|**Clear Warning Data**\\ | + | |wcmd|F|0|R|-|**Warning Command**\\ |
- | |CLRWCMD|-|-|-|-|**Clear Warning Command**\\ | + | |
- | |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.| | + | |
+ | === - Commands === | ||
- | ===== - Descrizione funzionamento come slave ===== | + | The available commands to manage the device are listed below in descending order of priority.\\ |
- | ==== - Modo di funzionamento SLAVE ==== | + | 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 then to CLOSECOM leaving therefore the communication port closed. | ||
- | La modalità slave viene impostata con il parametro | + | ^Name^D^R^A^Conditions^Description^ |
+ | |SEND|-|-|-|mode = 0\\ 0 < num <= 128\\ st_sended | ||
+ | |SENDSYC|-|-|-|mode = 0\\ 0 < num <= 128\\ st_sended = 1\\ st_opencom = 1|**Send synchronize**\\ Usable only in master mode determines the message transmission towards a slave QEM with synchronisation.| | ||
+ | |READSTYPE|-|-|-|mode = 0\\ st_sended = 1\\ st_opencom = 1|**Read | ||
+ | |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 status becomes 1.| | ||
+ | |CLOSECOM|-|-|-|-|**Close Serial communication**\\ Close the serial communication (the device then does not committted the communications port ). The st_opencom status becomes 0.| | ||
- | **Impostazioni modbus e apertura del canale di comunicazione di tipo seriale** | + | |
+ | ===== - Slave operation description ===== | ||
+ | ==== - Slave mode operation ==== | ||
+ | |||
+ | Slave mode is set with the mode = 1 or mode = 2 parameter. You must to introduce in the parameters the slave ID code through the idcard parameter. | ||
+ | |||
+ | **Modbus settings and opening channel of serial communication** | ||
<code QCL> | <code QCL> | ||
modbus.mode = 1 ; modbus slave | modbus.mode = 1 ; modbus slave | ||
Line 437: | Line 440: | ||
ENDIF | ENDIF | ||
</ | </ | ||
- | **Impostazioni modbus e apertura del canale di comunicazione di tipo TCPIP** | + | **Modbus settings and open of the communication channel of TCPIP type** |
<code QCL> | <code QCL> | ||
modbus.mode = 1 ; modbus slave | modbus.mode = 1 ; modbus slave | ||
Line 454: | Line 457: | ||
</ | </ | ||
- | Le operazioni che spettano all’applicativo | + | The operations that should execute the QCL are essentially two: |
- | * aggiornare i parametri tipo owordNN, olongNN (che verranno poi letti dal master) | + | * update the parameters |
- | * processare i parametri tipo iwordNN, ilongNN (che sono stati scritti dal master) | + | * process the parameters |
- | === - Aggiornamento dei parametri tipo owordNN === | + | === - Updating |
- | 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** | + | To update the owordNN parameters type the QCL must write values in the parameters then send the VALIDATE command. The use of the command is necessary to make available on the readings of the master the new data at the same time, so that they can be read only part of updated parameters. So assigning a value to a device parameter DOES NOT MEAN that it is immediately available for the master readings. Will only be available after the VALIDATE command. |
+ | |||
+ | **Example** | ||
<code QCL> | <code QCL> | ||
modbus.olong1 = anpos.speed | modbus.olong1 = anpos.speed | ||
Line 474: | Line 474: | ||
</ | </ | ||
- | === - Processo dei parametri tipo iwordNN === | + | === - Process |
- | 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 | ||
Line 488: | Line 486: | ||
RECEIVED modbus | 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 | + | 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 | + | 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 | + | |
- | alla stessa | + | All read requests that arrive from the master MODBUS |
- | ==== - Schema a blocchi | + | All write requests arriving from the MODBUS |
+ | ==== - Block diagram | ||
{{: | {{: | ||
- | ==== - Comandi e parametri | + | ==== - Commands and parameters |
=== - Simbologia adottata === | === - Simbologia adottata === |