background image

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. 

 

© 2018 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. 
 

TEKTELIC Communications Inc. 
7657 10

th

 Street NE 

Calgary, AB, Canada  T2E 8X2 
Phone: (403) 338-6900 

TEKTELIC

 

C

OMMUNICATIONS 

I

NC

.

 

 

Kona Home Sensor 

Technical Reference Manual 

Document Type:

 

Technical Reference Manual

 

Document Number:

 

T0005370_TRM

 

Document Version:

 

1.2

 

Product Name:

 

Kona LoRa IoT All-in-One Home Sensor

 

Product Codes:

 

T0004893

, T0004885

, T0004895

, T0004896

 

†Only applicable to module revisions above Rev C.  Some new features are not backward 

compatible with modules Rev C and below. Module revisions above Rev C only include Base and 
PIR models (Base model and External Connector model Rev C have been merged into a single 
Base model Rev D).

 

 

Summary of Contents for Kona T0004895

Page 1: ...n 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 TEKTELIC ...

Page 2: ... 0 3 Apr 06 2018 D Smith Added missing uplink info 0 4 Jul 6 2018 R Nikjah Expanded on payload examples Made some editorial fixes modifications 0 5 Jul 20 2018 D Smith Added new Rev D features 1 0 Aug 23 2018 R Nikjah Added some explanations and clarifications This version of the document is only applicable to Kona Home Sensor modules above Rev C 1 1 Oct 31 2018 R Nikjah Made a minor correction fo...

Page 3: ...missioning 12 3 3 LoRaMAC Configuration 13 3 3 2 LoRa Config Examples 14 3 4 Sensor Application Configuration 15 3 4 1 Periodic Tx Configuration 15 3 4 2 Reed Switch Configuration 17 3 4 3 External Input Configuration 19 3 4 4 Accelerometer Configuration 21 3 4 5 Temperature RH Threshold Configuration 24 3 4 6 Light Sensing Configuration 26 3 4 7 Motion Transducer Configuration 28 3 4 8 Moisture C...

Page 4: ...lt Values of Reed Switch Configuration Registers 18 Table 3 10 External Input Configuration Registers 19 Table 3 11 Default Values of External Input Configuration Registers 20 Table 3 12 Accelerometer Configuration Registers 21 Table 3 13 Default Values of Accelerometer Configuration Registers 23 Table 3 14 Temperature RH Threshold Configuration Registers 24 Table 3 15 Default Values of Temperatur...

Page 5: ...a LoRa IoT Home Sensor TRM T0005370_TRM Version 1 2 TEKTELIC Communications Inc Confidential Page 5 of 35 List of Figures Figure 2 1 The frame format in an UL payload 9 Figure 3 1 Format of a DL message 11 ...

Page 6: ... 8 m s2 Home Sensor Any one of the Kona All In One Home Sensor Module types ID identity IoT Internet of things LoRa a patented long range IoT technology acquired by Semtech LoRAMAC LoRaWAN MAC LoRaWAN LoRa wide area network a network protocol based on LoRa LoRaWAN Commissioning The unique device identifiers and encryption keys used for LoRaWAN communication see LoRaWAN Specification 1 for more det...

Page 7: ...on 1 2 TEKTELIC Communications Inc Confidential Page 7 of 35 Sensor Home Sensor Temp temperature transducer The sensing element attached to the Home Sensor e g PIR transducer humidity transducer TRM technical reference manual Tx transmitter UL uplink ...

Page 8: ...Rev D Home Sensor Module NA Base US 902 928MHz ISM Band T0004885 Rev D Home Sensor Module NA PIR US 902 928MHz ISM Band T0004895 Rev D Home Sensor Module EU Base EU 863 870MHz ISM Band T0004896 Rev D Home Sensor Module EU PIR EU 863 870MHz ISM Band The default configuration on the Home Sensor is Report Battery Voltage Temperature and RH every hour Report actuation an open to close or close to open...

