GeoThings IoT Platform

Version: V1.0.0

Copyright: Shenzhen Intgeo Innovation Technology Co., Ltd. (深圳市英特吉欧创新科技有限公司)

Last Updated: 2026.03.16

  1. All ownership and intellectual property rights of this software belong exclusively to Shenzhen Intgeo Innovation Technology Co., Ltd. (深圳市英特吉欧创新科技有限公司).
  2. Users shall obtain the right to use the software through lawful channels and use it in accordance with applicable agreements.
  3. During use of this software, any infringement or illegal acts not caused by Shenzhen Intgeo Innovation Technology Co., Ltd. (深圳市英特吉欧创新科技有限公司) shall be borne entirely by the user, and Shenzhen Intgeo Innovation Technology Co., Ltd. (深圳市英特吉欧创新科技有限公司) assumes no joint or several liability.
  4. Without written consent or authorization from Shenzhen Intgeo Innovation Technology Co., Ltd. (深圳市英特吉欧创新科技有限公司), no entity may modify or derive from this software in any form, including adaptation, translation, annotation, compilation, relicensing, or reauthorization.
  5. Updates or changes to this manual may be made without notice, and Shenzhen Intgeo Innovation Technology Co., Ltd. (深圳市英特吉欧创新科技有限公司) has no obligation to notify users.

Trademark Statement

"Shenzhen Intgeo Innovation Technology Co., Ltd. (深圳市英特吉欧创新科技有限公司)" and "GeoTwin" are trademarks or product identifiers of Shenzhen Intgeo Innovation Technology Co., Ltd. (深圳市英特吉欧创新科技有限公司). Unauthorized use is prohibited.

1. New Features / Improvements

1.1 What's New

  • Improvements:
    • First edition release; no previous version to compare.
  • New Features:
    • Asset Overview: dashboards for product/device/alert statistics and trends
    • Product Management: create/edit/delete products; configure access protocol and connection details; system icons and custom icon upload
    • Device Management: create/edit/delete devices; device details include basic info, attribute editing, records, alerts, MQTT topics, and API documentation
    • Data Ingestion: HTTP APIs for data push and coordinate push by device series number, with copy-to-clipboard for endpoints and request examples
    • Alert Center: filter alerts by time range and product; single/batch delete (permission-dependent)
    • Rule Center: view rules and configure applied devices
    • Localization & Appearance: zh_CN / zh_TW / en_US switching; theme switching (light/dark/auto); font size switching
    • Notifications: message center entry (SSE; message types TBD)
    • Camera Monitoring (if enabled): device monitoring modal playback (m3u8/HLS)
    • Monitor Wall (if enabled): multi-camera layout and preview
    • Asset Map / 3D Scene (if enabled): 3D scene and panel components (scope TBD)
  • Other Changes:
    • Some modules may be enabled by deployment configuration; the actual navigation menu is the source of truth.

1.2 Changelog

Version Date Summary
V1.0.0 2026.03.16 Initial release covering asset overview, product/device management, alert center, rule center, and ingestion APIs

2. Notes Before Use

2.1 System Requirements

2.1.1 Operating System

  • Supported OS: Windows 10/11 (x64), Windows Server 2019+, mainstream Linux distributions (deployment side, TBD)
  • Client: Modern browsers (Chrome / Edge, latest two major versions recommended)

2.1.2 Hardware

  • CPU: Dual-core or above
  • Memory: ≥ 8GB recommended (≥ 16GB for large data sets or heavy multitasking)
  • GPU: Not required (dedicated GPU recommended for map/3D visualization, TBD)

2.1.3 Storage & Network

  • Storage: SSD recommended on deployment side; free space ≥ 20GB (logs/static assets, TBD)
  • Network: Must reach backend APIs (default /api) and the SSE channel (TBD)
Component Recommended
CPU 4 cores or above
Memory 16GB or above
Storage 256GB SSD or above
Network Gigabit Ethernet or equivalent

2.2 Installation

  1. Open the deployment URL (TBD) in a browser;
  2. For local development/integration: install dependencies under apps/geotwin and start dev server (npm run dev);
  3. For production: build the app (npm run build:prod) and deploy static assets to a web server (Nginx/gateway, TBD).

2.3 Licensing / Authentication

2.3.1 Online Authentication (Login)

When to use: Access the system via the unified portal. The system uses a token for API calls and message subscriptions.

