Overview

The Ciholas Ultra-Wideband (CUWB) Manager is the primary software tool for managing, configuring, and operating CUWBNets. It provides a web-based User Interface (UI) that can be accessed from the user’s Local Area Network (LAN), allowing administrators to manage multiple CUWB Configurations and run CUWBNets simultaneously.

The CUWB Manager operates a single-page web application that stores all CUWB configurations and controls the execution of each CUWBNet. Through this interface, users can configure anchor settings, start or stop CUWBNet operation, and monitor system status in real time.

The CUWB Manager provides an Application Program Interface (API) that exposes the same functions available in the web interface. Developers can use the API to build custom tools or automate tasks such as adding or removing tags and adjusting beacon rates. Full API documentation is available in the CUWB Manager API.

This CUWB Manager Manual applies only to v5.1 of the CUWB Manager. The v5.1 CUWB Manager Version and Manual is compatible with Series 300 devices and is not compatible with older databases or legacy Ciholas hardware. Documentation for legacy systems is available in our legacy area.

CUWB RTLS Operation Background

This section outlines the roles and responsibilities of Tags and Anchors within the CUWB Real-Time Location System (RTLS). For a higher-level overview of the CUWB RTLS architecture, refer to the System Architecture section.

Anchors

Anchors serve as static reference points used by the location algorithm to determine the position of Tags. Anchors listen for Tag beacons, record the reception time, and if available, collect sensor data. All received data is transmitted to the CUWB Manager for use in the location algorithm and for display within the web interface.

In addition to serving as reference points, Anchors participate in Global Network Time (GNT) calculations. All devices in the CUWB Configuration must understand GNT in order to transmit and receive during their scheduled times. Multiple anchors participating in GNT allow the time to be distributed across large Anchor Arrays.

Anchors can be configured for one of three roles:

Each CUWB Configuration must have at least one Initial Seeder. This device initiates transmissions within the Anchor Array and provides the initial time model for the system. Ideally, the Initial Seeder is centrally located with strong RF connectivity to a large number of nearby Anchors. The choice of Initial Seeder can influence how quickly the Anchor Array achieves full GNT synchronization.

If multiple devices are configured as Initial Seeder, one will be selected at random to initialize the CUWBNet. If the selected device is unavailable (e.g., network disconnected or powered off), another Initial Seeder will be selected automatically.

Once the CUWBNet starts, Anchors near the Initial Seeder begin receiving UWB packets and attempt to ‘lock’ onto GNT. When a Seeder achieves full lock, it contributes to the GNT model, allowing synchronization to expand across the Array.

Quiet Anchors listen for transmissions from Seeders and Initial Seeders and attempt to ‘lock’ onto GNT. Once a Quiet Anchor has locked onto GNT, the Anchor can participate in position calculations but does not contribute to GNT modeling, and cannot be used to expand CUWBNets beyond the existing synchronization.

Tags

Tags are mobile devices tracked by the CUWBNet. Each Tag transmits UWB beacons that are received by Anchors. The Anchors forward reception timestamps to the CUWB Manager, where the location algorithm determines each Tag’s position.

Tags can be configured to transmit beacons at slower rates to conserve battery life or at faster rates to track dynamic objects.

Installation

The CUWB Manager can be installed in Ubuntu either online, via a Personal Package Archive (PPA) or offline, using pre-downloaded Debian packages.

Host PC Requirements

• OS: Ubuntu 22.04 Jammy or Ubuntu 24.04 Noble
• CPU: Intel or AMD 64-bit architecture, 2.5GHz, dual-core or better
• WAN: Must be able to reach ppa.cuwb.io via port 443¹
• Network: Two NICs or VLANs — one for the User Network and one for the isolated Anchor Network
• RAM: 8 GB or more
• HD: 32 GB or more²

<sub>1. Only required for online installation.
2. Additional space is required for CDP logging. See CDP Logging for additional requirements.</sub>

Requirements increase based upon CUWB System complexity. Larger installations may require additional processing power.

The Anchor Network NIC (or VLAN) must be configured for the link-local IP address range. See the Networking Guide for detailed instructions.

Online PPA Installation and Setup

Follow these steps to install the CUWB Manager:

After installation, the CUWB Manager is accessible on all network interfaces of the host machine at port 5000.

Offline Installation

The CUWB Manager can be installed on Host PCs that do not have PPA access. For instructions on how to create a transferable DEB package, see PPA Download for Software Packages.

If using individual Debian packages, CUWB Migrate DEB must be installed prior to CUWB Manager DEB.

Only use CLI to install the CUWB Migrate and CUWB Manager Debian packages.

The latest Debian (DEB) packages can be downloaded from the Software Packages page for offline installations. Transfer the DEB(s) to a USB drive or other transfer method to the Host PC. After downloading the packages, navigate to the file locations, and type the commands below into a terminal window to install the packages:

sudo apt install ./<package_name>.deb

Repeat the above step for each Debian package to be installed on the Host PC.

Some additional software, like the CUWB Viewer or CDP Logger, may have additional Host PC requirements. Review the requirements prior to installation.

CUWB Manager Software Installation

Regardless if installed via the PPA or the offline Debian packages, the CUWB Manager software package launches an installation GUI. Use Tab and Enter keys to navigate the installation GUI, which walks through several screens, that display the license agreement, configure optional host port settings, and expand the default UDP buffer size.

PPA Only Aggregation Selection

The PPA has a special aggregation that enables users to select which software packages to be installed:

When prompted in ‘CUWB Applications Selection,’ ensure that CUWB Manager and CUWB Firmware are selected for installation.

(Optional) Changing CUWB Manager local host port

When the installation script is first run, there will be a prompt for changing the local host port. Selecting No will display another prompt window where the new port can be entered.

If a different port is selected during installation, replace all the documentation references to :5000 with the new port.

The local host port can only be modified when installing the CUWB Manager for the first time or by uninstalling the CUWB Manager package and reinstalling the package.

(Optional) Expanding UDP Buffers

While this setting is optional, it is strongly recommended to increase the UDP buffer size for the linux kernel.

If the UDP buffer size is not increased during installation, it can be increased at any point. See APD002 for instructions.

Getting Started

This section guides the user through initial access to the CUWB Manager Web Interface and provides guidance on initial settings.

This Getting Started Guide uses the CUWB Manager in Basic View, which can be changed at any time. See Basic and Expert Settings View for additional information.

Preparation

Hardware Setup

Users new to the CUWB System should begin by setting up a small, manageable CUWB Configuration to become familiar with the tools and process. The Quick Start Guide provides step-by-step instructions for creating and running a small CUWBNet. For more detailed information, see the Installation Guide and Networking Guide.

To achieve the best performance, carefully select locations for Anchors. Each Anchor should have clear visibility to other Anchors and to the field of interest for tracking. For best practices, see the Component Placement Guide.

Survey data collected during hardware installation will be needed later for the CUWB Configuration setup.

Tags are shipped out in a ship mode which internally disconnects the battery. Some Tag variants support user replaceable batteries which need to be installed before Tag use. Ciholas recommends plugging Tags into chargers, or installing batteries, while the rest of the CUWB Manager is being configured.

If Tags are not plugged in while setup is occurring, they may need to be woken up prior to use. Shake devices prior to use to enable a faster CUWBNet join. Otherwise, Tags may take up to 640 seconds to join the CUWBNet.

Software Setup

If not already installed on the Host PC, follow the Installation instructions to install the CUWB Manager software.

Ensure that the Anchor Network NIC (or VLAN) is configured for link-local IP address range. See Networking Guide for instructions on configuring NIC(s).

If installing via separate Debian packages, make sure CUWB Migrate, CUWB Manager, and any CUWB Firmware for Anchors or Tags is installed.

Access the CUWB Manager Web Interface

On the Host PC where the CUWB Manager package was installed, open a web browser and navigate to:

http://localhost:5000

For systems without a desktop environment, a browser can be opened on another computer with access to the User Network using the IP address of the installation computer instead of localhost.

This will present the user with the main configuration page for CUWB Configurations. The CUWB Manager Web Interface is where users create one or more CUWB Configurations. Each CUWB Configuration defines the parameters used by an associated CUWBNet instance. The distinction helps organize settings for different networks and simplifies setup.

The configuration page is also available on port 5000 of each network interface. See Interface Example for viewing available Host PC interfaces.

Creating CUWB Configurations

Once in the CUWB Manager, open the CUWBNets tab. This section is where all configurations are created and managed.

To create a CUWB Configuration:

1. Enter a name for the CUWB Configuration (e.g., TestNetwork)

2. Click the “+” icon under the Actions column.

   The name of the CUWBNet cannot contain spaces or special characters, and is limited to a length of 100 characters.

3. After creating the configuration, select the gear icon under Actions. This opens the Configuration -> Device tab.

Adding Anchors

If Anchors are powered on and operational, the serial numbers will automatically populate in the Configuration -> Devices tab.

To add an Anchor:

1. Click the Anchor icon under Actions.

2. Enter an optional name, select a role, and provide X, Y, and Z coordinates.

   Anchors can be set to Quiet Anchor, Seeder, or Initial Seeder as roles. Most configurations will use the Seeder role for the majority of Anchors. If using MultiTime, one of the Anchors should be designated as the Initial Seeder. See Anchor Roles for details on each role.

3. Click the “+” icon to add the Anchor to the configuration.
4. Repeat for each Anchor in the configuration.

If the Anchors are powered off or did not auto-populate, they can be added manually by entering the same information (serial number, optional name, role, XYZ coordinates) in the fields at the bottom of the page.

