NIS-UL UltraSonic Sensor - Revision history

Lcs: /* Uplink data Frame format */

2021-03-17T14:45:18Z

‎Uplink data Frame format

Elc: /* Ultrasonic sensor properties */

2021-02-16T11:37:16Z

‎Ultrasonic sensor properties

Lcs at 14:19, 30 November 2018

2018-11-30T14:19:22Z

Elc: /* Uplink data Frame format */

2018-03-01T16:18:00Z

‎Uplink data Frame format

Arl: /* Power consumption */

2017-11-28T11:17:10Z

‎Power consumption

Elc: /* Downlink Frame format */

2017-11-24T15:04:31Z

‎Downlink Frame format

Elc: /* Downlink Frame format */

2017-11-24T15:00:04Z

‎Downlink Frame format

Elc: /* Downlink Frame format */

2017-11-24T14:50:22Z

‎Downlink Frame format

Elc: /* Uplink data Frame format */

2017-11-24T14:47:42Z

‎Uplink data Frame format

Lcs at 09:14, 24 November 2017

2017-11-24T09:14:35Z

@@ Line 44: / Line 44: @@
 bit 1 : indicates the presence of <usonic_dist> field.
-bit 2 : indicates the presence of <voltage> field.
+bit 2 : indicates the presence of <voltage> field. <span style="color:red">Only available for versions before 19W03</span>
-bit 3 : indicates the presence of <internal_temp> field.
+bit 3 : indicates the presence of <internal_temp> field. <span style="color:red">Only available for versions before 19W03</span>
 bit 4 : is reserved.

@@ Line 17: / Line 17: @@
 = Ultrasonic sensor properties =
-Default configuration allows target detection until 6 meters.
+Default configuration allows target detection until 3 meters.
-Objects from 0cm to 20cm range are reported as 20cm.
+Objects from 0cm to 20cm range are reported as 20cm (0 is at the transducer, at the bottom of the cone).
 The acoustic detection pattern has an angle of 7°.

@@ Line 104: / Line 104: @@
      <low_hysteresis>: value of low hysteresis
-It is possible to change the sensor configuration using the Nemeus downlink protocol. The downlink frame must be sent on the LoRaWAN port 8.
+It is possible to change the sensor configuration using the Nemeus downlink protocol.<br>
 The downlink frame has the following format:

@@ Line 40: / Line 40: @@
 <mask>: bit field on 1 byte indicating the presence of other fields. Bit 7 is always to 1 because the mask is never extended on next byte.
-bit 0 : indicates the presence of <nb_meas> field.
+bit 0 : indicates the presence of <nb_meas> field. Absence of <nb_meas> means <nb_meas> = 1.
 bit 1 : indicates the presence of <usonic_dist> field.
@@ Line 50: / Line 50: @@
 bit 4 : is reserved.
-bit 5 : indicates the presence of <cause> field.
+bit 5 : indicates the presence of <cause> field. Absence of <cause> field means <cause> = periodic only.
 bit 6 : is reserved.

← Older revision		Revision as of 11:17, 28 November 2017
Line 173:		Line 173:


