NIS-IO Digital Sensor - Revision history

Lcs: /* Downlink Frame format */

2018-04-24T08:46:23Z

‎Downlink Frame format

Lcs: /* Downlink Frame format */

2018-04-24T08:37:46Z

‎Downlink Frame format

Arl at 12:06, 17 April 2018

2018-04-17T12:06:14Z

Elc: /* Uplink data Frame format */

2017-12-18T13:33:55Z

‎Uplink data Frame format

Elc: /* Uplink data Frame format */

2017-12-15T16:49:26Z

‎Uplink data Frame format

Elc: /* Uplink data Frame format */

2017-12-15T16:36:51Z

‎Uplink data Frame format

Arl at 17:05, 14 December 2017

2017-12-14T17:05:35Z

Arl at 17:02, 14 December 2017

2017-12-14T17:02:53Z

Arl at 17:02, 14 December 2017

2017-12-14T17:02:19Z

Arl at 17:01, 14 December 2017

2017-12-14T17:01:50Z

@@ Line 134: / Line 134: @@
      <pwr_on_duration>: value in ms to wait between sensor power-on and measure reading
-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 NIS IO LoRaWAN port (14).
 The downlink frame has the following format:

← Older revision		Revision as of 08:37, 24 April 2018
Line 119:		Line 119:

	== Downlink Frame format ==		== Downlink Frame format ==
		+
		+	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)
		+	<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]
		+	<period_unit>: the unit of <meas_period> in seconds, the resulting period is <meas_perios>*<period_unit> seconds
		+	<mode>: bit field enabling/disabling the measures (threshold detections and periodic measures)
		+	<subperiod>: subdivision of period for threshold detection, actual measurement period is (<meas_period>*<period_unit>)/<subperiod> seconds
		+	<high_threshold>: value of high threshold
		+	<high_hysteresis>: value of high hysteresis
		+	<low_threshold>: value of low threshold
		+	<low_hysteresis>: value of low hysteresis
		+	<pwr_on_duration>: value in ms to wait between sensor power-on and measure reading
		+
		+	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:
		+
		+	<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.
		+
		+	Bit0 indicates the presence of <up_frame_mask> field
		+
		+	Bit1 indicates the presence of <nb_meas_for_tx> field
		+
		+	Bit2 indicates the presence of <meas_period> and <period_unit> fields
		+
		+	Bit3 indicates the presence of <mode> and <subperiod> fields
		+
		+	Bit4 indicates the presence of <high_threshold> and <high_hysteresis> fields
		+
		+	Bit5 indicates the presence of <low_threshold> and <low_hysteresis> fields
		+
		+	Bit6 indicates the presence of <pwr_on_duration> field
		+
		+	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 measurements required to trigger a transmission
		+
		+	If (mask.bit2 == 1):
		+
		+	<meas_period>: 2 bytes in little endian (LSB first) containing the period of measurements in <period_unit> seconds
		+	<period_unit>: 1 byte containing the unit of <meas_period> in seconds (default value is 1 second)
		+
		+	If (mask.bit3 == 1):
		+	<mode>: 1 byte encoded as follows:
		+	bit0: enable(1)/disable(0) high threshold detection
		+	bit1: enable(1)/disable(0) high hysteresis detection (when leaving high threshold state)
		+	bit2: enable(1)/disable(0) low threshold detection
		+	bit3: enable(1)/disable(0) low hysteresis detection (when leaving low threshold state)
		+	bit4: enable(1)/disable(0) periodic measurements
		+	bit5: reserved
		+	bit6: 0-10V(1)/4-20mA(0)
		+	bit7: reserved
		+	<subperiod>: 2 bytes in little endian containing the period subdivision
		+
		+	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_hysteresis>: unsigned integer on 1 byte containing the hysteresis when leaving high threshold state in 100 mV or 100 µA [0..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_hysteresis>: unsigned integer on 1 byte containing the hysteresis when leaving low threshold state in 100 mV or 100 µA [0..255]
		+
		+	If (mask.bit6 == 1):
		+
		+	<pwr_on_duration>: unsigned integer on 2 bytes containing the delay in ms [0..65535]
		+
		+	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>.
		+
		+	Some examples in hexadecimal:
		+
		+	“028182”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <digital_meas> field only

@@ Line 54: / Line 54: @@
 ;Maximum Input Voltage +/-35V
-;Detection level +/- 1.8V
+;Detection level VIL 2.1V / VIH 2.3V
 ;Opto-isolated 3,750 Vrms
 <section end=Input Electrical Characteristics />

@@ Line 116: / Line 116: @@
 if (mask.bit4 == 1) :
-     <in_evt>: 2 bytes containing the input source and the edge. First byte is a bit field identifying the input source (bit 0 is input 0 ...). Seconde byte is a bit field identifying the edge, 0 means falling edge and 1 means rising edge.
+     <in_evt>: 2 bytes containing the input source and the edge. First byte is a bit field identifying the input source(s) (bit 0 is input 0 ...). Second byte is a bit field identifying the edge, 0 means falling edge and 1 means rising edge. Edge bit is significant only when source bit is set to 1.
 == Downlink Frame format ==

@@ Line 115: / Line 115: @@
     <internal_temp>: 1*<nb_meas> bytes containing the internal temperature values (using MCU internal sensor). Each temperature value is a signed integer on 8 bits in big endian in °C [-128..+127].
+if (mask.bit4 == 1) :
-Thus the uplink frame format is <mask><nb_meas><analog_meas1>...<analog_measN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>
+    <in_evt>: 2 bytes containing the input source and the edge. First byte is a bit field identifying the input source (bit 0 is input 0 ...). Seconde byte is a bit field identifying the edge, 0 means falling edge and 1 means rising edge.
 == Downlink Frame format ==

← Older revision		Revision as of 16:36, 15 December 2017
Line 81:		Line 81:
	== Uplink data Frame format ==		== 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.
		+
		+	bit 0 : indicates the presence of <nb_meas> field.
		+
		+	bit 1 : indicates the presence of <io_state> field.
		+
		+	bit 2 : indicates the presence of <voltage> field.
		+
		+	bit 3 : indicates the presence of <internal_temp> field.
		+
		+	bit 4 : indicates the presence of <in_evt> field.
		+
		+	bit 5 : is reserved
		+
		+	bit 6 : is reserved
		+
		+	When bit 0 is not set, it means that other fields are present only once (nb_meas = 1).
		+
		+	if (mask.bit0 == 1) :
		+	<nb_meas>: 1 byte containing the number of measurements which follows.
		+
		+	if (mask.bit1 == 1) :
		+	<io_state>: 4*<nb_meas> bytes containing the input and output states. For each measure, first 16 bits contain the input states, last 16 bits contain the output states.
		+	Each 16 bits word is cut in 8 pairs of 2 bits assigned to each input or output.
		+	For each 2 bit pair, 00 means disabled, 10 means enabled level low, 11 means enabled level high
		+
		+	if (mask.bit2 == 1) :
		+	<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.
		+
		+	if (mask.bit3 == 1)
		+	<internal_temp>: 1*<nb_meas> bytes containing the internal temperature values (using MCU internal sensor). Each temperature value is a signed integer on 8 bits in big endian in °C [-128..+127].
		+
		+
		+	Thus the uplink frame format is <mask><nb_meas><analog_meas1>...<analog_measN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>
		+
		+	Default <mask> value is 0x8B which means that the default frame is <mask><nb_meas><analog_meas1>...<analog_measN><internal_temp1>...<internal_tempN>
		+
		+	Some examples (in hexadecimal):
		+
		+	“820239”: the frame indicates one analog measurement of 5689 mV or µA.
		+	“8302128E2533”: the frame indicates two analog measurements of 4750mV or µA and 9523 mV or µA.

	== Downlink Frame format ==		== Downlink Frame format ==

← Older revision		Revision as of 17:05, 14 December 2017
Line 71:		Line 71:
	;Nominal load current 3A		;Nominal load current 3A
	<section end=Output Electrical Characteristics />		<section end=Output Electrical Characteristics />
		+
		+
		+	= Magnetic Switch Protocol description =
		+	{{:NIS Generic Magnetic Switch Protocol}}
		+
		+	= Radio frames description =
		+	{{:NIS Generic Application Protocol}}
		+
		+	== Uplink data Frame format ==
		+
		+
		+	== Downlink Frame format ==

@@ Line 20: / Line 20: @@
 {| class="wikitable"
-|+Device wiring
+|+4 Inputs Device wiring
 |-
 |rowspan="2"|IN0

@@ Line 26: / Line 26: @@
 |rowspan="8"|JP1 1-2 : No pull for voltage input <br> JP1 2-3 : Pull-up for dry contact
 |-
-|4 : GND
+|2 : GND
 |-
 |rowspan="2"|IN1

← Older revision		Revision as of 17:01, 14 December 2017
Line 1:		Line 1:
		+	[[File:1 Exp PE Digital Sensor.png\|thumb\|400px\|IO Digital Sensor]]
		+
		+	= General information =
		+	{{:NIS Overview}}
		+
		+	= Mechanics =
		+	* Dimensions 60 x 95 x 85mm (109mm including fixing brackets)
		+	* 96mm spacing between brackets
		+	* IP 65
		+	* Solid ABS & PC material
		+
		+	= IO Digital sensor properties =
		+
		+	This sensor can monitor up to 4 digital inputs and control 4 digital outputs.
		+
		+	= Wiring =
		+
		+	[[File:Full config ids.png\|picture of sensor pcb and box]]
		+
		+
		+	{\| class="wikitable"
		+	\|+Device wiring
		+	\|-
		+	\|rowspan="2"\|IN0
		+	\|1 : IN0+
		+	\|rowspan="8"\|JP1 1-2 : No pull for voltage input <br> JP1 2-3 : Pull-up for dry contact
		+	\|-
		+	\|4 : GND
		+	\|-
		+	\|rowspan="2"\|IN1
		+	\|3 : IN1+
		+	\|-
		+	\|4 : GND
		+	\|-
		+	\|rowspan="2"\|IN2
		+	\|5 : IN2+
		+	\|-
		+	\|6 : GND
		+	\|-
		+	\|rowspan="2"\|IN3
		+	\|7 : GND
		+	\|-
		+	\|8 : IN3+
		+	\|}
		+
		+
	== Hardware description ==		== Hardware description ==
	<section begin=Input Electrical Characteristics />		<section begin=Input Electrical Characteristics />