hololink::emulation::sensors::TestSensor
hololink::emulation::sensors::TestSensor
I2C-controlled test sensor for validation and development.
Register map (16-bit big-endian address, same transaction format as Vb1940Emulator):
Inherits from: hololink::emulation::I2CPeripheral (public)
Constructors
TestSensor
Destructor
~TestSensor
Methods
reset
attach_to_i2c
python:
def attach_to_i2c(self: hemu.I2CPeripheral, i2c_controller: hemu.I2CController, bus_address: int)
attach the peripheral to the I2C controller. This should be called by client code before start() is called.
Parameters
The I2C controller to attach to. Retrieved from HSBEmulator with get_i2c(controller_address).
The bus address of the peripheral.
i2c_transaction
python:
def i2c_transaction(self: hemu.I2CPeripheral, peripheral_address: int, write_bytes: bytes, write_size: int, read_bytes: bytearray, read_size: int) -> hemu.I2CStatus
perform an I2C transaction. This will be called by the I2CController when a transaction is requested.
write_bytes and read_bytes may alias (the I2C controller hands the same data buffer for both), so consume the write bytes before producing the read bytes.
Python override: write_bytes arrives as an immutable bytes copy of length write_size; read_bytes is a bytearray of length read_size to fill, e.g. read_bytes[0:2] = bytes([0x12, 0x34]); it is copied into the controller’s buffer when the override returns, so it must keep its length. An exception from the override fails the transaction (I2C_STATUS_FATAL_ERROR) and is reported through sys.unraisablehook. Calling i2c_transaction on a peripheral from Python takes (peripheral_address, write_bytes, read_bytes=None, write_size=None, read_size=None) where write_bytes is any byte buffer and read_bytes a writable byte buffer (e.g. bytearray(n)).
Returns: I2CStatus The status of the transaction.
Parameters
The peripheral address to communicate with.
The bytes to write to the peripheral.
The size of the write bytes.
Buffer the peripheral fills with the bytes read. The caller provides read_size bytes of storage; the peripheral overwrites them with its reply.
The number of bytes requested by the host.
is_streaming
get_frame_size
get_frame_rate_hz
get_pattern_mode
get_constant_byte
fill_frame
Fill a frame buffer according to the current pattern configuration.
Parameters
Destination buffer (must be at least get_frame_size() bytes).
Frame sequence number used by the incrementing pattern.
start
start the peripheral.
This will be called when I2CController itself starts and should not be done by the client code.
stop
stop the peripheral.
This will be called when the I2CController is stopped and should not be done by the client code.
Peripheral should release all resources in case a subsequent start() is called.