optoOIS
Loading...
Searching...
No Matches
optoOIS.registers.mre3ois_registers.HallFeedback Class Reference

Parent class => FeedbackSystem
. More...

Inheritance diagram for optoOIS.registers.mre3ois_registers.HallFeedback:

Public Member Functions

 __init__ (self, board=None)
 init (self)
 is_init_done (self)
 reset_init_done (self)
 get_map_channels (self, channel, name)
 set_reg (self, channel, name, value)
 get_reg (self, channel, name)
 get_value (self, channel)
 get_value_id (self, channel)
 get_hf (self, channel)
 get_hf_id (self, channel)
 get_t_comp_type (self)
 set_t_comp_type (self, type=0)
 get_temp (self, channel)
 get_temperature (self, channel=0)
 get_temp_raw (self, channel)
 get_temp_offset (self, channel)
 get_temp_gain (self, channel)
 get_readout (self)
 start_readout (self)
 stop_readout (self)
 get_i2c_address (self)
 get_temp_value (self, channel)
 get_hf_a_values (self)
 get_hf_b_values (self)
 get_hf_c_values (self)
 set_current_compensation_matrix (self, vector)
 get_current_compensation_matrix (self, count=18)

Static Public Member Functions

 help ()

Public Attributes

int sys_id = 0x2B
dict hf_run
dict hf_cb_a
dict hf_cb_b
dict hf_cb_c
dict hf_a
dict hf_b
dict hf_c
dict filter_type
dict burst_size
dict t_comp_type
dict hf_init
dict hf_init_done
dict i2c_address
dict hf_temp_a
dict hf_cb_ay
dict hf_cb_by
dict hf_cb_cy
dict hf_cb_az
dict hf_cb_bz
dict hf_cb_cz
dict vec_comp_matrix = {'id': self.sys_id << 8 | 0x00, 'type': float}
 name = self.__class__.__name__
dict map_channels_hf = {0: 'hf_cb_a', 1: 'hf_cb_b', 2: 'hf_cb_c'}
dict map_channels = {0: '_a', 1: '_b', 2: '_c'}
dict map_channels_temp = {0: 'temp_a', 1: 'temp_b', 2: 'temp_c'}
dict map_channels_temp_raw = {0: 'temp_raw_a', 1: 'temp_raw_b', 2: 'temp_raw_c'}
dict map_channels_temp_offset = {0: 'temp_offset_a', 1: 'temp_offset_b', 2: 'temp_offset_c'}
dict map_channels_temp_gain = {0: 'temp_gain_a', 1: 'temp_gain_b', 2: 'temp_gain_c'}
int n_sensors = 3

Static Protected Attributes

bool _is_a_system = True

Detailed Description

Parent class => FeedbackSystem
. 

Device Functionality - Hall Feedback
System ID: 0x2B

* The hall feedback system provides information about the actual position of actuator.
* It also includes the parameter registers for setup of the hall sensors.
* Caution - sensors readout callbacks has to be disabled while operating actuator's eeprom!
*
* ### Register Map:
*
*  | Address | Name        | Default Value | Description                                    |  Type  | Access     |
*  |---------|-------------|---------------|------------------------------------------------|--------|------------|
*  | 0x2B00  | HFrunCB     | false (or 0)  | Enable/Disable sensors readout callbacks       | boolean| read write |
*  | 0x2B01  | HFvalCB_A   | N/A           | Magnetic field normalised value channel A      | float  | read only  |
*  | 0x2B02  | HFvalCB_B   | N/A           | Magnetic field normalised value channel B      | float  | read only  |
*  | 0x2B03  | HFvalCB_C   | N/A           | Magnetic field normalised value channel C      | float  | read only  |
*  | 0x2B04  | HFval_A     | N/A           | Magnetic field raw value channel A             | uint16 | read only  |
*  | 0x2B05  | HFval_B     | N/A           | Magnetic field raw value channel B             | uint16 | read only  |
*  | 0x2B06  | HFval_C     | N/A           | Magnetic field raw value channel C             | uint16 | read only  |
*  | 0x2B07  | FILTER_TYPE | 0             | Digital filter type [0=NONE, 1=FIR, 2=IIR]    | uint8  | read write |
*  | 0x2B08  | BURST_SIZE  | 0             | Filter burst size 2^val [0=1sample,..3=8sampl.]| uint8  | read write |
*  | 0x2B09  | T_COMP_TYPE | 0             | Sensor int.temp.comp.type [0=NONE,1=NEO,2=CER] | uint8  | read write |
*  | 0x2B0A  | HFinit      | N/A           | Sensor initialization                          | boolean| write      |
*  | 0x2B0B  | HFinit_done | false (or 0)  | Sensor initialization done information         | boolean| read write |
*  | 0x2B0C  | I2C_address | N/A           | Sensor I2C address detected on initialization  | uint8  | read only  |
*  | 0x2B0D  | HFtemp_A    | N/A           | Sensor #0 temperature                          | float  | read only  |
*  |---------|-------------|---------------|------------------------------------------------|--------|------------|
*/

