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

Add documentation for S7 and Modbus adapters #1914

Merged
merged 2 commits into from
Sep 12, 2023

Conversation

dominikriemer
Copy link
Member

Purpose

Add documentation for the PLC4X S7 and Modbus adapters.

Remarks

PR introduces (a) breaking change(s): no

PR introduces (a) deprecation(s): no

@github-actions github-actions bot added connect Related to the `connect` module (adapters) documentation Everything related to documentation labels Sep 11, 2023
Copy link
Contributor

@tenthe tenthe left a comment

Choose a reason for hiding this comment

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

Thank you very much for writing the documentation for the adapters. I find it very helpful. I added two small comments regarding the CSV files.
I think it would be very helpful to have good CSV examples here, because then we always have a good reference that we can copy and show to others.

should be added as nodes. Here is an example export enriched with the runtime name:

```
Runtime Name,Path,Data Type,Node Name,Comment,Hmi Visible,Hmi Accessible,Hmi Writeable,Typeobject ID,Version ID
Copy link
Contributor

Choose a reason for hiding this comment

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

Only the Runtime Name, Data Type, and Node Name columns are required. The mapping is done based on the title of the correspondingStaticProperty. All other fields are ignored. I'd suggest removing the other columns for simplicity. Maybe we can add a comment if there are more columns it is not a problem because they will be ignored.

Copy link
Member Author

Choose a reason for hiding this comment

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

I left one additional field so that it is clear that the CSV does not exactly need to contain the required fields.

### Nodes

The `Nodes` section requires configuration options for the individual nodes.
Nodes can be either imported from a comma-separated CSV file, or can be directly assigned in the configuration menu.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can here also provide a small sample CSV, that a user can copy to get started.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added a CSV example.

@dominikriemer dominikriemer merged commit f0cd81b into dev Sep 12, 2023
@dominikriemer dominikriemer deleted the improve-docs-for-s7-and-modbus branch September 12, 2023 19:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
connect Related to the `connect` module (adapters) documentation Everything related to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants