Gravio HubKit Installation and Upgrade Guide

This guide explains the installation and upgrade procedures for Gravio HubKit on each platform.

Table of Contents

1. Gravio System Overview
   • Network Ports Used by Gravio
2. Platform-Specific Installation Procedures
   • Windows Version
   • macOS Version
   • Linux Version
3. Upgrade Procedures
   • Windows Version
   • macOS Version
   • Linux Version (Ubuntu AMD64/ARM64)
   • Gravio Hub X64
4. Gravio Hub X64 Setup and Operation
   • Determining the Operation Method
   • Setup Procedure
   • Connection Method
   • Security Settings
   • Gravio Hub X64 Package Contents
5. New Installation and Setup Notes
6. Uninstallation Procedures
   • Linux Version (AMD64/ARM64) Uninstallation

1. Gravio System Overview

Gravio consists of two main components:

• Gravio HubKit: Server software package
• Gravio Studio: Client application (for operation)

Gravio HubKit is available on three platforms: Windows, macOS, and Linux. Gravio Studio can be installed from Microsoft Store on Windows and App Store on Mac.

Important: When installing Gravio HubKit on Windows, please install Gravio Studio from Microsoft Store first.

1.1 Network Ports Used by Gravio

Gravio’s HubKit server modules, Gravio Configuration Manager, and Coordinator use the following ports.

Inbound (Gravio 6.0 and later)

When using HubKit with Chrome cast, you need to open the port “Gravio App Service –HTTPS:29443” on the PC where HubKit is installed.

Outbound (Gravio 6.0 and later)

Proper configuration of these port settings enables normal communication in the Gravio system.

2. Platform-Specific Installation Procedures

2.1 Windows Version Installation Procedure

To perform a new installation of HubKit on Windows, follow these simple steps:

1. Download Gravio HubKit: Download the installer from https://www.gravio.com/jp/download
2. Run the downloaded installer: The installer will guide you through the entire setup process, so follow the on-screen instructions
3. Initial Setup: After installation is complete, perform initial setup in the Gravio Configuration Manager

This completes the Windows version HubKit installation.

2.2 macOS Version Installation Procedure

To perform a new installation of HubKit on macOS, follow these simple steps:

1. Download HubKit Mac version: Download from https://www.gravio.com/jp/download
2. Double-click the downloaded GravioHubKit.dmg file to open it
3. Drag and drop the Gravio HubKit icon to the Applications folder: Run the downloaded installer to copy HubKit
4. Double-click Gravio HubKit in the Applications folder to start it

This completes the macOS version HubKit installation.

2.3 Linux Version Installation Procedure

2.3.1 Installation Procedure for Gravio 6.0.x on Linux (Ubuntu ARM64/AMD64)

This is the procedure to install Gravio 6.0 on a fresh installation of Ubuntu 22.04LTS ARM64/AMD64.

Preparation

Copy the Gravio 6.0 deb file to the target environment using SFTP or similar tools beforehand, then log in via SSH.

Installation Procedure

1. OS Update

   sudo apt update
   sudo apt upgrade
   

2. Install Docker Environment

   sudo apt install docker.io docker-compose-v2
   

3. Install Gravio 6.0
   • For AMD64:

     sudo apt install ./setup_gravio_dockerimage_6.0.XXXX-1_amd64.deb
     

   • For ARM64:

     sudo apt install ./setup_gravio_dockerimage_6.0.XXXX-1_arm64.deb
     

     ※XXXX represents the version number

4. Installation Complete

   You may see an error message saying “N: Download is performed unsandboxed as root as file ‘/home/synon/setup_gravio_dockerimage_6.0.XXXX-1_arm64.deb’ couldn’t be accessed by user ‘_apt’. – pkgAcquire::Run (13: Permission denied)”, but you can ignore it as the installation is complete.

5. Restart

   After restarting the OS, you will be able to access the Configuration Manager.

3. Upgrade Procedures

3.1 Windows Version

Follow these steps to upgrade HubKit.

