Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOCS-2436: Change inclusion table header #3028

Merged
merged 21 commits into from
Jun 17, 2024
Merged
Show file tree
Hide file tree
Changes from 9 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
08f355f
DOCS-2436: Change inclusion table header
npentrel Jun 17, 2024
8a2ec48
Update docs/build/configure/processes.md
npentrel Jun 17, 2024
929db31
Update docs/build/configure/processes.md
npentrel Jun 17, 2024
3308d0e
Update docs/build/micro-rdk/movement-sensor/gyro-mpu6050.md
npentrel Jun 17, 2024
1d7895d
Update docs/build/configure/processes.md
npentrel Jun 17, 2024
d850f82
Update docs/build/micro-rdk/movement-sensor/accel-adxl345.md
npentrel Jun 17, 2024
8c931c4
Update docs/components/arm/lite6.md
npentrel Jun 17, 2024
72cb89a
Apply suggestions from code review
npentrel Jun 17, 2024
cdc8bee
Apply suggestions from code review
npentrel Jun 17, 2024
9297303
Apply suggestions from code review
npentrel Jun 17, 2024
57fde6e
Apply suggestions from code review
npentrel Jun 17, 2024
8801811
Update docs/components/gripper/softrobotics.md
npentrel Jun 17, 2024
79fd79c
Update docs/components/gripper/softrobotics.md
npentrel Jun 17, 2024
a220a2b
Apply suggestions from code review
npentrel Jun 17, 2024
dcf4001
Update docs/components/movement-sensor/cameramono.md
npentrel Jun 17, 2024
9357d7a
Apply suggestions from code review
npentrel Jun 17, 2024
7a03de8
Update docs/components/movement-sensor/gps-nmea-rtk-pmtk.md
npentrel Jun 17, 2024
82451de
Update docs/components/movement-sensor/gps-nmea-rtk-pmtk.md
npentrel Jun 17, 2024
9cae9c0
Apply suggestions from code review
npentrel Jun 17, 2024
56557e7
Apply suggestions from code review
npentrel Jun 17, 2024
8cbb6ff
Update docs/services/slam/orbslamv3/_index.md
npentrel Jun 17, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/build/configure/processes.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Navigate to that card.
Then fill in the following fields:

<!-- prettier-ignore -->
| Attribute (Builder Mode) | Attribute (JSON) | Type | Inclusion | Description |
| ------------------------ | -------------------- | ------- | ------------ | ----------- |
| Attribute (Builder Mode) | Attribute (JSON) | Type | Required? | Description |
| ------------------------ | ---------------- | ------- | --------- | ----------- |
| Executable | `name` | string | **Required** | The command you want to execute when your machine connects to the server. |
| Arguments | `args` | string | Optional | Arguments to follow the command. |
| Working directory | `cwd` | string | Optional | Where you want the process to execute. Defaults to the directory where `viam-server` executes. |
Expand Down
2 changes: 1 addition & 1 deletion docs/build/micro-rdk/base/two_wheeled_base.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Configure a `two_wheeled_base` base as follows:
The following attributes are available for `two_wheeled_base` bases:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `left` | string | **Required** | The `name` of a drive motor on the left side of the base. |
| `right` | string | **Required** | The `name` of a drive motor on the right side of the base. |
Expand Down
8 changes: 4 additions & 4 deletions docs/build/micro-rdk/board/esp32.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Click the **Save** button in the top right corner of the page.
The following attributes are available for `esp32` boards:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `analogs` | object | Optional | Attributes of any pins that can be used as analog-to-digital converter (ADC) inputs. See [configuration info](#analogs). |
| `i2cs` | object | Optional | Any Inter-Integrated Circuit (I<sup>2</sup>C) pins' bus index and name. See [configuration info](#i2cs). |
Expand All @@ -106,7 +106,7 @@ Interaction with digital interrupts is only supported with the [board API](/comp
The following properties are available for `analogs`:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `name` | string | **Required** | Your name for the analog reader. |
| `pin`| integer | **Required** | The GPIO number of the ADC's connection pin, wired to the board. |
Expand All @@ -116,7 +116,7 @@ The following properties are available for `analogs`:
The following properties are available for `i2cs`:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
|`name`| string| **Required** | `name` of the I<sup>2</sup>C bus. |
|`bus`| string | **Required** | The index of the I<sup>2</sup>C bus. Must be either `i2c0` or `i2c1`. |
Expand All @@ -130,7 +130,7 @@ The following properties are available for `i2cs`:
The following properties are available for `digital_interrupts`:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
|`pin`| string | **Required** | The GPIO number of the board's GPIO pin that you wish to configure the digital interrupt for. |

Expand Down
2 changes: 1 addition & 1 deletion docs/build/micro-rdk/encoder/incremental.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ Fill in and edit the attributes as applicable.
The following attributes are available for `incremental` encoders:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `board` | string | **Required** | The `name` of the [board](/build/micro-rdk/board/) to which the encoder is wired. |
| `a` | string | **Required** | GPIO number of one of the pins to which the encoder is wired |
Expand Down
2 changes: 1 addition & 1 deletion docs/build/micro-rdk/encoder/single.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The direction of spin is dictated by the [motor](/components/motor/) that has th
The following attributes are available for `single` encoders:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `pin` | object | **Required** | GPIO number of the pin to which the encoder is wired. |
| `dir_flip` | boolean | **Required** | If the encoder's count should increment or decrement in its initial state before a [`SetPower()`](/components/motor/#setpower) call is made to an encoded [motor](/build/micro-rdk/motor/). `true` implies decrement. |
Expand Down
4 changes: 2 additions & 2 deletions docs/build/micro-rdk/motor/gpio.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ An example configuration for a `gpio` motor:
The following attributes are available for `gpio` motors:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `board` | string | **Required** | `name` of the [board](/build/micro-rdk/board/) to which the motor driver is wired. |
| `pins` | object | **Required** | A structure that holds pin configuration information; [see below](#pins). |
Expand Down Expand Up @@ -135,7 +135,7 @@ There are three common ways for your computer to communicate with a brushed DC m
Inside the `pins` struct you need to configure **two or three** of the following depending on your motor driver:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `a` | string | **Required** for some drivers | Board {{< glossary_tooltip term_id="pin-number" text="pin number" >}} this motor driver's "IN1" or "A" pin is wired to. |
| `b` | string | **Required** for some drivers | Board {{< glossary_tooltip term_id="pin-number" text="pin number" >}} this motor driver's "IN2" or "B" pin is wired to. |
Expand Down
4 changes: 2 additions & 2 deletions docs/build/micro-rdk/movement-sensor/accel-adxl345.md
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,8 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
## Attributes

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| ---- | ------ | ------------ | ----------- |
| Name | Type | Required? | Description |
| ---- | ------ | --------- | ----------- |
| `board` | string | **Required** | The `name` of the [board](/build/micro-rdk/board/) to which the device is wired. |
| `i2c_bus` | string | **Required** | The `name` of the I<sup>2</sup>C bus on the [board](/build/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` |
Expand Down
4 changes: 2 additions & 2 deletions docs/build/micro-rdk/movement-sensor/gyro-mpu6050.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac
## Attributes

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| --------------------- | ------- | ------------ | ----------- |
| Name | Type | Required? | Description |
| --------------------- | ------- | --------- | ----------- |
| `board` | string | **Required** | The `name` of the [board](/build/micro-rdk/board/) to which the device is wired. |
| `i2c_bus` | string | **Required** | The `name` of the I<sup>2</sup>C bus configured 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` |
Expand Down
2 changes: 1 addition & 1 deletion docs/build/micro-rdk/sensor/ultrasonic.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Although `"board"` is marked as required in the RDK, it is not required for Micr
The following attributes are available for `ultrasonic` sensors:

<!-- prettier-ignore -->
| Attribute | Type | Inclusion | Description |
| Attribute | Type | Required? | Description |
| --------- | ---- | --------- | ----------- |
| `trigger_pin` | string | **Required** | The GPIO number of the [board's](/build/micro-rdk/board/) GPIO pin that you have wired to the trigger pin of your ultrasonic sensor. |
| `echo_interrupt_pin` | string | **Required** | The GPIO number of the board's GPIO pin that you have wired to the echo pin of your ultrasonic sensor. Please note that unlike the RDK ultrasonic sensor, you must not use a named pin associated with a digital interrupt configured on your board: it will not (currently) work. |
Expand Down
2 changes: 1 addition & 1 deletion docs/build/micro-rdk/servo/gpio.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ Then remove and fill in the attributes as applicable to your servo, according to
The following attributes are available for `gpio` servos:

<!-- prettier-ignore -->
| Name | Type | Inclusion | Description |
| Name | Type | Required? | Description |
| ---- | ---- | --------- | ----------- |
| `pin` | string | **Required** | The GPIO number of the pin the servo's control wire is wired to on the board. |
| `board` | string | **Required** | `name` of the [board](/build/micro-rdk/board/) the servo is wired to. |
Expand Down
Loading
Loading