X, Y, and Z coordinates must be entered in meters. This is the survey data for anchor locations from the hardware installation.

Adding Tags

To add a Tag:

1. Enter its Serial Number
2. Select the Role from the dropdown menu (use DEFAULT TAG if unknown)
3. Enter an optional name

The X, Y, and Z fields are available, but are not used by the system while the device is configured as a Tag.

Roles are beacon rate definitions that can be assigned to Tags. Tags support only one Role at a time, but Roles are configurable dynamically. Optional settings, like LED Brightness, can also be configured per Role. Additional information on Roles is available under Tag Roles.

Custom Roles can be added to the CUWB Configuration prior to adding Tags. Custom Tag Roles will appear in the Role assignment dropdown. See Adding a new Tag Role section.

In MultiRange, Anchors and Tags can be added to a CUWB Configuration at any point, even while the CUWBNet is active. In MultiTime, Tags can be added to a CUWB Configuration at any point, even while the CUWBNet is active. Anchors can be disabled while the CUWBNet is running. The CUWBNet must be stopped in order to add or re-enable Anchors.

Any edits to a device entry will need to be saved using the save icon for the entry row. The save icon will appear when an edit has been made.

Configuring Network Settings

The Network Interface Card (NIC) connected to the Anchor Array must be configured for link-local connections. See Networking Guide for instructions on configuring NIC(s) if they are not configured.

After Anchors and Tags are added to the configuration, navigate to the General tab to adjust the network settings. Under Ethernet settings, three data streams are populated by default:

• The Configuration Stream is used for device discovery, CUWB Applications and devices periodically announce their presence on this stream. This stream will default to IP address: 239.255.76.67 and Port: 7671. The interface will match the Anchor Stream. This stream should not be modified.
• The Anchor Stream is information sent from the Anchor Array devices to the CUWB Engine.
• The User Stream is the output data for User Applications to track position, configuration, status, and sensor information.

Each stream consists of three components:

• IP - The destination address for the stream
• Port - The destination UDP port for the stream

And one of the following:

• Listening Interface - The interface for listening to the Configuration or Anchor stream
• Sending Interface - The interface for emitting the User stream

The Anchor Stream Interface dropdown menu, highlighted in the red box must match theinet address of the link-local NIC or be set to Link Local. This address can be determined by the command line in Interface Example or by using the Networking Wizard and then selecting the appropriate address from the dropdown menu.

Interface Example

To view all network interfaces for the Host PC, type ifconfig in a terminal. In addition to the lo (or Local Loopback) interface, other interfaces typically begin with enp (wired Ethernet) or wlp (Wi-Fi). The IP address appears on the second line after inet.

Example:

enp3s0  Link encap:Ethernet  HWaddr b8:60:01:c3:9e:20
inet addr:192.168.100.2  Bcast:192.168.100.255  Mask:255.255.255.0

This output would indicate any device on the same network segment could access the CUWB Manager by browsing to http://192.168.100.2:5000.

Networking Wizard Example

The Networking Wizard guides users through the steps required for configuring both the Host PC and the CUWBNet for operation, including identifying available network interfaces and identifying potential problems in the setup.

To run the Networking Wizard, click the button labeled Networking Wizard.

The Networking Wizard does not modify the Host PC’s networking settings automatically, it is only a guide. For full operating system level instructions, see the Networking Guide.

Common General Settings

Other commonly modified general settings are also available in this tab. See the CUWB Manager Web Interface for all available options. These settings may not need to be adjusted for each RTLS deployment.

Common Schedule Settings

After general settings are adjusted, navigate to the Configuration -> Schedules tab. The CUWB Manager generates an air-time schedule for every Tag and Seeder listed in the CUWB Configuration. This gives devices a known time slot in which they can perform different RF actions according to the UWB operational mode. For a more detailed analysis of the underlying schedule for the operational modes, see Timing and Schedule.

• Tag Roles - Users can define and name custom Tag Roles, each defined by its beacon rate. The beacon rate sets how frequently the time slot is in the schedule.
• Seeder Rate - The Seeder rate cannot be adjusted in MultiRange Mode. In MultiTime Mode, the Seeder rate can be adjusted via the dropdown menu. Ciholas generally recommends using a 10Hz rate for most applications.

Preconfigured Tag Roles

Two Tag Roles are preconfigured for every CUWB Configuration: Unconfigured and Default. These preconfigured Roles can only have their counts modified.

• Unconfigured - Tag Role assigned to devices that are not configured to participate in the CUWBNet but may still appear nearby.
• Default - Tag Role used by Tags unless another role is selected.

Adding a New Tag Role:

To add a new role:

1. Enter a name for the role.
2. Select the beacon rate from the dropdown menu.
3. Enter the maximum number of Tags expected to use this role if using MultiTime.
4. Optionally enable or disable LEDs.
5. Click the “+” icon to add the Role.

When using a custom role for Tags, be sure to assign each Tag to that Role in Configuration -> Devices tab.

Adjusting LEDs for Anchors or Tags

Under LED Brightness, devices can be set to different LED modes: On, Off, and Device’s Settings. Device’s Settings will have devices follow their firmware programmed LED behaviors. These are outlined in each device datasheet.

Turning off LEDs may lead to confusion if a device is functioning. It is recommended to leave LEDs in either Device’s Settings or On during system setup.

Running the CUWBNet

After entering devices and customizing settings for the application, start the CUWB Configuration by clicking the Play button:

• In the upper right-hand corner in most tab views
• On the CUWBNets page
• On the Status tab

When the CUWBNet starts, Anchors will start their synchronization process (if using MultiTime) and start to build out the CUWBNet through UWB communications. If using MultiRange, devices will begin to range to each other. On the Status -> Devices tab, device connectivity and synchronization status is displayed.

The status uses red exclamation points for errors, yellow triangles for warnings, and green checks for good status. For additional details, see Status Indicators.

MultiRange will not display the synchronization status; and connectivity indication is limited to Ethernet only.

If Tags were not powered during setup, they may need to be awakened prior to use. Shaking a device before use speeds up the join process; otherwise, Tags may take up to 640 seconds to join the CUWBNet.

Additional diagnostics and system status information is available in the Log tab. For more information on common Log messages, see Common Log Messages.

Next Steps

Once the CUWBNet is active and devices are online, users can start tracking objects of interest. The CUWB Manager also provides advanced tools to customize and optimize tracking performance. See the CUWB Manager Reference Manual for advanced features of the CUWB Manager and CUWB Devices.

Additional CUWB RTLS tools:

• CUWB Manager API - Automate control of system functions
• CDP Logging - Enable CDP data collection for analysis
• CUWB Viewer - Visualize and model the tracking environment in 3D

Web Interface Walkthrough

The CUWB Manager Web Interface is the GUI through which users can set up one or more CUWB Configurations. Each CUWB Configuration controls the various settings that need to be used by an associated CUWBNet instance. This section describes the different tabs and configuration options within the CUWB Manager Web Interface in detail.

The terms “CUWB Configuration” and “CUWBNet Instance” are closely related. A CUWB Configuration is the set of parameters for a particular CUWBNet, while a CUWBNet Instance refers to the active, running system.

General Controls

Bell Icon

CUWBNet Control

In the upper right-hand corner of most tabs, the stop / play button allows control of the CUWBNet. There are three modes for a CUWBNet: Running, Shutting down, and Stopped.

• Running - The CUWBNet is enabled and active. The CUWBNet is running with the settings provided by the associated CUWB Configuration. Certain settings cannot be adjusted in this state.
• Shutting down - The CUWBNet is shutting down its processes. This may take a few seconds. Settings that are unable to be set while the CUWBNet is running are not allowed to be adjusted while the CUWBNet is shutting down.
• Stopped - The CUWBNet is not running. All settings in the associated CUWB Configuration can be adjusted.

Shutting Down a CUWBNet involves ensuring all active devices within the CUWBNet return to a nominal state. The process of sending wireless UWB commands to all devices directing them to leave the CUWBNet can take several seconds.

Basic and Expert Settings View

The Configuration tabs can be set to basic and expert views. The basic mode provides a reduced set of common features that cover the majority of users. Expert mode can be enabled via the expert mode checkbox.

Basic view is recommended unless more complex settings are needed.

List Control

The CUWB Manager displays CUWBNets, devices, and notifications in list format, supporting the following controls:

• Filter & Search - Narrow displayed items by name or parameter.
• Sorting - Click column headers to sort in ascending or descending order.
• Items per Page - Item display counts can be selected from the drop down menu.
• Page Control - Includes: Fast forward to beginning of list, Previous Page, Next Page, and Fast forward to end of list

Other links

Along the top of the Web Interface are links to the CUWB.IO Documentation site and a Version Page which displays the currently available versions of the CUWB Software Package from the PPA.

The PPA version table may be invalid if the Host PC is not connected to the external internet.

CUWB Configuration

The landing page of the CUWB Manager Web Interface is a listing of all available CUWB Configurations.

Name

This is the name of a particular CUWB Configuration and the name of the associated CUWBNet instance. Spaces and other special characters are not allowed in the name field. The field is restricted to 100 characters.

Valid Naming Examples: “Warehouse_Test” or “Floor_2_Building_5”

Invalid Naming Examples: “Warehouse Test” or “Floor 2 Building 5”

Instance ID

The instance ID is a unique identifier starting with FE:xx:xxxx, that represents a CUWB Configuration and CUWBNet instance.

