Gravio HubKit Manual

Gravio Device Manual

Table of Contents

1. Introduction

Gravio is a system for efficiently collecting and managing data from various types of sensors. This manual explains the basic procedures for collecting sensor data using Gravio.

2. Overall Flow of Sensor Data Collection

The overall process for collecting sensor data in Gravio is as follows:

  1. Physical Device Connection and Pairing - Physically connect sensor devices to HubKit and perform pairing as needed
  2. Logical Data Structure Setup - Define areas (physical locations) and layers (sensor types)
  3. Sensor Addition - Associate physical devices with the created layers
  4. Data Collection Start - Enable settings to begin data reception

3. Device Setup

3.1 Zigbee Devices

Required Hardware

To use Zigbee-compatible devices, you need to connect a Zigbee USB receiver to your PC.

Zigbee USB Receiver

If the Zigbee USB receiver is not recognized on Windows or Mac, you need to install drivers from the Silicon Lab website: - For Windows: Download and install "CP210x Windows Drivers" - For Mac: Download and install "CP210x VCP Mac OSX Driver"

Zigbee Device Addition Procedure

  1. In the "Device" tab, select the type of Zigbee sensor (DataKind) to add a new area and layer.

Layer Selection Dialog

  1. To receive sensor data from Zigbee-compatible devices, you first need to pair the sensor with the sensor receiver. Press the following button to display the sensor receiver settings screen connected to the serial port.

Device Tab Button

  1. The device list screen will be displayed. Verify that the Zigbee USB receiver is properly connected.

Device List Screen

Zigbee Device Pairing

  1. Press the "Pairing" button to put the receiver in pairing wait state. (Pairing mode lasts for 1 minute.)

Pairing Mode Screen

  1. When you press and hold the button on the sensor side for about 5 seconds during pairing mode, the sensor will be paired and displayed as follows.

Paired Device

Data Reception Activation

If "Automatically set if there are available layers during pairing" is enabled, and there is a layer configured for the paired device type, the device will be automatically registered to that layer and the settings will be activated.

3.2 EnOcean Devices

EnOcean Required Hardware

Connect the EnOcean dedicated USB receiver to your PC.

EnOcean Device Addition Procedure

  1. Open the sensor receiver settings screen

Sensor Receiver Settings Button

  1. Press the button on the EnOcean-compatible device After a while, the sensor will appear in the serial port

EnOcean Device Settings Screen

3.3 Bluetooth Devices

Bluetooth Required Hardware

Use the PC's built-in Bluetooth function or a Bluetooth USB receiver.

Bluetooth Device Addition Procedure

  1. Open the sensor receiver settings screen

Sensor Receiver Settings Button

  1. Click the right arrow on the Bluetooth line and press the scan button

Scan Mode

  1. Sensors will be displayed when discovered during scan mode

Scan Complete

  1. The detected device (in this example, Omron 2JCIE-BU01-sensor-1) is displayed

Device Setup Complete

3.4 Barcode Readers

Gravio can use barcode readers (barcode readers with USB COM port emulation capability) as a layer for data input. Here, we explain the setup procedure for barcode readers using the BUSICOM BC-NL2200U as an example.

Prerequisites

The barcode reader must be configured for USB COM port emulation functionality. Models such as BUSICOM's BC-NL1100U, BC-NL1100U II, BC-NL2200U, BC-NL2200U II, BC-NL3000U, and BC-NL3000U III can switch between USB HID-KBW functionality and USB COM port emulation functionality. When using with Gravio, make sure to set it to USB COM port emulation functionality.

Barcode Reader Connection Verification

  1. For Windows, you can verify the barcode reader connection in Device Manager

Device Manager Screen

  1. Verify that "USB Serial Device (COMx)" (e.g., COM5) appears under Ports (COM & LPT)

Barcode Reader Addition Procedure

  1. Adding Area and Layer
  2. In "Device", select Barcode (DataKind) to add a new area and layer

Layer Addition Screen

  1. Barcode Reader Setup
  2. Connect the barcode reader to the USB port
  3. Click the circled "+" mark in the top right of the screen

Screen After Adding Barcode Reader

  1. Device List Verification
  2. The device list will be displayed
  3. Verify that BUSICOM BC-NL2200U is displayed

Device List Screen

Note: If BUSICOM BC-NL2200U is not displayed, verify that the barcode reader is properly connected to the USB port and configured for USB COM port emulation functionality, then restart HubKit.

  1. Device and Layer Association
  2. Click the circled "+" mark in the top right of the window
  3. Select the barcode reader you want to connect to the layer

