From 3a22feedad54822aadc9c4804cc1b2b1330c0115 Mon Sep 17 00:00:00 2001 From: Sierra Guequierre Date: Wed, 13 Sep 2023 14:52:22 -0400 Subject: [PATCH] DOCS-1109: Clarify difference between `max_rotation_deg` and `max` attribute configuration for a `pi` servo (#1816) --- docs/components/servo/pi.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/components/servo/pi.md b/docs/components/servo/pi.md index 6e15b6d8c1..5868d6caf6 100644 --- a/docs/components/servo/pi.md +++ b/docs/components/servo/pi.md @@ -86,11 +86,11 @@ The following attributes are available for `pi` servos: | ---- | ---- | --------- | ----------- | | `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. | -| `min` | float | Optional | The minimum angle in degrees that the servo can reach.
Default = `0.0`
Range = [`0.0`, `180.0`] | -| `max` | float | Optional | The maximum angle in degrees that the servo can reach.
Default = `180.0`
Range = [`0.0`, `180.0`] | +| `min` | float | Optional | Sets a software limit on the minimum angle in degrees your servo can rotate to.
Default = `0.0`
Range = [`0.0`, `180.0`] | +| `max` | float | Optional | Sets a software limit on the maximum angle in degrees your servo can rotate to.
Default = `180.0`
Range = [`0.0`, `180.0`] | | `starting_position_degs` | float | Optional | Starting position of the servo in degrees.
Default = `0.0`
Range = [`0.0`, `180.0`] | | `hold_position` | boolean | Optional | If `false`, power down a servo if it has tried and failed to go to a position for a duration of 500 milliseconds.
Default = `true` | -| `max_rotation_deg` | int | Optional | The maximum angle the servo can rotate. Must be in between `min` and `max`.
Default = `180` | +| `max_rotation_deg` | int | Optional | The maximum angle that you know your servo can possibly rotate to, according to its hardware. Refer to your servo's data sheet for clarification. Must be greater than or equal to the value you set for `max`.
Default = `180` | {{% alert title="Tip" color="tip" %}}