Page 9: ...ucer data in the UL are sent through LoRaWAN Port 10 Table 2 1 Home Sensor Payload Frame Values Type Information Data Channel ID Data Type ID Bytes Data Type Data Format Battery Voltage 0x00 0xFF 2 Analog 10 mV LSB signed Reed Switch 0x01 0x00 1 Digital 0x00 Low Magnet present 0xFF High Magnet absent Light Detected 0x02 0x00 1 Digital 0x00 Dark 0xFF Bright Temperature 0x03 0x67 2 Temperature 0 1 C...

Page 10: ...𝟑 𝟔𝟕 Temperature 0x 00 0A 0 1 C 1 C o 0x 𝟎𝟒 𝟔𝟖 RH 0x 28 0 5 20 0x 04 68 14 01 00 FF 08 04 00 05 o 0x 𝟎𝟒 𝟔𝟖 RH 0x 14 0 5 10 o 0x 𝟎𝟏 𝟎𝟎 Reed Switch 0x FF Magnet Absent o 0x 𝟎𝟖 𝟎𝟒 Reed Switch Count 0x 00 05 5 switch triggers 0x 04 68 2A 03 67 FF FF 00 FF 01 2C o 0x 𝟎𝟒 𝟔𝟖 RH 0x 2A 0 5 21 o 0x 𝟎𝟑 𝟔𝟕 Temperature 0x FF FF 0 1 C 0 1 C o 0x 𝟎𝟎 𝐅𝐅 Battery Voltage 0x 01 2C 0 01 V 3 00 V 0x 02 00 FF 07 71 00 ...

Page 11: ...the Command Field determines whether a read or write action is being performed To write to a register the R W Access bit must be set to 1 one All read commands are one byte long Data following a read access command will be interpreted as a new command block To read a register the R W Access bit must be set to 0 zero Read commands are processed last For example in a single DL message if there is a ...

Page 12: ...r description of values Table 3 1 shows a list of these registers Table 3 1 LoRaWAN Commissioning Registers Address Access Value Bytes 0x00 R DevEUI 8 0x01 R AppEUI 8 0x02 R AppKey 16 0x03 R DevAddr 4 0x04 R NwkSKey 16 0x05 R AppSKey 16 Note 1 Commissioning values need to be kept secure at all times Note 2 Registers 0x02 0x04 and 0x05 cannot be read back in some regions if the DR number is too sma...

Page 13: ...ADR 0x12 R W Default DR number Default Tx Power number 2 B0 bits 3 0 Default DR number 3 B1 bits 3 0 Default Tx power number 3 0x13 R W Rx2 window DR number Rx2 window channel frequency 5 B0 B1 B2 B3 Channel frequency in Hz for Rx2 B4 DR for Rx2 0x19 R W Net ID MSBs 2 Bytes B0 B1 in the Net ID B0 B1 B2 B3 0x1A R W Net ID LSBs 2 Bytes B2 B3 in the Net ID B0 B1 B2 B3 Note Modifying these values only...

Page 14: ...U868 0x 33 D3 E6 08 00 869 525 MHz DR0 NA915 0x 37 08 70 A0 08 923 3 MHz DR8 AS923 0x 37 06 EA 00 02 923 2 MHz DR2 AU915 0x 37 08 70 A0 08 923 3 MHz DR8 IN865 0x 33 A6 80 F0 02 866 55 MHz DR2 CN470 0x 1E 1E 44 20 00 505 3 MHz DR0 KR920 0x 36 F3 13 E0 00 921 9 MHz DR0 RU864 0x 33 CD 69 E0 00 869 1 MHz DR0 3 3 2 LoRa Config Examples In the following example payloads the Command Field is boldfaced Sw...

Page 15: ...ll periodic transmissions 0x21 R W Ticks per Battery Tx 2 Ticks between Battery reports A value of 0 disables periodic battery reports 0x22 R W Ticks per Temperature Tx 2 Ticks between Temp reports A value of 0 disables periodic Temp reports 0x23 R W Ticks per RH Tx 2 Ticks between Humidity reports A value of 0 disables periodic Humidity reports 0x24 R W Ticks per Reed Switch Tx 2 Ticks between Re...

