"user manual"
Contents
1. Incompatibility O K General device O K Interface Alarm Cnt 1 Reference clock O K Device temperature O K Power supply voltage O K Input framing O K Timebase sync O K Buffer underflow O K Buffer overflow O K Clock PLL O K Synthesiser O K RF phase lock DRO O K BISS summary O K Internal M amp C module O K Interface module O K Internal modulator O K Device architecture O K As you can see there are 20 different alarms for this device Now I m sending following commands through RMCP Nas gt Nas 20 Indicating that there are 20 different known alarms When I send CAs Current alarm status string AlAlarmsCur this reads the status 0 or 1 of all current device alarm buffers The GET version returns the current alarm buffer contents the buffer is not reset Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 22 27 RMCP Manual Newtec Devices The SET version returns the current alarm buffer contents and resets the buffer CAs gt CAs 00011000000010000010 get version does not reset any of the alarms in the buffer CAs gt CAs 0001 1000000010000010 set version returns alarms then resets the alarms buffer CAs gt CAs 00001000000000000000 same but now you see that you only get the alarm that is still active the memorised alarms were reset by the previous get command And indeed you can see that the 5th bit is still in alarm meaning it is an active alarm If now se2. 6 1 Example of a device with multiple functions esssssseessssessssrressrrssrirnssrirnssttnnnstinnnntnnnnsrennnnt 16 6 2 Example of a drawer with multiple devices 2 00 2 ee eeceeeeeenneeeeeeeaeeeeeeeaeeeeeeaaeeeeetaeeeeteaeeeeee 16 7 Command Classification cceccecceceeeeeeeeeeeeeeceeeeeceaeeeeeaeseeeeeeeeeeeseaeeeeaae scenes seaeeesaeseeeeseeeeesieees 17 7 1 Standard Commands or var 17 7 1 1 Examples of standard commande 17 7 2 Special comnimandS EE 18 Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 4 27 RMCP Manual Newtec Devices 7 2 1 Example of a special commande 18 7 2 2 Example of a structured commande 19 7 2 3 Example of an array Commande 19 8 RMOP LOAM ET 20 9 Some hints on implementation Of RMCP cccceeeeceeeeeeeeeeeeeaeeeeaeeseeeeceaeeesaaeseeeeeseaeeeseaeeseaeeeenees 21 9 1 Alarmi Raning ET 21 9 2 Dynamic Alarm SiN geais ienaidnieka Eae EEN sneeeves EES eege cunsiayeesegersets 21 9 3 ele 22 9 4 A Practical Example of Alarm Handling 22 10 Questions and answers 25 Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 5 27 RMCP Manual Newtec Devices 1 Introduction 1 1 What is RMCP RMCP stands for Remote Monitor and Control Protocol which is a message oriented protocol This manual explains how Newtec devices can be remotely monitored and controlled via the serial port or via Ethernet It is a general manual intended for all prof
3. This can be useful to recover from corrupted firmware on such sub modules without having to do a full hard reset of the complete device The selection upgrade SRr 6 is used whenever an upgrade through bucket files is performed Q8 Is device reset flag supported in v2 in vi the command is Srs A The device reset flag is no longer supported in v2 0 Q9 Has IF output level in v1 TLI the same meaning as MoOutputLevel in v2 OOL A Yes the command OOL sets the operational output level of the modulator Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 26 27 RMCP Manual Newtec Devices Get More Out of Your Equipment The understanding of your application in combination with our product leads to reliable and cost efficient solutions Visit www newtec eu applications for our full application range Newtec Cy N V Laarstraat 5 9100 Sint Niklaas Belgium Tel 32 0 3 780 65 00 Fax 32 0 3 780 65 49 www newtec eu sales newtec eu Twitter com Newtec_Satcom Linkedin com company newtec Youtube com NewtecSatcom Slideshare net newtec_satcom Visit our website www newtec eu Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 27 27
4. characters 20hex to 7Fhex The header defines the meaning and size of this string Possible message text is e No data this is indicated as the null string e Anenumeration selected from a limited set of alternatives e Anumerical value with the format and units as given for each command Format and size are fixed Example s for sign two digits decimal dot and one digit e A text string with fixed or variable length e A dummy argument this is a string of question marks that replaces the normal value when the requested parameter is unknown e A not applicable indication this is a string of signs which replaces the normal value when the requested parameter is not applicable Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 13 27 RMCP Manual Newtec Devices 4 1 5 End of Text Byte The end of text byte indicates the end of the message text This is the end of text character with as value 03 hex This is the last but one byte of the complete message It is only followed by the checksum 4 1 6 Checksum Byte The last byte of each message is a checksum This is a one byte longitudinal redundancy check LRC It is calculated as the bit wise exclusive OR of all the message bytes including the message delimiters STX ETX and the address The bit wise exclusive OR function can be calculated by writing the binary value of all the concerned bytes beneath each other and then
5. MCP Manual Newtec Devices 2 3 2 Device address for serial interface SyDevRs485Addr Description The device address used in the messages for remote serial M amp C is a single byte with a value in the range 49 31 hex ASCII 1 up to 110 6E hex ASCII n It identifies the device that has to handle the message from the remote control unit When the multi user RS485 bus is used each device on the bus must have a different address unique in the system Address 111 6F hex ASCII o is the broadcast address This can be used when only one device is connected to a COM port of a PC to address the device without knowing its exact address Range e 49 110 2 3 3 Serial interface baudrate SyDevBaudrate Description Interface baudrate for serial monitor and control via the RMCP protocol Selections e 4800 e 9600 e 19200 e 38400 e 57600 e 15200 Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 9 27 RMCP Manual Newtec Devices 3 Ethernet RMCP RMCP commands can be sent to the device using the Ethernet interface The commands are sent as data in a TCP IP stream The used socket number is 5933 The RMCP protocol is exactly the same as for the serial interface with one small exception The RMCP address of the device that is present in an RMCP command will be ignored by the receiving device To enable the device to communicate over Ethernet the Ethernet interface needs to be configur
6. Newtec RMCP Manual Version 1 8 Version Date Comments V0 0 May 2005 Start of document V1 0 May 2005 First internal release of general RMCP manual V1 1 August 2005 Added an example of the implementation of alarm handling A ions and answer ion reflecting on some of th me a a Added some comparison notes between NTC 21xx and V1 3 December 2005 NTC 22xx series in answer to some specific questions of customers V1 4 February 2007 Chapter 7 Error Handling V1 5 August 2007 Chapter 7 Error Handling update V1 6 September 2007 New error reply codes added in the table V1 7 February 2011 Correction on chapter 4 1 7 V1 8 November 2013 New Newtec Template Newtec proprietary Version 1 8 Confidentiality Internal use only Page 1 27 RMCP Manual Newtec Devices 2013 Newtec Cy N V The material contained in this document is confidential and intended for use only by parties authorized by Newtec Cy N V All Rights Reserved No part of this document may be photocopied reproduced stored in a retrieval system or transmitted in any form or by any means without the prior written permission of Newtec Cy N V Newtec Cy N V Laarstraat 5 9100 Sint Niklaas Belgium Tel 32 0 3 780 65 00 Fax 32 0 3 780 65 49 www newtec eu sales newtec eu Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 2 27 RMCP Manual Newtec Devices About this manual This
7. ailed 110 Argument not acceptable wrong enumeration 111 Argument out of range enum 112 Argument too low numeric 113 Argument too high numeric 200 Get failed 300 K setting was failed and the original setting backup failed 301 New setting was failed but the original Setting backup is active again 302 Setting was rejected due to other system setting s Table 3 Error Reply Codes Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 15 27 RMCP Manual Newtec Devices 6 Logical Addressing Equipment can contain multiple devices and a device can contain multiple identical functions To address a function in a specific device in equipment one has to use logical addressing A logical address is a sub address and simply contains the device id and the function id Syntax device id function id with e device id one or more ASCII character 0 0x30 the common part to address common functions e g IP address RMCP mode drawer serial number UU 0x31 first device e g a modulator 2 0x32 second device e g a demodulator e function id one or more ASCII character UU 0x31 first function 2 0x31 second function eg function 17 in device 2 is 2 17 When no logical address is used in the RMCP message address 1 1 is assumed So when a device has no multiple functions or devices no logical address is needed 6 1 Example of a device wi
8. ariants Command Command Function SE Body Variant Call Reply Description Get VarValue No sale Returns current value of the variable in its proper format same as Set variable to new value and call function for d i Set VarValue Yas argument further dedicated processing Get VarSpec No spec Returns the specifications of the variable Table 4 Standard commands variants 7 1 1 Examples of standard command send SLs get serial number of device reply SLs 01052433 serial number 01051433 send Adr 100 set device address to 100 reply Adr 100 address is set to 100 send DSM set sleep mode to sleep reply DSM 1 sleep mode is set to sleep send Glen get specifications syntax of the serial number reply SLs lt s 8 gt syntax is 8 integers Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 17 27 RMCP Manual Newtec Devices 7 2 Special commands e Have no one to one mapping to state variables but have dedicated implementations e Can have different receive and reply argument lists The vars they refer to can be either state vars or temporary vars Temporary vars storage only exists during the processing of the command For reasons of uniformity special commands also exist in sei and get versions but the command reply argument lists can differ between the get and set version 7 2 1 Example of a special command 7 2 1 1 Devic
9. contact details can be found on http www newtec be index php id contactsupport Q1 In v2 can we know the set of all possible alarms A First send the command Nas That will return the number of available alarms Then perform a loop with las n where n 0 to the number returned by Nas 1 This will return the mnemonic and name of each available alarm e g las 14 gt las ntcSeEqAIMoRfPlo RF phase lock DRO with ntcSeEqAIMoRfPlo being the mnemonic of this command if you drop the ntcSeEq of this string you can search in the html RMCP user manual for this command The command also returns a textual description of the alarm Q2 In v2 the reply of las command consists of two part how can NMS recognize specific alarm Can it be recognized by the first part of such reply Is this string unique and constant for each alarm A The command las Identification of alarm returns the mnemonic and name of the interrogated alarm e g las 14 gt las ntcSeEqAIMoRfPlo RF phase lock DRO with ntcSeEqAIMoRfPlo being the mnemonic of this command if you drop the ntcSeEq of this string you can search in the html RMCP user manual for this command The command also returns a textual description of the alarm Q3 Does parameter Test function in v1 SMm exist in v2 If yes to which parameter in v2 should we refer to A The parameter SMm has been redefined from test functions to device mode Device mode SyDe
10. e mode SyDevMode Description The following device operating modes are defined Normal mode This is the standard operating mode which enables the default set of parameters that are most frequently used Expert mode This mode gives an expert operator access to an additional set of more advanced parameters A password is required to switch to expert mode This password is the model number of the device e g 2180 for a NTC 2180 DVB L band modulator or the software identification number in case of a board e g 6161 for a DVB S modulator board Commands that can only be changed in expert mode are indicated in this user manual by access level expert only rmcp header SMm get and set get elements get reply elements SyDevModeState set elements SyDevModeState SyDevModePass set reply elements SyDevModeReply SyDevModeState device id 0 Example send SMm get current operation mode of device reply SMm 1 current device mode is normal 1 send SMm 2 2180 set device mode to expert 2 using password 2180 reply SMm 0 2 success 0 now operation mode is expert 2 Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 18 27 RMCP Manual Newtec Devices 7 2 2 Example of a structured command A structured command can have more than 1 argument that is separated by commas These are especially useful to get or set parameters that are closely related In fact a structur
11. ed This is done by setting the IP address and net mask using the keyboard interface 3 1 Setting up the Device for M amp C over Ethernet In the Unit Setup Ethernet settings following parameters can be set 3 1 1 Device IP address SyDeviIPAddr Description Device IP address 3 1 2 Device IP mask SyDevIPMask Description Device IP Mask 3 1 3 Default gateway IP address SyDeviPGateWay Description IP address of default gateway Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 10 27 RMCP Manual Newtec Devices 3 1 4 Ethernet M amp C interface type SyEthTransType Description Selection of the Ethernet interface transport layer TCP default uses acknowledges that confirm reception of messages while UDP does not UDP has the advantage of being faster since it does not require the wait for acknowledge Furthermore RMCP over Ethernet already has protection on the RMCP layer by means of the CRC so there is no need for the extra protection provided by the TCP type layer Access level expert only Selections e TCP e UDP 3 1 5 Device MAC address SyDevMacAddr Description Device MAC address Read only Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 11 27 RMCP Manual Newtec Devices 4 RMCP Protocol The control unit sends a request message to a device identified by its unique address The addressed device interprets the messa
12. ed Use Time Use Host Name Unknown Host Name Remote Port 5933 r Logging Setup J7 Save to LogFile Iw Enable Time Stamps I Log Command Info Logging File No Logfile Selected Select LogFile Load Settings Save Settings Close Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 20 27 RMCP Manual Newtec Devices 9 Some hints on implementation of RUCP 9 1 Alarm Handling Each Newtec professional equipment device contains information on the proper working of itself by means of alarms A set of RMCP commands are foreseen that need to be used to e Get information about alarms AlAlarmCount AlAlarmDesc e Get the current and memorised status of the alarms AlAlarmCur AlAlarmsCur AlAlarmMem AlAlarmsMem AlAlarmTime e Get and set the operation mode of the alarms AlAlarmMode AlAlarmsMode The number of alarms is related to the configuration i e the number of boards and their types It is also possible that the number of alarms of a device can increase in the lifecycle of the software when new features are added Therefore special care has to be taken when writing a management system A Network Management System NMS needs to poll the alarm string on a regular base by using the command Current alarm status string AlAlarmsCur CAs This can be done using the get version CAs that will get the actual alarm string without resetting the memorized alarm indications A
13. ed command is a special case of a special command where get and set replies have the same format and consist of an equal number of arguments 1 3 2 8 PRBS counter BecBec Description Reads the current status PRBS synchronization elapsed time since start of the PRBS counter being locked and the number of PRBS errors counted since last lock Reset the time and number counters by pushing the CLR key rmcp header Bec expert get normal no access structure BecStatus BecErrCnt BecSecs device id 1 The arguments and replies of special commands are hyperlinked to their definition in the html rmcp o e manual In the explanation of the structure the elements are separated by space comma space for clarity When sending the message the spaces need to be omitted so that arguments and replies nm are only separated by commas 7 2 3 Example of an array command An array command is used when a variable is used over a number of identical instances In the RMCP command overview array commands have the array range indicated 1 2 1 8 5 Trap community 1 SyTrapCommunity1 Description SNMP trap community rmcp header TCO get and set device id 1 array range 1 2 Example send TIP 1 get first trap ip address reply TIP 1 192 168 2 169 first trap ip address is 192 168 2 169 send TIP 2 get first trap ip address reply TIP 2 192 168 2 171 second
14. eseaeeeseaeeeeaaeseeneeeaas 8 2 3 1 Serial M amp C interface type SyDevSerlfT ype 2 eceeceeceeececeeeeeeeeeeeaeeseneeeseaeeeseaeeseneeseaees 8 2 3 2 Device address for serial interface SyDevRs485Addfr ecccceceeeeeeeeeeeeeeeteeeeeaeeteneeseaees 9 2 3 3 Serial interface baudrate SyDevBaudrate ceccceccseceeseeceeeeeeeaeeeeaeeseeeeeseaeeesaeeseneeseaees 9 Bo sEthermet RMCP nister Zegerk e aeieeiaii dinaari afd danessa edanide eaten dhedeles ners EA eeng 10 3 1 Setting up the Device for M amp C over Ethernet ccceceeseeceeeeeceeeeeeeaeeeeeeeseeeeeeaeeeeeeeeenees 10 3 1 1 Device IP address GvevlbP Addr nesr nesrnssrnsrnsrnssrnssrnssrnssrnssrnssnns 10 3 1 2 Device IP mask GvievlPMask 10 3 1 3 Default gateway IP address GvtevlbGaieW au 10 3 1 4 Ethernet M amp C interface type Gv iblrans Type 11 3 1 5 Device MAC address GvfevkMacAcddr 11 A RMOP le ee 12 4 1 Message FON As recmo a cb neces sh fadeeyh geed eege eege eebe 12 NNN TEE 13 4 12 AOOreSS EE 13 4S Message Hoadol geegent eege 13 Ala EE E EE 13 Ale ENGO To Ble egie cider ced caeaiec 0b teccdnd ac ca fawesiee caved nn sauusieched fies ge sdvel eeadtvuaransd tie sed Ms cadaver es 14 AAG CHECKSUM Bytes eai aaaeeeaa ge enshapsceneeaie SES geed eege 14 4 1 7 Example of a Checksum Byte Calculation cccccccceseceeeeeceeeeeeaeeeeeeeseeeeesaeeesaaeeeeeeeeaas 14 Bs Eror AMINA E 15 Logical Addrossii pereon 16
15. essional equipment of Newtec A separate manual is also delivered that lists all the commands that are known to a specific model for example the AZ110 Broadcast Modulator 1 2 RMCP v1 0 versus v2 0 All current delivered devices are working with RMCP version 2 0 The RMCP v1 0 commands can be requested in that case the corresponding operational user manual will be used For RMCP v2 0 a separate reference manual can be requested This manual is automatically generated from the databases that define the features of equipment It consists of a general manual that is the same for all equipment and an html manual that has a description of all possible commands for the software that runs on specific equipment Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 6 27 RMCP Manual Newtec Devices 2 Serial RMCP 2 1 Connecting to the Device The serial monitor and control port can be switched between RS232 and RS485 by default RS485 is selected RS485 is typically used when more than 1 device needs to be controlled with a parallel drop down cable Pin Name Function 1 GND Shield ground 2 O nnecte 3 Tx A Send Data A input 4 Rx A Receive Data A output 5 GND Signal ground 6 Rx B Receive Data B output 7 8 O ecte 9 Tx B Send Data B input Table 1 RS485 serial interface Pin Name Function 1 GND Shield ground 2 Rx D Receive Data inpu
16. ge performs the requested action and sends back a response message The receiving device rejects all messages with transmission errors without any further action Transmission errors are no stop bit parity error LRC error and message receive buffer overflow All correct formatted messages except some special system messages are responded by the addressed device with an acknowledge message Only in a few restricted cases the device does not respond to a request from the control unit This is for example the case when a general device reset is requested Correctly received messages which cannot be handled by the device are refused via a no acknowledge error message containing the reason why the message is rejected A device never sends messages on its own initiative It only responds to a request from the control unit The total transmit time of a complete message may not exceed 250 ms If the message is not completed within this time it is discarded 4 1 Message Format The general syntax for all messages is e start byte e address byte e message header e message data e end of text byte e checksum byte Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 12 27 RMCP Manual Newtec Devices 4 1 1 Start Byte The start byte defines unequivocal the beginning of a new message There are three possible start bytes e O2hex start of text STX used for a request send by the control
17. le Interface module las 18 gt las ntcSeEqAlModModule Internal modulator las 19 gt las ntcSeEgAlArchitecture Device architecture Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 23 27 RMCP Manual Newtec Devices So in short first send the CAs command to get the current alarms and reset them Then send it again and you can see from the reply which alarms were memorized those that are now 0 and which one are still active Then from the position in the bit string you can determine which alarm it is Then you can act according to the severity you attribute to that alarm and determine your action to be taken The advantage of working with a dynamic alarm string is that whenever another device is connected to the management system that has more or less possible alarms and which could hold another position on the alarm string the management system will still act in the same way Another device could have alarm bits at another position or a different number because of differences in hard and software capabilities Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 24 27 RMCP Manual Newtec Devices 10 Questions and answers Following is a list of typical questions we received from some of our customers Please check this list to find out if the answer to your question hasn t been answered already In case a question remains unanswered feel free to contact our technical support
18. lon The first part is the alarm name a unique name for each alarm the second part is a short description of the alarm The NMS then can act accordingly when it detects a certain alarm This way the management system will not need to have the same alarm bit to be present at the exact same place in the alarm string so the NMS will always act the same independent of the position of an alarm in the alarm string Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 21 27 RMCP Manual Newtec Devices 9 3 Sync Bytes Every device runs separately a small thread This thread outputs SYNC characters e g every 100 ms internally The SYNC character value 16hex is sent by the device to indicate that it is busy with executing the command and preparing the response This prevents other devices from taking the bus if the response cannot be given immediately When a device receives an RMCP message the thread s output is redirected to the M amp C port The device interprets the message performs the requested action and sends back a response with the confirmation of the command Just before sending the response the thread s output is redirected internally 9 4 A Practical Example of Alarm Handling This example was taken from a typical support case From the diagnostics report just point your browser to the IP address of the modulator this is the list of alarms AZ110 Alarm Device Device reset flag O K Self test O K
19. manual describes how the RMCP protocol can be used For each device a separate reference manual exists listing the specific RMCP commands for that specific device Cautions and Symbols The following symbols appear in this manual a Sees A hint message indicates information for the proper operation of O your equipment including helpful hints shortcuts or important reminders E A reference message is used to direct to an internal reference within the document a related document or a web link Feedback Newtec encourages your comments concerning this document We are committed_to providing documentation that meets your needs Please send any comments by contacting us at documentation newtec eu Please include document and any comment error found or suggestion for improvement you have concerning this document Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 3 27 RMCP Manual Newtec Devices Table of Contents Lee n CT TEE 3 CAUTIONS and SYM DOIS sssini inariana ana aE aaan aaan iaaa edad ieee deen tea 3 Seele 3 UN Heen DE 6 1 1 What is RMGP KEE 6 1 2 RMCP v1 0 VersSuS v f ttin uttt uttu untn nntu ustu nnnn usnu nsnnnn natnn n nannt 6 2 Sena RMC GE 7 2 1 Connecting to the Device 0 0 eceeeeceeeeceeceneeeeaeeeeeeeeeaeeeeeaeeeeaaeseeeeseaeeesaaeseeaeeseeeeescaeeseaeeeeneeeaas 7 2 2 RIES ET 8 2 3 Setting up the Device for Serial M amp C ccceeseceeseeceeeeeeeeeeeeeeceneeecaeeesaaeseeae
20. n alarm that was active but is not active anymore at the time the alarm string is read will still indicate alarm until it is reset This is to make assure that momentary alarms that occur in between 2 polling cycles are not missed by the NMS After acknowledgement of the NMS that the alarm string is properly received it could send the set version CAs that will return the actual alarm string after which the device will reset the alarm string This is to erase all memorized alarms If the alarm string is read again it will show only the active alarms 9 2 Dynamic Alarm String The alarm string get with CAs is built up dynamically depending on the hardware that has been installed in the chassis drawer of the device New alarms will become available if boards are replaced by another type or added Also when additional features become available in higher newer software versions new alarms can be added to the alarm string In order to overcome problems that occur when working with static alarm strings that translate to a fixed alarm the use of the alarm indexing is highly recommended With this system the alarm string is read CAs or CAs then scanned by the NMS for any present alarm value not 0 The description of that alarm can then be retrieved by using the Alarm index description AlAlarmDesc that returns a short textual description of the n th alarm buffer of the device The reply will consist of two parts separated by a semico
21. nd las 4 to get the description of the 5th bit we start counting from 0 can get the description of that bit las 4 gt las ntcSeEgAllnterface Interface Now the command las Alarm index description AlAlarmDesc returns a short textual description of the n th alarm buffer of the device The reply will consist of two parts separated by a semicolon The first part is the alarm name intended for SW managing the device like Newtec SEMS while the second part is a short description of the alarm Now did send following commands to clarify the las commands las 0 gt las ntcSeEqAlResFlag Device reset flag las 1 gt las ntcSeEgAlSelfTest Self test las 2 gt las ntcSeEgAlIncompat Incompatibility las 3 gt las ntcSeEqAlGenDev General device las 4 gt las ntcSeEqAllnterface Interface las 5 gt las ntcSeEqAlRefClock Reference clock las 6 gt las ntcSeEqAlIDevTemp Device temperature las 7 gt las ntcSeEqAlPowSup Power supply voltage las 8 gt las ntcSeEqAIMolnpFram Input framing las 9 gt las ntcSeEqAIMoTbSync Timebase sync las 10 gt las ntcSeEqAIMoBufUfl Buffer underflow las 11 gt las ntcSeEqAIMoBufOfl Buffer overflow las 12 gt las ntcSeEqAIMoCIkPIl Clock PLL las 13 gt las ntcSeEqAlMoSynth Synthesiser las 14 gt las ntcSeEqAIMoRfPlo RF phase lock DRO las 15 gt las ntcSeEgAIBissSum BISS summary las 16 gt las ntcSeEqAIMcModule Internal M amp C module las 17 gt las ntcSeEgAlIntfModu
22. p layer of the general monitor and control software controls the boards and should be the only controller of the boards Using direct addressing of control parameters of boards may result in unwanted behaviour and erroneous transmissions Q6 Self test in vi we have a number of commands to perform self test and get the result of it SSs Sss SsS from our understanding in v2 we have only one command to perform such test GTS How can NMS get the result after performing such test by v2 A The command self test does not exist anymore in v1 0 and v2 0 for the NTC 21xx and NTC 22xx series of equipment The result of the boot self test is however included in the alarm string in location 0 There is no possibility to trigger a self test during normal operation Q7 In v1 we have only one type of reset in v2 we have number of possibilities to perform reset What type of reset from v2 is equal to the reset from v1 A The reset command Device reset SyDevRst has following enumerations possible Soft reset SRr 1 will send the reset command to all boards Factory reset SRr 2 results in the deletion of all saved configurations including the last active configuration followed by a reboot to factory default settings Hard reset SRr 4 will power cycle the device Data path reset SRr 5 is used for hard resetting all sub modules handling the data flowing through the device i e all boards except the M amp C related hardware
23. performing a modulo 2 addition on each column thus without carry propagation see examples 4 1 7 Example of a Checksum Byte Calculation For a unit with address 51 33hex ASCII 3 lt STX gt 3TTt1 lt ETX gt w lt STX gt 02 hex 000 0010 3 33 hex 011 0011 T 54 hex 101 0100 T 54 hex 101 0100 t 74 hex 111 0100 3F hex 0011 1111 lt ETX gt 03 hex 000 0011 LITT lt LRC gt 79 hex 0111 1001 ASCII y Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 14 27 RMCP Manual Newtec Devices o Error Handling In case there is an error in the RMCP message the device will reply with an error number Number Description 000 Argument in range 004 Failed to backup variables the backup pool to small 005 Failed to restore Variables the backup restore was failed special errors only for software debugging 023 Header unknown 024 Operation is unknown 025 Only basic RMCP commands are allowed blocking mode 026 Operation does not exist for this command Read Write 027 Command suppressed by SW HW Capability 028 Access denied by user 029 Suppressed due to other application settings 030 Format request error unknown identifier 031 Format Request Error No Set or Get Variant 032 Format Request Error Var index error 034 Data syntax error 035 String format error 040 Routing Not Available 041 Routing Timeout Error 042 Routing F
24. t 3 Tx D Transmit Data output 4 DTR Data Terminal Ready output 5 GND Signal ground 7 RTS Request To Send output 8 CTS Clear To Send input Table 2 RS232 serial interface Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 7 27 RMCP Manual Newtec Devices 2 2 Line Settings The main line settings for this serial interface are e asynchronous data transfer e 1 start bit logic 0 e 7 data bits LSB first on line e even parity e 1 stop bit logic 1 e 4800 9600 19200 38400 57600 or 115200 baud There is no flow control on the serial interface Next to correct formatted messages the only significant character is the SYNC character value 16 hex which is sent by the device to indicate that it is busy executing the command and preparing the response This prevents other devices from taking control of the bus if the response cannot be given immediately 2 3 Setting up the Device for serial M amp C In the Unit Setup Serial port settings following parameters can be set 2 3 1 Serial M amp C interface type SyDevSerlfType Description M amp C serial port interface type RS485 default or RS232 RS232 is used for M amp C of a single device RS485 is typically used for multiple devices on a single bus Access level expert only Selections e RS485 e RS232 Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 8 27 R
25. th multiple functions A NTC 2142 IF L Band Frequency Agile Up Down converter can have 2 identical functions ODU power supply enable one for the installed up converter conditioner and one for the installed down converter conditioner an example will make this clear 1 10Dp e enables the power supply voltage at the output of the up converter conditioner 71 20Dp e enables the power supply voltage at the input of the down converter conditioner 6 2 Example of a drawer with multiple devices A NTC 21xx modem holding a modulator and a demodulator board can common functions e g symbol rate an example will make this clear 1 1TRS e gets the symbol rate of the modulator board 2 1TRs e gets the symbol rate of the demodulator board Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 16 27 RMCP Manual Newtec Devices 7 Command Classification All RMCP remote monitor and control protocol commands consist of 3 characters followed by or set get and get variable specifications Note that RMCP commands are case sensitive In this device we distinguish 2 classes of RMCP commands standard commands and special commands 7 1 Standard Commands or vars e Map directly onto a state variable with permanent storage e Are completely defined by a single component definition file e Exist in 3 variants determined by the data following the 3 character RMCP header PRIVATE Standard Command v
26. trap ip address is 192 168 2 171 Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 19 27 RMCP Manual Newtec Devices 8 RMCP Loader RMCP Loader offers a Windows platform based user interface that allows e Single command control e Grouped command control e Single firmware update e Grouped firmware update For any Newtec device that is equipped with a serial monitor and control port or an Ethernet connection port This program can be useful when implementing a new management system to check the behavior of the equipment on RMCP commands The program and its user manual can be downloaded freely at http www newtec be support download shtm Remote Monitoring and Control v4 9 jelp Exit System Control RS 232 Communication Data TCP IP TXD n Communication Enabled Single Command Grouped Commands Single Firmware Update Grouped Firmware Update Single Command e rang Send Message J Sid Send Rmep Messag Communication Setup r Protocol Setup Max Sync Time Max Char Timeout r Communication Data BaudRate 115200 X Logfile No LogFile Selected Comfort TCP AP Max Responding Time Max Retrials r General Setup JW Auto Save On Exit History size sending Iw Selectable Cmnd Files single Rmep Cmnds r TCP IP Setup Use Host IP Address 1 e Iw Display Logging Enabl
27. unit to a device e O6hex acknowledge ACK used for the response from a device to the control unit e 15hex no acknowledge NAK used for the error response from a device to the control unit 4 1 2 Address Byte The address identifies the destination device for the request message and the source device for the response message Each device must have a unique address when the control unit guards more than one device via a multi user bus Valid addresses are in the range 49 31hex ASCII 1 up to 109 6Dhex ASCII m The indoor and outdoor units are two different logical devices for RMCP although they communicate via the same electrical link The outdoor unit has the address of the indoor unit raised by one For a limited set of messages the RMCP broadcast address 111 6Fhex ASCII o can be used This address is reserved for test systems with only one device connected to the control unit Messages that can be handled with the broadcast address are the device identification and the RMCP address 4 1 3 Message Header The header defines the contents of the message and thus how the device should handle it All headers consist of three capital or minor ASCII characters respectively 41hex up to 5Ahex and 61hex up to 7Ahex The header is always followed by or set get and get variable specifications The header syntax is case sensitive 4 1 4 Message Data The message text is a string of ASCII representing
28. vMode defines the device operating mode There are 2 modes e Normal mode This is the standard operating mode which enables the default set of parameters that are most frequently used e Expert mode This mode gives an expert operator access to an additional set of more advanced parameters A password is required to switch to expert mode This password is the model number of the device e g 110 for a AZ110 Broadcast Modulator or the software identification number in case of a board e g 6241 for a AZ110 modulator Commands that can only be changed in expert mode are indicated in this user manual by access level expert only To set the device mode via RMCP the password had to be given as a structured command e g to set the device mode to expert in a the command SMm 2 110 will need to be send Q 4 In v1 we have Device capability parameter SLc in v2 we have a number of different capabilities What capability should we refer to in v2 in order to know the value of the same parameter as in v1 And for Device identification 0 from v1 and Hardware description SSh from v1 A Following parameters are available that uniquely define the device see also Architecture General Device serial number SyDevSn Device hardware identification SyDevHwid Device hardware version SyDevHwVer Device hardware capability SyDevHwCapab Device software identification SyDevSwld Device software version SyDe
29. vSwVer Device software capability SyDevSwCapab Newtec proprietary Version 1 8 Confidentiality Unrestricted Page 25 27 RMCP Manual Newtec Devices Device capability SyDevCapab Product identification number SyDevProdld Q5 In v1 we have Interface identification what parameter from v2 has the same meaning A The same list of parameters as described above is available for each of the boards in the device The same commands have to be used but with direct addressing Only the addresses of the modulator and interface board are accessible for customers E g SLs will return the serial number of the general device but proceeding the command by the direct address of the modulator board will return the serial number of the modulator board TXD gt ADR 100 DATA SLs get general serial number RXD gt ADR 100 DATA SLs 05031401 reply TXD gt ADR 100 DATA 1 1 dSLs get serial number of interface board RXD gt ADR 100 DATA 1 1 dSLs 05011177 A reply TXD gt ADR 100 DATA 1 1 tSLs get serial number of modulator board RXD gt ADR 100 DATA 1 1 tSLs 05030901 A reply The following hardware addresses are available 1 1 d for interface boards 1 1 t for modulator boards 1 1 e for RF converters Warning Direct addressing of other parameters besides those in the architecture menu is also possible but it is strongly advised not to use this to command the device The to
Download Pdf Manuals
Related Search