Locator Details Table Definitions

You can find explanations below for the types of information found in each column of the Locator Details table as well as examples of how this information can be used for troubleshooting or system optimisation.

Locator ID

Shows the unique ID number of the Locator. It is used for identifying specific Locators in the project.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Name

Displays the Locator name as defined in the project file during the project planning phase in the Quuppa Site Planner (QSP). If not edited by the user, the default format is L001, L002, L003 and so on. It is used for identifying specific Locators in the project.

Note: Make sure that any changes you make to the project file are saved and submitted to the Quuppa Customer Portal and synced with the QPE to gain access to them via the Web Console.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Type

Shows what Locator model the Locator is, i.e. a Q17 Locator or a Q35 Locator.

This information can be used to identify different types of Locators in the project and to troubleshoot issues that might only be occurring with certain Locator types.

Coordinate System

Shows the name of the coordinate system that the Locator is in, as defined in the project file. If the Locator is in multiple coordinate systems at once, the Locator Details table will only show the primary coordinate system. Null is shown if this information is not available.

This information can be used to troubleshoot system performance. For example, to identify whether an issue is related to Locators in a specific coordinate system, or if a Locator has been associated to the wrong coordinate system.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Connection

Shows the status of the Locator's connection to the QPE. The values are:

  • Ok - a connection has been established and the QPE is working fine
  • Discovered - the system has received a status from the Locator, but the startup sequence hasn't yet been completed.
  • Waiting - the system is waiting to establish a connection with the Locator, e.g. when the Locator is starting up.
  • Failed - the connection has failed, e.g. due to a faulty Ethernet cable connection or the DHCP server is not running.
  • FWUpgrade - the Locator FW is currently being upgraded.
  • NotConnectable - the Locator hasn't been identified yet.

This is used for troubleshooting network performance issues by identifying whether the Locator is successfully connected to the network.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

License

Shows the license status for the Locator, i.e. if the Locator currently has a valid subscription or license. Following the status, information about how long the licence is still valid for will be displayed in brackets. The possible values are:

  • ok - License is valid
  • expired - License has expired and is no longer valid
  • invalid - License is not valid
  • not yet active - License has not been activated yet
  • no key - License is valid but no project key has been given to the QPE.
  • unknown - License is not know, e.g. used when the QPE is in simulator mode.

Colours are also used to visualise when licenses are about to expire:

This is useful information for assessing whether any issues with Locator performance could be caused by the subscription running out as well as to identify when action needs to be taken to renew the Locator subscriptions.

Note: This data is only available for Generation Q Locators. For LD Generation Locators, will show unknown.

Uptime

Shows the length of time that the Locator has been up and running and connected to the QPE, i.e. how long the Locator has been online.

This information can be used to troubleshoot Locator performance issues, such as identifying Locators that are experiencing connection issues and therefore are unable to remain online.

The Web Console retrieves this information from the QPE using the Get Positioning Engine Information API method.

IP address

Shows the IP address of the Locator. Null is shown if this information is not available. This column can be used to identify the Locator and troubleshoot network performance issues.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Ethernet mac

Shows the Ethernet MAC address of the Locator. Null is shown if this information is not available.

With the Generation Q Locators, the Ethernet MAC address is the same as the Locators ID. As the Ethernet MAC addresses are configured using our own address space, you can tell if a device is a Quuppa Locator if it's address is in the range of A4-DA-22 E00000-EFFFFF (e.g. a4da22efebdc).

This information can be used for troubleshooting network performance issues as well as to apply MAC filtering to your application as needed.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Mode

Shows the operation mode of the Locator. The modes are:

  • Track - The Locator is in tracking mode, collecting radio signals from the system environment and passing on data to the QPE.
  • Deployment - The Locator is in deployment mode. This mode is used for deploying (i.e. identifying and focusing) the Locators. Individual Locators can be placed into deployment mode as needed (e.g. if they need to be moved and refocused). Note: newly added Locators will be placed in deployment mode by default.
  • Moved - If the Locator has been moved, the mode may show as moved. We recommended refocusing any Locator that has been moved to ensure good tracking results.
  • Focusing - The Locator is in Focusing mode, i.e. can be used as a Focusing Locator to identify and focus other Locators in the project.

This information can be used to troubleshoot Locator performance issues, such as a Locator not behaving as it should as it has not entered the correct operation mode for some reason.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Last DF packet

