USER GUIDE OCTANS III & POSITIONING NAVIGATION III. PART 3 : INSTALLATION AND REPEATER SOFTWARE

Transcription

1 USER GUIDE OCTANS III NAVIGATION & POSITIONING III. PART 3 : INSTALLATION AND REPEATER SOFTWARE

2

3 TABLE OF CONTENTS III.1 INTRODUCTION... III-5 III.2 INSTALLATION... III-6 III.2.1 III.2.2 REQUIRED ENVIRONMENT... III-6 Installation procedure... III-6 III.3 HOW TO CONNECT OCTANS... III-8 III.4 General Overview... III-10 III.4.1 III.4.2 III.4.3 OCTANS Repeater Main window... III-10 configuration and monitoring menus... III-10 General rules for using Control Windows... III-12 III.5 Data display... III-13 III.5.1 III.5.2 III.5.3 III.5.4 How to add a window... III-13 How to move a window... III-13 How to delete a window... III-14 Changing background of Main Repeater Window... III-14 III.6 Log and latitude... III-15 III.6.1 III.6.2 Description of the dialog box for log and latitude... III-15 How to use the log and latitude dialog box... III-15 III.7 Geometric configuration... III-16 III.7.1 III.7.2 Description of the dialog box... III-16 How to use the dialog box for motion sensing and geometric configuration... III-16 III.8 Secondary Lever Arm... III-17 III.8.1 III.8.2 Description of the dialog box... III-17 How to use the dialog box for secondary lever arms... III-17 III.9 Serial port configuration... III-18 III.10 Analog outputs configuration... III-20 III.11 Pulses I/O configuration... III-21 III.12 Data Record... III-22 III.13 CONFIGURATION FILE... III-23 III.13.1 Save configuration file... III-23 Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-3

4 III.13.2 Load configuration file... III-23 III.14 OCTANS Log... III-24 III.14.1 OCTANS Status and Error Display... III-24 III.14.2 OCTANS Status and Error Log files... III-24 III General description... III-24 III Editing and deleting Status.log and Error.log... III-25 III.14.3 OCTANS Settling time... III-26 III Alignment phase... III-26 III Heave filter initialisation... III-27 III.15 SYSTEM INFORMATION... III-28 III.16 RESTART SYSTEM... III-28 III.17 SAVE CONFIGURATION TO PROM... III-28 Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-4

5 III.1 INTRODUCTION The OCTANS Installation and Repeater Software is part of the standard OCTANS delivery. It contains the software for configuring (required) and monitoring (optional) OCTANS. It also contains a protocol library interface to configure OCTANS outputs. This library interface is described in Part 4 of OCTANS III User Guide. OCTANS Installation and Repeater Software is required for the configuration of OCTANS parameters : electrical interfaces (inputs and outputs) angular bias compensation definition of lever arms for external monitoring points manual input or update of speed and latitude Configuration setting may be performed while the OCTANS is operating. The OCTANS Onstallation and Repeater Software may also be used to monitor OCTANS operation. It allows to : display in real time all the data delivered or used by OCTANS : the true heading, the attitude in terms of roll and pitch, the motion in terms of heave, surge and sway, some parameters used in the OCTANS algorithm, such as the latitude and the log, the OCTANS Status record data into text files automatically records OCTANS status and errors in dedicated log files. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-5

6 III.2 INSTALLATION III.2.1 REQUIRED ENVIRONMENT The OCTANS III Installation and Repeater Software should be installed on IBM compatible PC only, with any of the following versions of Windows: Windows NT, Windows 98, Windows 95, Windows 2000, Windows XP. Warning : if you are using Windows NT, you will be able to install the OCTANS III Installation and Repeater Software only if you have the administrator privileges. III.2.2 INSTALLATION PROCEDURE Insert the OCTANS installation software CD-ROM. The installation should start automatically, and the window displayed in Figure III-1 should appear on the screen. To exit Figure III-1 : Dialog box with auto-run CD Click on the Repeater software button to install the repeater software. The User Guides button displays the user guides directory. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-6

