From 6e73420d0ff2570f940bc101771b9cfd920e2345 Mon Sep 17 00:00:00 2001 From: Markus Zolliker Date: Fri, 3 Dec 2021 16:49:48 +0100 Subject: [PATCH] add doc strings to commands missing them Change-Id: Ib0320cc4653ff695a7ee2bad3486eeec5309d3b1 --- secop_psi/phytron.py | 1 + secop_psi/sea.py | 5 +++++ secop_psi/trinamic.py | 1 + 3 files changed, 7 insertions(+) diff --git a/secop_psi/phytron.py b/secop_psi/phytron.py index 0070ef1..3a020a7 100644 --- a/secop_psi/phytron.py +++ b/secop_psi/phytron.py @@ -148,6 +148,7 @@ class Motor(PersistentMixin, HasIodev, Drivable): @Command def reset(self): + """reset error, set position to encoder""" self.read_value() if self.status[0] == self.Status.ERROR: enc = self.encoder - self.zero diff --git a/secop_psi/sea.py b/secop_psi/sea.py index a70b9b6..0bde526 100644 --- a/secop_psi/sea.py +++ b/secop_psi/sea.py @@ -651,4 +651,9 @@ class SeaDrivable(SeaModule, Drivable): @Command() def stop(self): + """propagate to SEA + + - on stdsct drivables this will call the halt script + - on EaseDriv this will set the stopped state + """ self._iodev.query('%s is_running 0' % self.sea_object) diff --git a/secop_psi/trinamic.py b/secop_psi/trinamic.py index 3bfbaea..ef173b4 100644 --- a/secop_psi/trinamic.py +++ b/secop_psi/trinamic.py @@ -366,6 +366,7 @@ class Motor(PersistentMixin, HasIodev, Drivable): @Command(FloatRange()) def set_zero(self, value): + """adapt zero to make current position equal to given value""" raw = self.read_value() - self.zero self.write_zero(value - raw)