ecm-project

Fit From File

Submit an ECM fit from an uploaded cycling data file.

Returns 202 Accepted with the job_id. Always includes RC-pair parameters in the result. Optionally accepts known initial_soc / capacity, or an ocv_soc_curve; capacity is coulomb-count estimated unless bounds_capacity is also given (opting in to capacity fitting).

post/ecm/fit-from-file

Query parameters

num_rcsinteger
fit_ocvboolean
initial_socnumber nullable
capacitynumber nullable
regularizationnumber

Smoothness-prior strength on R0/RC curves (never OCV). scale = 5 / regularization; 0 disables the prior. Defaults to 0 (off).

Smoothness-prior strength on R0/RC curves (never OCV). scale = 5 / regularization; 0 disables the prior. Defaults to 0 (off).

ocv_soc_curvestring nullable

JSON-encoded OcvSocCurve, e.g. {"soc": [...], "ocv": [...]}. When provided OCV-fitting is skipped and OCV is interpolated from the curve.

JSON-encoded OcvSocCurve, e.g. {"soc": [...], "ocv": [...]}. When provided OCV-fitting is skipped and OCV is interpolated from the curve.

bounds_capacitystring nullable

JSON-encoded CapacityBounds, e.g. {"lo": 0.5, "hi": 5.0}. Providing this (with ocv_soc_curve and no capacity) opts in to fitting capacity; without it capacity is coulomb-count estimated.

JSON-encoded CapacityBounds, e.g. {"lo": 0.5, "hi": 5.0}. Providing this (with ocv_soc_curve and no capacity) opts in to fitting capacity; without it capacity is coulomb-count estimated.

num_knotsinteger nullable
num_knots_r0integer nullable
knot_schedulestring nullable

JSON-encoded list[int], e.g. [2,4,8].

JSON-encoded list[int], e.g. [2,4,8].

clamp_boundary_knotsboolean

Clamp boundary R0/alpha/beta knot values to interior neighbours. Set False when building R_rc symbolically downstream.

Clamp boundary R0/alpha/beta knot values to interior neighbours. Set False when building R_rc symbolically downstream.

clamp_max_rationumber

Response

Successful Response

{"stackTrail":"paths:/ecm/fit-from-file:post:responses:202:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

No recorded changes to this endpoint across all 1 revision of this API.