1. Back up C:\ProgramData\HubKit

   If ProgramData is a hidden folder, make it visible before backing up the HubKit data.

2. Uninstall HubKit

   Uninstall from Windows.

3. Download HubKit Windows version

   Download from https://www.gravio.com/jp/download

4. Install the downloaded Gravio HubKit

   Run the downloaded installer to install.

3.2 macOS Version

Follow these steps to upgrade HubKit.

1. Stop HubKit using the Gravio HubKit toolbar app shown in the toolbar

2. Quit the Gravio HubKit Toolbar app

   If HubKit is running, quit it first.

3. Back up /Library/Application\ Support/HubKit

   Back up the HubKit data.

4. Move Gravio HubKit4 in the Applications folder to the Trash

   Delete the HubKit you are using.

5. Download HubKit Mac version

   Download from https://www.gravio.com/jp/download

6. Double-click the downloaded GravioHubKit.dmg file to open it

7. Drag and drop the Gravio HubKit icon to the Applications folder

   Run the downloaded installer to copy HubKit.

8. Double-click Gravio HubKit in the Applications folder to start it

9. Click the “Gravio Initial Setup” menu from the Gravio HubKit toolbar app menu shown in the toolbar

3.3 Linux Version (Ubuntu AMD64/ARM64)

Procedure for upgrading from Gravio 5.x to Gravio 6 Follow these steps to upgrade HubKit.

1. Log in to Gravio Configuration Manager.

2. After logging in, press the backup button in the HubKit Backup section on the “Gravio Settings” tab screen to create a backup. After the backup file is created, the export button will become available. Press it to store the backup file on your local PC or other device.

3. Log in to Ubuntu with the “gravio” account in Terminal.

4. Copy the installer provided on the Gravio.com website to your home directory using scp or similar tools. (Example: scp setup_gravio_dockerimage_6.XXXXX_XXXX.deb gravio@192.168.1.100: )

5. Execute the following command:

   sudo docker compose down
   

6. Execute the following commands:

   sudo apt update
   sudo apt upgrade
   

7. After the above commands complete, execute the following command:

   sudo apt install ./setup_gravio_dockerimage_6.XXXXX_XXXX.deb
   

8. Execute the following command:

   sudo reboot
   

9. Log in to Gravio HubKit Web UI. Enter “https://[HubKit IP address]” in your PC’s browser to display the Gravio HubKit Web UI login screen

10. Log in with the local “gravio” account

11. Next, select the version to update in the “Gravio HubKit Software Update” row in the “Software Update” section and press the “Install” button. This will update HubKit to the specified version.

12. When the completion message is displayed, the upgrade is complete.

3.4 Gravio Hub X64

Procedure for upgrading Gravio Hub X64 with Gravio 5.x installed to Gravio 6.

1. Log in to Gravio Configuration Manager.

2. After logging in, press the backup button in the HubKit Backup section on the “Gravio Settings” tab screen to create a backup. After the backup file is created, the export button will become available. Press it to store the backup file on your local PC or other device.

3. Log in to Ubuntu with the “gravio” account in Terminal.

4. Copy the installer provided on the Gravio.com website to your home directory using scp or similar tools. (Example: scp setup_gravio_dockerimage_6.XXXXX_XXXX.deb gravio@192.168.1.100: )

5. Execute the following command:

   sudo docker compose down
   

6. Execute the following commands:

   sudo apt update
   sudo apt --fix-broken install
   sudo apt update
   sudo apt upgrade
   

7. After the above commands complete, execute the following command:

   sudo apt install ./setup_gravio_dockerimage_6.XXXXX_XXXX.deb
   

8. Execute the following command:

   sudo reboot
   

9. Log in to Gravio HubKit Web UI. Enter “https://[HubKit IP address]” in your PC’s browser to display the Gravio HubKit Web UI login screen

10. Log in with the local “gravio” account

11. Next, select the version to update in the “Gravio HubKit Software Update” row in the “Software Update” section and press the “Install” button. This will update HubKit to the specified version.

