DOCS-1222: Update PCA9685 I2C config info (#2015)

viamrobotics · Oct 12, 2023 · 19ca6f6 · 19ca6f6
1 parent f78142a
commit 19ca6f6
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 4 deletions.
diff --git a/assets/components/board/pca9685-ui-config.png b/assets/components/board/pca9685-ui-config.png
diff --git a/docs/components/board/pca9685.md b/docs/components/board/pca9685.md
@@ -31,6 +31,7 @@ Then remove and fill in the attributes as applicable to your board, according to
 {
   "board_name": "<your-board-name>",
   "i2c_name": "<your-bus-name>",
+  "i2c_bus": “<bus-identifier>”,
   "i2c_address": <int>
 }
 ```
@@ -40,8 +41,7 @@ Then remove and fill in the attributes as applicable to your board, according to
 
 ```json {class="line-numbers linkable-line-numbers"}
 {
-  "board_name": "local-pi",
-  "i2c_name": "1st-i2c-bus"
+  "i2c_bus": “1”
 }
 ```
 
@@ -60,7 +60,10 @@ Then remove and fill in the attributes as applicable to your board, according to
       "type": "board",
       "namespace": "rdk",
       "attributes": {
-        "board_name": "<your-board-name>"
+        "board_name": "<your-board-name>",
+        "i2c_name": "<your-bus-name>",
+        "i2c_bus": “<string>”,
+        "i2c_address": <int>
       },
       "depends_on": []
     }
@@ -76,7 +79,17 @@ The following attributes are available for `pca9685` boards:
 <!-- prettier-ignore -->
 | Name | Type | Inclusion | Description |
 | ---- | ---- | --------- | ----------- |
-| `board_name` | string | **Required** | The `name` of the board with GPIO pins your `pca9685` is [connected to](https://learn.adafruit.com/16-channel-pwm-servo-driver/hooking-it-up). |
+| `board_name` | string | Optional | The `name` of the board with GPIO pins your `pca9685` is [connected to](https://learn.adafruit.com/16-channel-pwm-servo-driver/hooking-it-up). |
+| `i2c_name` | string | Optional | The `name` of the `i2c` your `pca9685` is connected to, as configured in your main board's section of the config file. |
+| `i2c_bus` | string | Optional | The index of the board with GPIO pins your `pca9685` is connected to. Often a number. <br> Example: `”1”` |
+| `i2c_address` | int | Optional | The PCA9685's unique [I<sup>2</sup>C address](https://learn.adafruit.com/i2c-addresses/overview). |
+
+{{% alert title="Important" color="note" %}}
+
+Your PCA9685's config needs to include either just `i2c_bus`, or both `board_name` and `i2c_name`.
+Using `board_name` and `i2c_name` requires you to explicitly configure I<sup>2</sup>Cs on your main board, whereas using `i2c_bus` does not.
+
+{{% /alert %}}
 
 <!--
 | `analogs` | object | Optional | Attributes of any pins that can be used as Analog-to-Digital Converter (ADC) inputs. See [configuration info](/components/board/#analogs). |