ALTOdiagnostics CompWell PC - Program to Configure the Diagnostics Node of SmartRouter RTRSD and SmartRepeater RPTSD Software Description
These instructions will support you during installation and use of the software. The content of this documentation has been checked very thoroughly on the basis of the hard- and software described, however we cannot exclude potential divergences or errors. So we do not assume any liability for potential errors that may be contained in this description. The software product and the respective documentations are subject to modifications. All information contained in the document undergo a regularly checkup and necessary corrections will be incorporated in the following editions We would appreciate your comments and suggestions. More detailed information such as further descriptions, texts for invitation of tenders of devices, updated documentations and, available software updates are available for download at our website www.sysmik.de. We would like to point out that due to state-of-the-art it is currently not possible to create software to run trouble-free and without interruption in all applications and combinations and we therefore cannot assume any warranty. The software product and the relating documentation are made available as they are, we do not assume any warranty that the software meets the requirements and purpose of the user or is compatible with other programs the customer runs. As far as legally admitted, liability for direct, indirect or consequential damages is excluded. ALTO and IPOCS are trademarks of SysMik GmbH Dresden. Networking Together! is subject to copyright by SysMik GmbH Dresden. Echelon, LON, LONWORKS, LonBuilder, NodeBuilder, LonManager, LonTalk, LonUsers, LonPoint, Neuron, 3120, 3150, Digital Home, LONMARK, the Echelon logo, the LONMARK logo and the LonUsers Logo are trademarks of Echelon Corporation, registered in the US and other countries. LonLink, LonResponse, LonSupport, LONews, LonMaker und i.lon are trademarks of Echelon Corporation. All other trademarks referred to in this documentation are registered property of the respective owners. Those and further trademarks are used in the text but not specially marked in order not to affect the legibility in the following. Duplication or circulation of this documents as well as utilization and notification of the content are subject to approval by SysMik. Copyright 2002 by SysMik GmbH Dresden
Content 1 Survey 4 2 Use of ALTOdiagnostics 5 2.1 Installation 5 2.1.1 Selection of a Project 6 2.1.2 Selection of the Network Access 6 2.1.3 Management of the Diagnostics Nodes 6 2.1.4 Management of the Test List of the Current Diagnostics Node 8 2.1.5 Visualization of the Test Results 9 2.1.6 Setting of the Operating Parameters 11 2.1.7 Evaluation of the Current Protocol 11 3 Literature 14
1. 1 Survey SmartRouter (RTRSD) and SmartRepeater (RPTSD) with integrated diagnostics function by SysMik allow monitoring and error diagnostics of LONWORKS networks without any additional devices during running operation of the plant. The program ALTOdiagnostics described in this documentation enables configuration and parameterization of the diagnostics node included in RTRSD and RPTSD. The electronic version of the documentation is available in the installation directory of the program. ALTOdiagnostics is independent of the LNS architecture. Functions of ALTOdiagnostics ALTOdiagnostics is a Windows based 32 Bit PC program including the following functionalities: o Management of a diagnostics node list o Configuration and parameterization of the diagnostics nodes - Establishment of the test list, downloading and extraction from the device - Immediate check of the values entered - Setting of test cycles and duration - Activation and de-activation of test modes - Launch and interruption of the test run o Visualization of the monitoring results - Loading of the test results - Loading and saving of the current test protocol Note: The following documentation assumes knowledge in terminology and the use of the LonWorks Technology. Basic knowledge in operating Windows programs should also be granted. Concerning the function of the SmartRouter and the diagnostics node we refer to the device description SmartRouter with Bus Diagnostics [1]. Among others it describes the functionality of network monitoring, display and operating elements of the module. The functionality of the SmartRepeater is described in detail in the chapter SmartRepeater with Bus Diagnostics [2].
2 Use of ALTOdiagnostics 2.1 Installation ALTOdiagnostics has to be installed prior to use. The installation is launched by setup.exe and allows the selection of the installation path. Setup.exe is provided by the CD-ROM included in the scope of delivery or available for download at www.sysmik.de. During installation an entry in the start menu is generated allowing to start ALTOdiagnostics. Furthermore the start menu includes a link to the electronic version of this documentation and for de-installation. De-installation can be processed in the usual Windows procedures. Processing of a Project The following form appears after start: Fig. 1 Project Selection
The steps described in the following have to be executed for further operation of ALTOdiagnostics. 2. 2.1.1 Selection of a Project A project can be loaded or created under project selection. Note: ALTOdiagnostics administrates information including projects in files with the extension srd. In general projects include the following information: List of diagnostics nodes List of the nodes to be tested (test list) for each diagnostics node Parameterization information of the node if it has been loaded from or written into the device If there has been a communication with at least one node of the project the settings of the network interface will be saved The project represents the basis for all further operating steps. Once the selection is made another page of the form will be displayed. The order of the following steps may vary according to the mode of operation. 3. 2.1.2 Selection of the Network Access This is the earliest moment to select an available network access and to open it in the field Selection of Network Interface. In the following document network interface is abbreviated by NI. If required, the configuration of the opened NI may be modified in the section Network Interface Settings and explicitly be written into the NI via the button Save Network Settings. Attention: Prior to access the network all other programs accessing the NI have to be closed. ALTOdiagnostics support any network board compliant with the LONWORKS standard such as the PCLTA and PCNSS boards by Echelon. Note: In order to ensure correct function of Echelon network interfaces NI Application has to be set to NSIPCLTA or NSIPCC in the device driver (to be modified in the system control under LONWORKS Plug n Play ). The network access can of course be established at any later moment while working with ALTOdiagnostics, thus allowing to create a project prior to access the LONWORKS network and to synchronize the relevant information later. 4. 2.1.3 Management of the Diagnostics Nodes The list of the diagnostics nodes is shown at the page Diagnostics Nodes as displayed in Fig. 2.
Note: Diagnostics nodes are nodes in charge of network monitoring within RTRSD and RPTSD. New entries are added via the pushbutton New Diagnostics Node, existing nodes can be modified via Edit Diagnostics Node. The selection of the currently active node is either made via mouse click or via keyboard assignment. Entries can be deleted from the list by further pushbuttons ( Delete Diagnostics Node ) and rearranged in their order. The LONWORKS nodes are identified by their Neuron ID, which can either be entered manually, read-in via a barcode scanner or entered by receiving of the service pin message. Note: The order of the diagnostics nodes in the list has not to be in accordance with their order in the network. Fig. 2 List of Diagnostics Nodes The table contains index of the diagnostics node, Neuron ID, the current online test node status and a field for additional information. Additional information is not saved in the diagnostics node.
The diagnostics nodes included can already be verified concerning their availability in the network by entering the list ( Online Test ). The operating elements Online Test and Details are only available if a NI has been opened. The test status of the current diagnostics node is displayed in the lower part of the window if a NI is opened and the diagnostics node has responded upon the request of its node status and the program ID. This status of the diagnostics node is characterized as online. The query of a diagnostics node is online is made via the Online Test and the display via Online Test Node Status. Note: If the test of a diagnostics node has failed the node is not queried again in order to avoid needless busload of these nodes. A subsequent test run has explicitly to be launched again by switching-on Online Test. The access to configuration and/or parameterization of the currently selected diagnostics node is made via the pushbutton Go to Configuration including four property pages. The page Test List is the standard site shown, the required procedure is described in the following paragraphs. 5. 2.1.4 Management of the Test List of the Current Diagnostics Node On the page shown in fig. 3 of ALTOdiagnostics the list of nodes can be processed and either be written in or read from the device. The table includes index and Neuron ID of the node, the current online test node status, the columns EXT, NET A and RING A as well as a field for additional information. When the nodes are entered into the list, their availability within the network can also already be checked, similar to the description in chapter 2.1.3. EXT indicates if a node is located externally. External nodes are nodes located outside the ring-shaped segment within a LONWORKS network (EXT on TRUE). Further information concerning terminology and test algorithm is provided in [1] and [2].
Fig. 3 Test List Note: For practical use of the diagnostics function the nodes have to be filed within the table according to their position within the ring. This is also possible for external nodes, though not required. The results of the latest tests are stated in the columns NET A and RING A. Details and the meaning of the pushbuttons get check result, run check and stop check are explained in chapter 2.1.5 Visualization of the Test Results. Information can be synchronized between project and nodes via the pushbuttons Write List and Load List. Those two pushbuttons are only available while the diagnostics node is online (see 2.1.3). Note: Reading and especially writing procedures should not be interrupted. Therefore no other operation is enabled during loading and writing of the list. Interruption during writing of the list into the node leaves the node in an undefined state. 6. 2.1.5 Visualization of the Test Results
The results of the latest test run can be visualized on the pages check results and check nodes list, functions only available if the diagnostics node is online (see 2.1.3). A test run can explicitly be launched via the pushbutton run check and the results are automatically visualized after completion. The results of the last test can be viewed via get check result. run check and get check result are only available if there is no test running at the diagnostics node. stop test however is only available while the test is active. The test result for the specific node is showed in the test list in NET A and RING A (see [1] and [2]). Note: If the test list has not been synchronized between the device and ALTOdiagnostics (via write to device and load from device ), faulty interpretations of the visualization results may occur. A message is generated by the program in case of missing synchronization. A view of the page Test Results is shown in fig. 4. Fig. 4 Test Results This page shows the information from the diagnostics node. The informations are mainly retrieved by the network variables of the diagnostics node. ALTOdiagnostics
allows comfortable evaluation of these informations. The external interface of the diagnostics node is described in detail in [1] and [2]. 7. 2.1.6 Setting of the Operating Parameters The page configuration (see Fig. 5) allows setting of the operating parameters of the diagnostics node. The operating elements are only available while the node is online. set configuration to device is only available while no test is running. Meaning and value ranges of the parameters are described in [1] and [2]. Question marks appear if the current configuration has not yet been loaded from the device. Once the parameters have been successfully written into the node, the information is saved in the project as soon as the pushbutton save project is activated the next time. Fig. 5 Configuration 8. 2.1.7 Evaluation of the Current Protocol The running protocol provides access to any detail of the current test results. The test results are consecutively numbered and written into a ring buffer, thus always
including the latest information. ALTOdiagnostics allows comfortable access to the information of the protocol. Note: The ring buffer has a capacity of 256 entries. The information is: A delta value to reconstruct the time the value has been generated Number of the test run Index and Neuron ID The results of the node state poll The result of each single test step ALTOdiagnostics allows loading this protocol into the table, to save it as CSV file and to delete the protocol in the diagnostics node. Among others, the file format CSV can be read by Microsoft Excel und allows further computerized evaluation of the test results. Fig. 6 Test Protocol Note: The protocol loaded represents a snapshot of the status of a diagnostics node. If required, it has to be updated manually via the pushbutton get Protocol.
The pushbutton get protocol launches the loading of the protocol that can be saved afterwards via Save Protocol. Activation of the pushbutton delete protocol deletes the protocol file in the diagnostics node. This does not apply to the protocol file loaded in ALTOdiagnostics; the view can be updated via reactivation of the pushbutton get protocol.
9. 3 Literature [1] RTRSD Device Description. [2] RPTSD Device Description.