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

Documentation for modbus timeout PR #3570

Merged
merged 2 commits into from
Oct 9, 2017

Conversation

ziotibia81
Copy link
Contributor

@ziotibia81 ziotibia81 commented Oct 9, 2017

Description:

Pull request in home-assistant (if applicable): home-assistant/core#9780

```

Configuration variables:

- **type** (*Required*): Type of the connection to Modbus.
- **host** (*Required*): The IP address of your Modbus device, eg. 192.168.1.1.
- **port** (*Required*): The port for the communication.
- **timeout** (*Optional*): Timeout for slave response in seconds.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And please add the default value.

@@ -46,6 +48,7 @@ modbus:
stopbits: 1
bytesize: 8
parity: N
timeout: 1
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Dito

@@ -26,13 +26,15 @@ modbus:
type: tcp
host: IP_ADDRESS
port: 2020
timeout: 0.5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We try to keep all configuration samples minimal. Thus, no optional requirement in the default sample. This helps user to get started quickly by copy-&-paste the sample without worrying about optional parameters which they most likely not need. If required, insert a full configuration sample later that covers special setups or alike.

@fabaff fabaff added Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-feature This PR adds documentation for a new Home Assistant feature to an existing integration labels Oct 9, 2017
@fabaff fabaff merged commit b2032b2 into home-assistant:next Oct 9, 2017
@ziotibia81 ziotibia81 deleted the modbus_timeout branch October 9, 2017 21:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Hacktoberfest An PR on this issue (or the PR itself) is eligible towards Hacktoberfest! new-feature This PR adds documentation for a new Home Assistant feature to an existing integration
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants