Skip to content

Commit 3d54189

Browse files
committed
Fix documentation error
1 parent 899fb10 commit 3d54189

10 files changed

Lines changed: 22 additions & 23 deletions

File tree

docs/dvl/bluerov-integration-dvl-ugps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ Before successful sensor fusion of Underwater GPS and DVL the following conditio
3939
* Make sure that the compass calibration was successful by comparing the ROV orientation shown in the map in QGroundControl to the actual ROV orientation. Land-marks like a coast-line or an analogue compass can help.
4040

4141
!!! Note
42-
When you want to use the position estimate for *control* of the ROV and the UGPS Topside is on land, it is highly recommended setting up the Underwater GPS to use static position and static heading mode. Alternatively when the UGPS Topside position is not static (on a boat or similar) you need to input heading and position data from an external GPS compass. [Details can be found here](../underwater-gps/gui/settings.md#topside-setup).
42+
When you want to use the position estimate for *control* of the ROV and the UGPS Topside is on land, it is highly recommended setting up the Underwater GPS to use static position and static heading mode. Alternatively when the UGPS Topside position is not static (on a boat or similar) you need to input heading and position data from an external GPS compass. [Details can be found here](../underwater-gps/interface/gui/settings.md#topside-setup).
4343

4444
If you don't follow this advice, the position provided by the Underwater GPS will have more noise ("jump" too much) and also drift over time. This might cause the position hold mode to not work properly.
4545

@@ -67,7 +67,7 @@ Now both sensors should be considered for the position estimate of the ROV. You
6767

6868
This mode can be useful when you experience issues with sensor fusion (Mode "DVL+UGPS" above) or not all the described conditions in above section are met. Otherwise, we recommend using Mode "DVL+UGPS".
6969

70-
In this configuration the BlueROV will base its position estimate *updates* on velocity input from the DVL as well as accelerometer, gyroscope, compass and pressure sensor but not the Underwater GPS. Although the Underwater GPS is connected and running it will only be used to *initialize* the global ROV position at the beginning. QGroundControl (or the new Cockpit) will show the ROV position estimate based on the DVL only while the [Underwater GPS GUI](../underwater-gps/gui/position.md) will show the position based on the Underwater GPS.
70+
In this configuration the BlueROV will base its position estimate *updates* on velocity input from the DVL as well as accelerometer, gyroscope, compass and pressure sensor but not the Underwater GPS. Although the Underwater GPS is connected and running it will only be used to *initialize* the global ROV position at the beginning. QGroundControl (or the new Cockpit) will show the ROV position estimate based on the DVL only while the [Underwater GPS GUI](../underwater-gps/interface/gui/position.md) will show the position based on the Underwater GPS.
7171

7272
!!! Note
7373
The setup procedure below is very similar to when you only use the DVL without a running Underwater GPS. That case is described [here](bluerov-integration.md#software).

docs/modem-m16/modem-m16-gui.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ Follow the installation guide provided in README at [github for examples with Mo
2222

2323

2424
## GUI layout example:
25-
![](../../img/m16-gui.png)
25+
![](../img/m16-gui.png)
2626

2727
---

docs/underwater-gps/interface/gui/diagnostic-report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
On the diagnostic report page you can generate a report if you are experiencing problems with the UPGS. First type a small description of the problem you are experiencing and then click on the generate button. Send the resulting .wdat file to support@waterlinked.com.
44

5-
![diagnostics_report](../../img/diagnostic_report_g2.png)
5+
![diagnostics_report](../../../img/diagnostic_report_g2.png)
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# Position view
22

3-
The Underwater GPS GUI is web based. Using your favorite web browser, go the IP address as defined [here](../network-settings.md). We currently support and recommend Chrome, Firefox, Safari and Edge.
3+
The Underwater GPS GUI is web based. Using your favorite web browser, go the IP address as defined [here](../../network-settings.md). We currently support and recommend Chrome, Firefox, Safari and Edge.
44

55
!!! Note
66
You will need **internet access** on your computer that are showing the GUI if you also want to see the map and not only relative position to the locator. This is because the map is fetched from the internet.
77

88
!!! Attention
99
Internet Explorer is not supported as of now.
1010

11-
![gui_global_position](../../img/gui_global_position_r100.png)
11+
![gui_global_position](../../../img/gui_global_position_r100.png)

docs/underwater-gps/interface/gui/settings.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Settings
22

3-
![gui_settings_topside_setup](../../img/gui_settings_topside_setup.png)
3+
![gui_settings_topside_setup](../../../img/gui_settings_topside_setup.png)
44

55
## Locator setup
66

@@ -46,7 +46,7 @@ For best performance on boats or similar with a moving topside unit, we recommen
4646

4747
If the topside unit/antenna is at a globally stationary position (like a jetty) the *static* configuration of position and heading will give best accuracy of the system. Below you can see how the position and heading is set to static. Clicking on the map button opens a map window to help you input the static position.
4848

49-
![gui_settings_topside_setup_static_pos_marked](../../img/gui_settings_topside_setup_static_pos_marked.png)
49+
![gui_settings_topside_setup_static_pos_marked](../../../img/gui_settings_topside_setup_static_pos_marked.png)
5050

5151
## User preferences
5252

docs/underwater-gps/interface/ugps-gui.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -76,18 +76,18 @@ In the diagnostic plot you should see the signal from all 4 Receivers. The signa
7676

7777
Acoustic interference can be observed in the diagnostic plot. Echo sounders from your boat or nearby boats typically appears like burst noise.
7878

79-
![diagnostics2](../../../img/diagnostics_2.png)
79+
![diagnostics2](../../img/diagnostics_2.png)
8080

8181
If it is coming from your boat, try to turn off the echo sounder to improve position accuracy.
8282
In case of interference from other acoustic sources, use the GUI to try other channels to avoid the interference.
8383

8484
!!! Tip
85-
Typically, NSD (_Noise spectral density_, displayed in the [Diagnostic](../underwater-gps/interface/ugps-gui.md#diagnostics) pane of the GUI) is around -100 dBm (in the units of version 3.3.0 or later of the software; 15 nV/sqrt(Hz) in the units of earlier software versions), or a little higher or lower. If it is much higher than this, it is likely that there is acoustic interference in the chosen channel, and a different channel should be tried.
85+
Typically, NSD (_Noise spectral density_, displayed in the [Diagnostic](gui/diagnostic.md) pane of the GUI) is around -100 dBm (in the units of version 3.3.0 or later of the software; 15 nV/sqrt(Hz) in the units of earlier software versions), or a little higher or lower. If it is much higher than this, it is likely that there is acoustic interference in the chosen channel, and a different channel should be tried.
8686

8787
Note in particular that acoustic devices quite commonly operate at frequencies lying in Channel 1.
8888

8989
!!! Tip
90-
If the NSD values are normal, signal quality is mainly indicated by the RSSI values (_Received signal strength indicator_, displayed in the [Diagnostic](../underwater-gps/interface/ugps-gui.md#diagnostics) pane of the GUI). As long as the RSSI values are not too far below the NSD values, the signal strength should be at usable levels.
90+
If the NSD values are normal, signal quality is mainly indicated by the RSSI values (_Received signal strength indicator_, displayed in the [Diagnostic](gui/diagnostic.md) pane of the GUI). As long as the RSSI values are not too far below the NSD values, the signal strength should be at usable levels.
9191

9292
The UGPS system uses advanced signal processing techniques and can work even with rather weak signals, but an RSSI of -125 dBm or so (in the units of version 3.3.0 or later of the software; -45 dBnW in the units of earlier software versions) is around the lowest possible for an NSD of roughly -100 dBm.
9393

docs/underwater-gps/interface/warnings.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,5 +11,4 @@ Warnings that you might experience while using the UGPS.
1111
| Receiver N not detected. Please verify connection. | Receiver N is not detected by the Master-D1. Verify connection. |
1212
| External satellite position is required but not received. | External position is selected, but not received via the [API](http://demo.waterlinked.com/swagger/#/external/external#SetMaster). Typically this is an external software not started or not working. |
1313
| External orientation is required but not received. | External orientation is selected, but not received via the [API](http://demo.waterlinked.com/swagger/#/external/external#SetMaster). Typically this is an external software not started or not working. |
14-
| IMU is not calibrated: position will not be accurate. Please rotate the kit to calibrate or use external orientation source. | See [IMU calibration](../hardware.md#imu-calibration) for details on how calibrate. |
1514
| GPS has no position, please provide me with an unobstructed view of the sky. | The Underwater GPS needs GPS lock for time sync proposes. Move the Topside to another location where it has better view of the sky. |

docs/underwater-gps/ugps-sysconfig.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ In the Baseline window in the GUI, you adjust the placement of your antenna/rece
66

77
## Basline settings
88
Go to [Baseline](../underwater-gps/interface/ugps-gui.md#baseline) from the left menu in the GUI. </br>
9-
In the tab at the top select **antenna** or **receivers** according to whether an [antenna](../antenna.md) or loose [receivers](../receiver-d1.md) are used.
9+
In the tab at the top select **antenna** or **receivers** according to whether an [antenna](antenna.md) or loose [receivers](receiver-d1.md) are used.
1010

1111
In the receiver view, in the graphical configuration panel, you either drag and drop the receivers to their actual position in relation to the topside, or you fill in the position manually in the input fields below the panel. (You might need to drag the receivers apart for the manual input fields to become visible) Remember to fill inn the receivers depth.
1212

1313
In the antenna view you need to open Advanced Settings to fill in the position of the antenna in relation to the topside.
1414

1515
Improved positioning will likely be obtained by **limiting the search area** : Restrict the search area as far as possible by dragging and dropping the arrows in the graphical configuration panel.
1616

17-
![Receiver setup](../../img/receiver_placemet_g2.png)
17+
![Receiver setup](../img/receiver_placemet_g2.png)
1818

1919
## Locator and topside settings
2020
Cofigurations of the topside and locator settings is conducted in [Settings](../underwater-gps/interface/ugps-gui.md#settings), from the left menu in the GUI.
@@ -56,7 +56,7 @@ For best performance on boats or similar, with a moving topside unit, we recomme
5656

5757
If the topside unit/antenna is at a globally stationary position (like a jetty) the *static* configuration of position and heading will give best accuracy of the system. Below you can see how the position and heading is set to static. Clicking on the map button opens a map window to help you input the static position.
5858

59-
![gui_settings_topside_setup_static_pos_marked](../../img/gui_settings_topside_setup_static_pos_marked.png)
59+
![gui_settings_topside_setup_static_pos_marked](../img/gui_settings_topside_setup_static_pos_marked.png)
6060

6161
#### User preferences
6262

docs/underwater-gps/ugps-topside.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,4 +132,4 @@ The master electronics has an built in IMU used to provide the orientation of th
132132

133133
### IMU Calibration
134134

135-
For the IMU to work properly it needs to be calibrated. If the system is started on a new location a new calibration is needed for the IMU to work as intended. The IMU is calibrated in the [settings page](gui/settings.md) of the user interface.
135+
For the IMU to work properly it needs to be calibrated. If the system is started on a new location a new calibration is needed for the IMU to work as intended. The IMU is calibrated in the [settings page](interface/gui/settings.md) of the user interface.

mkdocs.yml

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -62,13 +62,13 @@ nav:
6262
- LED: underwater-gps/interface/ugps-led.md
6363
- Wiring: underwater-gps/interface/ugps-wiring.md
6464
- Warnings: underwater-gps/interface/warnings.md
65-
# - GUI:
66-
# - Position: underwater-gps/interface/gui/position.md
67-
# - Baseline: underwater-gps/interface/gui/receivers.md
68-
# - Settings: underwater-gps/interface/gui/settings.md
69-
# - Diagnostic: underwater-gps/interface/gui/diagnostic.md
70-
# - Diagnostic report: underwater-gps/interface/gui/diagnostic-report.md
71-
# - Demo: underwater-gps/interface/gui/demo-gui.md
65+
- GUI:
66+
- Position: underwater-gps/interface/gui/position.md
67+
- Baseline: underwater-gps/interface/gui/receivers.md
68+
- Settings: underwater-gps/interface/gui/settings.md
69+
- Diagnostic: underwater-gps/interface/gui/diagnostic.md
70+
- Diagnostic report: underwater-gps/interface/gui/diagnostic-report.md
71+
- Demo: underwater-gps/interface/gui/demo-gui.md
7272
- Hardware setup:
7373
- System setup: underwater-gps/ugps-sys-setup.md
7474
- Components:

0 commit comments

Comments
 (0)