7 If installation does not launch atomatically, run SETUP on \OCTANS Repeater CD-ROM directory and follow the instructions displayed on screen. Once the installation is completed, an ixsea directory is created in the default file C:/program files on your computer, with the folder lists displayed in Figure III-2. Default folder for Data Log record UDP protocol Library Folder Default folder for configuration files record Default folder for Octans Log record Figure III-2 : Directory list of OCTANS Repeater Software folder An application icon will also be available on your destop to start your Repeater software (see Figure III-3). Figure III-3 : OCTANS Repeater Icon Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-7

8 III.3 HOW TO CONNECT OCTANS In order to configure or monitor OCTANS using the Repeater Software, you must connect OCTANS to your PC. Refer to Part 2 of the OCTANS III User Guide for details. The communication with the PC is performed though a dedicated COM port on the PC. This proper COM port should be selected. Default factory setting is COM 1. If your PC is not communicating with the OCTANS, it may be that OCTANS is not connected to COM1. In such case, COM selection will have to be modified. To change the COM port selection : During Repeater launch, with OCTANS already connected to the proper COM port, the following window should appear (see Figure III-4) Figure III-4 : "Loading configuration" Window Click on the COM select button : the window for choosing the port (Figure III-5) will appear. Clicking on the Close button will stop configuration loading. Connection can be activated later on by opening the communication Dialog box. Once the repeater has been launched on the PC, you may see the repeater main window with NO Data messages on all panels : Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-8

9 Click on the right button of the mouse within the repeater window Choose Configuration, then Repeater Use the dialog box described on Figure III-5 to select the proper COM port. Figure III-5: Choice of the COM port NOTE : It is not necessary to first connect OCTANS before starting the Repeater Software : you can connect OCTANS at anytime. Even if OCTANS has been working for a long time, and has already tracked North, you will not interrupt OCTANS operation by launching the Repeater Software. However, if you modify some computation parameters, it is possible that you observe a transition phase. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-9

10 III.4 GENERAL OVERVIEW III.4.1 OCTANS REPEATER MAIN WINDOW When the Repeater Software is launched, and communicating with OCTANS, the Repeater Main window is displayed (see Figure III-6). Figure III-6 : Main repeater window III.4.2 CONFIGURATION AND MONITORING MENUS. All menus are accessed by clicking on the mouse right button, and selecting the proper menu (see Figure III-7). Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-10

11 Monitoring Main Repeater Window display Figure III-7 : General list of OCTANS Repeater menus The following items can be selected from the menu : Log and latitude : Geometric configuration : Secondary lever arms : Serial IO : Analogue IO : Pulse IO : Record Data to File : allows you to input the speed and the latitude compensation parameters. allows you to log in various compensation parameters, such as the primary lever arm, or to add different installation offsets. allows you to set up to three secondary lever arms. allows you to set the digital interfaces of OCTANS. Three independent serial ports are available in OCTANS, the availability of which depends on the OCTANS / Connector type. Details are given in the corresponding user s guide. Digital outputs are called SerOutA, SerOutB, SerOutC. Digital inputs are called SerInA, SerInB, SerInC. allows you to set the analogue interfaces of OCTANS. A maximum of four independent analog outputs are available depending on the OCTANS type. The analog outputs are called AnaOutA, AnaOutB, AnaOutC and AnaOutD. allows you to set the pulses (or on/off ) interfaces of OCTANS. There are two independent pulse outputs and two independent pulse inputs available on the serial I/O connector of OCTANS Surface. The pulses outputs are called NumOutA, NumOutB. The pulses inputs are called NumInA, NumInB. records OCTANS outputs in a text file. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-11

