tobbbbe
August 6, 2022, 8:40pm
1
Hi, I am trying to send the value from a sensor to a plc via modbus TCP.
Think you might want to look at Node red for this one as HA doesn’t work as a Modbus slave.
home-assistant:dev ← yury-sannikov:modbus-testing
opened 10:32AM - 25 Feb 21 UTC
<!--
You are amazing! Thanks for contributing to our project!
Please, DO N… OT DELETE ANY TEXT from this template! (unless instructed).
-->
## Breaking change
<!--
If your PR contains a breaking change for existing users, it is important
to tell them what breaks, how to make it work again and why we did this.
This piece of text is published with the release notes, so it helps if you
write it towards our users, not us.
Note: Remove this section if this PR is NOT a breaking change.
-->
This PR suppose not to introduce any breaking changes.
## Proposed change
<!--
Describe the big picture of your changes here to communicate to the
maintainers why we should accept this pull request. If it fixes a bug
or resolves a feature request, be sure to link to that issue in the
additional information section.
-->
Sometimes it makes sense to keep PLC or Programmable Relay as a Modbus master for reliability reasons. To connect with the Home Assistant one have to use an additional RS485 port and set up PLC as a slave. Sometimes this is not possible.
This PR adds the following features to the HomeAssistant:
Acts as a Modbus Slave device over the TCP RTU
Multiple virtual slave devices with the different unit address
Support multiple Modbus sensor entities on the same address using a bitmask
Support Modbus sensor to expose all supported data types as a slave
Support binary sensor
The idea is to keep the existing sensor code as-is and route read and write register methods to the Modbus Slave. That way, the Modbus Master can pull the data from the Slave and execute necessary actions. Also, Modbus Master can write data to the Slave sending any necessary telemetry.
Having both Master and Slave support enable Home Assistant to act as a Modbus switch, routing some of the actions between isolated Modbus networks.
## Type of change
<!--
What type of change does your PR introduce to Home Assistant?
NOTE: Please, check only 1! box!
If your PR requires multiple boxes to be checked, you'll most likely need to
split it into multiple PRs. This makes things easier and faster to code review.
-->
- [ ] Dependency upgrade
- [ ] Bugfix (non-breaking change which fixes an issue)
- [ ] New integration (thank you!)
- [x] New feature (which adds functionality to an existing integration)
- [ ] Breaking change (fix/feature causing existing functionality to break)
- [ ] Code quality improvements to existing code or addition of tests
## Example entry for `configuration.yaml`:
<!--
Supplying a configuration snippet, makes it easier for a maintainer to test
your PR. Furthermore, for new integrations, it gives an impression of how
the configuration would look like.
Note: Remove this section if this PR does not have an example entry.
-->
```yaml
# Example configuration.yaml
# You may notice the `type: tcpserver`
modbus:
name: power_main
type: tcpserver
host: 0.0.0.0
port: 5020
# senor.yaml
# sensor configuration stays as is
- platform: modbus
scan_interval: 1
registers:
- name: button_1
hub: power_main
slave: 77
register: 2
data_type: uint
# switch.yaml
- platform: modbus
registers:
- name: modbus_bit_switch
hub: power_main
slave: 77
register: 3
# having a state_bit_mask changes the switch behavior
# instead of writing command_on/command_off and comparing against state_on/state_off
# it applies a bit mask before do a state compare
# for the commands, command_on ORed and command_off ANDed with the register value before
# writing back to the slave state
# a bit mask to be applied to the register value
# ha_status = slave(register).value & state_bit_mask == state_on
state_bit_mask: 32
state_on: 32
state_off: 0
# Turn ON: slave(register) <== slave(register).value | command_on
command_on: 32
# Turn OFF: slave(register) <== slave(register).value & command_off
command_off: 65503
```
## Additional information
<!--
Details are important, and help maintainers processing your PR.
Please be sure to fill out additional details, if applicable.
-->
- This PR fixes or closes issue: fixes #
- This PR is related to issue:
- Link to documentation pull request:
## Checklist
<!--
Put an `x` in the boxes that apply. You can also fill these out after
creating the PR. If you're unsure about any of them, don't hesitate to ask.
We're here to help! This is simply a reminder of what we are going to look
for before merging your code.
-->
- [x] The code change is tested and works locally.
- [x] Local tests pass. **Your PR cannot be merged unless tests pass**
- [x] There is no commented out code in this PR.
- [x] I have followed the [development checklist][dev-checklist]
- [x] The code has been formatted using Black (`black --fast homeassistant tests`)
- [x] Tests have been added to verify that the new code works.
If user exposed functionality or configuration variables are added/changed:
- [ ] Documentation added/updated for [www.home-assistant.io][docs-repository]
If the code communicates with devices, web services, or third-party tools:
- [ ] The [manifest file][manifest-docs] has all fields filled out correctly.
Updated and included derived files by running: `python3 -m script.hassfest`.
- [ ] New or updated dependencies have been added to `requirements_all.txt`.
Updated by running `python3 -m script.gen_requirements_all`.
- [ ] Untested files have been added to `.coveragerc`.
The integration reached or maintains the following [Integration Quality Scale][quality-scale]:
<!--
The Integration Quality Scale scores an integration on the code quality
and user experience. Each level of the quality scale consists of a list
of requirements. We highly recommend getting your integration scored!
-->
- [ ] No score or internal
- [ ] 🥈 Silver
- [ ] 🥇 Gold
- [ ] 🏆 Platinum
<!--
This project is very active and we have a high turnover of pull requests.
Unfortunately, the number of incoming pull requests is higher than what our
reviewers can review and merge so there is a long backlog of pull requests
waiting for review. You can help here!
By reviewing another pull request, you will help raise the code quality of
that pull request and the final review will be faster. This way the general
pace of pull request reviews will go up and your wait time will go down.
When picking a pull request to review, try to choose one that hasn't yet
been reviewed.
Thanks for helping out!
-->
To help with the load of incoming pull requests:
- [x] I have reviewed two other [open pull requests][prs] in this repository.
[prs]: https://github.com/home-assistant/core/pulls?q=is%3Aopen+is%3Apr+-author%3A%40me+-draft%3Atrue+-label%3Awaiting-for-upstream+sort%3Acreated-desc+review%3Anone
<!--
Thank you for contributing <3
Below, some useful links you could explore:
-->
[dev-checklist]: https://developers.home-assistant.io/docs/en/development_checklist.html
[manifest-docs]: https://developers.home-assistant.io/docs/en/creating_integration_manifest.html
[quality-scale]: https://developers.home-assistant.io/docs/en/next/integration_quality_scale_index.html
[docs-repository]: https://github.com/home-assistant/home-assistant.io
cc @adamchengtkc @janiversen @vzahradnik
But Node red can pull the data from HA and either act as a Modbus slave or if it’s an Allen Bradley PLC, it can write to the tag directly.