Skip to content

Document how to write 1D and 2D controllers

Zbigniew Reszela requested to merge github/fork/reszelaz/2d_ctrl into develop

This PR adds documentation on how to write 1D and 2D controllers.

Since at the end 1D and 2D are timerable controllers as counter/timer controller, I decided to not duplicate the documentation and just reference to the counter/timer controller documentation and list the differences and additional features.

Similarly the 1D controller documentation does not duplicate the value referencing documentation which is placed in the 2D controller documentation.

These documentation does not follow the entire narration of developing "Springfield" hypothetical hardware controller as it is done for the motor and counter/timer. This would require more time and this PR just adds the strictly necessary information. This way we could advance with the last missing point from #1466.

@sardana-org/integrators could you please take a look on this one? Many thanks!

Merge request reports