search

pcdshub / lcls-twincat-motion

TwinCAT 3 Motion Control Utilities - PLC Motion Library for all PCDS Applications
https://pcdshub.github.io/lcls-twincat-motion
Other
35 stars 20 forks source link

MNT: Add docstrings and pragmas to DUT_MotionStage #22

Closed ZLLentz closed 5 years ago

ZLLentz commented 5 years ago

Added a pytmc pragma to every variable. Moved and edited the docstrings for clarity and consistency, and so that TwinCAT will pick them up when viewing the struct online.

ZLLentz commented 5 years ago

Accepting all opinions about what the PV names should actually be. A lot of these may be useful for debugging later.

ZLLentz commented 5 years ago

Quick conclusion before I merge this: I settled on the prefix PLC: for all of these because it makes it very clear where the values are coming from. These PVs are all intended for debug purposes.

An example PV in the new motion system would be something like IM3L0:PPM:MMS:Y:PLC:bBrakeRelease_RBV

Most of these are read-only, but I left a few writable because they may be useful debug points.