Shared Upload Helpers¶
json_utils ¶
JSON loading helpers shared across SHM modules.
Functions¶
load_json_data ¶
Load JSON data from disk using pathlib.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
path_to_data
|
str | Path | None
|
Path to the JSON document, or |
required |
Returns:
| Type | Description |
|---|---|
Any | None
|
Parsed JSON document, or |
Examples:
Source code in src/owi/metadatabase/shm/json_utils.py
signal_ids ¶
Typed parsing for SHM signal identifiers.
Classes¶
LegacySignalIdentifier
dataclass
¶
LegacySignalIdentifier(
raw,
parts,
subassembly,
signal_type,
lateral_position,
angular_position,
orientation,
)
Parsed representation of an SHM signal identifier.
Functions¶
to_legacy_dict ¶
Return the historical dict shape used by archive payload code.
Source code in src/owi/metadatabase/shm/signal_ids.py
Functions¶
parse_legacy_signal_id ¶
Parse an SHM signal identifier into a typed model.
Source code in src/owi/metadatabase/shm/signal_ids.py
upload_context ¶
Shared context models for SHM upload workflows.
Classes¶
payloads ¶
Non-legacy payload helpers for SHM upload workflows.
Classes¶
SignalPayload
dataclass
¶
SignalPayload(
site,
model_definition,
asset_location,
signal_type,
signal_id,
visibility_groups,
sub_assembly=None,
heading=None,
level=None,
orientation=None,
stats=None,
data_additional=None,
visibility="usergroup",
)
Payload model for signal records.
SignalHistoryPayload
dataclass
¶
SignalHistoryPayload(
signal_id,
activity_start_timestamp,
is_latest_status,
status,
sensor_serial_number=None,
status_approval="yes",
legacy_signal_id=None,
)
Payload model for signal history records.
LeadCorrectionPayload
dataclass
¶
Nested payload model for signal lead correction data.
SignalCalibrationData
dataclass
¶
SignalCalibrationData(
offset=None,
cwl=None,
coefficients=None,
t_ref=None,
gauge_correction=None,
lead_correction=None,
)
Nested payload model for signal calibration data.
SignalCalibrationPayload
dataclass
¶
SignalCalibrationPayload(
signal_id,
calibration_date,
data,
tempcomp_signal_id=None,
status_approval="yes",
)
Payload model for signal calibration records.
DerivedSignalPayload
dataclass
¶
DerivedSignalPayload(
site,
model_definition,
asset_location,
sub_assembly,
signal_type,
derived_signal_id,
visibility_groups,
heading=None,
level=None,
orientation=None,
stats=None,
data_additional=None,
visibility="usergroup",
)
Payload model for derived signal records.
DerivedSignalHistoryPayload
dataclass
¶
DerivedSignalHistoryPayload(
derived_signal_id,
activity_start_timestamp,
is_latest_status,
status,
status_approval="yes",
)
Payload model for derived signal history records.
DerivedSignalHistoryParentSignalsPatch
dataclass
¶
Patch payload for linking parent signals to a derived signal history.
DerivedSignalCalibrationData
dataclass
¶
Nested payload model for derived signal calibration data.
DerivedSignalCalibrationPayload
dataclass
¶
DerivedSignalCalibrationPayload(
derived_signal_id,
calibration_date,
data,
status_approval="yes",
)
Payload model for derived signal calibration records.
SensorTypePayload
dataclass
¶
SensorTypePayload(
name,
type,
type_extended,
hardware_supplier,
file=None,
visibility="usergroup",
visibility_groups=None,
)
Payload model for sensor type records.
SensorPayload
dataclass
¶
SensorPayload(
sensor_type_id,
serial_number,
cabinet,
visibility="usergroup",
visibility_groups=None,
)
Payload model for sensor records.
SensorCalibrationPayload
dataclass
¶
Payload model for sensor calibration records.
Functions¶
build_sensor_payloads ¶
build_sensor_payloads(
sensor_type_id,
serial_numbers,
cabinets,
visibility_groups,
visibility="usergroup",
)
Build sensor payload models from parallel columns.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_sensor_type_payloads ¶
build_sensor_type_payloads(
sensor_types_data,
visibility_groups,
path_to_images=None,
visibility="usergroup",
)
Build sensor type payload models from raw records.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_sensor_calibration_payloads ¶
Build sensor calibration payload models for one turbine.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_signal_main_payload ¶
Build the main signal payload from archive-style signal data.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_signal_status_payloads ¶
Build signal status payloads from archive-style status rows.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_signal_calibration_payloads ¶
Build signal calibration payloads from archive-style offset and CWL data.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_derived_signal_main_payload ¶
Build the main derived-signal payload from archive-style data.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_derived_signal_status_payload ¶
Build the derived-signal status payload used before parent patching.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_derived_signal_parent_patch ¶
Build the parent-signals patch payload for derived signal status rows.
Source code in src/owi/metadatabase/shm/upload/payloads.py
build_derived_signal_calibration_payloads ¶
Build derived-signal calibration payloads from archive-style data.