update CalibrateMetric description (Draegerwerk#56)

// update CalibrateMetric description # Checklist The following aspects have been respected by the author of this pull request, confirmed by both pull request assignee **and** reviewer: * Changelog update (necessity checked and entry added or not added respectively) * [x] Pull Request Assignee * [x] Reviewer * README update (necessity checked and entry added or not added respectively) * [x] Pull Request Assignee * [x] Reviewer
jannast · Aug 17, 2023 · 87ef9e4 · 87ef9e4
1 parent 095d01d
commit 87ef9e4
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -24,6 +24,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - TriggerAnyDescriptorUpdate manipulation
 
 ### Changed
+
+- semantics for the CalibrateMetric manipulation
 - semantics for the EnsembleContextIndicateMembershipWithIdentification manipulation
 - semantics for the SetMetricValuesInRange manipulation
 - semantics for the SetAlertConditionPresence manipulation

diff --git a/src/t2iapi/metric/metric_responses.proto b/src/t2iapi/metric/metric_responses.proto
@@ -15,13 +15,16 @@ option java_package = "com.draeger.medical.t2iapi.metric";
 option java_outer_classname = "MetricResponses";
 
 /*
-This message is used as a response for the CalibrateMetric manipulation. It returns a list of NumericMetricValue/@Value
-or SampleArrayValue/@Samples as strings measured during the calibration. An empty list is returned if no values
-can be provided.
+This message is used as a response for the CalibrateMetric manipulation.
+It returns a list of pm:MetricValue/@Value or pm:MetricValue/@Samples as strings measured during the calibration.
+For further comparison of the value(s) it is required that each returned string value has the same representation
+of the whole and fractional part that would be transmitted via SDC, i.e. if the value is represented as '0.01'
+via SDC, do not provide it as '00.010'.
+An empty list is returned if no values can be provided.
  */
 message CalibrateMetricResponse {
     BasicResponse response = 1;
-    repeated string values = 2;
+    repeated string values = 2;  // pm:MetricValue/@Value or pm:MetricValue/@Samples
 }
 
 // Response indicating whether a metric is computer-controlled

diff --git a/src/t2iapi/metric/service.proto b/src/t2iapi/metric/service.proto
@@ -47,7 +47,7 @@ service MetricService {
       returns (BasicResponse);
 
   /*
-  Calibrate the metric for the provided handle and return the calibration values.
+  Start a new calibration for the metric with the provided handle and return the calibration values.
    */
   rpc CalibrateMetric (BasicHandleRequest)
       returns (t2iapi.metric.CalibrateMetricResponse);