--- language: "en" --- # ZeroKey Info Center * ## [Getting Started](https://infocentre.zerokey.com/articles/getting-started.md) Learn more about ZeroKey RTLS and how to get started with your system * ### [Hardware](https://infocentre.zerokey.com/articles/hardware.md) Understand how to care for and operate ZeroKey hardware * ### [Config Tool](https://infocentre.zerokey.com/articles/features.md) Use ZeroKey's Config Tool to calibrate your system and optimize positioning * ### [Troubleshooting](https://infocentre.zerokey.com/articles/troubleshooting.md) Overcome common roadblocks in your deployment * ### [Dashboard](https://infocentre.zerokey.com/articles/network-configuration.md) The ZeroKey Dashboard lets you customize your positioning system * ### [ZeroKey API](https://infocentre.zerokey.com/articles/zerokey-api.md) Connect to and understand our API * ### [Positioning Concepts](https://infocentre.zerokey.com/articles/positioning-concepts.md) The concepts behind achieving great positioning * ### [ZeroKey and Tulip](https://infocentre.zerokey.com/articles/zerokey-and-tulip.md) Integrate ZeroKey's Quantum RTLS technology with Tulip's Frontline Operations Platform. --- language: "en" --- # Adding Anchors to Expand your Starter Kit's Coverage Easily expand the coverage offered by your tracking system by adding Anchors. This guide covers the steps for adding new Anchors, configuring and recalibrating the system, and evaluating coverage once the expansion is complete. ## **Why Expand?** Adding extra Anchors to your system can be beneficial in several ways, including: **Larger Tracked Space:** Increase the size of the tracked space to include new areas within a facility or capture additional work-flow processes. **Improved Positioning:**Increases reliability in areas where performance may be affected by obstructions or environmental factors. When site conditions change and new blockages are introduced, adding Anchors may be required. **Adaptability to New Testing Requirements:**Adapt the tracking system to changes in testing conditions and scenarios by adding Anchors. ## **Installation Steps** Before starting the expansion process, walk through the tracked space to determine optimal mounting locations for new Anchors. A Mobile always requires a clear line of sight to 4 Anchors. This is referred to as the **Rule of 4** and you can learn more about it by reading the help article in our Info Center: [Anchor Placement Fundamentals](https://infocentre.zerokey.com/articles/anchor-placement-fundamentals). **Plan your Anchor Placement** * **Identify the coverage area:** Determine the area where coverage is needed. * **Consider obstructions:** Blockages within the tracked space may offer the best mounting location for Anchors. Ensure that at least 4 Anchors can always maintain a line of sight to the Mobile. ![image-20241005-001736.png](https://infocentre.zerokey.com/__attachments/a_4bbc91bc79a4bcb25a10b5e4849514ff60dcc716563fbb6e2f1b607302f32c29/image-20241005-001736.png?cb=d95ec68b7db98e6b37fea0f370503e0d) * **Ensure sufficient coverage:** Place Anchors to create overlapping coverage and minimize blind spots. In most cases, 8 Anchors will provide coverage for 120 square feet or 11 square meters. **Install the Anchors** * **Mount the Anchors**: Use the Anchor mounts to firmly attach each Anchor to walls, ceilings, or other stable structures. Power on each Universal Anchor as it is installed. When installing Power over Ethernet (PoE) Anchors, network cables and a power source like a PoE switch are required. * **Position properly:** Vary the height of the Anchors. Ensure that the transducer is pointed towards the expansion area where tracking is required. ## **New Hardware Configuration** **Add Anchors to the same RF Channel** Use the ZeroKey Config Tool to confirm that the new devices are set to the same RF channel as the existing system. Learn more about changing the RF channel to match the current system by reading the help article in our Info Center: [Changing your System's RF Channel.](https://infocentre.zerokey.com/articles/changing-your-system-s-rf-channel) * Note: The default RF channel for ZeroKey devices is set to channel 50. If the channel on your existing devices has not been modified, you can keep the default channel setting of 50. However, if you have changed the channel (e.g., to channel 74), you will need to configure the new devices to use channel 74. Ensure that appropriate listening distance is configured when expanding system coverage. The default listening distance is set to 6.17 meters. * If the tracked space exceeds this range, you will need to increase the listening distance accordingly. For more details on selecting the proper listening distance, please refer to our help article: [Selecting the Right Listening Distance with Set Max Range.](https://infocentre.zerokey.com/articles/selecting-the-right-listening-distance-with-set-ma) Once the new devices are migrated to the correct RF channel, navigate to the **General** tab in the Config Tool and click the **Start Discovery** button. Ensure that all devices are discovered before moving to the next step, then click the **Stop Discovery** button. ![image-20241005-001900.png](https://infocentre.zerokey.com/__attachments/a_6e497524c09ac67b71b99b94c6286b5ecf3fbb0b2494a2de3b139938713126d8/image-20241005-001900.png?cb=b3a2acce12030172872e27b4bf5a179b) ## **Steps for Recalibration** After adding new Anchors, recalibrate the system to integrate the new Anchors into the larger Anchor network. 1. Launch the Config Tool and navigate to **General** tab. ![image-20241005-001944.png](https://infocentre.zerokey.com/__attachments/a_ab2a2b8e30c994da7c22e802d64ac5357cdaf378cff3d0662cb8f966d7333cc0/image-20241005-001944.png?cb=61de3bfcd9aa7cf5bdea31556a7bad95) 2. Click the **Anchor Calibration** button. 3. Follow the calibration process outlined in the Calibration Wizard to synchronize all Anchors. 4. For a more detailed guide on the calibration process, please read our help article:[How to Calibrate Your Positioning System.](https://infocentre.zerokey.com/articles/how-to-calibrate-your-positioning-system) ## **Positioning Evaluation** Once the calibration is complete, start positioning to confirm that the coverage provided by the new Anchors meets the expansion requirements. **Conduct a Coverage Test** * Start positioning and use a Mobile to walk through the existing and expanded area. * Monitor the system for any inconsistencies in tracking or coverage gaps by viewing the Mobiles movement in the Config Tool's 3D Visualizer. **Evaluate Anchor Placement** * Confirm that the entire area is covered as planned and that the Anchors provide stable tracking. * Adjust or add Anchors if necessary to optimize coverage and recalibrate. **Verify System Accuracy** * Use the **Distance Measure Tool** to test the accuracy of the enlarged system. Note: To use the **Scale Check** feature: * Power on a second Mobile and place the two Mobiles 1 meter apart. * In the Config Tool, navigate to the **General** tab and click **Distance Measurement Tool**. * A new window will open, prompting you to choose **Node A** and **Node B**. * Select the first Mobile under **Node A** and the second Mobile under **Node B**. * Once both Mobiles are selected, the tool will display the distance between them in real-time. For more information, read our help article: [How to Use the Distance Measurement Tool](https://infocentre.zerokey.com/articles/how-to-use-the-distance-measurement-tool). ## **Fine-tune the Anchor Layout** If positioning improvement is required, consider adjusting the Anchor layout -- for more information on how to do this, read our help article: [Utilizing Coordinate Transformation in the Config Tool](https://infocentre.zerokey.com/articles/utilizing-coordinate-transformation-in-the-config-). --- language: "en" --- # Anchor Layouts for Starter Kits Optimize the placement of Anchors in your starter kit for maximum coverage and performance. ## **Starter Kit Coverage** The Anchors in your starter kit provide coverage for about 120m^2^, or 1300ft^2^. Every deployment space is different and using the right Anchor placement will help to produce optimal positioning results. Setting up the Anchors is a quick and easy process, and there are a few key factors that, when followed, will help to ensure the installation goes smoothly. ## **Power On the Anchors** ZeroKey offers two types of Anchors: **Power Over Ethernet (PoE)** and **Universal** . You can read more about the difference between these Anchors in our help article named [*Selecting the Right Anchor for Your Deployment*](https://zerokey-knowledge-base.scrollhelp.site/articles/selecting-the-right-zerokey-anchor-for-your-deploy). PoE Anchors leverage ethernet cabling to permanently power each Anchor, whereas Universal Anchors are battery-powered, making them a convenient and portable choice. Be sure to charge and power on each Universal Anchor before installation. To power on, quickly press and release the grey button. ## **Transducer** The transducer on every Mobile and Anchor is the point at which the measurement originates during calibration and positioning. Direct the transducer towards the tracked space when installing each Anchor. Your Universal Starter Kit includes an Anchor mount that allows you to angle the Anchor towards the tracked space. PoE Anchors are equipped with a rotatable transducer that should be pointed towards the area of interest by applying light pressure on the blue ring around the transducer. ![image-20240823-225105.png](https://infocentre.zerokey.com/__attachments/a_4a78f2d7835cc1632f2febeeb3a2fcf6518443f84ad873770b970f3f719cc4a8/image-20240823-225105.png?cb=7147c6aa4e9444cf68cd6d486a5059c8) ## **Anchor Placement** When planning your Anchor layout, it's important to remember that the Mobile should always have a **Line of Sight** (LOS) to 4 Anchors. This is called the **Rule of Four** and it's part of what helps produce such great performance from your starter kit. One way to achieve this coverage is to use a combination of wall and ceiling Anchor attachments. ![image-20240823-202502.png](https://infocentre.zerokey.com/__attachments/a_4882d1a480ac2175b9f4046bd3ca71d1fdbe1848a3647283282d972caa7d12f9/image-20240823-202502.png?cb=edf1765fe2e193f2c7ffc92b84cb5f3b) Your starter kit comes with Anchor mounts to attach each Anchor to the walls and ceiling of your deployment environment. These mounts are installed by using M3 or #4 flat-head screws or double-sided tape for temporary installation. ## **Wall and Ceiling Anchor Layout** Use the layout shown in the image below when installing the Anchors. While Universal Anchors are shown in the image, the same layout can be used for PoE Anchors as well. Point the face of each Anchor towards the tracked space. ![image-20240415-162851.png](https://infocentre.zerokey.com/__attachments/a_c3e44568e941f576f37f8fa1e3ad934276eef2dc8f7ca6bcd4d2d28d2c4f7c6d/image-20240415-162851.png?cb=2e59a3b87a3def105ac23dc630986904) The ceiling-mounted Anchors should be installed no less than 1m from each wall. Install the wall-mounted Anchors tight to each corner no less than 2m from the floor. If they can't be mounted in the corners, move the Anchor to a minimum of 80cm from each corner. ## **Tripod Attachment** If mounting on walls or ceilings isn't feasible, using tripods is a great alternative. Arrange the Anchors in a circular formation with a diameter of approximately 5.5m. Attach one Anchor to each tripod and extend them to a minimum height of 2m. Lower one tripod by 50cm. Make sure each Anchor is facing the center of the tracked space. ![UASetup 2.png](https://infocentre.zerokey.com/__attachments/a_3363021b6dec0015da1c5c0308b290eae5b537458779134c9b65745878b7778c/UASetup%202.png?cb=deb1848006208ef677d69596314ffeff) ## **Vary the Height** Whether you're attaching the Anchors to the wall, ceiling, or tripods, altering the height of at least one of the Anchors helps ensure great performance. Using a wide variety of Anchor placements creates spatial diversity into the Anchor layout. This eliminates mathematical ambiguity during calibration and positioning, and is an important element when creating your Anchor layout. ## **Avoid Blockages** If a direct LOS can't be established between the Mobile and an Anchor, reliable communication between the two cannot be maintained. If blockages are present within the deployment area, consider attaching an Anchor to the obstacle. Keep the Anchors visible and easily noticeable instead of hiding them. ![image-20240823-202820.png](https://infocentre.zerokey.com/__attachments/a_cfdb0b08c8fb8701937687ccbcc0280b85c63bb5c58c44e3fc5a0aecdc7d6b58/image-20240823-202820.png?cb=3e28ef1b95dcd2580c7e310a0948a681) ## **Steer Clear of Straight Lines** Lastly, avoid installing Anchors in long straight rows where there is no variation in vertical or horizontal mounting locations. If Anchors are installed in straight, singular lines, it's unlikely that calibration or positioning will be successful due to the limited spatial diversity. --- language: "en" --- # Anchor Placement Fundamentals Correct Anchor placement is the foundation for ensuring that your positioning system is operating as expected. Failing to adhere to the requirements outlined in this article will result in the system not functioning properly. ## **The Rule of 4** ZeroKey's positioning system requires that a Mobile maintains a continuous line of sight to at least 4 Anchors at all times. This requirement, known as the **Rule of 4**, should be the primary consideration when planning your Anchor installation. Each ZeroKey Mobile transmits an ultrasonic pulse that is detected by nearby Anchors. When the Mobile is blocked and the line of sight is broken, its position becomes less reliable. ![image-20240823-201500.png](https://infocentre.zerokey.com/__attachments/a_421892496a1921d71c32f6f57e15a2ab9198d74691921650d6d3db836d690ace/image-20240823-201500.png?cb=af4528712e7534c5b2b485e1f3859505) If the ultrasonic pulse from the Mobile is detected by more than 4 Anchors, it adds redundancy to the position update, allowing the system to report the Mobile's location with greater confidence. Installing Anchors to maintain a continuous line of sight from at least 4 Anchors ensures consistent and reliable position updates. ![image-20240823-201616.png](https://infocentre.zerokey.com/__attachments/a_1117306dfe1bf01e3b5dadc0066908d6ceca4956777ce7bebdbb7e0bea94760f/image-20240823-201616.png?cb=017408e20146d84fff0647f552b407fe) ![image-20240819-192139.png](https://infocentre.zerokey.com/__attachments/a_95197eea366f6d256ddc66e8e10991ed43f9f43f35c101a6701a8b1d480fc909/image-20240819-192139.png?cb=53dc567afcb1634e8fae9396d65aa6d7) **RULE OF 4:** A continuous line of sight from the Mobile to 4 Anchors is required at all times to maintain positioning. ## **Prioritize High Placement with a Clear Line of Sight (LOS)** When installing Anchors, choose elevated locations that provide a clear line of sight to the tracked space. This reduces blockages and ensures an unobstructed line of sight between the Mobile and Anchors. ## **Increase Anchor Density** In environments where obstacles block the line of sight to the Mobile, increase the number of Anchors to compensate for limited visibility. Consider placing Anchors on the obstacles themselves to help maintain a clear line of sight to the Mobile. ## **Spatial Diversity** Enhancing positioning performance relies on diversifying the Anchor layout. A varied Anchor placement eliminates mathematical ambiguity during the calibration and positioning process, leading to highly accurate Mobile position tracking. * Vary the height of at least one Anchor by 50 cm. * Do not install Anchors in long, straight lines. Instead, stagger their positions to increase spatial diversity. ## **Leverage Hardware Features** ZeroKey's Power over Ethernet (PoE) and Universal Anchor mounts are designed to direct coverage toward the tracked space. This added functionality helps improve coverage in areas that need extra attention. PoE Anchors are equipped with a rotatable transducer that should be pointed towards the area of interest by applying light pressure on the blue ring around the transducer. ![image-20240823-201726.png](https://infocentre.zerokey.com/__attachments/a_d8ef80ac5804fe3c2603edc3b8fe6f08e1c73f2dae2331d3dfa8fde85cb52896/image-20240823-201726.png?cb=0e0b25d2751dff634605a259547c37f2) Universal Anchors can be installed using adjustable mounts, allowing you to angle the Anchor towards the tracked space. ![image-20240823-201832.png](https://infocentre.zerokey.com/__attachments/a_517267b887f1da16af92189d6de7c44750378ff026a6ff7c4a2bbed481866f9b/image-20240823-201832.png?cb=9e81d7b9c88b385506118334a1eb38b2) --- language: "en" --- # Applying a Spatial Intelligence Platform (SIP) License Key The **Licenses** menu in the dashboard allows you to activate a license, which is essential to fully utilize the features and capabilities of ZeroKey software. Without a valid license, access to some functionalities will be limited. Licensing ensures compliance with the terms of service and helps maintain authorized usage. ## **Getting Started** Once you're logged in, navigate to the **License** tab on the left side of the screen. ## **Activating an Online License Key** Click **+ Activate Online License Key** to enter a license key provided by the ZeroKey support team. The activation process is completed online by connecting to the ZeroKey server to validate and register the key. Then, click **Submit** to apply the key directly to the system. ![image-20240826-220751.png](https://infocentre.zerokey.com/__attachments/a_3c9d1bcf4db794a742e602fc8908776adf2e607ad639cd7dc18ba95f5d6de904/image-20240826-220751.png?cb=13463491cb4659ad1a98ce84cf29051e) ## **Uploading an Offline License File** If an internet connection isn't available or you prefer a manual activation process, the ZeroKey support team will provide an offline license file. Uploading this file to the system will activate the license. Click **+ Upload Offline License File** to open a window. Under **Actions** , click **Upload License** to enter an offline license file. Then, click **Submit** to apply the key directly to the system. ![image-20240826-220817.png](https://infocentre.zerokey.com/__attachments/a_3946a5e904c7c4c7cd9e2741ed6508c350121991d150b36fdfa7e77499143840/image-20240826-220817.png?cb=db2352599aa9f333846fd6953499bb57) ## **Using the Search Bar** The search bar allows you to quickly find licenses by entering relevant keywords. This is especially useful for managing multiple licenses. Click the refresh icon to the right of the search bar to refresh the list. ![image-20240826-220918.png](https://infocentre.zerokey.com/__attachments/a_504c73fdf6c8d43dbd88aba272d0fedee47b427f8d4eeee43b978ad895ab4392/image-20240826-220918.png?cb=d05ab5a12cd494aeb5b1fb1c0c4f3f39) ## **Understanding the License Table** The table displayed in this page provides details about active licenses: * **Key:** Displays the unique license key for ZeroKey software, a distinct string of characters for each license. * **ID:** Shows the unique identifier for the license. * **Status:** Indicates if the license is**VALID** or **EXPIRED**. * **Expiry Date:** Lists the expiration date of the license. ![image-20240826-221219.png](https://infocentre.zerokey.com/__attachments/a_a74a8f6e125cec90f7eab18e3d098799019f6a589cdfddccfe0cc368a87d9c5b/image-20240826-221219.png?cb=c412ac44075bfd5bf39ce7775e07b180) --- language: "en" --- # ASP.NET Core Runtime Requirements To ensure optimal performance and compatibility with our API, ZeroKey requires the latest version of the ASP.NET Core Runtime. The minimum supported version is ASP.NET Core Runtime 7. ## **Why Upgrade to the latest ASP.NET Core Runtime?** * **Enhanced performance and security**: The latest version includes optimizations and security updates that improve API efficiency and data protection. * **Full compatibility with ZeroKey API**: Our API is built and tested on the latest ASP.NET Core, ensuring easy integration and reliable performance. * **Access to new features**: The latest version introduces new features and functionality that are designed to streamline and improve user experience when interacting with ZeroKey API. ## **Upgrading Your ASP.NET Core Runtime** If you're not using version 7 ASP.NET Core or higher, download and install the latest runtime to prevent compatibility issues. * Visit and follow the steps to download and install the latest version. ## **Confirm Your Version** Once the installation is complete, confirm the runtime version by opening the command prompt or terminal and type in the following command: `dotnet --list-runtimes` This command will display the latest installed version as: `Microsoft.AspNetCore.App 8.x.x.` Using the latest ASP.NET Core Runtime ensures that you are fully aligned with ZeroKey's API requirements. --- language: "en" --- # Browser Requirements for the ZeroKey Dashboard This article outlines the supported web browsers and settings required to run the ZeroKey Dashboard. ## **Supported Browsers** * Microsoft Edge - v90 or later * Google Chrome - v90 or later ## **Unsupported Browsers** * Mozilla Firefox Mozilla Firefox is not supported. Users attempting to access the ZeroKey Dashboard with Firefox may experience unexpected behavior or degraded functionality. ## **Browser Configuration** Please ensure the following configurations are enabled in your browser: * **JavaScript -**The Dashboard relies on JavaScript for core functionality, including real-time data visualization and user interactions. * **Cookies -**The Dashboard uses cookies for session management and user authentication. * **Pop-Ups -**Certain features, such as report generation and external links, may open in new windows. * **Hardware acceleration -**Required for improved rendering performance, particularly when viewing the 3D visualization features. ## **Enable Hardware Acceleration** * **Google Chrome** -- Navigate to Settings -\> System and enable "Use graphics acceleration when available". * **Microsoft Edge** -- Navigate to Settings -\> System and Performance and enable "Use graphics acceleration when available". ## **Troubleshooting** If dashboard performance is degraded, the following troubleshooting steps should be attempted before contacting the ZeroKey Support Team. **Clear Browser Cache and Cookies** * Cached data may cause display or login issues after software updates. **Network Restrictions** * Firewalls or proxy servers may block required connections. Contact your network administrator if WebSocket connections are restricted. **Browser Version** * Ensure your browser meets the minimum version requirements listed above for either Microsoft Edge or Google Chrome. **Windows Power Settings** * Accessing the ZeroKey Dashboard from a mobile device such as a laptop running on Battery Power can automatically disable Hardware Acceleration which can cause degraded functionality. ## **Capture Browser Console Logs** When contacting ZeroKey support, you may be asked to provide browser console logs. These logs contain diagnostic information that can help identify the cause of an issue. To access and save console logs: 1. Open the ZeroKey Dashboard in your browser. 2. Press **'F12'** or **'Ctrl + Shift + I'**to open Developer Tools. 3. Select the Console tab. 4. Reproduce the issue. 5. Right-click anywhere in the console output and select Save As to export the log as a text file. 6. Attach the saved file to your support request. --- language: "en" --- # Calibration Technique The calibration process for the ZeroKey QRTLS is an important step in achieving outstanding positioning performance. Follow the requirements closely and read our article [Calibrate Your System with the ZeroKey Calibration Wizard](https://infocentre.zerokey.com/articles/how-to-calibrate-your-positioning-system) for information about using the ZeroKey Config Tool during the calibration process. Check out the calibration segment in our [Starter Kit Set Up](https://vimeo.com/1024927424?share=copy#t=3m18s) video for a quick overview of what the calibration looks like. ## **Calibration Requirements** ### **Mobile Placement** Start the calibration with the Mobile on the ground in the tracked space. * Ensure the Mobiles starting position offers a line of sight to a minimum of four Anchors. * Placing the Mobile on the ground establishes the Z: 0.00000 coordinate. * Once the Mobile is on the ground, step away from it to avoid blocking its line of sight. ### **Before Picking up the Mobile** Once the calibration starts, wait a moment for the data collection to begin before picking up the Mobile. * The ZeroKey Calibration Wizard will report an increased percentage of data collection for nearby Anchors once the calibration begins. * Before picking up the Mobile, confirm that you're seeing an increase in the data collection. ### **Mobile Handling** Hold the Mobile in your outstretched hand at shoulder height and remain in-motion throughout the calibration process. * Once you've picked up the Mobile, extend it away from your body. This ensures that the Mobile maintains a clear line of sight to the Anchors. * Try to limit the Mobiles movement in the Z axis during this time. * Read our help article about [Mobile Handling During Calibration](https://infocentre.zerokey.com/articles/wip-needs-imagery-mobile-handling-during-calibrati) for more information. ### **Reduce Blockage** Avoid blocking the Mobile with your body. Keep the Mobile between you and the center of the tracked space. * Hold the Mobile with the hand closest to the center of the tracked space. This increases its visibility to the Anchors. ### **Know Your Path** Navigate throughout the entire tracked space. Vary your path continuously as you walk inside the perimeter and through the interior of the area. * Avoid repeating your path and introduce a variety of position data from the Mobile by covering the entire tracked area. ### **Anchor Percentage Top-Up** As the data percentage for each Anchor nears completion, note any Anchors that require additional calibration. * While keeping the Mobile in motion, stay in the vicinity of those Anchors until 100% data quality is achieved for all Anchors. * Create a Device Map to help you understand where each Anchor is located. Read our help article on [Creating a Device Map](https://infocentre.zerokey.com/articles/getting-started) for more information. ### **Finalize Calibration** Once 100% data quality is achieved, you may continue walking through the space for an additional 10-30 seconds. * While this step is optional, extending the duration of the calibration will provide more data for system processing. ### **Finishing Position** Place the Mobile on the ground within the tracked space before moving the next step in the calibration process. * Once Step 4 of the ZeroKey Calibration Wizard is in progress, pick up the Mobile to ensure that it isn't damaged or lost. --- language: "en" --- # Care and Maintenance for Dot Mobile ## **Battery** Each Dot Mobile (QTM-DMC10) contains a coin cell battery. Here's what you need to know about replacing the single-use battery: * **Battery life**: The device can operate up to 96.5 weeks using an ultra-compact coin cell battery (2032). * **Battery replacement**: * Remove the panel on the back of the device by rotating it counter-clockwise. * Insert the battery with the positive side facing up. * Secure the panel by rotating it clockwise. ![Dot.47-20240911-164743.png](https://infocentre.zerokey.com/__attachments/a_bc92ae8bf65402a2d6eb37224dbc02b0027d892d0e4770dd78d2a944d7d15737/Dot.47-20240911-164743.png?cb=ab493fcc40e588ce34962be1889a0c71) QTM-DMC10 ## **Repairs and Disposal** Devices that are damaged or fail to operate can be returned for repair or replacement, with the following considerations: * If the battery is physically compromised or found defective, remove the battery before shipping the device back to ZeroKey. * If the device is intact but has stopped functioning, it can be returned via an RMA request. To start the replacement process, contact ZeroKey at the following email address: **support@zerokey.com**. ## **General Care** Clean each device using a moistened soft cloth and nonabrasive hand/dish soap. Do not immerse the device in water, as it will damage the internal components and render the device inoperable. Wipe dry to prevent moisture buildup. Each device operates effectively within a temperature range of -20°C to 60°C ambient. Avoid placing a device in direct sunlight for extended periods without proper ventilation, as it may exceed the 60°C temperature limit. --- language: "en" --- # Care and Maintenance for Universal Devices ## **Charging** Each Universal Anchor (QTM-UAR10) and Mobile (QTM-UMR10) contains a rechargeable lithium-polymer battery. Here's what you need to know about charging: * **Charging time**: Each device takes 5 hours to fully charge. * **Power**: Only use the supplied charger and cable to recharge the device. Use of another charger could cause damage or impair the device. * **Indicator**: While charging, the LED indicator will remain red and will turn off when charging is complete. * **Temperature monitoring**: The device will only charge in an ambient temperature between 0°C and 45°C. ![image-20240823-203023.png](https://infocentre.zerokey.com/__attachments/a_31c3f8b3ee438f0264cb20359f4e433d6b576690b1b90d75becd04f92e6aedf7/image-20240823-203023.png?cb=11d5102011b85c3ce8696c2f20ec9385) QTM-UAR10 and QTM-UMR10 ## **Repairs and Disposal** Devices that are damaged or fail to operate can be returned for repair or replacement, with the following considerations: * If the battery is physically compromised or found defective, the device cannot be legally shipped by any carrier. * If the device is intact but has stopped functioning, it can be returned via an RMA request. To start the replacement process, contact ZeroKey at the following email address: **support@zerokey.com**. ## **General Care** Clean each device using a moistened soft cloth and nonabrasive hand/dish soap. Do not immerse the device in water, as it will damage the internal components and render the device inoperable. Wipe dry to prevent moisture buildup. Each device operates effectively within a temperature range of -20°C to 60°C ambient. Avoid placing a device in direct sunlight for extended periods without proper ventilation, as it may exceed the 60°C temperature limit. --- language: "en" --- # Care and Maintenance for Wristband Mobile ## **Charging** Each Wristband Mobile (QTM-DWR10) contains a rechargeable lithium-polymer battery. Here's what you need to know about charging: * **Charging time**: Each device takes 4 hours to fully charge. * **Power**: Only use the supplied charger and cable to recharge the device. Use of another charger could cause damage or impair the device. * **Button/LED Indicator**: While charging, the LED indicator will remain red and will turn off when charging is complete. * **Temperature monitoring**: The device will only charge in an ambient temperature between 0°C and 60°C. ![Wristband-band 5 NS copy-20240911-164411.png](https://infocentre.zerokey.com/__attachments/a_c7be1f6b224bae65a9375dc39b79f02448395519eb763cd7f388c639ae9967f9/Wristband-band%205%20NS%20copy-20240911-164411.png?cb=3abee9be4ab50b194aab112ab2760d1c) QTM-DWR10 ## **Repairs and Disposal** Devices that are damaged or fail to operate can be returned for repair or replacement, with the following considerations: * If the battery is physically compromised or found defective, the device cannot be legally shipped by any carrier. * If the device is intact but has stopped functioning, it can be returned via an RMA request. To start the replacement process, contact ZeroKey at the following email address: **support@zerokey.com**. ## **General Care** Clean each device using a moistened soft cloth and nonabrasive hand/dish soap. Do not immerse the device in water, as it will damage the internal components and render the device inoperable. Wipe dry to prevent moisture buildup. Each device operates effectively within a temperature range of -20°C to 60°C ambient. Avoid placing a device in direct sunlight for extended periods without proper ventilation, as it may exceed the 60°C temperature limit. --- language: "en" --- # Change the Messaging Frequency for Location Updates in MQTT Configure the MQTT settings in the dashboard. Establish an MQTT connection and adjust the update rate of messaging frequency. ## **Step 1: Accessing the MQTT Settings** Start by navigating to the **MQTT Settings** tab, located under the **Integration** tab in your ZeroKey dashboard interface. Once there, delete or disconnect any existing MQTT connections to avoid conflicts. Then, proceed with creating a new connection. Please note that each MQTT broker can only support one connection at a time for managing message frequency. ## **Step 2: Looping Raw Location Data** * In the **Add Connection**window, provide the following details: * **Host\*:**Enter the IP address of your broker. * **Port\*:** Enter *1883* as the port number. * **Topic Title\*:** Enter the topic name you configured for your MQTT broker. * **Username/Password:** Not required unless they were previously set up in an MQTT broker. * **TLS:** Leave this at **No**. Next, add a filter to ensure only the correct messages are transmitted**:** * In the **Filter** section, leave the **Filter Template** dropdown selection set to **-- None --**. * In the **Selector\*** field, enter *Type* **.** * In the **Match\*** field, enter *LOCATION_FILTER_UPDATE* **.** * Ensure that **Type\*** is set to **string**to filter string-based messages. * Leave the **Invert** box unchecked. Once complete, click **Submit** to apply the settings. ## **Step 3: Adjusting the Quality of Service Settings** After the MQTT settings are configured, you will need to updateadditional settings to control the message rate. Follow the steps below: 1. Go to the **Quality of Service** section in the **Integration** tab. 2. Enable the **Rate Limit** setting. 3. Set the **Message Rate** to your desired value (between 1 and 20). 4. Leave Batch Messages set to **No**. Only the most recent update messages are required. Save your configuration by clicking the **Submit** button. ## **Message Rate** The following video displays the output given by the system if **Message Rate** is set to 1 Hz. [1Hz Update Rate.mkv](https://infocentre.zerokey.com/__attachments/a_3867f58e9094f7ba5d8dbf28f22522ae1f5e78e1977ec5104ae63946ac5209ee/1Hz%2520Update%2520Rate.mkv.md) 1Hz Update Rate The next video displays the output given by the system if **Message Rate** is set to 20 Hz. [20Hz Update Rate.mkv](https://infocentre.zerokey.com/__attachments/a_4cf63bceb200d56f0070596247b070818463c1a9ed8eb3a3d51d33e9bc18665e/20Hz%2520Update%2520Rate.mkv.md) 20Hz Update Rate --- language: "en" --- # Changes in the Mobile Body Frame from Quantum RTLS 1.0 to 2.0 ## **The Old Quantum RTLS 1.0 Body Frame Definition** The body frame of the Mobile was oriented with the button pointing in the direction of the positive Y-axis and the positive X-axis pointing straight ahead when the Mobile was held with the ZeroKey name facing correctly. ![image-20240823-223915.png](https://infocentre.zerokey.com/__attachments/a_18a2d7fcc59d0c43f96f57de9cfc6e12edfddfa4ca935fd507d2a42c5ff8bf8c/image-20240823-223915.png?cb=5705403c0e092a4733c94a86be4312c8) ## **The New Quantum RTLS 2.0 Body Frame Definition** To simplify the identification of the axes for the Mobile Body Frame, the definition has been updated starting with firmware version 2.0.0. Now, the button indicates the positive X-axis direction, and the USB port indicates the positive Y-axis direction. ![image-20240823-224003.png](https://infocentre.zerokey.com/__attachments/a_1bec8ef3316ee24c311718b4d4d3bb83162caa8bdab7708f7792722a88e15ce3/image-20240823-224003.png?cb=e261371fd4d4acac29f3f874f4c9653c) --- language: "en" --- # Changing your System's RF Channel ## **Radio Frequency (RF) Channels** ZeroKey hardware operates within the 2.4 GHz ISM radio band for communication between devices. To prevent interference among competing devices, it is important to establish clear transmission paths between Anchors, Mobiles, and Gateways. Channels 2 to 81 are available for system operation, and the positioning system can be configured to use the clearest channel recommended by the system. ### **Channel Scan** In the ZeroKey Config Tool, located under the **Wireless Settings** tab, the **Channel Scan** feature allows you to use the Gateway to survey the RF environment. The system will then provide a recommended RF channel for system operation. This helps to ensure clear communication between all ZeroKey hardware. ![image-20240719-224055.png](https://infocentre.zerokey.com/__attachments/a_84bb23be4a156de5fe915409e4981fcb101b95c7ebf1e2fe89da2c6524ee674e/image-20240719-224055.png?cb=b3daef2f3b2b7dd3c45f8752e9c100fc) To run the **Channel Scan**: 1. Ensure the Gateway is connected to your PC. Connect it in the Config Tool using the dropdown menu in the top-right corner. Select the Gateway and click **Connect**. 2. Navigate to the **Advanced** tab, click **Channel Scan**, and wait for the scan to complete. The scan should only take a few seconds. 3. The system will recommend an RF channel based on the surveyed RF data. This output will look like the following: `[2024-03-10T19:48:12.9455] COM29: |I| scan_all_channels: Recommended channel: 77 with average noise RSSI over -80 dBm: 0.55%` 4. In this scenario, the system recommends RF channel 77 as the optimal choice for RF communications. Although running the scanning process multiple times may yield different channel recommendations, it's advisable to take note of each recommendation. If a channel is recommended more than once, it's best to use that channel. ## **Connected Node Channel Change** Connect each Anchor, Mobile, or Gateway to your PC for direct RF channel configuration. The**Connected Node Channel Change** feature allows you to select your preferred RF channel for the connected device. Use the recommended channel from the **Channel Scan** steps to determine the best channel for system operation before starting this process. 1. Connect a device to your PC using a USB cable and connect it in the Config Tool using the dropdown menu in the top-right corner. Select the device and click **Connect**. 2. Enter the recommended channel in the text field and click **Connected Node Channel Change**. 3. Disconnect the device and repeat step 2 for every remaining device to ensure that all hardware is operating on the same channel. 4. Connect the Gateway and navigate to the **General** tab. Click **Start Discovery**. 5. Allow the discovery process to run and confirm that all expected Anchors and Mobiles are announcing. 6. Click **Stop Discovery**. ## **Reset Connected Device Channel** The RF channel on ZeroKey hardware can be reset to the firmware default settings. This default channel is channel 50. 1. Connect a device to your PC using a USB cable and connect in the Config Tool using the dropdown menu in the top right corner. Select the device and click **Connect**. 2. Click **Reset Connected Device Channel**. 3. Disconnect the device and repeat steps 1 and 2 for each remaining device. 4. Connect the Gateway and navigate to the **General** tab. Click **Start Discovery**. 5. Allow the discovery process to run and confirm that all expected Anchors and Mobiles are announcing. 6. Click **Stop Discovery**. --- language: "en" --- # Commonly Used Terms with ZeroKey's QRTLS This guide provides clear definitions of commonly used terms within the context of ZeroKey's Quantum RTLS. ## **Anchor** A ZeroKey device that is a stationary reference point for localizing the Mobile. *For more information, consult our Info Center article:* [*Select the Right ZeroKey Anchor for your Deployment*](https://infocentre.zerokey.com/articles/selecting-the-right-zerokey-anchor-for-your-deploy) ### **Anchor Density** The quantity of Anchors deployed in a specific environment to provide reference points for localizing Mobiles. *For more information, consult our Info Center article:* [*Anchor Placement Fundamentals*](https://infocentre.zerokey.com/articles/anchor-placement-fundamentals) ### **Anchor Layout** The arrangement or configuration of Anchors within a tracking environment. *For more information, consult our Info Center article:* [*Anchor Layouts for Starter Kits*](https://infocentre.zerokey.com/articles/anchor-layouts-for-starter-kits) ### **Application Programming Interface (API)** The software middleman that enables communication between two applications. *For more information, visit our API guide:* ### **Calibration** The process by which the ZeroKey Anchors, a ZeroKey Mobile, and a ZeroKey Gateway communicate to define a coordinate system. *For more information, consult our Info Center article:* [*How to Calibrate your Positioning System*](https://infocentre.zerokey.com/articles/how-to-calibrate-your-positioning-system) ### **COM Port** A hardware interface that enables connection to external devices for data transfer. ### **Config Tool** The ZeroKey GUI that is used to calibrate and operate the Quantum RTLS system. *For more information, consult our Info Center category:* [*Config Tool*](https://infocentre.zerokey.com/articles/features) ### **Coordinate Transformation** The process of converting the coordinates in a map from one coordinate system to another through rotation or scaling. *For more information, consult our Info Center article:* [*Utilize Coordinate Transformation in the Config Tool*](https://infocentre.zerokey.com/articles/utilizing-coordinate-transformation-in-the-config-) ### **Daisy Chain** Daisy chaining involves connecting multiple devices in a sequence, allowing for shared power and communication. In ZeroKey's ecosystem, Power over Ethernet (PoE) Anchors are connected using the daisy chain method. ### **Device Firmware Update (DFU)** The hardware state whereby the ZeroKey Anchor, Mobile, or Gateway enter a pairing state, ready to receive a firmware update. ### **Device Log** The output from all calibration and positioning data as well as configuration and settings information from each device. ### **Device Map** A detailed plot depicting the location of each Anchor within a tracked space. Each Anchor location is labelled with the corresponding Anchors MAC address. *For more information, consult our Info Center article:* [*Creating a Device Map*](https://infocentre.zerokey.com/articles/creating-a-device-map) ### **Discovery** The proprietary process by which ZeroKey Anchors and Mobiles are brought out of a battery saving dormant state into an active state using Radio Frequency (RF) communication. ### **Distance Measurement Tool** The interface embedded in the Config Tool that enables the measurement of the distance between two Mobiles within a tracked space. *For more information, consult our Info Center article:* [*How to use the Distance Measurement Tool*](https://infocentre.zerokey.com/articles/how-to-use-the-distance-measurement-tool) ### **Firmware Update Tool** The ZeroKey GUI that is used to apply firmware updates or downgrades to ZeroKey Anchors, Mobiles and Gateways. *For more information, consult our Info Center article:* [*Updating and Downgrading ZeroKey Firmware*](https://infocentre.zerokey.com/articles/updating-and-downgrading-zerokey-firmware) ### **Gateway** The ZeroKey device that acts as a communications link between Anchors and Mobiles and transmits calibration and positioning data through a wired connection. ### **Home Run** A direct wiring method where a single cable runs directly from a power source to an Anchor. ### **INS Fusion** The process of combining ultrasonic and inertial measurement data to achieve higher quality position accuracy ### **Line of Sight (LOS)** A straight line along which a Mobile has an unobstructed view to an Anchor. *For more information, consult our Info Center article:* [*Anchor Placement Fundamentals*](https://infocentre.zerokey.com/articles/anchor-placement-fundamentals) ### **MAC Address** A MAC address is a unique code assigned to a device's network interface for identifying it on a network. ### **Mobile** A ZeroKey trackable device in the form of a Universal Mobile, Wristband, Dot or Wearable Tag. *For more information, consult our Info Center article:* ### **Mobile Body Frame** The body frame is an orthogonal axis set which is aligned with the roll, pitch, and heading axes of the carrier where the IMU is mounted. *For more information, consult our Info Center article:* [*Mobile Body Frame in the ZeroKey Quantum RTLS*](https://infocentre.zerokey.com/articles/mobile-body-frame-in-the-zerokey-quantum-rtls) ### **Multipath** Refers to signals reaching a receiver via multiple paths due to reflection or scattering. ### **Power Allowance** The maximum permitted electrical power for a device. ### **Power Source** The central point where electrical power is distributed to Anchors such as a power injector or PoE switch. ### **Range** The distance calculated between a Mobile and an Anchor. ### **Solve** The Anchor coordinate system produced by the Config Tool based on data collected during calibration. ### **Terminal Input** The text input line in the Config Tool or any USB serial terminal. ### **Transducer** A mechanical device that generates sound waves from electrical energy. ### **Ultrasonic Pulse** A vibration that is generated when an electric current is applied to a transducer that produces a frequency greater than 20 kHz. ZeroKey devices produce a 50 kHz pulse. --- language: "en" --- # Conducting RF Scans to Find a Clear Channel Conduct radio frequency (RF) scans to optimize ZeroKey's wireless communications, ensuring minimal interference and maximum performance. RF scans involve scanning a range of frequencies to gather data on signal strength and noise levels. You can complete these steps at any point in time, whether it's before or after calibration or positioning. ## **Initiating the RF Scan** 1. Connect a Gateway to your PC and connect it in the Config Tool. 2. In the Config Tool, click on the **Advanced**tab. 3. Click on **Channel Scan** to begin scanning across RF channels. ![image-20240823-211609.png](https://infocentre.zerokey.com/__attachments/a_595530c034757f54653df686477da18ba888273ad3524b6e001cdc35a4259c2c/image-20240823-211609.png?cb=3a53658c766735e360826c713980be67) ## **Finding the Recommended Channel** 1. After the scan, check the **Device Log** for the recommended channel suggested by the system. The entry should look similar to the following: `scan_all_channels: Recommended channel: 75 with average noise RSSI over -80 dBm: 0.02%` 2. In this instance, channel 75 is identified as the recommended channel, indicating that the system identified it as the least congested among all scanned channels. --- language: "en" --- # Configure the Ethernet Ports on the Edge Compute Device (ECD) Establish a connection between the ZeroKey Edge Compute Device (ECD) and a company network using basic network configuration in the ZeroKey dashboard. Proper setup ensures efficient management and network continuity. ## **Dashboard Log In** Before starting your ECD network configuration, log in to the dashboard. For more information about logging in, visit our help article [Logging into the ZeroKey Dashboard](https://infocentre.zerokey.com/articles/logging-into-the-zerokey-dashboard). ## **Network Settings Menu** Access all ECD **Network Settings** under the **System** tab in the dashboard. ## **Ethernet Ports** The ethernet ports are located on the backside of the ECD. In the dashboard the **Ethernet Port** menu allows you to configure each port: **Standard Ethernet Port:**This port is reserved for the ZeroKey Anchor network connection. **Ethernet Port 2.5G:**This port is reserved for the company network connection. ## **Network Configuration** **DHCP Mode:** Automatically assigns IP addresses and subnet masks via the DHCP server (usually the router). This makes DHCP Mode ideal for environments that require dynamic IP allocation. **Static Mode:** This mode requires that you manually input an IP address and subnet mask according to the network's requirements. This makes Static Mode useful for networks with fixed IP address ranges. ## **Recommended Settings** **Ethernet Port 2.5G:** Set to DHCP mode for a dynamic IP assignment when connected to the company network. **Standard Ethernet Port:** Configure as the DHCP server with a static IP to manage local devices, allowing connected devices (e.g., PoE Anchors) to automatically receive IP addresses. Ensure the assigned IP is not the same as the company network. --- language: "en" --- # Configuring MQTT Settings Configure and save a new connection to the MQTT broker. ## **Adding a New Connection** In the ZeroKey Dashboard, navigate to the **Integration** tab and click **MQTT Settings** . Then, click the **+ Add Connection** button on the top right corner of the page. ![image-20240823-214546.png](https://infocentre.zerokey.com/__attachments/a_ec03cd6aeceff12341b72901face85ee319d093a190cbb2f4fd1f591e96f20b4/image-20240823-214546.png?cb=2be98ab4bfcca8e3cd341c5996b2424f) A window will then pop up, prompting you to enter the following details: 1. **Host (required):** * Enter the hostname or IP address of the MQTT broker. 2. **Port (required):** * Enter the port number in which the MQTT broker is listening. The default MQTT port is 1883. If you're using TLS, which is encrypted traffic, the default port is 8883. 3. **Username (optional):** * Enter your username if the MQTT broker requires authentication. If authentication is not required, leave it blank. 4. **Password (optional):** * Enter the corresponding password. 5. **TLS (optional):** * Select**Yes** if the connection is secured using TLS. Otherwise, select **No** . Note: If TLS is required, ensure to use the default port (1883) to successfully establish a connection. 6. **Topic (required):** * Enter the MQTT topic that this connection will subscribe or publish messages to. 7. **Filter (required):** * When setting up a new connection, you can define advanced message filtering rules to process only specific data based on the requirements. The filtering rules utilize selectors and matching criteria. 1. Under **Filter Template** , you can select a predefined template to automatically configure filters based on the most used by other users. If you want to select one of the predefined templates, click the dropdown menu under **Filter Template** and select one of the predefined rules. If you prefer to set your own rules, select **None**. 2. The **Selector** defines the criteria of the message that will be checked by the filter. 3. The **Type**allows you to choose between string (the filter will look for a specific string within the data) and regex (the filter will apply regular statements to the message content to determine matches). 8. **Add Child:** * This function allows the ability to add more filter criteria to the current filter. 9. **Add Filter:** * This function allows the ability to add the defined filter to the connection settings. 10. **Add Topic:** * This function allows the ability to add more topic fields to enable the connection to handle multiple topics at once. After filling out the required fields, click the **Submit** button located on the bottom right corner. ![image-20240823-214654.png](https://infocentre.zerokey.com/__attachments/a_bfae1ac37e89f61551549ad25a44dedfe4fe5b4b9e14070648677694fb622d33/image-20240823-214654.png?cb=70189a1dba5184ae15b6dc73fe35996e) You will then see the connection added in the **MQTT Settings** tab. ![image-20240823-214752.png](https://infocentre.zerokey.com/__attachments/a_50ebc86403563f622c1cc5b206bbfdefeb1f7451028b2d0494cba2c2b8b7441e/image-20240823-214752.png?cb=90fe2ab22388205f7d2f35451def3a2a) ## **Connection Management Options** After successfully adding an MQTT connection, you can either edit or delete the entry. ### **Editing the Connection:** * To adjust the current MQTT settings, click the pen icon located to the right, as shown below. ### **Deleting the Connection:** * To delete the connection, click the bin icon -- also shown below. * A confirmation prompt will pop up to ensure that removal is intentional. Click**Cancel** to abandon the deletion process and **Confirm** to permanently delete the connection. ![image-20240823-222239.png](https://infocentre.zerokey.com/__attachments/a_8b49ef38d41aa99ddbd12cb1b51cc521d0a0226539a0092d5f28fd5806c9fd7c/image-20240823-222239.png?cb=29d7cf83fa6de4a20f8375c12b42ffdc) --- language: "en" --- # Connecting to the Edge Compute Device (ECD) The Edge Compute Device (ECD) can be configured to support different networking requirements. Connect wirelessly or add the ECD to your wired network. ## **Connecting to the ECD through AP Mode** Your ECD comes preconfigured to connect using AP mode. ![image-20241025-164903.png](https://infocentre.zerokey.com/__attachments/a_ec3748356567a30851cd4d51723cf65ad50c11851205163fcc779f61481d9a4a/image-20241025-164903.png?cb=aa70b59e74c086b61a5d298043306dd1) When AP Mode is enabled, the ECD broadcasts a dedicated wireless network that your PC can connect to directly. Note that when your PC is connected to the ECD via AP mode, it will lose access to all other networks, including the internet. **Connection Steps** Once the ECD is powered on, AP mode will be enabled by default, and it will begin broadcasting the wireless network identified by the SSID. ![image-20240830-192842.png](https://infocentre.zerokey.com/__attachments/a_6ff52e354c61a3db0f6c1ecf9174e36b120db17420c44b3e43970dc86330bf20/image-20240830-192842.png?cb=45d67acaf36497bafac6849461a9216d) 1. Navigate to the Wi-Fi settings on your PC. 2. Locate and select the network broadcasted by the ECD, ***QuantumRTLS*** . Note that the serial number of the ECD follows the ***QuantumRTLS*** in the network name. 3. Enter the password ***SpatialIntelligence***. **Navigating to the Dashboard Log-In** 1. Open a web browser. 2. Enter the following address: ***https://\.edge.zerokey.com*** Replace ***\*** with the serial number of your ECD. ## **Connecting the ECD to a Network** The ECD provides flexibility with two Ethernet ports: a standard port and a 2.5G Ethernet port. Select the port that best meets your network needs. ![image-20240823-223725.png](https://infocentre.zerokey.com/__attachments/a_684c42056a0112a31e23973dc3bf7441a317dbedfc4650784c4331c684359c8b/image-20240823-223725.png?cb=e0a3afb341ea345dde8afd6bb59686c6) **Connection Steps** 1. Choose the Ethernet port that best meets your network needs and connect the ECD to the network using an Ethernet cable. 2. Connect a monitor (or any secondary display) to the ECD using an HDMI cable. This allows you to view the ECD's network information. ![image-20240821-205514.png](https://infocentre.zerokey.com/__attachments/a_137692e70804ef605fdb6c8de3afceab552964469346095185060d0ce1c4969c/image-20240821-205514.png?cb=ad68a242b984c24afa4aaf05c66cb86d) **Navigating to the Dashboard Log-In** 1. Make sure your PC is connected to the same network as the ECD, either through Wi-Fi or an Ethernet cable. 2. Enter the IP address, displayed on the screen in green text, into a browser's address bar. 3. After the IP address, add ***:11000*** to specify the port. Then, press enter. This should resemble the following: **192.168.1.199:11000**. --- language: "en" --- # Connect Your ECD to an MQTT Cloud Server Establish a connection from your ECD to a cloud-based MQTT server to enable data transfer between the two systems. Follow the steps below to set up and manage this connection. ## **Adding a New Connection** In the ZeroKey Dashboard, navigate to the **Integration** tab on the left side and click **MQTT Settings** . Then, click the **+ Add Connection** button on the top right of the page. ![image-20241108-223836.png](https://infocentre.zerokey.com/__attachments/a_315a5ed58b379dd72953a4aed2cff3367ad0cd593c509deecb3ebb57b595c8bd/image-20241108-223836.png?cb=94e1dbf0d012570107fce0c384fd02a2) A window will pop up, prompting you to enter the following details: 1. **Host (required):** * Enter the hostname or IP address of the cloud MQTT broker. 2. **Port (required):** * Enter the port number used by the cloud MQTT server. 3. **Username and Password (optional):** * If your cloud MQTT broker requires authentication, enter the username and password. 4. **TLS (optional):** * Select **Yes** if the cloud MQTT connection requires encryption; otherwise select **No.** **Note:** When TLS is enabled, ensure that you are using port 8883 to establish a secure cloud connection. Add a certificate or leave this field blank if you don't have one. 5. **Topic (required):** * Enter the MQTT topic that the cloud connection will subscribe or publish messages to. 6. **Filter (required):** * Set up filters to manage to manage messages based on specific criteria. For more information, check out our help article [Configuring MQTT Settings](https://infocentre.zerokey.com/articles/configuring-mqtt-settings). Once the connection is configured, click the **Submit** button in the bottom right corner to save the cloud MQTT connection. --- language: "en" --- # Connecting the ZeroKey SIP to the Tulip FOP through the Event Hub ## **Introduction** ZeroKey and Tulip Interfaces have partnered to integrate Quantum RTLS data with Tulip's no-code Frontline Operations Platform (FOP), enabling real-time connections between physical events and app logic. With Tulip's App Builder, you can trigger actions based on physical data. This guide focuses on the Event Hub integration, which establishes a one-way data flow from ZeroKey's Spatial Intelligence Platform (SIP) to a Tulip Application, where you can filter the incoming data and use it to trigger events within the app. ## **Prerequisites** * An existing Quantum RTLS deployment with ZeroKey SIP version 2.3.0 or higher. * To verify your SIP version in the dashboard, click the ZeroKey logo in the top left corner. * A *Professional* or *Enterprise* subscription to Tulip Interfaces. ## **Obtain your Edge Compute Device's (ECD's) URL.** In the dashboard, navigate to the **System** tab and go to the **Information** section. Here, you'll see values under **ECD Edge URL** , **ECD Cloud URL** , **ECD Serial Number** , and **Hardware Identifier**. * If your Tulip devices and Quantum RTLS deployment are on the same network, use the provided **ECD Edge URL** to minimize latency by channeling the Event Hub data directly to the Tulip client over the local network. * If your Tulip devices and Quantum RTLS deployment are not on the same network, use the provided **ECD Cloud URL** to make the Event Hub data available to your Tulip clients anywhere in the world. ![image-20240920-155950.png](https://infocentre.zerokey.com/__attachments/a_291dc37495ebf7f1a35d6a6ab0f3d00862edf4061a256ab7c34028a6c35b13a4/image-20240920-155950.png?cb=5a9bc98be424f7e48e2b86d96b4ababa) ## **Adding the ZeroKey Custom Widgets to Tulip** Navigate to the **Custom widgets** page from your Tulip account settings. Click the three dots next to the **Create custom widget** button in the top right corner of the screen and click **Import** from the dropdown menu. Upload both the **ZeroKey SIP Data Source** and**ZeroKey SIP Event Trigger** . Once imported successfully, the **Custom widgets** will be available to add to any new or existing Tulip app by selecting the widget from the **Settings** tab in the App Builder. ![image-20240920-164344.png](https://infocentre.zerokey.com/__attachments/a_04ba61ec9cbd702aac3cac1899321fb304cf57606b9f684d32f8bf69ab491343/image-20240920-164344.png?cb=75c33262fc4ae43739c4b717465a210d) ## **SIP Data Source Widget Connection** The **ZeroKey SIP Data Source** widget is added to the base layout of a Tulip app and establishes the connection to your Quantum RTLS deployment for that app. Navigate to the **Base layout** menu, located on the left, and add the **ZeroKey SIP Data Source** widget by selecting it from the **Custom** dropdown menu, located at the top. ![image-20240920-164724.png](https://infocentre.zerokey.com/__attachments/a_afe171587f87096d6e82a7e28fe9f78fe3d094f143b7c4641fe9bb70d57f3d51/image-20240920-164724.png?cb=295d772f93169535fa9053def0ee3501) To authenticate the connection, you will need the **ECD Edge URL** from the previous step and your ZeroKey user credentials. **NOTE:** These credentials are different from the ones used to log in to the dashboard. Please contact your ZeroKey representative to obtain your username and password. Alternatively, you can use an API key. These values can either be entered directly into the **Custom** widget as static inputs or referenced from a Tulip Table, allowing them to be updated dynamically from outside the Tulip App. ![image-20240920-164948.png](https://infocentre.zerokey.com/__attachments/a_83048b64f8e4be3095c319ac4f6b4f210dcb1ecaf1b4863e3bd8c4969a073901/image-20240920-164948.png?cb=fe34ecc93413d98bbaa92f19c30eb883) ## **SIP Data Source Widget Event Filters** The **ZeroKey SIP Data Source**widget can be configured to receive one or more event types. To optimize performance and reduce latency and CPU usage, it's recommended to receive only the event types that are necessary for your Tulip app. For each event category you want to use, select **Static Value** in the first field and enter *yes* in the second field. This ensures that only the required events are processed. ![image-20240920-170146.png](https://infocentre.zerokey.com/__attachments/a_478f8877c0e8cec9948e06559ce83fd1291c2d8c0bb3bd9875c86c150a90444f/image-20240920-170146.png?cb=68cdc45bae55eeba2b7d0010048dff7b) For further customization of the connection, you can use an **Additional custom filter string** for any supported filters available from the Event Hub API or an **Event Rate Limit** **(milliseconds)** to specify quality of service. Visit [api.zerokey.com](http://api.zerokey.com/) for full documentation on available filters. ![image-20240920-170303.png](https://infocentre.zerokey.com/__attachments/a_05c4736fc593b1d65ef727bcfa8eab87b7729bed87b554ddae4569e509d9b72b/image-20240920-170303.png?cb=80af2da1e3d91f89de493766523bc1be) ## **Create a Trigger to Store SIP Event Data** The **ZeroKey SIP Data Source** widget requires the use of a trigger to write the incoming data to a local app variable that is passed to the **ZeroKey SIP Event Trigger** widget on individual app step pages. In the **Custom** widget's options window, click the **+** next to **SIP_Event** under **Triggers** to open the trigger configuration window. Set up a trigger to store the **SIP_Event** data to a local app variable (**sip_event** in the example below). Modify the trigger configuration to look like the following: * **WHEN** `Custom Widget event occurs` **IF** `all` of the following conditions are met: **THEN** perform the following actions: `Data Manipulation` \| `Store` \| data: `Event` \| `SIP_Event` location: `Variable` \| `sip_event` ![image-20240920-170601.png](https://infocentre.zerokey.com/__attachments/a_eaf91c71460fc63b2f45399757dff2707ba80c01051ce109d5771d3ec191d3b6/image-20240920-170601.png?cb=f33a297428b549d4343ee743b8532399) ## **SIP Event Trigger Widget** To trigger step-level events based on the incoming Event Hub data, the **ZeroKey SIP Event Trigger** widget can be added to an individual step page within the app by navigating to the page and selecting the widget from the **Custom** dropdown menu. Configure the **ZeroKey SIP Event Trigger** to receive the local app variable set up in the previous step under **SIP_Event** in the **Widget** tab. ![image-20240920-171200.png](https://infocentre.zerokey.com/__attachments/a_4d413f3038074d5dcd3f62348153c210684235fc238aafc162c8f1601c97c2ea/image-20240920-171200.png?cb=ccf8d63f3d74f2dae9b121ff77f7cde5) Within the custom widget, triggers are available for each of the common event types: * **Position Example Trigger:** Sends position updates. * **Zone Entry Sample Trigger:** Sends an update for zone entry. * **Zone Exit Sample Trigger:** Sends an update for zone exit. Toggle on these triggers to provide quick visual confirmation that the integration is working correctly. For example, you could write the last received position to a variable or display a message when a zone collision happens. ![image-20240920-171622.png](https://infocentre.zerokey.com/__attachments/a_fccd9da059a9903f1065125f49861af68ad661cc133d96976d79976c670a7196/image-20240920-171622.png?cb=67cb88a602b75bd4ac124d79b244902d) ![image-20240920-171641.png](https://infocentre.zerokey.com/__attachments/a_02f7258906584c481d55692d00cdc67d57d42e1934f7db38a10e01d60557d10f/image-20240920-171641.png?cb=6e57f948953877d242326e004c52a41a) --- language: "en" --- # Connecting the ZeroKey Zones API to Tulip Connectors Integrate administrative capabilities, such as creating or deleting zones, into the Tulip Frontline Operations Platform using Tulip Connectors. The ZeroKey Zones Module Connector Suite offers prebuilt functionality for common features and is automatically installed when any ZeroKey Spatial MES Extension app template is added to your Tulip account. It can also be installed as a standalone package from the Tulip library. This connector suite is intended to supplement the ZeroKey Custom Widgets by incorporating request-response access to common features of the ZeroKey API. For one way flow of real-time data into the Frontline Operations Platform such as using live position and zone events to trigger actions within an app, use the ZeroKey Custom Widgets to connect your app to your ZeroKey Event Hub. ![image-20241112-210331.png](https://infocentre.zerokey.com/__attachments/a_d6f0bc92d051e7ccaf68694e5249384203aa7f1edc92414fdf8b6efe5967b559/image-20241112-210331.png?cb=20cb6e19a258f13191f839634234e8f7) ## **Prerequisites** * An existing Quantum RTLS deployment with ZeroKey SIP 2.3.0 or higher. * To verify your SIP version in the dashboard, click the ZeroKey Logo in the top left corner. * Connection of your Edge Compute Device to a network with unrestricted internet access. * A *professional* or *enterprise* subscription to Tulip Interfaces. ## **Obtain your Edge Compute Device's (ECD's) Cloud URL** In the ZeroKey dashboard, navigate to the **System** tab and go to the **Information** menu. Here, you'll see values in the **ECD Edge URL, ECD Cloud URL, ECD Serial Number** , and **Hardware Identifier** fields. For more information, read our help article [Edge vs Cloud Connection to the ZeroKey ECD](https://infocentre.zerokey.com/articles/edge-vs-cloud-connection-to-the-zerokey-ecd). ![image-20241112-211603.png](https://infocentre.zerokey.com/__attachments/a_5c11879e9dade8413d9d26f8a3048d5815b29678e8b4de210e4321b3a560b765/image-20241112-211603.png?cb=ed8c31dd2dbb7bdf996c358258851936) Connection to the ZeroKey API through Tulip Connectors requires the Cloud URL. The ECD must be connected to a network with unrestricted internet access to ensure the API is accessible through Tulip's Cloud Connector Host. ## **Configure the Connector Environment Settings** Begin by copying the ECD Cloud URL into the Server Address field within the Environment Settings pane, matching the exact formatting shown in the image below. Be sure to remove the **https://** before continuing. * Confirm **TLS** is toggled to **Yes**. * Select the **Use custom port** checkbox and enter **5001** as the chose port. ![image-20241112-211640.png](https://infocentre.zerokey.com/__attachments/a_3da1a5ae5d89cf1fa26482e9802f23e5ad76ddc8a3a4a55ffffc230e0e8c691e/image-20241112-211640.png?cb=fc9ba49853c98d5af7b8fe343f1dcaed) ## **Add your Edge Compute Device's (ECD's) API Key** If you haven't already generated an API Key, read our article [Generating the API Key using Postman](https://infocentre.zerokey.com/articles/generating-the-api-key-using-postman) for information on how to obtain one. Once the API Key is generated, add it to the **Header** section within the **Environment Settings** pane as shown in the image below. Ensure that you use the API Key and not a Bearer Token in this field. ![image-20241112-211736.png](https://infocentre.zerokey.com/__attachments/a_938715039e48390b17c1089d044d0f367ac5ffa09aedabd4780314a9766df802/image-20241112-211736.png?cb=48278cc8f832c2b13d17f285f885c2dd) ## **Test the Connection using Get All Device Information Connector** Click on the **Get All Device Information** connector and click **Run**. Within the response body, you will see an array of objects corresponding to all the Mobile and Anchor devices connected to the system, as well as a status indicating that the request was successful. This confirms that your environment is configured successfully and ready to use. ![image-20241112-211848.png](https://infocentre.zerokey.com/__attachments/a_f52f58bdd97e76e888da3a292b2c9ba7da7642822d5944d4ceec97a443b1c612/image-20241112-211848.png?cb=7a0f11d33c46d4a71f99547ed83c285b) ## **Example 1** ### **Creating a New Zone from within a Frontline Application** A trigger tied to a Tulip button press event is a simple and easy way to create zones from right within a Frontline Application. The ZeroKey Zones Module Connector Suite currently supports the creation of spherical zones, which can be either static or centered around a ZeroKey Mobile device so that the zone can move throughout the environment following the device it is associated with, such as a forklift, AGV or other mobile equipment. The following example demonstrates a trigger that will run the connector function to create a static zone with values tied to other app variables. ![image-20241112-211940.png](https://infocentre.zerokey.com/__attachments/a_6dda1270d3ee9803310aeda9aaac81331a16ef1365825d5dbb5beafdeecce5ba/image-20241112-211940.png?cb=eff0d9b415c723c6a33bf6709f597798) ## **Example 2** ### **Loading All Zones and Devices to an App Table** An **On step enter** Trigger can be used to load all the active zones and devices from your Quantum RTLS deployment to an object array local app variable. Once loaded, these values can easily be displayed and selected from interactive tables, making it simple and intuitive to build customized admin pages for spatial intelligence apps in Tulip such as in the template below. ![image-20241112-212030.png](https://infocentre.zerokey.com/__attachments/a_e3f8525b0e840275750c007d93747de0dd02c47315538b3b7c1b2ca096729e80/image-20241112-212030.png?cb=d581b341dbbb767785f45fb795950255) ![image-20241112-212100.png](https://infocentre.zerokey.com/__attachments/a_afdb5a002f38d4564318565d137300cda81fa4b8094cb553e3503354fd5af005/image-20241112-212100.png?cb=2c7661cf6ae7bb30594616d3baa2ef60) --- language: "en" --- # Connecting to Event Hub Using the Config Tool The **Connect to EventHub** interface in the Config Tool allows you to establish a connection with an Event Hub service to receive real-time data and updates. ## **Getting Started** 1. Open the Config Tool and click the **Event Hub** button, located on the top right-hand side. ![image-20240906-215437.png](https://infocentre.zerokey.com/__attachments/a_32ceea2fa1fc52d75a96ffe1f24ba32a7ef21b3e204848942db69c09d15f7317/image-20240906-215437.png?cb=0d0ec274010c64308ba0b7cd82f30517) * The **Connect to EventHub**window will open. ![image-20240906-214852.png](https://infocentre.zerokey.com/__attachments/a_a0ea16a4097d10a8ac764ba383ddfc68f6b54fbd89fcf7a184306a68dac09fd3/image-20240906-214852.png?cb=2c850a17753d7d72a9314d16e5aa32a5) 2. In the **EventHub Endpoint** field, replace *localhost* with the IP address of your ZeroKey Edge Compute Device (ECD) while leaving the rest the same. For more information on how to get the IP address of your ECD, visit our help article [Getting the IP address of your Edge Compute Device](https://infocentre.zerokey.com/articles/getting-the-ip-address-of-your-edge-compute-device). ![image-20240906-215658.png](https://infocentre.zerokey.com/__attachments/a_7a642dd9c312242076d2aa972400b9d9ee20a91c7ed17cf6cdc8ff065b82a7be/image-20240906-215658.png?cb=4f994f96b51c28affb6e63e6228ed009) 3. Enter*LocalAdmin* in the **Auth ID** field and *DefaultSecret* in the **Auth Secret** field. 4. In the **Position Message Type** dropdown menu, select the type of messages you want the Config Tool to receive from the Event Hub connection. For more details about each message type, please refer to [our API documentation](https://api.zerokey.com/v3/). ![image-20240906-215927.png](https://infocentre.zerokey.com/__attachments/a_e89e1f8a42c50f48bafc06e8cbec9ecea2f587fa69c49113e2786a08d87368a9/image-20240906-215927.png?cb=c0f7248cea2c852cc405702a3dbb2e04) * The **Filter position data from console** checkbox lets you filter the position data received from the console. * The **Filter raw gateway messages from console**checkbox lets you filter only the raw Gateway messages received from the console. 5. Click the **Connect** button. If the connection is successful, Event Hub messages will start appearing in the Config Tool. --- language: "en" --- # Connecting to ZeroKey's API with JavaScript Establish a connection to ZeroKey's API using JavaScript. ## **Getting Started** To start your integration with ZeroKey, you'll need to connect to the Spatial Intelligence Platform (SIP) API. Here's how to begin: 1. Go to the ZeroKey API webpage and navigate to the JavaScript section under Get Started. The following link will direct you to this page: [* *](https://api.zerokey.com/v3#section/Get-Started/JavaScript) . 2. Create an HTML file. 3. In the API document, copy the code provided under step 3 and paste it into your HTML file. ## **Editing the Code** Once you have the script ready, you can proceed to edit the JavaScript code. 1. First, locate the placeholders for the API host. Replace `{API Host Here}` with the IP address of the Edge Compute Device (ECD). * For example: `