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:

Io

AnalogLogic

DigitalLogic

property name#
class samna.xyloAudio3.OperationMode#

Bases: pybind11_object

Members:

Manual

AcceleratedTime

RealTime

Recording

property name#
class samna.xyloAudio3.PowerModule#

Bases: pybind11_object

A handle which offers basic power api

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#
write_config(self: samna.xyloAudio3.PowerModule, arg0: int, arg1: int) → None#
class samna.xyloAudio3.XyloAudio3TestBoard#

Bases: pybind11_object

Composite object that allows access to all the board features of a Xylo-Audio3 testboard.

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

Get the serial number of the board. :returns: The board serial number.

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

Get the Fxtree and Unifirm versions of this board.

get_io_control_module(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.unifirm.modules.ioControl.IoControlModule#
get_io_module(self: samna.xyloAudio3.XyloAudio3TestBoard) → samna.xyloAudio3.UnifirmModule#
Returns:

A handle to the unifirm IO module, Useful in debug scenarios.

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

Get the model on this board. :returns: XyloModel

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

Convenience function to get the model sink node directly.

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

Convenience function to get the model source node directly

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

A handle to an PowerModule object which is used to control power trace voltage and measure power consumption.

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

A handle to an PowerMonitor object which is used to read power.

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

A handle to the stopwatch object to control timestamp in events, for debug purpose. See StopWatch

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

Make a unifirm hook instance appropriately configured to tap into packet traffic.

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

Reset the FPGA and reset the peripherals.

Parameters:

default_config (Optional[XyloAudio3DefaultConfig]) – replaces default default config if set.

class samna.xyloAudio3.XyloAudio3TestBoardDefaultConfig#

Bases: DefaultConfigBase

Default configuration for Xylo-A3 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_frequency#

SADC clock frequency in Hz.

property saer_clock_frequency#

SAER clock frequency in Hz.

property skip_communication_check#

Do not check the communication to Xylo-A3 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.

samna.xyloAudio3.xylo_configuration_to_event(arg0: samna.xyloAudio3.configuration.XyloConfiguration) → List[samna.xyloAudio3.event.Spike | samna.xyloAudio3.event.AfeSample | samna.xyloAudio3.event.WriteRegisterValue | samna.xyloAudio3.event.ReadRegisterValue | samna.xyloAudio3.event.WriteMemoryValue | samna.xyloAudio3.event.ReadMemoryValue | samna.xyloAudio3.event.ReadMembranePotential | samna.xyloAudio3.event.ReadSynapticCurrent | samna.xyloAudio3.event.ReadHiddenSynapticCurrent2 | samna.xyloAudio3.event.ReadHiddenSpikeCount | samna.xyloAudio3.event.ReadVersion | samna.xyloAudio3.event.TriggerProcessing | samna.xyloAudio3.event.TriggerReadout]#

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 (xyloAudio3.configuration.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.

Contents