fcfclib.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)
def	add_json_file (self, file)
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	add_spf_string (self, spf_str, devtypes)
	Loads and parse a JSON string. More...
def	spf2json (self, spf, devtypes)
def	json2object (self)
	Loads and parse a JSON dictionary. More...
def	add_shutter_close (self, device)
	Close a shutte. More...
def	add_shutter_open (self, device)
	Open a shutte. More...
def	add_lamp_switch_on (self, device)
	Switch a lamp ON. More...
def	add_lamp_switch_on_with_intensity (self, device, intensity)
	Switch a lamp ON with intensity. More...
def	add_lamp_switch_on_with_timer (self, device, timer, intensity=100)
	Switch a lamp ON for a period of time. More...
def	add_lamp_switch_off (self, device)
	Switch a lamp OFF. More...
def	add_motor_move_abs_enc (self, device, position)
	Move a motor in absolute encoders. More...
def	add_motor_move_abs_pos (self, device, position)
	Move a motor in absolute user units. More...
def	add_motor_move_rel_enc (self, device, position)
	Move a motor in relative encoders. More...
def	add_motor_move_rel_pos (self, device, position)
	Move a motor in relative user units. More...
def	add_motor_move_name_pos (self, device, name)
	Move a motor to a named position. More...
def	add_motor_move_by_speed (self, device, speed)
	Move a motor to a named position. More...
def	add_drot_move_abs_pos (self, device, position)
	Move DROT to absolute position in user units. More...
def	add_drot_move_rel_pos (self, device, position)
	Move DROT to relative position in user units. More...
def	add_drot_move_by_speed (self, device, speed)
	Move a motor to a named position. More...
def	add_drot_move_posangle (self, device, position)
	Move DROT to position angle. More...
def	add_drot_start_sky_tracking (self, device)
	Start DROT tracking in Sky mode. More...
def	add_drot_start_elev_tracking (self, device)
	Start DROT tracking in Elev mode. More...
def	add_drot_start_user_tracking (self, device)
	Start DROT tracking in User mode. More...
def	add_drot_stop_tracking (self, device)
	Stop DROT tracking. More...
def	add_adc_move_motor1_abs_pos (self, device, position)
	Move ADC motor1 to an absolute position in user units. More...
def	add_adc_move_motor2_abs_pos (self, device, position)
	Move ADC motor2 to an absolute position in user units. More...
def	add_adc_move_posangle (self, device, position)
	Move DROT to a specific position angle. More...
def	add_adc_start_tracking (self, device)
	Start ADC tracking in Auto mode. More...
def	add_adc_stop_tracking (self, device)
	Stop ADC tracking. More...
def	add_piezo_set_auto (self, device)
	Set PIEZO to AUTO mode. More...
def	add_piezo_set_pos (self, device)
	Set PIEZO to POS mode. More...
def	add_piezo_set_home (self, device)
	Set PIEZO to HOME position. More...
def	add_piezo_move_in_user_units (self, device, pos1, pos2, pos3)
	Move PIEZO in user positions. More...
def	add_piezo_move_in_bits_units (self, device, bit1, bit2, bit3)
	Move PIEZO in bits. More...
def	add_actuator_switch_on (self, device)
	Switch actuator ON. More...
def	add_actuator_switch_off (self, device)
	Switch actuator OFF. 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 fcfclib.setup_buffer.SetupBuffer.__init__	(		self,
			cii
	)

Member Function Documentation

add_actuator_switch_off()

def fcfclib.setup_buffer.SetupBuffer.add_actuator_switch_off	(		self,
			device
	)

Switch actuator OFF.

add_actuator_switch_on()

def fcfclib.setup_buffer.SetupBuffer.add_actuator_switch_on	(		self,
			device
	)

Switch actuator ON.

add_adc_move_motor1_abs_pos()

def fcfclib.setup_buffer.SetupBuffer.add_adc_move_motor1_abs_pos	(		self,
			device,
			position
	)

Move ADC motor1 to an absolute position in user units.

add_adc_move_motor2_abs_pos()

def fcfclib.setup_buffer.SetupBuffer.add_adc_move_motor2_abs_pos	(		self,
			device,
			position
	)

Move ADC motor2 to an absolute position in user units.

add_adc_move_posangle()

def fcfclib.setup_buffer.SetupBuffer.add_adc_move_posangle	(		self,
			device,
			position
	)

Move DROT to a specific position angle.

add_adc_start_tracking()

def fcfclib.setup_buffer.SetupBuffer.add_adc_start_tracking	(		self,
			device
	)

Start ADC tracking in Auto mode.

add_adc_stop_tracking()

def fcfclib.setup_buffer.SetupBuffer.add_adc_stop_tracking	(		self,
			device
	)

Stop ADC tracking.

add_drot_move_abs_pos()

def fcfclib.setup_buffer.SetupBuffer.add_drot_move_abs_pos	(		self,
			device,
			position
	)

Move DROT to absolute position in user units.

add_drot_move_by_speed()

def fcfclib.setup_buffer.SetupBuffer.add_drot_move_by_speed	(		self,
			device,
			speed
	)

Move a motor to a named position.

add_drot_move_posangle()

def fcfclib.setup_buffer.SetupBuffer.add_drot_move_posangle	(		self,
			device,
			position
	)

Move DROT to position angle.

add_drot_move_rel_pos()

