Skip to main content
Version: DeepHub 2024 R1 - 2.5.0-beta.4

Kiosk UI

Overview

The Kiosk UI is the UI of choice for end users of the DeepHub that work with assets and need to quickly locate/find them.

The Kiosk UI does NOT allow users to create, edit, or delete any entities of the system. To achieve this, the Admin UI or the REST API of the DeepHub need to be used.

The user interface consists of only one component - a Live View that corresponds to the Live View of the Admin UI, but with some notable differences:

  • A map view that takes up the entirety of the UI, providing visibility to as many assets as possible.
  • Advanced search capabilities to allow for fast and effective retrieval of assets.

The Map

The map covers the whole view; there is intentionally no border, header, or footer. At the top right corner, there are overlays/widgets to increase/decrease the zoom level of the map, reset the bearing to North, locate your current device, etc.

interface

By clicking on a fence (blue area), a zone (green area), a trackable, or a location provider within the map, a window opens with information for all entities corresponding with the location that was clicked. In the example shown below, a zone and a fence were clicked at once:

information

Search Capabilities

The search field is at the top left corner of the UI. The blue DeepHub logo will change to red if the connection to the DeepHub was lost, or yellow if the connection is being re-established.

You can search for any known entity within the search field by using its id, name, or custom properties. The search happens immediately and incrementally. Whenever you start typing, the search begins based on the entered characters. When the search matches entities, the entities will be shown as a list below the search field. By clicking on a result, the map will pan and zoom directly to the corresponding entity.

If the results are insufficient, you can click on the magnifying glass symbol or press enter on your keyboard to get a detailed list of all search results right beneath the search field.

search field

Indirect Asset Tracking

Through two features, the Kiosk UI becomes a simple, elegant and cost-effective asset tracking solution. These two features include:

  • pairing the Kiosk UI with a tag (i.e. a location provider) to consume the tag's location and treat it as the Kiosk UI's location
  • barcode scanning from within the search field

The first feature is a setting that can easily be activated. Register a tag in the form of a location provider entity in the DeepHub. Then, switch to the "Locate Me" settings menu and choose that location provider as the "Locate Me" provider. Now, your Kiosk UI is ready to be used to supply location information to any trackable in the system.

search fieldsearch field

Scan a barcode or enter it manually in the search field of the Kiosk UI. If a trackable is found that matches the code, it will be shown. Hitting the "Update Location" button leads to that asset getting the current location information of the paired location provider. If no trackable is found for an entered code, hitting the "Update Location" button leads to the creation of a trackable AND an immediate setting of the current location.

search fieldsearch field

That's it: just update location information this way any time you move an asset!

Look-and-Feel Settings

The look-and-feel of the Kiosk UI can be configured through the "viewing options" dialog window. To open this window, navigate to the top right corner of the UI and click this button:

viewing options icon

Within the "viewing options" dialog, you can enable or disable the rendering of location providers, trackables, fences, and zones. If rendering is enabled, you can switch certain rendering details on or off:

Viewing Options

The "API" of the Kiosk UI

The Kiosk UI supports the same URL parameters as the Live View of the Admin UI. See the corresponding section in the documentation.