Constructor & Destructor Documentation

◆ __init__()

optoOIS.registers.mre3ois_registers.HallFeedback.__init__ ( self,
board = None )

Member Function Documentation

◆ get_current_compensation_matrix()

optoOIS.registers.mre3ois_registers.HallFeedback.get_current_compensation_matrix ( self,
count = 18 )

◆ get_hf()

optoOIS.registers.mre3ois_registers.HallFeedback.get_hf ( self,
channel )

◆ get_hf_a_values()

optoOIS.registers.mre3ois_registers.HallFeedback.get_hf_a_values ( self)

◆ get_hf_b_values()

optoOIS.registers.mre3ois_registers.HallFeedback.get_hf_b_values ( self)

◆ get_hf_c_values()

optoOIS.registers.mre3ois_registers.HallFeedback.get_hf_c_values ( self)

◆ get_hf_id()

optoOIS.registers.mre3ois_registers.HallFeedback.get_hf_id ( self,
channel )

◆ get_i2c_address()

optoOIS.registers.mre3ois_registers.HallFeedback.get_i2c_address ( self)

◆ get_map_channels()

optoOIS.registers.mre3ois_registers.HallFeedback.get_map_channels ( self,
channel,
name )

◆ get_readout()

optoOIS.registers.mre3ois_registers.HallFeedback.get_readout ( self)

◆ get_reg()

optoOIS.registers.mre3ois_registers.HallFeedback.get_reg ( self,
channel,
name )

◆ get_t_comp_type()

optoOIS.registers.mre3ois_registers.HallFeedback.get_t_comp_type ( self)

◆ get_temp()

optoOIS.registers.mre3ois_registers.HallFeedback.get_temp ( self,
channel )

◆ get_temp_gain()

optoOIS.registers.mre3ois_registers.HallFeedback.get_temp_gain ( self,
channel )

◆ get_temp_offset()

optoOIS.registers.mre3ois_registers.HallFeedback.get_temp_offset ( self,
channel )

◆ get_temp_raw()

optoOIS.registers.mre3ois_registers.HallFeedback.get_temp_raw ( self,
channel )

◆ get_temp_value()

optoOIS.registers.mre3ois_registers.HallFeedback.get_temp_value ( self,
channel )

◆ get_temperature()

optoOIS.registers.mre3ois_registers.HallFeedback.get_temperature ( self,
channel = 0 )

◆ get_value()

optoOIS.registers.mre3ois_registers.HallFeedback.get_value ( self,
channel )

◆ get_value_id()

optoOIS.registers.mre3ois_registers.HallFeedback.get_value_id ( self,
channel )

◆ help()

optoOIS.registers.mre3ois_registers.HallFeedback.help ( )
static

◆ init()

optoOIS.registers.mre3ois_registers.HallFeedback.init ( self)

◆ is_init_done()

optoOIS.registers.mre3ois_registers.HallFeedback.is_init_done ( self)

◆ reset_init_done()

optoOIS.registers.mre3ois_registers.HallFeedback.reset_init_done ( self)

◆ set_current_compensation_matrix()

optoOIS.registers.mre3ois_registers.HallFeedback.set_current_compensation_matrix ( self,
vector )

◆ set_reg()

optoOIS.registers.mre3ois_registers.HallFeedback.set_reg ( self,
channel,
name,
value )

◆ set_t_comp_type()

optoOIS.registers.mre3ois_registers.HallFeedback.set_t_comp_type ( self,
type = 0 )

◆ start_readout()

optoOIS.registers.mre3ois_registers.HallFeedback.start_readout ( self)

◆ stop_readout()

optoOIS.registers.mre3ois_registers.HallFeedback.stop_readout ( self)

Member Data Documentation

◆ _is_a_system

bool optoOIS.registers.mre3ois_registers.HallFeedback._is_a_system = True
staticprotected

◆ burst_size