When using more than one CUWBNet, the instance ID can be used to filter CDP packets.

See CUWBNet Instance ID for setting a custom ID.

Status

This column indicates the CUWBNet status: stopped, shutting down, or running. See CUWBNet Control for additional detail.

Mode

Indicates the mode, MultiTime™ or MultiRange™, for the given CUWB Configuration. The dropdown selector in this column can be used to change the mode for the CUWB Configuration.

Actions

The Actions column provides controls for each individual CUWBNet. Available actions are as follows:

When first adding a new CUWB Configuration:

1. Plus Icon - Add a new CUWB Configuration
2. Upload Icon - Upload a CUWB Configuration file to a new CUWB Configuration instance

After a CUWB Configuration is Added:

3. Play / Stop Button - Start or stop the CUWBNet
4. Gear Icon - Shortcut to Device Configuration tab
5. Page Icon - Shortcut to the Summary tab
6. Copy Icon - Duplicate the CUWB Configuration to a new CUWB Configuration
7. Download Icon - Download a copy of the CUWB Configuration
8. Trashcan Icon - Delete the CUWB Configuration

Group Actions

Configuration - Devices

The Configuration -> Devices tab provides the interface for adding devices to the CUWB configuration. Here, users can input device serial numbers and configure necessary parameters needed by the system for each device.

Enabled

Toggle devices on or off in the configuration.

In MultiRange mode, Anchors and Tags can be enabled within the CUWB Configuration, regardless of whether the CUWBNet is running. In MultiTime mode, Tags can be enabled at any time; however Anchors can only be enabled when the CUWBNet is stopped. All devices can be disabled while the CUWBNet is running.

Category and Role

Devices can be configured as either an Anchor or a Tag. Anchors are static devices placed in a region of interest that act as reference points. Tags are mobile devices that are trackable in the region of interest.

When entering a new device, the device type is determined based on the device’s role. A role of Seeder, Initial Seeder, or Quiet Anchor will result in the device being recognized as an Anchor. When configuring an Anchor, the following pieces of information are required: serial number, role, and survey location. All fields must be provided by the user before the Anchor can be added to the CUWB Configuration. See Anchors for an in-depth view of the different Anchor roles.

The Initial Seeder role is only available when using MultiTime operational mode.

A role other than the ones mentioned above will result in the device being a Tag in the configuration. When configuring a Tag, the only pieces of information that are required are the serial number and role. If using Default Tag, a Tag uses a role which beacons at 10Hz.

To set a custom Tag Role, see Tag Roles.

Serial Number and Name

The serial number is the 8 digit number listed on the device, e.g., 01:12:0068, 01:23:4567.

The name is a customizable name for a particular device. The custom names configured here can be seen in the CUWB Viewer, accessed by API request, or from CDP data item 0x013f.

Wildcards for Tags

A Wildcard is a special character used in the serial number field to match an unknown digit in the serial number. Wildcards can be used to assign roles to groups of devices. A capital X can replace any character in the Tag serial number. It will wildcard that particular number.

Anchors cannot use wildcards.

Wildcards are prioritized to the most specific wildcard. Using the exact serial number is prioritized over any wildcards that the device would match.

01:12:0123 would match the 01:12:XXXX wildcard instead of 01:XX:XXXX, if both wildcards are present in the device list.

Wildcards will cause the Status -> Devices tab to display a yellow exclamation mark in the role column instead of the role name. This is due to devices potentially having different roles configured.

X, Y, and Z

These columns provide the survey location for Anchors. The survey must be entered in meters and can be specified up to three decimal places. The system supports using a period, or full stop, as the standard decimal separator.

Commas are not supported in entering X, Y, and Z location data.

Although the X, Y, and Z fields can be entered for a Tag, these values are not used by the system while the device is configured as a Tag.

Actions

When first adding a new Device:

1. Plus Icon - Add a new device to the CUWB configuration after device information is provided

After adding a Device:

2. Reset Icon - Open a menu to send a hard or soft reset command to a device on a running CUWBNet instance. A soft reset will reset the device’s CUWBNet state without rebooting. A hard reset will reboot the device.
3. Brightness Icon - Trigger LED identification sequence: solid, flashing, or serial number flash.
4. Trash Icon - Delete a device from the configuration

While editing a Device entry:

• Undo Button - Undo the last edit
• Save Icon - Save the edit(s)

Expert Mode enables the following:

• Gear Icon - Add a device setting key to a specific device. See Appendix A for additional details on available settings.

Group Actions

LED Identification

The CUWB Manager has the ability to modify device colors via the Brightness Icon. This feature is useful for identifying devices, particularly Anchors when surveying. Available options are solid color, flashing color, or serial number flash.

Solid Color

The following options are available to set devices to a solid color:

Flashing Color

The LEDs for devices can be set to a flashing pattern of 750 ms ON and 750 ms OFF. This is to help differentiate the pattern from other standard LED behaviors. See LED Pattern Section for the typical Role led patterns.

The following options are available to set devices to a flashing color:

Serial Number Flash

Serial number flash is a pattern of colors that encode the device’s serial number. This can be used to clarify Anchor serial numbers during installation.

The serial number of the device is 4 bytes long and color coded via 8 nibbles. There is a short delay between 2 nibbles and a long delay between the full 4 bytes of serial number.

Color Cheat Sheet

Additional Tab Actions and Icons

Calculator Icon

When using MultiTime mode, the calculator icon pop-ups a calculator which can be used to determine the maximum number of Tags based on a supported Tag Role in the CUWBNet or CUWB Configuration.

Plus Icon

The Plus Icon will highlight and jump to the new device entry line. This can be useful when adding large quantities of devices.

Show Unconfigured

Display serial numbers of available devices that are not currently configured in the CUWBNet.

Configuration - General

CUWBNet Instance ID

The Instance ID will auto-populate with a unique ID in the Ciholas Serial number format, e.g., FE:XX:XXXX. This ID is configurable, but must start with “FE”. The Instance ID appears in CDP output data and can be used to filter data by CUWBNet instance.

No CUWBNet can have the same instance ID as another CUWBNet within the same LAN.

Position Settings

Position settings control the globally applied smoothing mode and smoothing factor.

• Simple - is a moving average of the position data over the last number of positions as determined by the smoothing factor.
• Weighted - is an average of the last number of positions determined by the smoothing factor, weighing each position based on its quality.

Bounding Box

The bounding box values globally limit the area the location algorithm uses for calculating the position of Tag beacons. The algorithm will not allow Tags to travel beyond the configured values. These values should be configured to reasonably cover the area of interest for the Tags.

Anchors installed in a planar geometry, i.e., mounted to the ceiling, present an issue to the location engine. Such geometries can result in Tags ‘sticking’ to the plane of the Anchors. The bounding box should not include the plane of the Anchors in these cases. Alternatively, users can install Anchors with diversity in all dimensions preventing Tags from sticking to planar geometries.

When more than one Anchor is configured with X, Y, and Z survey position, the “Use Anchor Bounds” option can be used to set the bounding box to just beyond the X, Y, and Z limits of the Anchor positions. An optional minimum/maximum padding can also be added.

Troubleshooting details can be found under Planar Anchors.

Device Updates

Automatic firmware updates can be enabled or disabled. When enabled, wired devices configured as Tags or Anchors will get updated over their wired connection. For wireless devices, users can use the default setting of Auto or if using MultiTime, select an individual Anchor to be the Wireless Updating Anchor. Wireless devices configured as Tags will be updated over the air when within range of the Wireless Updating Anchor. Auto allows the CUWB Engine to select the best Anchor for wireless updates instead of using a predefined Anchor.

If an Anchor happens to be using a Tag role, the Anchor will still update over the wire and not wirelessly.

See Tag Bootloading and Anchor Bootloading for additional details and instructions.

RF Settings

Drop downs provide configurable RF settings.

Devices are region locked. Observe all local and regional regulatory restrictions for use.

The following combinations are generally available; note that not all settings are available in all regions:

Always verify regulatory region requirements and restrictions prior to use.

The Tags can only join CUWBNets that are configured to use the same RF Settings. Tags do not support all channel combinations by default. Some RF settings combinations can only be enabled on Tags by using Persistent Properties via the Device Manager.

Additional details on RF parameters, such as center frequency and bandwidth are provided in the respective device datasheets.

RF Settings in Expert Mode

Expert mode enables a user to configure the PRF and Preamble Code:

Always verify regulatory region requirements and restrictions prior to use.

Power Settings [Expert Only]

Power Settings are only available to expert users. The TX Power Reduction field reduces the devices’ transmission power between 0 and 25.5 dB. Use 0 for no reduction in transmission power.

The Low Noise Amplifier (LNA) mode is modified via the dropdown menu to Device's Settings, Enabled, or Disabled. Use device's settings for default LNA behavior.

• Device’s Settings - All devices will enable the LNA unless configured otherwise through persistent properties.
• Enabled - All LNAs will be enabled for packet receptions.
• Disabled - All LNAs will be disabled for packet receptions.

See RF Power Control Settings for additional feature details.

Unless otherwise specified by device persistent properties, the Device’s Setting default to RX LNA Enabled.

Operational Mode

The CUWB System can operate in two fundamentally different operational modes: MultiRange™, and MultiTime™. Each mode provides users with low-latency location data output and can be used for large scale deployments. MultiRange utilizes ranging beacons between each Tag and multiple Anchors to produce location data, while MultiTime utilizes timing beacons between each Tag and the Anchor array.

