View source for NIS-AN Analogic Sensor (4-20ma,0-10v)

[[Category:Sensors]]
[[File:1 Exp PE Analogic Sensor.png|thumb|400px|AN Analogic 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

= AN Analogic sensor properties =

This sensor board allows monitoring of 4-20mA or 0-10V signal from compatible probe

= Wiring =


[[File:MS008 config2.jpeg|picture of sensor pcb and box]]

{| class="wikitable"
|+Probe settings
|-
|number of wires
|jumpers configuration
|Probe connection
|-
|rowspan="3"|4 wires
|JP2 jumper on 1-2 
|rowspan="3"|FORCE+ IN+ IN- FORCE-
|-
|JP3 NC
|-
|JP4 NC
|-
|rowspan="3"|3 wires
|JP2 jumper on 2-3
|rowspan="3"|FORCE+ IN+ IN-
|-
|JP3 NC
|-
|JP4 jumper ON 
|-
|rowspan="3"|2 wires
|JP2 jumper on 1-2
|rowspan="3"|IN+ IN-
|-
|JP3 jumper ON
|-
|JP4 jumper ON 
|}







== Digital input ==
{{#lst:NIS-IO_Digital_Sensor|Input Electrical Characteristics}}

 Label DIGITAL_IN

 Label JP1
;jumper on 1-2 : Pull down configuration
;jumper on 2-3 : Pull up configuration
;no jumper : floating input

== Power output ==

 Label 12V
;Software configurable low-current voltage source. Hardware configurable until 15V. Can be used to power sensors



{| class="wikitable"
|+Current sink for 15V output voltage
|-
|current sink @15V output
|current sink @3.6V input
|Power out (mW)	
|Power in (mW)	
|Efficiency (%)
|-
|11mA
|69mA
|165	  
|248,4	  
|66
|-
|12.8mA
|79mA
|192	  
|284,4	  
|68
|-
|15.4mA
|95mA
|231	  
|342	    
|68
|-
|19.2mA
|118.9mA
|288	  
|428,04	  
|67
|-
|25.5mA
|143.9mA
|382,5	
|518,04	  
|74
|-
|38.0mA
|215.7mA
|570	  
|776,52	  
|73 
|}

<gallery>
File:Boost 15v 11mA.jpg|  Vout rising time for 11mA @15V
File:Boost 15v 12.8mA.jpg|Vout rising time for 12.8mA @15V
File:Boost 15v 15.4mA.jpg|Vout rising time for 15.4mA @15V
File:Boost 15v 19.2mA.jpg|Vout rising time for 19.2mA @15V
File:Boost 15v 25.5mA.jpg|Vout rising time for 25.5mA @15V
File:Boost 15v 38mA.jpg  |Vout rising time for 38mA @15V
</gallery>

== Ground ==

 Label GND

== Analog input ==

 Label ANALOG_IN
;12 bit ADC
;50Ω input impedance for 4-20mA configuration
;11kΩ input impedance for 0-10V configuration

=== 4-20mA mode ===

High linearity of measurements.

{| class="mw-collapsible mw-collapsed wikitable"
|+Full table of measurements made with HP34401A
|-
|uA measured
|uA command
|-
|54
|60
|-
|199
|204
|-
|487
|498
|-
|996
|1002
|-
|1490
|1501
|-
|1989
|1992
|-
|2337
|2341
|-
|2572
|2583
|-
|2962
|2972
|-
|3683
|3691
|-
|4045
|4051
|-
|4442
|4450
|-
|5042
|5051
|-
|5533
|5534
|-
|6018
|6022
|-
|6532
|6541
|-
|7005
|7012
|-
|7500
|7508
|-
|8035
|8041
|-
|8511
|8516
|-
|9016
|9024
|-
|9522
|9529
|-
|10032
|10044
|-
|10537
|10546
|-
|11045
|11062
|-
|11543
|11549
|-
|12010
|12013
|-
|12507
|12524
|-
|13020
|13032
|-
|13553
|13565
|-
|14053
|14063
|-
|14527
|14534
|-
|15063
|15068
|-
|15524
|15530
|-
|16035
|16042
|-
|16512
|16518
|-
|17020
|17034
|-
|17521
|17535
|-
|18059
|18067
|-
|18511
|18526
|-
|19023
|19038
|-
|19511
|19533
|-
|20057
|20075
|-
|20546
|20563
|}


[[File:CurrentLinearity4-20mA.png|current measurements results for 4-20mA]]

=== 0-10V Mode ===

{| class="mw-collapsible mw-collapsed wikitable"
|+Full table of measurements made with HP34401A
|-
|mV measured
|mV command
|-
|0
|0
|-
|503
|496
|-
|1003
|993
|-
|1502
|1493
|-
|2002
|1988
|-
|2502
|2487
|-
|3002
|2985
|-
|3501
|3480
|-
|4002
|3978
|-
|4501
|4477
|-
|5001
|4972
|-
|5501
|5470
|-
|6000
|5970
|-
|6500
|6467
|-
|7000
|6963
|-
|7499
|7462
|-
|7999
|7955
|-
|8499
|8453
|-
|8999
|8952
|-
|9499
|9447
|-
|9998
|9945
|-
|10498
|10444
|}

[[File:VoltageLinearity0-10V.png|voltage measurements results for0-10V]]

== Digital output ==
{{#lst:NIS-IO_Digital_Sensor|Output Electrical Characteristics}}

 Label DIGITAL_OUT


= Magnetic Switch Protocol description =
{{:NIS Generic Magnetic Switch Protocol}}

= Radio frames description =
{{:NIS Generic Application Protocol}}

== 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 <rtd_temp> field.

bit 2 : indicates the presence of <voltage> field.

bit 3 : indicates the presence of <internal_temp> field.

bit 4 : is reserved.

bit 5 : indicates the presence of <cause> field.

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) :
    <rtd_temp>: 2*<nb_meas> bytes containing the temperature values in 0.1 °C. Each temperature value is a signed integer on 16 bits in big endian [-32768..+32767].

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].

if (mask.bit5 == 1) :
    <cause>: 1 byte containing the cause of the uplink frame. It is a bit field:
        Bit 0 indicates a periodic measure
        Bit 1 indicates the high threshold exceeding (temperature > high threshold)
        Bit 2 indicates the high hysteresis exceeding (temperature < high threshold - high hysteresis)
        Bit 3 indicates the low threshold exceeding (temperature < low threshold)
        Bit 4 indicates the low hysteresis exceeding (temperature > low threshold + low hysteresis)
        Bit 5 indicates the measure has been forced manually (with magnetic switch)
    Usually <cause> field is absent when threshold detections are disabled (periodic measures only)

Thus the uplink frame format is <mask><nb_meas><rtd_temp1>...<rtd_tempN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>

Default <mask> value is 0x83 which means that the default frame is <mask><nb_meas><rtd_temp1>...<rtd_tempN>

Some examples (in hexadecimal):

    “820119”: the frame indicates one temperature measurement of +28.1 °C.
    “8302FFCB000C”: the frame indicates two temperature measurements of -5.3 °c and +1.2 °C.

== 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
    <sensor_type>: identifies the type of sensor (PT100/PT1000 and 2/3/4 wires)

It is possible to change the sensor configuration using the Nemeus downlink protocol. The downlink frame must be sent on the MS008 LoRaWAN port (10).

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 <sensor_type> 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 to 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 0.1 °C [-2000..+8000]
    <high_hysteresis>: unsigned integer on 1 byte containing the hysteresis when leaving high threshold state in 0.1 °C [0..255]

If (mask.bit5 == 1):

    <low_threshold>: signed integer on 2 bytes in little endian containing the low threshold in 0.1 °C [-2000..+8000]
    <low_hysteresis>: unsigned integer on 1 byte containing the hysteresis when leaving low threshold state in 0.1 °C [0..255]

If (mask.bit6 == 1):

    <sensor_type>: unsigned integer on 1 byte containing the sensor type [11..16]
        11(0x0B): PT100 2 wires
        12(0x0C): PT100 3 wires
        13(0x0D): PT100 4 wires
        14(0x0E): PT1000 2 wires
        15(0x0F): PT1000 3 wires
        16(0x10): PT1000 4 wires

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><sensor_type>.

Some examples in hexadecimal:

    “028182”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <rtd_temp> 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

== Power consumption ==


Please find below a tool to calculate power consumption vs number of measures and transmissions.