dict optoOIS.registers.mre3ois_registers.HallFeedback.burst_size
Initial value:
= {'id': self.sys_id << 8 | 0x08, 'type': int, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ filter_type

dict optoOIS.registers.mre3ois_registers.HallFeedback.filter_type
Initial value:
= {'id': self.sys_id << 8 | 0x07, 'type': int, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_a

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_a
Initial value:
= {'id': self.sys_id << 8 | 0x04, 'type': int, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_b

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_b
Initial value:
= {'id': self.sys_id << 8 | 0x05, 'type': int, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_c

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_c
Initial value:
= {'id': self.sys_id << 8 | 0x06, 'type': int, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_a

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_a
Initial value:
= {'id': self.sys_id << 8 | 0x01, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_ay

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_ay
Initial value:
= {'id': self.sys_id << 8 | 0x0e, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_az

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_az
Initial value:
= {'id': self.sys_id << 8 | 0x11, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_b

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_b
Initial value:
= {'id': self.sys_id << 8 | 0x02, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_by

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_by
Initial value:
= {'id': self.sys_id << 8 | 0x0f, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_bz

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_bz
Initial value:
= {'id': self.sys_id << 8 | 0x12, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_c

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_c
Initial value:
= {'id': self.sys_id << 8 | 0x03, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_cy

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_cy
Initial value:
= {'id': self.sys_id << 8 | 0x10, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_cb_cz

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_cb_cz
Initial value:
= {'id': self.sys_id << 8 | 0x13, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_init

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_init
Initial value:
= {'id': self.sys_id << 8 | 0x0a, 'type': int, 'unit': None, 'range': None,
'default': None, 'value': None}

◆ hf_init_done

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_init_done
Initial value:
= {'id': self.sys_id << 8 | 0x0b, 'type': int, 'unit': None, 'range': None,
'default': None, 'value': None}

◆ hf_run

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_run
Initial value:
= {'id': self.sys_id << 8 | 0x00, 'type': int, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ hf_temp_a

dict optoOIS.registers.mre3ois_registers.HallFeedback.hf_temp_a
Initial value:
= {'id': self.sys_id << 8 | 0x0d, 'type': float, 'unit': None, 'range': None, 'default': None,
'value': None}

◆ i2c_address

dict optoOIS.registers.mre3ois_registers.HallFeedback.i2c_address
Initial value:
= {'id': self.sys_id << 8 | 0x0c, 'type': int, 'unit': None, 'range': None,
'default': None, 'value': None}

◆ map_channels

dict optoOIS.registers.mre3ois_registers.HallFeedback.map_channels = {0: '_a', 1: '_b', 2: '_c'}

◆ map_channels_hf

dict optoOIS.registers.mre3ois_registers.HallFeedback.map_channels_hf = {0: 'hf_cb_a', 1: 'hf_cb_b', 2: 'hf_cb_c'}

◆ map_channels_temp

dict optoOIS.registers.mre3ois_registers.HallFeedback.map_channels_temp = {0: 'temp_a', 1: 'temp_b', 2: 'temp_c'}

◆ map_channels_temp_gain

dict optoOIS.registers.mre3ois_registers.HallFeedback.map_channels_temp_gain = {0: 'temp_gain_a', 1: 'temp_gain_b', 2: 'temp_gain_c'}

◆ map_channels_temp_offset

dict optoOIS.registers.mre3ois_registers.HallFeedback.map_channels_temp_offset = {0: 'temp_offset_a', 1: 'temp_offset_b', 2: 'temp_offset_c'}

◆ map_channels_temp_raw

dict optoOIS.registers.mre3ois_registers.HallFeedback.map_channels_temp_raw = {0: 'temp_raw_a', 1: 'temp_raw_b', 2: 'temp_raw_c'}

◆ n_sensors

int optoOIS.registers.mre3ois_registers.HallFeedback.n_sensors = 3

◆ name

optoOIS.registers.mre3ois_registers.HallFeedback.name = self.__class__.__name__

◆ sys_id

int optoOIS.registers.mre3ois_registers.HallFeedback.sys_id = 0x2B

◆ t_comp_type

dict optoOIS.registers.mre3ois_registers.HallFeedback.t_comp_type
Initial value:
= {'id': self.sys_id << 8 | 0x09, 'type': int, 'unit': None, 'range': None,
'default': None, 'value': None}

◆ vec_comp_matrix

optoOIS.registers.mre3ois_registers.HallFeedback.vec_comp_matrix = {'id': self.sys_id << 8 | 0x00, 'type': float}
The documentation for this class was generated from the following file: