37 Commits

Author SHA1 Message Date
Jens Krüger
318b3ad412 Update copyright year
Change-Id: I7fe65e46639c2d8948fa93303ee9b14393e8bfca
2024-09-13 08:59:40 +02:00
Alexander Zaft
15d38d7cc1 all: remove coding cookies
Change-Id: I53a4d79c3ebc50b8aed43a5ef1fa6538f8059a47
Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/32251
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Alexander Zaft <a.zaft@fz-juelich.de>
2024-01-29 14:06:06 +01:00
158477792f add StringIO.writeline, improve StringIO.multicomm
- StringIO.writeline sends a command and does not expect a reply
- StringIO.multicomm and BytesIO.multicomm is improved in order
  to insert individual delays in between lines and individual
  noreply flags

+ fix a bug in tutorial_t_control
+ improve readability of frappy.lib.classdoc.indent_description

Change-Id: I9dea113e19147684ec41aca5267a79816bbf202c
Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/32267
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2024-01-29 13:34:45 +01:00
fd0e762d18 doc: drop latex support, add pdf support
latexpdf fails with error message "Too deply nested".
We want to avoid reducing the nesting level of doc strings
in frappy.lib.classdoc (less nice output) or a level of
nesting in method doc strings.

- latex removed from Jenkinsfile
- added support for rst2pdf

Change-Id: Ieb3355ef506e636e7e43a726c68327e3b1154469
Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/32406
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2024-01-29 13:34:39 +01:00
4c5109e5a3 fix frappy_demo.lakeshore
reading back the target does not work properly, because
  a) the readback value might be delayed
  b) there is no command to read back the target, SETP?1
     is returning the working setpoint, which might be distinct
     in case of a ramp

Change-Id: I0da2dbfc1a8ddbecbae6d0456ff64e008bc56336
Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/31983
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2023-09-14 09:09:09 +02:00
138b84e84c add a hook for reads to be done initially
inital reads from HW should be done in the thread started by
startModule, not in startModule itself.

- add a hook method 'initialReads' for this
+ add doc for init methods
+ fix some errors in doc

Change-Id: I914e3b7ee05050eea1ee8aff3461030adf08a461
Reviewed-on: https://forge.frm2.tum.de/review/c/secop/frappy/+/31374
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2023-06-20 08:03:37 +02:00
l_samenv
db94def694 newest version of okasanas drivers 2023-05-17 16:56:49 +02:00
da15df076a fetched mlz version
- before some chamges in the gerrit pipline

Change-Id: I33eb2d75f83345a7039d0fb709e66defefb1c3e0
2023-05-02 15:25:11 +02:00
6c325460f7 make doc when .git is not there
accept failure of secop.version.get_version()

Change-Id: Ia689bd4f56b848bc354c0d68826a3174f0746a97
2023-01-23 18:00:20 +01:00
b1ddc01fbb merge until "support write_ method on readonly param and more"
from gerrit

Change-Id: I8d2ad2a381d3a37947d8afc5e17be0428d94df36
2022-03-21 14:00:12 +01:00
34b93adef0 more merges from gerrit
Change-Id: I13441cd8889dd39f74a2dd1a85e75a1b76bb93c8
2022-03-08 10:52:14 +01:00
l_samenv
adc9a6da71 fixed bugs from syntax migration
- a new wrapper for a read function is not only to be created when
  the a new read method is in the class dict, but also when
  it is inherited, but not yet wrapped
- a handler must not be ignored, when a write method is inherited
- a proxy class must not call checkProperties

+ remove trailing spaces in tutorial_helevel.rst

Change-Id: I16024c14232ea200db91a1bc07ec23326219ab68
Reviewed-on: https://forge.frm2.tum.de/review/c/sine2020/secop/playground/+/25093
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2021-03-08 10:22:58 +01:00
l_samenv
b1bf5e866d improve tutorial_helevel
- fix indent of query method
- add remark about the CCU4 cid command
2021-03-03 10:17:05 +01:00
76c6ebe92c fixed errors during migration
- reference.rst did still contain do_<something>
- trailing commas in secop_demo/cryo.py

Change-Id: I5bb8bd310576366c8cfe406f0ec770fa40bcab5b
Reviewed-on: https://forge.frm2.tum.de/review/c/sine2020/secop/playground/+/25079
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2021-03-03 09:06:01 +01:00
07b758c3dd removed old style syntax
- removed secop/metaclass.py
- moved code from ModuleMeta to modules.HasAccessibles.__init_subclass__
- reworked properties:
  assignment obj.property = value now always allowed
- reworked Parameters and Command to be true descriptors
- Command must now be solely used as decorator
- renamed 'usercommand' to 'Command'
- command methods no longer start with 'do_'
- reworked mechanism to determine accessible order:
  the attribute paramOrder, if given, determines order of accessibles
+ fixed some issues makeing the IDE more happy
+ simplified code for StatusType and added a test for it

Change-Id: I8045cf38ee6f4d4862428272df0b12a7c8abaca7
Reviewed-on: https://forge.frm2.tum.de/review/c/sine2020/secop/playground/+/25049
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2021-02-26 17:27:13 +01:00
f9a2152883 enhance documentation
- flatten hierarchy (some links do not work when using folders)
- add a tutorial for programming a simple driver
- clean description using inspect.cleandoc
+ fix a bug with 'unit' pseudo property in a Parameter used as override

Change-Id: I31ddba5d516d1ee5e785e28fbd79fca44ed23f5e
Reviewed-on: https://forge.frm2.tum.de/review/c/sine2020/secop/playground/+/25000
Tested-by: Jenkins Automated Tests <pedersen+jenkins@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2021-02-26 17:27:13 +01:00
Enrico Faulhaber
536c798699 Remove obsolete protocol specification
The one at https://www.github.com/SampleEnvironment/SECoP
is the correct version!

