0.130.0

HiberGlobal · Nov 21, 2022 · 0cf085f · 0cf085f
1 parent 924564a
commit 0cf085f
Show file tree

Hide file tree

Showing 84 changed files with 2,148 additions and 394 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,25 @@
 # Changelog Hiber API
 
+### 0.130 (2022-11-21)
+
+##### EventService
+
+- Renamed the deprecated `ModemEvent.ModemActivatedEvent` to `ModemEvent.ModemInstalledEvent` to reflect the new
+  lifecycles.
+  - Renamed `Event.modem_activated` to `Event.modem_installed`.
+  - Removed deprecation flag from `ModemEvent.ModemActivatedEvent`.
+  - Changed when the event is produced:
+    - `ModemEvent.ModemActivatedEvent` was produced by the first real message from the modem.
+    - Now, `ModemEvent.ModemInstalledEvent` is produced when the lifecycle is changed to `INSTALLED`.
+      - Because of this `message_id` and `sent_at`, were removed from `ModemEvent.ModemInstalledEvent`.
+#### Unit values
+- Added support for rotation speed
+  - Currently only one unit, which is revolutions per minute (RPM)
+#### UnitPreferences
+
+- Add optional fields to UnitPreferences for each unit
+- Deprecate old oneof unit fields (with a separate boolean for each unit indicating whether that unit has a preference set)
+
 ### 0.129 (2022-11-14)
 
 ##### EasypulseService

