Skip to content

Commit

Permalink
Add all the sidebar labels and titles.
Browse files Browse the repository at this point in the history
  • Loading branch information
aitormurgu committed Mar 7, 2024
1 parent fad239a commit a6afe19
Show file tree
Hide file tree
Showing 24 changed files with 11,553 additions and 2,520 deletions.
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
sidebar_position: 5
sidebar_label: How to configure and trigger a remote action in devices
---

## Introduction
# Configure and trigger a 'remote actioning'

Biotz offers the feature to action devices remotely, this is offered just through MQTT. The configuration of this features include 3 steps:

<br></br>

## Step 1 - Setup the 'Remote actioning' in Biotz platform.

Expand Down
3 changes: 3 additions & 0 deletions docs/How-to guides/How to create a dashboard.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 6
sidebar_label: How to create a dashboard
---
# How to create a dashboard

## Introduction

Biotz provides a dashboarding tool that can be used to visualize the data coming from the devices.
Expand Down
4 changes: 4 additions & 0 deletions docs/How-to guides/How to create a schema.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
---
sidebar_position: 3
sidebar_label: How to create a schema - setup apllication to ingest certain data
---

# How to create a schema

## Introduction

When data arrives into Biotz's ingestion system, the received package of data is checked against schemas defined in Biotz. These schemas are the definition of the content of the data package and the user must take care of defining them in the system.
Expand Down
3 changes: 3 additions & 0 deletions docs/How-to guides/How to create developer API credentials.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 10
sidebar_label: How to create Developer API credentials
---
# Developer API

## Introduction

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.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 11
sidebar_label: How to debug communication coming from devices into the application
---
# How to debug communications coming from a device into the platform.

## Introduction
The communication debugger has as objective to help debug possible errors or problems related to the communication coming from the devices into Biotz Platform.

Expand Down
3 changes: 3 additions & 0 deletions docs/How-to guides/How to define alarm and triggers.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 8
sidebar_label: How to define alarm triggers
---
# How to define alarm triggers

## Introduction

Biotz provides alarm generation and notification capabilities based on the data received in the data ingestion flows. The alarm trigger or rules are evaluated against each received data observation, and when an alarm is triggered the corresponding users are notified.
Expand Down
3 changes: 3 additions & 0 deletions docs/How-to guides/How to invite users.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 1
sidebar_label: How to invite users
---

# How to invite users
## Introduction

Organization administrators can invite new users to their organization.
Expand Down
3 changes: 2 additions & 1 deletion docs/How-to guides/How to publish device data.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
sidebar_position: 4
sidebar_label: How to publish device data using MQTT - setup devices to send data
---

# Publishing Device data
## Introduction
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:

Expand Down
3 changes: 3 additions & 0 deletions docs/How-to guides/How to register devices.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 2
sidebar_label: How to register devices
---
# How to register devices

## Introduction

Biotz offers two ways for registering physical devices of a certain device type. This is used by Biotz to generate internal machinery for specific devices. But also as a way to have data of the collection of devices gathered together.
Expand Down
2 changes: 2 additions & 0 deletions docs/How-to guides/How to update device firmware.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
---
sidebar_position: 9
sidebar_label: How to update device firmware
---
# Update device firmware

## Introduction
Biotz offers a remote firmware update service. The user will upload the new firmware file to the Biotz IoT platform where it will be registered and stored. From that point on the user will be able to assign any firmware file to existing devices.
Expand Down
3 changes: 3 additions & 0 deletions docs/How-to guides/How to use dashboard variables.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
---
sidebar_position: 7
sidebar_label: How to use dashboard variables
---
# How to use dashboard variables

## Introduction

Dashboard variables allow users to make dashboard panels more dynamic. Instead of hardcoding specific devices in the panels, device selectors can be added to the dashboard. Those selectors are displayed in the main dashboard view, and the selected value can be changed by the final users at any time. Changing the value updates the data for all the panels that are using that variable.
Expand Down
3 changes: 3 additions & 0 deletions docs/Reference guides/Developer API.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
---
sidebar_position: 4
---

# Developer API

