DRYCONTACTS-IP68-Technical-Reference-Manual-APP-2.1.1.pdf

<aside> đź’ˇ Applicable for APP versions >= 2.1.1

</aside>

DOCUMENTATION GUIDE

TABLE OF CONTENTS

1. REGISTERS

1.1 Generic registers

Register Size (bytes) Base Description Default Value Range (Min-Max) Comments
304 2 10 PIN code
0
(deactiv ated)

0 - 9999 | PIN code used with ATPIN command. Value 0 disables the PIN code. | | 306 | 1 | 10 | Product mode |   0 | 0: PARK 1: RUN | In PARK mode, product is not using Radio. In RUN mode, product will send/receive RF uplinks/downlinks. |

1.2 Applicative registers

Register Size (byte) Base Description Default value Min-Max Value Comments
300 2 10 Keep alive period 8640 (24h) 2 ... 65535 X 10 seconds
301 2 10 Transmit period 0 0 ... 65535 X 10 seconds
0: no periodic transmission
308 4 16 LED activity
0x10007F
0-0xFFFFFFFF Default: 10007F Eco: 100070
Other values: reserved
315 1 10 Time zone offset
0
-12 … 14 Defines the Time Zone offset from UTC (in hours).
Must be defined for Daylight Saving Time management.
316 1 10 Daylight Saving Time management
0
0 … 1 Only applicable for European countries.
0: disabled
1: enabled
318 1 10 Time stamping

0 |   0 … 1 | [LoRaWAN only] If enabled, adds a time stamp in data frames. 0: disabled 1: enabled | | 319 | 1 | 10 | RTCcalibration value | 0 | -100 … 100 | Allows correcting a possible drift of the clock. In tenths of a second per day. | | 320 | 1 | 16 | Channel 1 configuration |       0x43 | <7:4> Debounce duration 0: no debounce 1: 10 ms 2: 20 ms 3: 50 ms 4: 100 ms 5: 200 ms 6: 500 ms 7: 1 s 8: 2 s 9: 5 s A: 10 s B: 20 s C: 40 s D: 60 s E: 5 minutes F: 10 minutes <3:0> Type 0 = Deactivated 1 = Input Event ON 2 = Input Event OFF 3 = Input ON/OFF 4 = Output |                   |

321 1 16 Channel 2 configuration 0x43 See register 320
322 1 16 Channel 3 configuration 0x43 See register 320
323 1 16 Channel 4 configuration 0x43 See register 320
324 2 10 Channel 1 eventthreshold 1
0 - 65535 Number of events detected before sending an UPLINK

0: deactivated | | 325 | 2 | 10 | Channel 2event threshold | 1 | 0 - 65535 | Number of events detected before sending an UPLINK

0: deactivated | | 326 | 2 | 10 | Channel 3 event threshold | 1 | 0 - 65535 | Number of events detected before sending an UPLINK

0: deactivated | | 327 | 2 | 10 | Channel 4 event threshold | 1 | 0 - 65535 | Number of events detected before sending an UPLINK

0: deactivated | | 328 | 2 | 10 | Transmit period for time counting | 0 |   0 - 65535 | 0: deactivated Otherwise: X 1 min

This transmit period is independent from 301. | | 330 | 1 | 10 | Channel 1 output state | 0 | 0 - 1 | If channel is configured as an output, this register determines its state.

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 331 | 1 | 10 | Channel 2 output state | 0 | 0 - 1 | If channel is configured as an output, this register determines its state.

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 332 | 1 | 10 | Channel 3 output state | 0 | 0 - 1 | If channel is configured as an output, this register determines its state.

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 333 | 1 | 10 | Channel 4 output state | 0 | 0 - 1 | If channel is configured as an output, this register determines its state.

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 340 | 2 | 10 | Channel 1 event duration threshold | 0 | 0 - 65535 | 0: deactivated Otherwise: X 1 min | | 341 | 2 | 10 | Channel 2 event duration threshold | 0 | 0 - 65535 | 0: deactivated Otherwise: X 1 min | | 342 | 2 | 10 | Channel 3 event durationthreshold | 0 | 0 - 65535 | 0: deactivated Otherwise: X 1 min | | 343 | 2 | 10 | Channel 4 event duration threshold | 0 | 0 - 65535 | 0: deactivated Otherwise: X 1 min | | 344 | 1 | 10 | Channel 1 output functionsource channel | 0 | 0 = Deactivated 2 = channel 2 3 = channel 3 4 = channel 4 | 0: deactivated Otherwise: Source channel for output function | | 345 | 1 | 10 | Channel 2 output function source channel | 0 | 0 = Deactivated 1 = channel 1 3 = channel 3 4 = channel 4 | 0: deactivated Otherwise: Source channel for output function |

