diff --git a/report/images/add_customer.png b/report/images/add_customer.png new file mode 100644 index 0000000..3f02a15 Binary files /dev/null and b/report/images/add_customer.png differ diff --git a/report/images/add_dashboard.png b/report/images/add_dashboard.png new file mode 100644 index 0000000..1b46edf Binary files /dev/null and b/report/images/add_dashboard.png differ diff --git a/report/images/add_device_1.png b/report/images/add_device_1.png new file mode 100644 index 0000000..0cd38c3 Binary files /dev/null and b/report/images/add_device_1.png differ diff --git a/report/images/add_device_2.png b/report/images/add_device_2.png new file mode 100644 index 0000000..21626b5 Binary files /dev/null and b/report/images/add_device_2.png differ diff --git a/report/images/add_user.png b/report/images/add_user.png new file mode 100644 index 0000000..7649596 Binary files /dev/null and b/report/images/add_user.png differ diff --git a/report/images/customer_list.png b/report/images/customer_list.png new file mode 100644 index 0000000..040c45a Binary files /dev/null and b/report/images/customer_list.png differ diff --git a/report/report.md b/report/report.md index 92df014..7c7c87d 100644 --- a/report/report.md +++ b/report/report.md @@ -1,5 +1,7 @@ # ThingsBoard Assessment +Team 8 + Jarne Clauw Tibo De Peuter Mathis De Witte @@ -8,21 +10,21 @@ Mathis De Witte Idk small introduction text -## ThingsBoard +## ThingsBoard installation Setup of ThingsBoard... -## Injecting data +## Using ThingsBoard -We will now demonstrate how to use ThingsBoard by injecting telemetry data. First we will create a tenant, which will be the the university of Ghent. The tenant can then add customers, which will be us, the students. The customer will have a device, from which we send data to the platform. +We will now demonstrate how to use ThingsBoard by injecting telemetry data. First we will create a tenant. This tenant can then add customers, and add users, assets, devices, dashboards and edges to each customer. -### Tenant +### Setting up a tenant In this section we will set up a new tenant. When browsing to `http://localhost:8080` we land on the login page. We log in with the following credentials, the email is `sysadmin@thingsboard.org` with password `sysadmin`. Once we successfully logged in, we land on the home page. ![[sysadmin_home.png]] -To add a tenant we can navigate to the `tenants` page by using the hamburger icon and clicking the `+` icon, or click on the `Add tenant` button on the home page. +To add a tenant we can navigate to the `tenants` page by using sidebar and clicking the `+` icon, or click on the `Add tenant` button on the home page. ![[images/add_tenant.png]] @@ -40,8 +42,45 @@ If everything was successful, you are now redirected to the home page, logged in This concludes this section where we created a tenant. In the next section we will add a customer for this tenant. -### Customer +### Setting up a customer +In this section we will add a customer to the tenant and also create a dashboard and add a device for this customer so we can inject data in the next section. We assume you are logged in as the tenant administrator. We can navigate to `customers` and click the `+` icon to create a new customer. + +![[images/add_customer.png]] + +The list of customer should be updated. + +![[images/customer_list.png]] + +What we will do now is add a user, so we can log in as that customer and create a dashboard for the customer. We will start with adding the user, click on `Manage customer users`. + +![[images/add_user.png]] + +This automatically redirects us to the new user account, but stay logged in as the tenant administrator. Now we can add a new dashboard to the customer by navigating to `Dashboards` and click `Add dashboard`. + +![[images/add_dashboard.png]] + +This creates an empty dashboard, which we will fill in the next section. Don't forget to save when leaving the page! The only thing left to do is to add a device to our customer. Navigate to `Entities/Devices` and click `Add device`. + +![[images/add_device_1.png]] + +![[images/add_device_2.png]] + +The second screen shows how to make a connection. For example, this is how you send data to the platform as the newly created device. + +``` +curl -v -X POST http://localhost:8080/api/v1/qTbjXOHQTgRYzjbn3UxF/telemetry --header Content-Type:application/json --data "{temperature:25}" +``` + +The header is made up in the following way. + +``` +http:///api/v1//telemetry +``` + +And simply sends JSON data. Now that everything is created, and we briefly saw how to send data from the device, we can go to the next section to inject the telemetry data and make this visible on the dashboard. + +### Injecting telemetry data ## Discussion