Skip to content

Commit

Permalink
DOCS-2957: Change docs for Modularize Components epic (#3668)
Browse files Browse the repository at this point in the history
  • Loading branch information
martha-johnston authored Nov 12, 2024
1 parent b1081dd commit bcbdd0f
Show file tree
Hide file tree
Showing 74 changed files with 125 additions and 3,533 deletions.
Binary file removed assets/components/board/beaglebone-ui-config.png
Binary file not shown.
Binary file removed assets/components/board/customlinux-ui-config.png
Binary file not shown.
Binary file removed assets/components/board/jetson-ui-config.png
Binary file not shown.
Binary file removed assets/components/board/numato-ui-config.png
Binary file not shown.
Binary file removed assets/components/board/odroidc4-ui-config.png
Binary file not shown.
Binary file removed assets/components/board/orangepi-ui-config.png
Binary file not shown.
Binary file removed assets/components/board/pca9685-ui-config.png
Binary file not shown.
Binary file removed assets/components/board/ti-ui-config.png
Binary file not shown.
Binary file removed assets/components/board/upboard-ui-config.png
Binary file not shown.
Binary file removed assets/components/encoder/configure-ams.png
Binary file not shown.
Binary file not shown.
Binary file removed assets/components/motor/28byj48-config-ui.png
Binary file not shown.
Binary file removed assets/components/motor/28byj48-wiring.png
Binary file not shown.
Binary file removed assets/components/motor/roboclaw-ui-config.png
Binary file not shown.
Binary file removed assets/components/motor/tmc5072-config-ui.png
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
78 changes: 64 additions & 14 deletions docs/appendix/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,25 @@ aliases:
- "/components/camera/dual-stream/"
- "/components/camera/align-color-depth-extrinsics/"
- "/components/camera/align-color-depth-homography/"
- "/components/board/customlinux/"
- "/components/board/jetson/"
- "/components/board/pca9685/"
- "/components/board/ti/"
- "/components/gripper/softrobotics/"
- "/components/motor/encoded-motor/"
- "/components/motor/gpiostepper/"
- "/components/motor/roboclaw/"
- "/components/movement-sensor/adxl345/"
- "/components/movement-sensor/dual-gps-rtk/"
- "/components/movement-sensor/gps-nmea-rtk-pmtk/"
- "/components/movement-sensor/gps-nmea-rtk-serial/"
- "/components/movement-sensor/gps-nmea/"
- "/components/movement-sensor/wheeled-odometry/"
- "/components/power-sensor/ina219/"
- "/components/power-sensor/ina226/"
- "/components/sensor/bme280/"
- "/components/sensor/ds18b20/"
- "/components/sensor/sensirion-sht3xd/"
layout: "changelog"
outputs:
- rss
Expand All @@ -21,15 +40,46 @@ date: "2024-09-18"

<!-- If there is no concrete date for a change that makes sense, use the end of the month it was released in. -->

{{% changelog date="2024-11-05" color="added" title="TFLite model moved to module" %}}

The `TFLite CPU` ML model service has moved to a [module](https://app.viam.com/module/viam/tflite_cpu).

{{% /changelog %}}

{{% changelog date="2024-10-28" color="added" title="Deprecate builtin pi model" %}}

The built-in `pi` sensor and board models have moved to the [`raspberry-pi` module](https://github.com/viam-modules/raspberry-pi).
{{% changelog date="2024-11-12" color="added" title="Builtin models moved to modules" %}}

The following resource models have moved to modules.

<!-- prettier-ignore -->
| Resource | Model |
| -------- | ----- |
| board | [`customlinux`](https://github.com/viam-modules/customlinux/) |
| board | [`jetson`](https://github.com/viam-modules/nvidia) |
| board | [`pca9685`](https://github.com/viam-modules/pca/tree/main) |
| board | [`odroid`](https://github.com/viam-modules/hardkernel) |
| board | [`ti`](https://github.com/viam-modules/texas-instruments) |
| board | [`pi`](https://github.com/viam-modules/raspberry-pi) |
| board | [`orange-pi`](https://github.com/viam-modules/orange-pi) |
| board | [`upboard`](https://github.com/viam-modules/up) |
| motor | [`tmc5072`](https://github.com/viam-modules/analog-devices) |
| motor | [`28byj-48`](https://github.com/viam-modules/uln2003) |
| encoder | [`ams-as5048`](https://github.com/viam-modules/ams/) |
| movement sensor | [`adxl345`](https://github.com/viam-modules/analog-devices) |
| movement sensor | [`dual-gps-rtk`](https://github.com/viam-modules/gps/) |
| movement sensor | [`gps-nmea-rtk-pmtk`](https://github.com/viam-modules/gps/) |
| movement sensor | [`gps-nmea-rtk-serial`](https://github.com/viam-modules/gps/) |
| movement sensor | [`gps-nmea`](https://github.com/viam-modules/gps/) |
| movement sensor | [`imu-wit`](https://github.com/viam-modules/wit-motion) |
| movement sensor | [`imu-wit-hwt905`](https://github.com/viam-modules/wit-motion) |
| movement sensor | [`mpu6050`](https://github.com/viam-modules/tdk-invensense) |
| power sensor | [`ina219`](https://github.com/viam-modules/texas-instruments) |
| power sensor | [`ina226`](https://github.com/viam-modules/texas-instruments) |
| sensor | [`bme280`](https://github.com/viam-modules/bosch) |
| sensor | [`sensirion-sht3xd`](https://github.com/viam-modules/sensirion) |
| sensor | [`pi`](https://github.com/viam-modules/raspberry-pi) |
| ML model | [`TFLite CPU`](https://app.viam.com/module/viam/tflite_cpu) |

The following models were removed:

| gripper | `softrobotics` |
| motor | `encoded-motor` |
| motor | `gpiostepper` |
| motor | `roboclaw` |
| sensor | `ds18b20` |

{{% /changelog %}}

Expand Down Expand Up @@ -221,7 +271,7 @@ You can use the `fragment_mods` objects to be able to deploy a fragment to a fle

{{% changelog date="2024-03-01" color="added" title="Dual GPS movement sensor" %}}

You can now use the [dual GPS movement sensor component](/components/movement-sensor/dual-gps-rtk/) to integrate a movement sensor that employs two GPS sensors into your machine.
You can now use the [dual GPS movement sensor component](https://github.com/viam-modules/gps) to integrate a movement sensor that employs two GPS sensors into your machine.
The dual GPS movement sensor calculates a compass heading from both GPS sensors, and returns the midpoint position between the two sensors as its position.

{{% /changelog %}}
Expand Down Expand Up @@ -391,7 +441,7 @@ To learn more, see [this tutorial](/tutorials/configure/pet-photographer/) on cr

{{% changelog date="2023-08-31" color="added" title="Configure a custom Linux board" %}}

You can now use boards like the [Mediatek Genio 500 Pumpkin](https://ologicinc.com/portfolio/mediateki500/) that run Linux operating systems with the [`customlinux` board model](/components/board/customlinux/).
You can now use boards like the [Mediatek Genio 500 Pumpkin](https://ologicinc.com/portfolio/mediateki500/) that run Linux operating systems with the [`customlinux` board model](https://github.com/viam-modules/customlinux/).

{{% /changelog %}}

Expand Down Expand Up @@ -1023,7 +1073,7 @@ The base control UI previously always sent 100% power to the base's motors.

{{% changelog date="2023-01-31" color="added" title="New encoder model: AMS AS5048" %}}

The [AMS AS5048](/components/encoder/ams-as5048/) is now supported.
The [AMS AS5048](https://github.com/viam-modules/ams) is now supported.

{{% /changelog %}}

Expand Down Expand Up @@ -1063,8 +1113,8 @@ You can now supply kinematic information using URDF files when implementing your

There are two new movement sensor {{< glossary_tooltip term_id="model" text="models" >}}:

- [ADXL345](/components/movement-sensor/adxl345/): A 3-axis accelerometer
- [MPU-6050](/components/movement-sensor/mpu6050/): A 6-axis accelerometer and gyroscope
- [ADXL345](https://github.com/viam-modules/analog-devices): A 3-axis accelerometer
- [MPU-6050](https://github.com/viam-modules/tdk-invensense): A 6-axis accelerometer and gyroscope

{{% /changelog %}}

Expand Down
2 changes: 1 addition & 1 deletion docs/appendix/try-viam/rover-resources/rover-tutorial-1.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ For more information, see [Camera Component](/components/camera/).

{{<imgproc src="appendix/try-viam/rover-resources/viam-rover/accelerometer.jpg" resize="400x" declaredimensions=true alt="A ADXL345 accelerometer" >}}

The [ADXL345](/components/movement-sensor/adxl345/) sensor manufactured by Analog Devices is a digital 3-axis accelerometer that can read acceleration up to ±16g for high-resolution (13-bit) measurements.
The [ADXL345](https://github.com/viam-modules/analog-devices/) sensor manufactured by Analog Devices is a digital 3-axis accelerometer that can read acceleration up to ±16g for high-resolution (13-bit) measurements.
You can access it with a SPI (3-wire or 4-wire) or I<sup>2</sup>C digital interface.

In Viam, you can configure it as a [movement sensor component](/components/movement-sensor/).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ The fragment adds the following components to your machine's JSON configuration:
- Wheel circumference: 381 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- An [accelerometer](/components/movement-sensor/mpu6050/)
- A [power sensor](/components/power-sensor/ina219/)
- An [accelerometer](https://github.com/viam-modules/tdk-invensense/)
- A [power sensor](https://github.com/viam-modules/texas-instruments/)

For information about how to configure components yourself when you are not using the fragment, click the links on each component above.
To see the configured pin numbers and other values specific to this fragment, [view it in the app](https://app.viam.com/fragment?id=7c413f24-691d-4ae6-a759-df3654cfe4c8).
Expand Down Expand Up @@ -82,8 +82,8 @@ The fragment adds the following components to your machine's JSON configuration:
- Wheel circumference: 381 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- An [accelerometer](/components/movement-sensor/mpu6050/)
- A [power sensor](/components/power-sensor/ina219/)
- An [accelerometer](https://github.com/viam-modules/tdk-invensense/)
- A [power sensor](https://github.com/viam-modules/texas-instruments/)

For information about how to configure components yourself when you are not using the fragment, click the links on each component above.
To see the configured pin numbers and other values specific to this fragment, [view it in the app](https://app.viam.com/fragment?id=7c413f24-691d-4ae6-a759-df3654cfe4c8).
Expand Down Expand Up @@ -114,7 +114,7 @@ The fragment adds the following components to your machine's JSON configuration:
- Wheel circumference: 217 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- An [accelerometer](/components/movement-sensor/adxl345/)
- An [accelerometer](https://github.com/viam-modules/analog-devices/)

{{% alert title="Info" color="info" %}}

Expand Down Expand Up @@ -151,8 +151,8 @@ The fragment adds the following components to your machine's JSON configuration:
- Wheel circumference: 381 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- An [accelerometer](/components/movement-sensor/mpu6050/)
- A [power sensor](/components/power-sensor/ina219/)
- An [accelerometer](https://github.com/viam-modules/tdk-invensense/)
- A [power sensor](https://github.com/viam-modules/texas-instruments/)

For information about how to configure components yourself when you are not using the fragment, click the links on each component above.
To see the configured pin numbers and other values specific to this fragment, [view it in the app](https://app.viam.com/fragment?id=747e1f43-309b-4311-b1d9-1dfca45bd097).
Expand Down Expand Up @@ -182,8 +182,8 @@ The fragment adds the following components to your machine's JSON configuration:
- Wheel circumference: 381 mm
- Spin slip factor: 1
- A webcam [camera](/components/camera/webcam/)
- An [accelerometer](/components/movement-sensor/mpu6050/)
- A [power sensor](/components/power-sensor/ina219/)
- An [accelerometer](https://github.com/viam-modules/tdk-invensense/)
- A [power sensor](https://github.com/viam-modules/texas-instruments/)

For information about how to configure components yourself when you are not using the fragment, click the links on each component above.
To see the configured pin numbers and other values specific to this fragment, [view it in the app](https://app.viam.com/fragment?id=6208e890-8400-4197-bf0f-e8ddeca4e157).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ Note that these boards require additional parts to be purchased and will not wor

The MPU6050 sensor is a digital 6-axis accelerometer or gyroscope that can read acceleration and angular velocity.
You can access it through the I2C digital interface.
You configure it with Viam on your machine as a [movement sensor](/components/movement-sensor/mpu6050/).
You configure it with Viam on your machine as a [movement sensor](https://github.com/viam-modules/tdk-invensense/).

### INA219 power monitoring unit

Expand All @@ -130,7 +130,7 @@ You configure it with Viam on your machine as a [movement sensor](/components/mo
The INA219 unit measures the voltage and current from the power supply.
You can use it to measure battery life status and power consumption.
It connects to the Raspberry Pi 4 through the I2C bus.
You configure it with Viam on your machine as a [power sensor](/components/power-sensor/ina219/).
You configure it with Viam on your machine as a [power sensor](https://github.com/viam-modules/texas-instruments/).

### DC-DC 5V converter

Expand Down
2 changes: 1 addition & 1 deletion docs/architecture/viam-micro-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ date: "2024-09-03"
---

`viam-micro-server` is the lightweight version of [`viam-server`](/architecture/viam-server/) which can run on resource-limited embedded systems (ESP32) that cannot run the fully-featured `viam-server`.
`viam-micro-server` is built from the open-source [micro-RDK](https://github.com/viamrobotics/micro-rdk/tree/main).
`viam-micro-server` is built from the open-source [micro-RDK](https://github.com/viamrobotics/micro-rdk/).

## Hardware requirements

Expand Down
94 changes: 0 additions & 94 deletions docs/components/board/beaglebone.md

This file was deleted.

Loading

0 comments on commit bcbdd0f

Please sign in to comment.