clib.setup_buffer.SetupBuffer Class Reference

Class manage the buffer of the setup request. More...

Public Member Functions
def	__init__ (self, cii)
def	update_json_data (self, json_data)
	This method merges a json object into a existing one. More...
def	add_json_file (self, file)
	Loads and parse a JSON file. More...
def	dump_json (self)
	Print out the elements in the internal JSON object. More...
def	add_json_string (self, json_str)
	Loads and parse a JSON string. More...
def	json2object (self)
	Loads and parse a JSON dictionary. More...
def	add_shutter_close (self, device, override=False)
	Close a shutter. More...
def	add_shutter_open (self, device, override=False)
	Open a shutter. More...
def	add_lamp_switch_on (self, device, override=False)
	Switch a lamp ON. More...
def	add_lamp_switch_on_with_intensity (self, device, intensity, override=False)
	Switch a lamp ON with intensity. More...
def	add_lamp_switch_on_with_timer (self, device, timer, intensity=100, override=False)
	Switch a lamp ON for a period of time. More...
def	add_lamp_switch_off (self, device, override=False)
	Switch a lamp OFF. More...
def	add_motor_move_abs_enc (self, device, position, override=False)
	Move a motor in absolute encoders. More...
def	add_motor_move_abs_pos (self, device, position, override=False)
	Move a motor in absolute user units. More...
def	add_motor_move_rel_enc (self, device, position, override=False)
	Move a motor in relative encoders. More...
def	add_motor_move_rel_pos (self, device, position, override=False)
	Move a motor in relative user units. More...
def	add_motor_move_name_pos (self, device, name, override=False)
	Move a motor to a named position. More...
def	add_motor_move_by_speed (self, device, speed, override=False)
	Move a motor to a named position. More...
def	add_drot_move_abs_pos (self, device, position, override=False)
	Move DROT to absolute position in user units. More...
def	add_drot_move_rel_pos (self, device, position, override=False)
	Move DROT to relative position in user units. More...
def	add_drot_move_by_speed (self, device, speed, override=False)
	Move a motor to a named position. More...
def	add_drot_move_posangle (self, device, position, override=False)
	Move DROT to position angle. More...
def	add_drot_start_sky_tracking (self, device, position=0.0, override=False)
	Start DROT tracking in Sky mode. More...
def	add_drot_start_elev_tracking (self, device, position=0.0, override=False)
	Start DROT tracking in Elev mode. More...
def	add_drot_start_user_tracking (self, device, position=0.0, override=False)
	Start DROT tracking in User mode. More...
def	add_drot_stop_tracking (self, device, override=False)
	Stop DROT tracking. More...
def	add_drot_track_offset (self, device, offset, override=False)
	Offset current position while tracking. More...
def	add_adc_move_motor1_abs_pos (self, device, position, override=False)
	Move ADC motor1 to an absolute position in user units. More...
def	add_adc_move_motor2_abs_pos (self, device, position, override=False)
	Move ADC motor2 to an absolute position in user units. More...
def	add_adc_move_posangle (self, device, position, override=False)
	Move DROT to a specific position angle. More...
def	add_adc_start_tracking (self, device, override=False)
	Start ADC tracking in Auto mode. More...
def	add_adc_stop_tracking (self, device, override=False)
	Stop ADC tracking. More...
def	add_piezo_set_auto (self, device, override=False)
	Set PIEZO to AUTO mode. More...
def	add_piezo_set_pos (self, device, override=False)
	Set PIEZO to POS mode. More...
def	add_piezo_set_home (self, device, override=False)
	Set PIEZO to HOME position. More...
def	add_piezo_move_in_user_units (self, device, pos1, pos2, pos3, override=False)
	Move PIEZO in user positions. More...
def	add_piezo_move_in_bits_units (self, device, bit1, bit2, bit3, override=False)
	Move PIEZO in bits. More...
def	add_actuator_switch_on (self, device, override=False)
	Switch actuator ON. More...
def	add_actuator_switch_off (self, device, override=False)
	Switch actuator OFF. More...
def	add_iodev_write_digital (self, device, channel, value, override=False)
	Write digital signal. More...
def	add_iodev_write_analog (self, device, channel, value, override=False)
	Write analog signal. More...
def	add_iodev_write_integer (self, device, channel, value, override=False)
	Write integer signal. More...
def	reset_buffer (self)
	Clean Setup buffer (message) More...
def	size (self)
	Get size of buffer (message) More...