Shows when the last Direction Finding packet was received from this Locator by the QPE. Shown in milliseconds.

Colours are used the visualise whether troubleshooting steps may be needed:

  • Green - The system is working fine, no actions needed.
  • Yellow - The system is losing some packets and some adjustments may be appropriate.
  • Red - Problems have been identified and troubleshooting is needed.

If the Locator has never received a Direction Finding packet, then unknown will be shown with the colour yellow.

This can be used to troubleshoot network performance issues.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Last good DF

Shows when the Locator last received a packet that was good enough to be used for positioning estimates. Null is shown if the system has never received any packets from this Locator.

Colours are also used to highlight any issues that may need troubleshooting. The colour options are:

  • green - The system is working fine and no action is needed
  • yellow - The system is losing some packets and some adjustments may be needed to ensure that positioning quality can be achieved
  • red - Problems have been identified and adjustments are needed to ensure that positioning quality can be achieved

This information can be used to manage air interface load, as it shows whether the QPE has validated that the packets received from this Locator can be used for positioning estimates. Interference and packet collisions can cause data packets to be damaged, and so it is important to take measures to manage air interface load if it starts to look like the packets received are not good enough quality to be used as this will directly affect the positioning performance of the system.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Last Data packet

Shows when the last data packet was received from this Locator by the QPE. Shown in milliseconds.

Colours are used the visualise whether troubleshooting steps may be needed:

  • Green - The system is working fine, no actions needed.
  • Yellow - The system is losing some packets and some adjustments may be appropriate.
  • Red - Problems have been identified and troubleshooting is needed.

If the Locator has never received a data packet, then unknown will be shown with the colour yellow.

This can be used to troubleshoot network performance issues.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

DF pps

Shows how many Direction Finding packets are received by this Locator from the tags per second. Direction Finding packets are used by the QPE to calculate positioning estimates for the tags in the tracking area and as such, this is an important indicator for system health.

The Web Console retrieves this information from the QPE using the Get Positioning Engine Information API method.

Data pps

Shows how many data packets are received by this Locator from the tags per second. This is an important indicator for system health.

The Web Console retrieves this information from the QPE using the Get Positioning Engine Information API method.

Sync/s (age)

Shows how many times the Locator has detected a syncronisation sequence per second, i.e. how much air interface traffic (both Quuppa traffic and other Bluetooth traffic) the Locator is picking up.

This is an important indicator for managing the air interface load as packet collisions in highly congested areas can damage the Direction Finding packets, which in turn can affect the QPE's ability to provide accurate positioning estimates. This value should always be compared with DF pps to get an accurate understanding of the current status. A level of 300-350 syncs per second typically indicates congestion in the air interface.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Network loss pps

Shows how many packets are lost per second between the Locators and the QPE. If the result is negative then the estimate is not available.

This indicator can be used to troubleshoot network performance issues.

The Web Console retrieves this information from the QPE using the Get Positioning Engine Information API method.

Deployment mode

When the Locator is in tracking mode, this column provides an Activate link that you can use to put Locator into deployment mode, e.g. if you need to move and refocus the Locator.

When the Locator is in deployment mode, this column will show a yellow colour to remind you to place the Locator back in tracking mode once you are ready with the deployment phase actions.

If the Locators accelerometer gives a different orientation to what is set In the project file, suggesting that the Locator has been moved and therefore requires refocusing, this column will display a red colour as a warning.

The Web Console retrieves the mode information from the QPE using the Get Locator Information API method.

Main FW

Shows the main firmware version run by the Locator. The column format shows the application version first, followed by the bootloader version (the bootloader version is only available for Generation Q Locators).

The information in this column can be used to check which firmware version is in use to troubleshoot firmware related issues and to check whether the Locator requires a firmware upgrade to gain access to the latest features and bug fixes.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Pos Radio FW

Shows the positioning radio firmware version run by the Locator. The column format shows the application version first, followed by the bootloader version (the bootloader version is only available for Generation Q Locators).

The information in this column can be used to check which firmware version is in use to troubleshoot firmware related issues and to check whether the Locator requires a firmware upgrade to gain access to the latest features and bug fixes.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Com Radio FW

Shows the communication radio firmware version run by the Locator. This column format shows the application version first, followed by the bootloader version. Not available for LD Generation Locators.

The information in this column can be used to check which firmware version is in use to troubleshoot firmware related issues and to check whether the Locator requires a firmware upgrade to gain access to the latest features and bug fixes.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Ant switch FW