The default CUWBNet setting is MultiRange. MultiRange is more tolerant to survey error and generally easier to set up for small installations. Users are encouraged to experiment with both modes to determine what is right for their application.

Additional detail regarding MultiTime vs MultiRange modes and when to use them can be found in CUWB Operational Modes.

The CUWB Manager software tabs adjust dynamically based on the available settings for the selected operational mode.

LED Pattern

Use this dropdown to globally control the LED Pattern behavior for devices in the CUWB Configuration. LEDs can be configured for Device mode or Role mode.

Device Mode

When configured in Device mode the LEDs are controlled by the device firmware. LED state definitions for Device mode can be found in the respective product datasheets. Each device will have varying LED state definitions.

Role Mode

Setting the CUWB Manager LED mode to Role mode will enable the devices to flash their individual roles within the CUWB Configuration. Role mode is useful, particularly during system setup and testing, to identify device roles and configuration from the tracking area. The table below shows the colors used in this mode.

Ethernet Settings

The CUWB Manager requires three communication streams to be defined for a CUWBNet to operate. The definition of these streams are as follows:

• Configuration Stream - This stream is used for device discovery. CUWB Applications and devices periodically announce their presence on this stream. This stream will default to IP address: 239.255.76.67 and Port: 7671. The interface will match the Anchor Stream. This stream should not be modified.
• Anchor Stream - Information sent from the Anchor Array devices to the CUWB Engine.
• User Stream - Output data for User Applications to track position, configuration, status, and sensor information.

Each stream consists of three components:

• IP - The destination address for the stream
• Port - The destination UDP port for the stream

And one of the following:

• Listening Interface - The interface for listening to the Configuration or Anchor stream
• Sending Interface - The interface for emitting the User stream

The dropdown selection for Listening and Sending Interfaces are populated with the addresses of the Network Interfaces on the Host PC. The Listening Interface may also be set to Link Local to automatically match to a link-local addressed interface and the Sending Interface may be set to Default Gateway to automatically match to the default interface on the Host PC.

In Expert Mode, the dropdown selection can be manually overridden by typing in the interface.

Refreshing Network Interfaces

The Refresh Network Interfaces button will update the options listed in the dropdown menu under Listening Interfaces and Sending Interfaces. This should be used after making a change to the Host PC’s networking configuration in the operating system.

CDP Streams Defaults

The default settings for the CDP streams are recommended for users who are unfamiliar with networking concepts. If a stream is changed from the default settings, the reset button will be enabled. Pressing this button will return the IP, port, and Network Interface settings to the default for that stream.

Networking Wizard

To run a CUWBNet, the Host PC must have a network interface configured for link-local addressing connected to the Anchor chain. This interface must match what is configured for the CUWBNet’s Ethernet Settings.

The Networking Wizard guides users through the steps required for configuring both the Host PC and the CUWBNet for operation, including identifying available network interfaces and identifying potential problems in the setup.

To run the Networking Wizard, click the button labeled Networking Wizard.

The Networking Wizard is disabled while the associated CUWBNet is running.

Optional Ethernet Settings [Expert Only]

In Expert mode, additional Ethernet streams are available. They include:

• Command Stream - Sends commands that are destined for Tags from the CUWB Engine to Anchors. If a manual entry is not created, a default will be created at IP Address: 239.255.63.82 and Port: 7672. The interface will match the Anchor Stream. The user should not send any data on this stream.
• Debug Stream - Used by Anchors to publish debug CDP data for Ciholas debugging purposes. If a manual entry is not created, a default will be created at IP Address: 239.255.11.11 and Port: 1111. The interface will match the Anchor Stream. The user should not send any data on this stream.
• Data to Device Stream - Accepts CDP commands from external applications bound for CUWB Tags or Anchors.
• Duplicate streams - for Config, Anchor, and User Streams. The CUWB Engine will duplicate all traffic it receives or sends on these streams to their duplicate streams. This is primarily intended to provide more flexibility when logging or doing post analysis on these streams.

Expert mode also enables the ability to set Port and TTL values for the Config, Anchor, and User streams.

System Settings [Expert Only]

These optional expert settings allow users to enable features, adjust feature thresholds, and adjust other system settings. The UI provides a short list of available options when the key text box is selected. See System Setting Keys in the Settings Key Appendix for available settings options.

Some system keys duplicate functionality of the CUWB Manager Web Interface. Updating a setting in one location will update the same setting elsewhere. If a setting dropdown is blank, it may be due to a system key setting selecting a value not available normally in the dropdown menu.

Configuration - Schedules

This page is for configuring different roles and role parameters that impact the CUWB Configuration schedule.

In MultiTime mode, the CUWB Manager generates an air-time schedule for every Tag and Seeder listed in the CUWB Configuration. The schedule defines a dedicated timeslot in which to beacon or listen. Under Status -> Schedule, a visual representation of the CUWB Configuration’s schedule is provided for running CUWBNets. For additional information, check out the CUWB Operational Modes Application Note.

In MultiRange mode, devices transmit at arbitrary times using an Aloha protocol. There is no fixed schedule in this mode. The role parameters define the relative beacon rates.

Tag Roles

Roles consist of beacon rate definitions and other settings that can be assigned to Tags as a group. Roles can be created in the Configuration -> Schedules tab.

A user might, for example, desire to have a slow beacon rate role for a Tag that is used to track objects that rarely move and have a fast rate for other objects that move quickly through the environment.

Once a role is created, it will be available for use on the Configuration -> Devices tab under the role dropdown menu.

Name

A custom name for a Tag role must be added. Names should be descriptive enough to separate them from other roles. Two Tag roles are always available: UNCONFIGURED and DEFAULT TAG.

• Unconfigured - Tag Role assigned to devices that are not configured to participate in the CUWBNet but may still appear nearby.
• Default - Tag Role used by Tags unless another role is selected

If a Configuration is set up with unconfigured Tag slots, Anchors may initially join the associated CUWBNet as an unconfigured Tag. This will cause the Anchor to use the unconfigured Tag LED settings.

Beacon Rate

The beacon rate should be set to the desired rate for the given role.

• For basic users, the beacon rate is selectable from a drop down menu.
• For expert users, the beacon rate can either be entered in Hz or ticks when in MultiTime mode. In MultiRange mode, the beacon rate can only be entered in Hz.

A tick is an arbitrary unit used for scheduling by the CUWB system. There are exactly 97500 ticks every second. Ticks are provided as an option due to rounding errors when entering beacon rates in Hz.

Tag Count

MultiTime adds an additional column called Tag Count. The Tag Count is the maximum number of Tags that can participate in the CUWBNet simultaneously for the given role. Users should set the count to a value equal to, or larger than, the number of Tags they expect to participate in the role at any given time.

Tags can not participate in a MultiTime CUWBNet if their assigned role does not have a Tag count set. If the Tag count is too low for the number of Tags using that role, then Tags will only participate on a first come first served basis.

LED Brightness

LED Brightness can be set to Device’s Settings, On, or Off. Roles will default to Device’s Settings when first created.

• Device’s Settings - Tags follow firmware-based LED behaviors while participating in a CUWBNet. See respective product datasheets for additional information.
• Off - Tags do not display LED behaviors while participating in a CUWBNet. This effectively turns all LEDs off and could lead to confusion depending on the user’s application.
• On - Tags display LED behaviors which follow the CUWB Configuration global setting while participating in a CUWBNet.

Use the LED Off settings to achieve lower power, longer battery life, on the Tags.

User Data [Expert Only]

User data options are only available in expert mode.

The following fields become available per role:

• User Data Rate - Rate in Hz (or ticks) of expected user data delivery
• User Data Size - Size of user data in bytes
• Payload Overhead Size - Padding for user data payload in bytes, typically 5 bytes

For additional details on configuring User Data, see User Data in the CUWB Manager Reference Guide.

Actions

The following actions are available:

• Trashcan Icon - Deletes a role from the configuration.
• Undo Button - Visible when editing a role; reverts the most recent change.
• Save Icon - Saves the current edits made to the role.

Expert Mode enables the additional action:

• Gear Icon - Adds a role settings key to the selected role. Multiple keys can be added as needed. A small numerical indicator is displayed on the icon, showing the total number of settings currently applied to that role.

Anchor Roles

Anchor roles are only available when using MultiTime. All Anchors are scheduled to transmit at the same seeder rate, which can be selected from the drop down menu. Available rates are 10Hz, 20 Hz, and 40 Hz.

Selecting a rate faster than 10Hz will help the Anchor Array synchronize time more quickly, but it will do so at the cost of locates per second. In nearly all situations, 10Hz is adequate.

If using expert mode, the seeder rate can be specified by typing in a rate in either Hz or ticks.

Seeder Count

Seeder Count is the number of time slots to allocate for the Initial Seeder and Seeder Roles in a MultiTime schedule. The default value is 0, which will configure the CUWB Configuration to use the total number of devices configured with the Initial Seeder or Seeder Role when the CUWBNet starts.

If users plan to add more devices to either the Initial Seeder or Seeder Role dynamically after the CUWBNet has started, this count can be used to allocate extra time slots for those devices.

If an Anchor is configured dynamically while the Seeder Count is higher than the number of Anchors configured with the Seeder Role, it will join the CUWBNet as a Seeder. If an Anchor is configured dynamically while the Seeder Count is equal to the number of Anchors configured with the Seeder Role, it will not participate in the CUWBNet.

LED Brightness

LED Brightness can be set to Device’s Settings, On, or Off. Roles will default to Device’s Settings when first created.

