optoOIS.registers.mre3ois_registers.StaticInput Class Reference

Inheritance diagram for optoOIS.registers.mre3ois_registers.StaticInput:

Public Member Functions
	__init__ (self, int channel=0, board=None)
	SetCurrent (self, value)
	GetCurrent (self)
	SetOF (self, value)
	GetOF (self)
	SetXY (self, value)
	GetXY (self)
	GetActiveType (self)

Static Public Member Functions
	help ()

Public Attributes
int	sys_id = 0x50 | channel
dict	current
dict	of
dict	xy_value
dict	active_type
	name = self.__class__.__name__

Protected Attributes
bool	_readonly = False
	_channel

Detailed Description

Input Channel Systems - USB/UART
System IDs: 0x50 through 0x57

+----------------+------+-------------+----------+-------------+---------+---------------------------------------+
| Register Name  | Id   | Type        | Unit     | Range       | Default | Comment                               |
+================+======+=============+==========+=============+=========+=======================================+
| current        | 0x00 | float 32-bit| A        | -1.13 to 1.13 | 0.0     |                                       |
+----------------+------+-------------+----------+-------------+---------+---------------------------------------+
| OF             | 0x00 | float 32-bit| A        |             | 0.0     |                                       |
+----------------+------+-------------+----------+-------------+---------+---------------------------------------+
| XY             | 0x00 | float 32-bit| A        | -1.0 to 1.0 | 0.0     |                                       |
+----------------+------+-------------+----------+-------------+---------+---------------------------------------+
| Type           | 0x00 | float 32-bit| A        |             | 0.0     |                                       |
+----------------+------+-------------+----------+-------------+---------+---------------------------------------+
| FP             | 0x00 | float 32-bit| A        |             | 0.0     |                                       |
+----------------+------+-------------+----------+-------------+---------+---------------------------------------+
| Unitless       | 0x00 | float 32-bit| A        |             | 0.0     |                                       |
+----------------+------+-------------+----------+-------------+---------+---------------------------------------+

Constructor & Destructor Documentation

__init__()

optoOIS.registers.mre3ois_registers.StaticInput.__init__	(		self,
		int	channel = 0,
			board = None )

Member Function Documentation

GetActiveType()

optoOIS.registers.mre3ois_registers.StaticInput.GetActiveType

(

self

)

GetCurrent()

optoOIS.registers.mre3ois_registers.StaticInput.GetCurrent

(

self

)

GetOF()

optoOIS.registers.mre3ois_registers.StaticInput.GetOF

(

self

)

GetXY()

optoOIS.registers.mre3ois_registers.StaticInput.GetXY

(

self

)

help()

optoOIS.registers.mre3ois_registers.StaticInput.help ( )

static

SetCurrent()

optoOIS.registers.mre3ois_registers.StaticInput.SetCurrent	(		self,
			value )

SetOF()

optoOIS.registers.mre3ois_registers.StaticInput.SetOF	(		self,
			value )

SetXY()

optoOIS.registers.mre3ois_registers.StaticInput.SetXY	(		self,
			value )

Member Data Documentation

_channel

optoOIS.registers.mre3ois_registers.StaticInput._channel

protected

_readonly

bool optoOIS.registers.mre3ois_registers.StaticInput._readonly = False

protected

active_type

dict optoOIS.registers.mre3ois_registers.StaticInput.active_type

Initial value:

=  {'id': self.sys_id << 8 | 0x03,
                            'type': UnitType,
                            'unit': None,
                            'range': None,
                            'default': 0,
                            'value': 0}

current

dict optoOIS.registers.mre3ois_registers.StaticInput.current

Initial value:

=  {'id': self.sys_id << 8 | 0x00,
                        'type': float,
                        'unit': 'A',
                        'range': [-1.13, 1.13],
                        'default': 0.0,
                        'value': 0.0}

name

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

of

dict optoOIS.registers.mre3ois_registers.StaticInput.of

Initial value:

=  {'id': self.sys_id << 8 | 0x01,
                   'type': float,
                   'unit': None,
                   'range': [-1, 1],
                   'default': 0.0,
                   'value': 0.0}

sys_id

int optoOIS.registers.mre3ois_registers.StaticInput.sys_id = 0x50 | channel

xy_value

dict optoOIS.registers.mre3ois_registers.StaticInput.xy_value

Initial value:

=  {'id': self.sys_id << 8 | 0x02,
                         'type': float,
                         'unit': 'XY',
                         'range': [-1, 1],
                         'default': 0.0,
                         'value': 0.0}

---

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

• C:/git/187-763-00_optoois/src/main/python/optoOIS/registers/mre3ois_registers.py