def fcfclib.setup_buffer.SetupBuffer.add_drot_move_rel_pos	(		self,
			device,
			position
	)

Move DROT to relative position in user units.

add_drot_start_elev_tracking()

def fcfclib.setup_buffer.SetupBuffer.add_drot_start_elev_tracking	(		self,
			device
	)

Start DROT tracking in Elev mode.

add_drot_start_sky_tracking()

def fcfclib.setup_buffer.SetupBuffer.add_drot_start_sky_tracking	(		self,
			device
	)

Start DROT tracking in Sky mode.

add_drot_start_user_tracking()

def fcfclib.setup_buffer.SetupBuffer.add_drot_start_user_tracking	(		self,
			device
	)

Start DROT tracking in User mode.

add_drot_stop_tracking()

def fcfclib.setup_buffer.SetupBuffer.add_drot_stop_tracking	(		self,
			device
	)

Stop DROT tracking.

add_json_file()

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

add_json_string()

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

Loads and parse a JSON string.

add_lamp_switch_off()

def fcfclib.setup_buffer.SetupBuffer.add_lamp_switch_off	(		self,
			device
	)

Switch a lamp OFF.

add_lamp_switch_on()

def fcfclib.setup_buffer.SetupBuffer.add_lamp_switch_on	(		self,
			device
	)

Switch a lamp ON.

add_lamp_switch_on_with_intensity()

def fcfclib.setup_buffer.SetupBuffer.add_lamp_switch_on_with_intensity	(		self,
			device,
			intensity
	)

Switch a lamp ON with intensity.

add_lamp_switch_on_with_timer()

def fcfclib.setup_buffer.SetupBuffer.add_lamp_switch_on_with_timer	(		self,
			device,
			timer,
			intensity = 100
	)

Switch a lamp ON for a period of time.

add_motor_move_abs_enc()

def fcfclib.setup_buffer.SetupBuffer.add_motor_move_abs_enc	(		self,
			device,
			position
	)

Move a motor in absolute encoders.

add_motor_move_abs_pos()

def fcfclib.setup_buffer.SetupBuffer.add_motor_move_abs_pos	(		self,
			device,
			position
	)

Move a motor in absolute user units.

add_motor_move_by_speed()

def fcfclib.setup_buffer.SetupBuffer.add_motor_move_by_speed	(		self,
			device,
			speed
	)

Move a motor to a named position.

add_motor_move_name_pos()

def fcfclib.setup_buffer.SetupBuffer.add_motor_move_name_pos	(		self,
			device,
			name
	)

Move a motor to a named position.

add_motor_move_rel_enc()

def fcfclib.setup_buffer.SetupBuffer.add_motor_move_rel_enc	(		self,
			device,
			position
	)

Move a motor in relative encoders.

add_motor_move_rel_pos()

def fcfclib.setup_buffer.SetupBuffer.add_motor_move_rel_pos	(		self,
			device,
			position
	)

Move a motor in relative user units.

add_piezo_move_in_bits_units()

def fcfclib.setup_buffer.SetupBuffer.add_piezo_move_in_bits_units	(		self,
			device,
			bit1,
			bit2,
			bit3
	)

Move PIEZO in bits.

add_piezo_move_in_user_units()

def fcfclib.setup_buffer.SetupBuffer.add_piezo_move_in_user_units	(		self,
			device,
			pos1,
			pos2,
			pos3
	)

Move PIEZO in user positions.

add_piezo_set_auto()

def fcfclib.setup_buffer.SetupBuffer.add_piezo_set_auto	(		self,
			device
	)

Set PIEZO to AUTO mode.

add_piezo_set_home()

def fcfclib.setup_buffer.SetupBuffer.add_piezo_set_home	(		self,
			device
	)

Set PIEZO to HOME position.

add_piezo_set_pos()

def fcfclib.setup_buffer.SetupBuffer.add_piezo_set_pos	(		self,
			device
	)

Set PIEZO to POS mode.

add_shutter_close()

def fcfclib.setup_buffer.SetupBuffer.add_shutter_close	(		self,
			device
	)

Close a shutte.

add_shutter_open()

def fcfclib.setup_buffer.SetupBuffer.add_shutter_open	(		self,
			device
	)

Open a shutte.

add_spf_string()

def fcfclib.setup_buffer.SetupBuffer.add_spf_string	(		self,
			spf_str,
			devtypes
	)

Loads and parse a JSON string.

dump_json()

def fcfclib.setup_buffer.SetupBuffer.dump_json

(

self

)

Print out the elements in the internal JSON object.

get()

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

Get size of buffer (message)

get_buffer()

def fcfclib.setup_buffer.SetupBuffer.get_buffer

(

self

)

Get the setup parameters.

json2object()

def fcfclib.setup_buffer.SetupBuffer.json2object

(

self

)

Loads and parse a JSON dictionary.

reset_buffer()

def fcfclib.setup_buffer.SetupBuffer.reset_buffer

(

self

)

Clean Setup buffer (message)

size()

def fcfclib.setup_buffer.SetupBuffer.size

(

self

)

Get size of buffer (message)

spf2json()

def fcfclib.setup_buffer.SetupBuffer.spf2json	(		self,
			spf,
			devtypes
	)

update_json_data()

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

---

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

• devmgr/fcfclib/src/fcfclib/setup_buffer.py