• Device’s Settings - Anchors follow the firmware-defined LED behaviors while participating in a CUWBNet. See respective product datasheets for additional information.
• Off - Anchors will not display LED behaviors while participating in a CUWBNet. This setting effectively turns off all LEDs, which may cause confusion in some applications.
• On - Anchors will display LED behaviors which follow the CUWB Configuration global setting while participating in a CUWBNet.

Use the LED Off setting to prevent anchor LED patterns and illumination from interfering with environmental aesthetics.

Anchor Actions

Expert Mode enables the additional action:

• Gear Icon - Adds a role settings key to all Anchor roles. Multiple keys can be added as needed. A small numerical indicator is displayed on the icon to show the total number of settings currently applied to the role.

Configuration - Pairs

Distance Measurement from Two-Way Ranging (TWR)

In the Pairs tab under Configuration, users can configure distance measurements from individual pairs in the Anchor Array. Once configured, Distance data is reported over the User Stream in DistanceV2 CDP Packets and is calculated using TWR timing data from packets already transmitted by the Anchors. This setting does not increase UWB airtime usage and is available in both MultiRange and MultiTime modes.

Distance from TWR data can be configured using the dropdown menus, and can be configured between individual Anchors or one Anchor and all other Anchors in the Anchor Array.

MultiRange additionally supports TWR from Tag to Anchor, but MultiTime only supports TWR between Anchors.

Below are some suggested reasons a user might want to enable TWR Distance measurements:

• Survey Checking: Distances between Anchors, measured using UWB transmissions, can be compared to nominal survey distances to find errors in survey.
• Identification of LoS Issues: Distances measured between Anchors that lack LoS will be larger than their nominal surveyed distances. In general the CUWB Engine will ignore timing data between these pairs, but it may be useful to add them as blacklist pairs to improve overall time synchronization.
• Pure Distance Applications: Users may want distance measurements Anchors-to-Anchor or Tag-to-Tag for unique applications that rely solely on ranging data and don’t require time synchronization.

Blacklist Ranging Pair [Expert Only]

Only available while using MultiTime mode, this allows expert users to have the CUWB Engine ignore data between certain Anchor pairs. This can help resolve time synchronization issues caused by environmental issues or poor line-of-sight.

Mesh TWR Mode [Expert Only]

Only available while using expert settings, this mode allows users to configure distance measurement for all devices on the CUWBNet. For MultiTime, this is all Anchors. For MultiRange, this would be all devices (Tag to Anchor and Anchor to Anchor).

Enabling TWR Mesh Mode causes significant additional Ethernet traffic on the User Stream in large Anchor Arrays.

Status - Notifications

In the CUWB Manager, under Status -> Notifications, users can view any notifications that are generated while using the CUWB Manager. These include messages about changes being made to the CUWB Configuration via the API Backend and high priority messages from the CUWBNet.

Notifications are not preserved for display across Host PC reboots. The notification data is archived in the text logs.

Notification Table

Notifications displayed in this table include a timestamp of when the notification was generated, a classification, the message, and a button to mark the notification read or unread. Unread notifications will appear with a white background and read notifications will appear with a grey background.

All information level notifications will be marked as read, while warning and error level will be marked as unread.

Notification Classification

Each notification is marked with a classification level: green circles for information, yellow triangles for warnings, and red circles for warnings.

Notification Detail Panel

Clicking on a notification will open a panel at the bottom of the page. This panel contains the full message of the notification, the classification icon, timestamp and an additional button to mark read/unread.

Additional Notification Tab Controls

In addition to the normal list controls, the Notifications tab also offers the following controls:

• Show Read Messages Checkbox: When this is disabled, the display will only show notifications which have not been read.
• Mark All as Read Button: This button marks all currently received notifications as read.

The table of notifications is sortable by timestamp, classification, or message content. By default, it is sorted by timestamp with the most recent notification appearing at the top of the list.

Status - Log

In the Log tab, users can view information about the CUWBNet from the CUWB Engine at a more in-depth level than the Notifications page. Whenever any significant change occurs in the CUWBNet state, such as a new device joining the CUWBNet or timing out, a message will be printed to this log. This information can be invaluable when debugging setup issues. See Logging for a list of common log messages.

The data in the Log tab will reset if the CUWBNet is stopped and the user leaves the tab. Additionally, there is a limit to how many log messages can be displayed in the log tab at once. By default, 1000 log messages can be displayed. This amount can be modified with the Max Log Messages quantity at the top of the tab.

The Log tab’s data will reset if the CUWBNet is stopped and the user leaves the tab.

The Log tab is configured to auto-scroll as new messages are posted by default. Use the auto-scroll checkbox to enable or disable auto-scrolling.

Downloading Logs from the CUWB Manager

The Download button opens a dialog window to allow users to select a log file to download, sorted by timestamp. Each entry is timestamped with a last modified time and date. Up to 31 log files may be present for a single CUWBNet. A new log file is generated every 24 hours.

Downloading Logs directly from the Host PC

Logs are located on the Host PC at /var/log/cuwb/network.

The following logs are available:

• cuwb-manager.log - Logs UI-related errors and issues.
• cuwb-websocket.log - Logs errors and issues occurring between the backend and CUWB Engine.
• <name_of_CUWBNet>.log - Logs errors and issues specific to the selected CUWBNet. This info is displayed in the Log tab of the CUWB Manager.

Status - Devices

In the CUWB Manager, under Status -> Devices, users can view various details about the currently running CUWBNet. This section displays information for each device, including the current connectivity status, synchronization status, firmware version, battery information and IP address, if applicable.

Status Indicators

The status uses red exclamation points for errors, yellow triangles for warnings, and green checks for good status.

Connectivity Status

In MultiTime mode, the connectivity status indicates whether each device has an active wired Ethernet connection, a wireless UWB connection, or both.

In MultiRange mode, the connectivity status will only indicate if an Anchor has an Ethernet connection. Tags will display a UWB connection.

Synchronization Status

This status is only reported when using MultiTime. Synchronization status indicates whether an Anchor is Transmit (Tx) synchronized, Receive (Rx) synchronized, or both. Transmit synchronization is necessary to spread synchronization to other devices. Receive synchronization is required for contributing to Tag position calculations.

Quiet Anchors will only have Rx synchronization.

Other Status

• IP Address: If a device is connected via Ethernet, the IP address will be displayed.
• Firmware Version: Displays the firmware version number of each device in the CUWBNet.
• Battery Percentage: Displays the current battery percentage reported by the device. If this percentage is below 20%, a warning icon will appear next to the entry.

When a device is selected, a panel at the bottom of the page will display additional detailed information for the device:

Device Status Caching

This tab also utilizes caching to display the last known status from the devices. This status data includes: battery, charging and external power flags, firmware version, IP address, and a timestamp of when the device was last heard from. The cached data will persist between page refreshes, CUWBNet restart, and Host PC reboots.

When a CUWBNet is started, the data from the cache is loaded onto the Status -> Devices tab. For devices actively participating in the CUWBNet, the cached data is updated on a real-time basis.

Any data for a device that is not in the CUWB Configuration will create an unconfigured device entry in the table. If the device is not being heard from, the last heard timestamp will be displayed next to the connectivity. Clearing the cached data will remove the entry.

Clearing Cached Data

The cached data can be cleared for all devices by clicking the Clear Cache button at the top of the page.

To clear the cache for a selected device, click on the device and select the Clear Cached Data option in the detailed information panel.

Additional Device Tab Controls

In addition to the normal list controls, the Device tab also offers the following controls:

• Show Unconfigured - Toggle displaying Tags with the UNCONFIGURED Role.
• Clear Cache - This button will clear the cached data for all devices.

Status - Summary

This tab provides an overview of various CUWBNet metrics:

• Roles: Displays device counts for different device roles
• Sync: Shows the total number of devices that are Transmit (Tx) and Receive (Rx) synchronized.
• Category: Shows devices listed by category: Anchors, Tags, and Unconfigured Devices

For items displayed as a fraction, the numerator is the count of devices currently online and the denominator is the total of devices defined in the configuration.

Status - Schedule

The schedule tab is only for use with MultiTime mode. The tab is hidden in MultiRange mode.

The schedule tab displays the schedule that the system has created for the devices in a chart format with each cell giving information on what it represents. This chart is a representation of the UWB events that occur over time. The chart shows all the UWB activity that occurs over the course of one second. In this chart, time starts in the bottom-left corner and progresses up the column. After reaching the top of the column, time continues from the bottom of the column immediately to the right. The height of each column (and the total number of columns) is determined by the rate of the fastest scheduled event. For example, on a default MultiTime CUWBNet, all events will run at 10 Hz, so each column will be 100 ms long, and there will be 10 columns.

Each cell in the chart represents a single UWB transmission. Highlighting any single cell will highlight all the cells representing repeated events where that transmission is repeated in a one second window.

There are multiple types of UWB packets that are used in transmissions in the CUWB system; these different types are represented with different colors in the schedule chart. For example, the Command Window - where commands are sent to have new devices join the CUWBNet - is displayed in neon green.

Options

• Show Full Schedule - select this checkbox to expand the schedule view from displaying only the occupied time slice to showing the entire schedule.
• Units - Select the schedule to be displayed in milliseconds or ticks

Status - Location Viewer

The Location Viewer is a 2D map showing the current locations and status of network devices with a slow refresh rate. For a faster refresh rate and 3D modeling, see our standalone CUWB Viewer. Anchors are represented as squares and Tags are represented as circles. The table below shows how device connectivity and synchronization status is represented by color.

