Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[modbus_controller] on command sent trigger #4039

Merged
merged 6 commits into from
Jul 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions components/modbus_controller.rst
Original file line number Diff line number Diff line change
Expand Up @@ -89,6 +89,9 @@ Configuration variables:
- **lambda** (**Required**, :ref:`lambda <config-lambda>`):
Lambda that returns the value of this register.

Automations:

- **on_command_sent** (*Optional*, :ref:`Automation <automation>`): An automation to perform when a modbus command has been sent. See :ref:`modbus_controller-on_command_sent`

Example Client
--------------
Expand Down Expand Up @@ -721,6 +724,28 @@ The response is mapped to the sensor based on ``register_count`` and offset in b

.. _modbusseealso:

.. _modbus_controller-automations:

Automation
----------

.. _modbus_controller-on_command_sent:

``on_command_sent``
*******************

This automation will be triggered when a command has been sent by the `modbus_controller`. In :ref:`Lambdas <config-lambda>`
you can get the function code in ``function_code`` and the register address in ``address``.

.. code-block:: yaml

modbus_controller:
- id: modbus_con
# ...
on_command_sent:
then:
- number.increment: modbus_commands

See Also
--------

Expand Down