API 6 table
 Share
The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss

Comment only
 
ABCDEFGHIJKLMNOPQRSTUVWXYZ
1
Main changes from API5:
2
3
one API for all simpleHW devices (simpleLeak, simplePackPlus, simplePack Ivory, simpleTemp)
4
easy to read, comprehend and parse in any IoT platform
5
future proof and ready with full forward and backward compatibility both in downlink and uplink
6
new uplink and downlink mechanism.
7
using simpleTime for all time definitions (from 1 second to 63 days) using just one byte
see the tab with detailed description
8
using simpleTemp for all temperature definitions
see the tab with detailed description
9
support for all new sensors
10
2 definable heartbeats with definable behaviour and additional payloads
11
message and heartbeat appendable information at defined fixed payload positions
see the tab with detailed description
12
support for Sigfox coverage confirmation
13
ready for logical operators via downlink on device side
14
ready for world time sync and world time timed alerts
15
easy to understand and consistent LED blinking
see the tab with detailed description
16
myriads of other refinements and improvements
17
18
Uplink:
19
20
1st byte: Mode in which the device is working (expanding from current 16 to 256)
21
2nd byte: Main alert or type of message/event see predefined table in API6 (0-255) /roughly 30 defined currently in the definition table
22
3rd - 12th byte: event specific payload or appended information
23
see the tab with detailed description
24
25
Downlink:
26
27
We have a predefined table of 256 registers/pointers/addresses (see API 6 table)
28
/roughly 30 defined currently in the definition table
29
30
In downlink we always send the address/pointer (1 Byte) together with value (1 Byte).
31
32
1. Pointer A 0-255
33
2. Value A 0-255
34
3. Pointer B 0-255
35
4. Value B 0-255
36
5. Pointer C 0-255
37
6. Value C 0-255
38
7. Pointer D 0-255
39
8. Value D 0-255
40
41
One downlink can change 4 Bytes in the device at different addresses
42
Downlinks can be confirmed by device if requested.
43
see the tab with detailed description
44
45
46
Document changelog:
47
11.12.2018
Downlink - register description
Alert delay moved from reg. 5-6 to 44-45
48
16.12.2018
Downlink - register description
Added Register 69 - definition of leakage detection filtering.
49
18.12.2018
Downlink - register description
Added bit 0 to register 14 - Watchdog enable/disable
50
20.12.2018Uplink
Added Reed contact pipeline uplink paket specification (event 131).
51
20.12.2018
Downlink - register description
Added register 70 - Reed contact pipeline time threshold for exponent selection.
52
29.12.2018
Downlink - register description
Kill bit device control moved to separate register for secuity purposes
53
29.12.2018Modes
added modes and changes in default values differing from Default default settings
54
29.12.2018
Downlink - register description
departure delay default shortened from 30 to 15 secs
55
29.12.2018
Downlink - register description
default sleep time changes from 10 mins to 1 min
56
29.12.2018Uplink
complemented and clarified arming/armed/disarmed events
57
2.1.2019Uplink
Events 144-161 with Wifi added: Button press, light/reed sensor, drop alert, tracing tag
58
2.1.2019
Downlink - register description
Reg. 60 and reg. 61 - Accelerometer/magnetometer measurement period (SimpleTime encoding)
59
2.1.2019Uplink
Event 125 - device reset by watchdog or other reset source
60
3.1.2019Modes
Added 4 modes for temperature/cold chain monitoring
61
4.1.2019
Downlink - register description
Device control (reg. 0x40) added explanation of the logic (force arm/disarm)
62
8.1.2019
Downlink - register description
Reg. 0x29 - SimplePack, mode 9, alert 3, LED indication is ON
63
8.1.2019Blinking and beeping
Timing pattern change. New values are: double blink pattern dd_dd_dd_ (20ms ON, 280ms OFF, 20ms ON, 680ms OFF)
64
11.1.2019
Downlink - register description
Added explanation of ascending and descending order of register pointers in downlink payload.
65
12.1.2019
Default Value for register E changed to 0xE1
Beeper generally switched on
66
14.1.2019
Downlink - register description
New comment in register 64, arm/disarm logic explanation when corrupted downlink is received (wrong configuration request).
67
15.1.2019Modes
Detection delay used to drop short events in Reed contact with pipeline (rendundancy mode)
68
15.1.2019Modes
Default value for Detection delay inReed contact with pipeline (rendundancy mode) changed to 5 secs
69
15.1.2019Modes
Change departure time in Reed contact with pipeline to factory default of 15 secs
70
16.1.2019Uplink
254 FE Debug RAM register dump implemented
71
16.1.2019
Downlink - register description
254 FE Debug implemented
72
16.1.2019Modes
12 C Reed contact on/off added detection delay=0 secs
73
16.1.2019
Downlink - register description
Explanation of bit 3 and of Coverage detection added
74
18.1.2019
Downlink - register description
Reg. 21-24 - Accelerometer don't drop me detection logic changed
75
18.1.2019
Downlink - register description
Reg. 72-78 - Detection delay definition (time the input has to be valid till the event is considered as active)
76
21.1. 2019
Downlink - register description
added register 88 for defining duration of short LED blink in msec
77
21.1. 2019
Downlink - register description
added register 71 for control of the radio zone
78
21.1. 2019
Downlink - register description
added registers 54-58 for defintion of measurement periods
79
21.1. 2019Blinking and beeping
using register 88 for duration definition
80
21.1. 2019
Downlink - register description
New reg. 79 - Measurement window - monitor me mode [ms]
81
21.1.2019
Downlink - register description
New reg. 47 - Delta temperature. Sigfox message is sent when measured temperature differs from last reported temperature for more than delta temperature.
82
22.1.2019Modes
added mode 200 C8 Continous wave - mo message is sent, extralong press is supported
83
23.1.2019
Downlink - register description
added 5 5 Time Tracing interval 0-255 0x4A (10min.)
84
24.1.2019Modes
Track me modes..added default sleep time =0
85
24.1.2019Modes
Reed contact pipeline changed default to detection delay = 5 secs, sleep time=0
86
29.1.2019Uplinks
Reg. 132 & 133 - Temperature monitoring with redundancy
87
29.1.2019
Downlink - register description
Reg. 85 - TX SMPS voltage and attenuation definition
88
29.1.2019
Downlink - register description
67 43 Light Light Sensitivity hysteresis
89
29.1.2019
Downlink - register description
85 55 Device control RF Transceiver power (voltage + attenuation)
Not for end user/platform configuration
90
29.1.2019Modes
Added to 10 Temperature threshold alert and 11 Temperature monitoring settings for appending temperature
91
29.1.2019
Downlink - register description
Changed 19 Magnetometer general sensitivity 1A Magnetometer X axis sensitivity 1B Magnetometer Y axis sensitivity 1CMagnetometer Z axis sensitivity to defualt 0x05
92
30.1.2019Modes
Changed customer specific values in Mode 9 by Default default values
93
30.1.2019
Downlink - register description
Added explanation of general keys for multiple axes
94
31.1.2019Uplink
Event 129 - added HW version identification bytes
95
31.1.2019
Downlink - register description
Reg. 208-212 are not writable by downlink message. They are set by production tester according to production batch (HW configuration).
96
4.2.2019
Downlink - register description
Reg. 211 - power amplifier presence bit
97
5.2.2019
Downlink - register description
For debugging added app start and watchdog reporting
98
5.2.2019Uplink
Added App start and Watchdog reset reporting
99
5.2.2019
Downlink - register description
Reg. E - bit2 and bit1 are modified. (Any reset condition report - includes app start, Watchdog reset report)
100
5.2.2019Uplink
Events 7C and 7D discarded. New event 86 is created instead - containing reset flags.
Loading...