RGAM Communication protocol description I 94 GB Date: March 10, 1999

Transcription

1 RGAM Communication protocol description I 94 GB Date: March 10, 1999 General features: Master-slave protocol, where usually the master is a Personal Computer or a device capable of communication and data processing (intelligent terminal). Multidrop configuration. Up to 32 stations can share the same communication line. Half- duplex communication with standard two-wire RS-485 interface. RGAM..RC units have a built-in RS-485 interface, while the master is usually connected by means of a RS-232 to RS-485 converter with automatic control of the transmission line. Transmission format is: 9600 bps, 8 data bit, no parity, 1 stop bit. ASCII mnemonic-code messages. Possibility to connect a couple of modems between the master and the RS232 / RS485 converter. Windows-based Remote control software available. Message structure: Every message has a frame with the following structure. ( AA CC O DDD...DDD &CK ) CR LF where: ( ASCII 28H character. Indicates the begin of the message. AA Address. Two-digit number that selects the address of the RGAM to which the message has to be sent ( when transmitted by the master) or that identifies the provenience of the message (when transmitted by the slave). CC Op-code. Two ASCII chars that identify the meaning of the message. O Operator. Action that has to be connected to the previous op-code. It can be? for a request, = for a write action (transmitted by the master) or for an answer (transmitted by the slave), : for confirm,! for forcing. Not all the opcodes can support all the operands. DD..DDD Data to be transmitted. Length varies depending upon the op-code and operand. Data can sometimes be separated by commas or by =. & ASCII 26H character. Indicates the end of data and the begin of message checksum (optional). CK Checksum. Two ASCII chars, indicating the Low significant byte of the algebraic sum of the single bytes transmitted, starting from AA up to the last D before &. Checksum transmission is optional. ) ASCII 29H character. Indicates ASCII message end. CR Carriage return 0DH. Added to the end of the message. LF Line Feed 0AH. Added to the end of the message. Master: (01MV?)CRLF The master asks 3-ph mains voltage value to RGAM station 01 (01MV=00400=00399=00401)CRLF RGAM answers 400, 399 and 401V Master: (01MV?&43)CRLF Same as above, using checksum (01MV=00400=00399=00401&A9)CRLF RGAM answers using checksum. Codice documento: I94GB03_99.DOC Pagina nr. 1 di 10

2 Mnemonic op-code table: Op-code Operand Operand Description (master side) (slave side) ID? = Identification request ST? = General status request ER? = Error status request MV? = Mains voltage value (3-phase) request GV? = Generator voltage value request FR? = Generator frequency request BV? = Battery voltage request HR? = Engine total working time request (Hours - minutes) MN? = Time-to-maintenance request AV? = Battery charger alternator voltage request IO? = Digital Input / Output status request PS? = Front panel status request AT?, = =, : Automatic test request/forcing OF! : OFF mode forcing MA! : MAN mode forcing AU! : AUT mode forcing TE! : TEST mode forcing KO! : OFF key pressing simulation KM! : MAN key pressing simulation KA! : AUT key pressing simulation KT! : TEST key pressing simulation KR! : SELECT-RESET key pressing simulation KS! : START key pressing simulation KP! : STOP key pressing simulation KN! : MAINS key pressing simulation KG! : GEN key pressing simulation MR! : Maintenance interval reset RB! : System reboot SB?,= =, : Base setup values request / writing SA?,= =, : Advanced setup values request / writing SI?,= =, : Programmable inputs setup values request / writing ET? = Event timer and pointer EL?,= =,: Event log data Codice documento: I94GB03_99.DOC Pagina nr. 2 di 10