12. When the completion message is displayed, the upgrade is complete.

4. Gravio Hub X64 Setup and Operation

4.1 Determining the Operation Method

First, decide how you want to operate Gravio Hub X64.

• Operate as Main Server: Use as a Main Server to collect and store sensor data from other servers.
• Operate as Networked Node: Use as a node operating under another management server.

4.2 Setup Procedure

Log in to the Gravio HubKit Web UI from your browser.

1. Configure Gravio Hub WiFi settings on the Gravio Hub Settings screen to connect Gravio Hub X64 to the internet.

2. License Acquisition and Configuration according to the operation method

   • To set as Main Server: Obtain a Main license and perform the initial setup of the Gravio Coordinator.
     • Note: Even when configured as a Main Server, it can also function as a Networked Node to acquire sensor data and execute actions.
   • To use as a Networked Node: Obtain a NODE license. You can configure this Networked Node to send sensor data to a Main Server by registering it with the Main Server. It’s also possible to operate this node independently without connecting to a Main Server. Servers not belonging to a Main Server are called Standalone nodes.

4.3 Connection Method

For Wired LAN Connection

1. Connect a wired LAN cable to the LAN connector of Gravio Hub X64.
   • Ensure the LAN supports DHCP.
2. Start Gravio Hub X64.
   • Connect the USB-C cable to the power supply, then press the start button.
     • If an IP address is assigned via DHCP, log in to the console:
       • Username: gravio
       • Password: graviohub
   • Check the IP address using ip addr and access https://[IP_Address] from your browser. (Since HTTPS uses a self-signed certificate, your browser might show a warning. You can proceed to access the page. If you have your own SSL certificate, configure it in the Certificate Settings section on the Gravio Hub Settings screen to avoid this warning.)

For Wireless LAN Connection

1. Start Gravio Hub X64 (remove the wired LAN cable)

2. Connect to the SSID named “GravioHubXXXXXXXXXX” from your PC’s WiFi
   • WiFi password is “graviohub”
3. Access Gravio HubKit Web UI from your browser and configure WiFi settings

4.4 Security Settings

Gravio Hub X64 runs on Ubuntu2204-based Linux OS. It is important to change the login account password to enhance security.

In the Gravio Hub Settings tab of Gravio HubKit Web UI, there is an item called Ubuntu(gravio) Account Password Change. Gravio Hub X64 comes with Linux OS, and terminal login to this machine is registered as a local account named “gravio”. Therefore, the password for the “gravio” account is required for logging into this Linux machine, so please set a secure password by entering it yourself in this section.

Note: Please keep the reset login account password safe. If you lose the password, you will not be able to log into Linux.

4.5 Gravio Hub X64 Package Contents

The following items are included with Gravio Hub X64:

• Gravio Hub X64 Main Unit
• USB-C Cable
• Power Adapter
• Gravio Zigbee Receiver

5. New Installation and Setup Notes

When introducing the Gravio system for the first time, please note the following points:

1. Select the appropriate packages
   • Both the server software “Gravio HubKit” and the operating client “Gravio Studio” are required. Use the installer corresponding to the platform you are using.
2. Installation order
   • For the Windows version, be sure to install Gravio Studio first.
3. Prepare the network environment
   • A stable network environment is required for HubKit to operate.
   • Prepare a LAN environment where DHCP or static IP is available, or a properly configured WiFi environment.
4. Security measures
   • Manage passwords correctly.
   • Regularly perform HubKit backups using the Gravio Settings tab.

6. Uninstallation Procedures

6.1 Linux Version (AMD64/ARM64) Uninstallation

The procedure for uninstalling Gravio on the Linux version is as follows.

To uninstall Gravio from a Linux system, use the following command:

sudo apt remove ghubupdate

Also, delete the files in the following folders:

• /home/gravio/.env
• /home/gravio/docker-compose.yml

With these steps, you can complete the installation, upgrade, and initial setup of Gravio HubKit.