Shows the antenna switch firmware version run by the Locator. This column format shows the application version first, followed by the bootloader version. Not available for LD Generation Locators.

The information in this column can be used to check which firmware version is in use to troubleshoot firmware related issues and to check whether the Locator requires a firmware upgrade to gain access to the latest features and bug fixes.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Ethernet FW

Shows the Ethernet firmware version run by the Locator. Only available for LD Generation Locators. Unknown shows for Generation Q Locators.

The information in this column can be used to check which firmware version is in use to troubleshoot firmware related issues and to check whether the Locator requires a firmware upgrade to gain access to the latest features and bug fixes.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Orientation, rotation (deg)

Shows the rotation of the Locator in degrees as seen by its accelerometer. It is important that the there is no significant discrepancy between the true physical orientation of the Locator and the orientation defined in the project file, which is used by the QPE for calculations. Significant discrepancies will affect the QPE's ability to provide an accurate positioning estimate for the tracked tag.

This information can be used to troubleshoot system performance and positioning accuracy.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Orientation, elevation (deg)

Shows the elevation angle of the Locator in degrees as seen by the accelerometer.

  • 0 - the Locator is pointing directly down
  • 180 the Locator is pointing directly up

It is important that there is no significant discrepancy between the true physical elevation of the Locator and the elevation defined in the project file, which is used by the QPE for the positioning calculations. Significant discrepancies will affect the QPE's ability to provide an accurate positioning estimate for the tracked tag.

This value can bee used for troubleshooting system performance and positioning accuracy.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Orientation error, rotation (deg)

Shows the difference in degrees of the rotation angles given by the Locator's accelerometer and the value set in the project file.

For Locators with an elevation angle of between 15 and 165 degrees, this value is a good indicator of whether the Locator focusing has been done well, enabling the QPE to provide accurate positioning estimates. A low value suggests that the focusing has been successful, while a high value suggests that either there was a problem with the focusing of this Locator or the Locator has been moved since it was originally focused. If the value is high, the Locator should be refocused for best results as the discrepancy affects the QPE's ability to provide accurate tracking results.

Note: This value is relatively meaningless for Locators with an elevation angle of close to 0 or 180 degrees.

This information can be used to troubleshoot system performance and positioning accuracy.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Orientation error, elevation (deg)

Shows the difference in degrees of the elevation angles given by the Locator's accelerometer and the value set in the project file.

A low value suggests that the Locator has been focused well, while a high value suggests that either there was a problem with the focusing of this Locator or the Locator has been moved since it was originally focused. If the value is high, the Locator should be refocused for best results as the discrepancy affects the QPE's ability to provide accurate tracking results.

This value can bee used for troubleshooting system performance and positioning accuracy.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Receive channels (MHz/BLE)

Displays the channels that the Locator is listening to. A frequency number (in MHz) and a BLE channel index are shown. Displays custom if custom configurations have been implemented.

This indicator can be used to troubleshoot system performance.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Startup override

Specifies any custom startup configurations that are performed by the Locator when it connects to the QPE. If no custom startup configurations have been set, the column will show normal (Default).

This information can be used to troubleshoot any network performance issues caused by the startup configurations.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Scan Mode

Shows the scan mode defined for the Locator in the project file. Available values are:

  • Positioning (DF) - A mode in which the Locator participates in Direction Finding.
  • Proximity (RSSI) - A mode in which the Locator does not participate in Direction Finding, but instead provides RSSI information such as the location types Proximity and Presence.

The scan mode can be set in the project file using the Quuppa Site Planner tool.

Note: Make sure that any changes you make to the project file are saved and submitted to the Quuppa Customer Portal and synced with the QPE to gain access to them via the Web Console.

Sensitivity (dB)

Displays the Locator's sensitivity level as defined in the project file.

This information is useful to managing the air interface load for your system to ensure best system performance.

The sensitivity setting can be adjusted in using the Quuppa Site Planner tool.

Note: Make sure that any changes you make to the project file are saved and submitted to the Quuppa Customer Portal and synced with the QPE to gain access to them via the Web Console.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Area

Shows the name of the tracking area in the project file that the Locator is in. If the Locator is in multiple tracking areas, all of the tracking areas will be listed, separated by commas. Null is shown if this information is not available.

The tracking area name is defined in the project file and can be edited using the Quuppa Site Planner (QSP).