3 ID Identification request The ID code is useful to ask to the RGAM the type and version of software and hardware. The slave answers with project code, denomination, firmware version, date, program memory checksum and board nominal power supply voltage. Master: (01ID?)CRLF (01ID=LOVATO 5B1 RGAM REV.02 DATE: CKS: V)CRLF ST - General status request Useful to ask general status information to the RGAM. The presence of a determinate condition is evidenced by an alpha-char, while the absence of that condition is evidenced by a.. The answer is a 9-char data string. Each character of that string has the following meaning: Char Description position 1 O If system is in OFF mode M in MAN mode A in AUT mode T in TEST mode 2 R If the engine is running. If not 3 A If the alarm delay (oil + temp) has elapsed. if alarms are not yet enabled 4 M If mains voltage is present (inside limits). if not 5 G If generator voltage is present (inside limits). if not 6 M if mains contactor is closed. if open 7 G if generator contactor is closed. if open 8 E if there are live alarms. no alarms 9 T Automatic test is enabled. disabled Master: (01ST?)CRLF (01ST=A.. M. M..T )CRLF The message indicates that RGAM station 01 status is: AUT mode, engine stopped, alarms disabled, mains voltage ok, generator voltage not present, mains contactor closed, generator contactor opened, no live alarms present, automatic test enabled. ER Error status request By means of this op-code it is possible to ask to RGAM if there are alarms present. In this case, their code will be answered. If there is no alarm present, 000 will be transmitted. Master: (01ER?)CRLF (01ER=001=013 )CRLF Two alarms present: A01 Oil pressure and A13 Emergency stop Master: (01ER?)CRLF (01ER=000)CRLF No alarms present. Codice documento: I94GB03_99.DOC Pagina nr. 3 di 10

4 MV Mains voltage request With this code the master can ask the instantaneous value of the three-phase mains voltage. The measures are expressed in Volt (RMS) each one in a five-digit decimal value. Master: (02MV?)CRLF (02MV=00381=00385=00383)CRLF GV Generator voltage request Returns the generator voltage value. Master: (02GV?)CRLF (02GV=00400)CRLF FR Generator frequency request Returns the generator frequency value, expressed in Hz/10. Master: (01FR?)CRLF (01FR=00502)CRLF The generator frequency is 50.2 Hz BV Battery voltage request Returns the last battery voltage, expressed in Volts/10. We remind that there are two types of RGAM, with 12V and 24V nominal battery supply. Master: (02BV?)CRLF (02BV=00142)CRLF The battery voltage of station 02 is 14.2VDC HR Engine working time counter Returns the hours and minutes of the engine working time counter. This counter is kept even without battery supply. The answer format has 3 digits for hours and two digits for minutes. Master: (03HR?)CRLF (03HR=02535)CRLF Station 03 engine working time counter is 25h35min MN Time-to-maintenance request Returns the minutes left before maintenance interval request. Master: (01MN?)CRLF (01MN=00186)CRLF There are 3h 06min left before maintenance AV - Battery charger alternator voltage request Returns the last value of the voltage applied to the battery charger input, expressed in V/10. Master: (01AV?)CRLF (01AV=00142)CRLF The battery charger alternator voltage is 14.2V Codice documento: I94GB03_99.DOC Pagina nr. 4 di 10

5 IO Input / Output status request Returns a 15-character string. Each character represents the status of one I/O line of the RGAM, as shown in the following table: Char Description position 1 O Oil pressure input active 2 T High temperature input active 3 F Fuel level input active 4 S Emergency stop input open (active). Emergency stop input closed (not active) 5 5 Programmable input terminal nr.10 active 6 6 Programmable input terminal nr.11 active 7 7 Programmable input terminal nr.12 active 8 8 Programmable input terminal nr.13 active 9 N Mains contactor relay contact closed 10 G Generator contactor relay contact closed 11 V Fuel valve relay contact closed 12 S Start relay contact closed 13 5 Programmable relay terminal 18 closed 14 6 Programmable relay terminal 16 closed 15 7 Programmable relay terminal 20 closed Master: (01IO?)CRLF (01IO= N )CRLF All inputs disabled, all outputs disabled except mains contactor output PS Front panel status By means of this code it is possible to have the situation of the front panel LEDs and display. The answer is composed of a 9-bytes string showing the LED status, followed by a string for the alphanumeric display. Char Description position 1 O if led OFF is lit M if led MAN is lit A if led AUT is lit T if led TEST is lit. none of the above 2 N if led NET (near display) is lit G if led GEN (near display) is lit F if led FREQ (near display) is lit B if led BATT (near display) is lit H if led HOUR (near display) is lit Codice documento: I94GB03_99.DOC Pagina nr. 5 di 10