def	get (self, index)
	Get size of buffer (message) More...
def	get_buffer (self)
	Get the setup parameters. More...

Detailed Description

Class manage the buffer of the setup request.

Constructor & Destructor Documentation

__init__()

def clib.setup_buffer.SetupBuffer.__init__	(		self,
			cii
	)

Member Function Documentation

add_actuator_switch_off()

def clib.setup_buffer.SetupBuffer.add_actuator_switch_off	(		self,
			device,
			override = False
	)

Switch actuator OFF.

add_actuator_switch_on()

def clib.setup_buffer.SetupBuffer.add_actuator_switch_on	(		self,
			device,
			override = False
	)

Switch actuator ON.

add_adc_move_motor1_abs_pos()

def clib.setup_buffer.SetupBuffer.add_adc_move_motor1_abs_pos	(		self,
			device,
			position,
			override = False
	)

Move ADC motor1 to an absolute position in user units.

add_adc_move_motor2_abs_pos()

def clib.setup_buffer.SetupBuffer.add_adc_move_motor2_abs_pos	(		self,
			device,
			position,
			override = False
	)

Move ADC motor2 to an absolute position in user units.

add_adc_move_posangle()

def clib.setup_buffer.SetupBuffer.add_adc_move_posangle	(		self,
			device,
			position,
			override = False
	)

Move DROT to a specific position angle.

add_adc_start_tracking()

def clib.setup_buffer.SetupBuffer.add_adc_start_tracking	(		self,
			device,
			override = False
	)

Start ADC tracking in Auto mode.

add_adc_stop_tracking()

def clib.setup_buffer.SetupBuffer.add_adc_stop_tracking	(		self,
			device,
			override = False
	)

Stop ADC tracking.

add_drot_move_abs_pos()

def clib.setup_buffer.SetupBuffer.add_drot_move_abs_pos	(		self,
			device,
			position,
			override = False
	)

Move DROT to absolute position in user units.

add_drot_move_by_speed()

def clib.setup_buffer.SetupBuffer.add_drot_move_by_speed	(		self,
			device,
			speed,
			override = False
	)

Move a motor to a named position.

add_drot_move_posangle()

def clib.setup_buffer.SetupBuffer.add_drot_move_posangle	(		self,
			device,
			position,
			override = False
	)

Move DROT to position angle.

add_drot_move_rel_pos()

def clib.setup_buffer.SetupBuffer.add_drot_move_rel_pos	(		self,
			device,
			position,
			override = False
	)

Move DROT to relative position in user units.

add_drot_start_elev_tracking()

def clib.setup_buffer.SetupBuffer.add_drot_start_elev_tracking	(		self,
			device,
			position = 0.0,
			override = False
	)

Start DROT tracking in Elev mode.

add_drot_start_sky_tracking()

def clib.setup_buffer.SetupBuffer.add_drot_start_sky_tracking	(		self,
			device,
			position = 0.0,
			override = False
	)

Start DROT tracking in Sky mode.

add_drot_start_user_tracking()

def clib.setup_buffer.SetupBuffer.add_drot_start_user_tracking	(		self,
			device,
			position = 0.0,
			override = False
	)

Start DROT tracking in User mode.

add_drot_stop_tracking()

def clib.setup_buffer.SetupBuffer.add_drot_stop_tracking	(		self,
			device,
			override = False
	)

Stop DROT tracking.

add_drot_track_offset()

def clib.setup_buffer.SetupBuffer.add_drot_track_offset	(		self,
			device,
			offset,
			override = False
	)

Offset current position while tracking.

add_iodev_write_analog()

def clib.setup_buffer.SetupBuffer.add_iodev_write_analog	(		self,
			device,
			channel,
			value,
			override = False
	)

Write analog signal.

add_iodev_write_digital()

def clib.setup_buffer.SetupBuffer.add_iodev_write_digital	(		self,
			device,
			channel,
			value,
			override = False
	)

Write digital signal.

add_iodev_write_integer()

def clib.setup_buffer.SetupBuffer.add_iodev_write_integer	(		self,
			device,
			channel,
			value,
			override = False
	)

Write integer signal.

add_json_file()

def clib.setup_buffer.SetupBuffer.add_json_file	(		self,
			file
	)

Loads and parse a JSON file.

The syntax of the file shall follow the defined FCF schema.

add_json_string()

def clib.setup_buffer.SetupBuffer.add_json_string	(		self,
			json_str
	)

