XGRIDSDocs
  • 简体中文
  • English
  • 繁體中文
  • 日本語
  • Deutsch
  • Español
  • Italiano
  • Français
  • Русский
  • Polski
  • Nederlands
  • 简体中文
  • English
  • 繁體中文
  • 日本語
  • Deutsch
  • Español
  • Italiano
  • Français
  • Русский
  • Polski
  • Nederlands
  • PortalCam

    • Product Overview
    • Basic Operation
    • Using the LCC Scan App
    • Maintenance and Care
    • FAQ
  • Lixel K Series

    • Lixel K1

      • Product Overview
      • Basic Operation
      • Device Activation and Connection
      • Scanning Workflow
      • Acquire Point Cloud Data with Absolute Coordinate
      • Map Fusion
      • Route Planning Suggestions for Typical Scenes
      • Precautions
      • FAQ
    • Lixel K2

      • Product Overview
      • Basic Operation
      • Device Activation and Connection
      • Scanning Workflow
      • Acquire Point Cloud Data with Absolute Coordinate
      • Map Fusion
      • Route Planning Suggestions for Typical Scenes
      • Precautions
      • FAQ
  • Lixel L Series

    • Lixel L2 Pro

      • Product Overview
      • Basic Operation
      • Device Activation and Connection
      • Scanning Workflow
      • Acquire Point Cloud Data with Absolute Coordinate
      • Measure Point
      • Appendix
      • FAQ
    • Lixel L3

      • Product Overview
      • Basic Device Functions
      • Device Activation and Connection
      • Data Capture
      • Capturing Absolute Coordinates
      • Appendix
  • Accessories

    • Stick Light

      • Installation Guide
      • Basic Operation
      • FAQ
  • Lixel Studio

    • Version and Copyright
    • Installation and Activation
    • Software Interface
    • File Operations
    • Project Processing
    • Tools
    • 2D Drawing
    • Applications
    • Settings
    • Device Connection
    • FAQ
  • Lixel CyberColor

    • LCC Studio

      • Getting Started
      • Version and Updates
      • Download and Installation
      • Interface Overview and Navigation
      • Before Reconstruction
      • Model Reconstruction
      • Single Model Reconstruction
      • Map Fusion
      • Aerial-Ground Fusion
      • Aerial Reconstruction
      • My Models
      • Other Features
      • Settings and Account
      • Converter
      • Video Reconstruction
      • FAQ
    • LCC Scene Editor

      • Version & Updates
      • Account & Login
      • Product Overview & Home
      • Editor Interface
      • Scene Navigation Modes
      • File
      • Settings
      • Edit Operations
      • Window
      • Global Toolbar
      • Assets & Properties
      • Left Toolbar
      • Viewpoints
      • Portal
      • Skybox
      • Annotations
      • Measurement
      • Flythrough
      • Scene Report
      • 3D Layout
      • Mini-Map
      • Preview Mode (Viewer)
      • Help
      • FAQ
      • Spawn Point
    • LCC Model Editor

      • Version and Updates
      • User Guide
      • Overview and Interface
      • File Operations
      • Selectors
      • Editing Models
      • Measurement
      • Color Grading
      • Asset Management
      • Settings and Help
      • FAQ
    • Capture Guide

      • Overview
      • Capture Devices Overview
      • General Capture Principles
      • Indoor Scene Capture
      • Outdoor Scene Capture
      • Large-Scale Capture (Map Fusion)
      • Aerial-Ground Map Fusion Capture
      • Object Capture
      • People Capture
      • Video Reconstruction Capture
      • HD Enhancement
      • Control Points (Lixel P1)
      • FAQ and Troubleshooting
    • LCC Studio Linux

      • Product Overview
      • Architecture Guide
      • Installation and Deployment Guide
      • Container Startup Parameters Guide
      • CodeMeter Offline Licensing Deployment Guide
      • API Reference
      • Appendix - Developer Data Guide
      • Appendix - Error Code List
      • Single-Machine Multi-GPU Cluster Deployment QuickStart
    • Best Practices

      • Merging Multiple Large 3DGS Models
    • Version History
  • Plugin & SDK

    • Unreal

      • Introduction
      • Quick Start - Windows
      • Quick Start - Linux
      • Quick Start - Quest3
      • Editions and Licensing
      • Rendering
      • Tiled Rasterization (Experimental)
      • Visual Settings
      • Normals and Lighting
      • Scene Editing
      • Performance Parameters
      • Performance Guide
      • Third-party and Engine Plugin Integration
      • Proxy Mesh
      • Loading Animation
      • Collision
      • Navigation System Support
      • Single Layer Water Support
      • Localization
      • FAQ
      • Troubleshooting
      • Logging and Diagnostics
      • Contact Us
      • Best Practices

        • Relighting 3DGS with a LixelStudio Mesh
      • API Reference

        • ALCCActorBase
        • ULCCComponentBase
        • ULCCComponent
        • ULCC2Component
        • SOG / SPZ / PLY Actors
        • ALCC2ProxyMesh
        • ALCCClippingVolume
        • ALCCSectionPlane
        • ALCCLoadVolume
        • ULCCUtilLibrary
        • Enums
        • Structs
      • Changelog

        • v3.4.0
        • v3.3.1
        • v3.0.0
        • v2.2.1
        • v1.0.0
        • v0.9.0
        • v0.8.0
        • v0.7.1
        • v0.6.1
        • v0.5.2
        • v0.4.1
        • v0.4.0
        • v0.3.0
        • v0.0.5
        • v0.0.4
        • v0.0.3
        • v0.0.2
        • v0.0.1
    • Web

      • Introduction
      • Rendering Performance Optimization Guide
      • Graphics Configuration
      • FAQ
      • API Reference

        • LCCRender::clearIndexDB
        • LCCRender::dispose
        • LCCRender::load
        • LCCRender::setCamera
        • LCCRender::unload
        • LCCRender::update
        • LCCObject::checkRenderNextFrame
        • LCCObject::clearRenderNextFrame
        • LCCObject::ecef2Prj
        • LCCObject::getBounds
        • LCCObject::getEnvInstancedMesh
        • LCCObject::getInstancedMesh
        • LCCObject::getLodInfos
        • LCCObject::getOriginPosition
        • LCCObject::getProjectionCoordinateSystemInfos
        • LCCObject::hasCollision
        • LCCObject::hasEnvironment
        • LCCObject::hasShcoef
        • LCCObject::intersectsCapsule
        • LCCObject::intersectsRayExt
        • LCCObject::intersectsRayFromOriginExt
        • LCCObject::intersectsSphere
        • LCCObject::lowerToBottom
        • LCCObject::prj2Ecef
        • LCCObject::raiseToTop
        • LCCObject::raycast
        • LCCObject::raycastFromOrigin
        • LCCObject::setAlpha
        • LCCObject::setClipBox
        • LCCObject::setClipPlane
        • LCCObject::setEndLod
        • LCCObject::setLodAutoLevelUp
        • LCCObject::setMaxDistance
        • LCCObject::setMaxNodeSplats
        • LCCObject::setMaxSplats
        • LCCObject::setOriginPosition
        • LCCObject::setPointsColor
        • LCCObject::setRenderState
        • LCCObject::setRotation
        • LCCObject::setScale
        • LCCObject::setSemantic
        • LCCObject::setSemanticColor
        • LCCObject::setSmooth
        • LCCObject::setStartLod
        • LCCObject::setTranslation
        • LCCObject::setVisible
        • LCCObject::togglePointsDisplayMode
        • LCCObject::useEnvironment
        • LCCObject::useShcoef
      • Changelog

        • v0.6.3
        • v0.6.2
        • v0.6.1
        • v0.6.0
        • v0.5.5
        • v0.5.4
        • v0.5.3
        • v0.5.2
        • v0.5.1
        • v0.5.0
        • v0.4.1
        • v0.4.0
        • v0.3.1
        • v0.3.0
        • v0.2.0
    • Lixel OpenAPI

      • Overview
      • Connection & Authentication
      • Message Model & Codec
      • Interface Catalog
      • Real-time Data
      • Project File Access
      • Error Codes
      • Python

        • Quick Start
        • Client Wrapper & Tools
        • FAQ
      • C++

        • Quick Start
        • Client & Examples
        • FAQ

