Krucial CONNECT Application

The Krucial CONNECT website application makes managing your K-Cell and LoRaWan devices straightforward. This guide will walk you through using the site and setting up your first Krucial CONNECT deployment.

Deployment

After logging in to the Krucial CONNECT platform, the first tab on the navigation menu will be Deployment. Here, you can see all your active deployments for your organization and make edits or deletions as needed.

Creating a Deployment

Creating a deployment will be the first step to setting up your Krucial CONNECT site. Click on the red button labelled Add Deployment, as shown in the image below:

A window will appear for you to enter the name of your gateway and select a K-Cell to attach to it. To add a K-Cell to the gateway, click the down arrow to reveal K-Cells that are assigned to your organisation. They are listed by serial number.

Select which K-Cell you wish to act as your gateway and press Save. There is an additional option at the bottom to store your data on Krucial Servers - if you wish to, just select the checkbox.

After saving the deployment, you should receive a notification at the top of your page that says "Deployment created" and see your newly created deployment listed below.

Viewing a Deployment

For each deployment, you have the ability to view their assigned K-Cell, devices, and plugins. To view your K-Cell/Gaateway information, select Manage K-Cell inside the K-Cell square.

There are five tabs you can view - Status, Housekeeping, Queue, Configuration, and Operations.

• Status will display the most recent updates from your K-Cell, such as it's charging status and the last time it sent a transmission.

• Housekeeping allows you to view your K-Cell's battery voltage and charging status over time - you can filter the results by date in order to narrow down your search.

• Queue shows actions that have been requested from your gateway, for example, enabling the WiFi on your K-Cell.

• Configuration allows you to edit the Wi-Fi, message timings, and message requests to and from your K-Cell. Before enabling the Wi-Fi option on the K-Cell, you must set the SSID and a password by selecting the Set button under Wi-Fi, as shown below:

• Operations allows you to replace your current K-Cell with another in the circumstance that you would require a different K-Cell to act as your gateway. It allows your devices to eventually change over to a new K-Cell without having to manually do it yourself.

Devices

The second tab on the navigation menu is labelled Devices. Here, you can view all of your devices that have been added to your organisation. You can see their unique IDs (DevEUI), the name assigned to the device (Device Name), and the ability to edit or delete them under Operations.

Adding a Device

In order to add a device, you can either use the Krucial CONNECT CLI commands (instructions on how to set this up can be found here) or use Manage Devices under the Deployment tab.

To add them on the Krucial CONNECT application, navigate to Deployment on the menu and select Manage Devices under the Devices box. Here, you can view all devices that are attached to the given deployment and data packets that are sent from them.

To add your device, select the Add Device to Deployment button located here:

A form window will show up, prompting you to enter the Device name, DevEUI (ID of your chosen device), and Device Profile. After entering these fields, an additional one will show up asking for an Application Key. This is the unique "password" that protects different devices.

The form should show like the following:

Optionally, you can add a latitude and longitude to account for your device location as well as tags to help filter your devices.

After filling out the form, please press Save at the bottom of the window. Your screen should now list your newly created device and notify you at the top that your Device has been created and successfully added to your deployment.

Deleting a Device

To remove a device from your deployment, simply press the bin button located next to the Device name under Operations as shown below:

A confirmation window will show up to ensure this is the device you want to delete. To continue, press Delete.

A notification will appear at the top of your screen saying the device has been removed from the deployment and deleted from your organisation. The device will no longer appear in your Deployment devices list.

Webhooks

The third tab on the navigation menu is labelled Webhooks. Here, you can add, delete, and view webhooks on your organisation. A webhook can send automated messages from one application to another in real-time.

If you chose to store data on Krucial servers when setting up your deployment initially, there will already be a webhook showing that the data has been stored internally.

Creating a Webhook

To create a webhook, press the Add Url button located at the top right of your screen in the Webhook tab:

A form window will open asking you to enter a Webhook name for identification, select a deployment to attach it to, and enter the destination Url of your webhook. You will also have the option to select if the webhook will use hmacAuth. This is a method of encoding your data for extra security.

