radiens_core.models.status

System status domain models and enums.

CLASS	DESCRIPTION
BackboneMode	Hardware backbone mode.
BackboneStatus	Complete system backbone status.
DataRecordingType	Data recording type.
RecordMode	Data recording mode.
RecordStateRequest	Request to change recording state.
RecordingConfig	Recording configuration settings.
RecordingStatus	Current recording status.
SinapsStatusRegisters	Status registers for a Sinaps probe.
StreamMode	Data stream mode.
StreamStateRequest	Request to change streaming state.
StreamingStatus	Current streaming status.

ATTRIBUTE	DESCRIPTION
FlexBackboneMode	BackboneMode that also accepts a string enum name (case-insensitive).

Attributes

FlexBackboneMode module-attribute

FlexBackboneMode = BackboneMode | str

BackboneMode that also accepts a string enum name (case-insensitive).

Classes

BackboneMode

Bases: IntEnum

Hardware backbone mode.

ATTRIBUTE	DESCRIPTION
SMARTBOX_SIM_GEN_SINE	Simulator generating low-frequency sine waves.
SMARTBOX_SIM_GEN_BROADBAND	Simulator generating LFP plus baseline-free spikes; the content follows the sample rate.

BackboneStatus

Bases: BaseModel

Complete system backbone status.

ATTRIBUTE	DESCRIPTION
streaming	Current streaming status. TYPE: StreamingStatus
recording	Current recording status. TYPE: RecordingStatus
ports	List of port channel counts. TYPE: list[PortChannelCount]
is_connected	Whether the backbone is connected. TYPE: bool
gpio_channel_count	GPIO channel count information. TYPE: GPIOChannelCount

DataRecordingType

Bases: IntEnum

Data recording type.

RecordMode

Bases: IntEnum

Data recording mode.

RecordStateRequest

Bases: BaseModel

Request to change recording state.

Only the deprecated AllegoClient.set_record_state() takes this.

ATTRIBUTE	DESCRIPTION
mode	Target recording mode. TYPE: RecordMode
port	Port to control; None controls system-level recording. TYPE: Port | None

RecordingConfig

Bases: BaseModel

Recording configuration settings.

Configures output file paths, naming, and recording behavior. Used as both request (update_recording_config()) and response (get_recording_config()).

ATTRIBUTE	DESCRIPTION
base_file_name	Base filename for recording output (without extension or timestamp). TYPE: str
base_file_path	Base directory path for recording files. TYPE: str
datasource_idx	Index number for the composed file name. get_recording_config() does not report it, so it reads as 0 there. TYPE: int
time_stamp	True to include timestamp in the composed file name. Defaults to True. TYPE: bool
split_files_by_port	True to create separate files for each port. Defaults to False. TYPE: bool
force_start_at_tstamp_0	True to force recording to start at timestamp 0. Defaults to False. TYPE: bool
recording_type	Type of data to record. Also accepts string names (e.g. "continuous"). Defaults to DataRecordingType.CONTINUOUS. TYPE: DataRecordingType | DataRecordingTypeStr

RecordingStatus

Bases: BaseModel

Current recording status.

ATTRIBUTE	DESCRIPTION
record_mode	ON if any port is recording. TYPE: RecordMode
active_filename	Name of the file currently being recorded. TYPE: str
duration	Current recording duration in seconds. TYPE: float
error	Current recording error message, if any. TYPE: str
record_mode_port_a	Recording mode for port A; None if not reported. TYPE: RecordMode | None
record_mode_port_b	Recording mode for port B; None if not reported. TYPE: RecordMode | None
record_mode_port_c	Recording mode for port C; None if not reported. TYPE: RecordMode | None
record_mode_port_d	Recording mode for port D; None if not reported. TYPE: RecordMode | None
record_mode_port_e	Recording mode for port E; None if not reported. TYPE: RecordMode | None
record_mode_port_f	Recording mode for port F; None if not reported. TYPE: RecordMode | None
record_mode_port_g	Recording mode for port G; None if not reported. TYPE: RecordMode | None
record_mode_port_h	Recording mode for port H; None if not reported. TYPE: RecordMode | None

SinapsStatusRegisters

Bases: BaseModel

Status registers for a Sinaps probe.

ATTRIBUTE	DESCRIPTION
calibration_state	True if the probe is currently calibrating. TYPE: bool
calibration_progress	Calibration progress (0.0 to 1.0). TYPE: float
num_active_pixels_shank0	Number of active pixels on shank 0. TYPE: int
num_active_pixels_shank1	Number of active pixels on shank 1. TYPE: int
num_active_pixels_shank2	Number of active pixels on shank 2. TYPE: int
num_active_pixels_shank3	Number of active pixels on shank 3. TYPE: int
v_ref_ffa	Reference voltage FFA. TYPE: float
v_ref_ffb	Reference voltage FFB. TYPE: float
v_ref_ffc	Reference voltage FFC. TYPE: float
v_ref_ffd	Reference voltage FFD. TYPE: float
is_error0	True if there is an error on shank 0. TYPE: bool
is_error1	True if there is an error on shank 1. TYPE: bool
is_error2	True if there is an error on shank 2. TYPE: bool
is_error3	True if there is an error on shank 3. TYPE: bool
host_counter	Host-side packet counter. TYPE: int
fpga_counter	FPGA-side packet counter. TYPE: int
firmware_version	Probe firmware version string. TYPE: str
probe_generation	Probe hardware generation number. TYPE: int
probe_model	Probe model number. TYPE: int

StreamMode

Bases: IntEnum

Data stream mode.

StreamStateRequest

Bases: BaseModel

Request to change streaming state.

Only the deprecated AllegoClient.set_stream_state() takes this.

ATTRIBUTE	DESCRIPTION
mode	Target streaming mode. TYPE: StreamMode

StreamingStatus

Bases: BaseModel

Current streaming status.

ATTRIBUTE	DESCRIPTION
stream_mode	Current streaming mode. TYPE: StreamMode
primary_cache_t_range	[start, end] in seconds of stream time that the live cache holds. TYPE: list[float]
hardware_memory_level	Hardware memory fill level (0.0 to 1.0). TYPE: float