Expand Down
5 changes: 5 additions & 0 deletions docs/Reference guides/Glossary.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_position: 2
sidebar_label: Glossary
---
# Glossary
**Device type**: Biotz allows managing multiple different devices from the same account. “Types” are a way of grouping those devices.

**Device**: a device in Biotz corresponds to a single device in the physical world. There should be a one to one mapping between the IOT devices and the devices registered in Biotz.
Expand Down
6 changes: 6 additions & 0 deletions docs/Reference guides/MQTT broker.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
sidebar_position: 1
sidebar_label: MQTT Broker
---
# MQTT Broker Reference

## Connection details
- Host: mqtts://broker.biotz.io
- Port: 8883
Expand Down
6 changes: 6 additions & 0 deletions docs/Reference guides/Message-type Schema specification.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
sidebar_position: 3
sidebar_label: Message-type Schema specification
---
# Message-type Schema specification

his is the specification for the schema of a message-type. The users will have to specify a device-type, with one to many message-type. Each message-type will have one to many schemas.

This schema is the structure of the data that the device will be sending in each communication with Biotz. The definition provided in the schema creation in the web application is the one used to validate the incoming data. Also, this will be used to structure the specific database schema for the data to be stored in a structured way.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@

## Creating a Device Type
---
sidebar_position: 1
sidebar_label: Step 1 - 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
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
sidebar_position: 2
sidebar_label: Step 2 - Creating a Message Type
---
# Creating a Message Type
As the name implies this is a type of message your device can send. If your device outputs different information structures, each of them would be a different Message Type. In this tutorial, you will create a single Message Type for the sake of simplicity. To do so, from the sidebar, in the **Setup** section, click on **Data Ingestion Flow**. You will be presented with the following page:

<div class="tutorial-image-container">
Expand Down
7 changes: 5 additions & 2 deletions docs/Tutorials/Getting started/Step 3 - Creating a Schema.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@

---

sidebar_position: 3
sidebar_label: Step 3 - Creating a Schema
---

# Creating a Schema

Now that you have created a Message Type, you have to define the shape of the data for that Message Type. This is what is called Schemas in Biotz. Schemas are just the definition of the structure of what your device will send to the platform. This helps Biotz ingest and process your data effectively.


Expand Down
6 changes: 6 additions & 0 deletions docs/Tutorials/Getting started/Step 4 - Creating a device.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
sidebar_position: 4
sidebar_label: Step 4 - Creating a device
---
# Creating a device

Before sending any data you need to register a device. To do so, from the sidebar, in the **Device Management** section, click on **Devices**. This will show up a list of devices. In the top right corner you click on **New device**. You will see the following form:

<div class="tutorial-image-container">
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,11 @@
---
sidebar_position: 5
sidebar_label: Step 5 - Authenticating a device
---

# Authenticating a device


In this tutorial, as said in the beginning, the data sending will be simulated. To do so, you will make an HTTP request to the **http-forwarder** service of Biotz which will, as the name implies, forward your data ingestion request to the competent services. That is the reason why you chose the **HTTP communication protocol** before when creating a message type.


Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
---
sidebar_position: 6
sidebar_label: Step 6 - Sending a data ingestion request
---

# Sending a data ingestion request

Now that you have a token from Biotz Identity Provider, it is time to send actual data to Biotz. In this tutorial, as said before, you will simulate a device sending data using the terminal. The approach is basically the same as to retrieve a token, just an HTTP request to the **http-forwarder** service. It will take your request and re-route it into a queue to be processed when the system is available.
<br></br>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
---
sidebar_position: 7
sidebar_label: Step 7 - Displaying the data
---

# Displaying the data

In order to display the data you will need to create a dashboard and a panel. A dashboard is a collection of panels. Each panel contains a specific query to display your data. You can also apply different customizations to the panel's appearance. However, the focus of this tutorial is to just display your newly ingested data. Bear in mind that the data you will display is a single point, if you have followed this tutorial. Displaying a single point is not very useful but the end goal is to learn how it works. So, later on when you create your real dashboard panels you have a good foundation to do so.

<br></br>
Expand Down
Loading

0 comments on commit a6afe19

Please sign in to comment.