12 Configuration File : OCTANS log : System information : Restart system : Allows the user to save the configuration data of an OCTANS into a user named file and to load the configuration data saved in file into the OCTANS. edits and deletes automatically updated Status.log and Error.log files. returns the serial number of the OCTANS and the software version. allows the user to restart the algorithms without switching off the power supply. Save configuration to PROM: saves the current configuration in the OCTANS. When a menu is selected, a dedicated control window is displayed. III.4.3 GENERAL RULES FOR USING CONTROL WINDOWS Control Windows are open after selection of a menu in the OCTANS Repeater menu list (see Figure III-7). They allow you to display or modify OCTANS configuration parameters. At first delivery, these parameters are set to default values. They have to be modified by the user depending on the system configuration. For each parameter (or set of parameters) entered by the user in a control window, - when parameter setting is performed from selection in a menu (for example for electrical interfaces configuration), it is required to click on the corresponding SET button prior to EXIT or close the window, so that modified selection is accounted for and stored into OCTANS Random Access Memory. Failure to click on the SET button will invalidate all modifications performed. The Reset button restores parameters to previously entered values. - When parameter setting is performed by manual entry of a value (for example for manual input of latitude, see figure below), the box to be modified should be first ticked, then the new value should be typed in the corresponding frame. The modification is validated by clicking on the SET button prior to exit or close the window. WARNING : To save settings modification into OCTANS PROM, so that they are used at next OCTANS start, it is required to perform a Save to PROM operation after any setting modifications. Otherwise, modifications are volatile, as only saved into OCTANS RAM. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-12

13 III.5 DATA DISPLAY You can display different types of windows and data in the main repeater window. The general appearance of the window will be saved when you exit the Repeater (OctRepeater.ini file) and displayed again when the Repeater software is launched again. The different types of windows which can be displayed are listed here : Graphic windows: compass rose, skyline Status panel window : displays the OCTANS status. Digital windows: any available data (heading, roll, pitch, sway, surge, heave, latitude, log) III.5.1 HOW TO ADD A WINDOW Click on the area on the screen where you want to add a window with the right button of the mouse, you will open a dialog box (see Figure III-8) Choose Add If you want to add a graphic window, choose Compass rose or Skyline, a status panel choose Status panel or a digital window, choose Display, then the desired parameter Figure III-8 : Add window menu NOTES : it is not possible to add a window if there is not enough place on the screen where you have clicked. Windows will appears greyed in the list. III.5.2 HOW TO MOVE A WINDOW Click on the window with the left button of the mouse, and keep the button pressed Move the window using the mouse Release the button Note: you cannot superimpose two windows, you have always to bypass all the opened windows. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-13

14 III.5.3 HOW TO DELETE A WINDOW Click on the window with the right button of the mouse, you will open a dialog box (see Figure III-8) Choose Delete III.5.4 CHANGING BACKGROUND OF MAIN REPEATER WINDOW Background of the main repeater window can be changed by selecting the Repeater sub menu in the Configuration menu, and selecting a new background in the Repeater Aspect box (see Figure III-5). Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-14