Anchors in MultiRange will appear in the viewer as an orange color, instead of green.

Inactive Tags will be removed from the plot after 5 seconds, and will reappear once new data is received.

2D Viewer Controls:

• Pan - Click and drag to pan around the plot
• Zoom - Scroll with the mousewheel to zoom in and out
• Device Selection - Click on a device to select it, highlighting it and revealing its serial number. To deselect a device, select another device or click on any empty space in the plot.

Options

• Show Serial Numbers - Toggle serial number display
• Auto-fitting - Fit all devices on the viewable plot, resizing dimensions as needed. Auto-fitting will stop when the box is unchecked or the user pans / zooms around on the plot.
• Reset View - Undo panning or zooming done by the user. This setting does not affect auto-fitting.
• Show Unconfigured - Toggle displaying Tags with the UNCONFIGURED Role.

Device Manager

The Device Manager tab allows users to issue commands to devices individually or as a group using the checkboxes. Command options include resets, enabling ship mode, setting and getting persistent properties, and getting device attributes.

The device list displays a unit’s name, serial number, connectivity, recent response, and the timestamp of the recent response. Selecting a device row will open a detailed panel of the same information with additional space for longer response messages.

The CUWBNet must be running in order to make full use of the Device Manager.

Upon pressing the Apply button, the Device manager sends commands once. Like any RF signal, UWB transmissions are susceptible to interference, so over-the-air command delivery is not guaranteed.

Some commands, like get property list, get property and get device attributes, can transfer a large amount of data over-the-air. Users should limit the amount of Tags utilizing these commands to avoid transmission failures due to lack of airtime.

Users should utilize a maximum ratio of 10 Tags to 1 Anchor to allow enough processing time for data transfer.

CUWB USB Driver and Device Manager

The Device Manager can be used in conjunction with the CUWB USB Driver allowing commands to be sent to devices that support a USB connection.

Using the CUWB USB Driver, with the Device Manager, requires a CUWBNet to be running to set Persistent Properties or retrieve Device Attributes.

Resets

Devices can be sent a reset command through the UI.

A soft reset will reset the device’s CUWBNet state without rebooting. A hard reset will reboot the device.

To reset a device:

1. Select Soft Reset or Hard Reset
2. Using the checkboxes, select one or more devices to be reset
3. Hit Apply

If the command is successful, the selected devices will reset and their respective response columns will display the following message:

Successfully reset device 12:34:5678

Ship Mode

Ship mode is a special mode for rechargeable, battery powered-devices that disconnects the battery internally to allow safe shipment. Once in ship mode the devices are not operational until they exit ship mode, which typically occurs by plugging the device into power. Devices that are in ship mode will not search for or operate within CUWBNets. See device datasheets for support and specific ship mode information.

To return a device to ship mode:

1. Select the ship mode action
2. Using the checkboxes, select one or more devices to be placed into ship mode
3. Hit Apply

If the command is successful, the selected devices’ response will display the following message and the devices will enter ship mode:

Successfully readied device 12:34:5678 for ship mode

If using the CUWB USB driver to send ship mode commands, the device will enter ship mode once removed from USB power.

Device Attributes

Device attributes are the attributes of a device that are not modifiable. These include the following:

• MAC Address for Anchors
• Maximum Beacon Rate for Tags
• RF Jurisdiction
• Enclosure Color
• Device Creation Timestamp
• Stock-keeping unit (SKU)

Get Device Attributes

The get device attributes command provides a list of all the device attributes and their values. The list output is a semicolon-separated message.

1. Select the get device attributes action
2. Using the checkboxes, select one or more devices to retrieve attributes
3. Hit Apply

If the command is successful, the selected devices’ response will display the following message:

Device 12:34:5678 has attributes: MAC address: 00:01:02:03:04:05; maximum beacon rate: N/A; jurisdiction: FCC; color: black; device creation timestamp: Tue Mar 24 2026 16:09:42 GMT-0600; SKU: AN302-K1;

Persistent Properties [Expert Only]

Persistent Properties are device properties that will persist after a device reboots. Persistent Properties are for expert users only; the default settings will work for most users.

Known Properties vs Custom Properties

Persistent Properties use a hex-based ID number. For a listing of currently supported properties, see Appendix A in the CUWB Manager Feature Reference.

Invalid Custom Persistent Properties may cause devices to malfunction.

Custom Persistent Properties can be manually entered through the device manager by selecting the custom property option from the dropdown menu using hexadecimal. Values for custom Persistent Properties should be a hexadecimal string in little Endian format.

Defined Properties may have more detailed UI messages. See Persistent Property Appendix for additional details on expected messages.

Get Property List

The get persistent property list command provides a list of all the Persistent Property IDs that a device possesses. This list output is a comma separated message.

1. Select get persistent property list action
2. Using the checkboxes, select one or more devices
3. Hit Apply

If the command is successful, the devices’ respective responses will display the following message:

Device 12:34:5678 has properties: 0x40a0,0x40a1,0x4086,0x4085

Get Property

The get persistent property command retrieves the value of the provided Persistent Property ID.

1. Select get persistent property action
2. Select the Persistent Property from the dropdown menu
3. Using the checkboxes, select one or more devices
4. Hit Apply

If the command is successful, the devices’ respective responses will display the following message:

Device 12:34:5678 has the following Search Parameters: Channel 9, PRF 16, Preamble Code 4.

Set Property

The set persistent property command sets a value for a Persistent Property ID.

1. Select set persistent property action
2. Using the checkboxes, select one or more devices
3. Select the Persistent Property from the dropdown menu
4. Select the property value from the dropdown menu or provide the property value in hex
5. Hit Apply
6. Select the Hard Reset action
7. Using the checkboxes, reselect the same devices from step 2
8. Hit Apply

If the command is successful, the devices’ respective responses will display the following message:

Set property 0x0064 for device 12:34:5678

Clear Property

The clear persistent property command will remove the value that is set for a Persistent Property ID. This will revert the setting to firmware controlled defaults.

1. Select clear persistent property action
2. Using the checkboxes, select one or more devices
3. Select the Persistent Property from the dropdown menu
4. Hit Apply
5. Select the Hard Reset action
6. Using the checkboxes, reselect the same devices from step 2
7. Hit Apply

If the command is successful, the devices’ respective responses will display the following message:

Successfully cleared property 0x0064 for device 12:34:5678

Property Command Failure

If one of the above commands fails, the following message will be displayed:

Persistent Property request for device 12:34:5678 failed.

Revision

APPENDIX A : Settings Keys

Device Settings Keys

This section describes the different optional device settings keys that can be added to a CUWB Configuration on a per device basis. These are added per device under Configuration -> Devices via the gear icon. These settings are for expert users only.

These are also called interface settings in the API documentation.

lna_mode

This device setting key specifies whether a device, while participating in a CUWBNet, will use its Low Noise Amplifier (LNA).

If this device setting is present, it will override the system and role setting of lna_mode.

position_delivery_probabilities

This device settings key specifies a comma-separated list of integer percentages that determine which position windows a particular anchor participates in transmitting position delivery packets.

rx_antenna_delay_offset

This device settings key is a signed integer that specifies the adjustment to the device’s local antenna delay for any packets received by the device. This setting key should only be used with custom hardware.

For use with custom hardware only. Do not modify without express Ciholas guidance.

tx_antenna_delay_offset

This device settings key is a signed integer that specifies the adjustment to he device’s local antenna delay for any packets transmitted by the device. This setting key should only be used with custom hardware.

For use with custom hardware only. Do not modify without express Ciholas guidance.

tx_power_reduction

This device settings key specifies for a device, while they are participating in a CUWBNet, the adjustments to their transmission power.

If this device setting is present, it will override the system and role setting of tx_power_reduction.

Role Settings Keys

This section describes the different optional role settings keys that can be added to a CUWB Configuration. These are added per device role under Configuration -> Schedules. These settings are for expert users only.

Some of these role keys duplicate functionality of the CUWB Manager Web Interface. Updating a setting in one location will update the same setting elsewhere. If a setting dropdown is blank, it may be due to a role key setting selecting a value not normally available in the dropdown menu.

If the value for the role settings key is not provided, the setting will be set to the default value.

command_window_divisor

This role settings key specifies how many command subgroups each role should have.

emit_network_time_period

This role settings key specifies the rate that a Tag will emit CDP Network Time packets 0x0149 over CSP.

lna_mode

This role setting key specifies how the LNA will be configured for devices following this role and participating in a CUWBNet.

If this role setting is present, it will override the system setting of lna_mode.

max_role_velocity

This role settings key specifies a limit used for sanity checking incoming data by the CUWB Engine. The maximum role velocity is given in meters per second and affects any tag in a given role.

The max_role_velocity should be set to 2-3x the maximum speed of tags used in the role for MultiRange and 5x the maximum speed in MultiTime. Lower values will result in less noise in output position measurement, but will also result in rejected input data and can negatively impact CUWB Engine operation if set too low.

If this role setting is present, then it overrides the System Setting of max_tag_velocity.

mr_num_anchors

This role settings key specifies the number of Anchors that should be used in the MultiRange selection algorithm for the role. The value for this setting can be lowered to save battery power on Tags by reducing UWB transmissions. Changing this value can impact the overall quality of the output location. This role key is ignored when using MultiTime.

This role settings key overrides the system settings key mr_num_anchors.

no_network_timeout