−	~~Please find below a tool to calculate power~~ consumption vs number of ~~measures~~ and transmissions.	+	Power consumption calculator based on the number of measurements and transmissions.


	{{#widget:Iframe\|param=https://jscalc.io/calc/7Z9r3VnBuApcPSzj\|width=100%\|height=800}}		{{#widget:Iframe\|param=https://jscalc.io/calc/7Z9r3VnBuApcPSzj\|width=100%\|height=800}}

@@ Line 167: / Line 167: @@
 Some examples in hexadecimal:
-     “028182”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <analog_meas> field only
+     “028182”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <usonic_dist> field only
      “028E04605401100100”: set <nb_meas_for_tx> to 4, <meas_period> to 21600*<period_unit> seconds, <period_unit> to 1 second and enable periodic measurements only with subperiod to 1 => one measurement every 6 hours and one transmission every 4 measures (every day). Each uplink frame will include 4 measurements

@@ Line 103: / Line 103: @@
      <low_threshold>: value of low threshold
      <low_hysteresis>: value of low hysteresis
-It is possible to change the sensor configuration using the Nemeus downlink protocol. The downlink frame must be sent on the MS008 LoRaWAN port (11).
+It is possible to change the sensor configuration using the Nemeus downlink protocol. The downlink frame must be sent on the LoRaWAN port 8.
 The downlink frame has the following format:
@@ Line 125: / Line 124: @@
 Bit5 indicates the presence of <low_threshold> and <low_hysteresis> fields
-Bit6 indicates the presence of <pwr_on_duration> field
+Bit6 is reserved
 If (mask.bit0 == 1):
@@ Line 148: / Line 149: @@
          bit4: enable(1)/disable(0) periodic measurements
          bit5: reserved
-         bit6: 0-10V(1)/4-20mA(0)
+         bit6: reserved
          bit7: reserved
      <subperiod>: 2 bytes in little endian containing the period subdivision
@@ Line 154: / Line 155: @@
 If (mask.bit4 == 1):
-     <high_threshold>: signed integer on 2 bytes in little endian containing the high threshold in mV [0..+9999] or µA [+4000..+19999]
+     <high_threshold>: unsigned integer on 2 bytes in little endian containing the high threshold in cm [20..299]
-     <high_hysteresis>: unsigned integer on 1 byte containing the hysteresis when leaving high threshold state in 100 mV or 100 µA [0..255]
+     <high_hysteresis>: unsigned integer on 1 byte containing the hysteresis when leaving high threshold state in cm [1..255]
 If (mask.bit5 == 1):
-     <low_threshold>: signed integer on 2 bytes in little endian containing the low threshold in mV [+1..+10000] or µA [+4001..+20000]
+     <low_threshold>: unsigned integer on 2 bytes in little endian containing the low threshold in cm [21..300]
-     <low_hysteresis>: unsigned integer on 1 byte containing the hysteresis when leaving low threshold state in 100 mV or 100 µA [0..255]
+     <low_hysteresis>: unsigned integer on 1 byte containing the hysteresis when leaving low threshold state in cm [1..255]
-Thus the downlink frame format is <cmd><mask><up_frame_mask><nb_meas_for_tx><meas_period><period_unit><mode><subperiod><high_threshold><high_hysteresis><low_threshold> <low_hysteresis><pwr_on_duration>.
+Thus the downlink frame format is <cmd><mask><up_frame_mask><nb_meas_for_tx><meas_period><period_unit><mode><subperiod><high_threshold><high_hysteresis><low_threshold> <low_hysteresis>.
 Some examples in hexadecimal:

@@ Line 93: / Line 93: @@
 The sensor configuration contains the following fields:
-* <up_frame_mask>: the mask identifying the different fields present in uplink frames (possible values are described in “Uplink data Frame format” section)
+    <up_frame_mask>: the mask identifying the different fields present in uplink frames (possible values are described in “Uplink data Frame format” section)
-* <nb_meas_for_tx>: the number of measures required to trigger a transmission (possible values are [1..8]
+    <nb_meas_for_tx>: the number of measures required to trigger a transmission (possible values are [1..8]
-* <meas_period>: the period of the measures in <perdiod_unit> seconds(possible values are [600..65535]
+    <meas_period>: the period of the measures in <perdiod_unit> seconds(possible values are [600..65535]
-* <period_unit>: the unit of <meas_period> in seconds, the resulting period is <meas_perios>*<period_unit> seconds
+    <period_unit>: the unit of <meas_period> in seconds, the resulting period is <meas_perios>*<period_unit> seconds
-It is possible to change the sensor configuration using the Nemeus downlink protocol. The downlink frame must be sent on the MS006 LoRaWAN port (8).
+It is possible to change the sensor configuration using the Nemeus downlink protocol. The downlink frame must be sent on the MS008 LoRaWAN port (11).
 The downlink frame has the following format:
@@ Line 104: / Line 111: @@
 <cmd>: 1 byte containing WRITE_CFG_CMD=0x02
-<mask>: bit field on 1 byte indicating the presence of other fields. Most significant bit (bit7) is always to 1 because the mask is never extended on next byte. Least significant bit (bit0) indicates the presence of <up_frame_mask> field, bit1 indicates the presence of <nb_meas_for_tx>, bit2 indicates the presence of <meas_period> and bit3 indicates the presence of <period_unit>
+<mask>: bit field on 1 byte indicating the presence of other fields. Most significant bit (bit7) is always to 1 because the mask is never extended on next byte.
 If (mask.bit0 == 1):
-: <up_frame_mask>: 1 byte containing the uplink frame mask
 If (mask.bit1 == 1):
-: <nb_meas_for_tx>: 1 byte containing the number of measures required to trigger a transmission
 If (mask.bit2 == 1):
-: <meas_period>: 2 bytes in little endian (LSB first) containing the period of measures in seconds
 If (mask.bit3 == 1):
-: <period_unit>: 1 byte containing the unit of <meas_period> in seconds (default value is 1 second)
+    <mode>: 1 byte encoded as follows:
-Thus the downlink frame format is <cmd><mask><up_frame_mask><nb_meas_for_tx><meas_period><period_unit>.
+    <low_threshold>: signed integer on 2 bytes in little endian containing the low threshold in mV [+1..+10000] or µA [+4001..+20000]
 Some examples in hexadecimal:
-* “028181”: set the <up_frame_mask> to 0x81 => the next uplink frames will include the <usonic_dist> field only (no <voltage> field and no <temp> field)
-* “028E04605401”: set <nb_meas_for_tx> to 4, <meas_period> to 21600*<period_unit> seconds and <period_unit> to 1 second => one measure every 6 hours and one transmission every 4 measures (every day). Each uplink frame will include 4 measures
+    “028182”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <analog_meas> field only
 == Power consumption ==

@@ Line 37: / Line 37: @@
 <br><br>
 The uplink payload contains multiple fields:
-Whatever the <mask> value, the field <nb_meas> follows it and applies to all measures. Thus, the frame starts with <mask><nb_meas>.
+<mask>: bit field on 1 byte indicating the presence of other fields. Bit 7 is always to 1 because the mask is never extended on next byte.
-: <nb_meas>: 1 byte containing the number of measures which follow.
 if (mask.bit0 == 1) :
-: <usonic_dist>: 2*<nb_meas> bytes containing the distances measured by the ultrasonic sensor in centimeters (1 to 600 cm in big endian).
+    <nb_meas>: 1 byte containing the number of measurements which follows.
 if (mask.bit1 == 1) :
-: <voltage>: 2*<nb_meas> bytes containing the voltages measured by the sensor in millivolts (in big endian).
+    <usonic_dist>: 2*<nb_meas> bytes containing the distances measured by the ultrasonic sensor in centimeters (1 to 300 cm in big endian).
 if (mask.bit2 == 1) :
-: <temp>: 1*<nb_meas> bytes containing the measured temperatures (signed integer)
+    <voltage>: 2*<nb_meas> bytes containing the voltage values measured by the sensor in millivolts. Each voltage value is an unsigned integer on 16 bits in big endian.
-Thus the uplink frame format is <mask><nb_meas><usonic_dist1>...<usonic_distN><voltage1>...<voltageN><temp1>...<tempN>
-Default <mask> value is 0x85 which means that the default frame is <mask><nb_meas><usonic_dist1>...<usonic_distN><temp1>...<tempN> (the voltage is not present)
+Default <mask> value is 0x8B which means that the default frame is <mask><nb_meas><usonic_dist1>...<usonic_distN><temp1>...<tempN> (the voltage is not present)
 Some examples (in hexadecimal):
-* “8502009700981f19”: the frame indicates two measurements of 151cm and 152cm followed by two temperatures of 31°C and 25°C.
+* “8B02009700981f19”: the frame indicates two measurements of 151cm and 152cm followed by two temperatures of 31°C and 25°C.
-* “810100a0”: the frame indicates a single measurement of 160cm without temperature.
+* “8200a0”: the frame indicates a single measurement of 160cm without temperature.
-* “84011e”: the frame indicates one temperature of 30°C.
+* “881e”: the frame indicates one temperature of 30°C.
 == Downlink Frame format ==

@@ Line 34: / Line 34: @@
 == Uplink data Frame format ==
 The uplink payload contains multiple fields:
 <mask>: bit field on 1 byte indicating the presence of other fields. Bit 7 is always to 1 because the mask is never extended on next byte. Least significant bit (bit 0) indicates the presence of <usonic_dist> field, bit 1 indicates the presence of <voltage>, bit 2 indicates the presence of <temp>.
@@ Line 57: / Line 59: @@
 == Downlink Frame format ==
 The sensor configuration contains the following fields: