Reload Modbus configuration
Use this action to reload your Modbus configuration from YAML without restarting Home Assistant. This applies changes to your hubs and entities and restarts the connections.
Using this action from the user interface
If you prefer building automations and scripts visually, Home Assistant walks you through this action step by step. You pick what to target, tweak a few options, and save. No YAML knowledge required.
To reload the Modbus configuration from an automation or a script:
- Go to Settings > Automations & scenes.
- Open an existing automation or script, or select Create to start a new one.
- If you’re setting up a new automation, add a trigger in the When section. Scripts don’t need a trigger.
- In the Then do section, select Add action.
- From the search box, search for and select Modbus: Reload.
- Select Save.
This action does not support targets. In the UI, you are not prompted to choose an area, device, entity, or label. Only users with administrator rights can run this action.
Options in the UI
This action has no additional options in the UI.
Using this action in YAML
If you work directly in YAML, or you want to know exactly what Home Assistant does under the hood, this section has the technical reference. It lists the field names you use in YAML, their types, and which ones are required.
In YAML, refer to this action as modbus.reload. A basic example looks like this:
action: modbus.reload
This reloads the Modbus configuration from your YAML configuration.
Options in YAML
This action has no additional options in YAML.
Good to know
- Run this action after you change your Modbus configuration in YAML so the changes take effect without a restart.
Try it yourself
Ready to test this? Open Developer tools > Actions, search for this action, fill in the fields, and select Perform action. You see what happens on your actual entitiesAn entity represents a sensor, actor, or function in Home Assistant. Entities are used to monitor physical properties or to control other entities. An entity is usually part of a device or a service. [Learn more] without writing a line of YAML.
Still stuck?
The Home Assistant community is quick to help: join Discord for real-time chat, post on the community forum with the action you’re calling and what you expected to happen, or share on our subreddit /r/homeassistant.
AI assistants like ChatGPT or Claude can also explain actions or suggest the right one when you describe what you want in plain language.
Related actions
These actions work well alongside this one:
-
Stop hub: Stops a Modbus hub and closes its connection.
-
Write register: Writes a value to one or more Modbus holding registers.
-
Write coil: Writes a state to one or more Modbus coils.