From f533bed708e401bf3d306f5c600b7f92081eacd4 Mon Sep 17 00:00:00 2001 From: JessamyT Date: Thu, 26 Oct 2023 15:01:08 -0700 Subject: [PATCH] DOCS-1302: Remove imu-vectornav from docs --- docs/components/movement-sensor/_index.md | 3 +-- docs/components/movement-sensor/imu/imu-vectornav.md | 1 + docs/components/movement-sensor/merged.md | 10 +++++----- docs/services/navigation/_index.md | 3 --- static/include/components/apis/movement-sensor.md | 3 ++- 5 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/components/movement-sensor/_index.md b/docs/components/movement-sensor/_index.md index c95b19e168..3b6a835ef3 100644 --- a/docs/components/movement-sensor/_index.md +++ b/docs/components/movement-sensor/_index.md @@ -42,7 +42,6 @@ Model | Description [`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 I2C (**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 @@ -325,7 +324,7 @@ xAngVel := linAccel.X Report the current [compass heading]() in degrees. -Supported by GPS models and `imu-vectornav`. +Supported by GPS models. {{< tabs >}} {{% tab name="Python" %}} diff --git a/docs/components/movement-sensor/imu/imu-vectornav.md b/docs/components/movement-sensor/imu/imu-vectornav.md index 407aee9d2d..0b0a496dc4 100644 --- a/docs/components/movement-sensor/imu/imu-vectornav.md +++ b/docs/components/movement-sensor/imu/imu-vectornav.md @@ -5,6 +5,7 @@ weight: 10 type: "docs" description: "Configure a VectorNav IMU." images: ["/icons/components/imu.svg"] +draft: true # SMEs: Rand --- diff --git a/docs/components/movement-sensor/merged.md b/docs/components/movement-sensor/merged.md index 5dbbef61af..3259f966c9 100644 --- a/docs/components/movement-sensor/merged.md +++ b/docs/components/movement-sensor/merged.md @@ -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"] } @@ -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"] }, @@ -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" >}} diff --git a/docs/services/navigation/_index.md b/docs/services/navigation/_index.md index 4a2469bc39..8390442a39 100644 --- a/docs/services/navigation/_index.md +++ b/docs/services/navigation/_index.md @@ -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: @@ -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/) @@ -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: diff --git a/static/include/components/apis/movement-sensor.md b/static/include/components/apis/movement-sensor.md index 2ab3f25476..23debef959 100644 --- a/static/include/components/apis/movement-sensor.md +++ b/static/include/components/apis/movement-sensor.md @@ -1,10 +1,11 @@ + 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