Steps:

  1. Access the GeoTwin IoT application via the unified portal (https://portal-dev.geotwin.cn/gtiot/home) and complete sign-in;
  2. After login, the system stores an access token in the browser, used for backend API requests and message subscriptions (e.g., Message Center / SSE; TBD);
  3. Return to the system home page or refresh the page, then verify modules load data correctly.

Troubleshooting:

  • If you see authorization errors or 401/403 responses: re-login; confirm the account has required roles/permissions; contact an administrator if needed.
  • If data fails to load: verify network access to backend APIs (default /api, TBD) and check request errors in the browser developer tools (TBD).

2.3.2 Offline Licensing

Offline licensing is not available in the current version (TBD: will be documented if supported in future releases).

3. Overview

3.1 Positioning

GeoTwin (IoT) is an IoT asset management and visualization application. It provides product/device management, device data ingestion (API push), alert viewing and handling, and rule center configuration. It is suitable for unified IoT device management in campuses, cities, and enterprise asset scenarios.

3.2 Modules

  • Asset Overview: dashboards for product/device/alert statistics and trends
  • Product Management: manage products (type, protocol, icon) and configure fields/alert rules (TBD: per actual UI)
  • Device Management: manage devices (product binding, coordinates), view device attributes/records/alerts and data push APIs
  • Alert Center: view alerts with time/product filters and handle alerts
  • Rule Center: view rules and configure applied devices
  • Asset Map (Optional): view/manage devices on map/3D scene (if enabled)
  • Monitor Wall (Optional): multi-camera monitoring layout (if enabled)

3.3 Key Advantages

  • Multi-language: zh_CN / zh_TW / en_US
  • Standard ingestion: data push and coordinate push APIs by device series number
  • Unified alert visibility: filters for time range and product
  • Modular & extensible: Vue3 + Element Plus, structured for delivery and extension

4. Format Support

4.1 Input Formats

Data Type Supported Format Notes
Device data push (HTTP) JSON POST /gtportal/iot/api/{seriesNumber}/device/data; fields depend on product dynamic schema
Device coordinate push (HTTP) JSON POST /gtportal/iot/api/{seriesNumber}/device/location; includes x/y/z
Product icon upload Image files (TBD) System icon selection or custom upload

4.2 Output Formats

Output Supported Format Notes
Dashboards In-app visualization Trends and distributions (no file export, TBD)
Device charts In-app visualization Time-series charts for numeric fields (no file export, TBD)
Links / API endpoints URL Copyable data push service endpoints

5. Usage Guide

5.1 Core Module Operations

5.1.1 Asset Overview

How it works: Aggregates key indicators (products, devices, alerts) into summary cards and trend charts for fast situational awareness.

Key features:

  • View summary cards and charts for products/devices/alerts
  • Switch time scope (last N days or date range; TBD)

Steps:

  1. Open "Asset Overview" from the left menu;

  2. Switch the time scope and review trends;

  3. Drill down to the alert list or device details for further handling (TBD: per actual UI).

Fig 5-1-1-1: Asset Overview (TBD)

5.1.2 Product Management

How it works: Uses "Product" as a device-type abstraction. Protocol, schema, icons, and alert rules are configured at the product level as a foundation for device onboarding and alert evaluation.

Key features:

  • Create/edit/delete products
  • Configure access protocol (e.g., MQTT) and connection details (host/port/username/password)
  • Configure product icon (system icon or uploaded icon)
  • Maintain product fields and alert rules in the product drawer (per actual UI)

Steps:

  1. Open "Product Management" to view the product list;

  2. Click "Create" to add a new product and fill required fields (TBD: per actual UI);

  3. Open product settings to configure protocol and connection details;

  4. Configure the icon (system icon or upload a custom icon);

  5. Configure fields and alert rules as needed, then save (TBD: activation policy per actual UI).

Fig 5-1-2-1: Product Management (TBD)

5.1.3 Device Management

How it works: Uses "Device" as the concrete asset instance bound to a product. Device detail consolidates attributes, records, alerts, topics, and ingestion APIs for operations and integrations.

Key features:

  • Create/edit/delete devices and bind them to products
  • Maintain device coordinates (x/y/z)
  • Device details: attributes, records, alerts, MQTT topics, API documentation
  • Camera monitoring: play live streams in a modal (m3u8/direct URL; TBD)

Steps:

  1. Open "Device Management" and search/filter devices (TBD: filters per actual UI);

  2. Click "Create" to add a device, select a product, fill name and coordinates, then save;

  3. Open device detail tabs to update attributes, review records/alerts, and copy MQTT/API information;

  4. For camera devices, open the monitoring modal and verify playback (TBD: depends on stream URL and network).

Fig 5-1-3-1: Device Management (TBD)

5.1.4 Alert Center

How it works: Centralizes all alerts into a unified list, with filters by time range and product for quick triage and traceability.

Key features:

  • Filter alerts by time range and product
  • Batch delete or single delete (subject to permissions/backend policy)

Steps:

  1. Open "Alert Center" and set time range and product filters;

  2. Review alert list and navigate to related device/detail when needed (TBD: entry per actual UI);

  3. With sufficient permissions, delete single alerts or batch delete.

Fig 5-1-4-1: Alert Center (TBD)

5.1.5 Rule Center

How it works: Manages alert/strategy rules and binds them to devices via "Applied Devices" to control the effective scope.

Key features:

  • View rule list and descriptions
  • Configure applied devices for a rule

Steps:

  1. Open "Rule Center" and review rule list/descriptions;

  2. Open "Applied Devices" for the target rule;

  3. Select devices and save to make the rule effective for the selected devices (TBD: effective timing per actual UI).

Fig 5-1-5-1: Rule Center (TBD)

5.2 Key Workflows

5.2.1 Data Import (Data Ingestion)

  1. Create a product in "Product Management" and complete protocol/schema configuration (TBD);

  2. Create a device in "Device Management", select the product, and fill name and coordinates;

  3. Open the device details "API" tab to obtain endpoints:

    • Data push: POST /gtportal/iot/api/{seriesNumber}/device/data
    • Coordinate push: POST /gtportal/iot/api/{seriesNumber}/device/location (only visible when realtime coordinate push is enabled)
  4. Send JSON payloads from external systems according to API docs. Data will be used for records/alerts/visualization (backend-dependent).

Fig 5-2-1-1: Device Detail - API (TBD)

5.2.2 Processing (Alerts and Rules)

  1. Configure alert rules in product settings (threshold/severity/message; TBD);

  2. In "Rule Center", open "Applied Device" for a rule, select target devices, and save;

  3. When ingested data meets trigger conditions, alerts appear in "Alert Center" and "Device Detail - Alert".

Fig 5-2-2-1: Rule Center - Applied Devices (TBD)

5.2.3 Export (View and Copy)

  1. In "Alert Center", filter by time range and product to locate alerts;

  2. In "Device Management", open device details:

    • View historical records in "Record" tab (TBD)
    • Edit and save device attributes in "Attribute" tab
    • Copy endpoints and request examples in "API" tab
  3. For exporting data as files, contact the delivery team to enable export features (TBD).

Fig 5-2-3-1: Alert Center - Filters and List (TBD)

5.3 Troubleshooting

Issue 1: Permission denied / API returns 401 or 403

Fix: Re-login; check token expiry; contact an admin to grant roles/permissions.

Issue 2: Coordinate push API is not shown in device detail

Fix: Ensure the product has realtime coordinate push enabled and refresh the page.

Issue 3: Camera stream cannot be played

Fix: Verify the stream URL accessibility; for m3u8 ensure HLS is reachable; check backend transcoding settings (TBD).

Issue 4: Alerts are missing or abnormal

Fix: Verify pushed fields match the product schema; verify rule thresholds and device bindings; confirm the rule is applied to the device.

6. Concepts

Term Definition
Product The device type abstraction, including protocol, schema, and icon
Device A concrete asset instance bound to a product, with name/coordinates/series number
Series Number A device identifier used to compose data push API paths
Dynamic Field The product-defined reportable field set, defining JSON payload keys
Alert A warning/event generated when rule conditions are met
Rule A rule configuration for alerts/push strategies, can be applied to devices
Token / clientid Authentication parameters for backend APIs, typically issued after login
SSE Server-Sent Events channel for notifications/messages

7. Support

  • Website: TBD
  • Manual Download: TBD
  • Email: TBD
  • Official Account: TBD

Appendix: Information To Be Confirmed

  1. Official software name, versioning, copyright holder/company name
  2. Production URL, unified portal URL, and user onboarding/permission process
  3. Final UI and field definitions for product schema, alert rules, and push configuration
  4. Data source/mapping for "Record" tab and whether export is supported
  5. Camera streaming source and supported formats (m3u8/rtsp transcoding), backend requirements
  6. Screenshots to be added: docs/images/en/5-1-1-1-asset-overview.png, docs/images/en/5-1-2-1-product-list.png, docs/images/en/5-1-3-1-device-list.png, docs/images/en/5-1-4-1-alert-center.png, docs/images/en/5-1-5-1-rule-center.png, docs/images/en/5-2-1-1-device-detail.png, docs/images/en/5-2-2-1-rule-applied-devices.png, docs/images/en/5-2-3-1-alert-list.png (and other key steps)