6 . none of the above 3 E if led ENGINE ON is lit 4 N if led mains contactor closed is lit 5 G if led generator contactor closed is lit 6 1 if led mains L1-L2 voltage present is lit 7 2 if led mains L2-L3 voltage present is lit 8 3 if led mains L1-L3 voltage present is lit 9 G if led generator voltage present is lit The display status is transmitted just after the above mentioned led status. The display string length can be from 3 to 6 ASCII characters, depending upon the presence of decimal dots. In case of an alphanumeric string, the correspondent ASCII chars are transmitted (for example, when the display shows StA during starting cycle, StA will be transmitted). Example : Master: (01PS?)CRLF (01PS=MB. N )CRLF The Leds MAN, BATT, Mains contactor closed, Mains voltage present (x3) and the display shows the battery voltage 25.3V AT Automatic test If used with the? operator, it returns the status (enabled or disabled) of the Automatic test, in a 3-digit format (000 = disabled, 001 = enabled). After that, the RGAM returns the minutes left before the next automatic test execution, in a five-digit format. Master: (01AT?)CRLF (01AT=001=00310)CRLF The Automatic test is enabled. The next automatic test will be executed in 310 min (5h 10min). Using the AT code with the write operator = it is possible to enable or disable the automatic test execution. Master: (01AT=001)CRLF The master enables the automatic test. (01AT:)CRLF RGAM confirms. OF, MA, AU, TE Mode selection By means of this four codes with the forcing operator!, it is possible to select one of the four operative modes (respectively OFF, MAN, AUT and TEST). Examples: Master: (01OF!)CRLF Master forces OFF mode (01OF:)CRLF RGAM confirms Master: (01TE!)CRLF Master forces TEST mode (01TE:)CRLF RGAM confirms KO, KM, KA, KT, KR, KS, KP, KN, KG Front key pressing simulation By means of these codes, used with the forcing operator!, it is possible to simulate the front panel keystrokes. RGAM acts just like if the real key was pressed and released. Code Key Codice documento: I94GB03_99.DOC Pagina nr. 6 di 10

7 KO KM KA KT KR KS KP KN KG OFF MAN AUT TEST SELECT/RESET START STOP MAINS GEN Examples: Master: (01KO!)CRLF OFF pressed and released (01KO:)CRLF RGAM confirms Master: (01KR!)CRLF SELECT/RESET pressed and released (01KR:)CRLF RGAM confirms. MR Reset of the maintenance interval The purpose of this code is to reset the maintenance interval counter. Normally it is used to reset the <A15 Maintenance requested> alarm. However, this commands resets the maintenance interval counter even if it has not yet elapsed, that is, even before the alarm has raised. Master: (01MR!)CRLF Maintenance interval counter reset (01MR:)CRLF RGAM confirms. RB Reset of the system (reboot) The purpose of this code is to reset the RGAM CPU. After this command, RGAM resets and restarts as if the power supply was switched off and then back on. In this case, no answer is given. See the following SB,SA and SI codes. Master: (01RB!)CRLF RGAM system reset (no answer) Codice documento: I94GB03_99.DOC Pagina nr. 7 di 10