Error Codes

Request-response messages carry the result in the Error error = 15 field of the response, holding the code code and description desc. This page lists the error codes exposed by the OpenAPI, by category, with their numeric values.

Looking up a name from a value

Both Error.code and DeviceStatusReport.modeling_state are uint32; the client wrapper decodes them into decimal integers. Convert the integer to hexadecimal, then look up the name in the "Value" column below. For example, the device returns 302252033, which is 0x12040001 in hex and corresponds to EC_Success; a modeling_state of 302252332, i.e. 0x1204012C, corresponds to EC_ScanReady (standby).

code = rsp["error"]["code"]
print(hex(code))        # 0x12040001

The high 16 bits of the value indicate the category; the public error codes below are grouped accordingly. The device enum also contains values not listed here (with high 16 bits such as 0x2201, 0x2203, 0x3203); treat an unlisted value as unknown and do not error out on it. Do not judge the category by the name prefix alone: names starting with EC_Scan span status, warning, and error categories — rely on the value.

High 16 bitsCategorySection on this page
0x1204Status & successGeneral status, upgrade status, activation status, Ntrip status, scan status
0x2204WarningScan warning codes
0x3201Device exceptionDevice exception codes
0x3204ErrorGeneral errors, Ntrip errors, external-storage errors, scan errors
0x3205Calibration errorCalibration error codes