Physical Device Binding Screen

  1. Barcode Reader Activation
  2. After setup is complete, turn the switch ON to begin data reception

Barcode Reader Activation Screen

Notes

3.5 GPS Devices

In Gravio, GPS devices (GPS devices available via COM port connection) can be used as data input devices as a single layer.

Confirming GPS Device Connection

For Windows 10, confirm that COMx (in this case COM5) is displayed in the Device Manager to verify the GPS device connection.

GPS Device Addition Procedure

In this example, we explain how to get GPS data using a VKLSVAN VK172 G-MOUSE USB GPS device.

  1. In "Devices," select the GPS (DataKind) you want to use and add a new area and layer.

GPS Layer Addition

  1. To receive GPS data, connect the GPS device to a USB port, then press the following button to display the GPS device settings screen.

GPS Device Settings Button

  1. The device list screen appears. Confirm that GPS Generic Type is displayed.

GPS Device List

Note: If GPS Generic Type is not displayed, check that the GPS device is correctly connected to the USB port and restart HubKit.

If GPS Generic Type is displayed, you're done. Close the dialog.

  1. Next, click the circled "+" mark at the top right of the window.

Device Addition Button

  1. Select and configure the GPS device you want to connect to the layer.

GPS Device Binding

When you've finished configuring, close this screen.

  1. You will see a screen like the one below. Finally, turn ON the switch to receive data from this GPS device.

GPS Device Activation

GPS data reception will start automatically from the GPS device.

GPS Data Format

The data that can be received from the GPS set in the layer is as follows. You can check it in the Data Viewer.

Data Description
Course Device moving direction (value from 0 degrees north clockwise to 359.9 degrees) -1 if direction is invalid
SpeedKm Device moving speed (km/h)
SpeedKn Device moving speed (knots)
LatitudeDeg Latitude (DEG format)
LongitudeDeg Longitude (DEG format)
Latitude Latitude (DMM format)
Longitude Longitude (DMM format)
LatitudeDir Latitude direction (N or S)
LongitudeDir Longitude direction (E or W)

Terminology: - DEG format: Data format ddd.ddd, where ddd.ddd is expressed in degrees with decimal point. This is the notation used in Google Maps. - DMM format: Data format dddmm.mmmm, where ddd is degrees and mm.mmmm is minutes in sexagesimal system, so 60 minutes equals 1 degree. The ddd.dddd degree notation used in Google Maps can be calculated as (degrees + minutes/60).

4. Data Structure Setup

After completing physical device connection, set up the logical data structure in Gravio.

4.1 Creating Areas

Areas represent the physical locations where devices are installed.

  1. Click the "+" mark in the top right of the Device tab to create a new area
  2. Name the area (e.g., "3rd Floor West", "Seminar Room", "Entrance Area", etc.)
  3. Adding photos can help with identification

4.2 Adding Layers

After creating an area, add layers within that area.

  1. Click "+" within the area to add a layer
  2. Give the layer a meaningful name (e.g., "Temperature Sensor Layer", "Motion Sensor Layer", etc.)
  3. Select the type of data (DataKind) to be collected in this layer

4.3 Adding Sensors

Add the physically connected and paired sensor devices to the created layers.

  1. Click the "+" mark in the top right of the sensor receiver settings screen
  2. Select and configure the sensor you want to connect to the layer
  3. Close the settings screen after configuration is complete

5. Starting and Verifying Data Collection

After sensor setup is complete, begin data reception.

  1. Turn ON the sensor receiver switch
  2. This will automatically begin data reception from the sensors
  3. For Zigbee, you can connect up to 64 devices with one dongle
  4. Use the data viewer to verify received data

6. Troubleshooting

If devices are not properly recognized:

If sensor data cannot be collected:

7. Appendix

7.1 HubKit Data Directory

When Hub is installed, it creates a data directory for saving configuration files and data.

When Installed on Windows 10

C:\ProgramData\HubKit

When Installed on macOS

/Library/Application Support/HubKit/

When Installed on Linux/Raspberry

Since it runs in Docker on Linux/Raspberry, the following directory is mounted as a volume:

/home/gravio/hubkitrepo4/data

7.2 Camera Image Storage Location

Images obtained from cameras via ONVIF etc. are saved in directories organized by camera device and date in the following directory:

Windows 10

C:\ProgramData\HubKit\mediadata

macOS

/Library/Application Support/HubKit/mediadata

Linux/Raspberry

Since it runs in Docker on Linux/Raspberry, when viewed from the Host side, the following directory is mounted as a volume:

/home/gravio/hubkitrepo4/data/mediadata

When viewed from inside Docker, the directory is:

/var/opt/hubkit/mediadata