diff --git a/docs/build/configure/processes.md b/docs/build/configure/processes.md index 330d9a8260..1ab6b905f3 100644 --- a/docs/build/configure/processes.md +++ b/docs/build/configure/processes.md @@ -57,8 +57,8 @@ Navigate to that card. Then fill in the following fields: -| 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. | diff --git a/docs/build/micro-rdk/base/two_wheeled_base.md b/docs/build/micro-rdk/base/two_wheeled_base.md index a338868cb4..cb72a8838e 100644 --- a/docs/build/micro-rdk/base/two_wheeled_base.md +++ b/docs/build/micro-rdk/base/two_wheeled_base.md @@ -70,7 +70,7 @@ Configure a `two_wheeled_base` base as follows: The following attributes are available for `two_wheeled_base` bases: -| 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. | diff --git a/docs/build/micro-rdk/board/esp32.md b/docs/build/micro-rdk/board/esp32.md index 4200346061..bc7c1c0428 100644 --- a/docs/build/micro-rdk/board/esp32.md +++ b/docs/build/micro-rdk/board/esp32.md @@ -91,7 +91,7 @@ Click the **Save** button in the top right corner of the page. The following attributes are available for `esp32` boards: -| 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 (I2C) pins' bus index and name. See [configuration info](#i2cs). | @@ -106,7 +106,7 @@ Interaction with digital interrupts is only supported with the [board API](/comp The following properties are available for `analogs`: -| 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. | @@ -116,7 +116,7 @@ The following properties are available for `analogs`: The following properties are available for `i2cs`: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | |`name`| string| **Required** | `name` of the I2C bus. | |`bus`| string | **Required** | The index of the I2C bus. Must be either `i2c0` or `i2c1`. | @@ -130,7 +130,7 @@ The following properties are available for `i2cs`: The following properties are available for `digital_interrupts`: -| 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. | diff --git a/docs/build/micro-rdk/encoder/incremental.md b/docs/build/micro-rdk/encoder/incremental.md index 00e381004f..a94174a3ce 100644 --- a/docs/build/micro-rdk/encoder/incremental.md +++ b/docs/build/micro-rdk/encoder/incremental.md @@ -71,7 +71,7 @@ Fill in and edit the attributes as applicable. The following attributes are available for `incremental` encoders: -| 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 | diff --git a/docs/build/micro-rdk/encoder/single.md b/docs/build/micro-rdk/encoder/single.md index 30ca04a486..d521578102 100644 --- a/docs/build/micro-rdk/encoder/single.md +++ b/docs/build/micro-rdk/encoder/single.md @@ -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: -| 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. | diff --git a/docs/build/micro-rdk/motor/gpio.md b/docs/build/micro-rdk/motor/gpio.md index 9bc8ae1658..f8f6e44ec3 100644 --- a/docs/build/micro-rdk/motor/gpio.md +++ b/docs/build/micro-rdk/motor/gpio.md @@ -106,7 +106,7 @@ An example configuration for a `gpio` motor: The following attributes are available for `gpio` motors: -| 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). | @@ -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: -| 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. | diff --git a/docs/build/micro-rdk/movement-sensor/accel-adxl345.md b/docs/build/micro-rdk/movement-sensor/accel-adxl345.md index e98ecb7b2c..000dfba778 100644 --- a/docs/build/micro-rdk/movement-sensor/accel-adxl345.md +++ b/docs/build/micro-rdk/movement-sensor/accel-adxl345.md @@ -117,8 +117,8 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac ## Attributes -| 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 I2C 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.
Default: `false` | diff --git a/docs/build/micro-rdk/movement-sensor/gyro-mpu6050.md b/docs/build/micro-rdk/movement-sensor/gyro-mpu6050.md index 574421097b..7acf39bf0d 100644 --- a/docs/build/micro-rdk/movement-sensor/gyro-mpu6050.md +++ b/docs/build/micro-rdk/movement-sensor/gyro-mpu6050.md @@ -114,8 +114,8 @@ Then remove and fill in the attributes as applicable to your movement sensor, ac ## Attributes -| 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 I2C 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`.
Default: `false` | diff --git a/docs/build/micro-rdk/sensor/ultrasonic.md b/docs/build/micro-rdk/sensor/ultrasonic.md index 9174dea981..726dc7f187 100644 --- a/docs/build/micro-rdk/sensor/ultrasonic.md +++ b/docs/build/micro-rdk/sensor/ultrasonic.md @@ -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: -| 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. | diff --git a/docs/build/micro-rdk/servo/gpio.md b/docs/build/micro-rdk/servo/gpio.md index 7542c08e6e..ab54ec2dc6 100644 --- a/docs/build/micro-rdk/servo/gpio.md +++ b/docs/build/micro-rdk/servo/gpio.md @@ -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: -| 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. | diff --git a/docs/cli.md b/docs/cli.md index 0feda9be36..7cc1ee1ca2 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -260,12 +260,12 @@ viam [global options] command [command options] [arguments...] ``` -| Parameter | Description | -| ----------- | ----------- | -| [Global options](#global-options) | _optional_ - list of flags that apply for commands | -| [Command](#commands) | _required_ - the specific CLI command to run | -| Command options | _required for some commands_ - the operation to run for the specified command. | -| Arguments | _required for some commands_ - the arguments for the specified command operation. Some commands take positional arguments, some named arguments. | +| Parameter | Description | +| --------- | ----------- | +| [Global options](#global-options) | _optional_ - list of flags that apply for commands | +| [Command](#commands) | _required_ - the specific CLI command to run | +| Command options | _required for some commands_ - the operation to run for the specified command. | +| Arguments | _required for some commands_ - the arguments for the specified command operation. Some commands take positional arguments, some named arguments. | See the list of [commands](#commands) below. @@ -335,51 +335,51 @@ done | Command option | Description | Positional arguments | | -------------- | ----------- | -------------------- | -| `export` | Export data in a specified format to a specified location | - | -| `database configure` | Create a new database user for the Viam organization's MongoDB Atlas Data Federation instance, or change the password of an existing user. See [Configure data query](/services/data/query/#configure-data-query) | - | -| `database hostname` | Get the MongoDB Atlas Data Federation instance hostname and connection URI. See [Configure data query](/services/data/query/#configure-data-query) | - | -| `dataset add` | Add a new image to an existing dataset by its file id, or add a group of images by specifying a filter | `filter` | -| `dataset remove` | Remove an existing image from a dataset by its file id, or remove a group of images by specifying a filter | `filter` | -| `delete binary` | Delete binary data | - | -| `delete tabular` | Delete tabular data | - | -| `--help` | Return help | - | +| `export` | Export data in a specified format to a specified location | - | +| `database configure` | Create a new database user for the Viam organization's MongoDB Atlas Data Federation instance, or change the password of an existing user. See [Configure data query](/services/data/query/#configure-data-query) | - | +| `database hostname` | Get the MongoDB Atlas Data Federation instance hostname and connection URI. See [Configure data query](/services/data/query/#configure-data-query) | - | +| `dataset add` | Add a new image to an existing dataset by its file id, or add a group of images by specifying a filter | `filter` | +| `dataset remove` | Remove an existing image from a dataset by its file id, or remove a group of images by specifying a filter | `filter` | +| `delete binary` | Delete binary data | - | +| `delete tabular` | Delete tabular data | - | +| `--help` | Return help | - | ##### Positional arguments: `dataset` | Argument | Description | -| ----------- | ----------- | -| `filter` | `add` or `delete` images from a dataset using a filter. See [Using the `filter` argument)](#using-the-filter-argument).| -| `ids` | `add` or `delete` images from a dataset by specifying one or more file ids as a comma-separated list. See [Using the `ids` argument)](#using-the-ids-argument).| -| `--help` | Return help | +| -------- | ----------- | +| `filter` | `add` or `delete` images from a dataset using a filter. See [Using the `filter` argument)](#using-the-filter-argument).| +| `ids` | `add` or `delete` images from a dataset by specifying one or more file ids as a comma-separated list. See [Using the `ids` argument)](#using-the-ids-argument).| +| `--help` | Return help | ##### Named arguments -| Argument | Description | Applicable commands | Inclusion | -| ----------- | ----------- | ----------- | ----------- | -| `--destination` | Output directory for downloaded data |`export`| **Required** | -| `--data-type` | Data type to be downloaded: either binary or tabular |`export`| **Required** | -| `--component-name` | Filter by specified component name |`export`, `delete`| Optional | -| `--component-type` | Filter by specified component type |`export`, `delete`| Optional | -| `--component-model` | Filter by specified component model |`export`, `delete`| Optional | -| `--dataset-id` | Dataset to add or remove images from |`dataset`| **Required** | +| Argument | Description | Applicable commands | Required? | +| -------- | ----------- | ------------------- | --------- | +| `--destination` | Output directory for downloaded data |`export`| **Required** | +| `--data-type` | Data type to be downloaded: either binary or tabular |`export`| **Required** | +| `--component-name` | Filter by specified component name |`export`, `delete`| Optional | +| `--component-type` | Filter by specified component type |`export`, `delete`| Optional | +| `--component-model` | Filter by specified component model |`export`, `delete`| Optional | +| `--dataset-id` | Dataset to add or remove images from |`dataset`| **Required** | | `--delete-older-than-days` | Number of days, 0 means all data will be deleted | `delete` | Optional | -| `--start` | ISO-8601 timestamp indicating the start of the interval |`export`, `delete`, `dataset`| Optional | -| `--end` | ISO-8601 timestamp indicating the end of the interval |`export`, `delete`, `dataset`| Optional | -| `--file-ids` | File-ids to add or remove from a dataset |`dataset`| **Required** | -| `--location-id` | Location ID for the file ids being added or removed from the specified dataset (only accepts one location id) |`dataset`| **Required** | -| `--location-ids` | Filter by specified location ID (accepts comma-separated list) |`export`, `delete`| Optional | -| `--method` | Filter by specified method |`export`, `delete`| Optional | -| `--mime-types` | Filter by specified MIME type (accepts comma-separated list) |`export`, `delete`|false | +| `--start` | ISO-8601 timestamp indicating the start of the interval |`export`, `delete`, `dataset`| Optional | +| `--end` | ISO-8601 timestamp indicating the end of the interval |`export`, `delete`, `dataset`| Optional | +| `--file-ids` | File-ids to add or remove from a dataset |`dataset`| **Required** | +| `--location-id` | Location ID for the file ids being added or removed from the specified dataset (only accepts one location id) |`dataset`| **Required** | +| `--location-ids` | Filter by specified location ID (accepts comma-separated list) |`export`, `delete`| Optional | +| `--method` | Filter by specified method |`export`, `delete`| Optional | +| `--mime-types` | Filter by specified MIME type (accepts comma-separated list) |`export`, `delete`|false | | `--org-id` | Org ID for the database user being configured (with `database`), or for the file ids being added or removed from the specified dataset (with `dataset`) | `database configure`, `database hostname`, `dataset` | **Required** | -| `--org-ids` | Filter by specified organizations ID (accepts comma-separated list) |`export`, `delete`| Optional | -| `--parallel` | Number of download requests to make in parallel, with a default value of 10 |`export`, `delete`|false | -| `--part-id` | Filter by specified part ID |`export`, `delete`| Optional | -| `--part-name` | Filter by specified part name |`export`, `delete`| Optional | -| `--robot-id` | Filter by specified robot ID |`export`, `delete`| Optional | -| `--robot-name` | Filter by specified robot name |`export`, `delete`| Optional | -| `--tags` | Filter by specified tag (accepts comma-separated list) |`export`, `delete`, `dataset`| Optional | +| `--org-ids` | Filter by specified organizations ID (accepts comma-separated list) |`export`, `delete`| Optional | +| `--parallel` | Number of download requests to make in parallel, with a default value of 10 |`export`, `delete`|false | +| `--part-id` | Filter by specified part ID |`export`, `delete`| Optional | +| `--part-name` | Filter by specified part name |`export`, `delete`| Optional | +| `--robot-id` | Filter by specified robot ID |`export`, `delete`| Optional | +| `--robot-name` | Filter by specified robot name |`export`, `delete`| Optional | +| `--tags` | Filter by specified tag (accepts comma-separated list) |`export`, `delete`, `dataset`| Optional | | `--password` | Password for the database user being configured | `database configure` | **Required** | ##### Using the `ids` argument @@ -437,25 +437,26 @@ viam locations list [] | Command option | Description | Positional arguments | | -------------- | ----------- | -------------------- | -| `list` | List all locations (name and id) that the authenticated session has access to, grouped by organization | **organization id** : return results for specified organization only | -| `api-key` | Work with an api-key for your location | `create` | -| `--help` | Return help | - | +| `list` | List all locations (name and id) that the authenticated session has access to, grouped by organization | **organization id** : return results for specified organization only | +| `api-key` | Work with an api-key for your location | `create` | +| `--help` | Return help | - | ##### Positional arguments: `api-key` | Argument | Description | -| ----------- | ----------- | -| `create` | Create an API key for a specific location | -| `--help` | Return help | +| -------- | ----------- | +| `create` | Create an API key for a specific location | +| `--help` | Return help | ##### Named arguments -| Argument | Description | Applicable commands | Inclusion | -| --------------- | ---------------------------------------- | ------------------- | ------------ | -| `--location-id` | The location to create an API key for | `api-key` | **Required** | -| `--name` | The name of the API key | `api-key` | Optional | -| `--org-id` | The organization ID to attach the key to | `api-key` | Optional | + +| Argument | Description | Applicable commands | Required? | +| -------- | ----------- | ------------------- | --------- | +| `--location-id` | The location to create an API key for | `api-key` | **Required** | +| `--name` | The name of the API key | `api-key` | Optional | +| `--org-id` | The organization ID to attach the key to | `api-key` | Optional | ### `login` @@ -475,17 +476,18 @@ If you haven't already, you must [create an organization API key](#create-an-org | Command option | Description | Positional arguments | | -------------- | ----------- | -------------------- | -| `api-key` | Authenticate to Viam using an organization, location, or machine part API key | Create | -| `print-access-token` | Prints the access token used to authenticate the current CLI session | - | -| `--help` | Return help | - | +| `api-key` | Authenticate to Viam using an organization, location, or machine part API key | Create | +| `print-access-token` | Prints the access token used to authenticate the current CLI session | - | +| `--help` | Return help | - | | `--disable-browser-open` | Authenticate in a headless environment by preventing the opening of the default browser during login (default: false) | - | ##### Named arguments -| Argument | Description | Applicable commands | Inclusion | -| ---------- | ---------------------------------- | ------------------- | ------------ | -| `--key-id` | The `key id` (UUID) of the API key | `api-key` | **Required** | -| `--key` | The `key value` of the API key | `api-key` | **Required** | + +| Argument | Description | Applicable commands | Required? | +| -------- | ----------- | ------------------- | --------- | +| `--key-id` | The `key id` (UUID) of the API key | `api-key` | **Required** | +| `--key` | The `key value` of the API key | `api-key` | **Required** | ### `logout` @@ -534,32 +536,32 @@ If you update and release your module as part of a continuous integration (CI) w #### Command options -| Command option | Description | Positional arguments | -| ----------- | ----------- | ----------- | -| `create` | Generate new metadata for a custom module on your local filesystem | - | -| `update` | Update an existing custom module on your local filesystem with recent changes to the [`meta.json` file](#the-metajson-file). Note that the `upload` command automatically runs `update` for you; you do not need to explicitly run `update` if you are also running `upload` | - | -| `upload` | Validate and upload a new or existing custom module on your local filesystem to the Viam registry. See [Upload validation](#upload-validation) for more information | **module-path** : specify the path to the file, directory, or compressed archive (with `.tar.gz` or `.tgz` extension) that contains your custom module code | -| `build start` | Start a module build in a cloud runner using the build step in your [`meta.json` file](#the-metajson-file). See [Using the `build` subcommand](#using-the-build-subcommand) | - | -| `build local` | Start a module build locally using the build step in your [`meta.json` file](#the-metajson-file). See [Using the `build` subcommand](#using-the-build-subcommand) | - | -| `build list` | List the status of your cloud module builds. See [Using the `build` subcommand](#using-the-build-subcommand) | - | -| `build logs` | Show the logs from a specific cloud module build. See [Using the `build` subcommand](#using-the-build-subcommand) | - | -| `--help` | Return help | - | +| Command option | Description | Positional arguments | +| -------------- | ----------- | -------------------- | +| `create` | Generate new metadata for a custom module on your local filesystem | - | +| `update` | Update an existing custom module on your local filesystem with recent changes to the [`meta.json` file](#the-metajson-file). Note that the `upload` command automatically runs `update` for you; you do not need to explicitly run `update` if you are also running `upload` | - | +| `upload` | Validate and upload a new or existing custom module on your local filesystem to the Viam registry. See [Upload validation](#upload-validation) for more information | **module-path** : specify the path to the file, directory, or compressed archive (with `.tar.gz` or `.tgz` extension) that contains your custom module code | +| `build start` | Start a module build in a cloud runner using the build step in your [`meta.json` file](#the-metajson-file). See [Using the `build` subcommand](#using-the-build-subcommand) | - | +| `build local` | Start a module build locally using the build step in your [`meta.json` file](#the-metajson-file). See [Using the `build` subcommand](#using-the-build-subcommand) | - | +| `build list` | List the status of your cloud module builds. See [Using the `build` subcommand](#using-the-build-subcommand) | - | +| `build logs` | Show the logs from a specific cloud module build. See [Using the `build` subcommand](#using-the-build-subcommand) | - | +| `--help` | Return help | - | ##### Named arguments -| Argument | Description | Applicable commands | Inclusion | -| ----------- | ----------- | ----------- | ----------- | -| `--count` | Number of cloud builds to list, defaults to displaying all builds | `build list` | Optional | -| `--force` | Skip local validation of the packaged module, which may result in an unusable module if the contents of the packaged module are not correct | `upload` | Optional | -| `--id` | The build ID to list or show logs for, as returned from `build start` | `build list`, `build logs` | Optional | -| `--module` | The path to the [`meta.json` file](#the-metajson-file) for the custom module, if not in the current directory | `update`, `upload`, `build` | Optional | -| `--name` | The name of the custom module to be created | `create` | **Required** | -| `--org-id` | The organization ID to associate the module to. See [Using the `--org-id` argument](#using-the---org-id-and---public-namespace-arguments) | `create`, `upload` | **Required** | -| `--public-namespace` | The [namespace](/cloud/organizations/#create-a-namespace-for-your-organization) to associate the module to. See [Using the `--public-namespace` argument](#using-the---org-id-and---public-namespace-arguments) | `create`, `upload` | **Required** | -| `--platform` | The architecture of your module binary. See [Using the `--platform` argument](#using-the---platform-argument) | `upload`, `build logs` | **Required** | -| `--version` | The version of your module to set for this upload. See [Using the `--version` argument](#using-the---version-argument) | `upload` | **Required** | -| `--wait` | Wait for the build to finish before outputting any logs | `build logs` | Optional | +| Argument | Description | Applicable commands | Required? | +| -------- | ----------- | ------------------- | --------- | +| `--count` | Number of cloud builds to list, defaults to displaying all builds | `build list` | Optional | +| `--force` | Skip local validation of the packaged module, which may result in an unusable module if the contents of the packaged module are not correct | `upload` | Optional | +| `--id` | The build ID to list or show logs for, as returned from `build start` | `build list`, `build logs` | Optional | +| `--module` | The path to the [`meta.json` file](#the-metajson-file) for the custom module, if not in the current directory | `update`, `upload`, `build` | Optional | +| `--name` | The name of the custom module to be created | `create` | **Required** | +| `--org-id` | The organization ID to associate the module to. See [Using the `--org-id` argument](#using-the---org-id-and---public-namespace-arguments) | `create`, `upload` | **Required** | +| `--public-namespace` | The [namespace](/cloud/organizations/#create-a-namespace-for-your-organization) to associate the module to. See [Using the `--public-namespace` argument](#using-the---org-id-and---public-namespace-arguments) | `create`, `upload` | **Required** | +| `--platform` | The architecture of your module binary. See [Using the `--platform` argument](#using-the---platform-argument) | `upload`, `build logs` | **Required** | +| `--version` | The version of your module to set for this upload. See [Using the `--version` argument](#using-the---version-argument) | `upload` | **Required** | +| `--wait` | Wait for the build to finish before outputting any logs | `build logs` | Optional | ##### Using the `--org-id` and `--public-namespace` arguments @@ -575,15 +577,15 @@ You may use either argument for the `viam module create` command, but must use ` The `--platform` argument accepts one of the following architectures: -| Architecture | Description | Common use case | -| -------------- | ----------- | --------------- | -| `any` | Any supported OS running any supported architecture. | Suitable for most Python modules that do not require OS-level support (such as platform-specific dependencies). | -| `any/amd64` | Any supported OS running the `amd64` architecture. | Suitable for most Docker-based modules on `amd64`. | -| `any/arm64` | Any supported OS running the `arm64` (`aarch64`) architecture. | Suitable for most Docker-based modules on `arm64`. | -| `linux/any` | Linux machines running any architecture. | Suitable for Python modules that also require Linux OS-level support (such as platform-specific dependencies). | -| `darwin/any` | macOS machines running any architecture. | Suitable for Python modules that also require macOS OS-level support (such as platform-specific dependencies). | -| `linux/amd64` | Linux machines running the Intel `x86_64` architecture. | Suitable for most C++ or Go modules on Linux `amd64`. | -| `linux/arm64` | Linux machines running the `arm64` (`aarch64`) architecture, such as the Raspberry Pi. | Suitable for most C++ or Go modules on Linux `arm64`. | +| Architecture | Description | Common use case | +| ------------ | ----------- | --------------- | +| `any` | Any supported OS running any supported architecture. | Suitable for most Python modules that do not require OS-level support (such as platform-specific dependencies). | +| `any/amd64` | Any supported OS running the `amd64` architecture. | Suitable for most Docker-based modules on `amd64`. | +| `any/arm64` | Any supported OS running the `arm64` (`aarch64`) architecture. | Suitable for most Docker-based modules on `arm64`. | +| `linux/any` | Linux machines running any architecture. | Suitable for Python modules that also require Linux OS-level support (such as platform-specific dependencies). | +| `darwin/any` | macOS machines running any architecture. | Suitable for Python modules that also require macOS OS-level support (such as platform-specific dependencies). | +| `linux/amd64` | Linux machines running the Intel `x86_64` architecture. | Suitable for most C++ or Go modules on Linux `amd64`. | +| `linux/arm64` | Linux machines running the `arm64` (`aarch64`) architecture, such as the Raspberry Pi. | Suitable for most C++ or Go modules on Linux `arm64`. | | `linux/arm32v7`| Linux machines running the `arm32v7` architecture. | Suitable for most C++ or Go modules on Linux `arm32v7`. | | `linux/arm32v6`| Linux machines running the `arm32v6` architecture. | Suitable for most C++ or Go modules on `arm32v6`. | | `darwin/amd64` | macOS machines running the Intel `x86_64` architecture. | Suitable for most C++ or Go modules on macOS `amd64`. | @@ -898,27 +900,27 @@ See [create an organization API key](#create-an-organization-api-key) for more i #### Command options -| Command option | Description | Positional arguments | -| ----------- | ----------- | ----------- | -| `list` | List all organizations (name, id, and [namespace](/cloud/organizations/#create-a-namespace-for-your-organization)) that the authenticated session belongs to | - | -| `api-key` | Create a new organization API key |`create` | -| `--help` | Return help | - | +| Command option | Description | Positional arguments | +| -------------- | ----------- | -------------------- | +| `list` | List all organizations (name, id, and [namespace](/cloud/organizations/#create-a-namespace-for-your-organization)) that the authenticated session belongs to | - | +| `api-key` | Create a new organization API key |`create` | +| `--help` | Return help | - | ##### Positional arguments: `api-key` | Argument | Description | -| ----------- | ----------- | ----------- | -| `create` | Create an API key for an organization | -| `--help` | Return help | +| -------- | ----------- | +| `create` | Create an API key for an organization | +| `--help` | Return help | ##### Named arguments -| Argument | Description | Applicable commands | Inclusion | -| ----------- | ----------- | ----------- | ----------- | -| `--org-id` | The organization to create an API key for |`api-key` | **Required** | -| `--name` | The optional name for the organization API key. If omitted, a name will be auto-generated based on your login info and the current time |`api-key` | Optional | +| Argument | Description | Applicable commands | Required? | +| -------- | ----------- | ------------------- | --------- | +| `--org-id` | The organization to create an API key for |`api-key` | **Required** | +| `--name` | The optional name for the organization API key. If omitted, a name will be auto-generated based on your login info and the current time |`api-key` | Optional | ### `packages` @@ -933,15 +935,15 @@ viam packages export --org-id= --name= --version=latest -- #### Command options -| Command option | Description | Positional arguments | -| ----------- | ----------- | ----------- | -| `upload` | Upload a package to the Viam cloud | - | -| `export` | Download a package from the Viam cloud | - | +| Command option | Description | Positional arguments | +| -------------- | ----------- | -------------------- | +| `upload` | Upload a package to the Viam cloud | - | +| `export` | Download a package from the Viam cloud | - | ##### Named arguments -| Argument | Description | Applicable commands | Inclusion | +| Argument | Description | Applicable commands | Required? | | -------- | ----------- | ------------------- | -------- | | `--org-id` | The organization ID of the package | `upload`, `export` | **Required** | | `--name` | The name of the package | `upload`, `export` | **Required** | @@ -995,50 +997,50 @@ viam.service.vision.v1.VisionService.GetClassificationsFromCamera #### Command options -| Command option | Description | Positional arguments | -| ----------- | ----------- | ----------- | -| `list` | List all machines that the authenticated session has access to, filtered by organization and location. | - | -| `api-key` | Work with an api-key for your machine | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) | -| `status` | Retrieve machine status for a specified machine | - | -| `logs` | Retrieve logs for a specified machine | - | -| `part` | Manage a specified machine part | `status`, `run`, `logs`, `shell` (see [positional arguments: part](#positional-arguments-part)) | -| `--help` | Return help | - | +| Command option | Description | Positional arguments | +| -------------- | ----------- | -------------------- | +| `list` | List all machines that the authenticated session has access to, filtered by organization and location. | - | +| `api-key` | Work with an api-key for your machine | `create` (see [positional arguments: api-key](#positional-arguments-api-key)) | +| `status` | Retrieve machine status for a specified machine | - | +| `logs` | Retrieve logs for a specified machine | - | +| `part` | Manage a specified machine part | `status`, `run`, `logs`, `shell` (see [positional arguments: part](#positional-arguments-part)) | +| `--help` | Return help | - | ##### Positional arguments: `api-key` | Argument | Description | -| ----------- | ----------- | ----------- | -| `create` | Create an API key for a specific machine | -| `--help` | Return help | +| -------- | ----------- | +| `create` | Create an API key for a specific machine | +| `--help` | Return help | ##### Positional arguments: `part` -| Argument | Description | -| ----------- | ----------- | ----------- | -| `status` | Retrieve machine status for a specified machine part | -| `run` | Run a component or service command, optionally at a specified interval. For commands that return data in their response, you can use this to stream data. | -| `logs` | Get logs for the specified machine part | -| `shell` | Access a machine part securely using a secure shell. This feature must be enabled. | -| `--help` | Return help | +| Argument | Description | +| -------- | ----------- | +| `status` | Retrieve machine status for a specified machine part | +| `run` | Run a component or service command, optionally at a specified interval. For commands that return data in their response, you can use this to stream data. | +| `logs` | Get logs for the specified machine part | +| `shell` | Access a machine part securely using a secure shell. This feature must be enabled. | +| `--help` | Return help | ##### Named arguments -| Argument | Description | Applicable commands | Inclusion | -| ----------- | ----------- | ----------- | ----------- | -| `--organization` | Organization name that the machine belongs to | `list`, `status`, `logs`, `part` | **Required** | -| `--location` | Location name that the machine belongs to | `list`, `status`, `logs`, `part` | **Required** | -| `--robot` | Machine ID for which the command is being issued | `status`, `logs`, `part` | **Required** | -| `--errors` | Boolean, return only errors (default: false) | `logs` | Optional | -| `--part` | Part name for which the command is being issued | `logs` | Optional | -| `--tail` | Tail (stream) logs, boolean(default false) | `part logs` | Optional | -| `--stream` | If specified, the interval in which to stream the specified data, for example, 100ms or 1s | `part run` | Optional | -| `--data` | Command data for the command being request to run (see [data argument](#using-the---stream-and---data-arguments)) | `part run` | **Required** | +| Argument | Description | Applicable commands | Required? | +| -------- | ----------- | ------------------- | --------- | +| `--organization` | Organization name that the machine belongs to | `list`, `status`, `logs`, `part` | **Required** | +| `--location` | Location name that the machine belongs to | `list`, `status`, `logs`, `part` | **Required** | +| `--robot` | Machine ID for which the command is being issued | `status`, `logs`, `part` | **Required** | +| `--errors` | Boolean, return only errors (default: false) | `logs` | Optional | +| `--part` | Part name for which the command is being issued | `logs` | Optional | +| `--tail` | Tail (stream) logs, boolean(default false) | `part logs` | Optional | +| `--stream` | If specified, the interval in which to stream the specified data, for example, 100ms or 1s | `part run` | Optional | +| `--data` | Command data for the command being request to run (see [data argument](#using-the---stream-and---data-arguments)) | `part run` | **Required** | | `--robot-id` | The machine to create an API key for | `api-key` | **Required** | -| `--name` | The optional name of the API key | `api-key` | Optional | -| `--org-id` | The optional organization ID to attach the key to | `api-key` | Optional | +| `--name` | The optional name of the API key | `api-key` | Optional | +| `--org-id` | The optional organization ID to attach the key to | `api-key` | Optional | ##### Using the `--stream` and `--data` arguments @@ -1115,41 +1117,41 @@ Sharing this information could compromise your system security by allowing unaut #### Command options -| Command option | Description | -| -------------- | --------------------------------------- | -| `register` | Register an [application](https://fusionauth.io/docs/get-started/core-concepts/applications) with FusionAuth | -| `update` | Update your application | +| Command option | Description | +| -------------- | ----------- | +| `register` | Register an [application](https://fusionauth.io/docs/get-started/core-concepts/applications) with FusionAuth | +| `update` | Update your application | ##### Named arguments: `register` -| Argument | Description | Inclusion | -| -------------------- | ----------------------------------------------------------------- | ------------ | -| `--org-id` | The {{< glossary_tooltip term_id="organization" text="organization" >}} ID with which to associate this app | **Required** | +| Argument | Description | Required? | +| -------- | ----------- | --------- | +| `--org-id` | The {{< glossary_tooltip term_id="organization" text="organization" >}} ID with which to associate this app | **Required** | | `--application-name` | A display name (of your choice) for your application. | **Required** | -| `--origin-uris` | All URIs from which valid logins to FusionAuth can originate from | **Required** | -| `--redirect-uris` | URIs to which FusionAuth will redirect the user upon login | **Required** | -| `--logout-uri` | URI of page to show user upon logout | **Required** | +| `--origin-uris` | All URIs from which valid logins to FusionAuth can originate from | **Required** | +| `--redirect-uris` | URIs to which FusionAuth will redirect the user upon login | **Required** | +| `--logout-uri` | URI of page to show user upon logout | **Required** | ##### Named arguments: `update` The `org-id` and `application-id` are immutable; they cannot be updated after the application is registered. -| Argument | Description | Inclusion | -| -------------------- | -------------------------------------------- | ------------ | -| `--org-id` | The {{< glossary_tooltip term_id="organization" text="organization" >}} ID with which this app is associated | **Required** | -| `--application-id` | The identifier of your application, returned when you registered the application | **Required** | +| Argument | Description | Required? | +| -------- | ----------- | --------- | +| `--org-id` | The {{< glossary_tooltip term_id="organization" text="organization" >}} ID with which this app is associated | **Required** | +| `--application-id` | The identifier of your application, returned when you registered the application | **Required** | | `--application-name` | A display name (of your choice) for your application. | Optional | -| `--origin-uris` | All URIs from which valid logins to FusionAuth can originate | Optional | -| `--redirect-uris` | URIs to which FusionAuth will redirect the user upon login | Optional | -| `--logout-uri` | URI of page to show user upon logout | Optional | +| `--origin-uris` | All URIs from which valid logins to FusionAuth can originate | Optional | +| `--redirect-uris` | URIs to which FusionAuth will redirect the user upon login | Optional | +| `--logout-uri` | URI of page to show user upon logout | Optional | ## Global options You can pass global options after the `viam` CLI keyword with any command. -| Global option | Description | -| ----------- | ----------- | +| Global option | Description | +| ------------- | ----------- | | `--debug` | Enable debug logging (default: false) | diff --git a/docs/components/arm/fake.md b/docs/components/arm/fake.md index b2d9bdc4e2..6d305b391a 100644 --- a/docs/components/arm/fake.md +++ b/docs/components/arm/fake.md @@ -73,7 +73,7 @@ If both attributes are specified, an error is thrown stating "can only populate The following attributes are available for `fake` arms: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `arm-model` | string | Optional | Model name of the robotic arm model you want your fake arm to act as. See [built-in arm models](../#supported-models) for supported model names. | | `model-path` | string | Optional | The path to the [kinematic configuration file](/internals/kinematic-chain-config/) of the arm driver you want your fake arm to act as. This path should point to the exact location where the file is located on your computer running `viam-server`. | diff --git a/docs/components/arm/lite6.md b/docs/components/arm/lite6.md index 242fa37d0c..ebba38ac9f 100644 --- a/docs/components/arm/lite6.md +++ b/docs/components/arm/lite6.md @@ -91,8 +91,8 @@ Fill in the attributes as applicable to your arm, according to the table below. The following attributes are available for `lite6` arms: -| Attribute | Type | Inclusion | Description | -| --------- | ---- | ----------| ----------- | +| Attribute | Type | Required? | Description | +| --------- | ---- | --------- | ----------- | | `host` | string | **Required** | IP address of the arm's system on your network. Find this when setting up your xArm. | | `port` | int | Optional | Port number of the arm's system. Find this when setting up your xArm.
Default: `502` | | `speed_degs_per_sec` | float | Optional | Desired maximum speed of joint movement in degrees/sec.
Default: `20.0` | diff --git a/docs/components/arm/ur5e.md b/docs/components/arm/ur5e.md index b96eb4c17f..4f79158808 100644 --- a/docs/components/arm/ur5e.md +++ b/docs/components/arm/ur5e.md @@ -73,8 +73,8 @@ Edit and fill in the attributes as applicable. The following attributes are available for `ur5e` arms: -| Attribute | Type | Inclusion | Description | -| --------- | ---- | ----------| ----------- | +| Attribute | Type | Required? | Description | +| --------- | ---- | --------- | ----------- | | `speed_degs_per_sec` | float | **Required** | Desired maximum speed of joint movement in degrees per second. Must be between `3` and `180`. | | `host` | string | **Required** | The IP address of the arm's system on your network. Find this when setting up your UR5e. | diff --git a/docs/components/arm/xarm6.md b/docs/components/arm/xarm6.md index f4c53ba059..05d4555d6a 100644 --- a/docs/components/arm/xarm6.md +++ b/docs/components/arm/xarm6.md @@ -92,8 +92,8 @@ Edit and fill in the attributes as applicable. The following attributes are available for `xArm6` arms: -| Attribute | Type | Inclusion | Description | -| --------- | ---- | ----------| ----------- | +| Attribute | Type | Required? | Description | +| --------- | ---- | --------- | ----------- | | `host` | string | **Required** | IP address of the arm's system on your network. Find this when setting up your xArm. | | `port` | int | Optional | Port number of the arm's system. Find this when setting up your xArm.
Default: `502` | | `speed_degs_per_sec` | float | Optional | Desired maximum speed of joint movement in degrees/sec.
Default: `20.0` | diff --git a/docs/components/arm/xarm7.md b/docs/components/arm/xarm7.md index 829368e4ff..02433ac3c4 100644 --- a/docs/components/arm/xarm7.md +++ b/docs/components/arm/xarm7.md @@ -92,8 +92,8 @@ Edit and fill in the attributes as applicable. The following attributes are available for `xArm7` arms: -| Attribute | Type | Inclusion | Description | -| ----------| ---- | ----------| ----------- | +| Attribute | Type | Required? | Description | +| ----------| ---- | --------- | ----------- | | `host` | string | **Required** | IP address of the arm's system on your network. Find this when setting up your xArm. | | `port` | int | Optional | Port number of the arm's system. Find this when setting up your xArm.
Default: `502` | | `speed_degs_per_sec` | float | Optional | Desired maximum speed of joint movement in degrees/sec.
Default: `20.0` | diff --git a/docs/components/base/boat.md b/docs/components/base/boat.md index 359ff34f64..550d4a7ba6 100644 --- a/docs/components/base/boat.md +++ b/docs/components/base/boat.md @@ -51,7 +51,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for `boat` bases: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `length_mm` | int | **Required** | Length of the base in millimeters. In other words, the distance between the approximate centers of the right and left wheels. Can be an approximation. | | `width_mm` | int | **Required** | Width of the base in millimeters. In other words, the distance between the approximate centers of the right and left motors. Can be an approximation. | @@ -61,7 +61,7 @@ The following attributes are available for `boat` bases: Each [motor](/components/motor/) inside of `Motors` has the following attributes available: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `Name` | string | **Required** | Name of the motor. | | `x_offset_mm` | int | **Required** | | diff --git a/docs/components/base/sensor-controlled.md b/docs/components/base/sensor-controlled.md index 1b3fe47ed6..882bc306cc 100644 --- a/docs/components/base/sensor-controlled.md +++ b/docs/components/base/sensor-controlled.md @@ -71,7 +71,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for `sensor-controlled` bases: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `movement_sensor` | array | **Required** | Array with the `name`s of any movement sensors on your base you want to gather feedback from. The driver will select the first movement sensor providing appropriate feedback for either the `SetVelocity()` or the `Spin()` endpoint.
If your sensor has an adjustable frequency or period, set the frequency to something greater than or equal to the default base control loop frequency of 10Hz, or set the period to something less than or equal to the corresponding period of 100msecs. | | `base` | string | **Required** | String with the `name` of the base you want to wrap with sensor control. | diff --git a/docs/components/base/wheeled.md b/docs/components/base/wheeled.md index 47de825c44..f8f6a84498 100644 --- a/docs/components/base/wheeled.md +++ b/docs/components/base/wheeled.md @@ -136,7 +136,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for `wheeled` bases: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `left` | array | **Required** | Array with the `name` of any drive motors on the left side of the base. | | `right` | array | **Required** | Array with the `name` of any drive motors on the right side of the base. | diff --git a/docs/components/board/beaglebone.md b/docs/components/board/beaglebone.md index f07ec65a00..e53bf035c6 100644 --- a/docs/components/board/beaglebone.md +++ b/docs/components/board/beaglebone.md @@ -63,7 +63,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `beaglebone` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](#digital_interrupts). | diff --git a/docs/components/board/customlinux.md b/docs/components/board/customlinux.md index 8eed2f965f..4e232b4263 100644 --- a/docs/components/board/customlinux.md +++ b/docs/components/board/customlinux.md @@ -241,7 +241,7 @@ Use the template and example below to populate the JSON file with a single key, The following parameters are available for each pin object: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `name` | string | **Required** | The name of the pin. This can be anything you want but it is convenient to use the physical board pin number.
Example: `"3"`. | | `device_name` | string | **Required** | The name of the device in /dev that this pin is attached to. Multiple pins may be attached to the same GPIO chip. See [GPIO info tips](#tips-for-finding-gpio-information) below.
Example: `"gpiochip0"`. | @@ -394,6 +394,6 @@ Edit the file path to use your [board definitions file](#create-a-board-definiti The following attributes are available for `customlinux` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board_defs_file_path` | string | **Required** | The path to the pin mappings. See [Create a board definitions file](#create-a-board-definitions-file). | diff --git a/docs/components/board/fake.md b/docs/components/board/fake.md index 7040321403..fe2c670e6d 100644 --- a/docs/components/board/fake.md +++ b/docs/components/board/fake.md @@ -52,7 +52,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `fake` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `fail_new` | bool | **Required** | If the fake board should raise an error at machine start-up. | | `analogs` | object | Optional | Attributes of any pins that can be used as Analog-to-Digital Converter (ADC) inputs. See [configuration info](#analogs). | diff --git a/docs/components/board/jetson.md b/docs/components/board/jetson.md index f731ef6898..ba0a147b17 100644 --- a/docs/components/board/jetson.md +++ b/docs/components/board/jetson.md @@ -76,7 +76,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `jetson` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](#digital_interrupts). | diff --git a/docs/components/board/numato.md b/docs/components/board/numato.md index e6e665628f..780517e687 100644 --- a/docs/components/board/numato.md +++ b/docs/components/board/numato.md @@ -64,7 +64,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `numato` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `pins` | int | **Required** | Number of GPIO pins available on the module. | | `analogs` | object | Optional | Attributes of any pins that can be used as Analog-to-Digital Converter (ADC) inputs. See [configuration info](#analogs). | diff --git a/docs/components/board/odroid.md b/docs/components/board/odroid.md index ba4a47f031..a88aebf48a 100644 --- a/docs/components/board/odroid.md +++ b/docs/components/board/odroid.md @@ -55,7 +55,7 @@ Click the **{}** (Switch to Advanced) button in the top right of the odroid boar The following attributes are available for `odroid` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](#digital_interrupts).| | `analogs` | object | Optional | Attributes of any pins that can be used as Analog-to-Digital Converter (ADC) inputs. See [configuration info](#analogs).| diff --git a/docs/components/board/orangepi.md b/docs/components/board/orangepi.md index 2c7418c3b0..1256173023 100644 --- a/docs/components/board/orangepi.md +++ b/docs/components/board/orangepi.md @@ -99,7 +99,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `orangepi` boards: -| 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). | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](/components/board/#digital_interrupts). | diff --git a/docs/components/board/pca9685.md b/docs/components/board/pca9685.md index 531ea256cf..51b3f1e561 100644 --- a/docs/components/board/pca9685.md +++ b/docs/components/board/pca9685.md @@ -53,7 +53,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `pca9685` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `i2c_bus` | string | **Required** | The index of the I2C bus on the board with GPIO pins your `pca9685` is connected to. Often a number.
Example: `”1”` | | `i2c_address` | int | Optional | The PCA9685's unique [I2C address](https://learn.adafruit.com/i2c-addresses/overview). | diff --git a/docs/components/board/pi.md b/docs/components/board/pi.md index ce50762368..988e8ba3e0 100644 --- a/docs/components/board/pi.md +++ b/docs/components/board/pi.md @@ -76,7 +76,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `pi` boards: -| 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). | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](#digital_interrupts). | diff --git a/docs/components/board/pi5.md b/docs/components/board/pi5.md index e563368f53..c21aaf96c5 100644 --- a/docs/components/board/pi5.md +++ b/docs/components/board/pi5.md @@ -87,7 +87,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `pi5` boards: -| 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). | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](#digital_interrupts). | diff --git a/docs/components/board/ti.md b/docs/components/board/ti.md index c692e52016..50dfe10f31 100644 --- a/docs/components/board/ti.md +++ b/docs/components/board/ti.md @@ -61,7 +61,7 @@ Enter a name or use the suggested name for your board and click **Create**. The following attributes are available for `ti` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](#digital_interrupts). | diff --git a/docs/components/board/upboard.md b/docs/components/board/upboard.md index 62bd888800..8280d1940d 100644 --- a/docs/components/board/upboard.md +++ b/docs/components/board/upboard.md @@ -95,7 +95,7 @@ Edit the attributes as applicable to your board, according to the table below. The following attributes are available for `upboard` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](/components/board/#digital_interrupts). | diff --git a/docs/components/camera/fake.md b/docs/components/camera/fake.md index f4cfd5774c..b9f7c41554 100644 --- a/docs/components/camera/fake.md +++ b/docs/components/camera/fake.md @@ -53,7 +53,7 @@ Edit the attributes as applicable to your camera, according to the table below. The following attributes are available for `fake` cameras: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `width` | int | Optional | The width of the image in pixels. The maximum width is 10000.
Default: `1280` | | `height` | int | Optional | The height of the image in pixels. The maximum height is 10000.
Default: `720` | diff --git a/docs/components/camera/ffmpeg.md b/docs/components/camera/ffmpeg.md index ae1e761592..09350788e6 100644 --- a/docs/components/camera/ffmpeg.md +++ b/docs/components/camera/ffmpeg.md @@ -75,7 +75,7 @@ Edit the attributes as applicable to your camera, according to the table below. The following attributes are available for `ffmpeg` cameras: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `video_path` | string | **Required** | The file path to the camera device, color image file, or streaming camera. If you are using a camera with an RTSP stream, provide the RTSP address to this attribute. | | `intrinsic_parameters` | object | Optional | The intrinsic parameters of the camera used to do 2D <-> 3D projections:
  • width_px: The expected width of the aligned image in pixels.
  • height_px: The expected height of the aligned image in pixels.
  • fx: The image center x point.
  • fy: The image center y point.
  • ppx: The image focal x.
  • ppy: The image focal y.
| diff --git a/docs/components/camera/image-file.md b/docs/components/camera/image-file.md index edc60bb1c7..b98a0e813d 100644 --- a/docs/components/camera/image-file.md +++ b/docs/components/camera/image-file.md @@ -67,7 +67,7 @@ Note that you _must_ specify at least one of `color_image_file_path`, `depth_ima The following attributes are available for `image_file` cameras: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `intrinsic_parameters` | object | Optional | The intrinsic parameters of the camera used to do 2D <-> 3D projections:
  • width_px: The expected width of the aligned image in pixels.
  • height_px: The expected height of the aligned image in pixels.
  • fx: The image center x point.
  • fy: The image center y point.
  • ppx: The image focal x.
  • ppy: The image focal y.
| | `distortion_parameters` | object | Optional | Modified Brown-Conrady parameters used to correct for distortions caused by the shape of the camera lens:
  • rk1: The radial distortion x.
  • rk2: The radial distortion y.
  • rk3: The radial distortion z.
  • tp1: The tangential distortion x.
  • tp2: The tangential distortion y.
| diff --git a/docs/components/camera/join-color-depth.md b/docs/components/camera/join-color-depth.md index c8dfffd5ee..c89d6abe6a 100644 --- a/docs/components/camera/join-color-depth.md +++ b/docs/components/camera/join-color-depth.md @@ -93,7 +93,7 @@ Then remove and fill in the attributes as applicable to your camera, according t The following attributes are available for `join_color_depth` views: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `output_image_type` | string | **Required** | Specify `color` or `depth` for the output stream. | | `color_camera_name` | string | **Required** | `name` of the color camera to pull images from. If your camera provides both color and depth image streams, you must set this to be the same as `depth_camera_name`. | diff --git a/docs/components/camera/join-pointclouds.md b/docs/components/camera/join-pointclouds.md index 9ccaa8be3b..5e18095094 100644 --- a/docs/components/camera/join-pointclouds.md +++ b/docs/components/camera/join-pointclouds.md @@ -60,7 +60,7 @@ Edit the attributes as applicable to your machine, according to the table below. The following attributes are available for `join_pointclouds` views: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `target_frame` | string | **Required** | The frame of reference for the points in the merged point cloud. | | `source_cameras` | array | **Required** | The `name` of each of the camera sources to combine. | diff --git a/docs/components/camera/transform.md b/docs/components/camera/transform.md index 55128d4ad4..aed29b2bbf 100644 --- a/docs/components/camera/transform.md +++ b/docs/components/camera/transform.md @@ -114,7 +114,7 @@ Then remove and fill in the attributes as applicable to your camera, according t The following attributes are available for `transform` views: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `source` | string | **Required** | `name` of the camera to transform. | | `pipeline` | array | **Required** | Specify an array of transformation objects. | diff --git a/docs/components/camera/velodyne.md b/docs/components/camera/velodyne.md index 5aa4ed76fa..b5ca899ca1 100644 --- a/docs/components/camera/velodyne.md +++ b/docs/components/camera/velodyne.md @@ -50,7 +50,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for `velodyne` cameras: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `port` | int | **Required** | The port the Velodyne camera is running on. Try `2368` if you are unsure. | | `ttl_ms` | int | **Required** | Frequency in milliseconds to output the [TTL signal](https://en.wikipedia.org/wiki/Transistor%E2%80%93transistor_logic) from the camera. | diff --git a/docs/components/camera/webcam.md b/docs/components/camera/webcam.md index 2f77a046b1..2e49a2fc32 100644 --- a/docs/components/camera/webcam.md +++ b/docs/components/camera/webcam.md @@ -86,7 +86,7 @@ If you click on **Show more**, then the **video_path** field while your machine The following attributes are available for `webcam` cameras: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `video_path` | string | Optional | The ID of or the path to the webcam. If you don't provide a `video_path`, it defaults to the first valid video path it finds. Using the ID of a webcam is more consistent than the path. See [Using `video_path`](#using-video_path). | | `format` | string | Optional | The camera image format, used with `video_path` to find the camera. See [Using `format`](#using-format). | diff --git a/docs/components/component/board1.md b/docs/components/component/board1.md index f855f78332..33c813ec13 100644 --- a/docs/components/component/board1.md +++ b/docs/components/component/board1.md @@ -75,7 +75,7 @@ Click the **{}** (Switch to Advanced) button in the top right of the component p The following attributes are available for `` boards: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `digital_interrupts` | object | Optional | Any digital interrupts's {{< glossary_tooltip term_id="pin-number" text="pin number" >}} and name. See [configuration info](#digital_interrupts).| | `analogs` | object | Optional | Attributes of any pins that can be used as Analog-to-Digital Converter (ADC) inputs. See [configuration info](#analogs).| diff --git a/docs/components/component/model1.md b/docs/components/component/model1.md index c0c80be43a..0e04ea4489 100644 --- a/docs/components/component/model1.md +++ b/docs/components/component/model1.md @@ -123,8 +123,8 @@ Then remove and fill in the attributes as applicable to your COMPONENT, accordin The following attributes are available for `model1` arms: -| Name | Inclusion | Type | Default Value | Description | -| ------------ | ------------ | ------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| Name | Required? | Type | Default Value | Description | +| ------------ | --------- | ------ | ------------- | ----------- | | `board` | **Required** | string | - | The name of the board to which the device is wired. | | `i2c_bus` | **Required** | string | - | The name of the I2C bus through which the device communicates with the SBC. Note that this must match the name you gave the I2C bus you configured in the board component. | | `attribute3` | Optional | int | 300 | Insert useful description here. | diff --git a/docs/components/encoder/ams-as5048.md b/docs/components/encoder/ams-as5048.md index b4edfc943d..9aaa7b4d28 100644 --- a/docs/components/encoder/ams-as5048.md +++ b/docs/components/encoder/ams-as5048.md @@ -55,7 +55,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for `AMS-AS5048` encoders: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `connection_type` | string | **Required** | Use `"i2c"`. | | `i2c_attributes` | object | **Required** | The attributes to configure the I2C connection:
  • i2c_bus: The index of the I2C bus on the [board](/components/board/) wired to this encoder.
    Example: `"1"`
  • i2c_addr: The address of the bus.
    Example: `64`
| diff --git a/docs/components/encoder/arduino.md b/docs/components/encoder/arduino.md index 9b9ac405d5..f5bf796ef9 100644 --- a/docs/components/encoder/arduino.md +++ b/docs/components/encoder/arduino.md @@ -49,7 +49,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for `arduino` encoders: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board` | string | **Required** | The `name` of the board to which the encoder is wired. | | `motor_name` | string | **Required** | The `name` of the motor. | diff --git a/docs/components/encoder/incremental.md b/docs/components/encoder/incremental.md index 89a63daacd..54c53b11db 100644 --- a/docs/components/encoder/incremental.md +++ b/docs/components/encoder/incremental.md @@ -83,7 +83,7 @@ Fill in and edit the attributes as applicable. The following attributes are available for `incremental` encoders: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board` | string | **Required** | The `name` of the [board](/components/board/) to which the encoder is wired. | | `pins` | object | **Required** | A struct holding the names of the pins wired to the encoder:
  • a: {{< glossary_tooltip term_id="pin-number" text="Pin number" >}} of one of the pins to which the encoder is wired.
  • b: Required for two phase encoder. {{< glossary_tooltip term_id="pin-number" text="Pin number" >}} for the second board pin to which the encoder is wired.

    • If the encoded motor does not operate as expected, the encoder pins might be configured in reverse, switch the a and b pin definitions in your incremental encoder attributes to reconfigure your encoded motor.

| diff --git a/docs/components/encoder/single.md b/docs/components/encoder/single.md index 56a0ec39f8..60565752ca 100644 --- a/docs/components/encoder/single.md +++ b/docs/components/encoder/single.md @@ -50,7 +50,7 @@ Fill in and edit the attributes as applicable. The following attributes are available for `single` encoders: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board` | string | **Required** | The `name` of the [board](/components/board/) to which the encoder is wired. | | `pins` | object | **Required** | A struct holding the name of the pin wired to the encoder:
  • i: {{< glossary_tooltip term_id="pin-number" text="Pin number" >}} of the pin to which the encoder is wired.
| diff --git a/docs/components/gantry/multi-axis.md b/docs/components/gantry/multi-axis.md index cc7f774a8d..0ea19744f1 100644 --- a/docs/components/gantry/multi-axis.md +++ b/docs/components/gantry/multi-axis.md @@ -205,7 +205,7 @@ Fill in the attributes as applicable to your gantry, according to the table belo The following attributes are available for `multi-axis` gantries: -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | ---- | --------- | ----------- | | `subaxes_list` | array | **Required** | An array of the `name` of each of the sub-axes, the [`single-axis`](/components/gantry/single-axis/) gantries that make up the `multi-axis` gantry. | | `move_simultaneously` | boolean | Optional | A boolean indicating if the sub-axes should move together, or one at a time when `MoveToPosition` is called.
Default: `false` | diff --git a/docs/components/gantry/single-axis.md b/docs/components/gantry/single-axis.md index adcc873b99..8e296e67c8 100644 --- a/docs/components/gantry/single-axis.md +++ b/docs/components/gantry/single-axis.md @@ -57,7 +57,7 @@ Fill in the attributes as applicable to your gantry, according to the table belo The following attributes are available for `single-axis` gantries: -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | ---- | --------- | ---------- | | `length_mm` | int | **Required** | Length of the axis of the gantry in millimeters. | | `motor` | string | **Required** | `name` of the [motor](/components/motor/) that moves the gantry's actuator. | diff --git a/docs/components/gripper/softrobotics.md b/docs/components/gripper/softrobotics.md index 3f3c9dfdd0..f743216819 100644 --- a/docs/components/gripper/softrobotics.md +++ b/docs/components/gripper/softrobotics.md @@ -90,8 +90,8 @@ Fill in the attributes as applicable to your gripper, according to the table bel The following attributes are available for `softrobotics` grippers: -| Name | Inclusion | Type | Description | -| --------------- | ------------ | ------ | -------- | +| Name | Required? | Type | Description | +| --------------- | --------- | ------ | ----------- | | `board` | **Required** | string | The `name` of the [board](/components/board/) to which your gripper [control unit](https://www.softroboticsinc.com/uploads/2020/05/Tech_Sheet_coDrive_Control_Unit_-__TS-200210_Rev_B.pdf) is wired. | | `open` | **Required** | string | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the board pin wired to the open pin (D1) on the gripper controller. | | `close` | **Required** | string | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the board pin wired to the close pin (D2) on the gripper controller. | diff --git a/docs/components/input-controller/fake.md b/docs/components/input-controller/fake.md index 31518bebc4..98c826de58 100644 --- a/docs/components/input-controller/fake.md +++ b/docs/components/input-controller/fake.md @@ -59,7 +59,7 @@ Edit the attributes as applicable. The following attributes are available for `fake` input controllers: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `callback_delay_sec` | float | **Required** | The number of seconds between callbacks getting triggered. Random between 1 and 2 if not specified. `0` is not valid and will be overwritten by a random delay. | | `event_value` | float | Optional | Set the value of events returned. Random between -1 and 1 if not specified. | diff --git a/docs/components/input-controller/gamepad.md b/docs/components/input-controller/gamepad.md index 554b2c17e8..67cba38a51 100644 --- a/docs/components/input-controller/gamepad.md +++ b/docs/components/input-controller/gamepad.md @@ -53,7 +53,7 @@ Edit the attributes as applicable to your input controller, according to the tab The following attributes are available for `gamepad` input controllers: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `dev_file` | string | Optional | If `dev_file` is left blank or not included, `viam-server` will search and use the first gamepad it finds that's connected to the computer controlling your machine. If you want to specify a device, give the absolute path to the input device event file. For example: `/dev/input/event42`. | | `auto_reconnect` | boolean | Optional | Applies to both remote (gRPC) and local (bluetooth or direct USB connected) devices. If set to `true`, `viam-server` tries to (re)connect the device automatically. It waits for a device to connect during a machine's start-up. If set to false (default) then start-up fails if a device is not already connected. | diff --git a/docs/components/input-controller/gpio.md b/docs/components/input-controller/gpio.md index 2ea28c58f1..c97289a188 100644 --- a/docs/components/input-controller/gpio.md +++ b/docs/components/input-controller/gpio.md @@ -202,7 +202,7 @@ Then remove and fill in the attributes as applicable to your input controller, a The following attributes are available for `gpio` input controllers: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board` | string | **Required**| The name of the board component with GPIO or ADC pins to use as the controlling device. | | `buttons` | object | **Required** | The [Buttons](../#button-controls) available for control. These should be connected to the GPIO/ADC board.

Each button has the following fields:
  • name: Name of the Digital Interrupt the button/switch is connected to, as configured on the board component.
  • control: The [Control](../#control-field) type to use when reporting events as this button's state is changed.
  • invert: Boolean indicating if the digital input (high/low) should be inverted when reporting button Control value indicating button state.
    This option is given because digital switches vary between high, `1`, and low, `0`, as their default at rest.
    • *true:* `0` is pressed, and `1` is released.
    • *false (default):* `0` is released, and `1` is pressed.
  • debounce_ms: How many milliseconds to wait for the interrupt to settle. This is needed because some switches can be electrically noisy.
| diff --git a/docs/components/input-controller/mux.md b/docs/components/input-controller/mux.md index b1cdb56a29..20506df036 100644 --- a/docs/components/input-controller/mux.md +++ b/docs/components/input-controller/mux.md @@ -109,7 +109,7 @@ The following example configuration combines a `gamepad` and a `webgamepad` cont The following attributes are available for `mux` input controllers: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `sources` | array | **Required** | The `name` of every controller component you wish to combine input from. | diff --git a/docs/components/motor/28byj48.md b/docs/components/motor/28byj48.md index 845624eda2..b30239d000 100644 --- a/docs/components/motor/28byj48.md +++ b/docs/components/motor/28byj48.md @@ -111,7 +111,7 @@ Example configuration for a `28byj48` stepper motor: The following attributes are available for `28byj48` motors: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board` | string | **Required** | `name` of the [board](/components/board/) the motor driver is wired to. | | `pins` | object | **Required** | A JSON object containing the {{< glossary_tooltip term_id="pin-number" text="pin numbers" >}} the `in1`, `in2`, `in3`, and `in4` pins of the motor driver are wired to on the [board](/components/board/). | diff --git a/docs/components/motor/dmc4000.md b/docs/components/motor/dmc4000.md index eeb16bf502..b5ed6895c0 100644 --- a/docs/components/motor/dmc4000.md +++ b/docs/components/motor/dmc4000.md @@ -95,7 +95,7 @@ The `"serial_path"` filepath on a macOS system might resemble "/dev/ttyUSB The following attributes are available for `DMC4000` motors: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | |`amplifier_gain` | int | **Required** | Set the [per phase current](https://www.galil.com/download/comref/com4103/index.html#amplifier_gain.html) (when using stepper amp). | | `low_current` | int | **Required** | Reduce the [hold current](https://www.galil.com/download/comref/com4103/index.html#low_current_stepper_mode.html). | diff --git a/docs/components/motor/encoded-motor.md b/docs/components/motor/encoded-motor.md index 7383ccd6f2..cf24c5a257 100644 --- a/docs/components/motor/encoded-motor.md +++ b/docs/components/motor/encoded-motor.md @@ -144,7 +144,7 @@ Here’s an example configuration: In addition to the [attributes for a non-encoded motor](/components/motor/gpio/), the following attributes are available for encoded DC motors: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `encoder` | string | **Required** | `name` of the encoder. | | `ticks_per_rotation` | int | **Required** | Number of ticks in a full rotation of the encoder and motor shaft. | diff --git a/docs/components/motor/fake.md b/docs/components/motor/fake.md index ab354081ae..33a91698cb 100644 --- a/docs/components/motor/fake.md +++ b/docs/components/motor/fake.md @@ -78,7 +78,7 @@ Since a `fake` motor isn't a physical piece of hardware, attributes are only rep However, if you would like to mock up a virtual placeholder for a real, physical motor, you can configure some or all of the following attributes: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board` | string | Optional | `name` of the [board](/components/board/) to which the motor driver is wired. | | `min_power_pct` | float | Optional | Sets a limit on minimum power percentage sent to the motor.
Default: `0.0` | @@ -93,7 +93,7 @@ However, if you would like to mock up a virtual placeholder for a real, physical Nested within `pins`: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `a` | string | Optional | See [Pin Information](#pin-information). Corresponds to "IN1" on many driver data sheets. {{< glossary_tooltip term_id="pin-number" text="Pin number" >}} of the GPIO pin this is wired to on the [board](/components/board/). | | `b` | string | Optional | See [Pin Information](#pin-information). Corresponds to "IN2" on many driver data sheets. {{< glossary_tooltip term_id="pin-number" text="Pin number" >}} of the GPIO pin this is wired to on the [board](/components/board/). | diff --git a/docs/components/motor/gpio.md b/docs/components/motor/gpio.md index 5c275cd70e..848dc704a2 100644 --- a/docs/components/motor/gpio.md +++ b/docs/components/motor/gpio.md @@ -119,7 +119,7 @@ An example configuration for a `gpio` motor: The following attributes are available for `gpio` motors: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board` | string | **Required** | `name` of the [board](/components/board/) to which the motor driver is wired. | | `max_rpm` | int | **Required** | This is an estimate of the maximum RPM the motor will run at with full power under no load. The [`GoFor`](/components/motor/#gofor) method calculates how much power to send to the motor as a percentage of `max_rpm`. If unknown, you can set it to 100, which will mean that giving 40 as the `rpm` argument to `GoFor` or `GoTo` will set it to 40% speed. ***Not required** or available for [encoded](/components/motor/encoded-motor/) `gpio` motors.* | @@ -149,7 +149,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, in addition to `"en_high"` or `"en_low"`, depending on your motor driver: -| 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. | diff --git a/docs/components/motor/gpiostepper.md b/docs/components/motor/gpiostepper.md index 32ee8e97dd..76ffc38fa1 100644 --- a/docs/components/motor/gpiostepper.md +++ b/docs/components/motor/gpiostepper.md @@ -110,7 +110,7 @@ Here’s an example of a basic stepper driver config: The following attributes are available for `gpiostepper` motors: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ---------- | | `board` | string | **Required** | `name` of the [board](/components/board/) the motor driver is wired to. | | `pins` | object | **Required** | A struct containing the [board](/components/board/) {{< glossary_tooltip term_id="pin-number" text="pin numbers" >}} that the `step` and `dir` pins of the motor driver are wired to. | diff --git a/docs/components/motor/roboclaw.md b/docs/components/motor/roboclaw.md index 4605202eda..2ded9214cb 100644 --- a/docs/components/motor/roboclaw.md +++ b/docs/components/motor/roboclaw.md @@ -91,7 +91,7 @@ The `"serial_path"` filepath on a macOS system might resemble "/dev/ttyUSB The following attributes are available for `roboclaw` motors: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `serial_path` | string | **Required** | The full filesystem path to the serial device, starting with /dev/. To find your serial device path, first connect the serial device to your machine, then:
  • On Linux, run ls /dev/serial/by-path/\* to show connected serial devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/serial/by-path/usb-0:1.1:1.0".
  • On macOS, run ls /dev/tty\* \| grep -i usb to show connected USB serial devices, ls /dev/tty\* to browse all devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/ttyS0".
| | `serial_baud_rate` | int | Optional | [Rate to send data](https://learn.sparkfun.com/tutorials/serial-communication) over the serial line. This must match the baudrate you have set up using basicmicro's setup program. You cannot have multiple `roboclaw` motors with different baud rates.
Default: `38400` | diff --git a/docs/components/motor/tmc5072.md b/docs/components/motor/tmc5072.md index 11c223b859..adefd2b57a 100644 --- a/docs/components/motor/tmc5072.md +++ b/docs/components/motor/tmc5072.md @@ -101,7 +101,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for `TMC5072` motors: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `spi_bus` | string | **Required** | The index of the SPI bus over which the TMC chip communicates with the board. | |`chip_select` | string | **Required** | The chip select number (CSN) that the TMC5072 is wired to. For Raspberry Pis, use `"0"` if the CSN is wired to {{< glossary_tooltip term_id="pin-number" text="pin number" >}} 24 (GPIO 8) on the Pi, or use `"1"` if you wire the CSN to pin 26. The board sets this high or low to let the TMC chip know whether to listen for commands over SPI. | diff --git a/docs/components/movement-sensor/adxl345.md b/docs/components/movement-sensor/adxl345.md index 23b8b9d1d5..5c50afed4d 100644 --- a/docs/components/movement-sensor/adxl345.md +++ b/docs/components/movement-sensor/adxl345.md @@ -92,8 +92,8 @@ Fill in the attributes as applicable to your movement sensor, according to the t ## Attributes -| Name | Type | Inclusion | Description | -| ---- | ------ | ------------ | ----------- | +| Name | Type | Required? | Description | +| ---- | ------ | --------- | ----------- | | `i2c_bus` | string | **Required** | The index of the I2C bus on the board your device is connected to. Often a number.
Example: "2" | | `use_alternate_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.
Default: `false` | | `board` | string | Optional | The `name` of the [board](/components/board/) to which the device is wired. Only needed if you've configured any [interrupt](/components/board/#digital_interrupts) functionality. | @@ -105,8 +105,8 @@ Fill in the attributes as applicable to your movement sensor, according to the t Inside the `tap` object, you can include the following attributes: -| Name | Type | Inclusion | Description | -| ------------------- | ------ | ------------ | ----------- | +| Name | Type | Required? | Description | +| ------------------- | ------ | --------- | ----------- | | `accelerometer_pin` | int | **Required** | On the accelerometer you can choose to send the interrupts to int1 or int2. Specify this by setting this config value to `1` or `2`. | | `interrupt_pin` | string | **Required** | The `name` of the [digital interrupt](/components/board/#digital_interrupts) you configured for the pin on the [board](/components/board/) wired to the `accelerometer_pin`. | | `exclude_x` | bool | Optional | Tap detection defaults to all three axes. Exclude the x axis by setting this to true.
Default: `false` | @@ -120,8 +120,8 @@ Inside the `tap` object, you can include the following attributes: Inside the `freefall` object, you can include the following attributes: -| Name | Type | Inclusion | Description | -| ------------------- | ------ | ------------ | ----------- | +| Name | Type | Required? | Description | +| ------------------- | ------ | --------- | ----------- | | `accelerometer_pin` | int | **Required** | On the accelerometer you can choose to send the interrupts to int1 or int2. Specify this by setting this config value to `1` or `2`. | | `interrupt_pin` | string | **Required** | The `name` of the [digital interrupt](/components/board/#digital_interrupts) you configured for the pin on the [board](/components/board/) wired to the `accelerometer_pin`. | | `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`).
Default: `437.5` | diff --git a/docs/components/movement-sensor/cameramono.md b/docs/components/movement-sensor/cameramono.md index c2314175f5..506ae1e5e9 100644 --- a/docs/components/movement-sensor/cameramono.md +++ b/docs/components/movement-sensor/cameramono.md @@ -97,8 +97,8 @@ Edit and fill in the attributes as applicable. ## Attributes -| Name | Type | Inclusion | Description | -| -------------------------- | ------ | ------------ | ----------- | +| Name | Type | Required? | Description | +| -------------------------- | ------ | --------- | ----------- | | `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). | diff --git a/docs/components/movement-sensor/dual-gps-rtk.md b/docs/components/movement-sensor/dual-gps-rtk.md index d989981327..13a0b93744 100644 --- a/docs/components/movement-sensor/dual-gps-rtk.md +++ b/docs/components/movement-sensor/dual-gps-rtk.md @@ -77,7 +77,7 @@ Fill in the attributes as applicable to your movement sensor, according to the t The following attributes are available for a `dual-gps-rtk` movement sensor: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `first_gps` | int | **Required** | The name you have configured for the first movement sensor you want to combine the measurements from. Must be a GPS model. | | `second_gps` | string | **Required** | The name you have configured for the second movement sensor you want to combine the measurements from. Must be a GPS model. | diff --git a/docs/components/movement-sensor/gps-nmea-rtk-pmtk.md b/docs/components/movement-sensor/gps-nmea-rtk-pmtk.md index ca3d09b572..fc06619984 100644 --- a/docs/components/movement-sensor/gps-nmea-rtk-pmtk.md +++ b/docs/components/movement-sensor/gps-nmea-rtk-pmtk.md @@ -109,8 +109,8 @@ Fill in the attributes as applicable to your movement sensor, according to the t The following attributes are available for a `gps-nmea-rtk-pmtk` movement sensor: -| Name | Type | Inclusion | Description | -| ------------------------ | ------ | ------------ | ----------- | +| Name | Type | Required? | Description | +| ------------------------ | ------ | --------- | ----------- | | `i2c_addr` | int | **Required** | The device's I2C address. | | `i2c_bus` | string | **Required** | The index of the I2C bus of the board wired to the sensor. | | `i2c_baud_rate` | int | Optional | The rate at which data is sent from the sensor. Optional.
Default: `38400` | diff --git a/docs/components/movement-sensor/gps-nmea-rtk-serial.md b/docs/components/movement-sensor/gps-nmea-rtk-serial.md index f67ac8b75b..0b021d2748 100644 --- a/docs/components/movement-sensor/gps-nmea-rtk-serial.md +++ b/docs/components/movement-sensor/gps-nmea-rtk-serial.md @@ -111,8 +111,8 @@ The `"serial_path"` filepath on a macOS system might resemble "/dev/ttyUSB The following attributes are available for a `gps-nmea-rtk-pmtk` movement sensor: -| Name | Type | Inclusion | Description | -| ------------------------ | ------ | ------------ | ---------------- | +| Name | Type | Required? | Description | +| ------------------------ | ------ | --------- | ----------- | | `serial_path` | string | **Required** | The full filesystem path to the serial device, starting with /dev/. To find your serial device path, first connect the serial device to your machine, then:
  • On Linux, run ls /dev/serial/by-path/\* to show connected serial devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/serial/by-path/usb-0:1.1:1.0".
  • On macOS, run ls /dev/tty\* \| grep -i usb to show connected USB serial devices, ls /dev/tty\* to browse all devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/ttyS0".
| | `serial_baud_rate` | int | Optional | The rate at which data is sent from the sensor.
Default: `38400` | | `ntrip_url` | string | **Required** | The URL of the NTRIP server from which you get correction data. Connects to a base station (maintained by a third party) for RTK corrections. | diff --git a/docs/components/movement-sensor/gps-nmea.md b/docs/components/movement-sensor/gps-nmea.md index a2d2dc9b08..748c216c9b 100644 --- a/docs/components/movement-sensor/gps-nmea.md +++ b/docs/components/movement-sensor/gps-nmea.md @@ -120,8 +120,8 @@ The `"serial_path"` filepath on a macOS system might resemble "/dev/ttyUSB ## Attributes -| Name | Type | Inclusion | Description | -| ----------------- | ------- | ------------ | ---------------- | +| Name | Type | Required? | Description | +| ----------------- | ------- | --------- | ------------ | | `connection_type` | string | **Required** | `"I2C"` or `"serial"`. See [Connection Attributes](#connection-attributes) below. | ### Connection attributes @@ -141,8 +141,8 @@ See examples of this struct in the example tabs above. For a movement sensor communicating over serial, you'll need to include a `serial_attributes` struct containing: -| Name | Type | Inclusion | Description | -| ------------------ | ------ | ------------ | ------------------------- | +| Name | Type | Required? | Description | +| ------------------ | ------ | --------- | ------------ | | `serial_path` | string | **Required** | The full filesystem path to the serial device, starting with /dev/. To find your serial device path, first connect the serial device to your machine, then:
  • On Linux, run ls /dev/serial/by-path/\* to show connected serial devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/serial/by-path/usb-0:1.1:1.0".
  • On macOS, run ls /dev/tty\* \| grep -i usb to show connected USB serial devices, ls /dev/tty\* to browse all devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/ttyS0".
| | `serial_baud_rate` | int | Optional | The rate at which data is sent from the sensor.
Default: `38400` | @@ -154,8 +154,8 @@ For a movement sensor communicating over serial, you'll need to include a `seria For a movement sensor communicating over I2C, you'll need a `i2c_attributes` struct containing: -| Name | Type | Inclusion | Description | -| --------------- | ------ | ------------ | ------------------------ | +| Name | Type | Required? | Description | +| --------------- | ------ | --------- | ----------- | | `i2c_bus` | string | **Required** | The index of the I2C bus on the board wired to the sensor. | | `i2c_addr` | int | **Required** | The device's I2C address. | | `i2c_baud_rate` | int | Optional | The rate at which data is sent from the sensor. Optional.
Default: `38400` | diff --git a/docs/components/movement-sensor/imu-vectornav.md b/docs/components/movement-sensor/imu-vectornav.md index d063180e6d..f0dabc89ea 100644 --- a/docs/components/movement-sensor/imu-vectornav.md +++ b/docs/components/movement-sensor/imu-vectornav.md @@ -83,7 +83,7 @@ Fill in the attributes as applicable to your movement sensor, according to the t ## Attributes -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `board` | string | **Required** | The `name` of the [board](/components/board/) to which the device is wired. | | `spi_bus` | string | **Required** | The index of the SPI bus over which the device communicates with the board. | diff --git a/docs/components/movement-sensor/imu-wit-hwt905.md b/docs/components/movement-sensor/imu-wit-hwt905.md index ceda78e1b1..543c1d54e0 100644 --- a/docs/components/movement-sensor/imu-wit-hwt905.md +++ b/docs/components/movement-sensor/imu-wit-hwt905.md @@ -80,8 +80,8 @@ The `"serial_path"` filepath on a macOS system might resemble "/dev/ttyUSB ## Attributes -| Name | Type | Inclusion | Description | -| -------------- | ------ | ----------- | ----------- | +| Name | Type | Required? | Description | +| ----- | ------ | --------- | ----------- | | `serial_path` | string | **Required** | The full filesystem path to the serial device, starting with /dev/. To find your serial device path, first connect the serial device to your machine, then:
  • On Linux, run ls /dev/serial/by-path/\* to show connected serial devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/serial/by-path/usb-0:1.1:1.0".
  • On macOS, run ls /dev/tty\* \| grep -i usb to show connected USB serial devices, ls /dev/tty\* to browse all devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/ttyS0".
| | `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`.
Default: `115200` | diff --git a/docs/components/movement-sensor/imu-wit.md b/docs/components/movement-sensor/imu-wit.md index 38d4d349bd..1914fc2daf 100644 --- a/docs/components/movement-sensor/imu-wit.md +++ b/docs/components/movement-sensor/imu-wit.md @@ -94,8 +94,8 @@ The `"serial_path"` filepath on a macOS system might resemble "/dev/ttyUSB ## Attributes -| Name | Type | Inclusion | Description | -| -------------- | ------ | ----------- | ----------- | +| Name | Type | Required? | Description | +| ----- | ------ | --------- | ----------- | | `serial_path` | string | **Required** | The full filesystem path to the serial device, starting with /dev/. To find your serial device path, first connect the serial device to your machine, then:
  • On Linux, run ls /dev/serial/by-path/\* to show connected serial devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/serial/by-path/usb-0:1.1:1.0".
  • On macOS, run ls /dev/tty\* \| grep -i usb to show connected USB serial devices, ls /dev/tty\* to browse all devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/ttyS0".
| | `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.
Default: `115200` | diff --git a/docs/components/movement-sensor/merged.md b/docs/components/movement-sensor/merged.md index c34f3701d7..7e7b313a98 100644 --- a/docs/components/movement-sensor/merged.md +++ b/docs/components/movement-sensor/merged.md @@ -99,8 +99,8 @@ Configure an array of the `name` of each movement sensor you want to add to your You can use the same sensor for multiple attributes if it supports multiple properties. -| Name | Type | Inclusion | Description | -| --------------------- | ----- | ---------------------------------------- | ----------- | +| Name | Type | Required? | Description | +| --------------------- | ----- | --------- | ----------- | | `position` | array | **Dependent on Readings Type Supported** | The `name` of the movement sensor you want to merge, if it reads position. | | `orientation` | array | **Dependent on Readings Type Supported** | The `name` of the movement sensor you want to merge, if it reads orientation. | | `compass_heading` | array | **Dependent on Readings Type Supported** | The `name` of the movement sensor you want to merge, if it reads compass heading position. | diff --git a/docs/components/movement-sensor/mpu6050.md b/docs/components/movement-sensor/mpu6050.md index 5962e9d9a2..9242769433 100644 --- a/docs/components/movement-sensor/mpu6050.md +++ b/docs/components/movement-sensor/mpu6050.md @@ -72,8 +72,8 @@ Fill in the attributes as applicable to your movement sensor, according to the t ## Attributes -| Name | Type | Inclusion | Description | -| --------------------- | ------- | ------------ | ----------- | +| Name | Type | Required? | Description | +| --------------------- | ------- | --------- | ----------- | | `i2c_bus` | string | **Required** | The index of the I2C bus on the [board](/components/board/) that your movement sensor is wired to. | | `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`.
Default: `false` | diff --git a/docs/components/movement-sensor/wheeled-odometry.md b/docs/components/movement-sensor/wheeled-odometry.md index aa0e967ea2..f32321c2a8 100644 --- a/docs/components/movement-sensor/wheeled-odometry.md +++ b/docs/components/movement-sensor/wheeled-odometry.md @@ -110,7 +110,7 @@ Fill in the attributes as applicable to your movement sensor, according to the t The following attributes are available for `wheeled-odometry` movement sensors: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `base` | string | **Required** | The `name` of the [base](/components/base/) to which the encoders making up this movement sensor are wired. | | `left_motors` | object | **Required** | A list containing the name of each of the bases' left [position-reporting motors](/components/motor/gpio/). | diff --git a/docs/components/power-sensor/ina219.md b/docs/components/power-sensor/ina219.md index edbfbe2dfd..41a3bf4d5a 100644 --- a/docs/components/power-sensor/ina219.md +++ b/docs/components/power-sensor/ina219.md @@ -81,7 +81,7 @@ Edit the attributes as applicable to your power sensor, according to the table b The following attributes are available for `ina219` sensors: -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | -----| --------- | ----------- | | `i2c_bus` | integer | **Required** | The index of the I2C bus that the sensor is connected to. | | `i2c_addr` | integer | Optional | The sensor's unique [I2C address](https://learn.adafruit.com/i2c-addresses/overview).
Default: `0x40` | diff --git a/docs/components/power-sensor/ina226.md b/docs/components/power-sensor/ina226.md index 05bcf8a8e5..7d615345c4 100644 --- a/docs/components/power-sensor/ina226.md +++ b/docs/components/power-sensor/ina226.md @@ -79,7 +79,7 @@ Edit the attributes as applicable to your power sensor, according to the table b The following attributes are available for `ina226` sensors: -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | -----| --------- | ----------- | | `i2c_bus` | integer | **Required** | The index of the I2C bus that the sensor is connected to. | | `i2c_addr` | integer | Optional | Default: `0x40`. The sensor's unique [I2C address](https://learn.adafruit.com/i2c-addresses/overview). | diff --git a/docs/components/power-sensor/renogy.md b/docs/components/power-sensor/renogy.md index f0516b79fb..a78d9163b3 100644 --- a/docs/components/power-sensor/renogy.md +++ b/docs/components/power-sensor/renogy.md @@ -79,7 +79,7 @@ The `"serial_path"` filepath on a macOS system might resemble "/dev/ttyUSB The following attributes are available for `renogy` sensors: -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | ---- | --------- | ----------- | | `serial_path` | string | Optional | The full filesystem path to the serial device, starting with /dev/. To find your serial device path, first connect the serial device to your machine, then:
  • On Linux, run ls /dev/serial/by-path/\* to show connected serial devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/serial/by-path/usb-0:1.1:1.0".
  • On macOS, run ls /dev/tty\* \| grep -i usb to show connected USB serial devices, ls /dev/tty\* to browse all devices, or look for your device in the output of sudo dmesg \| grep tty. Example: "/dev/ttyS0".

Default: `/dev/serial0` | | `serial_baud_rate` | integer | Optional | The baud rate to use for serial communications.
Default: `9600` | diff --git a/docs/components/sensor/bme280.md b/docs/components/sensor/bme280.md index 7c6d2f8267..e9d0b58075 100644 --- a/docs/components/sensor/bme280.md +++ b/docs/components/sensor/bme280.md @@ -54,7 +54,7 @@ Fill in the attributes as applicable to your sensor, according to the table belo The following attributes are available for `bme280` sensors: -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | ---- | --------- | ---------- | | `i2c_bus` | string | **Required** | The index of the I2C bus on the board that the sensor is wired to. | | `i2c_address` | string | Optional | Default: `0x77`. The [I2C device address](https://learn.adafruit.com/i2c-addresses/overview) of the sensor. | diff --git a/docs/components/sensor/ds18b20.md b/docs/components/sensor/ds18b20.md index 48c7a43724..b919205c68 100644 --- a/docs/components/sensor/ds18b20.md +++ b/docs/components/sensor/ds18b20.md @@ -53,7 +53,7 @@ Fill in the attributes as applicable to your sensor, according to the table belo The following attributes are available for `ds18b20` sensors: -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | ---- | --------- | ---------- | | `unique_id` | string | **Required** | The [unique 64-bit serial code](https://www.analog.com/media/en/technical-documentation/data-sheets/ds18b20.pdf) of your DS18B20 sensor. Laser engraved onto your sensor and available [programmatically](https://github.com/milesburton/Arduino-Temperature-Control-Library). Example: `"28EEB2B81D160127"`. Note that this ID will also be the last 16 digits of the [device file](https://en.wikipedia.org/wiki/Device_file) when the sensor is mounted in a Linux filesystem. | diff --git a/docs/components/sensor/sensirion-sht3xd.md b/docs/components/sensor/sensirion-sht3xd.md index 9fb6db078b..b4d7f45187 100644 --- a/docs/components/sensor/sensirion-sht3xd.md +++ b/docs/components/sensor/sensirion-sht3xd.md @@ -54,7 +54,7 @@ Fill in the attributes as applicable to your sensor, according to the table belo The following attributes are available for `sensirion-sht3xd` sensors: -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | ---- | --------- | ----------- | | `i2c_bus` | string | **Required** | The index of the I2C bus on the board that the sensor is wired to. | | `i2c_address` | string | Optional | The [I2C device address](https://learn.adafruit.com/i2c-addresses/overview) of the sensor.
Default: `0x44` | diff --git a/docs/components/servo/gpio.md b/docs/components/servo/gpio.md index c691c9b2e0..e762193276 100644 --- a/docs/components/servo/gpio.md +++ b/docs/components/servo/gpio.md @@ -85,7 +85,7 @@ Fill in the attributes as applicable to your servo, according to the table below The following attributes are available for `gpio` servos: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `pin` | string | **Required** | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the pin the servo's control wire is wired to on the [board](/components/board/). | | `board` | string | **Required** | `name` of the [board](/components/board/) the servo is wired to. | diff --git a/docs/components/servo/pi.md b/docs/components/servo/pi.md index 735c7d984f..3ce67aafbb 100644 --- a/docs/components/servo/pi.md +++ b/docs/components/servo/pi.md @@ -94,7 +94,7 @@ Fill in the attributes as applicable to your servo, according to the table below The following attributes are available for `pi` servos: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `pin` | string | **Required** | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the pin the servo's control wire is wired to on the [board](/components/board/). | | `board` | string | **Required** | `name` of the [board](/components/board/) the servo is wired to. | diff --git a/docs/registry/configure.md b/docs/registry/configure.md index 4f854b52f2..55498896d2 100644 --- a/docs/registry/configure.md +++ b/docs/registry/configure.md @@ -142,7 +142,7 @@ You can edit the configuration of the modular resource or resources you have add If you prefer to use JSON, the following properties are available for all modular resources: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `namespace` | string | **Required** | The namespace of the API (the first part of the {{< glossary_tooltip term_id="api-namespace-triplet" text="API namespace triplet">}}). See [Valid APIs to implement in your model](/registry/#valid-apis-to-implement-in-your-model) | | `type` | string | **Required** | The {{< glossary_tooltip term_id="subtype" text="subtype">}} of the API (the third part of the {{< glossary_tooltip term_id="api-namespace-triplet" text="API namespace triplet">}}). See [Valid APIs to implement in your model](/registry/#valid-apis-to-implement-in-your-model). | @@ -431,7 +431,7 @@ Locate a module's card in the part-resource hierarchy and click on it to expand. The following properties are available for modules: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `name` | string | **Required**| Name of the module you are registering. | | `executable_path` | string | **Required**| The absolute path to the executable on your machine's filesystem. | @@ -469,7 +469,7 @@ Once you have added a local module to your machine, you can add any number of th The following properties are available for modular resources: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `namespace` | string | **Required** | The namespace of the API (the first part of the {{< glossary_tooltip term_id="api-namespace-triplet" text="API namespace triplet">}}). See [Valid APIs to implement in your model](/registry/#valid-apis-to-implement-in-your-model). | | `type` | string | **Required** | The {{< glossary_tooltip term_id="subtype" text="subtype">}} of the API (the third part of the {{< glossary_tooltip term_id="api-namespace-triplet" text="API namespace triplet">}}). See [Valid APIs to implement in your model](/registry/#valid-apis-to-implement-in-your-model). | diff --git a/docs/registry/create/_index.md b/docs/registry/create/_index.md index b77c3e4c00..de0a30379d 100644 --- a/docs/registry/create/_index.md +++ b/docs/registry/create/_index.md @@ -1134,7 +1134,7 @@ On the new component panel, copy and paste the following attribute template into The following attributes are available for `` s: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ------- | ------ | ------------ | ----------- | | `todo1` | string | **Required** | TODO | | `todo2` | string | Optional | TODO | @@ -1192,7 +1192,7 @@ On the new component panel, copy and paste the following attribute template into The following attributes are available for `viam:base:agilex-limo` bases: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ------------- | ------ | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `drive_mode` | string | **Required** | LIMO [steering mode](https://docs.trossenrobotics.com/agilex_limo_docs/operation/steering_modes.html#switching-steering-modes). Options: `differential`, `ackermann`, `omni` (mecanum). | | `serial_path` | string | Optional | The full filesystem path to the serial device, starting with /dev/. 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 `ttyTHS1`, to its device file, such as /dev/ttyTHS1. If you omit this attribute, Viam will attempt to automatically detect the path.
Default: `/dev/ttyTHS1` | diff --git a/docs/services/base-rc/_index.md b/docs/services/base-rc/_index.md index 96d310af4e..ab8284936b 100644 --- a/docs/services/base-rc/_index.md +++ b/docs/services/base-rc/_index.md @@ -101,7 +101,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for base remote control services: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `base` | string | **Required** | The `name` of the [base](/components/base/) you have configured for the base you are operating with this service. | | `input_controller` | string | **Required** | The `name` of the [input controller](/components/input-controller/) you have configured for the base you are operating with this service. | diff --git a/docs/services/data/trigger-sync.md b/docs/services/data/trigger-sync.md index 68cf69d922..d775046532 100644 --- a/docs/services/data/trigger-sync.md +++ b/docs/services/data/trigger-sync.md @@ -106,8 +106,8 @@ To use [`sync-at-time:timesyncsensor`](https://app.viam.com/module/naomi/sync-at The following attributes are available for the `naomi:sync-at-time:timesyncsensor` sensor: -| Name | Type | Inclusion | Description | -| ------- | ------ | ------------ | ----------- | +| Name | Type | Required? | Description | +| ------- | ------ | --------- | ----------- | | `start` | string | **Required** | The start time for the time frame during which you want to sync. Example: `"14:10:00"`. | | `end` | string | **Required** | The end of the sync time frame, for example: `"15:35:00"`. | | `zone` | string | **Required** | The time zone for the `start` and `end` time, for example: `"CET"`. | diff --git a/docs/services/frame-system/_index.md b/docs/services/frame-system/_index.md index 797bc22f63..59b4915efa 100644 --- a/docs/services/frame-system/_index.md +++ b/docs/services/frame-system/_index.md @@ -149,7 +149,7 @@ You can add a reference frame to your component with the following template: Configure the reference frame as follows: -| Parameter | Inclusion | Required | +| Parameter | Required? | Required | | --------- | ----------- | ----- | | `parent` | **Required** | Default: `world`. The name of the reference frame you want to act as the parent of this frame. | | `translation` | **Required** | Default: `(0, 0, 0)`. The coordinates that the origin of this component's reference frame has within its parent reference frame.
Units: _mm_. | diff --git a/docs/services/frame-system/frame-config.md b/docs/services/frame-system/frame-config.md index d3c8a5f05b..6db2dccd18 100644 --- a/docs/services/frame-system/frame-config.md +++ b/docs/services/frame-system/frame-config.md @@ -75,7 +75,7 @@ To configure your machine following this example: {{< /tabs >}} -| Parameter | Inclusion | Required | +| Parameter | Required? | Required | | --------- | ----------- | ----- | | `parent` | **Required** | Default: `world`. The name of the reference frame you want to act as the parent of this frame. | | `translation` | **Required** | Default: `(0, 0, 0)`. The coordinates that the origin of this component's reference frame has within its parent reference frame.
Units: _mm_. | diff --git a/docs/services/frame-system/nested-frame-config.md b/docs/services/frame-system/nested-frame-config.md index a8d518ecb6..4e52fec9d2 100644 --- a/docs/services/frame-system/nested-frame-config.md +++ b/docs/services/frame-system/nested-frame-config.md @@ -108,7 +108,7 @@ To configure your machine following this example: {{< /tabs >}} -| Parameter | Inclusion | Required | +| Parameter | Required? | Required | | --------- | ----------- | ----- | | `parent` | **Required** | Default: `world`. The name of the reference frame you want to act as the parent of this frame. | | `translation` | **Required** | Default: `(0, 0, 0)`. The coordinates that the origin of this component's reference frame has within its parent reference frame.
Units: _mm_. | diff --git a/docs/services/ml/deploy/tflite_cpu.md b/docs/services/ml/deploy/tflite_cpu.md index b5fdc9553a..73f3efc903 100644 --- a/docs/services/ml/deploy/tflite_cpu.md +++ b/docs/services/ml/deploy/tflite_cpu.md @@ -123,7 +123,7 @@ You do not need to edit the configuration yourself, expect if you wish to change The following parameters are available for a `"tflite_cpu"` model: -| Parameter | Inclusion | Description | +| Parameter | Required? | Description | | --------- | --------- | ----------- | | `model_path` | **Required** | The absolute path to the `.tflite model` file, as a `string`. | | `label_path` | Optional | The absolute path to a `.txt` file that holds class labels for your TFLite model, as a `string`. This text file should contain an ordered listing of class labels. Without this file, classes will read as "1", "2", and so on. | diff --git a/docs/services/navigation/_index.md b/docs/services/navigation/_index.md index a29231fc42..68de70f224 100644 --- a/docs/services/navigation/_index.md +++ b/docs/services/navigation/_index.md @@ -149,7 +149,7 @@ Edit and fill in the attributes as applicable. The following attributes are available for `Navigation` services: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | | `store` | obj | **Required** | The type and configuration of data storage to use. Either type `"memory"`, where no additional configuration is needed and the waypoints are stored in local memory while the navigation process is running, or `"mongodb"`, where data persists at the specified [MongoDB URI](https://www.mongodb.com/docs/manual/reference/connection-string) of your MongoDB deployment.
Default: `"memory"` | | `base` | string | **Required** | The `name` you have configured for the [base](/components/base/) you are operating with this service. | diff --git a/docs/services/slam/cartographer/_index.md b/docs/services/slam/cartographer/_index.md index 2b63df94ea..649a770d54 100644 --- a/docs/services/slam/cartographer/_index.md +++ b/docs/services/slam/cartographer/_index.md @@ -566,7 +566,7 @@ If you move your machine, it will appear to be moving in a trajectory from the m ### Attributes -| Name | Data Type | Inclusion | Description | +| Name | Data Type | Required? | Description | | ---- | --------- | --------- | ----------- | | `use_cloud_slam` | boolean | **Required** | If `true`, the Cartographer algorithm will execute in the cloud rather than locally on your machine. | | `camera` | obj | **Required** | An object of the form `{ "name": , "data_frequency_hz": }` where `name` is the name of the LiDAR camera component to use as input and `data_frequency_hz` is the rate at which to capture (in "Create new map" or "Update existing map" modes) or poll (in "Localize only" mode) data from that camera component. | diff --git a/docs/services/slam/orbslamv3/_index.md b/docs/services/slam/orbslamv3/_index.md index dc0aadd72f..835d6ca778 100644 --- a/docs/services/slam/orbslamv3/_index.md +++ b/docs/services/slam/orbslamv3/_index.md @@ -297,7 +297,7 @@ These are generated at runtime, so there is no need to adjust this folder. {{% tab name="Attributes" %}} -| Name | Data Type | Inclusion | Description | +| Name | Data Type | Required? | Description | | ---- | --------- | --------- | ----------- | | `data_dir` | string | **Required** | Path to the directory used for saving input /data and output /map visualizations. | | `sensors` | string[] | **Required** | Names of any configured [webcams](/components/camera/) providing data to the SLAM service. | @@ -322,7 +322,7 @@ Setting `delete_processed_data: true` and `use_live_data: false` is invalid and Adjust these parameters to fine-tune the algorithm `orbslamv3` utilizes: -| Parameter Mode | Description | Inclusion | Default Value | +| Parameter | Description | Required? | Default Value | | -------------- | ----------- | --------- | ------------- | | `mode` | `rgbd` or `mono` | **Required** | No default | | `debug` | Boolean specifying if the service should be run in debug mode. Affects log output. | Optional | `false` | diff --git a/docs/services/vision/color_detector.md b/docs/services/vision/color_detector.md index d3e54e433e..27cd2565fb 100644 --- a/docs/services/vision/color_detector.md +++ b/docs/services/vision/color_detector.md @@ -96,7 +96,7 @@ Add the vision service object to the services array in your JSON configuration: The following parameters are available for a `color_detector`: -| Parameter | Inclusion | Description | +| Parameter | Required? | Description | | --------- | --------- | ----------- | | `segment_size_px` | **Required** | An integer that sets a minimum size (in pixels) of a contiguous color region to be detected, and filters out all other found objects below that size. | | `detect_color` | **Required** | The color to detect in the image, as a string of the form `#RRGGBB`. The color is written as a hexadecimal string prefixed by ‘#’. | diff --git a/docs/services/vision/detector_3d_segmenter.md b/docs/services/vision/detector_3d_segmenter.md index 1f632b82fc..0584c5b17b 100644 --- a/docs/services/vision/detector_3d_segmenter.md +++ b/docs/services/vision/detector_3d_segmenter.md @@ -85,7 +85,7 @@ Add the vision service object to the services array in your raw JSON configurati The following parameters are available for a `detector_3d_segmenter`. -| Parameter | Inclusion | Description | +| Parameter | Required? | Description | | --------- | --------- | ----------- | | `detector_name`| **Required** | The name of a registered detector vision service. The segmenter vision service uses the detections from `"detector_name"` to create the 3D segments. | | `confidence_threshold_pct` | Optional | A number between 0 and 1 which represents a filter on object confidence scores. Detections that score below the threshold will be filtered out in the segmenter. The default is 0.5. | diff --git a/docs/services/vision/mlmodel.md b/docs/services/vision/mlmodel.md index cbd031392b..abe561746b 100644 --- a/docs/services/vision/mlmodel.md +++ b/docs/services/vision/mlmodel.md @@ -116,7 +116,7 @@ Click the **Save** button in the top right corner of the page. The following attributes are available for an `mlmodel` detector or classifier: -| Parameter | Type | Inclusion | Description | +| Parameter | Type | Required? | Description | | --------- | ---- | --------- | ----------- | | `mlmodel_name` | string | **Required** | The name of the [ML model service](/services/ml/deploy/) you want to use the model from. | | `remap_output_names` | object | Optional | The names of your output tensors, mapped to the service requirements. See [Tensor names](#tensor-names) for more information. | diff --git a/docs/services/vision/obstacles_depth.md b/docs/services/vision/obstacles_depth.md index c95aae5fb2..05b7869e9f 100644 --- a/docs/services/vision/obstacles_depth.md +++ b/docs/services/vision/obstacles_depth.md @@ -111,7 +111,7 @@ Add the following vision service object to the services array in your raw JSON c The following parameters are available for an `"obstacles_depth"` segmenter: -| Parameter | Inclusion | Description | +| Parameter | Required? | Description | | --------- | --------- | ----------- | | `min_points_in_plane` | Optional | An integer that specifies how many points to put on the flat surface or ground plane when clustering. This is to distinguish between large planes, like the floors and walls, and small planes, like the tops of bottle caps.
Default: `500`
| | `min_points_in_segment` | Optional | An integer that sets a minimum size to the returned objects, and filters out all other found objects below that size.
Default: `10`
| diff --git a/docs/services/vision/obstacles_distance.md b/docs/services/vision/obstacles_distance.md index a90b895cae..79c41c5502 100644 --- a/docs/services/vision/obstacles_distance.md +++ b/docs/services/vision/obstacles_distance.md @@ -76,7 +76,7 @@ Add the vision service object to the services array in your raw JSON configurati The following parameters are available for a `obstacles_distance` segmenter: -| Parameter | Inclusion | Description | +| Parameter | Required? | Description | | --------- | --------- | ----------- | | `num_queries`| Optional | How many times the model should call [`GetPointCloud()`](/components/camera/#getpointcloud) before taking the average of the measurements and returning the single closest point. Accepts an integer between `1` and `20`.
Default: `10` | diff --git a/docs/services/vision/obstacles_pointcloud.md b/docs/services/vision/obstacles_pointcloud.md index a665b7e74a..62d580fed2 100644 --- a/docs/services/vision/obstacles_pointcloud.md +++ b/docs/services/vision/obstacles_pointcloud.md @@ -100,7 +100,7 @@ Add the vision service object to the services array in your raw JSON configurati The following parameters are available for a `"obstacles_pointcloud"`. -| Parameter | Inclusion | Description | +| Parameter | Required? | Description | | --------- | --------- | ----------- | | `min_points_in_plane` | Optional | An integer that specifies how many points to put on the flat surface or ground plane when clustering. This is to distinguish between large planes, like the floors and walls, and small planes, like the tops of bottle caps.
Default: `500`
| | `min_points_in_segment` | Optional | An integer that sets a minimum size to the returned objects, and filters out all other found objects below that size.
Default: `10`
| diff --git a/static/include/components/board/board-analogs.md b/static/include/components/board/board-analogs.md index dccbb5c1ee..1cded741cc 100644 --- a/static/include/components/board/board-analogs.md +++ b/static/include/components/board/board-analogs.md @@ -68,7 +68,7 @@ Assign a name to your analog and then fill in the required properties outlined b The following properties are available for `analogs`: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | |`name` | string | **Required** | Your name for the analog reader. | |`pin`| string | **Required** | The pin number of the ADC's connection pin, wired to the board. This should be labeled as the physical index of the pin on the ADC. diff --git a/static/include/components/board/board-digital-interrupts.md b/static/include/components/board/board-digital-interrupts.md index 243bf261c7..b4d0590643 100644 --- a/static/include/components/board/board-digital-interrupts.md +++ b/static/include/components/board/board-digital-interrupts.md @@ -61,7 +61,7 @@ Assign a name to your digital interrupt and then enter a pin number. The following properties are available for `digital_interrupts`: -| Name | Type | Inclusion | Description | +| Name | Type | Required? | Description | | ---- | ---- | --------- | ----------- | |`name` | string | **Required** | Your name for the digital interrupt. | |`pin`| string | **Required** | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the board's GPIO pin that you wish to configure the digital interrupt for. | diff --git a/static/include/components/ultrasonic-attributes.md b/static/include/components/ultrasonic-attributes.md index 07c42abf35..462b8e0c9e 100644 --- a/static/include/components/ultrasonic-attributes.md +++ b/static/include/components/ultrasonic-attributes.md @@ -1,5 +1,5 @@ -| Attribute | Type | Inclusion | Description | +| Attribute | Type | Required? | Description | | --------- | ---- | --------- | ----------- | | `trigger_pin` | string | **Required** | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the [board's](/components/board/) GPIO pin that you have wired [the ultrasonic's trigger pin](https://www.sparkfun.com/products/15569) to. | | `echo_interrupt_pin` | string | **Required** | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the pin [the ultrasonic's echo pin](https://www.sparkfun.com/products/15569) is wired to on the board. If you have already created a [digital interrupt](/components/board/#digital_interrupts) for this pin in the [board's configuration](/components/board/), use that digital interrupt's `name` instead. | diff --git a/static/include/services/cartographer/configparams.md b/static/include/services/cartographer/configparams.md index 114a995a6d..85775cb18c 100644 --- a/static/include/services/cartographer/configparams.md +++ b/static/include/services/cartographer/configparams.md @@ -1,5 +1,5 @@ -| Parameter Mode | Description | Inclusion | Default Value | Notes | +| Parameter Mode | Description | Required? | Default Value | Notes | | -------------- | ----------- | --------- | ------------- | ----- | | `mode` | `2d` | **Required** | None | | | `optimize_every_n_nodes` | How many trajectory nodes are inserted before the global optimization is run. | Optional | `3` | To disable global SLAM and use only local SLAM, set this to `0`. |