rename Param -> Parameter

Change-Id: Idcbc440b76219282a888172890673a4d74935dfd
Reviewed-on: https://forge.frm2.tum.de/review/18210
Tested-by: JenkinsCodeReview <bjoern_pedersen@frm2.tum.de>
Reviewed-by: Enrico Faulhaber <enrico.faulhaber@frm2.tum.de>
This commit is contained in:
Enrico Faulhaber
2018-06-19 13:53:04 +02:00
parent 82caa33a5e
commit 22645b449b
11 changed files with 157 additions and 151 deletions

View File

@ -24,7 +24,7 @@ from math import atan
import time
import random
from secop.modules import Drivable, Command, Param
from secop.modules import Drivable, Command, Parameter
from secop.datatypes import FloatRange, EnumType, TupleOf
from secop.lib import clamp, mkthread
@ -41,82 +41,82 @@ class Cryostat(CryoBase):
- thermal transfer between regulation and samplen
"""
parameters = dict(
jitter=Param("amount of random noise on readout values",
jitter=Parameter("amount of random noise on readout values",
datatype=FloatRange(0, 1), unit="K",
default=0.1, readonly=False, export=False,
),
T_start=Param("starting temperature for simulation",
T_start=Parameter("starting temperature for simulation",
datatype=FloatRange(0), default=10,
export=False,
),
looptime=Param("timestep for simulation",
looptime=Parameter("timestep for simulation",
datatype=FloatRange(0.01, 10), unit="s", default=1,
readonly=False, export=False,
),
ramp=Param("ramping speed of the setpoint",
ramp=Parameter("ramping speed of the setpoint",
datatype=FloatRange(0, 1e3), unit="K/min", default=1,
readonly=False,
),
setpoint=Param("current setpoint during ramping else target",
setpoint=Parameter("current setpoint during ramping else target",
datatype=FloatRange(), default=1, unit='K',
),
maxpower=Param("Maximum heater power",
maxpower=Parameter("Maximum heater power",
datatype=FloatRange(0), default=1, unit="W",
readonly=False,
group='heater_settings',
),
heater=Param("current heater setting",
heater=Parameter("current heater setting",
datatype=FloatRange(0, 100), default=0, unit="%",
group='heater_settings',
),
heaterpower=Param("current heater power",
heaterpower=Parameter("current heater power",
datatype=FloatRange(0), default=0, unit="W",
group='heater_settings',
),
target=Param("target temperature",
target=Parameter("target temperature",
datatype=FloatRange(0), default=0, unit="K",
readonly=False,
),
value=Param("regulation temperature",
value=Parameter("regulation temperature",
datatype=FloatRange(0), default=0, unit="K",
),
pid=Param("regulation coefficients",
pid=Parameter("regulation coefficients",
datatype=TupleOf(FloatRange(0), FloatRange(0, 100),
FloatRange(0, 100)),
default=(40, 10, 2), readonly=False,
group='pid',
),
p=Param("regulation coefficient 'p'",
p=Parameter("regulation coefficient 'p'",
datatype=FloatRange(0), default=40, unit="%/K", readonly=False,
group='pid',
),
i=Param("regulation coefficient 'i'",
i=Parameter("regulation coefficient 'i'",
datatype=FloatRange(0, 100), default=10, readonly=False,
group='pid',
),
d=Param("regulation coefficient 'd'",
d=Parameter("regulation coefficient 'd'",
datatype=FloatRange(0, 100), default=2, readonly=False,
group='pid',
),
mode=Param("mode of regulation",
mode=Parameter("mode of regulation",
datatype=EnumType('mode', ramp=None, pid=None, openloop=None),
default='ramp',
readonly=False,
),
pollinterval=Param("polling interval",
pollinterval=Parameter("polling interval",
datatype=FloatRange(0), default=5,
),
tolerance=Param("temperature range for stability checking",
tolerance=Parameter("temperature range for stability checking",
datatype=FloatRange(0, 100), default=0.1, unit='K',
readonly=False,
group='stability',
),
window=Param("time window for stability checking",
window=Parameter("time window for stability checking",
datatype=FloatRange(1, 900), default=30, unit='s',
readonly=False,
group='stability',
),
timeout=Param("max waiting time for stabilisation check",
timeout=Parameter("max waiting time for stabilisation check",
datatype=FloatRange(1, 36000), default=900, unit='s',
readonly=False,
group='stability',

View File

@ -25,7 +25,7 @@ import random
import threading
from secop.lib.enum import Enum
from secop.modules import Readable, Drivable, Param
from secop.modules import Readable, Drivable, Parameter
from secop.datatypes import EnumType, FloatRange, IntRange, ArrayOf, StringType, TupleOf, StructOf, BoolType
@ -33,18 +33,18 @@ class Switch(Drivable):
"""switch it on or off....
"""
parameters = {
'value': Param('current state (on or off)',
'value': Parameter('current state (on or off)',
datatype=EnumType(on=1, off=0), default=0,
),
'target': Param('wanted state (on or off)',
'target': Parameter('wanted state (on or off)',
datatype=EnumType(on=1, off=0), default=0,
readonly=False,
),
'switch_on_time': Param('seconds to wait after activating the switch',
'switch_on_time': Parameter('seconds to wait after activating the switch',
datatype=FloatRange(0, 60), unit='s',
default=10, export=False,
),
'switch_off_time': Param('cool-down time in seconds',
'switch_off_time': Parameter('cool-down time in seconds',
datatype=FloatRange(0, 60), unit='s',
default=10, export=False,
),
@ -95,22 +95,22 @@ class MagneticField(Drivable):
"""a liquid magnet
"""
parameters = {
'value': Param('current field in T',
'value': Parameter('current field in T',
unit='T', datatype=FloatRange(-15, 15), default=0,
),
'target': Param('target field in T',
'target': Parameter('target field in T',
unit='T', datatype=FloatRange(-15, 15), default=0,
readonly=False,
),
'ramp': Param('ramping speed',
'ramp': Parameter('ramping speed',
unit='T/min', datatype=FloatRange(0, 1), default=0.1,
readonly=False,
),
'mode': Param('what to do after changing field',
'mode': Parameter('what to do after changing field',
default=1, datatype=EnumType(persistent=1, hold=0),
readonly=False,
),
'heatswitch': Param('name of heat switch device',
'heatswitch': Parameter('name of heat switch device',
datatype=StringType(), export=False,
),
}
@ -183,10 +183,10 @@ class CoilTemp(Readable):
"""a coil temperature
"""
parameters = {
'value': Param('Coil temperatur',
'value': Parameter('Coil temperatur',
unit='K', datatype=FloatRange(), default=0,
),
'sensor': Param("Sensor number or calibration id",
'sensor': Parameter("Sensor number or calibration id",
datatype=StringType(), readonly=True,
),
}
@ -199,13 +199,13 @@ class SampleTemp(Drivable):
"""a sample temperature
"""
parameters = {
'value': Param('Sample temperature',
'value': Parameter('Sample temperature',
unit='K', datatype=FloatRange(), default=10,
),
'sensor': Param("Sensor number or calibration id",
'sensor': Parameter("Sensor number or calibration id",
datatype=StringType(), readonly=True,
),
'ramp': Param('moving speed in K/min',
'ramp': Parameter('moving speed in K/min',
datatype=FloatRange(0, 100), unit='K/min', default=0.1,
readonly=False,
),
@ -246,16 +246,16 @@ class Label(Readable):
modules.
"""
parameters = {
'system': Param("Name of the magnet system",
'system': Parameter("Name of the magnet system",
datatype=StringType, export=False,
),
'subdev_mf': Param("name of subdevice for magnet status",
'subdev_mf': Parameter("name of subdevice for magnet status",
datatype=StringType, export=False,
),
'subdev_ts': Param("name of subdevice for sample temp",
'subdev_ts': Parameter("name of subdevice for sample temp",
datatype=StringType, export=False,
),
'value': Param("final value of label string",
'value': Parameter("final value of label string",
datatype=StringType,
),
}
@ -291,20 +291,20 @@ class DatatypesTest(Readable):
"""for demoing all datatypes
"""
parameters = {
'enum': Param('enum', datatype=EnumType(boo=None, faar=None, z=9),
'enum': Parameter('enum', datatype=EnumType(boo=None, faar=None, z=9),
readonly=False, default=1),
'tupleof': Param('tuple of int, float and str',
'tupleof': Parameter('tuple of int, float and str',
datatype=TupleOf(IntRange(), FloatRange(),
StringType()),
readonly=False, default=(1, 2.3, 'a')),
'arrayof': Param('array: 2..3 times bool',
'arrayof': Parameter('array: 2..3 times bool',
datatype=ArrayOf(BoolType(), 2, 3),
readonly=False, default=[1, 0, 1]),
'intrange': Param('intrange', datatype=IntRange(2, 9),
'intrange': Parameter('intrange', datatype=IntRange(2, 9),
readonly=False, default=4),
'floatrange': Param('floatrange', datatype=FloatRange(-1, 1),
'floatrange': Parameter('floatrange', datatype=FloatRange(-1, 1),
readonly=False, default=0, ),
'struct': Param('struct(a=str, b=int, c=bool)',
'struct': Parameter('struct(a=str, b=int, c=bool)',
datatype=StructOf(a=StringType(), b=IntRange(),
c=BoolType()),
),
@ -313,6 +313,6 @@ class DatatypesTest(Readable):
class ArrayTest(Readable):
parameters = {
"x": Param('value', datatype=ArrayOf(FloatRange(), 100000, 100000),
"x": Parameter('value', datatype=ArrayOf(FloatRange(), 100000, 100000),
default = 100000 * [0]),
}

View File

@ -22,7 +22,7 @@
import random
from secop.modules import Readable, Drivable, Communicator, Param
from secop.modules import Readable, Drivable, Communicator, Parameter
from secop.datatypes import FloatRange, StringType
@ -44,7 +44,7 @@ class Heater(Drivable):
but the implementation may do anything
"""
parameters = {
'maxheaterpower': Param('maximum allowed heater power',
'maxheaterpower': Parameter('maximum allowed heater power',
datatype=FloatRange(0, 100), unit='W',
),
}
@ -63,14 +63,14 @@ class Temp(Drivable):
but the implementation may do anything
"""
parameters = {
'sensor': Param(
'sensor': Parameter(
"Sensor number or calibration id",
datatype=StringType(
8,
16),
readonly=True,
),
'target': Param(
'target': Parameter(
"Target temperature",
default=300.0,
datatype=FloatRange(0),