Note: Make sure that any changes you make to the project file are saved and submitted to the Quuppa Customer Portal and synced with the QPE to gain access to them via the Web Console.

This information can be used to troubleshoot system performance issues.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

x (m)

Displays the Locator's X coordinate, as defined in the project file. The coordinates can be edited using the Quuppa Site Planner (QSP).

Note: Make sure that any changes you make to the project file are saved and submitted to the Quuppa Customer Portal and synced with the QPE to gain access to them via the Web Console.

This indicator can be used to troubleshoot system performance issues related to Locator.

The Web Console retrieves this information from the QPE using the Get Project Info API method.

y (m)

Displays the Locator's Y coordinate, as defined in the project file. The coordinates can be edited using the Quuppa Site Planner (QSP).

Note: Make sure that any changes you make to the project file are saved and submitted to the Quuppa Customer Portal and synced with the QPE to gain access to them via the Web Console.

This indicator can be used to troubleshoot system performance issues related to Locator.

The Web Console retrieves this information from the QPE using the Get Project Info API method.

z (m)

Displays the Locator's Z coordinate, as defined in the project file. The coordinates can be edited using the Quuppa Site Planner (QSP).

Note: Make sure that any changes you make to the project file are saved and submitted to the Quuppa Customer Portal and synced with the QPE to gain access to them via the Web Console.

This indicator can be used to troubleshoot system performance issues related to Locator.

The Web Console retrieves this information from the QPE using the Get Project Info API method.

Temperature (C)

Displays the internal temperature of the Locator in degrees Celsius, based on measurements by the Locator's temperature sensor. The accuracy of the temperature sensor is about +- 5 degrees. The electrical components inside the Locator generate some heat and so the temperature value is typically slightly higher than the temperature of the environment. This value is only available for LD Generation Locators.

This information can be used to troubleshoot Locator performance issues, e.g. those caused by overheating or other temperature variations.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Identification

Displays the status of the Locator's identification process. The available values are:

  • Not done - the Locator has not been identified, i.e. it does not have an ID.
  • Manual - the Locator has been identified, but the ID has been added manually via the QSP tool rather than using the identification wizard and Focusing Locator.
  • Wizard - the Locator has been identified using the QSP's identification wizard and the Focusing Locator.
  • Reset - the Locator has been identified using the QSP's identification wizard but has been reset.
  • Changed manually - the Locator has been identified using th QSP's identification wizard but the ID has been changed manually.
  • Runtime - the Locator is not in any coordinate system.

This indicator can be used to troubleshoot Locator performance issues that could be related to the deployment of the Locator. We recommend the use of the Wizard whenever possible, as it ensures that the Locator has not been misidentified by accident due to human error. If the Locator has been misidentified, then the QPE will not be able to provide accurate positioning estimates.

Focusing

Displays the status of the Locator's focusing process. The available values are:

  • Not done - the Locator has not been focused.
  • Manual confirmed - the Locator's focusing information has been set manually using the QSP tool.
  • Manual unconfirmed -the Locator's focusing information has been set manually.
  • Wizard - the Locator has been focused using the QSP's focusing wizard and a Focusing Locator.
  • Runtime - the Locator is not in any coordinate system.

This indicator can be used to troubleshoot Locator performance issues that could be related to the deployment of the Locator. We recommend the use of the Wizard whenever possible, as it ensures that the Locator has not been focused poorly due to human error. If the Locator has been focused poorly, then the QPE will not be able to provide accurate positioning estimates.

Command delay (ms)

Shows how many milliseconds it takes for the Locator to respond to commands sent by the QPE.

This indicator can be used to troubleshoot system performance issues.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Last command status (age)

Shows the status of the last command for the Locator sent by the QPE. The available values are:

  • Waiting - if the Locator has not been commanded.
  • OK - if the last command was successful.
  • Failed - if the last command was unsuccessful (the Locator is expected to reboot).
  • Failed (x) - if the multiple consecutive commands have failed. The x indicated the number of failed commands. These command failures will be ignored and the Locator will continue to operate as normal.

This indicator can be used to troubleshoot system performance issues.

The Web Console retrieves this information from the QPE using the Get Locator Information API method.

Command failure rate (%)

Shows the percentage of Locator commands that are failing. This indicator can be used to validate whether the connection from the QPE to the Locators is working well.

The Web Console retrieves this information from the QPE using the Get Positioning Engine Information API method.