radiens_core.models.status
System status domain models and enums.
Classes
BackboneMode
Bases: IntEnum
Hardware backbone mode. Values match proto allego.BackboneMode.
BackboneStatus
Bases: BaseModel
Complete system backbone status.
Attributes:
| Name | Type | Description |
|---|---|---|
streaming |
StreamingStatus
|
Current streaming status. |
recording |
RecordingStatus
|
Current recording status. |
ports |
list[PortChannelCount]
|
List of port channel counts. |
is_connected |
bool
|
Whether the backbone is connected. |
gpio_channel_count |
GPIOChannelCount
|
GPIO channel count information. |
DataRecordingType
Bases: IntEnum
Data recording type. Values match proto allego.DataRecordingType.
RecordMode
Bases: IntEnum
Data recording mode. Values match proto allego.RecordMode.
RecordStateRequest
Bases: BaseModel
Request to change recording state.
Attributes:
| Name | Type | Description |
|---|---|---|
mode |
RecordMode
|
Target recording mode. References RecordMode. |
port |
Port | None
|
Optional port to control. References Port. Defaults to None. |
RecordingConfig
Bases: BaseModel
Recording configuration settings.
Configures output file paths, naming, and recording behavior. Used as both request (for set_recording_config) and response (for get_recording_config).
Attributes:
| Name | Type | Description |
|---|---|---|
base_file_name |
str
|
Base filename for recording output (without extension or timestamp). |
base_file_path |
str
|
Base directory path for recording files. |
datasource_idx |
int
|
Index number for the composed file name. Defaults to 0. |
time_stamp |
bool
|
True to include timestamp in the composed file name. Defaults to True. |
split_files_by_port |
bool
|
True to create separate files for each port. Defaults to False. |
force_start_at_tstamp_0 |
bool
|
True to force recording to start at timestamp 0. Defaults to False. |
recording_type |
DataRecordingType
|
Type of data to record. References DataRecordingType. Defaults to DataRecordingType.CONTINUOUS. |
RecordingStatus
Bases: BaseModel
Current recording status.
Attributes:
| Name | Type | Description |
|---|---|---|
record_mode |
RecordMode
|
System-level recording mode. References RecordMode. |
active_filename |
str
|
Name of the file currently being recorded. |
duration |
float
|
Current recording duration in seconds. |
error |
str
|
Current recording error message, if any. |
record_mode_port_a |
RecordMode | None
|
Recording mode for Port A. References RecordMode. Defaults to None. |
record_mode_port_b |
RecordMode | None
|
Recording mode for Port B. References RecordMode. Defaults to None. |
record_mode_port_c |
RecordMode | None
|
Recording mode for Port C. References RecordMode. Defaults to None. |
record_mode_port_d |
RecordMode | None
|
Recording mode for Port D. References RecordMode. Defaults to None. |
record_mode_port_e |
RecordMode | None
|
Recording mode for Port E. References RecordMode. Defaults to None. |
record_mode_port_f |
RecordMode | None
|
Recording mode for Port F. References RecordMode. Defaults to None. |
record_mode_port_g |
RecordMode | None
|
Recording mode for Port G. References RecordMode. Defaults to None. |
record_mode_port_h |
RecordMode | None
|
Recording mode for Port H. References RecordMode. Defaults to None. |
RestartRequest
Bases: BaseModel
Request to restart the system with a specific backbone mode.
Attributes:
| Name | Type | Description |
|---|---|---|
mode |
BackboneMode
|
Target hardware backbone mode. References BackboneMode. |
SinapsStatusRegisters
Bases: BaseModel
Status registers for a Sinaps probe.
Attributes:
| Name | Type | Description |
|---|---|---|
calibration_state |
bool
|
True if the probe is currently calibrating. |
calibration_progress |
float
|
Calibration progress (0.0 to 1.0). |
num_active_pixels_shank0 |
int
|
Number of active pixels on shank 0. |
num_active_pixels_shank1 |
int
|
Number of active pixels on shank 1. |
num_active_pixels_shank2 |
int
|
Number of active pixels on shank 2. |
num_active_pixels_shank3 |
int
|
Number of active pixels on shank 3. |
v_ref_ffa |
float
|
Reference voltage FFA. |
v_ref_ffb |
float
|
Reference voltage FFB. |
v_ref_ffc |
float
|
Reference voltage FFC. |
v_ref_ffd |
float
|
Reference voltage FFD. |
is_error0 |
bool
|
True if there is an error on shank 0. |
is_error1 |
bool
|
True if there is an error on shank 1. |
is_error2 |
bool
|
True if there is an error on shank 2. |
is_error3 |
bool
|
True if there is an error on shank 3. |
host_counter |
int
|
Host-side packet counter. |
fpga_counter |
int
|
FPGA-side packet counter. |
firmware_version |
str
|
Probe firmware version string. |
probe_generation |
int
|
Probe hardware generation number. |
probe_model |
int
|
Probe model number. |
StreamMode
Bases: IntEnum
Data stream mode. Values match proto allego.StreamMode.
StreamStateRequest
Bases: BaseModel
Request to change streaming state.
Attributes:
| Name | Type | Description |
|---|---|---|
mode |
StreamMode
|
Target streaming mode. References StreamMode. |
StreamingStatus
Bases: BaseModel
Current streaming status.
Attributes:
| Name | Type | Description |
|---|---|---|
stream_mode |
StreamMode
|
Current streaming mode. References StreamMode. |
primary_cache_t_range |
list[float]
|
Time range of data in the primary cache. |
hardware_memory_level |
float
|
Hardware memory fill level (0.0 to 1.0). |