samna.xyloAudio3

samna.xyloAudio3#

Submodules#

Module content#

class samna.xyloAudio3.InputSource#

Bases: pybind11_object

Members:

AnalogMicrophone

DigitalMicrophone

SpikeEvents

AdcEvents

PdmEvents

property name#

class samna.xyloAudio3.MeasurementChannels#

Bases: pybind11_object

Members:

AnalogLogic

DigitalLogic

property name#

class samna.xyloAudio3.OperationMode#

Bases: pybind11_object

Members:

Manual

AcceleratedTime

RealTime

Recording

DirectOutput

property name#

class samna.xyloAudio3.PowerModule#

Bases: pybind11_object

The PowerModule provides access to the ADCs used for power measurements.

get_analog_adc(self: samna.xyloAudio3.PowerModule) → samna.unifirm.adc.ina229.Ina229#

get_digital_adc(self: samna.xyloAudio3.PowerModule) → samna.unifirm.adc.ina229.Ina229#

get_io_adc(self: samna.xyloAudio3.PowerModule) → samna.unifirm.adc.ina229.Ina229#

class samna.xyloAudio3.XyloAudio3TestBoard#

Bases: pybind11_object

The XyloAudio3TestBoard class provides access to all the hardware features of the XyloAudio 3 test board.

This composite object aggregates different modules and interfaces available on the board, including power management, input/output controls, and firmware access. It also provides utility methods for debugging, board configuration, and interfacing with external modules.

get_board_serial_number(self: samna.xyloAudio3.XyloAudio3TestBoard) → str#

Get the serial number of the board.

Returns:: The serial number of the test board.
Return type:: str

get_firmware_versions(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.boards.common.FirmwareVersions#

Retrieve the Fxtree and Unifirm firmware versions installed on this board.

Returns:: the Fxtree and Unifirm firmware versions.
Return type:: FirmwareVersions

get_io_control_module(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.unifirm.modules.ioControl.IoControlModule#: Get the unifirm module to control I/O pins. For debug purposes.)

get_io_module(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.xyloAudio3.UnifirmModule#: Get the unifirm I/O module of the board. For debug purposes.

get_model(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.xyloAudio3.XyloModel#

Get the XyloModel on this board.

Returns:: The XyloModel instance for this board.
Return type:: XyloModel

get_model_sink_node(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.DeviceSinkNode_xylo_audio3_event_input_event#

Get the model sink node.

This is a convenience function to access the node that consumes model data.

get_model_source_node(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.DeviceSourceNode_xylo_audio3_event_output_event#

Get the model source node.

This is a convenience function to access the node that produces model data.

get_power_module(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.xyloAudio3.PowerModule#

Get the PowerModule object.

Returns:: A PowerModule instance to control power supply and track power consumption.
Return type:: PowerModule

get_power_monitor(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.boards.common.power.PowerMonitor#

Get the PowerMonitor object.

Returns:: A PowerMonitor instance to handle power measurements.
Return type:: PowerMonitor

get_stop_watch(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.unifirm.timestamp.StopWatch#

Get the stopwatch object for event timestamping.

Returns:: A stopwatch for generating timestamps.
Return type:: StopWatch

make_unifirm_hook(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.unifirm.UnifirmHook#

Create and configure a unifirm hook instance to monitor packet traffic on the board.

This function sets up a hook that taps into the unifirm module’s packet flow for debugging purposes.

reset_board_soft(self: samna.xyloAudio3.XyloAudio3TestBoard, defaultConfig: samna.xyloAudio3.XyloAudio3TestBoardDefaultConfig | None = None) → None#

Soft reset the FPGA and its peripherals.

This function resets the FPGA and reinitializes the connected peripherals. Optionally, a custom default configuration can be provided to replace the standard configuration.

Parameters:: defaultConfig (Optional[XyloAudio3DefaultConfig]) – A custom default configuration to apply after reset.

class samna.xyloAudio3.XyloAudio3TestBoardDefaultConfig#

Bases: DefaultConfigBase

Default configuration for XyloAudio 3 board. Used as optional argument for

samna.device.open_device()
samna.xyloAudio3.XyloAudio3TestBoard.reset_board_soft.

property communication_check_timeout#: Timeout for communication check in seconds.

from_json(self: samna.xyloAudio3.XyloAudio3TestBoardDefaultConfig, arg0: str) → None#

property main_clock_frequency#: Main clock frequency in Hz.

property pdm_clock_frequency#: PDM clock frequency in Hz.

property sadc_clock_divider#: SADC clock divider in relation to the main clock.

property saer_clock_divider#: SAER clock divider in relation to the main clock.

property skip_communication_check#: Do not check the communication to XyloAudio 3 on startup.

to_json(self: samna.xyloAudio3.XyloAudio3TestBoardDefaultConfig) → str#

samna.xyloAudio3.validate_configuration(arg0: samna.xyloAudio3.configuration.XyloConfiguration) → Tuple[bool, str]#

Validate the given configuration.

Parameters:: config (xyloAudio3.configuration.XyloConfiguration) – The configuration to validate.
Returns:: A pair of the validation result and the analysis string.

Get the events for the given Xylo configuration.

Parameters:: config (xyloAudio3.configuration.XyloConfiguration) – The configuration to turn into events.
Returns:: A list of events.

samna.xyloAudio3.xylo_configuration_to_i2c_bytes(arg0: samna.xyloAudio3.configuration.XyloConfiguration, arg1: int) → bytes#

Get the I2C byte stream for the given Xylo configuration.

Parameters:

config (XyloConfiguration) – The configuration to turn into I2C byte stream.
taddr_bits (int) – value of the two variable bits in TADDR.

Returns:

byte stream to emit on I2C.

samna.xyloAudio3

Contents

samna.xyloAudio3#

Submodules#

Module content#