fieldline_service
index
/home/andreas/src/fieldline/fieldline_api/fieldline_service.py

 
Classes
       
builtins.object
FieldLineService

 
class FieldLineService(builtins.object)
    FieldLineService(callback=None, prefix='')
 

 
  Methods defined here:
__init__(self, callback=None, prefix='')
callback - required callback class
           should be of type FieldLineCallback
coarse_zero_sensor(self, chassis_id, sensor_id)
Coarse zero sensor
Note: can only be performed after restart is complete
 
chassis_id - unique ID of chassis
sensor_id - unique ID of sensor
connect(self, ip_list)
ip_list - list of IP addresses to connect to
fine_zero_sensor(self, chassis_id, sensor_id)
Fine zero sensor
Note: can only be performed after coarse zero is complete
 
chassis_id - unique ID of chassis
sensor_id - unique ID of sensor
get_chassis_list(self)
Returns a list of chassis
get_fields(self, chassis_id, sensor_id)
Get the fields for a sensor
 
chassis_id - unique ID of chassis
sensor_id - unique ID of sensor
get_serial_numbers(self, chassis_id, sensor_id)
Get the card and sensor serial number for a sensor
 
chassis_id - unique ID of chassis
sensor_id - unique ID of sensor
get_version(self, chassis_id)
Get the build version
 
chassis_id - unique ID of chassis
is_service_running(self)
Returns True if service is running, False if not
restart_sensor(self, chassis_id, sensor_id)
Restart the sensor
Note: can be performed anytime
 
chassis_id - unique ID of chassis
sensor_id - ID of sensor
set_bz_wave(self, chassis_id, sensor_id, wave_type, freq=None, amplitude=None)
Apply a known magnetic field to the BZ coil (e.g. sine wave)
 
chassis_id - unique ID of chassis
sensor_id - unique ID of sensor
wave_type - FieldLineWaveType (WAVE_OFF, WAVE_RAMP, WAVE_SINE)
freq - frequency of wave
amplitude - amplitude of wave (nT)
set_closed_loop(self, enable)
Turn closed loop on or off
 
enable - True or False for on or off
start(self)
Start FieldLine service and begin checking for chassis.
start_adc(self, chassis_id, freq)
Start ADC from chassis
 
chassis_id - unique ID of chassis
freq - frequency of stream
start_bz(self, chassis_id, sensor_list, freq)
Start streaming BZ data
 
chassis_id - unique ID of chassis
sensor_list - list of sensors to start data
freq - frequency of stream
start_data(self)
Begin streaming data through API
stop(self)
Stop FieldLine service and stop checking for chassis.
stop_adc(self, chassis_id)
Stop ADC from chassis
 
chassis_id - unique ID of chassis
stop_bz(self, chassis_id, sensor_list)
Stop streaming BZ data
 
chassis_id - unique ID of chassis
sensor_list - lost of sensors to stop data
stop_data(self)
Stop streaming data through API
turn_off_sensor(self, chassis_id, sensor_id)
Turn off sensor
Note: can be performed anytime
 
chassis_id - unique ID of chassis
sensor_id - ID of sensor

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)