Upstream/esphome-docs
1
0
Fork 0
mirror of https://github.com/esphome/esphome-docs.git synced 2025-01-26 22:21:38 +01:00
Code Issues Projects Releases Wiki Activity

add stepper accel and decel to docs (#1288)

Browse Source
This commit is contained in:
WeekendWarrior1 2021-07-05 11:22:54 +10:00 committed by GitHub
parent aafea27b0a
commit 40ad369b4e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 40 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
components/stepper/index.rst
View File

@ -228,6 +228,46 @@ Configuration variables:
- **speed** (**Required**, :ref:`templatable <config-templatable>`, float): The speed
in ``steps/s`` (steps per seconds) to drive the stepper at.
.. _stepper-set_acceleration_action:
``stepper.set_acceleration`` Action
-----------------------------------
This :ref:`Action <config-action>` allows you to set the acceleration of a stepper at runtime.
.. code-block:: yaml
on_...:
- stepper.set_acceleration:
id: my_stepper
speed: 250 steps/s^2
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the stepper.
- **acceleration** (**Required**, :ref:`templatable <config-templatable>`, float): The acceleration
in ``steps/s^2`` (steps per seconds squared) to use when starting to move.
.. _stepper-set_deceleration_action:
``stepper.set_deceleration`` Action
-----------------------------------
This :ref:`Action <config-action>` allows you to set the deceleration of a stepper at runtime.
.. code-block:: yaml
on_...:
- stepper.set_deceleration:
id: my_stepper
speed: 250 steps/s^2
Configuration variables:
- **id** (**Required**, :ref:`config-id`): The ID of the stepper.
- **deceleration** (**Required**, :ref:`templatable <config-templatable>`, float): The same as ``acceleration``,
but for when the motor is decelerating shortly before reaching the set position.
.. _stepper-ha-config:
Home Assistant Configuration