This role settings key specifies the amount of time, in seconds, before a Tag falls off the network if it has not heard any MultiRange UWB Packets. This role key is ignored when using MultiTime.

position_delivery_divisor

This role settings key enables or disables position delivery for a role.

position_delivery_smoothing

This role settings key sets the amount of smoothing for position calculations that are delivered via position delivery for a given role.

tx_power_reduction

This role settings key specifies the adjustment to the transmission power of devices following this role and participating in a CUWBNet.

If this role setting is present, it will override the system setting of tx_power_reduction.

wake_on_shake_threshold

This role settings key sets the minimum accelerometer value needed to trigger a “shake” event for the Wake-on-Shake Leave behavior. This is a positive integer value of milligravities.

wake_on_shake_timeout

This role settings key sets the time for a device to leave a CUWBNet if it has not experienced a “shake” event. Only positive values are valid.

System Settings Keys

This section describes the different optional system settings keys that can be added to a CUWB Configuration. These settings are for expert users only.

Some of these system keys duplicate functionality of the CUWB Manager Web Interface. Updating a setting in one location will update the same setting elsewhere. If a setting dropdown is blank, it may be due to a system key setting selecting a value not available normally in the dropdown menu.

If the value for the system settings key is not provided, the setting will be set to the default value.

anchor_announce_timeout

This system key specifies the time an anchor will wait to send an Anchor Announce packet for MultiRange mode.

anchor_health_report_period

This system key specifies the period, in seconds, at which the CUWB Engine should emit anchor health data items.

announce_window_period

This system key specifies the rate in ticks for the announce window for MultiTime mode. If set to 0, then the announce window will be scheduled at the same rate as the Seeder Rate.

The announce_window_period must be an even multiple of the Seeder Rate in ticks.

cdp_aggregation_network_period

This system key specifies the CDP aggregation rate for anchors. The CDP aggregation rate is how long anchors hold onto CDP data before sending. CDP aggregation collects CDP data items at the anchors and combines the items into a larger UDP packet. This can help reduce Ethernet traffic load for switches.

cdp_aggregation_mode

This system key enables or disables CDP aggregation for anchors. CDP aggregation collects CDP data items at the anchors and combines the items into a larger UDP packet. This can help reduce Ethernet traffic load for switches.

cdp_logging_enabled

This system key specifies if text log messages from the CUWB Engine will be emitted over CDP.

command_window_period

This system key specifies the rate in ticks for the command window for MultiTime mode. If provided a value of 0, then the command window will be scheduled for the same rate as the Seeder Rate.

device_timeout

This system key specifies the CUWB Engine global device timeout in seconds. The global device timeout is the number of seconds the CUWB Engine can go without hearing data from a device before it recognizes the device as timed out and starts sending it reset commands. If a device doesn’t have a specific lease or CUWBNet timeout configured, then it will use the device timeout on the device-side as well.

device_update_mode

This system key specifies how the CUWB Engine will update devices. The CUWB Engine will automatically look in /usr/lib/cuwb/device-images/ for images to use for updating devices.

This setting is also available in the CUWB Manager Web Interface under Configuration -> General tab. The Dropdown “Enabled” is the equivalent of the “auto” setting as a system key.

ignore_network_duration

This system key specifies the duration, in seconds, that unconfigured devices will ignore the CUWBNet when all unconfigured Tag slots are full.

led_mode

This system key specifies whether the LED for a device, while participating in a CUWBNet, is controlled by the device or by the role.

This setting can also be set in the Configuration -> General tab of the CUWB Manager via the LED Pattern dropdown menu.

Additional information about device-based LED behaviors can be found in the device datasheets.

lna_mode

This system settings key specifies, for all devices, if the devices use their LNA while they are participating in a CUWBNet.

This setting can also be set in the Configuration -> General tab of the CUWB Manager via the Power Settings.

log_playback_mode

This system key allows the CUWBNet to receive CDP data played back from the Host PC’s internal stream as if the data is coming from actual devices.

low_anchor_count_tracking

Enabling low Anchor count tracking allows the CUWB Engine to compute position output data when not enough Anchor data is received for good tracking. When enabled, the CUWB Engine uses a different, low-accuracy, algorithm to compute output positions any time fewer than four Anchors report beacon receptions.

By default, this setting is enabled in MultiTime and disabled in MultiRange.

max_position_calculation_delay

This system key specifies the delay between reception of initial Ping V5 CDP packet and calculation of position associated with that Ping V5 packet along with ping data received from all anchors. This setting intentionally adds delay to allow for variable latency in a user’s Ethernet LAN or when using CDP aggregation.

max_tag_velocity

This max Tag velocity key specifies a limit used for sanity checking incoming data by the CUWB Engine. The max_tag_velocity is given in meters per second and affects all Tags in the system.

The max_tag_velocity should be set to the 2-3x the maximum speed expected for Tags in the CUWBNet. Lower values will result in less noise in output position measurement, but will also result in rejected input data and can negatively impact CUWB Engine operation if set too low.

This settings key can be overridden by max_role_velocity.

max_user_data_payload_size

This system key specifies the maximum size of any extraneous commands that can be passed through the CUWBNet to devices over UWB. The max_user_data_payload_size is in bytes.

If a command larger than this max size is sent to the CUWBNet, it will be thrown away and a warning message will be printed in the text log for the CUWBNet.

mr_num_anchors

This system key specifies the number of Anchors that a Tag will range to at any given time in MultiRange mode. The value for this setting can be lowered to save battery power on Tags by reducing UWB transmissions. Changing this value can impact the overall quality of the output location.

This system settings key can be overridden by the role settings key mr_num_anchors.

position_delivery_max_positions

This system key specifies the maximum number of Tags that can receive positions from position delivery.

position_delivery_max_subwindow_positions

This system key specifies the maximum number of positions to be delivered during a position delivery transmission.

position_delivery_period

This system key specifies the rate of position reports from the Anchors.

position_delivery_windows

This system key specifies the number of position windows that exist for position delivery.

position_smoothing

This system key specifies the global amount of smoothing to be done on position calculations.

This setting can also be set in the Configuration -> General tab of the CUWB Manager via the Smoothing Factor.

position_smoothing_mode

This system key specifies the global type of smoothing algorithm used by the CUWB Engine when non-zero position smoothing is applied.

This setting can also be set in the Configuration -> General tab of the CUWB Manager via the Smoothing Factor.

Kalman Filtering is only available when using the system setting key.

transmit_anchor_status

This system key configures the CUWB Engine to emit Anchor status data items along with the Tag’s position CDP item.

Anchor status data items specify which Anchors were used, what their qualities were, and what sanity checks they failed, if any.

• If set to “false” or “none”, then Anchor status data items will not be emitted.
• If set to “true” or “position”, then the data items will be emitted and will provide the status for position data.

twr_mesh_mode

This system key is used to enableTWR mesh mode.

This setting can also be set in the Configuration -> Pairs tab of the CUWB Manager while in expert mode.

tx_power_reduction

This system settings key specifies, for all devices, the adjustment to their transmission power while they are participating in a CUWBNet.

This setting can also be set in the Configuration -> General tab of the CUWB Manager via the Power Settings.

APPENDIX B : License Terms and Conditions