Page 16: ...es periodic reporting for the specified transducer 3 4 1 3 Default Configuration Table 3 7 shows the default values for the periodic transmission configuration registers Table 3 7 Default Values of Periodic Transmission Configuration Registers Seconds per tick 3600 1 hour Ticks per Battery 1 thus 1 hour period Ticks per Temperature 1 thus 1 hour period Ticks per RH 1 thus 1 hour period Ticks per o...

Page 17: ...lied if all event based reporting as explained in subsequent sections is disabled then periodic reporting is checked If all periodic reporting is disabled or the minimum non zero period is greater than a week then to avoid bricking the Sensor the core tick is set to 86400 i e one day and the battery voltage tick is set to 1 one 3 4 2 Reed Switch Configuration Table 3 8 shows a list of Reed Switch ...

Page 18: ...on it may be configured either to disable event based transmission in favor of getting hourly reports from the sensor or to only transmit after 50 events logged in the room The latter may be useful for alerting cleaning staff that room requires attention 3 4 2 3 Value to Tx The Value to Tx determines what information is transmitted whenever an event or periodic digital transmission is required If ...

Page 19: ...ounter Value 3 4 3 External Input Configuration Table 3 10 shows a list of External Input configuration registers Table 3 10 External Input Configuration Registers Address Access Value Bytes Description 0x2D R W Mode 1 Bit 0 Rising Edge Enable Bit 1 Falling Edge Enable Other bits are ignored 0x2E R W Count Threshold 2 of Triggers for event transmission A value of 0 disables event transmission 0x2F...

Page 20: ...e count from a high volume water meter it may be configured to disable event based transmission in favor of getting hourly reports from the sensor If a sensor is intended to monitor room utilization it may be configured to only transmit after 100 events logged in the room This may be useful for alerting cleaning staff that room requires attention 3 4 3 3 Value to Tx The Value to Tx determines what...

Page 21: ...dic reporting o DL payload 0x AE 00 00 AF 02 Count Threshold set to 0 zero Value to Tx set to Counter Value 3 4 4 Accelerometer Configuration The accelerometer transducer offers two thresholds for event based break in and impact detection It can also be polled periodically for applications where the Sensor orientation may be of interest Table 3 12 shows a list of accelerometer configuration regist...

Page 22: ... Impact Threshold is greater than 0 zero A value of 0 zero is ignored 3 4 4 3 Value to Transmit When an impact event is registered or when the accelerometer is periodically polled the data to transmit can be configured by the end user Available types are Alarm A single data byte to indicate that the Sensor was tripped Magnitude A single RMS value for the X Y Z accelerometer reading Full Precision ...

Page 23: ...k In Threshold 𝟑𝟎𝟎𝟎 milli 𝒈 Impact Threshold 6000 milli 𝑔 Value to Transmit Full Precision Impact Debounce Time 2 two seconds Mode Break In Threshold Disabled Impact Threshold Disabled Powered Off Sample Rate 0x01 1 Hz 3 4 4 8 Example DL Messages In the following example payloads the Command Field is boldfaced Set Impact Threshold and Impact Debounce Time o DL payload 0x B1 07 D0 B3 00 0A Reg 31 a...

Page 24: ...byte indexed i as defined Figure 3 1 Table 3 14 Temperature RH Threshold Configuration Registers Address Access Value Bytes Description 0x39 R W Temp Humid Sample Period Idle 4 Sample period of external Temperature RH transducer Idle state seconds 0x3A R W Temp Humid Sample Period Active 4 Sample period of external Temperature RH transducer Active state seconds 0x3B R W Low High Temperature Thresh...

