From 9b9be7bf704e205cc73adffcd0cce5ad717ae5ab Mon Sep 17 00:00:00 2001 From: Aitor Murguzur Date: Mon, 4 Mar 2024 18:30:23 +0100 Subject: [PATCH] Correcting all the links and adding some that were missing. --- ... and trigger a remote action in devices.md | 2 +- .../How to create a dashboard.md | 107 +++++++++++++++++- ...How to create developer API credentials.md | 2 +- .../How to publish device data.md | 6 +- docs/Reference guides/Developer API.md | 2 +- docs/Reference guides/MQTT broker.md | 8 +- .../Step 1 - Creating a Device Type.md | 10 +- 7 files changed, 116 insertions(+), 21 deletions(-) diff --git a/docs/How-to guides/How to configure and trigger a remote action in devices.md b/docs/How-to guides/How to configure and trigger a remote action in devices.md index 7948242..bebf725 100644 --- a/docs/How-to guides/How to configure and trigger a remote action in devices.md +++ b/docs/How-to guides/How to configure and trigger a remote action in devices.md @@ -16,7 +16,7 @@ Biotz shows the same interface for both message types (specific to communication ## Step 2 - Setup device to get the order to perform the action. -Find specific MQTT broker information following this link. +Find specific MQTT broker information following this link. The specific device of the selected device type should be already registered under the 'Device Management' section for devices. The device should be configured to SUBSCRIBE to the specific topic that Biotz will use to notify the action to the device. The topic follows this pattern: diff --git a/docs/How-to guides/How to create a dashboard.md b/docs/How-to guides/How to create a dashboard.md index 60e1a7f..02fe58d 100644 --- a/docs/How-to guides/How to create a dashboard.md +++ b/docs/How-to guides/How to create a dashboard.md @@ -13,11 +13,11 @@ Dashboards are created from the “Dashboards” list. Just a name and an option
![Dashboards](/img/Dashboards.png)
-![Dashboards](/img/Dashboards.png) When clicking on “create” an empty dashboard is created. - +
![Empty dashboard](/img/EmptyDashboard.png) +
## Creating panels @@ -26,6 +26,10 @@ A dashboard is composed of one or more panels. To create a new one use the “Ne At the moment the available panel types are the following: time-series, pie chart and gauge. +
+ ![creating panels](/img/creating-panels.png) +
+ ### General information Name the panel and optionally set a description. @@ -43,7 +47,7 @@ The query builder is used to define which data will the panel display. The x-ax

Defining a query requires the following configuration: -- Selecting a device or device variable. Each line in the chart can show the data of a single device. The device to be used can be fixed and defined at panel creation time, or determined by a dashboard variable (see this for more info). +- Selecting a device or device variable. Each line in the chart can show the data of a single device. The device to be used can be fixed and defined at panel creation time, or determined by a dashboard variable (see this for more info). - Message type and attribute. Each line in the chart can show the data of a single message type attribute. - Aggregation method. The method used to aggregate the devices data to adapt the number of displayed points to the user's screen size and zoom level. @@ -59,8 +63,105 @@ The reason for aggregating the data is performance. Lets say a certain device is ###### Appearance +
+![appearance](/img/appearance.png) +
+ +The following appearance related options are available: +- X axis title +- Y axis title +- Series appearance (configurable for each of them) +- Display name +- Color +- Dash style +- Marker symbol +- Enable/disable legend + +##### Gauge + +###### Query builder + +The query builder is used to define which data will the gauge display. A gauge shows the aggregation of a certain device message-type attribute in the selected time-frame period. + + +Defining the query requires the following configuration: + +- Selecting a device or device variable. Each gauge can show the data of a single device. The device to be used can be fixed and defined at panel creation time, or determined by a dashboard variable (see this for more info). +- Message type and attribute. Each gauge can work with a single attribute. +- Aggregation method. The data for the selected device and attribute will be aggregated using this method. Note that the special “first” and “last” aggregation methods are also available that show a single data point. +‍ + +##### Attribute type and Available aggregation methods + +- Numeric: Count, maximum, minimum, mean, standard deviation, sum, first and last. +- Boolean: Count, first and last. +- Text: Count, first and last. +‍ + +###### Appearance +The following appearance related options are available: + +- Min value +- Max value +- Unit +- Thresholds: the gauge can represent multiple threshold values using colors. +- Percentage +- Color + +##### Pie chart + +###### Query builder +The query builder is used to define which data will the pie chart display. Each segment of the pie is defined by an independent query that displays the aggregation of a certain device message type attribute. + +‍ + +Defining the query requires the following configuration: + +- Selecting a device or device variable. Each pie segment can show the data of a single device. The device to be used can be fixed and defined at panel creation time, or determined by a dashboard variable +(see this for more info). +- Message type and attribute. Each pie segment can work with a single attribute. +- Aggregation method. The data for the selected device and attribute will be aggregated using this method. Note that the special “first” and “last” aggregation methods are also available that show a single data point. +‍ + +##### Attribute type and Available aggregation methods + +- Numeric: Count, maximum, minimum, mean, standard deviation, sum, first and last. +- Boolean: Count, first and last. +- Text: Count, first and last. +‍ + +###### Appearance The following appearance related options are available: +- Enable/disable legend +- Enable/disable data-labels +- Segments appearance +- Display name +- Color +‍ + +##### State chart +###### Query builder +The query builder is used to define which data will the state chart display. Each chart can show the data from one variable. + +‍ + +Defining the query requires the following configuration: + +- Selecting a device or device variable. The device to be used can be fixed and defined at panel creation time, or determined by a dashboard variable (see this for more info). +- Message type and attribute. +- Aggregation method. The data for the selected device and attribute will be aggregated using this method. Note that the special “first” and “last” aggregation methods are also available that show a single data point. +‍ + +##### Attribute type and Available aggregation methods + +- Numeric: Count, maximum, minimum, mean, standard deviation, sum, first and last. +- Boolean: Count, first and last. +- Text: Count, first and last. +‍ + +###### Appearance +The following appearance related options are available: - Enable/disable value with unit marker. - Conditions for different styles, applies the first that's true - Color diff --git a/docs/How-to guides/How to create developer API credentials.md b/docs/How-to guides/How to create developer API credentials.md index e48fcbc..6d3add5 100644 --- a/docs/How-to guides/How to create developer API credentials.md +++ b/docs/How-to guides/How to create developer API credentials.md @@ -1,4 +1,4 @@ -To create applications that consume our data we have a Developer API, following this link you will be able to consult more information about the endpoints in our documentation. +To create applications that consume our data we have a Developer API, following this link you will be able to consult more information about the endpoints in our documentation. ## Credentials creation diff --git a/docs/How-to guides/How to publish device data.md b/docs/How-to guides/How to publish device data.md index a541ff8..f5ab8c7 100644 --- a/docs/How-to guides/How to publish device data.md +++ b/docs/How-to guides/How to publish device data.md @@ -1,10 +1,10 @@ There is a standard format of the MQTT topics for sending data from devices to the Biotz IoT Platform. For this to happen there are these pre-steps that must be fulfilled: - Organisation must be registered in Biotz. -- Device-Type, message-type and the schema of data schema of data to be sent must be registered in Biotz. -- Specific device must be registered. +- Device-Type, message-type and the schema of data schema of data to be sent must be registered in Biotz. +- Specific device must be registered. -Find specific MQTT broker information following this link. +Find specific MQTT broker information following this link. This is the generic MQTT topic builds: diff --git a/docs/Reference guides/Developer API.md b/docs/Reference guides/Developer API.md index 01dc029..297dae5 100644 --- a/docs/Reference guides/Developer API.md +++ b/docs/Reference guides/Developer API.md @@ -4,7 +4,7 @@ Here you can see the different data related to the developer API. # Reference data -The API documentation with every available endpoint is here. If you want to know how to authorize correctly before consuming the API go here. +The API documentation with every available endpoint is here. If you want to know how to authorize correctly before consuming the API go here. In order to connect correctly you'll need this data: diff --git a/docs/Reference guides/MQTT broker.md b/docs/Reference guides/MQTT broker.md index 7e836f1..448cf50 100644 --- a/docs/Reference guides/MQTT broker.md +++ b/docs/Reference guides/MQTT broker.md @@ -10,7 +10,7 @@ The authentication values are generated and provided when a new device is regist - **Username**: generated and provided when a device is registered. - **Password**: generated and provided when a device is registered. -More information about device registration here. +More information about device registration here. ## Topics @@ -21,7 +21,7 @@ More information about device registration More information +More information ### Subscribe #### Remote actioning:‍ @@ -29,12 +29,12 @@ biotz/1/0/CUSTOMER-ID/DEVICE-ID/publish/data/MESSAGE-TYPE-INTERNAL-NAME ``` biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/action/ACTION-MESSAGE-TYPE-INTERNAL-NAME ``` -More information +More information ### Firmware updates: ``` biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/firmware/update ``` -More information +More information diff --git a/docs/Tutorials/Step 1 - Creating a Device Type.md b/docs/Tutorials/Step 1 - Creating a Device Type.md index 3caf242..5b2494c 100644 --- a/docs/Tutorials/Step 1 - Creating a Device Type.md +++ b/docs/Tutorials/Step 1 - Creating a Device Type.md @@ -1,10 +1,5 @@ ---- -id: Step 1-Creating a Device Type - ---- - -# Creating a Device Type +## Creating a Device Type Before we start sending and ingesting data you have to configure your Biotz account to be able to know **who** is sending data and **how** to process it. The first step is to create a Device Type, which will allow you to categorise your devices. Assuming you have signed in into the application, from the sidebar, in the **Setup** section, click on **Device Type**. @@ -42,7 +37,6 @@ Leave the **Internal name** unchanged and click on **Save**. If there is nothing ![Confirm](/img/Created.png) -Now that you have created a Device Type, the next step is to create a Message Type . +Now that you have created a Device Type, the next step is to create a Message Type .