APPENDIX C : Software License Attributions

    -------------------------------------------------------------------------
            GNU LESSER GENERAL PUBLIC LICENSE
            Version 3, 29 June 2007

    -------------------------------------------------------------------------

    Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/><br>
    Everyone is permitted to copy and distribute verbatim copies of this
    license document, but changing it is not allowed.

    This version of the GNU Lesser General Public License incorporates
    the terms and conditions of version 3 of the GNU General Public
    License, supplemented by the additional permissions listed below.

    0. Additional Definitions.

    As used herein, "this License" refers to version 3 of the GNU Lesser
    General Public License, and the "GNU GPL" refers to version 3 of the
    GNU General Public License.

    "The Library" refers to a covered work governed by this License,
    other than an Application or a Combined Work as defined below.

    An "Application" is any work that makes use of an interface provided
    by the Library, but which is not otherwise based on the Library.
    Defining a subclass of a class defined by the Library is deemed a mode
    of using an interface provided by the Library.

    A "Combined Work" is a work produced by combining or linking an
    Application with the Library. The particular version of the Library
    with which the Combined Work was made is also called the "Linked
    Version".

    The "Minimal Corresponding Source" for a Combined Work means the
    Corresponding Source for the Combined Work, excluding any source code
    for portions of the Combined Work that, considered in isolation, are
    based on the Application, and not on the Linked Version.

    The "Corresponding Application Code" for a Combined Work means the
    object code and/or source code for the Application, including any data
    and utility programs needed for reproducing the Combined Work from the
    Application, but excluding the System Libraries of the Combined Work.

    1. Exception to Section 3 of the GNU GPL.

    You may convey a covered work under sections 3 and 4 of this License
    without being bound by section 3 of the GNU GPL.

    2. Conveying Modified Versions.

    If you modify a copy of the Library, and, in your modifications, a
    facility refers to a function or data to be supplied by an Application
    that uses the facility (other than as an argument passed when the
    facility is invoked), then you may convey a copy of the modified
    version:

        a) under this License, provided that you make a good faith effort
        to ensure that, in the event an Application does not supply the
        function or data, the facility still operates, and performs
        whatever part of its purpose remains meaningful, or

        b) under the GNU GPL, with none of the additional permissions of
        this License applicable to that copy.

    3. Object Code Incorporating Material from Library Header Files.

    The object code form of an Application may incorporate material from
    a header file that is part of the Library. You may convey such object
    code under terms of your choice, provided that, if the incorporated
    material is not limited to numerical parameters, data structure
    layouts and accessors, or small macros, inline functions and templates
    (ten or fewer lines in length), you do both of the following:

        a) Give prominent notice with each copy of the object code that
        the Library is used in it and that the Library and its use are
        covered by this License.

        b) Accompany the object code with a copy of the GNU GPL and this
        license document.

    4. Combined Works.

    You may convey a Combined Work under terms of your choice that, taken
    together, effectively do not restrict modification of the portions of
    the Library contained in the Combined Work and reverse engineering for
    debugging such modifications, if you also do each of the following:

        a) Give prominent notice with each copy of the Combined Work that
        the Library is used in it and that the Library and its use are
        covered by this License.

        b) Accompany the Combined Work with a copy of the GNU GPL and this
        license document.

        c) For a Combined Work that displays copyright notices during
        execution, include the copyright notice for the Library among
        these notices, as well as a reference directing the user to the
        copies of the GNU GPL and this license document.

        d) Do one of the following:

            0) Convey the Minimal Corresponding Source under the terms of
            this License, and the Corresponding Application Code in a form
            suitable for, and under terms that permit, the user to
            recombine or relink the Application with a modified version of
            the Linked Version to produce a modified Combined Work, in the
            manner specified by section 6 of the GNU GPL for conveying
            Corresponding Source.

            1) Use a suitable shared library mechanism for linking with
            the Library. A suitable mechanism is one that (a) uses at run
            time a copy of the Library already present on the user's
            computer system, and (b) will operate properly with a modified
            version of the Library that is interface-compatible with the
            Linked Version.

        e) Provide Installation Information, but only if you would
        otherwise be required to provide such information under section 6
        of the GNU GPL, and only to the extent that such information is
        necessary to install and execute a modified version of the
        Combined Work produced by recombining or relinking the Application
        with a modified version of the Linked Version. (If you use option
        4d0, the Installation Information must accompany the Minimal
        Corresponding Source and Corresponding Application Code. If you
        use option 4d1, you must provide the Installation Information in
        the manner specified by section 6 of the GNU GPL for conveying
        Corresponding Source.)

    5. Combined Libraries.

    You may place library facilities that are a work based on the Library
    side by side in a single library together with other library
    facilities that are not Applications and are not covered by this
    License, and convey such a combined library under terms of your
    choice, if you do both of the following:

        a) Accompany the combined library with a copy of the same work
        based on the Library, uncombined with any other library
        facilities, conveyed under the terms of this License.

        b) Give prominent notice with the combined library that part of
        it is a work based on the Library, and explaining where to find
        the accompanying uncombined form of the same work.

    6. Revised Versions of the GNU Lesser General Public License.

    The Free Software Foundation may publish revised and/or new versions
    of the GNU Lesser General Public License from time to time. Such new
    versions will be similar in spirit to the present version, but may
    differ in detail to address new problems or concerns.

    Each version is given a distinguishing version number. If the Library
    as you received it specifies that a certain numbered version of the
    GNU Lesser General Public License "or any later version" applies to
    it, you have the option of following the terms and conditions either
    of that published version or of any later version published by the
    Free Software Foundation. If the Library as you received it does not
    specify a version number of the GNU Lesser General Public License,
    you may choose any version of the GNU Lesser General Public License
    ever published by the Free Software Foundation.

    If the Library as you received it specifies that a proxy can decide
    whether future versions of the GNU Lesser General Public License shall
    apply, that proxy's public statement of acceptance of any version is
    permanent authorization for you to choose that version for the Library.

    -------------------------------------------------------------------------
            GNU LESSER GENERAL PUBLIC LICENSE
            Version 3, 29 June 2007

    -------------------------------------------------------------------------

    Copyright © 2007 Free Software Foundation, Inc. <http://fsf.org/><br>
    Everyone is permitted to copy and distribute verbatim copies of this
    license document, but changing it is not allowed.

    This version of the GNU Lesser General Public License incorporates
    the terms and conditions of version 3 of the GNU General Public
    License, supplemented by the additional permissions listed below.

    0. Additional Definitions.

    As used herein, "this License" refers to version 3 of the GNU Lesser
    General Public License, and the "GNU GPL" refers to version 3 of the
    GNU General Public License.

    "The Library" refers to a covered work governed by this License,
    other than an Application or a Combined Work as defined below.

    An "Application" is any work that makes use of an interface provided
    by the Library, but which is not otherwise based on the Library.
    Defining a subclass of a class defined by the Library is deemed a mode
    of using an interface provided by the Library.

    A "Combined Work" is a work produced by combining or linking an
    Application with the Library. The particular version of the Library
    with which the Combined Work was made is also called the "Linked
    Version".

    The "Minimal Corresponding Source" for a Combined Work means the
    Corresponding Source for the Combined Work, excluding any source code
    for portions of the Combined Work that, considered in isolation, are
    based on the Application, and not on the Linked Version.

    The "Corresponding Application Code" for a Combined Work means the
    object code and/or source code for the Application, including any data
    and utility programs needed for reproducing the Combined Work from the
    Application, but excluding the System Libraries of the Combined Work.

    1. Exception to Section 3 of the GNU GPL.

    You may convey a covered work under sections 3 and 4 of this License
    without being bound by section 3 of the GNU GPL.

    2. Conveying Modified Versions.

    If you modify a copy of the Library, and, in your modifications, a
    facility refers to a function or data to be supplied by an Application
    that uses the facility (other than as an argument passed when the
    facility is invoked), then you may convey a copy of the modified
    version:

        a) under this License, provided that you make a good faith effort
        to ensure that, in the event an Application does not supply the
        function or data, the facility still operates, and performs
        whatever part of its purpose remains meaningful, or

        b) under the GNU GPL, with none of the additional permissions of
        this License applicable to that copy.

    3. Object Code Incorporating Material from Library Header Files.

    The object code form of an Application may incorporate material from
    a header file that is part of the Library. You may convey such object
    code under terms of your choice, provided that, if the incorporated
    material is not limited to numerical parameters, data structure
    layouts and accessors, or small macros, inline functions and templates
    (ten or fewer lines in length), you do both of the following:

        a) Give prominent notice with each copy of the object code that
        the Library is used in it and that the Library and its use are
        covered by this License.

        b) Accompany the object code with a copy of the GNU GPL and this
        license document.

    4. Combined Works.

    You may convey a Combined Work under terms of your choice that, taken
    together, effectively do not restrict modification of the portions of
    the Library contained in the Combined Work and reverse engineering for
    debugging such modifications, if you also do each of the following:

        a) Give prominent notice with each copy of the Combined Work that
        the Library is used in it and that the Library and its use are
        covered by this License.

        b) Accompany the Combined Work with a copy of the GNU GPL and this
        license document.

        c) For a Combined Work that displays copyright notices during
        execution, include the copyright notice for the Library among
        these notices, as well as a reference directing the user to the
        copies of the GNU GPL and this license document.

        d) Do one of the following:

            0) Convey the Minimal Corresponding Source under the terms of
            this License, and the Corresponding Application Code in a form
            suitable for, and under terms that permit, the user to
            recombine or relink the Application with a modified version of
            the Linked Version to produce a modified Combined Work, in the
            manner specified by section 6 of the GNU GPL for conveying
            Corresponding Source.

            1) Use a suitable shared library mechanism for linking with
            the Library. A suitable mechanism is one that (a) uses at run
            time a copy of the Library already present on the user's
            computer system, and (b) will operate properly with a modified
            version of the Library that is interface-compatible with the
            Linked Version.

        e) Provide Installation Information, but only if you would
        otherwise be required to provide such information under section 6
        of the GNU GPL, and only to the extent that such information is
        necessary to install and execute a modified version of the
        Combined Work produced by recombining or relinking the Application
        with a modified version of the Linked Version. (If you use option
        4d0, the Installation Information must accompany the Minimal
        Corresponding Source and Corresponding Application Code. If you
        use option 4d1, you must provide the Installation Information in
        the manner specified by section 6 of the GNU GPL for conveying
        Corresponding Source.)

    5. Combined Libraries.

    You may place library facilities that are a work based on the Library
    side by side in a single library together with other library
    facilities that are not Applications and are not covered by this
    License, and convey such a combined library under terms of your
    choice, if you do both of the following:

        a) Accompany the combined library with a copy of the same work
        based on the Library, uncombined with any other library
        facilities, conveyed under the terms of this License.

        b) Give prominent notice with the combined library that part of
        it is a work based on the Library, and explaining where to find
        the accompanying uncombined form of the same work.

    6. Revised Versions of the GNU Lesser General Public License.

    The Free Software Foundation may publish revised and/or new versions
    of the GNU Lesser General Public License from time to time. Such new
    versions will be similar in spirit to the present version, but may
    differ in detail to address new problems or concerns.

    Each version is given a distinguishing version number. If the Library
    as you received it specifies that a certain numbered version of the
    GNU Lesser General Public License "or any later version" applies to
    it, you have the option of following the terms and conditions either
    of that published version or of any later version published by the
    Free Software Foundation. If the Library as you received it does not
    specify a version number of the GNU Lesser General Public License,
    you may choose any version of the GNU Lesser General Public License
    ever published by the Free Software Foundation.

    If the Library as you received it specifies that a proxy can decide
    whether future versions of the GNU Lesser General Public License shall
    apply, that proxy's public statement of acceptance of any version is
    permanent authorization for you to choose that version for the Library.