8 SB,SA,SI Read / write of Base, Advanced and Prog-inputs setup These codes are useful to read and modify the parameters of Base setup, Advanced Setup and Programmable inputs Setup. Used with the operator? it is possible to read the parameters values, while using = it is possible to modify them (writing them to permanent memory). It is important to understand that it is not possible to access one single parameter but both the reading and the writing must be performed with all the parameters of the selected setup. Moreover, note that some of the parameters are expressed in 3-digits format while other are in 5-digit, and the correct sequence must be observed. Please note also that parameters modifications must be made in OFF mode only, and need to be followed by a system reset to take place (see RB code). For these reasons, we recommend the use these codes in write mode only to expert users. However, if the message syntax is not correct, the RGAM will answer with an error message. Examples: Master: (01SA?)CRLF Advanced setup parameters read Slave : (01SA=000=00400=000=010=010=003=000=00100=000=015=010=005=005=005=001=008=010 =00120=020=005=090=00160=050=000=000=000=000=000=000=000=000=000=000) CRLF RGAM answers with Advanced setup parameters values Master: (01SB?)CRLF Base setup parameters read (01SB=015=020=015=005=00060=020=020=005=020=000=020=000=003=010=001)CRLF RGAM answers with Base setup parameters values Master: (01SB==016=020=015=005=00060=020=020=005=020=000=020=000=003=010=001)CRLF Base setup parameters write (correct) (01SB :)CRLF RGAM confirms Master: (01SB==035=020=015=005=00060=020=020=005=020=000=020=000=003=010=001)CRLF Base setup write (not correct, first parameter out of range) (01ER :)CRLF RGAM answers with an error code ET Event timer and pointer This code id useful to read the event log timer reference point from the RGAM. The mechanism of saving events in RGAM works as follows: The events are kept only when DC power is applied to RGAM The RGAM can store the last 255 events. Over that number, the newest event will overwrite the oldest (circular buffer). The time stamp of each event is stored with reference to the moment of RGAM power-on (time 0). That is, each event is recorded with days, hours, minutes and seconds elapsed starting from RGAM power-on. This can be converted in absolute time using the PC clock time and date. The ET code returns the following information: 1. Circular buffer head (pointer to oldest event) in 3-digit format 2. Circular buffer tail (pointer to newest event) in 3-digit format 3. Days elapsed since power-on in 5-digit format 4. Hours elapsed since power on in 3-digit format 5. Minutes elapsed since power-on in 3-digit format 6. Seconds elapsed from power-on in 3-digit format Number of stored events can be calculated as follows: if (tail > head) Number of events = (tail - head + 1) else Number of events = 255 Master: (01ET?)CRLF Master asks Event timer data (01ET=000=001=00000=000=002=030)CRLF RGAM has stored two events and has been powered up for 2min 30 sec Codice documento: I94GB03_99.DOC Pagina nr. 8 di 10

9 EL Event log data With this code it is possible to read the event log data from the RGAM. Using operator? it is possible to fetch code and relative time of each event stored. EL Returns: 1. Code of the event (see following event table) 2. Days elapsed since power-on when event happened in 5-digit format 3. Hours elapsed since power on when event happened in 3-digit format 4. Minutes elapsed since power-on when event happened in 3-digit format 5. Seconds elapsed from power-on when event happened in 3-digit format Every time the master uses the code EL? A RGAM internal pointer is moved on the next event. If the user wants to set this pointer to a specific location, then he has to use EL code with operator =. EL has to be used in conjunction with ET and with the actual date time if the user wants to calculate number of events and their absolute time. Absolute time can be calculated as follows: Power-on absolute time = (Actual absolute time ET time) Event absolute time = (Power-on absolute time + EL time of event) Master: (01EL?)CRLF Master asks Event log data (01EL=084=00000=005=012=010)CRLF Event with code 84 has happened 5h 12m 10s after RGAM power on. (again, RGAM moves automatically the pointer to the following event) Master: (01EL?)CRLF Master asks Event log data (01EL=085=00000=005=012=042)CRLF Event with code 85 has happened 5h 12m 42s after RGAM power on. Master: (01EL=000)CRLF Master sets event pointer to position 0 (01EL:)CRLF Slave confirms Code Event 01 Begin of alarm A01 02 Begin of alarm A Begin of alarm A17 21 Begin of alarm UA Begin of alarm UA4 31 End of alarm A01 32 End of alarm A02 47 End of alarm A17 51 End of alarm UA1 54 End of alarm UA4 061 RGAM in OFF mode 062 RGAM in MAN mode 063 RGAM in AUT mode 064 RGAM in TEST mode 071 MAINS contactor closed 072 MAINS contactor opened 073 GEN contactor closed 074 GEN contactor opened Code Event 075 Engine running 076 Engine not running 077 MAINS voltage present 078 MAINS voltage absent 079 GEN voltage present 080 GEN voltage absent 081 Starting attempt 082 Engine running (from frequency) 083 Engine running (from generator voltage) 084 RGAM is under remote control 085 End of remote control 086 Manual START command 087 Manual STOP command 088 Manual MAINS contactor changeover 089 Manual GEN contactor changeover 090 Access to base setup parameters (from front panel) 091 Access to Advanced setup parameters (from front panel) 092 Access to user alarms setup parameters (from front panel) 093 Access to base setup parameters (from remote control) 094 Access to Advanced setup parameters (from remote control) 095 Access to user alarms setup parameters (from remote control) 096 Access to Adjust parameters (from front panel) 097 System reset (warm boot) Codice documento: I94GB03_99.DOC Pagina nr. 9 di 10

10 Codice documento: I94GB03_99.DOC Pagina nr. 10 di 10