15 III.6 LOG AND LATITUDE III.6.1 DESCRIPTION OF THE DIALOG BOX FOR LOG AND LATITUDE The dialog box is shown in Figure III-9. Figure III-9 : Log and latitude dialog box As with every gyrocompass, OCTANS is sensitive to speed and latitude (refer to Part 2 of OCTANS III User Guide). It is possible to log in these parameters through connection of external sensor (Log sensor and/ or GPS). In addition, it is possible to log in these values manually. It is recommended that a correct manual value for latitude is set, even is a GPS is connected. Latitude is enter as a signed value : positive (0 to 90 degrees) in the northern hemisphere, negative (-90 degrees to 0 degree) in the southern hemisphere. Once entered and set, latitude is displayed unsigned in the Log and Latitude dialog box. Hemisphere is shown by a letter ( N for Northern, S for Southern, displayed after the latitude unsigned value. III.6.2 HOW TO USE THE LOG AND LATITUDE DIALOG BOX Example: To change the latitude value: Select Latitude by ticking the box. Failure to tick the box will invalidate modifications typed. Change the latitude value, for example 45 degrees North Click on Set To reset the original value, click on Reset Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-15

16 III.7 GEOMETRIC CONFIGURATION III.7.1 DESCRIPTION OF THE DIALOG BOX The dialog box is shown in Figure III-10. Figure III-10: Geometric configuration dialog box The dialog box is divided into three parts: Bias: OCTANS is calibrated at ixsea and the heading value refers to the centerline of OCTANS. However it is sometimes very difficult to perform a perfect alignment between OCTANS and the vessel. Therefore, it is possible to add some bias to the heading, as well as to the roll and pitch. Refer to Part 2 of OCTANS User Guide for the definitions of angular misalignment bias. Primary lever Arms: gives the position of an external monitoring point with respect to OCTANS center of measurement. Refer to Part 2 of OCTANS User Guide for the definition of lever arms. Heave/Surge/Sway filtering parameter: This function is only used with previous versions of OCTANS. In OCTANS III, T0 is automatically set by the algorithm and it will not be possible to change its value. This sub-window is automatically greyed. III.7.2 HOW TO USE THE DIALOG BOX FOR MOTION SENSING AND GEOMETRIC CONFIGURATION To add a bias to the heading value (example) : Tick the Heading box Type the bias value in the heading frame, for example 0.2 degrees Click on Set Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-16

17 III.8 SECONDARY LEVER ARM III.8.1 DESCRIPTION OF THE DIALOG BOX The dialog box is shown in Figure III-11. For each secondary monitoring point (up to 3), it is possible to configure the lever arm. Figure III-11: Secondary lever arm dialog box III.8.2 HOW TO USE THE DIALOG BOX FOR SECONDARY LEVER ARMS To change the secondary lever arm 1 (example) : Select Secondary level arm1 X1, X2 and X3 (tick the boxes!) Change the three values, for example 1.2, 2.3 and 0.4 meters Click on Set To reset the original value, click on Reset Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-17

18 III.9 SERIAL PORT CONFIGURATION The dialog box is shown in Figure III-12. Figure III-12: Serial port configuration dialog box For each serial port, it is possible to change : General Parameters (used both for input and output on a given port) : Parity : you may choose among Odd, Even, and None. Stop bit : 0.5, 1, 1.5, or 2 Parameters for input : Baudrate : to be selected from a pre-set list (from 600 bauds up to kbauds) Protocol : each protocol is defined in the OCTANS Interface Library document, Part 4 of the OCTANS III User Guide. Timeout : is the time to wait between the end of an incoming data frame and the arrival of the next data frame. o o Default value 1 corresponds to an automatic setting of TimeOut. If binary protocols are used on the input port, TimeOut should be set at least equal to the time interval between 2 bits. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-18

19 Parameters for output : Baudrate : to be selected from a pre-set list (from 600 bauds up to kbauds) Protocol : each protocol is defined in the OCTANS Interface Library document, Part 4 of the OCTANS III User Guide. Lever Arm: Specify the lever arm used. Motion sensing output on the protocol selected will be the motion measured at the external monitoring point defined by the lever arm. Level : RS232 or RS422 SmpPeriod : time interval in milliseconds between the beginning of two consecutive outputs. Minimum value is 10 ms, corresponding to a maximum output frequency of 100 Hz. Sampling period minimum increment is 10 ms : user-defined sampling period should be a multiple of 10 ms. Warnings : when configuring the output port, check that sampling period and baudrate are consistent with the protocol data field length. If it is not the case, data output will not be correct, and a SerOut X full flag will appear in the OCTANS status panel. Checking procedure is as follows : o Count the maximum number of bits Nb (including parity and stop bits) in the protocol data frame. ASCII characters are 8 bits long. o Select Baudrate and Sampling period so that : Nb < Sampling Period (in ms) * Baudrate (in kbauds) If the three output ports are connected, and if output frequencies are different between the 3 data outputs, configure port C with the lowest output frequency settings (highest sampling period). If less than three outputs are needed, do not use port C for output. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-19

20 III.10 ANALOG OUTPUTS CONFIGURATION The dialog box is shown in Figure III-13. Figure III-13: Analog output configuration dialog box For analog serial I/O, it is possible to change: Data: each protocol is defined in the OCTANS Interface Library, Part 4 of the OCTANS III User Guide. Lever Arm: Specify the lever arm used Parameter: The parameter definition is related to the chosen protocol and is also defined in the OCTANS Interface Library, Part 4 of the OCTANS III User Guide. Most of the times, parameter can be understood as a scale factor For example, a roll parameter will be expressed in Volts/degrees. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-20

21 III.11 PULSES I/O CONFIGURATION The dialog box is shown in Figure III-14. Figure III-14: Pulses I/O configuration dialog box For each serial I/O, it is possible to change: Data: each protocol is defined in the OCTANS Interface Library, Part 4 of the OCTANS III User Guide. Lever Arm: Specify the lever arm used. Parameter: The parameter definition is related to the chosen protocol and is also defined in the OCTANS Interface Library, Part 4 of the OCTANS III User Guide. For example for a pulse log input, the parameter will be expressed in Pulses/Nautical miles. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-21

22 III.12 DATA RECORD OCTANS data can be recorded in a text file with the repeater software. Right click on the mouse button Select Record data to file in the Menu list. The Record Data dialog box appears (see Figure III-15). Select the data to be saved or click button Select all data Input File Name Set the SmpPeriod : time interval between 2 data records. Smp Period has to be set has a multiple of 200 ms, with a minimum value of 200 ms. Set the Smp per files : maximum number of points per file. If the maximum number of points is reached, a new file is created and an incremented index is added to the file name. Click on the Record button to start data record Click on the Stop button to stop data record. Figure III-15 : "Record data to disk" dialog box The file is a text file and is always located in the following directory (see Figure III-2) : C\Program Files\IXSEA\OctRepeaterVX_Y\DataRecord\, where VX_Y refers to your current Repeater version. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-22

23 III.13 CONFIGURATION FILE This function allows the user to store the OCTANS configuration into a file and also to load a saved configuration from a file into OCTANS. III.13.1 SAVE CONFIGURATION FILE When selecting Save configuration file (see Figure III-16), the user will save all the configuration parameters of the OCTANS in a file. The configuration parameters are all the geometric parameters, the I/O protocols and baudrates. The user can choose the name of the file. The name has to be typed in the Configuration Save File window. By clicking on OK, all the parameters will saved in the file. This will allow the user to reuse the file for loading the saved configuration. III.13.2 LOAD CONFIGURATION FILE When selecting Load configuration file, the user will be able to select a given file (that has been previously saved) and to load it into the OCTANS. With this single click, then the whole configuration that had been saved will be immediately loaded and active in OCTANS. The window that will pop up is shown on Figure III-17. The user has then to select the file name that he wants to load (in the Select a file window). And click afterwards on the OK button. BE CAREFUL : This function loads the configuration parameters in the RAM of OCTANS. If you want to save it into OCTANS for next use, you have to save this new configuration in PROM (refer to III.17). Figure III-16 : Save configuration file window Figure III-17 : "Load configuration window Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-23

24 III.14 OCTANS LOG OCTANS has a built-in status and error test which provides alarms and displays messages in the status panel when status is changed or when errors are detected. Status and error information is given by the 8 bytes hexadecimal word $PHINF (see Library Interface for a description of the $PHINF word). III.14.1 OCTANS STATUS AND ERROR DISPLAY OCTANS status word $PHINF is displayed in the status panel window of the repeater. Messages corresponding to the error and status bits which are set to 1 are red-displayed in the status panel window on occurrence. On error occurrence, data which accuracy may be affected by the error are red-displayed. III.14.2 OCTANS STATUS AND ERROR LOG FILES III GENERAL DESCRIPTION OCTANS status changes and error occurrences are automatically logged into two dedicated text file : Status.log : records change in OCTANS status only. Error.log : records OCTANS errors only. Files are automatically updated with the date and time of occurrence and description of either status change or error detected (see an example at Figure III-18). The 2 files are located in the following directory (see Figure III-2): C:\Program Files\IXSEA\OctRepeaterVX_Y\OCTANSStatus, where X_Y refers to the current version of OCTANS Repeater. Figure III-18 : Status.log content Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-24

25 Status.log and Error.log can be moved or deleted from their default directory when OCTANS Repeater is not running. OCTANS Repeater will create new Status.Log and Error.log files in the directory C:\Program Files\IXSEA\OctRepeaterVX_Y\OctansStatus at next restart. Maximum size for the Status.log and Error.log files is set to 1 Mo. File size is checked for when OCTANS repeater is launched. When maximum size is reached, a dialog box will be displayed. User can choose either to continue with the current file or to create a back-up file. In such case, a back-up file of the current.log file is automatically created in the directory C:\Program Files\IXSEA\OctRepeaterVX_Y\OctansStatus. A new.log file is created. Only one.bak file can be stored : at next back-up, the current back-up file will be automatically replaced. III EDITING AND DELETING STATUS.LOG AND ERROR.LOG Status.log and Error.log can be edited during OCTANS operation. Right-click on the mouse button Select Configuration, then OCTANS Log submenu (see Figure III-19) Edit error file : opens the Error.log file with any Notepad configured for. Data are displayed and updated as shown in Figure III-18. Edit Status file : opens the Status file with any Notepad configured for. Data are displayed and updated as shown in Figure III-18. Delete Error File : the file Error.log is deleted. A new Error.log file will be automatically created as soon as one of the following happens : New error occurrence Restart of OCTANS Repeater software Delete Status File : the file Status.log is deleted. A new Status.log file will be automatically created as soon as one of the following happens : New OCTANS status change Restart of OCTANS Repeater software Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-25

26 Figure III-19 : OCTANS Log menu III.14.3 OCTANS SETTLING TIME III ALIGNMENT PHASE When it is powered on, OCTANS finds the North and the vertical axis after a 5 minutes alignment phase. During this alignment phase, data are available, but may be out of specifications in terms of accuracy. Specified accuracy on heading, roll and pitch is reached at the end of the 5 minute alignment phase. All output data values are red-displayed during the alignment phase. They are switched to white-display when alignment is over. OCTANS Status Word bits set to 1 during alignment phase : Bit 0 : Heading unvalid Bit 1 : Roll unvalid Bit 2 : Pitch unvalid Bit 3 : Heave init Bit 5 : OCTANS alignment Bit 27 : H, R, P unvalid This translates into the 6 last bytes of the hexadecimal $PHINF set to 00002F during the alignment phase. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-26

27 III HEAVE FILTER INITIALISATION Heave initialisation occurs at each OCTANS powering on. It is performed in parallel with the OCTANS alignment phase, but lasts roughly 5 minutes longer. During the heave initialisation phase, the heave, surge and sway outputs have not reached full accuracy and are red-displayed. OCTANS Status Word bits set to 1 during heave initialisation phase : Bit 3 : Heave init This translates into the 6 last bytes of the hexadecimal $PHINF set to during the heave initialisation phase. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-27

28 III.15 SYSTEM INFORMATION The dialog box is shown in Figure III-20. This dialog box shows the serial number and firmware version of the system. Figure III-20 : system dialog box III.16 RESTART SYSTEM This repeater function allows to restart all OCTANS algorithms without switching off the power. The following window opens : Just click on Yes for restarting the algorithms. III.17 SAVE CONFIGURATION TO PROM This function allows the user to save all the configuration parameters in PROM. Once this is done, every time the OCTANS is switched OFF and ON again, it will start using the same configuration parameters. When saving to Prom, the OCTANS status Config saved should appear in the Status window within 10 seconds. Part 3 : INSTALLATION AND REPEATER SOFTWARE Page III-28