After filling out the form, press Save to confirm your new Webhook. You should be able to see a notification at the top of your page confirming that the new webhook has been successfully added, as well as seeing it listed underneath.

If you want to view more details of a given Webhook, simply click on the name of a specified webhook or the button under the Operations column to view any data or responses sent from it.

Deleting a Webhook

To delete your webhook, click on the icon under the Operations column. A confirmation window will apear - press Delete to confirm the removal of your webhook.

Device Profiles

The fourth tab on the navigation menu is labelled Device Profiles. Here, you can edit, add and delete Gateways (also known as K-Cells) on your deployments or organisation.

A Device Profile allows you to configure the way a device sends data.

You will see two existing Device profiles - Krucial OTAA Default and Krucial ABP Default. These are the two different activation methods for LoRaWan devices.

Adding a Device Profile

To add a new device profile, click the Add Device Profile button in the top right of the window.

A form window will appear, giving you two different methods to create a device profile:

• Upload a file - with this method, you can use an existing file to quickly create a device profile. The form should prompt you to enter an easily identifiable Device Profile Name, a Device Profile, and a Device Profile Codec as shown below:

Press Save to confirm your changes. You should receive a notification at the top of your page that confirms the newly created device profile and see it listed below.

• Manual entry - with this method, you can manually set the new device profile from the website application. You will be prompted to enter several mandatory fields to fit to your needs, as shown below:

After filling in the fields, press Save by scrolling to the bottom of the window. You should then receive a notification at the top of the page that your Device Profile has been created and see it listed below.

Editing a Device Profile

To edit a device profile, select the button under the Operations column in the Device Profiles tab. You will have the option to view the existing details attached to the profile under the Details tab, or edit them under the Edit tab.

To confirm an edit, press Save Changes, located at the bottom of the page.

Deleting a Device Profile

There are two options when deleting a device profile:

• Deleting Device Profile from a Gateway - this option only removes the device profile from a K-Cell/gateway it was initially set up as attached to. This can be done by pressing the button under Operations.

A form window will come up which will prompt you to select a K-Cell from the dropdown menu to remove the profile from. After choosing your designated K-Cell serial number, press Delete. A notification should show that the device profile has been successfully removed from the gateway at the top of your screen.

• Deleting Device Profile from your Organisation - this option completely removes a device profile from your organisation, so it is permanently deleted. This can be done by pressing the button under Operations. This action can only be completed if it has been removed from any gateway it was previously attached to, so please refer to the option above first.

After pressing the icon, click Delete to confirm your choice. You should receive a notification at the top of the screen showing the Device Profile as deleted. You should no longer be able to see that Device Profile as an option underneath.

API Keys

The fifth tab on the navigation menu is labelled API Keys. Here, you can create and delete different API keys to control who and what can access the API (Application Programming Interface). This is where you can access your CLient ID and Client Secret for setting up your Connect CLI environment.

Add Key

To create a new API key, press the Add Key button located on the top right of the page under the API Keys tab, as shown below:

A form window will appear, prompting you to enter an easily identifiable name for your new API Key. Ensure there are no spaces in the name, like the following:

Press Save to confirm the creation of your new API Key. You should receive a notification at the top of your screen that shows the API Key as created and see it listed below.

Delete Key

To delete an API Key, simply press the button under Operations. Press Delete to confirm your choice.

Please note that if the client ID and client secret were used to set up your Connect CLI environment, it will stop working and you will have to set it up again with a different API key.

Plugins

The last tab on the navigation menu is labelled Plugins. Here, you can add, delete, or edit various plugins that you decide to add to your deployments. Plugins are additional features or functions to add on to a software application.

Add a Plugin

To add a plugin, press the Add Plugin button located on the top right of your page under the Plugins tab, as shown here:

You will be asked to enter an easily identifiable name, the plugin's type, and the authentication type. Currently the only supported Plugin type is the iTwin IoT Platform. Please refer here to learn about setting up the Bentley iTwin plugin for your organisation.

Delete a Plugin

To delete a plugin from your organisation, press the button under Operations in the Plugins tab. To confirm the action, press Delete. You should receive a notification at the top of the page showing the Plugin as deleted and no longer see the plugin listed below.