diff --git a/base.proto b/base.proto
@@ -303,8 +303,8 @@ enum EventType {
  * When combined with include, exclude takes precedence when determining whether an item is filtered
  */
 message Filter {
-    /* Specify which organizations to get data from. By default, data is only retrieved for the current organization, but
-     * using ChildOrganizations we can specify to include a number of, or all, sub-organizations.
+    /* Specify which organizations to get data from. By default, data is only retrieved for the current organization,
+     * but using ChildOrganizations we can specify to include a number of, or all, sub-organizations.
      *
      * Note: ChildOrganization differs from other filters in that it defaults to not allowing anything, where the
      * other filters default to allowing everything
@@ -575,5 +575,7 @@ enum UnitOfMeasurement {
 
     FLOW_CUBIC_METERS_PER_HOUR = 39;
 
+    REVOLUTIONS_PER_MINUTE = 44;
+
     reserved 13;
 }
diff --git a/docs/html/assignment.html b/docs/html/assignment.html
@@ -2905,7 +2905,7 @@ <h3 id="hiber.Filter">Filter</h3>
 
 
         <h3 id="hiber.Filter.ChildOrganizations">Filter.ChildOrganizations</h3>
-        <p>Specify which organizations to get data from. By default, data is only retrieved for the current organization, but</p><p>using ChildOrganizations we can specify to include a number of, or all, sub-organizations.</p><p>Note: ChildOrganization differs from other filters in that it defaults to not allowing anything, where the</p><p>other filters default to allowing everything</p>
+        <p>Specify which organizations to get data from. By default, data is only retrieved for the current organization,</p><p>but using ChildOrganizations we can specify to include a number of, or all, sub-organizations.</p><p>Note: ChildOrganization differs from other filters in that it defaults to not allowing anything, where the</p><p>other filters default to allowing everything</p>
 
 
           <table class="field-table">
@@ -4698,6 +4698,12 @@ <h3 id="hiber.UnitOfMeasurement">UnitOfMeasurement</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>REVOLUTIONS_PER_MINUTE</td>
+                <td>44</td>
+                <td><p></p></td>
+              </tr>
+
           </tbody>
         </table>
 
@@ -5825,7 +5831,7 @@ <h3 id="hiber.modem.Modem.Peripherals">Modem.Peripherals</h3>
                   <td>hiber_antenna</td>
                   <td><a href="#hiber.modem.Modem.Peripherals.HiberAntenna">Modem.Peripherals.HiberAntenna</a></td>
                   <td></td>
-                  <td><p> </p></td>
+                  <td><p><strong>Deprecated.</strong>  </p></td>
                 </tr>
 
                 <tr>
@@ -5853,6 +5859,27 @@ <h3 id="hiber.modem.Modem.Peripherals">Modem.Peripherals</h3>
           </table>
 
 
+
+
+            <h4>Fields with deprecated option</h4>
+            <table>
+              <thead>
+                <tr>
+                  <td>Name</td>
+                  <td>Option</td>
+                </tr>
+              </thead>
+              <tbody>
+
+                <tr>
+                  <td>hiber_antenna</td>
+                  <td><p>true</p></td>
+                </tr>
+
+              </tbody>
+            </table>
+
+
 
 
 
@@ -7854,6 +7881,31 @@ <h4>Methods with deprecated option</h4>
                 <td><p>true</p></td>
               </tr>
 
+              <tr>
+                <td>Rename</td>
+                <td><p>true</p></td>
+              </tr>
+
+              <tr>
+                <td>UpdateNotes</td>
+                <td><p>true</p></td>
+              </tr>
+
+              <tr>
+                <td>UpdateSecureNotes</td>
+                <td><p>true</p></td>
+              </tr>
+
+              <tr>
+                <td>UpdateStatus</td>
+                <td><p>true</p></td>
+              </tr>
+
+              <tr>
+                <td>UpdatePeripherals</td>
+                <td><p>true</p></td>
+              </tr>
+
             </tbody>
           </table>
 

diff --git a/docs/html/certificate.html b/docs/html/certificate.html
@@ -1196,7 +1196,7 @@ <h3 id="hiber.Filter">Filter</h3>
 
 
         <h3 id="hiber.Filter.ChildOrganizations">Filter.ChildOrganizations</h3>
-        <p>Specify which organizations to get data from. By default, data is only retrieved for the current organization, but</p><p>using ChildOrganizations we can specify to include a number of, or all, sub-organizations.</p><p>Note: ChildOrganization differs from other filters in that it defaults to not allowing anything, where the</p><p>other filters default to allowing everything</p>
+        <p>Specify which organizations to get data from. By default, data is only retrieved for the current organization,</p><p>but using ChildOrganizations we can specify to include a number of, or all, sub-organizations.</p><p>Note: ChildOrganization differs from other filters in that it defaults to not allowing anything, where the</p><p>other filters default to allowing everything</p>
 
 
           <table class="field-table">
@@ -2989,6 +2989,12 @@ <h3 id="hiber.UnitOfMeasurement">UnitOfMeasurement</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>REVOLUTIONS_PER_MINUTE</td>
+                <td>44</td>
+                <td><p></p></td>
+              </tr>
+
           </tbody>
         </table>
 

diff --git a/docs/html/currentuser.html b/docs/html/currentuser.html
@@ -1534,7 +1534,7 @@ <h3 id="hiber.Filter">Filter</h3>
 
 
         <h3 id="hiber.Filter.ChildOrganizations">Filter.ChildOrganizations</h3>
-        <p>Specify which organizations to get data from. By default, data is only retrieved for the current organization, but</p><p>using ChildOrganizations we can specify to include a number of, or all, sub-organizations.</p><p>Note: ChildOrganization differs from other filters in that it defaults to not allowing anything, where the</p><p>other filters default to allowing everything</p>
+        <p>Specify which organizations to get data from. By default, data is only retrieved for the current organization,</p><p>but using ChildOrganizations we can specify to include a number of, or all, sub-organizations.</p><p>Note: ChildOrganization differs from other filters in that it defaults to not allowing anything, where the</p><p>other filters default to allowing everything</p>
 
 
           <table class="field-table">
@@ -3327,6 +3327,12 @@ <h3 id="hiber.UnitOfMeasurement">UnitOfMeasurement</h3>
                 <td><p></p></td>
               </tr>
 
+              <tr>
+                <td>REVOLUTIONS_PER_MINUTE</td>
+                <td>44</td>
+                <td><p></p></td>
+              </tr>
+
           </tbody>
         </table>
 

diff --git a/docs/html/dashboard.html b/docs/html/dashboard.html
@@ -326,11 +326,11 @@ <h2>Table of Contents</h2>
                 </li>
 
                 <li>
-                  <a href="#hiber.event.Event.ModemEvent.ModemActivatedEvent"><span class="badge">M</span>Event.ModemEvent.ModemActivatedEvent</a>
+                  <a href="#hiber.event.Event.ModemEvent.ModemCreatedEvent"><span class="badge">M</span>Event.ModemEvent.ModemCreatedEvent</a>
                 </li>
 
                 <li>
-                  <a href="#hiber.event.Event.ModemEvent.ModemCreatedEvent"><span class="badge">M</span>Event.ModemEvent.ModemCreatedEvent</a>
+                  <a href="#hiber.event.Event.ModemEvent.ModemInstalledEvent"><span class="badge">M</span>Event.ModemEvent.ModemInstalledEvent</a>
                 </li>
 
                 <li>
@@ -1233,10 +1233,10 @@ <h3 id="hiber.event.Event">Event</h3>
                 </tr>
 
                 <tr>
-                  <td>modem_activated</td>
-                  <td><a href="#hiber.event.Event.ModemEvent.ModemActivatedEvent">Event.ModemEvent.ModemActivatedEvent</a></td>
+                  <td>modem_installed</td>
+                  <td><a href="#hiber.event.Event.ModemEvent.ModemInstalledEvent">Event.ModemEvent.ModemInstalledEvent</a></td>
                   <td></td>
-                  <td><p><strong>Deprecated.</strong>  </p></td>
+                  <td><p> </p></td>
                 </tr>
 
                 <tr>
@@ -1552,11 +1552,6 @@ <h4>Fields with deprecated option</h4>
                   <td><p>true</p></td>
                 </tr>
 
-                <tr>
-                  <td>modem_activated</td>
-                  <td><p>true</p></td>
-                </tr>
-
               </tbody>
             </table>
 
@@ -2918,8 +2913,8 @@ <h3 id="hiber.event.Event.ModemEvent.MessageEvent.ModemMessageReceivedEvent">Eve
 
 
 
-        <h3 id="hiber.event.Event.ModemEvent.ModemActivatedEvent">Event.ModemEvent.ModemActivatedEvent</h3>
-        <p>When the first _real_ message for a modem comes in, the modem is considered to be activated.</p><p>A _real_ message is:</p><p>- a message received through a modem, on an environment that has real modems (hiber.cloud)</p><p>- any test message, on an environment that only has simulated modems (dev.hiber.global)</p>
+        <h3 id="hiber.event.Event.ModemEvent.ModemCreatedEvent">Event.ModemEvent.ModemCreatedEvent</h3>
+        <p></p>
 
 
           <table class="field-table">
@@ -2949,25 +2944,11 @@ <h3 id="hiber.event.Event.ModemEvent.ModemActivatedEvent">Event.ModemEvent.Modem
                   <td><p>External device id for this modem (e.g. a MAC address). </p></td>
                 </tr>
 
-                <tr>
-                  <td>message_id</td>
-                  <td><a href="#uint64">uint64</a></td>
-                  <td></td>
-                  <td><p>The id of the mesasge that activated this modem. </p></td>
-                </tr>
-
                 <tr>
                   <td>time</td>
                   <td><a href="#hiber.Timestamp">hiber.Timestamp</a></td>
                   <td></td>
-                  <td><p>The time this modem was activated in the system. </p></td>
-                </tr>
-
-                <tr>
-                  <td>sent_at</td>
-                  <td><a href="#hiber.Timestamp">hiber.Timestamp</a></td>
-                  <td></td>
-                  <td><p>The time this modem sent the message that activated it. </p></td>
+                  <td><p> </p></td>
                 </tr>
 
                 <tr>
@@ -2998,8 +2979,8 @@ <h3 id="hiber.event.Event.ModemEvent.ModemActivatedEvent">Event.ModemEvent.Modem
 
 
 
-        <h3 id="hiber.event.Event.ModemEvent.ModemCreatedEvent">Event.ModemEvent.ModemCreatedEvent</h3>
-        <p></p>
+        <h3 id="hiber.event.Event.ModemEvent.ModemInstalledEvent">Event.ModemEvent.ModemInstalledEvent</h3>
+        <p>When the modem is marked as installed.</p>
 
 
           <table class="field-table">
@@ -3033,7 +3014,7 @@ <h3 id="hiber.event.Event.ModemEvent.ModemCreatedEvent">Event.ModemEvent.ModemCr
                   <td>time</td>
                   <td><a href="#hiber.Timestamp">hiber.Timestamp</a></td>
                   <td></td>
-                  <td><p> </p></td>
+                  <td><p>The time this modem was installed. </p></td>
                 </tr>
 
                 <tr>
@@ -7080,7 +7061,7 @@ <h3 id="hiber.modem.Modem.Peripherals">Modem.Peripherals</h3>
                   <td>hiber_antenna</td>
                   <td><a href="#hiber.modem.Modem.Peripherals.HiberAntenna">Modem.Peripherals.HiberAntenna</a></td>
                   <td></td>
-                  <td><p> </p></td>
+                  <td><p><strong>Deprecated.</strong>  </p></td>
                 </tr>
 
                 <tr>
@@ -7108,6 +7089,27 @@ <h3 id="hiber.modem.Modem.Peripherals">Modem.Peripherals</h3>
           </table>
 
 
+
+
+            <h4>Fields with deprecated option</h4>
+            <table>
+              <thead>
+                <tr>
+                  <td>Name</td>
+                  <td>Option</td>
+                </tr>
+              </thead>
+              <tbody>
+
+                <tr>
+                  <td>hiber_antenna</td>
+                  <td><p>true</p></td>
+                </tr>
+
+              </tbody>
+            </table>
+
+
 
 
 
@@ -9109,6 +9111,31 @@ <h4>Methods with deprecated option</h4>
                 <td><p>true</p></td>
               </tr>
 
+              <tr>
+                <td>Rename</td>
+                <td><p>true</p></td>
+              </tr>
+
+              <tr>
+                <td>UpdateNotes</td>
+                <td><p>true</p></td>
+              </tr>
+
+              <tr>
+                <td>UpdateSecureNotes</td>
+                <td><p>true</p></td>
+              </tr>
+
+              <tr>
+                <td>UpdateStatus</td>
+                <td><p>true</p></td>
+              </tr>
+
+              <tr>
+                <td>UpdatePeripherals</td>
+                <td><p>true</p></td>
+              </tr>
+
             </tbody>
           </table>