# Abeeway trackers and location services documentation
This page lists all the documentation available for Abeeway trackers, Abeeway Device Manager and the ThingPark X Location Engine.
# Suggested journey through the documentation
The complete documentation listed below can be a bit overwhelming. We recommend to read the documentation in the following order:
- Read the out-of-the box notice related to your specific tracker model (which will also provide convenient QR codes pointing to essential documentation).
- Read the training on the tracker Button and LED User Interface (opens new window) and on the Command Line Interface (CLI) (opens new window). Many features require activation by button press sequences or CLI commands, and it is important to be familiar with both.
- Read the Abeeway Device Manager (ADM) User Guide (opens new window). This easy to use online tool will allow you to interact and configure your trackers without having to know the exact configuration commands or parameter IDs.
- You will need to tune the tracker's LoRaWAN transmit strategy to your specific use case and network. ADM provides default settings but if you want to optimize power consumption for a given private network you will need to make sure the the datarates used are as high as possible. AN-002_LoRa_Transmission_strategy (opens new window) provides all the details.
- You will usually need to understand how to tune the embedded GNSS geolocation logic to optimize power consumption and tune it to your local GNSS reception conditions, or configure aggressive timeouts if you want the tracker to switch to WiFi or BLE geolocation as much as possible. AN-016_GPS_LPGPS (opens new window) provides the required reference.
- If you need to understand specific parameters when using the Abeeway Device Manager beyond the tooltip information, you can refer to the Abeeway Trackers Reference Guide. This document is not meant to be read end-to-end, but rather as a comprehensive reference for all commands and parameters.
- You can more information in Abeeway Firmware trainings and ThingPark X Location Engine trainings below for more specific use cases.
The rest of the documentation relates to specific use cases (e.g. BLE scanning, Covid proximity) or specific actions (Firmware update, debugging), and the titles are self-explanatory. You need to read them only if relevant to you.
# Abeeway trackers
# Reference Guides and Tools
| Resource | |
|---|---|
| Asset tracker firmware reference guide | LATEST OLDER VERSIONS (opens new window) |
| Asset tracker firmware Release Notes | Abeeway tracker Firmware Release notes |
| Trackers power consumption estimation | Power Consumption Estimation (opens new window) |
| LED patterns for micro tracker and smart badge | LED patterns (opens new window) |
| Asset tracker driver | Asset Tracker Driver User Guide (opens new window) |
| Melodies for Abeeway Trackers | Abeeway trackers melody (opens new window) |
# Out of Box User Guides
| Resource | |
|---|---|
| Micro tracker | Micro tracker Out of Box User Guide (opens new window) |
| Smart badge | Smart Badge Out of Box User Guide (opens new window) |
| Industrial tracker | Industrial Tracker Out of Box User Guide (opens new window) |
| Compact tracker | Compact Tracker Out of Box User Guide (opens new window) |
# Certifications
| Resource | |
|---|---|
| Micro tracker V2 | Certification documents (opens new window) |
| Micro tracker V3 | Certification documents (opens new window) |
| Smart badge | Certification documents (opens new window) |
| Industrial tracker V1 | Certification documents (opens new window) |
| Industrial tracker V2 | Certification documents (opens new window) |
| Compact tracker | Certification documents (opens new window) |
| Docking station | Certification documents (opens new window) |
# Abeeway Device Manager application
| Resource | |
|---|---|
| Abeeway Device Manager (ADM) | Abeeway Device Manager User Guide (opens new window) |
# Data sheets
| Resource | |
|---|---|
| Micro tracker | Data sheet (opens new window) |
| Smart badge | Data sheet (opens new window) |
| Industrial tracker | Data sheet (opens new window) |
| Compact tracker | Data sheet (opens new window) |
| Smart badge docking station | Data sheet (opens new window) |
| Geolocation module | Data sheet (opens new window) |
| Third party accessories | Data sheet (opens new window) |
# Application notes
| Description | Resource | Minimum Required MCU/BLE Firmware Version | |
|---|---|---|---|
| Battery Percentage | This application note describes the computation of the remaining (%) battery level | AN-000_battery-percentage (opens new window) | MCU: 1.9.x, BLE: 2.2.0 This application note is deprecated since MCU FW 2.0 and above |
| BLE Firmware Update | This application note describes the update of BLE Firmware on the tracker using nRFconnect app. | AN-001_ble_firmware_update (opens new window) | MCU: 1.9.x, BLE: 2.2.0 |
| LoRa transmit strategy | This application note describes the configuration and usage of LoRaWAN® custom transmit strategy. | AN-002_LoRa_Transmission_strategy (opens new window) | MCU: 1.9.x, BLE: 2.2.0 |
| Scan collection | This feature describes the scan collection feature which allows scanning, filtering and reporting up to twenty BLE beacons in several uplink payloads. | AN-003_ScanCollection (opens new window) | MCU: 2.0, BLE: 3.1.0 |
| Device orientation | This application note explains how to use the accelerometer data from the tracker to detect its orientation. | AN-005_device_orientation (opens new window) | MCU: 1.9.x, BLE: 2.2.0 |
| BLE position filtering | This application note explains the functionality and configuration of BLE position filtering feature that allows reporting of up to four BLE beacon identifiers with different filtering options on BLE UID. | AN-006_Position_BLE_filtering (opens new window) | MCU: 2.1.x, BLE: 3.2.2 |
| Proximity detection | This application note describes the Proximity detection feature that can be used for contact tracing and proximity detection between people wearing the Abeeway trackers. | AN-007_proximity-detection (opens new window) | MCU: 2.1.x, BLE: 3.2.2 This feature is deprecated since MCU FW 2.4+. Please use MCU FW 2.3 and below to use this feature |
| Proximity detection calibration guide | This application note describes the positioning and calibration of badges for proximity detection and contact tracing. | AN-008_proximity-detection-calibration-guide (opens new window) | MCU: 2.1.x, BLE: 3.2.2 This feature is deprecated since MCU FW 2.4+. Please use MCU FW 2.3 and below to use this feature |
| MCU firmware update | This application note describes the MCU firmware update procedure.This tool is deprecated since MCU FW 2.2. Please use Abeeway Updater tool (see Firmware Update section below). | AN-009_mcu_firmware_update (opens new window) | MCU: 1.9.x, BLE: 2.2.0 |
| Angle Detection | This application note describes how to trigger events from the tracker based on its orientation | AN-010_Angle_Detection (opens new window) | MCU: 2.2.x, BLE: 3.3.0 |
| BLE Geozoning | This application note describes the BLE Geozoning feature which can be used to generate alerts from the tracker based on safe/hazard zone detection using BLE | AN-011_BLE_geozoning (opens new window) | MCU: 2.2.x, BLE: 3.3.0 |
| Quuppa Beaconing | This application note describes the Quuppa beaconing feature. | AN-012_Quuppa_beaconing (opens new window) | MCU: 2.2.x, BLE: 3.3.0 |
| CLI Usage | This application note describes the debugging of the tracker over USB interface. | AN-013_CLI_Description (opens new window) | MCU: 2.2.x, BLE: 3.3.0 |
| BLE Communication | This application note describes the interface between the tracker and the mobile APP | AN-014_BLE communication (opens new window) | MCU: 2.2.x, BLE: 3.3.0 |
| Debug Trackers | This application note describes how to debug Abeeway trackers when there is reset or any other unexpected cause | AN-015_Debug data (opens new window) | MCU: 2.2.x, BLE: 3.3.0 |
| GPS/LPGPS Usage | This application note describes how to configure and use the GPS/LP-GPS feature to optimize accuracy/power consumption of the tracker | AN-016_GPS_LPGPS (opens new window) | MCU: 2.2.x, BLE: 3.3.0 |
| Getting started with Mobile APP | This application note describes how to configure and use the Abeeway mobile APP with the trackers | AN-017_Mobile APP Getting Started Guide (opens new window) | MCU: 2.2.x, BLE: 3.3.0 |
| Motion and Shock detection | This application note describes how to configure the firmware for motion and shock detection) | AN-018_Motion_and_shock_detection (opens new window) | MCU: 2.3.x, BLE: 3.3.2 |
| BLE beaconing | This application note describes how to configure the firmware to send BLE beacons (iBeacon, Eddystone and Altbeacon) | AN-019_BLE Beacon transmission (opens new window) | MCU: 2.3.x, BLE: 3.3.2 |
# Firmware Update
| Description | Resource | |
|---|---|---|
| Abeeway Updater (Firmware Update tool) | This tool allows MCU and BLE Firmware update of Abeeway trackers. | Abeeway Firmware Update (opens new window) |
| MCU Firmware binaries | This folder has all the binaries for MCU/Application Firmware. | MCU Firmware binaries (opens new window) |
| BLE Firmware binaries | This folder has all the binaries for BLE Firmware. | BLE Firmware binaries (opens new window) |
| Config files | This folder has all the Firmware config files for different trackers. | Abeeway Firmware Update (opens new window) |
| BLE firmware update | This application note describes the BLE firmware update procedure using Nordic NrfConnect smartphone application. | AN-001_ble-update (opens new window) |
# Abeeway Firmware trainings
| Description | Resource | |
|---|---|---|
| Abeeway Firmware feature overview | These sessions provide overview of firmware features for each release | What's new sessions (opens new window) |
| User Interface | These training slides introduce the user interface (LED, buzzer, button) for Abeeway trackers. | User Interface (opens new window) |
| Proximity Policy Enforcement | These training slides introduce basic concepts of proximity solution and how to set it up. | Proximity Solution (opens new window) |
| Scan Collection | This feature introduces BLE/WiFi scanning and reporting of up to 20 BLE Beacons/WiFi BSSIDs. | Scan Collection (opens new window) |
| BLE Position Filtering | This feature introduces BLE position reporting of up to 4 BLE beacons. | BLE Position Filtering (opens new window) |
| CLI Usage | This feature allows to interact with tracker over USB to get the internal logs and also set the tracker parameters. | CLI Usage (opens new window) |
| Quuppa Beaconing | This feature enables Quuppa beaconing for Abeeway trackers. | Quuppa Beaconing (opens new window) |
| BLE Geozoning | This feature enables BLE geozoning for Abeeway trackers. | BLE geozoning (opens new window) |
| Abeeway Mobile App | This feature explains how to use Abeeway Mobile for Abeeway trackers. | Abeeway Mobile App (opens new window) |
# ThingPark X Location Engine
# ThingPark X Location Engine Trainings
| Description | Resource | |
|---|---|---|
| ThingPark Location Introduction | These training slides introduce basic features of ThingPark Location. | ThingPark Location Introduction (opens new window) |
| ThingPark Location feature overview | These sessions provide overview of ThingPark X Location Engine features for each release | What's new sessions (opens new window) |
To get more resources on ThingPark Location, see Documentation library.