| 346 | 1 | 10 | Channel 3 output functionsource channel | 0 | 0 = Deactivated 1 = channel 1 2 = channel 2 4 = channel 4 | 0: deactivated Otherwise: Source channel for output function | | --- | --- | --- | --- | --- | --- | --- | | 347 | 1 | 10 | Channel 4 output function source channel | 0 | 0 = Deactivated 1 = channel 1 2 = channel 2 3 = channel 3 | 0: deactivated Otherwise: Source channel for output function | | 348 | 1 | 10 | Channel 1output function pulse duration | 0 | 0 - 100 | 0: steady state Otherwise : pulse duration in tenth of a second | | 349 | 1 | 10 | Channel 2 output function pulse duration | 0 | 0 - 100 | 0: steady state Otherwise : pulse duration in tenth of a second | | 350 | 1 | 10 | Channel 3 output functionpulse duration | 0 | 0 - 100 | 0: steady state Otherwise : pulse duration in tenth of a second | | 351 | 1 | 10 | Channel 4 output functionpulse duration | 0 | 0 - 100 | 0: steady state Otherwise : pulse duration in tenth of a second | | 352 | 1 | 10 | Channel 1 output function inversion | 0 | 0 - 1 | 0: Output is not inverted 1:Output is inverted | | 353 | 1 | 10 | Channel 2 output function inversion | 0 | 0 - 1 | 0: Output is not inverted 1:Output is inverted | | 354 | 1 | 10 | Channel 3 output functioninversion | 0 | 0 - 1 | 0: Output is not inverted 1:Output is inverted | | 355 | 1 | 10 | Channel 4 output function inversion | 0 | 0 - 1 | 0: Output is not inverted 1:Output is inverted | | 390 | 2 | 10 | Global counter for channel 1 | 0 | 0 – 65535 | In-RAM counter that stores all the detected events on the channel This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 391 | 2 | 10 | Global counter for channel 2 | 0 | 0 – 65535 | In-RAM counter that stores all the detected events on the channel This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 392 | 2 | 10 | Global counter for channel 3 | 0 | 0 – 65535 | In-RAM counter that stores all the detected events on the channel This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 393 | 2 | 10 | Global counter for channel 4 | 0 | 0 – 65535 | In-RAM counter that stores all the detected events on the channel This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 394 | 4 | 10 | Total events time counter for channel 1 | 0 | 0 – 4294967295 | In-RAM counter that accumulates the duration in seconds of the detected events on the channel

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 395 | 4 | 10 | Total events time counter for channel 2 | 0 | 0 – 4294967295 | In-RAM counter that accumulates the duration in seconds of the detected events on the channel

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 396 | 4 | 10 | Total eventstime counter for channel 3 | 0 | 0 – 4294967295 | In-RAM counter that accumulates the duration in seconds of the detected events on the channel

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore | | 397 | 4 | 10 | Total events time counter for channel 4 | 0 | 0 – 4294967295 | In-RAM counter that accumulates the duration in seconds of the detected events on the channel

This register is not saved in EEPROM. Its value is therefore set to 0 if the product is not powered anymore |

1.3 Radio registers

1.3.1 LoRaWAN Network Registers

1.3.1 LoRaWAN Network Registers

