Documentation Update #92
Conversation
|
|
||
| This uses Python async/await syntax to asynchronously communicate with | ||
| a ClickPLC. For example: | ||
| This uses Python ≥3.5's async/await syntax to asynchronously communicate with |
There was a problem hiding this comment.
I explicitly removed this reference recently so I don't have to keep updating the numbers. Any modern python has await at this point
There was a problem hiding this comment.
Good call, I'l remove this.
| from clickplc import ClickPLC | ||
|
|
||
| async def get(): | ||
| async def foo(): |
There was a problem hiding this comment.
I understand what you mean with foo and bar, but let's stick with the more descriptive name. If you don't like using get twice, maybe get and get_serial?
| $ clickplc the-plc-ip-address tags-filepath | ||
| ``` | ||
|
|
||
| ### Warning with Serial Connection |
There was a problem hiding this comment.
AFAIK the ClickPLC doesn't support RS-485 only RS-232. The wiring is physically different.
(Aside: Not sure if you've had any exposure to the Productivity series, but they have both.)
Clarify your heading from a generic "warning" to something more specific - "exclusive access" or "interaction with Click Programming Software." Also, the last 2.5 sentences are wordy; see if you can reduce them.
There was a problem hiding this comment.
EDIT: Apparently some models actually do. Never mind
There was a problem hiding this comment.
Yeah, the "Click PLUS" models do have both as options.
| ``` | ||
|
|
||
| Currently, the following datatypes are supported: | ||
| All of the following datatypes are supported: |
2 participants
This PR updates README as well as a new file I made called
docs.mdfor an exercise. Happy to delete that if you'd like, it was moreso just a practice in documentation.