search

Open-Mobile-Robotics / open-process-library

Open Process Library
MIT License
16 stars 2 forks source link

Make the user docs for the valve #7

Open aott33 opened 1 month ago

aott33 commented 1 month ago

I think the documentation for DMC's Siemens Open Library is a good reference for documenting the library. I found their documentation very helpful when first starting out using their library. Example below:

4- Siemens Open Library - Detailed Block Overview.pdf

zantiu commented 1 month ago

Yes. The Rockwell PlantPax object library docs are also a good example.

russwaddell commented 1 month ago

...Example below:

4- Siemens Open Library - Detailed Block Overview.pdf

See Section 7 starting p. 50 for valve tags and diagrams

russwaddell commented 1 month ago

Yes. The Rockwell PlantPax object library docs are also a good example.

https://literature.rockwellautomation.com/idc/groups/literature/documents/rm/proces-rm001_-en-p.pdf

See valve examples on p. 34-35. Not sure if this is the documentation you had in mind for PlantPax

zantiu commented 1 month ago

No Rockwell/PlantPax has dedicated docs for the objects. This is an older version example of the valve: https://literature.rockwellautomation.com/idc/groups/literature/documents/rm/syslib-rm014_-en-e.pdf But I can't find the latest one.

It's quite extensive. Probably a bit too much.

russwaddell commented 1 month ago

Diagrams of valves on page 25-26 are useful. I'm not sure most of the HMI element and alarm documentation are needed for our purposes.