Skip to content

Commit

Permalink
DOCS-1359: Improve movement-sensor control sections (#2144)
Browse files Browse the repository at this point in the history
  • Loading branch information
npentrel authored Nov 8, 2023
1 parent a71c8eb commit 3cd0219
Show file tree
Hide file tree
Showing 21 changed files with 63 additions and 16 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 6 additions & 1 deletion docs/components/movement-sensor/adxl345.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,4 +178,9 @@ Inside the `freefall` object, you can include the following attributes:
| `threshold` | float | Optional | The acceleration on each axis is compared with this value to determine if a free-fall event occurred (in milligrams, between `0` and `15,937`). <br> Default: `437.5` |
| `time_ms` | float | Optional | Unsigned time value representing the minimum time that the value of all axes must be less than `threshold` to generate a free-fall interrupt (in milliseconds, between 0 and 1,275). <br> Default: `160` |

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.

{{<imgproc src="/components/movement-sensor/movement-sensor-control-tab-adxl345.png" resize="400x" declaredimensions=true alt="The movement sensor component in the control tab">}}
5 changes: 4 additions & 1 deletion docs/components/movement-sensor/cameramono.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,4 +99,7 @@ Edit and fill in the attributes as applicable.
| `camera` | string | **Required** | The `name` of the [camera](/components/camera/) you want to use for visual odometry. |
| `motion_estimation_config` | object | **Required** | See [motionestimation.go in RDK](https://github.com/viamrobotics/rdk/blob/99f62a1640f4c267b744bdfc2924e9fd4f7a3c60/vision/odometry/motionestimation.go). |

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
8 changes: 7 additions & 1 deletion docs/components/movement-sensor/fake.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,10 @@ Edit and fill in the attributes as applicable.
{{% /tab %}}
{{< /tabs >}}

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
The sections in the panel include the position, orientation, angular velocity, linear velocity, and linear acceleration.

{{<imgproc src="/components/movement-sensor/movement-sensor-control-tab.png" resize="800x" declaredimensions=true alt="The movement sensor component in the control tab">}}
2 changes: 1 addition & 1 deletion docs/components/movement-sensor/gps/gps-nmea-rtk-pmtk.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,4 @@ If you are not sure where to start, check out this [GPS-RTK2 Hookup Guide from S

{{% /alert %}}

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
{{< readfile "/static/include/components/test-control/movement-sensor-gps-control.md" >}}
2 changes: 1 addition & 1 deletion docs/components/movement-sensor/gps/gps-nmea-rtk-serial.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,4 @@ If you are not sure where to start, check out this [GPS-RTK2 Hookup Guide from S

{{% /alert %}}

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
{{< readfile "/static/include/components/test-control/movement-sensor-gps-control.md" >}}
2 changes: 1 addition & 1 deletion docs/components/movement-sensor/gps/gps-nmea.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,4 +215,4 @@ For a movement sensor communicating over I<sup>2</sup>C, you'll need a `i2c_attr
{{% /tab %}}
{{< /tabs >}}

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
{{< readfile "/static/include/components/test-control/movement-sensor-gps-control.md" >}}
2 changes: 1 addition & 1 deletion docs/components/movement-sensor/imu/imu-vectornav.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,4 +117,4 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
| `spi_baud_rate` | int | **Required** | The rate at which data is sent from the IMU. <br> Default: `115200` |
| `polling_frequency_hz` | int | **Required** | How many times per second the sensor is polled. |

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
{{< readfile "/static/include/components/test-control/movement-sensor-imu-control.md" >}}
2 changes: 1 addition & 1 deletion docs/components/movement-sensor/imu/imu-wit.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,4 +111,4 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
| `serial_path` | string | **Required** | The full filesystem path to the serial device, starting with <file>/dev/</file>. With your serial device connected, you can run `sudo dmesg \| grep tty` to show relevant device connection log messages, and then match the returned device name, such as `ttyS0`, to its device file, such as <file>/dev/ttyS0</file>. If you omit this attribute, Viam will attempt to automatically detect the path. |
| `serial_baud_rate` | int | Optional | The rate at which data is sent from the sensor over the serial connection. Valid rates are `9600` and `115200`. The default rate will work for all models. _Only the HWT901B can have a different serial baud rate._ Refer to your model's data sheet. <br>Default: `115200` |

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
{{< readfile "/static/include/components/test-control/movement-sensor-imu-control.md" >}}
5 changes: 4 additions & 1 deletion docs/components/movement-sensor/merged.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,4 +137,7 @@ Note that only one sensor from each array can be used to retrieve each type of r
Your robot uses the first sensor in the array that has implemented the relevant API method in its model and does not raise an error at runtime.
For instance, in the **JSON Example** above, if both `"imu-wit"` and `"mpu6050"` support returning `angular_velocity`, `"mpu6050"` is only used to read angular velocity on the robot if `"imu-wit"` returns an error at runtime.

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
8 changes: 7 additions & 1 deletion docs/components/movement-sensor/mpu6050.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,4 +115,10 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
| `i2c_bus` | string | **Required** | The `name` of the [I<sup>2</sup>C bus configured](/components/board/#i2cs) on your [board](/components/board/) wired to this device. |
| `use_alt_i2c_address` | boolean | Optional | Depends on whether you wire AD0 low (leaving the default address of 0x68) or high (making the address 0x69). If high, set `true`. If low, set `false`. <br> Default: `false` |

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
The sections in the panel include the angular velocity and linear acceleration.

{{<imgproc src="/components/movement-sensor/movement-sensor-control-tab-mpu6050.png" resize="800x" declaredimensions=true alt="The movement sensor component in the control tab">}}
5 changes: 4 additions & 1 deletion docs/components/movement-sensor/viam-visual-odometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,4 +255,7 @@ The following attributes are available to configure the `monocular-visual-odomet

See the [ORB openCV documentation](https://docs.opencv.org/3.4/db/d95/classcv_1_1ORB.html) for more details.

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
5 changes: 4 additions & 1 deletion docs/components/movement-sensor/wheeled-odometry.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,4 +140,7 @@ The following attributes are available for `wheeled-odometry` movement sensors:
| `right_motors` | object | **Required** | A list containing the name of each of the bases' right [position-reporting motors](/components/motor/gpio/). |
| `time_interval_msec` | number | Optional | The time in milliseconds between each wheeled odometry calculation.<br>Default: `500.0`</br> |

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
7 changes: 6 additions & 1 deletion docs/micro-rdk/movement-sensor/accel-adxl345.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,9 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
| `i2c_bus` | string | **Required** | The `name` of the I<sup>2</sup>C bus on the [board](/micro-rdk/board/) wired to this device. |
| `use_alt_i2c_address` | bool | Optional | Depends on whether you wire SDO low (leaving the default address of 0x53) or high (making the address 0x1D). If high, set true. If low, set false or omit the attribute. <br> Default: `false` |

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.

{{<imgproc src="/components/movement-sensor/movement-sensor-control-tab-adxl345.png" resize="400x" declaredimensions=true alt="The movement sensor component in the control tab">}}
8 changes: 7 additions & 1 deletion docs/micro-rdk/movement-sensor/gyro-mpu6050.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,10 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
| `i2c_bus` | string | **Required** | The `name` of the [I<sup>2</sup>C bus configured](/components/board/#i2cs) on your [board](/components/board/) wired to this device. |
| `use_alt_i2c_address` | boolean | Optional | Depends on whether you wire AD0 low (leaving the default address of 0x68) or high (making the address 0x69). If high, set `true`. If low, set `false`. <br> Default: `false` |

{{< readfile "/static/include/components/test-control/movement-sensor-control.md" >}}
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
The sections in the panel include the angular velocity and linear acceleration.

{{<imgproc src="/components/movement-sensor/movement-sensor-control-tab-mpu6050.png" resize="800x" declaredimensions=true alt="The movement sensor component in the control tab">}}
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
The sections in the panel include the position, orientation, angular velocity, linear velocity, and linear acceleration.
The sections in the panel include the position, linear velocity and compass heading.

{{<imgproc src="/components/movement-sensor/movement-sensor-control-tab.png" resize="800x" declaredimensions=true alt="The movement sensor component in the control tab">}}
{{<imgproc src="/components/movement-sensor/movement-sensor-control-tab-gps.png" resize="800x" declaredimensions=true alt="The movement sensor component in the control tab">}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
## Test the movement sensor

After you configure your movement sensor, navigate to the [Control tab](/manage/fleet/robots/#control) and select the dedicated movement sensor dropdown panel.
This panel presents the data collected by the movement sensor.
The sections in the panel include the orientation, angular velocity and linear acceleration.

{{<imgproc src="/components/movement-sensor/movement-sensor-control-tab-imu.png" resize="800x" declaredimensions=true alt="The movement sensor component in the control tab">}}

0 comments on commit 3cd0219

Please sign in to comment.