0.219.0

HiberGlobal · Dec 3, 2024 · 0e67257 · 0e67257
1 parent 0ead0b1
commit 0e67257
Show file tree

Hide file tree

Showing 78 changed files with 1,550 additions and 816 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog Hiber API
 
+### 0.219 (2024-12-03)
+
+##### ValueSimulationService
+
+- The `unit` and `numeric-value-type` are now required for numeric value simulation.
+
+##### ValueService
+
+- Added `Value.Numeric.Type.OTHER` and `Value.Numeric.Other` for value types that are known but not supported.
+- Reordered and added documentation for `Value.Numeric.Type` values and `Value.Numeric` type objects.
+
 ### 0.218 (2024-11-26)
 
 ##### UserService

diff --git a/base.proto b/base.proto
@@ -750,5 +750,7 @@ enum UnitOfMeasurement {
 
     ITEMS_PER_24_HOURS = 45;
 
+    OTHER = 54;
+
     reserved 13;
 }
diff --git a/docs/enum-json/base.json b/docs/enum-json/base.json
@@ -112,5 +112,6 @@
     , "FLOW_CUBIC_FEET_PER_SECOND": ""
     , "REVOLUTIONS_PER_MINUTE": ""
     , "ITEMS_PER_24_HOURS": ""
+    , "OTHER": ""
     }
 }]
