Skip to content

Latest commit

 

History

History
149 lines (119 loc) · 4.5 KB

model1.md

File metadata and controls

149 lines (119 loc) · 4.5 KB
title linkTitle weight type description images tags draft
Configure a Model1
Model1
12
docs
Configure a model1 arm.
/icons/components.png
name
components
true

The model1 arm model supports the XYZ unit made by Some Company(INSERT LINK AS APPLICABLE). Optional additional description/information.

To be able to test your component as you configure it, first physically assemble the component and connect it to your machine's computer. Power both on. Then, configure the component:

{{< tabs >}} {{% tab name="Config Builder" %}}

Navigate to the CONFIGURE tab of your machine's page in the Viam app. Click the + icon next to your machine part in the left-hand menu and select Component. Select the arm type, then select the model1 model. Enter a name or use the suggested name for your arm and click Create.

{{< imgproc src="/components/component/model1-builder.png" alt="Creation of a model1 arm in the Viam app config builder." resize="600x" >}}

Edit and fill in the attributes as applicable.

{{% /tab %}} {{% tab name="JSON Template" %}}

{
  "components": [
    {
      "name": <arm_name>,
      "model": "model1",
      "type": "arm",
      "namespace": "rdk",
      "attributes": {
        "board": <string>,
        "i2c_bus": <string>
      },
      "depends_on": []
    }
  ]
}

{{% /tab %}} {{% tab name="JSON Example" %}}

{
  "components": [
    {
      "name": "myArm",
      "model": "model1",
      "type": "arm",
      "namespace": "rdk",
      "attributes": {
        "board": "local",
        "i2c_bus": "1"
      },
      "depends_on": []
    }
  ]
}

{{% /tab %}} {{% tab name="Annotated JSON" %}}

Very optional; probably don't bother making one if you don't already have one handy.

{{% /tab %}} {{< /tabs >}}

The following attributes are available for model1 arms:

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.
attributes Optional int 300 Insert useful description here.

Test the component

After you configure your component, navigate to the CONTROL tab and select the Component dropdown panel.

Then explain how to interact with the panel.

{{}}

Troubleshooting

{{< readfile "/static/include/components/troubleshoot/component.md" >}}

Next steps

Text & Links