General status codes

NameValue (hex, decimal)Meaning
EC_UnknownState0x12040000 (302252032)Unknown state
EC_Success0x12040001 (302252033)Success
EC_SuccessAndReboot0x12040002 (302252034)Success and reboot
EC_RequestSuccess0x12040001 (302252033)Request successful (same as EC_Success)

General error codes

NameValue (hex, decimal)Meaning
EC_UnknownError0x32040000 (839122944)Unknown error
EC_ProtoError0x32040001 (839122945)Protocol error
EC_RequestError0x32040002 (839122946)Request error

Upgrade status codes

NameValue (hex, decimal)Meaning
EC_UpgradeOnGoing0x120400C8 (302252232)Upgrade in progress
EC_UpgradeFileNotExist0x120400C9 (302252233)File does not exist
EC_UpgradeFileBroken0x120400CA (302252234)File is corrupted
EC_UpgradeProtoError0x120400CB (302252235)Protocol error
EC_UpgradeFailed0x120400CC (302252236)Upgrade failed
EC_UpgradeSucceed0x120400CD (302252237)Upgrade succeeded
EC_UpgradeLowBattery0x120400CE (302252238)Battery level too low
EC_UpgradeInternalError0x120400CF (302252239)Internal error

Activation status codes

NameValue (hex, decimal)Meaning
EC_Activated0x120401F4 (302252532)Activated
EC_Deactivated0x120401F5 (302252533)Not activated

Ntrip status and error codes

NameValue (hex, decimal)Meaning
EC_NtripLoginSuccess0x12040001 (302252033)Ntrip login successful
EC_NtripLogoutSuccess0x12040001 (302252033)Ntrip logout successful
EC_NtripDisConnected0x12040191 (302252433)Ntrip service disconnected
EC_NtripLogoutFailed0x32040002 (839122946)Ntrip logout failed
EC_NtripNetworkError0x32040003 (839122947)Ntrip network error
EC_NtripAuthError0x32040004 (839122948)Ntrip authentication failed
EC_NtripTimeoutError0x32040005 (839122949)Ntrip execution timeout

External storage (Udisk) error codes

NameValue (hex, decimal)Meaning
EC_UdiskNotMounted0x3204000B (839122955)External storage not mounted
EC_UdiskStorageLow0x3204000C (839122956)External storage space insufficient
EC_UdiskNoProject0x3204000D (839122957)No project to transfer
EC_UdiskTransferError0x3204000E (839122958)External storage transfer error
EC_UdiskLowBattery0x3204000F (839122959)Insufficient battery for external storage transfer

Device exception codes