Change-Id: I4f8a9c3b40ea4e1f3ecea8b7b491dd96cb04d009
Reviewed-on: https://forge.frm2.tum.de/review/c/sine2020/secop/playground/+/21437
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2019-10-18 16:30:54 +02:00
Enrico Faulhaber
3eaa32d514 rename framework methods to camelCase
for easier distinction:
- camelCase or singleword: framework method
- snake_case: driver method

(driver) parameters are lowercase, single word framework variables may
have to start with uppercase letters to distinguish...

Change-Id: I76536b6390324625b242c4f190553014c2ca61d6
Reviewed-on: https://forge.frm2.tum.de/review/20295
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2019-04-02 08:15:40 +02:00
Enrico Faulhaber
a230e553a9 add default role to doc conf.py
Change-Id: If67755186150a3a7a0432caca9d2bdf945ae35fe
Reviewed-on: https://forge.frm2.tum.de/review/20216
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
2019-03-26 10:42:49 +01:00
Björn Pedersen
01075b7183 doc: Add a last-updated timestamp to html
Change-Id: I971516f45b52dcb73761f9f022a831bf329a5b6f
Reviewed-on: https://forge.frm2.tum.de/review/19621
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Jens Krueger <jens.krueger@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
2018-12-20 16:42:57 +01:00
Frank Wutzler
3e9733d8f3 describe SECoP motivation discussed in meeting 2017-11-27
Change-Id: Ib82b9ac195dccb29ce5c314e67840bcdd02e0515
Signed-off-by: Frank Wutzler <frank.wutzler@helmholtz-berlin.de>
Reviewed-on: https://forge.frm2.tum.de/review/16892
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
2017-12-15 13:57:00 +01:00
Enrico Faulhaber
69e77749fb fix typo and include comment from Niklas
Change-Id: I12656269a399d8e0602304187a833d0781906084
Reviewed-on: https://forge.frm2.tum.de/review/16848
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
2017-12-05 10:01:00 +01:00
Enrico Faulhaber
97d0d33049 add info about Meeting @PSI
Change-Id: I45231cd0fc35925d668615aed724b5c3d37629a3
Signed-off-by: Lutz Rossa <rossa@helmholtz-berlin.de>
Reviewed-on: https://forge.frm2.tum.de/review/16789
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Reviewed-by: Anders Pettersson <anders.pettersson@esss.se >
2017-12-04 13:57:39 +01:00
4cf4ecb507 - fixed documentation hierarchy
Change-Id: Ic61b10c393b1d5fa12d194a804c19f23a570c792
Reviewed-on: https://forge.frm2.tum.de/review/16708
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Markus Zolliker <markus.zolliker@psi.ch>
2017-11-15 11:48:47 +01:00
8663501150 revision of SECoP documentation
- created secop_v2017-09-14.rst, based on the GoogleDocs
  SECoP Preliminary V2016-11-30 (rc 2)
- this Document is supposed to contain the full SECoP standard
- created SECoP issues
- moved everything else to "outdated" (kept for reference)

Change-Id: I87d69d1846fc4ed55f1c78b22fd4650d8550152b
Reviewed-on: https://forge.frm2.tum.de/review/16573
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
2017-11-03 08:46:20 +01:00
Enrico Faulhaber
eeac276601 Remove obsolete protocol implementations
Change-Id: I9342ff3d00666238b6412b41a3785dadd96a7778
Reviewed-on: https://forge.frm2.tum.de/review/16273
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
2017-09-18 15:14:04 +02:00
Alexander Lenz
35fe312214 doc: fix format.
Change-Id: I13b33706ba160b0402eb2a06323e9cd74179fc72
2017-09-13 17:00:46 +02:00
6c0f54d988 doc update (commands and datatypes)
Change-Id: Ia89a179043491be71d0b2d1fac7a6e41b596c91d
2017-09-13 16:21:08 +02:00
Alexander Lenz
e6fd421ec7 doc: fix cp errors.
Change-Id: Id93a78f463a6b782e10b230509af61b6f86c146f
2017-09-13 16:19:19 +02:00
Alexander Lenz
ffd84c4b6e doc: Fix escapes.
Change-Id: If0abff5e259eeaa66c4b8357b72e4f9f2646531c
2017-09-13 15:42:11 +02:00
Alexander Lenz
4e1dd2507e doc: remove html escapes.
Change-Id: I9e5f31ecff93e17dfee344cdc74c0ff9bd1b4600
2017-09-13 15:38:58 +02:00
Alexander Lenz
07b6351db6 doc: fix protocol/datatypes.
Change-Id: I98feff61d7303f73aff6f038cda3bdeb94fea021
2017-09-13 15:28:58 +02:00
Alexander Lenz
8a1a062415 doc: improve layout.
Change-Id: I22d700a3c634d19aa6e3220f79b302261c0beb0c
2017-09-13 14:34:04 +02:00
Alexander Lenz
c652d0a14b doc: add datatypes.
Change-Id: Ia8e3903d619f733cd2951945a2a2bbc8d883b3e7
2017-09-12 18:29:59 +02:00
Enrico Faulhaber
96ac437fd3 fix transport and display of node-properties
Change-Id: I35a3021768e386a5ce922c8e24128d0bc3a039be
2017-09-12 16:10:22 +02:00
Enrico Faulhaber
ba59448442 fixups
Change-Id: If1377ef41f8d500ccab0e2a0979343b4c090c036
2017-09-11 17:50:20 +02:00
Alexander Lenz
77b01404d9 Improve doc.
Change-Id: I0b25fd1c645a47084fb7fda1bbb7d41a2d10dcbb
2017-09-11 17:35:03 +02:00