Loads and parse a JSON string.

add_lamp_switch_off()

def clib.setup_buffer.SetupBuffer.add_lamp_switch_off	(		self,
			device,
			override = False
	)

Switch a lamp OFF.

add_lamp_switch_on()

def clib.setup_buffer.SetupBuffer.add_lamp_switch_on	(		self,
			device,
			override = False
	)

Switch a lamp ON.

add_lamp_switch_on_with_intensity()

def clib.setup_buffer.SetupBuffer.add_lamp_switch_on_with_intensity	(		self,
			device,
			intensity,
			override = False
	)

Switch a lamp ON with intensity.

add_lamp_switch_on_with_timer()

def clib.setup_buffer.SetupBuffer.add_lamp_switch_on_with_timer	(		self,
			device,
			timer,
			intensity = 100,
			override = False
	)

Switch a lamp ON for a period of time.

add_motor_move_abs_enc()

def clib.setup_buffer.SetupBuffer.add_motor_move_abs_enc	(		self,
			device,
			position,
			override = False
	)

Move a motor in absolute encoders.

add_motor_move_abs_pos()

def clib.setup_buffer.SetupBuffer.add_motor_move_abs_pos	(		self,
			device,
			position,
			override = False
	)

Move a motor in absolute user units.

add_motor_move_by_speed()

def clib.setup_buffer.SetupBuffer.add_motor_move_by_speed	(		self,
			device,
			speed,
			override = False
	)

Move a motor to a named position.

add_motor_move_name_pos()

def clib.setup_buffer.SetupBuffer.add_motor_move_name_pos	(		self,
			device,
			name,
			override = False
	)

Move a motor to a named position.

add_motor_move_rel_enc()

def clib.setup_buffer.SetupBuffer.add_motor_move_rel_enc	(		self,
			device,
			position,
			override = False
	)

Move a motor in relative encoders.

add_motor_move_rel_pos()

def clib.setup_buffer.SetupBuffer.add_motor_move_rel_pos	(		self,
			device,
			position,
			override = False
	)

Move a motor in relative user units.

add_piezo_move_in_bits_units()

def clib.setup_buffer.SetupBuffer.add_piezo_move_in_bits_units	(		self,
			device,
			bit1,
			bit2,
			bit3,
			override = False
	)

Move PIEZO in bits.

add_piezo_move_in_user_units()

def clib.setup_buffer.SetupBuffer.add_piezo_move_in_user_units	(		self,
			device,
			pos1,
			pos2,
			pos3,
			override = False
	)

Move PIEZO in user positions.

add_piezo_set_auto()

def clib.setup_buffer.SetupBuffer.add_piezo_set_auto	(		self,
			device,
			override = False
	)

Set PIEZO to AUTO mode.

add_piezo_set_home()

def clib.setup_buffer.SetupBuffer.add_piezo_set_home	(		self,
			device,
			override = False
	)

Set PIEZO to HOME position.

add_piezo_set_pos()

def clib.setup_buffer.SetupBuffer.add_piezo_set_pos	(		self,
			device,
			override = False
	)

Set PIEZO to POS mode.

add_shutter_close()

def clib.setup_buffer.SetupBuffer.add_shutter_close	(		self,
			device,
			override = False
	)

Close a shutter.

add_shutter_open()

def clib.setup_buffer.SetupBuffer.add_shutter_open	(		self,
			device,
			override = False
	)

Open a shutter.

dump_json()

def clib.setup_buffer.SetupBuffer.dump_json

(

self

)

Print out the elements in the internal JSON object.

get()

def clib.setup_buffer.SetupBuffer.get	(		self,
			index
	)

Get size of buffer (message)

get_buffer()

def clib.setup_buffer.SetupBuffer.get_buffer

(

self

)

Get the setup parameters.

json2object()

def clib.setup_buffer.SetupBuffer.json2object

(

self

)

Loads and parse a JSON dictionary.

reset_buffer()

def clib.setup_buffer.SetupBuffer.reset_buffer

(

self

)

Clean Setup buffer (message)

size()

def clib.setup_buffer.SetupBuffer.size

(

self

)

Get size of buffer (message)

update_json_data()

def clib.setup_buffer.SetupBuffer.update_json_data	(		self,
			json_data
	)

This method merges a json object into a existing one.

It shall be used specially to overwrite configuration read from files.

---

The documentation for this class was generated from the following file:

• devmgr/clib/src/ifw/fcf/clib/setup_buffer.py