Update the part about creating a schema, and adding images in define …

…alarm triggers
biotz · Jun 21, 2024 · 5556a39 · 5556a39
1 parent 1c42498
commit 5556a39
Show file tree

Hide file tree

Showing 11 changed files with 52 additions and 6 deletions.
diff --git a/docs/How-to guides/How to create a dashboard.md b/docs/How-to guides/How to create a dashboard.md
@@ -248,5 +248,5 @@ This would be an example of a device map panel:
 </div>
 
  After creating one of these panels, you should select the dashboard for which you have created the panel, and you should see all the panels you have created for that dashboard. The panels vary depending on the type of panel and its configuration.
-
+d
 
diff --git a/docs/How-to guides/How to create a schema.md b/docs/How-to guides/How to create a schema.md
@@ -70,6 +70,40 @@ Timestamp ones, the same as the rest with an extra one:
 ![Payload Timestamp](img/payload-timestamp.png)
 </div>
 
+### Data tranformation
+
+This would be a data transformation functionality during ingestion, which now includes advanced options such as the application of scaling and offsetting. This feature allows users to adjust their data more precisely during the ingestion process, this will be applicable to integers and decimals.
+
+How to Use the Functionality
+
+**Step 1: Access the Ingestion Configuration**
+Navigate to the data ingestion module in the Biotz platform.
+Select the "Data Transformation" option clicking where it says "fx": will only appear on click when having selected, integer, integer as text, integer as hexadecimal text, decimal and decimal as text.
+
+<div class="tutorial-image-container">
+    ![Creating panels](img/click-to-tranform.png)
+</div>
+
+**Step 2: Define Transformation Rules with Scale and Offset**
+
+Click on "Tranformation type".
+Select the type of transformation you want to apply, you can only choose scale and offset.
+Configure the specific parameters of the transformation.
+
+For example:
+
+Scale: 1.5
+Offset: -2
+This means that each data value will be multiplied by 1.5 and then 2 will be subtracted.
+
+<div class="tutorial-image-container">
+    ![Creating panels](img/transformation.png)
+</div>
+
+**Step 3: Apply Transformations**
+
+Associate the defined transformation rules with the data ingestion flow.
+
 Once the schema is totally represented the ‘save’ button will register the schema. This will create the necessary machinery for the data validation and ingestion, it will also create the needed database structure for the data to be stored.
 
 ## Create a schema using the text editor

diff --git a/docs/How-to guides/How to define alarm and triggers.md b/docs/How-to guides/How to define alarm and triggers.md
@@ -21,12 +21,16 @@ The alarm trigger will apply to all the devices of a certain device type no matt
 The alarm triggers are defined in the “Alarm triggers” subsection under the “Setup” section.
 <br></br>
 
-\<screenshot>
+<div class="tutorial-image-container">
+    ![Creating panels](img/alarm-triggers.png)
+</div>
 
-<!-- To create the first alarm click on the “New alarm trigger” button. -->
+To create the first alarm click on the “New alarm trigger” button.If you want to create a new one you can also click on the top right hand corner.
 <br></br>
 
-\<screenshot>
+<div class="tutorial-image-container">
+    ![Creating panels](img/new-alarm-trigger.png)
+</div>
 
 Defining an alarm requires three steps: general options, rule definition and notification settings.
 
@@ -78,6 +82,8 @@ By default no users will be notified when an alarm is triggered. The triggered a
 <br></br>
 The selected users will get a web notification and an email when an alarm is triggered.
 <br></br>
-\<screenshot>
+<div class="tutorial-image-container">
+![Groups](img/select-user.png)
+</div>
 <br></br>
 To avoid overwhelming the user with notifications, a rate limit is applied to the notifications sent to the users. The users will be notified at most once every 15 minutes for each device an alarm trigger definition. Additional notifications will be ignored, but the alarm will be persisted and viewable in the alarms list.
diff --git a/docs/How-to guides/How to use dashboard variables.md b/docs/How-to guides/How to use dashboard variables.md
@@ -42,10 +42,16 @@ Once a dashboard variable is defined it can be used when defining dashboard pane
 
 For that, click on the “Variable, select a variable defined in the dashboard” in the query builder. Then select a specific variable from the list. Continue with the rest of the form as when selecting a specific device.
 
+<div class="tutorial-image-container">
+    ![Creating panels](img/variable-selector.png)
+</div>
+‍
 The dashboard variable is now ready to use. Changing the device in the dashboard view will update the corresponding panels.
 
+This is what a new panel would look like using variables:
+
 <div class="tutorial-image-container">
-    ![Creating panels](img/variable-selector.png)
+    ![Creating panels](img/with-variables.png)
 </div>
 ‍
 

diff --git a/docs/How-to guides/img/alarm-triggers.png b/docs/How-to guides/img/alarm-triggers.png
diff --git a/docs/How-to guides/img/click-to-tranform.png b/docs/How-to guides/img/click-to-tranform.png
diff --git a/docs/How-to guides/img/general-information.png b/docs/How-to guides/img/general-information.png
diff --git a/docs/How-to guides/img/new-alarm-trigger.png b/docs/How-to guides/img/new-alarm-trigger.png
diff --git a/docs/How-to guides/img/select-user.png b/docs/How-to guides/img/select-user.png
diff --git a/docs/How-to guides/img/transformation.png b/docs/How-to guides/img/transformation.png
diff --git a/docs/How-to guides/img/with-variables.png b/docs/How-to guides/img/with-variables.png