Download
Share
Print this page
  1. Manuals
  2. Brands
  3. TEKTELIC Communications Manuals
  4. GPS
  5. STORK
  6. Technical reference manual

TEKTELIC Communications STORK Technical Reference Manual

Hide thumbs Also See for STORK:

Advertisement

Quick Links

Download this manual
STORK
Technical Reference Manual (TRM)
Document Type
Document Number
Document Version
Product Name
Product Codes
Release Date
PROPRIETARY:
The information contained in this document is the property of TEKTELIC Communications Inc. Except as specifically
authorized in writing by TEKTELIC, the holder of this document shall keep all information contained herein
confidential, and shall protect the same in whole or in part from disclosure to all third parties.
© 2023 TEKTELIC Communications Inc., all rights reserved.
All products, names, and services are trademarks and registered trademarks of their respective companies.
DISCLAIMER:
Material contained in this document is subject to change without notice. The material herein is solely for
information purposes and does not represent a commitment by TEKTELIC or its representatives. TEKTELIC has
prepared the information contained in this document solely for use by its employees, agents, and customers.
Dissemination of this information and/or concepts to other parties is prohibited without the prior written consent
of TEKTELIC. In no event will TEKTELIC be liable for any incidental or consequential damage in connection with the
furnishing, performance or use of this material.
TEKTELIC reserves the right to revise this publication in accordance with formal change control procedures defined
by TEKTELIC.
Technical Reference Manual
T0008710_TRM
1.0
V
STORK
T0008375 (1x C-Cell)
September 13, 2023

Advertisement

loading
Need help?

Need help?

Do you have a question about the STORK and is the answer not in the manual?

Questions and answers

Related Manuals for TEKTELIC Communications STORK

