Skip to content

Commit

Permalink
DOCS-1302: Remove imu-vectornav from docs
Browse files Browse the repository at this point in the history
  • Loading branch information
JessamyT committed Oct 26, 2023
1 parent e335a81 commit f533bed
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 11 deletions.
3 changes: 1 addition & 2 deletions docs/components/movement-sensor/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Model | Description <a name="model-table"></a>
[`gps-nmea-rtk-pmtk`](./gps/gps-nmea-rtk-pmtk/) | [NTRIP-based](https://en.wikipedia.org/wiki/Networked_Transport_of_RTCM_via_Internet_Protocol) [RTK](https://en.wikipedia.org/wiki/Real-time_kinematic_positioning) GPS models using I<sup>2</sup>C (**experimental**)
[`gps-nmea-rtk-serial`](./gps/gps-nmea-rtk-serial/) | [NTRIP-based](https://en.wikipedia.org/wiki/Networked_Transport_of_RTCM_via_Internet_Protocol) [RTK](https://en.wikipedia.org/wiki/Real-time_kinematic_positioning) GPS models using serial communication (**experimental**)
[`imu-wit`](./imu/imu-wit/) | IMUs manufactured by [WitMotion](https://www.wit-motion.com/)
[`imu-vectornav`](./imu/imu-wit/) | IMUs manufactured by [VectorNav](https://www.vectornav.com/products)
[`accel-adxl345`](./adxl345/) | The [Analog Devices ADXL345](https://www.analog.com/en/products/adxl345.html) digital accelerometer
[`viam_visual_odometry`](./viam-visual-odometry/) | A [modular resource](/modular-resources/) that derives movement data from a [camera](/components/camera/) stream
[`gyro-mpu6050`](./mpu6050/) | A gyroscope/accelerometer manufactured by TDK InvenSense
Expand Down Expand Up @@ -325,7 +324,7 @@ xAngVel := linAccel.X

Report the current [compass heading](<https://en.wikipedia.org/wiki/Heading_(navigation)>) in degrees.

Supported by GPS models and `imu-vectornav`.
Supported by GPS models.

{{< tabs >}}
{{% tab name="Python" %}}
Expand Down
1 change: 1 addition & 0 deletions docs/components/movement-sensor/imu/imu-vectornav.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ weight: 10
type: "docs"
description: "Configure a VectorNav IMU."
images: ["/icons/components/imu.svg"]
draft: true
# SMEs: Rand
---

Expand Down
10 changes: 5 additions & 5 deletions docs/components/movement-sensor/merged.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
```json {class="line-numbers linkable-line-numbers"}
{
"position": ["gps1"],
"orientation": ["vectornav"],
"orientation": ["imu-wit"],
"compass_heading": ["gps1"],
"angular_velocity": ["vectornav", "mpu6050"],
"angular_velocity": ["imu-wit", "mpu6050"],
"linear_velocity": ["gps1"],
"linear_acceleration": ["adxl345"]
}
Expand Down Expand Up @@ -101,9 +101,9 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
"namespace": "rdk",
"attributes": {
"position": ["gps1"],
"orientation": ["vectornav"],
"orientation": ["imu-wit"],
"compass_heading": ["gps1"],
"angular_velocity": ["vectornav", "mpu6050"],
"angular_velocity": ["imu-wit", "mpu6050"],
"linear_velocity": ["gps1"],
"linear_acceleration": ["adxl345"]
},
Expand Down Expand Up @@ -135,6 +135,6 @@ Configure an array of the `name` of each movement sensor you want to add to your

Note that only one sensor from each array can be used to retrieve each type of reading.
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 `"vectornav"` and `"mpu6050"` support returning `angular_velocity`, `"mpu6050"` is only used to read angular velocity on the robot if `"vectornav"` returns 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" >}}
3 changes: 0 additions & 3 deletions docs/services/navigation/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -629,7 +629,6 @@ Then use the movement sensor API's [`GetCompassHeading()`](/components/movement-
The following {{< glossary_tooltip term_id="model" text="models" >}} of [movement sensor](/components/movement-sensor/) take orientation measurements:

- [imu-wit](/components/movement-sensor/imu/imu-wit/)
- [imu-vectornav](/components/movement-sensor/imu/imu-vectornav/)

An example of an `Orientation` reading:

Expand All @@ -652,7 +651,6 @@ Then use the movement sensor API's [`GetOrientation()`](/components/movement-sen
The following {{< glossary_tooltip term_id="model" text="models" >}} of the [movement sensor](/components/movement-sensor/) component take angular velocity measurements:

- [imu-wit](/components/movement-sensor/imu/imu-wit/)
- [imu-vectornav](/components/movement-sensor/imu/imu-vectornav/)
- [wheeled-odometry](/components/movement-sensor/wheeled-odometry/)
- [gyro-mpu6050](/components/movement-sensor/mpu6050/)

Expand Down Expand Up @@ -716,7 +714,6 @@ The following {{< glossary_tooltip term_id="model" text="models" >}} of [movemen

- [accel-adxl345](/components/movement-sensor/adxl345/)
- [imu-wit](/components/movement-sensor/imu/imu-wit/)
- [imu-vectornav](/components/movement-sensor/imu/imu-vectornav/)
- [gyro-mpu6050](/components/movement-sensor/mpu6050/)

An example of a `Linear Acceleration` reading:
Expand Down
3 changes: 2 additions & 1 deletion static/include/components/apis/movement-sensor.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
<!-- prettier-ignore -->
Method Name | Description | Models That Support This Method
----------- | ----------- | -------------------------------
[`GetPosition`](/components/movement-sensor/#getposition) | Get the current latitude, longitude and altitude. | GPS models
[`GetLinearVelocity`](/components/movement-sensor/#getlinearvelocity) | Get the current linear velocity as a 3D vector. | GPS models
[`GetAngularVelocity`](/components/movement-sensor/#getangularvelocity) | Get the current angular velocity as a 3D vector. | IMU models and `gyro-mpu6050`
[`GetLinearAcceleration`](/components/movement-sensor/#getlinearacceleration) | Get the current linear acceleration as a 3D vector. | IMU models, `accel-adxl345`, and `gyro-mpu6050`
[`GetCompassHeading`](/components/movement-sensor/#getcompassheading) | Get the current compass heading in degrees. | GPS models and `imu-vectornav`
[`GetCompassHeading`](/components/movement-sensor/#getcompassheading) | Get the current compass heading in degrees. | GPS models
[`GetOrientation`](/components/movement-sensor/#getorientation) | Get the current orientation. | IMU models
[`GetProperties`](/components/movement-sensor/#getproperties) | Get the supported properties of this sensor. | all models
[`GetAccuracy`](/components/movement-sensor/#getaccuracy) | Get the accuracy of the various sensors. | GPS models
Expand Down

0 comments on commit f533bed

Please sign in to comment.