diff --git a/report/report.md b/report/report.md index dbe8e80..32f62ea 100644 --- a/report/report.md +++ b/report/report.md @@ -27,24 +27,24 @@ Start by navigating to `http://localhost:8080`, where you will land on the login - **Password**: `sysadmin` Once logged in, you will be redirected to the home page. -![[images/sysadmin_home.png]] +![Sysadmin home page.](images/sysadmin_home.png) To create a new tenant, go the the **Tenants** page from the sidebar and click the **+** icon , or click **Add Tenant** button directly from the home page. -![[images/create_tenant.png]] +![Creating a tenant.](images/create_tenant.png) Fill in the required information for the tenant and click **Add**. The tenant will appear in the tenant list. -![[images/tenant_list.png]] +![List of tenants.](images/tenant_list.png) To enable login for the tenant, you need to create an admin user. Click on the three dots next to the tenant name and select **Manage Tenant Admins**. Fill in the user details and click **Add**. Activate the account via email if needed. -![[images/create_tenant_admin.png]] +![Creating a tenant admin.](images/create_tenant_admin.png) If successful, you will be redirected back to the home page, but now logged in as the tenant's sysadmin. -![[images/tenant_home.png]] +![Tenant home page.](images/tenant_home.png) Now that the tenant is set up, we can proceed to add a customer in the next section. @@ -54,23 +54,23 @@ A customer represents an organization or group that will have access to specific In the **Customers** section, click the **+** icon to create a new customer. -![[images/create_customer.png]] +![Creating a customer.](images/create_customer.png) Once created, the customer will appear in the customer list. -![[images/customer_list.png]] +![List of customers.](images/customer_list.png) To create a dashboard for the customer, navigate to the **Dashboards** section and click **Add Dashboard**. This will create an empty dashboard. Always make sure to save the dashboard before leaving the page. -![[images/create_dashboard.png]] +![Creating a dashboard.](images/create_dashboard.png) To inject data into the dashboard, we need to add a device from which the data will come. Navigate to **Entities > Devices** and click **Add Device**. Fill in the required information for the device and assign it to the customer created earlier. After adding the device, you get a screen showing the instructions on how to send telemetry data to the platform. -![[create_device_1.png]] +![Adding a device.](create_device_1.png) -![[images/create_device_2.png]] +![Device credentials instructions.](images/create_device_2.png) For HTTP it essentially comes down to the following. @@ -80,13 +80,13 @@ curl http:///api/v1//telemetry --header Content-Type:applica When you try this out, you should see that the device is active and telemetry data has been received. -![[images/device_active.png]] +![An active device.](images/device_active.png) The last thing we need to do as a tenant, is to create a regular user account. Navigate to **Customers** and click on **Manage customer users**. Click on the **+** icon to add a new user and fill in the required information. -![[images/create_user.png]] +![Creating a user](images/create_user.png) After activating the account, you will be redirect to the home page of this user account. This user can not change any settings to the dashboard, devices ... as this is a read-only account. You could give the user the right privileges through role-based permissions, but this requires the Professional Edition of ThingsBoard! @@ -101,7 +101,7 @@ Navigate to **Dashboards** and select the dashboard associated with the customer - Changed the series to read from MB but convert to GB - Changed the Y axes to better display the memory used. -![[images/dashboard_widget.png]] +![Creating a widget on the dashboard.](images/dashboard_widget.png) To make this dashboard a live display of the memory used, we need to keep sending telemetry data. This is why we made a small script to do this, and made it as a docker service. @@ -117,7 +117,7 @@ This should send the used memory to the platform every second. The following is how the dashboard looks from the user account. -![[dashboard_customer.png]] +![Dashboard from the perspective of the user.](dashboard_customer.png) A lot more can be done, but then we suggest to read the [documentation](https://thingsboard.io/docs/).