Summary of Contents for TEKTELIC Communications STORK

  • Page 1 September 13, 2023 PROPRIETARY: The information contained in this document is the property of TEKTELIC Communications Inc. Except as specifically authorized in writing by TEKTELIC, the holder of this document shall keep all information contained herein confidential, and shall protect the same in whole or in part from disclosure to all third parties.
  • Page 2 Response to Configuration and Control Commands ..............30 DL Payload Formats ........................32 Configuration and Control Commands..................32 4.1.1 Operational Mode Configuration ..................33 4.1.2 LoRaMAC Configuration ....................33 Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 2 of 51...
  • Page 3 BLE Configurations – Sensor mode.................. 43 4.1.10 BLE Beacon Mode Configuration ..................45 4.1.11 Response to DL Commands Configuration ..............48 4.1.12 Command and Control....................48 References ............................51 Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 3 of 51...
  • Page 4 Table 2-1: Supported Geolocation Technologies ..................15 Table 3-1: UL Information Streams ....................... 23 Table 3-2: UL Frame Payload Values for Present STORK Data ..............23 Table 3-3: Examples of Decoded Uplinks ....................24 Table 3-4: Examples of BLE decoded ULs ....................27 Table 3-5: Example of response to config commands ................
  • Page 5 Figure 1-4: Battery Polarity Markers and Insertion ................. 14 Figure 1-5: Positive Terminal on Battery cover ..................14 Figure 2-1: System Operation Overview for Stork .................. 15 Figure 2-2: Geolocation Strategy Flow Chart ..................16 Figure 2-3: The BLE Scan Schematic Procedure..................17 Figure 2-4: The Magnetic Reset/Wake-Up Pattern.
  • Page 6 LoRaWAN ....LoRa wide area network (a network protocol based on LoRa) LoS ......line-of-sight LSb ......least significant bit LSB ......least significant byte MAC ......Medium Access Control Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential...
  • Page 7 ....... second(s) SH ....... safety hook SW ......software transducer....a sensing element in the STORK, such as the accelerometer TRM ......technical reference manual (this document) Tx ........ transmitter UL ....... uplink UTC ..
  • Page 8 LoRaWAN® Standard or proprietary protocols. Stork has one basic function: gather data from the GNSS or Wi-Fi or BLE modules and transmit the data, via LoRa, to a NS which then forwards it to their respective position resolver components that returns position fixes that can be visualized using a third-party application.
  • Page 9 1x mounting bracket (only for variants with mounting).  1x small magnet (only for C-cell variants). 1.2 Safety Precautions The following safety precautions should be observed when operating the stork Sensor:  All installation practices must be in accordance with the local and national electrical codes. ...
  • Page 10 Do not expose contents to water.  Do not encapsulate and/or modify batteries.  Store unused batteries in their original packaging away from metal objects.  Do not mix or jumble batteries. Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 10 of 51...
  • Page 11 Figure 1-2 shows that the pattern involves sustaining a “magnet presence” continuously for at least 3 s but less than 10s. See section 2.4 for more information on how to wake up the sensor. Figure 1-1: Sensor’s front view showing the location for applying magnetic pattern Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc.
  • Page 12 3 sec but no longer than 10 sec Figure 1-2: Stork’s Magnetic Activation Pattern When the sensor is activated, it displays an LED indication to show that it is beginning to join the network. It may take up to 10 seconds between the time of activation and the beginning of the LED join attempt pattern.
  • Page 13 The battery contacts are marked with their proper polarities (see Figure 1-4 with the positive terminal marked with a plus-sign (+), and the negative with a minus-sign (-). Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc.
  • Page 14 4. Before reattaching the battery cover, ensure the proper orientation of the cover by placing the battery symbol next to the mounting feature. 5. Reassemble the cover to the chassis by using the 4x Phillips head screws, using a #1 size screwdriver and up to 0.23 Nm of torque. Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc.
  • Page 15 Figure 2-1: System Operation Overview for Stork A summary of the current system operation is given as follows: Stork sensor performs priority based GNSS/Wi-Fi/BLE scans and sends the scan results as an uplink to Tek NS through a gateway. Tek NS forwards the relevant (BLE/GNSS and Wi-Fi) uplinks to the Tek application which will handle sending requests to position resolvers for both BLE and GNSS/Wi-Fi separately.
  • Page 16 (0x30) – see Section 4.1.4 for more information. The flow chart below outlines the flow of events within a geolocation cycle. Figure 2-2: Geolocation Strategy Flow Chart Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc.
  • Page 17 2.3 Bluetooth Low-Energy (BLE) Operation Stork is equipped with a BLE module that is embedded in the MCU. It serves as a BLE central device that periodically searches to discover nearby BLE peripherals, and in some cases, periodically broadcasts advertising packets to be visible to other devices.
  • Page 18 3 sec may trigger a module reset, as explained in item A above. The magnetic-forced UL contains a regular battery life information payload uplink on LoRaWAN port 10. Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc.
  • Page 19 2.5 Temperature and Relative Humidity Transducer The Stork sensor has a temperature and relative humidity (RH) transducer. Note that because the transducer element is located inside the sensor housing, sense response time will not be immediate. Two vents in the front and side of the enclosure are designed to allow ambient air to contact the transducer.
  • Page 20 2.6 Accelerometer Transducer The Stork sensor supports motion sensing through an integrated 3-axis accelerometer which can optionally be disabled. The main role of the accelerometer in the is to detect motion that can indicate a change of the sensor’s state from static to mobile, or vice versa.
  • Page 21 ON and OFF every 0.5 sec for 3 sec as shown in Figure 2-9. 2. After a 5 s pause, the normal Power-On and Network Join LED patterns described in Section 2.7.1 above occur after the device resets. Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc.
  • Page 22 1. The POST LED pattern described in steps 1-4 in Section 2.7.1 above occurs after the device resets. 2. Immediately, GREEN is toggled ON and OFF every 0.1 sec for 0.6 sec as shown in Figure 2-10. Figure 2-10: The GREEN LED Pattern Before Entering DEEP SLEEP Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential...
  • Page 23 Semtech Requests (Clock Sync, Almanac update, etc.) 3.1 Frame Payload to Report Real-Time Sensing Data Each data field from the Stork is encoded in a frame format shown in Figure 3-1. A big-endian format (MSb/MSB first) is always followed. Figure 3-1: The frame format in an UL payload.
  • Page 24 00 71 01 01 01 01 01 01 00 67 01 2A { “raw": "00 71 01 01 01 01 01 01 03 67 01 2A", "fport": 10, "acceleration_x": "0.257", "acceleration_y": "0.257", "acceleration_z": "0.257", "temperature": "29.8"} Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 24 of 51...
  • Page 25 LoRaWAN regional restrictions. If the devices to be reported do not fit into one packet, more than one packet will be transmitted to report the devices. Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc.
  • Page 26 (b) Whitelisting mode, Range 0. (c) Whitelisting mode, Range 1. (d) Whitelisting mode, Range 2. (e) Whitelisting mode, Range 3. Figure 3-2: The UL payload format to report discovered BLE devices. Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential...
  • Page 27 0x B0 8F 97 B3 AC 8F 97 B4 AD "raw": "B0 8F 97 B3 AC 8F 97 B4 AD", "fPort": 25, "filter_report_0": [ "BD_ADDR_1": "8f 97 b3", "RSSI_1": -84 "BD_ADDR_1": "8f 97 b4", "RSSI_1": -83 Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 27 of 51...
  • Page 28 0x B2 8F 96 C3 B2 8F 96 C4 B3 8F "raw": "B2 8F 96 C3 B2 8F 96 C4 B3 8F 96 B9 B4 8F 96 F4 B5", 96 B9 B4 8F 96 F4 B5 "fPort": 25, "filter_report_2": [ Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential...
  • Page 29 96 B9 B8 96 B4 AD B9 96 B4 AA BA "fPort": 25, "filter_report_3": [ "BD_ADDR_4": "8f 96 b7", "RSSI_4": -74 "BD_ADDR_4": "8f 96 b8", "RSSI_4": -73 Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 29 of 51...
  • Page 30  Writing to (a) configuration register(s). In the first case, Stork responds with the address and value of each of the registers under inquiry on LoRaWAN port 100. The response can be in one or more consecutive UL packets depending on the maximum frame payload size allowed.
  • Page 31 LoRaWAN port 100. In this case, the UL response to read commands on LoRaWAN port 100 is handled before the UL response to write commands on LoRaWAN port 101. Stork will respond this way to all read and/or write commands, except for the special case where the anti-bricking strategy is performed.
  • Page 32 Read Register 0x13 and Write value 0x8000 to Register 0x10: o DL command: {0x 13 90 80 00} When a read or write or write-and-read command is sent to the Stork, the Stork immediately responds on port 100 with the format described in Section 3.3.
  • Page 33 4.1.1 Operational Mode Configuration Stork can be configured to operate as a Sensor or as a Beacon, depending on the use case. By default, Stork is programmed as a Sensor i.e., the device can track other BLE devices around it but it can’t be tracked/discovered by other BLE Sensors.
  • Page 34 Note: Modifying these values only changes them in the Stork. Options for the Stork in the NS may also need to be changed to not strand a Stork. Modifying configuration parameters in the NS is outside the scope of this document. Unlike Tektelic’s other sensors, register 0x10 and 0x12 (and parts of 0x11) configuration are not supported (due to using a different LoRaMAC stack, i.e., LoRa Basics Modem).
  • Page 35 01: BLE scan fails (unsigned/no unit)  10: WIFI  11: GNSS b00 11 10 01 The following rules apply: 0x39  scan must be defined. Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 35 of 51...
  • Page 36 0x 00 00 01 2C frequency when motion frequency d/sec) is detected. keep motion cleared / device settled geolocation scan frequency NOTES Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 36 of 51...
  • Page 37 3. If scan 3 is undefined the geolocation scan cycle ends after scan 2 or 1 depending on bits 6-7 value. By default, Stork periodically reports geolocation at the frequency defined on register 0x31 (geolocation_scan_frequency) – see Section 4.1.4. The frequency of reporting changes to the value defined in...
  • Page 38 Anything else, invalid and ignored 4.1.6 Temperature/RH Configuration Table 4-6 shows a list of configuration registers for the Stork’s temperature/RH sensor. In this table, the bit indexing scheme is as shown in Figure 4-1. All the registers have R/W access. Stork TRM T0008710_Stork_TRM Version 1.0...
  • Page 39 Thresholds disabled/enabled. Enabled (string/no unit)  Bits 1-7: Ignored rh_threshold_high:  <value> Bits 8-15: High RH Low/High RH 0x3D threshold (unsigned, 1% Thresholds RH / LSB) (unsigned/%) Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 39 of 51...
  • Page 40  disabled/enabled Accelerometer on (unsigned/no unit)  Bits 3-6: Ignored 0x 87 zaxis_enabled:  Bit 7: 0/1 = Accelerometer <value>, off/on (unsigned/no unit) poweron: <value> (unsigned/no unit) Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 40 of 51...
  • Page 41 5 min before the alarm can be _grace_period: 0x 45 Event Grace cleared) <value>  Acceptable values: 0x 01 2C Period (unsigned/sec)  0-14: Invalid and ignored Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 41 of 51...
  • Page 42 (unsigned/no unit)  Bits 0-7: avg_energy_trend_win Average 10 core ticks dow: <value> Number of core ticks, w 0x 4B Energy Trend 0x 0A Window (unsigned/no unit) [1 update/LSB] Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 42 of 51...
  • Page 43  0: Invalid and ignored  ble_scan_interval: Scan interval (1 ms/LSb) 30 ms  <value> Acceptable values: “Scan 0x 52 Scan Interval Window”, …, 10000 0x 00 1E (unsigned/sec) Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 43 of 51...
  • Page 44 { Range inactive BD_ADDRs  0x 56 Filter Range 2 0x 00 00 00 00 00 00 00 oui: <value>, 00 00  OUI = B Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 44 of 51...
  • Page 45 Disable (unsigned/no unit)  0/1 = Advertising off/on min_advertising_int 100 ms Advertising interval (1 ms / Advertising erval: <value> 0x 59 LSb) Interval 0x 00 64 (unsigned/ms) Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 45 of 51...
  • Page 46 0x 5C TLM advertising disabled Packet Format (unsigned/no unit) disabled/enabled  Bits 3-7: RFU 0x 01 eddystone_tlm:  All set to 0: invalid and <value> ignored (unsigned/no unit) Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 46 of 51...
  • Page 47 (unsigned/no unit)  0x0C = -14.1 dBm  0x0D = -16.5 dBm  0x0E = -20.85 dBm  0x0F = -40 dBm  Other values: invalid and ignored Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 47 of 51...
  • Page 48 4.1.11 Response to DL Commands Configuration The Stork includes the ability for the user to select the format of UL responses to DL commands. Details on the response formats can be found in Section 3.3. Table 4-11 shows the response to DL commands register. This register has R/W access.
  • Page 49 Table 4-14: LoRaWAN Regions and Region IDs LoRaWAN Region Region ID EU868 US915 AS923 AU915 IN865 KR920 RU864 After sending the reset-to-factory-defaults command, the Stork is automatically reset with corresponding default configuration values. Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential Page 49 of 51...
  • Page 50 Write Application and LoRa Configurations to flash and reboot the device: o DL payload: 0x F0 60 01  Get FW version, and reset App Configuration to factory defaults o DL payload: 0x 71 F2 0A Stork TRM T0008710_Stork_TRM Version 1.0 TEKTELIC Communications Inc. Confidential...
  • Page 51 [1] Tadiran Batteries GmbH, "Tadiran Lithium Batteries: Technical Brochure LTC-Batteries," Tadiran Batteries, Büdingen, Germany, 2020. [2] TEKTELIC Communications Inc, "Network Server Quickstart Guide - Creating Your first network," 21 August 2019. [Online]. Available: https://support.tektelic.com/portal/en/kb/support. [Accessed 12 April 2021]. [3] LoRa Alliance, "LoRaWAN Regional Parameters," ver. 1.0.2, rev. B, Feb 2017.

This manual is also suitable for:

T0008375T0008376T0008377T0008395T0008357T0008356