0.185.0

HiberGlobal · Mar 12, 2024 · 05d3048 · 05d3048
1 parent ee71e2a
commit 05d3048
Show file tree

Hide file tree

Showing 34 changed files with 668 additions and 301 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,22 @@
 # Changelog Hiber API
 
+### 0.185 (2024-03-12)
+
+##### AlarmService
+
+- Add `BlockedRangeCheck` as an explicit inverted `ThresholdCheck`.
+  - Creating a `ThresholdCheck` where `minimum` > `maximum` automatically creates a `BlockedRangeCheck`.
+  - Creating a `BlockedRangeCheck` where `minimum` > `maximum` automatically creates a `ThresholdCheck`.
+
+##### UserService
+
+- Fixed a bug where a user that was invited and removed from an organization could not be invited again.
+
+##### ModemService
+
+- Added a new lifecycle: `READY_TO_INSTALL` to `Modem.Lifecycle`.
+- Updated the documentation for `Modem.Lifecycle` to be more clear.
+
 ### 0.183 (2024-02-27)
 
 ##### ValueService

diff --git a/docs/enum-json/modem.json b/docs/enum-json/modem.json
@@ -33,12 +33,13 @@
   "name": "Lifecycle",
   "description": "",
   "values": {
-    "ACCEPTANCE_TESTING": "Device is deployed, but not active yet. Invisible for customer."
-    ,"INSTALLED": "Device is active and sending messages. See health for more details on its health, based on the past messages."
-    ,"PAUSED": "Device is paused and not sending messages. This should be of a temporary nature. (e.g. a change to the installation is being made)"
-    ,"DISABLED": "Device is disabled and not sending messages. Invisible for customer. This could be either temporary or become permanent. Used for cases where devices is being serviced and customer should not be burdened with the health of this device."
-    ,"DECOMMISSIONED": "Device is (going to be) removed from installation and will not return to installed status again."
-    ,"DEFECTIVE": "Device is defective and should not be used anymore."
+    "ACCEPTANCE_TESTING": "Device is being tested by Hiber. Devices in this state are not visible to customers."
+    ,"READY_TO_INSTALL": "Device has passed Acceptance Testing and is ready be installed. When it sends it first message, it will automatically go to INSTALLED. Devices in this state are not visible to customers."
+    ,"INSTALLED": "Device is active and sending messages."
+    ,"PAUSED": "Device is paused and not sending messages. This should be of a temporary nature (e.g. a change to the installation is being made). On its next message, it will automatically go back to INSTALLED. Offline alarm checks will not be triggered for devices in this lifecycle."
+    ,"DISABLED": "Device is disabled and not sending messages. This is a more permanent version of PAUSED. Devices in this state are not visible to customers."
+    ,"DECOMMISSIONED": "Device is (going to be) removed from installation and will not return to installed status again. Devices in this state are not visible to customers."
+    ,"DEFECTIVE": "Device is defective and should not be used anymore. Devices in this state are typically RMA-ed and (should be) transferred to the RMA organization. Devices in this state are not visible to customers."
     }
 },{
   "name": "Type",

diff --git a/docs/html/assignment.html b/docs/html/assignment.html
@@ -863,6 +863,10 @@ <h2>Table of Contents</h2>
                   <a href="#hiber.modem.alarm.ModemAlarm.Check.FieldCheck.BlockedCheck"><span class="badge">M</span>ModemAlarm.Check.FieldCheck.BlockedCheck</a>
                 </li>
 
+                <li>
+                  <a href="#hiber.modem.alarm.ModemAlarm.Check.FieldCheck.BlockedRangeCheck"><span class="badge">M</span>ModemAlarm.Check.FieldCheck.BlockedRangeCheck</a>
+                </li>
+
                 <li>
                   <a href="#hiber.modem.alarm.ModemAlarm.Check.FieldCheck.DeltaCheck"><span class="badge">M</span>ModemAlarm.Check.FieldCheck.DeltaCheck</a>
                 </li>
@@ -7755,42 +7759,54 @@ <h3 id="hiber.modem.Modem.Lifecycle">Modem.Lifecycle</h3>
               <tr>
                 <td>ACCEPTANCE_TESTING</td>
                 <td>0</td>
-                <td><p>Device is deployed, but not active yet. Invisible for customer.</p></td>
+                <td><p>Device is being tested by Hiber.
+Devices in this state are not visible to customers.</p></td>
+              </tr>
+
+              <tr>
+                <td>READY_TO_INSTALL</td>
+                <td>8</td>
+                <td><p>Device has passed Acceptance Testing and is ready be installed.
+When it sends it first message, it will automatically go to INSTALLED.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>INSTALLED</td>
                 <td>1</td>
-                <td><p>Device is active and sending messages.
-See health for more details on its health, based on the past messages.</p></td>
+                <td><p>Device is active and sending messages.</p></td>
               </tr>
 
               <tr>
                 <td>PAUSED</td>
                 <td>6</td>
-                <td><p>Device is paused and not sending messages. This should be of a temporary nature.
-(e.g. a change to the installation is being made)</p></td>
+                <td><p>Device is paused and not sending messages.
+This should be of a temporary nature (e.g. a change to the installation is being made).
+On its next message, it will automatically go back to INSTALLED.
+Offline alarm checks will not be triggered for devices in this lifecycle.</p></td>
               </tr>
 
               <tr>
                 <td>DISABLED</td>
                 <td>5</td>
-                <td><p>Device is disabled and not sending messages. Invisible for customer.
-This could be either temporary or become permanent.
-Used for cases where devices is being serviced and customer
-should not be burdened with the health of this device.</p></td>
+                <td><p>Device is disabled and not sending messages.
+This is a more permanent version of PAUSED.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>DECOMMISSIONED</td>
                 <td>4</td>
-                <td><p>Device is (going to be) removed from installation and will not return to installed status again.</p></td>
+                <td><p>Device is (going to be) removed from installation and will not return to installed status again.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>DEFECTIVE</td>
                 <td>7</td>
-                <td><p>Device is defective and should not be used anymore.</p></td>
+                <td><p>Device is defective and should not be used anymore.
+Devices in this state are typically RMA-ed and (should be) transferred to the RMA organization.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
           </tbody>
@@ -8696,6 +8712,13 @@ <h3 id="hiber.modem.alarm.ModemAlarm.Check.FieldCheck">ModemAlarm.Check.FieldChe
                   <td><p>Check that a field is within a given numeric range. </p></td>
                 </tr>
 
+                <tr>
+                  <td>blocked_range</td>
+                  <td><a href="#hiber.modem.alarm.ModemAlarm.Check.FieldCheck.BlockedRangeCheck">ModemAlarm.Check.FieldCheck.BlockedRangeCheck</a></td>
+                  <td></td>
+                  <td><p>Check that a field is not in a given numeric range. </p></td>
+                </tr>
+
                 <tr>
                   <td>delta</td>
                   <td><a href="#hiber.modem.alarm.ModemAlarm.Check.FieldCheck.DeltaCheck">ModemAlarm.Check.FieldCheck.DeltaCheck</a></td>
@@ -8758,6 +8781,30 @@ <h3 id="hiber.modem.alarm.ModemAlarm.Check.FieldCheck.BlockedCheck">ModemAlarm.C
 
 
 
+        <h3 id="hiber.modem.alarm.ModemAlarm.Check.FieldCheck.BlockedRangeCheck">ModemAlarm.Check.FieldCheck.BlockedRangeCheck</h3>
+        <p>Check that the field is outside of a range.</p><p>If the minimum is higher than the maximum (i.e. 30..10), this is automatically converted into a</p><p>ThresholdCheck.</p>
+
+
+          <table class="field-table">
+            <thead>
+              <tr><td>Field</td><td>Type</td><td>Label</td><td>Description</td></tr>
+            </thead>
+            <tbody>
+
+                <tr>
+                  <td>blocked</td>
+                  <td><a href="#hiber.DoubleRange">hiber.DoubleRange</a></td>
+                  <td></td>
+                  <td><p>The range the value must not be in. </p></td>
+                </tr>
+
+            </tbody>
+          </table>
+
+
+
+
+
         <h3 id="hiber.modem.alarm.ModemAlarm.Check.FieldCheck.DeltaCheck">ModemAlarm.Check.FieldCheck.DeltaCheck</h3>
         <p>A check that evaluates the differences in values over time, for the selected field(s) in the parsed body.</p>
 
@@ -8880,7 +8927,7 @@ <h3 id="hiber.modem.alarm.ModemAlarm.Check.FieldCheck.MinimumCheck">ModemAlarm.C
 
 
         <h3 id="hiber.modem.alarm.ModemAlarm.Check.FieldCheck.ThresholdCheck">ModemAlarm.Check.FieldCheck.ThresholdCheck</h3>
-        <p>Check that the field is above a minimum threshold and under a maximum threshold.</p><p>If minimum <= maximum, this means that the value must be between minimum and maximum.</p><p>If minimum > maximum, however, this means that the value must NOT be between maximum and minimum</p><p>(i.e. minimum 100 with maximum 50 means it cannot be between 50 and 100).</p>
+        <p>Check that the field is above a minimum threshold and under a maximum threshold.</p><p>If the minimum is higher than the maximum (i.e. 30..10), this is automatically converted into a</p><p>BlockedRangeCheck.</p>
 
 
           <table class="field-table">
@@ -8893,9 +8940,7 @@ <h3 id="hiber.modem.alarm.ModemAlarm.Check.FieldCheck.ThresholdCheck">ModemAlarm
                   <td>expected</td>
                   <td><a href="#hiber.DoubleRange">hiber.DoubleRange</a></td>
                   <td></td>
-                  <td><p>The range the value must be in.
-If maximum &lt; minimum, the value must effectively be outside the inverted range, i.e.
-20..10 implies the value must not be in 10..20. </p></td>
+                  <td><p>The range the value must be in. </p></td>
                 </tr>
 
                 <tr>

diff --git a/docs/html/dashboard.html b/docs/html/dashboard.html
@@ -8592,42 +8592,54 @@ <h3 id="hiber.modem.Modem.Lifecycle">Modem.Lifecycle</h3>
               <tr>
                 <td>ACCEPTANCE_TESTING</td>
                 <td>0</td>
-                <td><p>Device is deployed, but not active yet. Invisible for customer.</p></td>
+                <td><p>Device is being tested by Hiber.
+Devices in this state are not visible to customers.</p></td>
+              </tr>
+
+              <tr>
+                <td>READY_TO_INSTALL</td>
+                <td>8</td>
+                <td><p>Device has passed Acceptance Testing and is ready be installed.
+When it sends it first message, it will automatically go to INSTALLED.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>INSTALLED</td>
                 <td>1</td>
-                <td><p>Device is active and sending messages.
-See health for more details on its health, based on the past messages.</p></td>
+                <td><p>Device is active and sending messages.</p></td>
               </tr>
 
               <tr>
                 <td>PAUSED</td>
                 <td>6</td>
-                <td><p>Device is paused and not sending messages. This should be of a temporary nature.
-(e.g. a change to the installation is being made)</p></td>
+                <td><p>Device is paused and not sending messages.
+This should be of a temporary nature (e.g. a change to the installation is being made).
+On its next message, it will automatically go back to INSTALLED.
+Offline alarm checks will not be triggered for devices in this lifecycle.</p></td>
               </tr>
 
               <tr>
                 <td>DISABLED</td>
                 <td>5</td>
-                <td><p>Device is disabled and not sending messages. Invisible for customer.
-This could be either temporary or become permanent.
-Used for cases where devices is being serviced and customer
-should not be burdened with the health of this device.</p></td>
+                <td><p>Device is disabled and not sending messages.
+This is a more permanent version of PAUSED.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>DECOMMISSIONED</td>
                 <td>4</td>
-                <td><p>Device is (going to be) removed from installation and will not return to installed status again.</p></td>
+                <td><p>Device is (going to be) removed from installation and will not return to installed status again.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>DEFECTIVE</td>
                 <td>7</td>
-                <td><p>Device is defective and should not be used anymore.</p></td>
+                <td><p>Device is defective and should not be used anymore.
+Devices in this state are typically RMA-ed and (should be) transferred to the RMA organization.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
           </tbody>

diff --git a/docs/html/device.html b/docs/html/device.html
@@ -7226,42 +7226,54 @@ <h3 id="hiber.modem.Modem.Lifecycle">Modem.Lifecycle</h3>
               <tr>
                 <td>ACCEPTANCE_TESTING</td>
                 <td>0</td>
-                <td><p>Device is deployed, but not active yet. Invisible for customer.</p></td>
+                <td><p>Device is being tested by Hiber.
+Devices in this state are not visible to customers.</p></td>
+              </tr>
+
+              <tr>
+                <td>READY_TO_INSTALL</td>
+                <td>8</td>
+                <td><p>Device has passed Acceptance Testing and is ready be installed.
+When it sends it first message, it will automatically go to INSTALLED.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>INSTALLED</td>
                 <td>1</td>
-                <td><p>Device is active and sending messages.
-See health for more details on its health, based on the past messages.</p></td>
+                <td><p>Device is active and sending messages.</p></td>
               </tr>
 
               <tr>
                 <td>PAUSED</td>
                 <td>6</td>
-                <td><p>Device is paused and not sending messages. This should be of a temporary nature.
-(e.g. a change to the installation is being made)</p></td>
+                <td><p>Device is paused and not sending messages.
+This should be of a temporary nature (e.g. a change to the installation is being made).
+On its next message, it will automatically go back to INSTALLED.
+Offline alarm checks will not be triggered for devices in this lifecycle.</p></td>
               </tr>
 
               <tr>
                 <td>DISABLED</td>
                 <td>5</td>
-                <td><p>Device is disabled and not sending messages. Invisible for customer.
-This could be either temporary or become permanent.
-Used for cases where devices is being serviced and customer
-should not be burdened with the health of this device.</p></td>
+                <td><p>Device is disabled and not sending messages.
+This is a more permanent version of PAUSED.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>DECOMMISSIONED</td>
                 <td>4</td>
-                <td><p>Device is (going to be) removed from installation and will not return to installed status again.</p></td>
+                <td><p>Device is (going to be) removed from installation and will not return to installed status again.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>DEFECTIVE</td>
                 <td>7</td>
-                <td><p>Device is defective and should not be used anymore.</p></td>
+                <td><p>Device is defective and should not be used anymore.
+Devices in this state are typically RMA-ed and (should be) transferred to the RMA organization.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
           </tbody>

diff --git a/docs/html/device_service.html b/docs/html/device_service.html
@@ -6988,42 +6988,54 @@ <h3 id="hiber.modem.Modem.Lifecycle">Modem.Lifecycle</h3>
               <tr>
                 <td>ACCEPTANCE_TESTING</td>
                 <td>0</td>
-                <td><p>Device is deployed, but not active yet. Invisible for customer.</p></td>
+                <td><p>Device is being tested by Hiber.
+Devices in this state are not visible to customers.</p></td>
+              </tr>
+
+              <tr>
+                <td>READY_TO_INSTALL</td>
+                <td>8</td>
+                <td><p>Device has passed Acceptance Testing and is ready be installed.
+When it sends it first message, it will automatically go to INSTALLED.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>INSTALLED</td>
                 <td>1</td>
-                <td><p>Device is active and sending messages.
-See health for more details on its health, based on the past messages.</p></td>
+                <td><p>Device is active and sending messages.</p></td>
               </tr>
 
               <tr>
                 <td>PAUSED</td>
                 <td>6</td>
-                <td><p>Device is paused and not sending messages. This should be of a temporary nature.
-(e.g. a change to the installation is being made)</p></td>
+                <td><p>Device is paused and not sending messages.
+This should be of a temporary nature (e.g. a change to the installation is being made).
+On its next message, it will automatically go back to INSTALLED.
+Offline alarm checks will not be triggered for devices in this lifecycle.</p></td>
               </tr>
 
               <tr>
                 <td>DISABLED</td>
                 <td>5</td>
-                <td><p>Device is disabled and not sending messages. Invisible for customer.
-This could be either temporary or become permanent.
-Used for cases where devices is being serviced and customer
-should not be burdened with the health of this device.</p></td>
+                <td><p>Device is disabled and not sending messages.
+This is a more permanent version of PAUSED.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>DECOMMISSIONED</td>
                 <td>4</td>
-                <td><p>Device is (going to be) removed from installation and will not return to installed status again.</p></td>
+                <td><p>Device is (going to be) removed from installation and will not return to installed status again.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
               <tr>
                 <td>DEFECTIVE</td>
                 <td>7</td>
-                <td><p>Device is defective and should not be used anymore.</p></td>
+                <td><p>Device is defective and should not be used anymore.
+Devices in this state are typically RMA-ed and (should be) transferred to the RMA organization.
+Devices in this state are not visible to customers.</p></td>
               </tr>
 
           </tbody>