Omron E5CK Temperature Controller

The Omron E5CK temperature controllers are programmable temperature controllers. The Py4Syn implementation is strongly software based, overcoming device programming limitations, allowing it to be used like an IScannable device and supporting tens of thousands of ramp steps.

Using EPICS Omron E5CK temperature controller module

Usage of Python class for EPICS Omron E5CK temperature controllers.

class py4syn.epics.OmronE5CKClass.OmronE5CK(pvName, mnemonic)

Class to control Omron E5CK temperature controllers via EPICS.

Examples

>>> from py4syn.epics.OmronE5CKClass import OmronE5CK
>>> 
>>> def showTemperature(pv='', name=''):
...     e5ck = OmronE5CK(pv, name)
...     print('Temperature is: %d' % e5ck.getValue())
...
>>> def fastRaiseTemperature(e5ck, amount, rate=30):
...     e5ck.setRate(rate)
...     e5ck.setValue(e5ck.getValue() + amount)
...
>>> def complexRamp(e5ck):
...     e5ck.setRate(10)
...     e5ck.setValue(200)
...     e5ck.wait()
...     e5ck.setRate(2)
...     e5ck.setValue(220)
...     e5ck.wait()
...     sleep(500)
...     e5ck.setRate(5)
...     e5ck.setValue(100)
...     e5ck.wait()
...     e5ck.stop()
...
>>> import py4syn
>>> from py4syn.epics.ScalerClass import Scaler
>>> from py4syn.utils.counter import createCounter
>>> from py4syn.utils.scan import scan
>>> 
>>> def temperatureScan(start, end, rate, pv='', counter='', channel=2):
...     e5ck = OmronE5CK(pv, 'e5ck')
...     py4syn.mtrDB['e5ck'] = e5ck
...     c = Scaler(counter, channel, 'simcountable')
...     createCounter('counter', c, channel)
...     e5ck.setRate(rate)
...     scan('e5ck', start, end, 10, 1)
...     e5ck.stop()
...

Constructor See py4syn.epics.StandardDevice

Parameters:

pvName : string

Power supply base naming of the PV (Process Variable)

mnemonic : string

Temperature controller mnemonic

advance()

Helper method to skip the current program step and execute the next one.

getD()

Return the current D value at the furnace

Returns:

`double`

getHighLimitValue()

Returns the controller high limit temperature.

Returns:

`float`

getI()

Return the current I value at the furnace

Returns:

`double`

getLowLimitValue()

Returns the controller low limit temperature.

Returns:

`float`

getNumPIDElements()

Return the number of all parameters at a PID table

Returns:

`int`

getP()

Return the current P value at the furnace

Returns:

`double`

getPIDTable()

Return the current PID table at the furnace

Returns:

`array`

getPower()

Return the current Power value at the furnace

Returns:

`double`

getRealPosition()

Returns the same as getValue().

See: getValue()

Returns:

`float`

getStepNumber()

Helper method to get the current program step.

Returns:

`int`

getStepNumberSync()

Helper module to retrieve an up-to-date value for the current program step number. Similar to getStepNumber(), but it doesn’t rely on monitor value and instead does a synchronous caget() call.

See: getStepNumber()

Returns:

`int`

getTarget()

Returns the current target temperature. If the device is running, the target temperature is the temperature the device is changing to. If the device is not running, the target temperature is ignored.

Returns:

`float`

getTimeScale()

Returns the time scale being used by the controller. The timescale can either be zero, for hours:minutes, or one, for minutes:seconds.

Returns:

`int`

getValue()

Returns the current measured temperature.

Returns:

`float`

isPaused()

Returns true if the controller is paused (keep temperature).

Returns:

`bool`

isRunning()

Returns true if the controller is in program mode. Whenever it is program mode, it is following a target temperature.

Returns:

`bool`

onProgrammingChange(value, **kwargs)

Helper callback that tracks when the IOC finished programming the device.

onStepChange(value, **kwargs)

Helper callback that indicates when a new program step has been reached

onTemperatureChange(value, **kwargs)

Helper callback that indicates when the measured temperature has changed

pause()

Pauses current ramp program. To resume program, use run()

See: run()

preset()

Makes the controler enter a well defined known state. This method creates and runs an “empty” ramp program. The program simply mantains the current temperature forever, whatever that temperature is. This is mostly a helper function, to allow making complex temperature ramps starting from a known state and reusing the preset values.

Note

Running a new program requires stopping the current program. While the program is stopped, the controller power generation drops to zero. Because of this power drop, this method may be slow to stabilize.

program(programTable)

Set a programTable to the furnace

run()

Starts or resumes executing the current temperature program.

sendCommand(command)

Helper method to send a custom command to the controller.

Parameters:

command : str

The command to be send

setPIDTable(pidTable)

Set a PIDtable to the furnace

setRate(r)

Sets the ramp speed in degrees per minutes for use with setValue(). This method does not send a command to the controller, it only stores the rate for the next ramps.

See: setValue()

Parameters:

r : float

Ramp speed in °C/min

setTimeScale(minutes)

Changes the time scale being used by the controller. The timescale can either be zero, for hours:minutes, or one, for minutes:seconds. This operation requires switching the controller operation mode to be successful, and then a reset is issued after it. The whole operation takes more than 5 seconds.

Parameters:

minutes : int

Set to 1 for minutes:seconds, or 0 for hours:minutes

setValue(v)

Changes the temperature to a new value. This method calls preset if it has not already been called first. The speed that the new temperature is reached is set with setRate(). The default rate is 5 °C/minute.

See: setRate()

Parameters:

v : float

The target temperature in °C

setVelocity(velo)

Same as setRate().

See: setRate()

Parameters:

r : float

Ramp speed in °C/min

stop()

Stops executing the current temperature program and puts the device in idle state. In the idle state, the device will not try to set a target temperature.

synchronizeStep(current)

Helper method to set up a constant temperature right before running a ramp program. This method detects if a current ramp program is running or not. If it’s not, then it doesn’t do anything. If there is a ramp running, then it configures and advances to a “synchronization step”, that is, a step where the temperature does not change. This step marks the beginning of the new ramp.

The method returns the resulting step number

Parameters:

current : float

The temperature target for the synchronization step

Returns:

`int`

timeToValue(t)

Helper method to convert between minutes to the format used by the controller.

Parameters:

t : float

The desired time, in minutes

Returns:

`float`

wait()

Blocks until the requested temperature is achieved.