optoOIS
Loading...
Searching...
No Matches
optoOIS.registers.mre3ois_registers.TemperatureManager Class Reference
Inheritance diagram for optoOIS.registers.mre3ois_registers.TemperatureManager:

Public Member Functions

 __init__ (self, board=None)
 GetDeviceTemperature (self)
 GetDeviceTemperatureThreshold (self)
 SetDeviceTemperatureThreshold (self, threshold=0)
 GetBoardOutputStageTemperature (self)
 GetBoardOutputStageTemperatureThreshold (self)
 SetBoardOutputStageTemperatureThreshold (self, threshold=0)
 GetProxyTemperature (self)
 GetProxyTemperatureThreshold (self)
 SetProxyTemperatureThreshold (self, threshold=0)
 GetMcuTemperature (self)
 GetMcuTemperatureThreshold (self)
 SetMcuTemperatureThreshold (self, threshold=0)

Static Public Member Functions

 help ()

Public Attributes

int sys_id = 0x22
dict device_temperature
dict device_temp_threshold
dict board_out_temperature
dict board_out_threshold
dict proxy_temperature
dict proxy_threshold
dict mcu_temperature
dict mcu_temperature_threshold
 name = self.__class__.__name__

Static Protected Attributes

bool _is_a_system = False

Detailed Description

    Device Functionality - Device Temperature Readout
    System ID: 0x22
    If this threshold is reached the output of the driver is disabled to cool down.
    Temperature has to fall by 10 degrees so that the output is enabled again
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+
    | Register Name                   | Id   | Type        | Unit | Range | Default | Comment                      |
    +=====================+======+=============+======+=======+=========+==========================================+
    |actuator_temperature             | 0x00 | float  |°C    |       |N/A       |Degrees Celsius               |
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+
    |actuator_temp_threshold          | 0x01 | float  |°C    |       |85        |Degrees Celsius               |
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+
    |output_stage_board_temp          | 0x02 | float  |°C    |       |N/A       |Degrees Celsius               |
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+
    |output_stage_board_temp_threshold| 0x03 | float  |°C    |       |80        |Degrees Celsius               |
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+
    |proxy_board_temperature          | 0x04| float  |°C     |       |N/A       |Degrees Celsius               |
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+
    |proxy_board_temperature_threshold| 0x05 | float  |°C    |       |85        |Degrees Celsius               |
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+
    |mcu  _temp_threshold            | 0x06 | float  |°C    |       |N/A       |Degrees Celsius               |
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+
    |mcu_temp_threshold              | 0x07 | float  |°C    |       |85        |Degrees Celsius               |
    +---------------------+------+-------------+------+-------+---------+------------------------------------------+

Constructor & Destructor Documentation

◆ __init__()

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

Member Function Documentation

◆ GetBoardOutputStageTemperature()

optoOIS.registers.mre3ois_registers.TemperatureManager.GetBoardOutputStageTemperature ( self)

◆ GetBoardOutputStageTemperatureThreshold()

optoOIS.registers.mre3ois_registers.TemperatureManager.GetBoardOutputStageTemperatureThreshold ( self)

◆ GetDeviceTemperature()

optoOIS.registers.mre3ois_registers.TemperatureManager.GetDeviceTemperature ( self)

◆ GetDeviceTemperatureThreshold()

optoOIS.registers.mre3ois_registers.TemperatureManager.GetDeviceTemperatureThreshold ( self)

◆ GetMcuTemperature()

optoOIS.registers.mre3ois_registers.TemperatureManager.GetMcuTemperature ( self)

◆ GetMcuTemperatureThreshold()

optoOIS.registers.mre3ois_registers.TemperatureManager.GetMcuTemperatureThreshold ( self)

◆ GetProxyTemperature()

optoOIS.registers.mre3ois_registers.TemperatureManager.GetProxyTemperature ( self)

◆ GetProxyTemperatureThreshold()

optoOIS.registers.mre3ois_registers.TemperatureManager.GetProxyTemperatureThreshold ( self)

◆ help()

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

◆ SetBoardOutputStageTemperatureThreshold()

optoOIS.registers.mre3ois_registers.TemperatureManager.SetBoardOutputStageTemperatureThreshold ( self,
threshold = 0 )

◆ SetDeviceTemperatureThreshold()

optoOIS.registers.mre3ois_registers.TemperatureManager.SetDeviceTemperatureThreshold ( self,
threshold = 0 )

◆ SetMcuTemperatureThreshold()

optoOIS.registers.mre3ois_registers.TemperatureManager.SetMcuTemperatureThreshold ( self,
threshold = 0 )

◆ SetProxyTemperatureThreshold()

optoOIS.registers.mre3ois_registers.TemperatureManager.SetProxyTemperatureThreshold ( self,
threshold = 0 )

Member Data Documentation

◆ _is_a_system

bool optoOIS.registers.mre3ois_registers.TemperatureManager._is_a_system = False
staticprotected

◆ board_out_temperature

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

◆ board_out_threshold

dict optoOIS.registers.mre3ois_registers.TemperatureManager.board_out_threshold
Initial value:
= {'id': self.sys_id << 8 | 0x03, 'type': float, 'unit': '°C', 'range': None,
'default': 80, 'value': None}

◆ device_temp_threshold

dict optoOIS.registers.mre3ois_registers.TemperatureManager.device_temp_threshold
Initial value:
= {'id': self.sys_id << 8 | 0x01, 'type': float, 'unit': '°C', 'range': None,
'default': 85, 'value': None}

◆ device_temperature

dict optoOIS.registers.mre3ois_registers.TemperatureManager.device_temperature
Initial value:
= {'id': self.sys_id << 8 | 0x00, 'type': float, 'unit': '°C', 'range': None,
'default': None, 'value': None}

◆ mcu_temperature

dict optoOIS.registers.mre3ois_registers.TemperatureManager.mcu_temperature
Initial value:
= {'id': self.sys_id << 8 | 0x06, 'type': float, 'unit': '°C', 'range': None,
'default': None, 'value': None}

◆ mcu_temperature_threshold

dict optoOIS.registers.mre3ois_registers.TemperatureManager.mcu_temperature_threshold
Initial value:
= {'id': self.sys_id << 8 | 0x07, 'type': float, 'unit': '°C', 'range': None,
'default': 90, 'value': None}

◆ name

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

◆ proxy_temperature

dict optoOIS.registers.mre3ois_registers.TemperatureManager.proxy_temperature
Initial value:
= {'id': self.sys_id << 8 | 0x04, 'type': float, 'unit': '°C', 'range': None,
'default': None, 'value': None}

◆ proxy_threshold

dict optoOIS.registers.mre3ois_registers.TemperatureManager.proxy_threshold
Initial value:
= {'id': self.sys_id << 8 | 0x05, 'type': float, 'unit': '°C', 'range': None,
'default': 85, 'value': None}

◆ sys_id

int optoOIS.registers.mre3ois_registers.TemperatureManager.sys_id = 0x22

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