diff --git a/docs/enum-json/value.json b/docs/enum-json/value.json
@@ -110,20 +110,21 @@
   "description": "The type of numeric value that is represented. Supported types will automatically convert to the preferred unit (based on the user settings).",
   "values": {
     "TYPE_UNKNOWN": ""
-    , "PERCENTAGE": ""
-    , "TEMPERATURE": ""
-    , "DISTANCE": ""
-    , "PRESSURE": ""
-    , "VOLTAGE": ""
-    , "SPEED": ""
-    , "VOLUME": ""
-    , "DURATION": ""
-    , "FUEL_EFFICIENCY": ""
-    , "MASS": ""
-    , "BATTERY_LEVEL": ""
-    , "FLOW": ""
-    , "ROTATION_SPEED": ""
-    , "RATE": ""
+    , "BATTERY_LEVEL": "Battery level, as a percentage."
+    , "DISTANCE": "Distance in metric or imperial units."
+    , "DURATION": "Time period."
+    , "FLOW": "Volume per time period."
+    , "FUEL_EFFICIENCY": "Fuel efficiency, e.g. mpg or l/100km."
+    , "MASS": "Mass."
+    , "OTHER": "Known unit that is not (yet) supported. This could be a very specific value, like a counter, or something like energy in joules that is not available."
+    , "PERCENTAGE": "A percentage, typically 0-100%."
+    , "PRESSURE": "Pressure."
+    , "RATE": "Count per time period, e.g. the amount of items counted in a 24 hour window."
+    , "ROTATION_SPEED": "Speed that something rotates per time period, typically in revolutions per minute."
+    , "TEMPERATURE": "Temperature."
+    , "SPEED": "Speed, e.g. km/h."
+    , "VOLTAGE": "Voltage, e.g. mV."
+    , "VOLUME": "Volume, e.g. m³."
     }
 },{
   "name": "VoltageUnit",

diff --git a/docs/html/asset.html b/docs/html/asset.html
@@ -622,6 +622,10 @@ <h2>Table of Contents</h2>
                   <a href="#hiber.value.Value.Numeric.Mass"><span class="badge">M</span>Value.Numeric.Mass</a>
                 </li>
 
+                <li>
+                  <a href="#hiber.value.Value.Numeric.Other"><span class="badge">M</span>Value.Numeric.Other</a>
+                </li>
+
                 <li>
                   <a href="#hiber.value.Value.Numeric.Percentage"><span class="badge">M</span>Value.Numeric.Percentage</a>
                 </li>
@@ -3310,6 +3314,12 @@ <h3 id="hiber.UnitOfMeasurement">UnitOfMeasurement</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>OTHER</td>
+                <td>54</td>
+                <td><p></p></td>
+              </tr>
+
           </tbody>
         </table>
 
@@ -4807,6 +4817,13 @@ <h3 id="hiber.value.Value.Numeric">Value.Numeric</h3>
                   <td><p> </p></td>
                 </tr>
 
+                <tr>
+                  <td>other</td>
+                  <td><a href="#hiber.value.Value.Numeric.Other">Value.Numeric.Other</a></td>
+                  <td></td>
+                  <td><p> </p></td>
+                </tr>
+
                 <tr>
                   <td>unknown</td>
                   <td><a href="#double">double</a></td>
@@ -4960,7 +4977,7 @@ <h3 id="hiber.value.Value.Numeric.Flow">Value.Numeric.Flow</h3>
 
 
         <h3 id="hiber.value.Value.Numeric.FuelEfficiency">Value.Numeric.FuelEfficiency</h3>
-        <p>The value is a distance value, converted to your preferred distance unit.</p>
+        <p>The value is a fuel efficiency value, converted to your preferred fuel efficiency unit.</p>
 
 
           <table class="field-table">
@@ -4984,7 +5001,7 @@ <h3 id="hiber.value.Value.Numeric.FuelEfficiency">Value.Numeric.FuelEfficiency</
 
 
         <h3 id="hiber.value.Value.Numeric.Mass">Value.Numeric.Mass</h3>
-        <p>The value is a volume value, converted to your preferred volume unit.</p>
+        <p>The value is a mass value, converted to your preferred mass unit.</p>
 
 
           <table class="field-table">
@@ -5007,6 +5024,13 @@ <h3 id="hiber.value.Value.Numeric.Mass">Value.Numeric.Mass</h3>
 
 
 
+        <h3 id="hiber.value.Value.Numeric.Other">Value.Numeric.Other</h3>
+        <p>Known unit that is not (yet) supported.</p><p>This could be a very specific value, like a counter,</p><p>or something like energy in joules that is not available.</p>
+
+
+
+
+
         <h3 id="hiber.value.Value.Numeric.Percentage">Value.Numeric.Percentage</h3>
         <p>The value is a percentage.</p>
 
@@ -5637,87 +5661,95 @@ <h3 id="hiber.value.Value.Numeric.Type">Value.Numeric.Type</h3>
               </tr>
 
               <tr>
-                <td>PERCENTAGE</td>
-                <td>1</td>
-                <td><p></p></td>
+                <td>BATTERY_LEVEL</td>
+                <td>11</td>
+                <td><p>Battery level, as a percentage.</p></td>
               </tr>
 
               <tr>
-                <td>TEMPERATURE</td>
-                <td>2</td>
-                <td><p></p></td>
+                <td>DISTANCE</td>
+                <td>3</td>
+                <td><p>Distance in metric or imperial units.</p></td>
               </tr>
 
               <tr>
-                <td>DISTANCE</td>
-                <td>3</td>
-                <td><p></p></td>
+                <td>DURATION</td>
+                <td>8</td>
+                <td><p>Time period.</p></td>
               </tr>
 
               <tr>
-                <td>PRESSURE</td>
-                <td>4</td>
-                <td><p></p></td>
+                <td>FLOW</td>
+                <td>12</td>
+                <td><p>Volume per time period.</p></td>
               </tr>
 
               <tr>
-                <td>VOLTAGE</td>
-                <td>5</td>
-                <td><p></p></td>
+                <td>FUEL_EFFICIENCY</td>
+                <td>9</td>
+                <td><p>Fuel efficiency, e.g. mpg or l/100km.</p></td>
               </tr>
 
               <tr>
-                <td>SPEED</td>
-                <td>6</td>
-                <td><p></p></td>
+                <td>MASS</td>
+                <td>10</td>
+                <td><p>Mass.</p></td>
               </tr>
 
               <tr>
-                <td>VOLUME</td>
-                <td>7</td>
-                <td><p></p></td>
+                <td>OTHER</td>
+                <td>15</td>
+                <td><p>Known unit that is not (yet) supported.
+This could be a very specific value, like a counter,
+or something like energy in joules that is not available.</p></td>
               </tr>
 
               <tr>
-                <td>DURATION</td>
-                <td>8</td>
-                <td><p></p></td>
+                <td>PERCENTAGE</td>
+                <td>1</td>
+                <td><p>A percentage, typically 0-100%.</p></td>
               </tr>
 
               <tr>
-                <td>FUEL_EFFICIENCY</td>
-                <td>9</td>
-                <td><p></p></td>
+                <td>PRESSURE</td>
+                <td>4</td>
+                <td><p>Pressure.</p></td>
               </tr>
 
               <tr>
-                <td>MASS</td>
-                <td>10</td>
-                <td><p></p></td>
+                <td>RATE</td>
+                <td>14</td>
+                <td><p>Count per time period, e.g. the amount of items counted in a 24 hour window.</p></td>
               </tr>
 
               <tr>
-                <td>BATTERY_LEVEL</td>
-                <td>11</td>
-                <td><p></p></td>
+                <td>ROTATION_SPEED</td>
+                <td>13</td>
+                <td><p>Speed that something rotates per time period, typically in revolutions per minute.</p></td>
               </tr>
 
               <tr>
-                <td>FLOW</td>
-                <td>12</td>
-                <td><p></p></td>
+                <td>TEMPERATURE</td>
+                <td>2</td>
+                <td><p>Temperature.</p></td>
               </tr>
 
               <tr>
-                <td>ROTATION_SPEED</td>
-                <td>13</td>
-                <td><p></p></td>
+                <td>SPEED</td>
+                <td>6</td>
+                <td><p>Speed, e.g. km/h.</p></td>
               </tr>
 
               <tr>
-                <td>RATE</td>
-                <td>14</td>
-                <td><p></p></td>
+                <td>VOLTAGE</td>
+                <td>5</td>
+                <td><p>Voltage, e.g. mV.</p></td>
+              </tr>
+
+              <tr>
+                <td>VOLUME</td>
+                <td>7</td>
+                <td><p>Volume, e.g. m³.</p></td>
               </tr>
 
           </tbody>