Register Description Encoding Details
201 Spreading Factor (SF) by default (Read Only) Decimal Default: 12
Min/max: 7 to 12
Unit: None
204 Reserved Hexadecimal Do not use
214 LORA APP-EUI (first part – MSB) Hexadecimal Default: 0
Key encoded on 16 characters. Each register contains a part of
the key.
Used during the JOIN phase in OTAA mode
E.g.:
APP-EUI = 0018B244 41524632
• S214 = 0018B244
• S215 = 41524632
215 LORA APP-EUI (second part – MSB) Hexadecimal Default: 0
Key encoded on 16 characters. Each register contains a part of
the key.
Used during the JOIN phase in OTAA mode
E.g.:
APP-EUI = 0018B244 41524632
• S214 = 0018B244
• S215 = 41524632
216 LORA APP-KEY (firstpart – MSB) Hexadecimal Default: 0
Key encoded on 32-byte characters. Each of the 4 registers contains 8 characters.
Used during the JOIN phase in OTAA mode
E.g.:
APP-KEY = 0018B244 41524632 0018B200 00000912
• S216 = 0018B244
• S217= 41524632
• S218=0018B200
• S219= 00000912
217 LORA APP-KEY (second part – MID MSB) Hexadecimal Default: 0
Key encoded on 32-byte characters. Each of the 4 registers contains 8 characters.
Used during the JOIN phase in OTAA mode
E.g.:
APP-KEY = 0018B244 41524632 0018B200 00000912
• S216 = 0018B244
• S217= 41524632
• S218=0018B200
• S219= 00000912
218 LORA APP-KEY (thirdpart – MID LSB) Hexadecimal Default: 0
Key encoded on 32-byte characters. Each of the 4 registers contains 8 characters.
Used during the JOIN phase in OTAA mode
E.g.:
APP-KEY = 0018B244 41524632 0018B200 00000912
• S216 = 0018B244
• S217= 41524632
• S218=0018B200
• S219= 00000912
219 LORA APP-KEY (fourth part – LSB) Hexadecimal Default: 0
Key encoded on 32-byte characters. Each of the 4 registers contains 8 characters.
Used during the JOIN phase in OTAA mode
E.g.:
APP-KEY = 0018B244 41524632 0018B200 00000912
• S216 = 0018B244
• S217= 41524632
• S218=0018B200
• S219= 00000912
220 LoRaWAN Options Hexadecimal Default: 5
Bit 0: Activation of the ADR ON(1)/OFF(0)
Bit 1: Reserved
Bit 2: DUTY CYCLE ON(1)/DUTY CYCLE OFF(0)
Bits 3 & 4: Reserved
Bits 5: CLASS C (1)/ CLASS A (0)
Bits 6 to 7: Reserved
CAUTION:
Deactivation of the Duty cycle may result in a violation of the
conditions of use of the frequency band, depending on the use of the device, thus violating the regulations in force.
In the case of disabling the Duty cycle, liability is transferred to
the user.
221 Mode of activation Decimal Default: 1
Choice: (see NOTE 1 after the table)
• 0: ABP
• 1: OTAA
222 LORA NWK_SKEY (first part – MSB) Hexadecimal Default: 0
Parameter encoded on 16 bytes. 4 registers contains 4 bytes.
223 LORA NWK_SKEY(second part - MID MSB) Hexadecimal
224 LORA NWK_SKEY (third part - MID LSB) Hexadecimal
225 LORA NWK_SKEY(fourth part – LSB) Hexadecimal
226 LORA APP_SKEY (first part – MSB) Hexadecimal Default: 0
Parameter encoded on 16 bytes, each register with 4 bytes.
227 LORA APP_SKEY(second part - MID MSB) Hexadecimal
228 LORA APP_SKEY (third part - MID LSB) Hexadecimal
229 LORA APP_SKEY(fourth part – LSB) Hexadecimal
280 NETWORK ID Hexadecimal Default: 0 Read only
281 DEVICE ADDRESS Hexadecimal Default: 0

NOTE 1: The “Over The Air Activation” (OTAA) mode uses a JOIN phase before being able to transmit on the network. This mode uses the APP_ EUI (S214 and S215) and APP_KEY (S216 to S219) codes during this phase to create the keys for network communication.

Once this phase is completed, the codes APP_sKEY, NWK_sKEY and DEVICE ADDRESS will be present in the corresponding registers. A new JOIN phase is started every time the device exits Command mode, a reset is performed, or the device is turned on.

Codes:

The “Activation by personalization” (ABP) mode has no JOIN phase; it transmits directly on the network using the codes NWK_sKEY (S222 to S225), APP_sKEY (S226 to S229) and DEVICE ADDRESS (S281) to communicate.

Codes:

Register Size (bytes) Base Description Default Value Range (Min- Max) Minimum required Application version Comments
303 1 10 LoRaWAN Confirmed mode
0
0-1
V1.2.0 0: deactivation
1: activation
312 4 10 Maximum delay between 2 authentication attempts
43200 (12h)
60-
2592000

V2.1.2 | X 1 second Period: 1 minute to 30 days | | 313 | 2 | 10 | Weighting factor for initial authentication attempts | 1 | 1-65535 | V2.1.2 | | | 314 | 1 | 10 | Number of tries for each authentication attempt | 10 | 1-255 | V2.1.2 | |

1.3.2 Sigfox Network Registers

1.3.2 Sigfox Network Registers

| --- | --- | --- | --- | --- | --- | --- |

2. RADIO PROTOCOL

Data with size greater than 1 byte will be transmitted MSB first. In LoRaWAN, frames are sent on port 1.

2.1 Status byte

All frames sent by the product contain a status byte. Its format is identical for all IoT Adeunis products.