NameValue (hex, decimal)Meaning
EC_ExBatteryLow0x32011001 (838930433)Low battery level
EC_ExStorageLow0x32011002 (838930434)Low storage capacity
EC_ExImuAbnormal0x32011003 (838930435)IMU abnormal
EC_ExImuHalt0x32011004 (838930436)IMU stopped working
EC_ExEncoderAbnormal0x32011005 (838930437)Encoder abnormal
EC_ExEncoderHalt0x32011006 (838930438)Encoder stopped working
EC_ExCamera0Abnormal0x32011007 (838930439)Camera 0 abnormal
EC_ExCamera1Abnormal0x32011009 (838930441)Camera 1 abnormal
EC_ExCamera2Abnormal0x3201100D (838930445)Camera 2 abnormal
EC_ExCamera3Abnormal0x3201100B (838930443)Camera 3 abnormal
EC_ExCamera0Halt0x32011008 (838930440)Camera 0 stopped working
EC_ExCamera1Halt0x3201100A (838930442)Camera 1 stopped working
EC_ExCamera2Halt0x3201100E (838930446)Camera 2 stopped working
EC_ExCamera3Halt0x3201100C (838930444)Camera 3 stopped working
EC_ExBatteryEmpty0x3201100F (838930447)Battery depleted
EC_ExStorageEmpty0x32011010 (838930448)Storage depleted
EC_ExLidarAbnormal0x32011011 (838930449)LiDAR abnormal
EC_ExLidarHalt0x32011012 (838930450)LiDAR stopped working
EC_ExCpuTempHigh0x32011013 (838930451)CPU temperature too high
EC_ExSlipRingOverLife0x32011014 (838930452)Slip ring service life expired
EC_ExHardwareFault0x32011015 (838930453)Hardware fault
EC_ExMagneticAbnormal0x32011016 (838930454)Magnetic sensor abnormal
EC_ExMagneticHalt0x32011017 (838930455)Magnetometer data stopped
EC_ExSlamStopFailed0x32011018 (838930456)Algorithm stop exception
EC_ExBatteryTempHigh0x32011019 (838930457)Battery temperature too high
EC_ExUdiskLow0x3201101A (838930458)External storage capacity low
EC_ExUdiskEmpty0x3201101B (838930459)External storage capacity depleted
EC_ExUdiskRemove0x3201101C (838930460)External storage removed

Scan status codes

NameValue (hex, decimal)Meaning
EC_ScanReady0x1204012C (302252332)Standby
EC_ScanStarting0x1204012D (302252333)Starting scan
EC_ScanModeling0x1204012E (302252334)Scanning
EC_ScanStopping0x1204012F (302252335)Stopping scan
EC_ScanStopped0x12040130 (302252336)Scan finished

Besides the table above, modeling_state may also take the scan warning codes EC_ScanMappingAbort, EC_ScanNotAllowedInUsbMass, and EC_ScanProjectTransferring. For example, in USB mass storage mode the device reports 0x2204013E; waiting indefinitely for EC_ScanReady then times out.

Scan error codes

NameValue (hex, decimal)Meaning
EC_ScanMountError0x32040131 (839123249)Mount error
EC_ScanStorageError0x32040132 (839123250)Storage error
EC_ScanSlamError0x32040133 (839123251)Mapping error
EC_ScanPreIDError0x32040134 (839123252)Pre-project error
EC_ScanStorageEmpty0x32040135 (839123253)Disk capacity empty
EC_ScanCameraError0x32040136 (839123254)Camera error
EC_ScanRelocSuccess0x32040137 (839123255)Relocation successful (the name contains Success, but the value starts with 0x3204, assigned from the error base)
EC_ScanRelocFailed0x32040138 (839123256)Relocation failed
EC_ScanSlamAbort0x32040139 (839123257)Algorithm aborted
EC_ScanStorageLow0x3204013A (839123258)Insufficient disk space
EC_ScanMemoryLow0x3204013B (839123259)Insufficient memory
EC_ScanLidarError0x3204013C (839123260)LiDAR data abnormal

Calibration error codes

NameValue (hex, decimal)Meaning
EC_CalibFailed0x32050001 (839188481)Calibration failed
EC_CalibMagRtkError0x32050002 (839188482)Magnetometer calibration RTK state error
EC_CalibMagLackDataError0x32050003 (839188483)Magnetometer calibration data acquisition abnormal
EC_CalibFileNotExists0x32050004 (839188484)File does not exist
EC_CalibFileNotPermitted0x32050005 (839188485)File operation not permitted

Scan warning codes

NameValue (hex, decimal)Meaning
EC_ScanMappingAbort0x2204013D (570687805)Mapping aborted, packet recording only
EC_ScanNotAllowedInUsbMass0x2204013E (570687806)Scan not allowed in USB mass storage mode
EC_ScanProjectTransferring0x2204013F (570687807)Scan not allowed during project transfer
EC_ScanPclRefineError0x22040140 (570687808)PCL refine failed
EC_ScanPcbinDataError0x22040141 (570687809)Pcbin data abnormal (causes LAS file generation to fail)
EC_ScanXbinDataError0x22040142 (570687810)Xbin data abnormal (causes post-processing to fail)

Note: this page lists only the error codes exposed by the OpenAPI; the device has more, and they may change across firmware versions. For an unlisted code, first confirm the category from the hex value, then refer to the desc in the response. Note: on a successful AC_ADD for control_point, desc is the pose numbers of the point, not a text description.