Skip to content

Commit

Permalink
Correcting all the links and adding some that were missing.
Browse files Browse the repository at this point in the history
  • Loading branch information
aitormurgu committed Mar 4, 2024
1 parent df60ed9 commit 9b9be7b
Show file tree
Hide file tree
Showing 7 changed files with 116 additions and 21 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="/academy/docs/Reference guides/MQTT broker" target="_self">link</a>.

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:

Expand Down
107 changes: 104 additions & 3 deletions docs/How-to guides/How to create a dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ Dashboards are created from the “Dashboards” list. Just a name and an option
<div class="tutorial-image-container">
![Dashboards](/img/Dashboards.png)
</div>
![Dashboards](/img/Dashboards.png)

When clicking on “create” an empty dashboard is created.

<div class="tutorial-image-container">
![Empty dashboard](/img/EmptyDashboard.png)
</div>

## Creating panels

Expand All @@ -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.

<div class="tutorial-image-container">
![creating panels](/img/creating-panels.png)
</div>

### General information

Name the panel and optionally set a description.
Expand All @@ -43,7 +47,7 @@ The query builder is used to define which data will the panel display. The x-ax
<br></br>
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 <a href="./How to use dashboard variables" target="_self">this</a> 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.

Expand All @@ -59,8 +63,105 @@ The reason for aggregating the data is performance. Lets say a certain device is

###### Appearance

<div class="tutorial-image-container">
![appearance](/img/appearance.png)
</div>

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 <a href="./How to use dashboard variables" target="_self">this</a> 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 <a href="./How to use dashboard variables" target="_self">this</a> 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 <a href="./How to use dashboard variables" target="_self">this</a> 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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
To create applications that consume our data we have a Developer API, following <a href="./Step 2 - Creating a Message Type" target="_self">this link</a> 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 <a href="/academy/docs/Tutorials/Step 2 - Creating a Message Type" target="_self">this link</a> you will be able to consult more information about the endpoints in our documentation.

## Credentials creation

Expand Down
6 changes: 3 additions & 3 deletions docs/How-to guides/How to publish device data.md
Original file line number Diff line number Diff line change
@@ -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 <a href="./Creating a Biotz account" target="_self">registered</a> in Biotz.
- <a href="./Step 1 - Creating a Device Type" target="_self">Device-Type</a>, <a href="./Step 2 - Creating a Message Type" target="_self">message-type</a> and the schema of data <a href="http://localhost:3000/academy/docs/Tutorials/Step%203%20-%20Creating%20a%20Schema/" target="_self">schema of data</a> to be sent must be registered in Biotz.
- <a href="http://localhost:3000/academy/docs/Tutorials/Step%204%20-%20Creating%20%20a%20device/" target="_self">Specific</a> device must be registered.
- <a href="/academy/docs/Tutorials/Step 1 - Creating a Device Type" target="_self">Device-Type</a>, <a href="/academy/docs/Tutorials/Step 2 - Creating a Message Type" target="_self">message-type</a> and the schema of data <a href="/academy/docs/Tutorials/Step 3 - Creating a Schema" target="_self">schema of data</a> to be sent must be registered in Biotz.
- <a href="/academy/docs/Tutorials/Step 4 - Creating a device" target="_self">Specific</a> device must be registered.

Find specific MQTT broker information following this <a href="./MQTT broker" target="_self">link</a>.
Find specific MQTT broker information following this <a href="/academy/docs/Reference guides/MQTT broker" target="_self">link</a>.

This is the generic MQTT topic builds:

Expand Down
2 changes: 1 addition & 1 deletion docs/Reference guides/Developer API.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="https://api.biotz.io/docs/ui/index.html#/" target="_self">here</a>. If you want to know how to authorize correctly before consuming the API go <a href="./How to create developer API credentials" target="_self">here</a>.
The API documentation with every available endpoint is <a href="https://api.biotz.io/docs/ui/index.html#/" target="_self">here</a>. If you want to know how to authorize correctly before consuming the API go <a href="/academy/docs/How-to guides/How to create developer API credentials" target="_self">here</a>.

In order to connect correctly you'll need this data:

Expand Down
8 changes: 4 additions & 4 deletions docs/Reference guides/MQTT broker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="./Step 4 - Creating a device" target="_self">here</a>.
More information about device registration <a href="/academy/docs/Tutorials/Step 1 - Creating a Device Type" target="_self">here</a>.

## Topics

Expand All @@ -21,20 +21,20 @@ More information about device registration <a href="./Step 4 - Creating a devic
```
biotz/1/0/CUSTOMER-ID/DEVICE-ID/publish/data/MESSAGE-TYPE-INTERNAL-NAME
```
<a href="./How to publish device data" target="_self">More information</a>
<a href="/academy/docs/How-to guides/How to publish device data" target="_self">More information</a>
### Subscribe

#### Remote actioning:‍

```
biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/action/ACTION-MESSAGE-TYPE-INTERNAL-NAME
```
<a href="./How to configure and trigger a remote action in devices" target="_self">More information</a>
<a href="/academy/docs/How-to guides/How to configure and trigger a remote action in devices" target="_self">More information</a>

### Firmware updates:

```
biotz/1/0/CUSTOMER-ID/DEVICE-ID/subscribe/firmware/update
```
<a href="./How to update device firmware" target="_self">More information</a>
<a href="/academy/docs/How-to guides/How to update device firmware" target="_self">More information</a>

10 changes: 2 additions & 8 deletions docs/Tutorials/Step 1 - Creating a Device Type.md
Original file line number Diff line number Diff line change
@@ -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**.

Expand Down Expand Up @@ -42,7 +37,6 @@ Leave the **Internal name** unchanged and click on **Save**. If there is nothing
![Confirm](/img/Created.png)
</div>

Now that you have created a Device Type, the next step is to <a href="./Creating a Device Type
" target="_self">create a Message Type </a>.
Now that you have created a Device Type, the next step is to <a href="./Step 2 - Creating a Message Type" target="_self">create a Message Type </a>.


0 comments on commit 9b9be7b

Please sign in to comment.