Web Dashboard

The Kinuxota Web Dashboard provides a comprehensive user interface for managing your IoT devices, scripts, packages, and commands. This document outlines the features and capabilities of the web dashboard.

Introduction to the Web Dashboard

The Kinuxota Web Dashboard is a modern, responsive web application that serves as the primary interface for managing your IoT device fleet. It provides a comprehensive set of tools for device management, script execution, package management, and command monitoring.

The web dashboard is built using modern web technologies:

Next.js for the frontend framework
React for the UI components
Apollo Client for GraphQL communication
TailwindCSS for styling

Getting Started with the Web Dashboard

⚠️ IMPORTANT: During the pilot phase, each user is limited to a maximum of 3 devices in the free tier.

User Registration and Login

To access the Kinuxota Web Dashboard, you need to create an account:

Navigate to the signup page
Enter your email address and password
Verify your email address through the verification link sent to your inbox
Log in with your credentials

If you forget your password, you can use the “Forgot Password” link on the login page to reset it.

Dashboard Overview

After logging in, you’ll be directed to the main dashboard, which provides:

A summary of your device fleet
Total number of devices
Number of online devices
Device status cards showing the current state of each device
Last seen timestamps for each device

The dashboard automatically refreshes to show real-time device status updates.

Device Management

Registering New Devices

To add a new device to your fleet:

Navigate to the Devices page
Click the “Add Device” button
Enter the device details:
- Device name
- Description (optional)
- Serial number (optional)
- Device type (optional)
Click “Create Device” to register the device

Note: The free tier is limited to a maximum of 3 devices.

Viewing Device Details

To view detailed information about a device:

Navigate to the Devices page
Click on a device in the list

The device details page provides:

Basic device information (name, description, serial number)
Current status (online/offline)
Last seen timestamp
Firmware version
Tabs for accessing different device management features

Managing Device Status

The device status is automatically monitored and displayed in the UI. Status indicators show:

Online (green): The device is currently connected
Offline (red): The device is not connected
Updating (blue): The device is currently receiving an update

Deleting Devices

To remove a device from your fleet:

Navigate to the Devices page
Click the delete icon next to the device you want to remove
Confirm the deletion in the confirmation dialog

Script Management

Creating Scripts

To create a new script:

Navigate to the Scripts page
Click the “Create Script” button
Enter the script details:
- Script name
- Description (optional)
- Main script content (in the code editor)
- Additional files (if needed)
Click “Create Script” to save the script

Viewing Script Details

To view detailed information about a script:

Navigate to the Scripts page
Click on a script in the list

The script details page provides:

Basic script information (name, description)
Creation date
Script content
Additional files
Execution history

Executing Scripts on Devices

To execute a script on a device:

Navigate to the device details page
Select the “Scripts” tab
Choose a script from the list
Click “Execute Script”
Monitor the execution progress

Alternatively, you can execute a script from the script details page by selecting a target device.

Monitoring Script Executions

To monitor script executions:

Navigate to the Script Executions page, or
View the execution details from the device’s Scripts tab

The execution details page provides:

Execution status (pending, deploying, deployed, executing, completed, failed, cancelled)
Start and completion timestamps
Exit code
Execution logs
Script content for reference

Package Management

Viewing Installed Packages

To view packages installed on a device:

Navigate to the device details page
Select the “Packages” tab

The packages tab displays:

List of installed packages
Package versions
Installation dates

Installing New Packages

To install a new package on a device:

Navigate to the device details page
Select the “Packages” tab
Click “Install Package”
Enter the package name and optional version
Click “Install”

You can install multiple packages at once by adding additional package rows.

Updating Packages

To update an installed package:

Navigate to the device details page
Select the “Packages” tab
Find the package you want to update
Click “Update” next to the package
Enter the new version
Click “Update”

Removing Packages

To remove a package from a device:

Navigate to the device details page
Select the “Packages” tab
Find the package you want to remove
Click “Remove” next to the package
Confirm the removal

You can also select multiple packages and remove them in bulk.

Command Execution

Sending Commands to Devices

Commands are typically sent to devices through specific actions like installing packages or executing scripts. The web dashboard handles the command creation and submission automatically.

Monitoring Command Status

Command status is displayed in real-time in the relevant sections of the UI:

Package installation/update/removal status in the Packages tab
Script execution status in the Scripts tab

User Settings and Account Management

To manage your account settings:

Click on your profile in the top-right corner
Select “Settings” from the dropdown menu

In the settings page, you can:

Update your profile information
Change your password
Manage notification preferences
View account usage and limits