0.228.0

CHANGELOG.md

@@ -1,5 +1,28 @@
 # Changelog Hiber API
 
+### 0.228 (2025-02-25)
+
+##### AssignmentService
+
+- Deprecated `Assignment.AlarmAssignment.parameters` due to disuse.
+  - Deprecated `Assign.Request.alarm_parameters` and
+    `ListAlarmAssignments.Response.To{Modem,Tag,Asset}.parameters`
+- Added `Assignment.AdditionalConfiguration` for additional configuration for specific assignment types
+  - Added `Assignment.additional_configuration` `oneof` and `Assign.Request.additional_configuration` `oneof`
+  - Added `Assignment.AdditionalConfiguration.AssetDeviceAssignment` and `Assignment.asset_device` for
+  specific configuration for assignments between assets and devices:
+    - Added `Assignment.AdditionalConfiguration.AssetDeviceAssignment.shared_fields` to limit the fields shared
+      in an asset device assignment.
+
+##### DeviceService
+
+- Added `files` to `Device`.
+- Added `add_files` and `delete_files` to `UpdateDevice`.
+
+##### ModemService
+
+- Added `files` to `Modem`.
+
 ### 0.226 (2025-02-11)
 
 - Grammatical corrections in documentation

assignment.proto

@@ -97,7 +97,7 @@ message Assignment {
         string identifier = 1;
         string name = 5;
         string description = 2;
-        google.protobuf.Struct parameters = 3;
+        google.protobuf.Struct parameters = 3 [deprecated = true];
 
         reserved 4;
     }
@@ -132,6 +132,29 @@ message Assignment {
         tag.Tag to_tag = 7;
         string to_asset = 11;
     }
+
+    message AdditionalConfiguration {
+        /* Select the fields, defined as a list of json paths.
+         * Fields are produced by the device's assigned parsers. See field.proto for more information.
+         */
+        message FieldsByJsonPath {
+            /* List of json paths specifying fields. See field.proto for more information. */
+            repeated string fields = 1;
+        }
+
+        message AssetDeviceAssignment {
+            /* Specify the fields that are shared with the Asset.
+             * If nothing is specified, all fields are shared with the asset by default.
+             */
+            FieldsByJsonPath shared_fields = 1;
+        }
+    }
+
+    /* Additional configuration depending on the assignment type. */
+    oneof additional_configuration {
+        /* Additional configuration for assignment between Asset and Device/Modem. */
+        AdditionalConfiguration.AssetDeviceAssignment asset_device = 12;
+    }
 }
 
 message AssignmentSelection {
@@ -202,7 +225,13 @@ message Assign {
         }
 
         /* The alarm parameters, by alarm identifier, if any, overriding any default values in the alarm(s). */
-        map<string, google.protobuf.Struct> alarm_parameters = 6;
+        map<string, google.protobuf.Struct> alarm_parameters = 6 [deprecated = true];
+
+        /* Additional configuration depending on the assignment type. */
+        oneof additional_configuration {
+            /* Additional configuration for assignment between Asset and Device/Modem. */
+            Assignment.AdditionalConfiguration.AssetDeviceAssignment asset_device = 15;
+        }
 
         /* Time that the assignment should be active.
          * This sets the assignment to start in the past, but would not have effect in the past for assignments like
@@ -510,15 +539,15 @@ message ListAlarmAssignments {
         message AlarmAssignment {
             message ToModem {
                 string modem_number = 1;
-                google.protobuf.Struct parameters = 2;
+                google.protobuf.Struct parameters = 2 [deprecated = true];
             }
             message ToTag {
                 tag.Tag tag = 1;
-                google.protobuf.Struct parameters = 2;
+                google.protobuf.Struct parameters = 2 [deprecated = true];
             }
             message ToAsset {
                 string asset_identifier = 1;
-                google.protobuf.Struct parameters = 2;
+                google.protobuf.Struct parameters = 2 [deprecated = true];
             }
 
             string organization = 1;
@@ -562,10 +591,10 @@ message ListModemMessageBodyParserAssignments {
             string organization = 1;
             modem.message.bodyparser.ModemMessageBodyParser message_body_parser = 2;
 
-            /* The modem numbers this alarm is assigned to, with the alarm parameters. */
+            /* The modem numbers this parser is assigned to. */
             repeated string modems = 3;
 
-            /* The tags this alarm is assigned to, with the alarm parameters. */
+            /* The tags this parser is assigned to. */
             repeated tag.Tag tags = 4;
         }
 

device.proto

@@ -5,6 +5,7 @@ package hiber.device;
 import "google/protobuf/struct.proto";
 
 import "base.proto";
+import "file.proto";
 import "health.proto";
 import "modem.proto";
 import "tag.proto";
@@ -76,6 +77,11 @@ message Device {
      */
     repeated value.Value.Numeric.Type numeric_value_types = 19;
 
+    /* Files for this tag.
+     * Typically an image of the device installation. See the File.media_type for more information.
+     */
+    repeated file.File files = 20;
+
     /* Collection of data about the devices it is connected to. */
     message Links {
         /* Other identifiers for this devices. Could include data like its MAC-address or otherwise unique identifier. */
@@ -84,11 +90,6 @@ message Device {
         /* The gateway directly upstream from this device (in the direction of Mission Control).
          * This device sends its data directly to its gateway, which in turn relays it to Mission Control. */
         optional string gateway = 2;
-
-//        /* The devices that are directly upstream form this device if any.
-//         * The upstream devices use this device to relay messages for them. */
-//        TODO(WEB-6273) Implement list of children
-//        repeated string children = 3;
     }
 }
 

device_service.proto

@@ -9,6 +9,7 @@ package hiber.device;
 
 import "base.proto";
 import "device.proto";
+import "file.proto";
 import "modem.proto";
 import "value.proto";
 
@@ -90,6 +91,14 @@ message UpdateDevice {
      */
     optional hiber.value.Value.Numeric.Rate expected_transmission_rate = 14;
 
+    /* Add files to the device. These can be just an identifier to an existing File, or a full file upload.
+     * Keep in mind the grpc request size limitation.
+     */
+    repeated file.File add_files = 15;
+
+    /* Remove files from the device and delete them from the system (if no other references exist). */
+    repeated string delete_files = 16;
+
     /* When updating peripherals, you can choose to add and delete peripherals,
      * or to do a wholesome replace of all peripherals.
      */

docs/html/asset.html

@@ -4704,7 +4704,7 @@ <h3 id="hiber.tag.UpdateTagRequest">UpdateTagRequest</h3>
                   <td>delete_files</td>
                   <td><a href="#string">string</a></td>
                   <td>repeated</td>
-                  <td><p>Remove files from the new tag and delete them from the system. </p></td>
+                  <td><p>Remove files from the tag and delete them from the system (if no other references exist). </p></td>
                 </tr>
 
             </tbody>

docs/html/asset_service.html

@@ -4749,6 +4749,14 @@ <h3 id="hiber.device.Device">Device</h3>
 The device may produce other values (like battery level), but these are the primary value types. </p></td>
                 </tr>
 
+                <tr>
+                  <td>files</td>
+                  <td><a href="#hiber.file.File">hiber.file.File</a></td>
+                  <td>repeated</td>
+                  <td><p>Files for this tag.
+Typically an image of the device installation. See the File.media_type for more information. </p></td>
+                </tr>
+
             </tbody>
           </table>
 
@@ -5797,7 +5805,7 @@ <h3 id="hiber.tag.UpdateTagRequest">UpdateTagRequest</h3>
                   <td>delete_files</td>
                   <td><a href="#string">string</a></td>
                   <td>repeated</td>
-                  <td><p>Remove files from the new tag and delete them from the system. </p></td>
+                  <td><p>Remove files from the tag and delete them from the system (if no other references exist). </p></td>
                 </tr>
 
             </tbody>