Page 25: ...single 2 byte register with the upper byte storing the high temperature threshold and the lower byte storing the low temperature threshold with a 1 C per bit precision Each temperature threshold is stored transmitted as a 1 byte 2 s complement number The high temperature threshold must be greater than the low temperature threshold 3 4 5 4 RH Threshold The RH threshold is stored in a single 2 byte ...

Page 26: ...mple DL Messages In the following example payloads the Command Field is boldfaced Set Temperature Thresholds o DL payload 0x BB 19 F1 Reg 3B with write bit set to true High threshold set to 25 C Low threshold set to 15 C Read Temperature RH Sample Periods o DL payload 0x 39 3A Reg 39 and Reg 3A with their write bits set to false Set and enable RH thresholds o DL payload 0x BD 3C 14 BE 01 Reg 3D an...

Page 27: ...e period to 0 zero disables the light sensing element Setting the samples period to anything from 1 to 59 sets the sample period to 60 Note The light sensing sample period needs to be enabled for periodic transmission Otherwise in every transmission a repetitive light value residing in the MCU memory is reported 3 4 6 2 Threshold The Threshold is used to set the dark bright transition point for th...

Page 28: ...operation of the radio causes the PIR transducer to produce false positives so a cool down period is required after each Tx The Home Sensor runs a simple state machine for reporting whether or not motion is detected To conserve battery usage the Home Sensor only reports motion when it is first detected and when motion has not been detected for a configurable Grace Period Note The PIR transducer is...

Page 29: ...d Period The Threshold Period is the amount of time that motion events will be accumulated for Threshold detection For example a Threshold Period of 10 ten seconds accumulates motion detection events over a 10 ten second period from the time of first detection If the Threshold is exceeded before the time expires the sensor reports Motion Detected otherwise it does not report Values less than 5 for...

Page 30: ...ne leak spills etc and report moisture detection events The moisture transducer detector is integrated into the Home Sensor enclosure base screw side and can sense moisture without making physical contact with the liquid This transducer does not measure humidity in air Table 3 20 shows a list of moisture transducer configuration registers Table 3 20 Moisture Transducer Configuration Registers Addr...

Page 31: ...ether the moisture transducer is initialized enabled or de initialized disabled This register is used to determine the default state of the moisture transducer when first powered on The possible values for bit 0 are 0 Disable 1 Enable 3 4 8 4 Calibrate Baseline Writing a non zero value to this register forces the transducer to re calibrate the dry baseline to the current value regardless of its ac...

Page 32: ...never the moisture detector is enabled it is recalibrated for a new dryness baseline 2 In every sample if the measured value goes up from the baseline by more than 10 counts not user configurable the moisture detector is recalibrated for a new dryness baseline 3 In every sample if the measured value goes down from the baseline by more than the Threshold user configurable see Section 3 4 8 2 the de...

Page 33: ...inor B2 App version revision B3 LoRaMAC version major B4 LoRaMAC version minor B5 LoRaMAC version revision B6 LoRaMAC region number 0x72 W Reset Config Registers to Factory Defaults 1 0x0A Reset App Config 0xB0 Reset LoRa Config 0xBA Reset both App and LoRa Configs Any other value is ignored Resetting to factory defaults takes effect on the next power cycle Note The Command Control Register is alw...

Page 34: ...5 2 Command Examples In the following examples the Command Field is boldfaced Write Application Configuration to Flash memory o DL payload 0x F0 20 00 Write Application and LoRa Configurations to Flash memory o DL payload 0x F0 60 00 Reboot Device o DL payload 0x F0 00 01 Get FW version and reset App Config to factory defaults o DL payload 0x 71 F2 0A ...

Page 35: ...ions Inc Confidential Page 35 of 35 References 1 LoRa Alliance LoRaWAN Specification ver 1 0 3 Mar 2018 2 TEKTELIC Communications Inc Kona Home Sensor Uplink and Downlink Payload Formation ver 0 1 Jun 2018 3 LoRa Alliance LoRaWAN 1 1 Regional Parameters ver 1 1 rev B Jan 2018 ...

Reviews: