From c24e6367e1aaa4f8c246f7364490a8363595f62e Mon Sep 17 00:00:00 2001 From: JessamyT <75634662+JessamyT@users.noreply.github.com> Date: Thu, 7 Dec 2023 13:15:17 -0800 Subject: [PATCH] DOCS-1389: Update TMC5072 motor attributes (#2300) --- docs/components/motor/tmc5072.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/components/motor/tmc5072.md b/docs/components/motor/tmc5072.md index 7ffa632562..1e2acb5f29 100644 --- a/docs/components/motor/tmc5072.md +++ b/docs/components/motor/tmc5072.md @@ -52,7 +52,7 @@ Edit and fill in the attributes as applicable. "board": "", "spi_bus": "", "chip_select": "", - "index": "", + "index": "", "ticks_per_rotation": , "max_acceleration_rpm_per_sec": , "sg_thresh": , @@ -86,12 +86,11 @@ Edit and fill in the attributes as applicable. "type": "motor", "namespace": "rdk", "attributes": { - "board": "example-board", - "chip_select": "36", - "index": 0, + "chip_select": "0", + "index": 1, "max_acceleration": 10000, "max_rpm": 450, - "spi_bus": "main", + "spi_bus": "0", "ticks_per_rotation": 200 } } @@ -107,9 +106,8 @@ The following attributes are available for `TMC5072` motors: | Name | Type | Inclusion | Description | | ---- | ---- | --------- | ----------- | -| `board` | string | **Required** | `name` of the [board](/components/board/) to which the motor controller is wired. | | `spi_bus` | string | **Required** | The board [SPI bus](/components/board/#spis) over which the TMC chip communicates with the board. | -|`chip_select` | string | **Required** | The {{< glossary_tooltip term_id="pin-number" text="pin number" >}} of the GPIO pin on the board wired to the TMC controller. The board sets this high or low to let the TMC chip know whether to listen for commands over SPI. | +|`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. | | `index` | int | **Required** | The index of the part of the chip the motor is wired to. Either `1` or `2`, depending on whether the motor is wired to the "MOTOR1" terminals or the "MOTOR2" terminals, respectively. | | `ticks_per_rotation` | int | **Required** | Number of full steps in a rotation. 200 (equivalent to 1.8 degrees per step) is very common. If your data sheet specifies this in terms of degrees per step, divide 360 by that number to get ticks per rotation. | | `max_acceleration_rpm_per_sec` | number | **Required** | Set a limit on maximum acceleration in revolutions per minute per second. |