nemeuswiki - User contributions [en]

NIS-TH Temperature Hygrometry Sensor

2021-10-11T15:01:40Z

Arl: /* Uplink data Frame format */

[[Category:Sensors]]
[[File:2 Exp Humidity and Temperature sensor.png|thumb|400px|RTD Temperature 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

= TH Temperature Hygrometry sensor properties =

== Humidity Sensor Specification ==

Specified range : [0RH - 90RH]

Accuracy tolerance : Typ +-2% RH

Long-term drift : Typ <0.25% RH/year

== Temperature Sensor Specification ==

Specified range : [-40°C to 90°C]

Accuracy tolerance : typ +-0.3°C

Long Term Drift : max <0.03°C/year

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

bit 2 : indicates the presence of <voltage> field. Only available for versions before 19W03

bit 3 : indicates the presence of <internal_temp> field. Only available for versions before 19W03

bit 4 : indicates the presence of <th_hygro> field.

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) :
<th_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.bit4 == 1) :
<th_hygro>: 2*<nb_meas> bytes containing the hygrometry values in 0.01 %. Each hygrometry value is an unsigned integer on 16 bits in big endian [0..9999].

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.
“9201190B40”: the frame indicates one measurements of temperature +28.1 °C followed by one measurement of hygrometry of 28.8%.
“930201190120140014A0”: the frame indicates two measurements of temperature +28.1 °C.and +28.8 °C followed by two measurements of hygrometry of 51.2% and 52.8%.

== 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

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): N/A
12(0x0C): N/A
13(0x0D): ...

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 <th_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 ==

Power consumption calculator based on the number of measurements and transmissions.

NIS-NH3 Gas Sensor

2021-10-11T09:34:25Z

Arl: Created page with " NH3 Gas Sensor = General information = {{:NIS Overview}} = Mechanics = * Dimensions 60 x 95 x 85mm (109mm including..."

[[File:.png|thumb|400px|NH3 Gas 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

= NH3 Gas sensor properties =

* 0 to 100ppm ± 8ppm ± 3% (Conditions : 25°C / Hygrometry : 50% / Pression 1013 mbar)
* Humidity Range 0 to 95% rh non-condensing
* Sensor Temperature Range -20°C to +50°C
* Temperature compensation

= 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 <analog_meas> 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) :
<analog_meas>: 2*<nb_meas> bytes containing the analog measure values in ppm. Each measure 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 (analog_meas > high threshold)
Bit 2 indicates the high hysteresis exceeding (analog_meas < high threshold - high hysteresis)
Bit 3 indicates the low threshold exceeding (analog_meas < low threshold)
Bit 4 indicates the low hysteresis exceeding (analog_meas > 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><analog_meas1>...<analog_measN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>

Default <mask> value is 0x8A which means that the default frame is <mask><analog_meas><internal_temp>

Some examples (in hexadecimal):

“8A000113”: the frame indicates one analog measurement of 1ppm, with an internal temperature of 19°C.
“8A000E14”: the frame indicates one analog measurement of 14ppm, with an internal temperature of 20°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
<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):
RESERVED

If (mask.bit4 == 1):
RESERVED

If (mask.bit5 == 1):
RESERVED

If (mask.bit6 == 1):
RESERVED

Thus the downlink frame format is <cmd><mask><up_frame_mask><nb_meas_for_tx><meas_period><period_unit>.

Some examples in hexadecimal:

“028182”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <analog_meas> field only

"028604605401" set <nb_meas_for_tx> to 4, <meas_period> to 21600*<period_unit> seconds, <period_unit> to 1 second

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

TBD

NIS-TH Temperature Hygrometry Sensor

2021-10-07T17:56:28Z

Arl: /* Uplink data Frame format */

[[Category:Sensors]]
[[File:2 Exp Humidity and Temperature sensor.png|thumb|400px|RTD Temperature 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

= TH Temperature Hygrometry sensor properties =

== Humidity Sensor Specification ==

Specified range : [0RH - 90RH]

Accuracy tolerance : Typ +-2% RH

Long-term drift : Typ <0.25% RH/year

== Temperature Sensor Specification ==

Specified range : [-40°C to 90°C]

Accuracy tolerance : typ +-0.3°C

Long Term Drift : max <0.03°C/year

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

bit 2 : indicates the presence of <voltage> field. Only available for versions before 19W03

bit 3 : indicates the presence of <internal_temp> field. Only available for versions before 19W03

bit 4 : indicates the presence of <th_hygro> field.

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) :
<th_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.bit4 == 1) :
<th_hygro>: 2*<nb_meas> bytes containing the hygrometry values in 0.1 %. Each hygrometry value is an unsigned integer on 16 bits in big endian [0..9999].

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.
“9201190120”: the frame indicates one measurements of temperature +28.1 °C followed by one measurement of hygrometry of 28.8%.
“93020119012002000210”: the frame indicates two measurements of temperature +28.1 °C.and +28.8 °C followed by two measurements of hygrometry of 51.2% and 52.8%.

== 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

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): N/A
12(0x0C): N/A
13(0x0D): ...

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 <th_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 ==

Power consumption calculator based on the number of measurements and transmissions.

NIS-CO2 Gas Sensor

2021-02-10T17:06:37Z

Arl: /* Downlink Frame format */

[[File:.png|thumb|400px|CO2 Gas 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

= CO2 Gas sensor properties =

* 0 to 5000ppm ± 50ppm
* Humidity Range 0 to 95% rh non-condensing
* Sensor Temperature Range -20°C to +50°C
* Temperature compensation

[[File:CO2 temp compensation.png|400px|CO2 linearization]]

= 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 <analog_meas> 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) :
<analog_meas>: 2*<nb_meas> bytes containing the analog measure values in ppm. Each measure 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 (analog_meas > high threshold)
Bit 2 indicates the high hysteresis exceeding (analog_meas < high threshold - high hysteresis)
Bit 3 indicates the low threshold exceeding (analog_meas < low threshold)
Bit 4 indicates the low hysteresis exceeding (analog_meas > 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><analog_meas1>...<analog_measN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>

Default <mask> value is 0x8A which means that the default frame is <mask><analog_meas><internal_temp>

Some examples (in hexadecimal):

“8A013A0A”: the frame indicates one analog measurement of 314ppm, with an internal temperature of 10°C.
“8A01E014”: the frame indicates one analog measurement of 480ppm, with an internal temperature of 20°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
<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):
RESERVED

If (mask.bit4 == 1):
RESERVED

If (mask.bit5 == 1):
RESERVED

If (mask.bit6 == 1):
RESERVED

Thus the downlink frame format is <cmd><mask><up_frame_mask><nb_meas_for_tx><meas_period><period_unit>.

Some examples in hexadecimal:

“028182”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <analog_meas> field only

"028604605401" set <nb_meas_for_tx> to 4, <meas_period> to 21600*<period_unit> seconds, <period_unit> to 1 second

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

TBD

NIS-CO2 Gas Sensor

2021-02-10T16:53:09Z

Arl: /* Uplink data Frame format */

NIS-CO2 Gas Sensor

2021-02-10T16:50:38Z

Arl: /* Uplink data Frame format */

NIS-PC Pulse Sensor

2019-11-22T11:05:56Z

Arl: /* Wiring */

[[File:Exp PE pulse sensor.png|thumb|400px|Load Cell 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

= Pulse sensor properties =

* Handles open collector and dry contact inputs

* Max 50k pulses per second

* broken cable detection

The pullup resistor (1Mohm / 3.3V) is integrated.
Perfect for use with reed switches.
The current flowing through the dry contact is 3.3uA.

Absolute Maximum voltage injection : 6V.

= Wiring =

[[File:Full_config_ids_3I_O.png|picture of sensor pcb and box]]

{| class="wikitable"
|+Probe settings
|-
|Input mode
|jumpers configuration
|Probe connection
|-
|rowspan="3"|dry contact
|rowspan="3"|None
|3 : GND
|-
|2 : Alert
|-
|1 : Pulse
|}

If you want to use the Alert signal, connect it to GND on the sensor side. If the cable breaks, the device detects it.

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

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

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

bit 4 : indicates the presence of <fraud_counter> field.

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) :
<pc_pulse>: 4*<nb_meas> bytes containing the Pulse counter values measure in 1 pulse. Each counter value is an unsigned integer on 32 bits in big endian [0..+4294967295].

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.bit4 == 1)
<fraud_counter>: 1*<nb_meas> bytes containing the fraud counter values (using MCU internal sensor). Each fraud_counter value is an unsigned integer on 8 bits in big endian.

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 (value > high threshold)
Bit 2 indicates the high hysteresis exceeding (value < high threshold - high hysteresis)
Bit 3 indicates the low threshold exceeding (value < low threshold)
Bit 4 indicates the low hysteresis exceeding (value > 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><pc_pulse1>...<pc_pulseN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>

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

Some examples (in hexadecimal):

“8200009C40”: the frame indicates one Pulse measurement of 40 000 pulses.
“8302001e8480002dc6c0”: the frame indicates two pulse measurements of 2.10^6 pulses and 3.10^6 pulses.

== 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 <pc_pulse> field only
“028192”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <pc_pulse> and <fraud_counter> fields
“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

'''Note :''' Alarm on Pulse counter should be managed carefully as the counter only goes up. So an high_threshold should be updated when alarm is reached, in order to allow another alarm. 

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

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

File:Full config ids 3I O.png

2019-11-22T11:03:25Z

Arl: Arl uploaded a new version of File:Full config ids 3I O.png

NIS-PC Pulse Sensor

2019-11-22T10:49:18Z

Arl: /* Wiring */

[[File:Exp PE pulse sensor.png|thumb|400px|Load Cell 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

= Pulse sensor properties =

* Handles open collector and dry contact inputs

* Max 50k pulses per second

* broken cable detection

The pullup resistor (1Mohm / 3.3V) is integrated.
Perfect for use with reed switches.
The current flowing through the dry contact is 3.3uA.

Absolute Maximum voltage injection : 6V.

= Wiring =

[[File:Full_config_ids_3I_O.png|picture of sensor pcb and box]]

{| class="wikitable"
|+Probe settings
|-
|Input mode
|jumpers configuration
|Probe connection
|-
|rowspan="3"|open collector
|rowspan="3"|JP1 on 1-2 and JP2 : NC
|3 : GND
|-
|2 : Alert
|-
|1 : Pulse
|-
|rowspan="3"|dry contact
|rowspan="3"|JP1 on 2-3 and JP2 : NC
|3 : GND
|-
|2 : Alert
|-
|1 : Pulse
|}

If you want to use the Alert signal, connect it to GND on the sensor side. If the cable breaks, the device detects it.

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

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

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

bit 4 : indicates the presence of <fraud_counter> field.

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) :
<pc_pulse>: 4*<nb_meas> bytes containing the Pulse counter values measure in 1 pulse. Each counter value is an unsigned integer on 32 bits in big endian [0..+4294967295].

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.bit4 == 1)
<fraud_counter>: 1*<nb_meas> bytes containing the fraud counter values (using MCU internal sensor). Each fraud_counter value is an unsigned integer on 8 bits in big endian.

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 (value > high threshold)
Bit 2 indicates the high hysteresis exceeding (value < high threshold - high hysteresis)
Bit 3 indicates the low threshold exceeding (value < low threshold)
Bit 4 indicates the low hysteresis exceeding (value > 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><pc_pulse1>...<pc_pulseN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>

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

Some examples (in hexadecimal):

“8200009C40”: the frame indicates one Pulse measurement of 40 000 pulses.
“8302001e8480002dc6c0”: the frame indicates two pulse measurements of 2.10^6 pulses and 3.10^6 pulses.

== 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 <pc_pulse> field only
“028192”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <pc_pulse> and <fraud_counter> fields
“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

'''Note :''' Alarm on Pulse counter should be managed carefully as the counter only goes up. So an high_threshold should be updated when alarm is reached, in order to allow another alarm. 

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

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

NIS-PC Pulse Sensor

2019-11-22T10:47:02Z

Arl: /* Wiring */

[[File:Exp PE pulse sensor.png|thumb|400px|Load Cell 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

= Pulse sensor properties =

* Handles open collector and dry contact inputs

* Max 50k pulses per second

* broken cable detection

The pullup resistor (1Mohm / 3.3V) is integrated.
Perfect for use with reed switches.
The current flowing through the dry contact is 3.3uA.

Absolute Maximum voltage injection : 6V.

= Wiring =

[[File:Full_config_ids_3I_O.png|picture of sensor pcb and box]]

{| class="wikitable"
|+Probe settings
|-
|Input mode
|jumpers configuration
|Probe connection
|-
|rowspan="8"|open collector
|rowspan="8"|JP1 on 1-2 and JP2 : NC
|3 : GND
|-
|2 : Alert
|-
|1 : Pulse
|-
|rowspan="8"|dry contact
|rowspan="8"|JP1 on 2-3 and JP2 : NC
|3 : GND
|-
|2 : Alert
|-
|1 : Pulse
|}

If you want to use the Alert signal, connect it to GND on the sensor side. If the cable breaks, the device detects it.

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

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

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

bit 4 : indicates the presence of <fraud_counter> field.

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) :
<pc_pulse>: 4*<nb_meas> bytes containing the Pulse counter values measure in 1 pulse. Each counter value is an unsigned integer on 32 bits in big endian [0..+4294967295].

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.bit4 == 1)
<fraud_counter>: 1*<nb_meas> bytes containing the fraud counter values (using MCU internal sensor). Each fraud_counter value is an unsigned integer on 8 bits in big endian.

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 (value > high threshold)
Bit 2 indicates the high hysteresis exceeding (value < high threshold - high hysteresis)
Bit 3 indicates the low threshold exceeding (value < low threshold)
Bit 4 indicates the low hysteresis exceeding (value > 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><pc_pulse1>...<pc_pulseN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>

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

Some examples (in hexadecimal):

“8200009C40”: the frame indicates one Pulse measurement of 40 000 pulses.
“8302001e8480002dc6c0”: the frame indicates two pulse measurements of 2.10^6 pulses and 3.10^6 pulses.

== 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 <pc_pulse> field only
“028192”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <pc_pulse> and <fraud_counter> fields
“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

'''Note :''' Alarm on Pulse counter should be managed carefully as the counter only goes up. So an high_threshold should be updated when alarm is reached, in order to allow another alarm. 

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

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

NIS-PC Pulse Sensor

2019-11-22T10:46:10Z

Arl: /* Wiring */

[[File:Exp PE pulse sensor.png|thumb|400px|Load Cell 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

= Pulse sensor properties =

* Handles open collector and dry contact inputs

* Max 50k pulses per second

* broken cable detection

The pullup resistor (1Mohm / 3.3V) is integrated.
Perfect for use with reed switches.
The current flowing through the dry contact is 3.3uA.

Absolute Maximum voltage injection : 6V.

= Wiring =

[[File:Full_config_ids_3I_O.png|picture of sensor pcb and box]]

{| class="wikitable"
|+Probe settings
|-
|Input mode
|jumpers configuration
|Probe connection
|-
|rowspan="8"|open collector
|rowspan="8"|JP1 on 1-2 and JP2 : NC
|1 : NC
|-
|2 : NC
|-
|3 : NC
|-
|4 : NC
|-
|5 : NC
|-
|6 : GND
|-
|7 : Alert
|-
|8 : Pulse
|-
|rowspan="8"|dry contact
|rowspan="8"|JP1 on 2-3 and JP2 : NC
|1 : NC
|-
|2 : NC
|-
|3 : NC
|-
|4 : NC
|-
|5 : NC
|-
|6 : GND
|-
|7 : Alert
|-
|8 : Pulse
|}

If you want to use the Alert signal, connect it to GND on the sensor side. If the cable breaks, the device detects it.

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

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

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

bit 4 : indicates the presence of <fraud_counter> field.

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) :
<pc_pulse>: 4*<nb_meas> bytes containing the Pulse counter values measure in 1 pulse. Each counter value is an unsigned integer on 32 bits in big endian [0..+4294967295].

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.bit4 == 1)
<fraud_counter>: 1*<nb_meas> bytes containing the fraud counter values (using MCU internal sensor). Each fraud_counter value is an unsigned integer on 8 bits in big endian.

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 (value > high threshold)
Bit 2 indicates the high hysteresis exceeding (value < high threshold - high hysteresis)
Bit 3 indicates the low threshold exceeding (value < low threshold)
Bit 4 indicates the low hysteresis exceeding (value > 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><pc_pulse1>...<pc_pulseN><voltage1>...<voltageN><internal_temp1>...<internal_tempN><cause>

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

Some examples (in hexadecimal):

“8200009C40”: the frame indicates one Pulse measurement of 40 000 pulses.
“8302001e8480002dc6c0”: the frame indicates two pulse measurements of 2.10^6 pulses and 3.10^6 pulses.

== 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 <pc_pulse> field only
“028192”: set the <up_frame_mask> to 0x82 => the next uplink frames will include the <pc_pulse> and <fraud_counter> fields
“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

'''Note :''' Alarm on Pulse counter should be managed carefully as the counter only goes up. So an high_threshold should be updated when alarm is reached, in order to allow another alarm. 

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

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

File:Full config ids 3I O.png

2019-11-22T10:45:49Z

Arl:

MG003-L-EU Firmware Update Procedure

2019-11-20T11:11:39Z

Arl:

[[Category:Gateways]]

=== Prerequisites ===

* You must use the last version of the Java gateway tool available here: http://store.nemeus.fr/apps/gatewayTool/v1.54/
* Your gateway must have an access to the Internet. Ensure that your router allows UDP flows on port 2225 (both senses)
* You must send an email to support@nemeus.fr containing the following information:
** Your identification (company, name, address, phone number)
** The Ethernet MAC address of your gateway, you can read it on the sticker or with the Java gateway tool in DHCP tab (it is the field "Source MAC @"). This information is required to allow our gateways supervision server to update your gateway

[[File:Mg003 firmware update 1.png]]

=== Procedure ===

Connect Java gateway tool to your gateway
In SNET tab in "Security Server information" part, set tools.nemeus.fr in "Server name" field and 2225 in "Port" field

Then click on "Write" button and wait several seconds until the configuration is written in the gateway
Finally click on "Reset Gateway" button to restart the gateway with its new configuration

This configuration allows the gateway to communicate with our gateways supervision server.

[[File:Mg003 firmware update 2.png]]

The server will update automatically your gateway if it has been beforehand allowed.
The firmware update procedure lasts several minutes, thus do not cut neither the power-supply nor the Ethernet connection.

NIS-CO2 Gas Sensor

2018-06-21T10:14:46Z

Arl:

NIS-CO2 Gas Sensor

2018-06-21T10:09:35Z

Arl:

File:CO2 temp compensation.png

2018-06-21T10:09:19Z

Arl:

NIS-CO2 Gas Sensor

2018-06-21T10:08:57Z

Arl:

NIS-CO2 Gas Sensor

2018-06-21T10:07:34Z

Arl: /* CO2 Gas sensor properties */

[[File:.png|thumb|400px|Load Cell 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

= CO2 Gas sensor properties =

* 0 to 5000ppm ± 50ppm
* Humidity Range 0 to 95% rh non-condensing
* Sensor Temperature Range -20°C to +50°C
* Temperature compensation

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

Some examples (in hexadecimal):

“820119”: the frame indicates

== 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)

The downlink frame has the following format:

<cmd>: 1 byte containing WRITE_CFG_CMD=0x02

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

TBD

NIS-CO2 Gas Sensor

2018-06-21T10:06:50Z

Arl: Created page with " Load Cell Sensor = General information = {{:NIS Overview}} = Mechanics = * Dimensions 60 x 95 x 85mm (109mm includin..."

[[File:.png|thumb|400px|Load Cell 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

= CO2 Gas sensor properties =

* 0 to 5000ppm ± 50ppm
* Humidity Range 0 to 95% rh non-condensing
* Sensor Temperature Range -20°C to +50°C

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

Some examples (in hexadecimal):

“820119”: the frame indicates

== 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)

The downlink frame has the following format:

<cmd>: 1 byte containing WRITE_CFG_CMD=0x02

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

TBD

NIS Overview

2018-06-06T09:43:56Z

Arl: /* Environment */

== Overview ==
;LoRa™ WAN 1.0.2 EU Class A & C
: Activation by Personalization (ABP)
: Over-The-Air Activation (OTAA)
;SIGFOX™ ready
;Fully certified on major LoraWan & Sigfox networks
;Easy to use and deploy
;3.6V / 2200mAh Primary battery Li-SOCl2 embedded
;Magnetic switch and LED to ease the installation
;RoHS conform / Pre-Certified ETSI EN 300-220 / RED compliance under certification

=== RF Performance ===
* TX Power 14 dBm (25 mW)
* RX Sensitivity -137 dBm
* Approx. 10 km range
* Integrated PCB antenna

=== Environment ===
* Operating temperature -40°C to +85°C
* Storage temperature 30°C recommended (to limit battery self-discharge)
* Rel. humidity 0% to 95% (not condensing)

=== Options ===
* External antenna
* SDK for your SW development purposes
* 10-30V external power supply
* Compatible with the NEMEUS PicoGateway for private networks

== Installation ==

By using the internal antenna, the position of the sensor is critical.

Install your product as high as possible, and prefer unobstructed area (concrete and metal are the worst materials).

If you cannot fulfill these conditions, it is still possible to use an optional external antenna.

NIS-PC Pulse Sensor

2018-05-17T09:32:09Z

Arl: /* Pulse sensor properties */

NIS-RP Repeater

2018-05-16T15:56:24Z

Arl: /* Power consumption */

[[File:|thumb|400px|Repeater]]

= 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

= Features =

*Compatible with Nemeus NIS series of sensors.

*Low requirements on sensors of other brands to make them repeatable. Contact us for a complete list of requirements.

*Allows to increase the network coverage, and to reach uncovered areas.

*by software configuration, two possible modes:
** LoRawan sensor repeater to Lorawan network.
** LoRawan sensor repeater to Sigfox network.

*Very high autonomy thanks to a fine management of the sensor listening windows.

*Dual battery to reach the same autonomy as the sensors.

*possibility to repeat several sensors with the same repeater.

*Configuration in ABP or OTAA protocol.

*The repeater can use the sensor identifiers (transparent mode), or use its own identifiers (encapsulated mode).

*Fully bidirectional, it can also repeat the downlink channel, with delay.

= Power consumption =

Power consumption calculator based on the number of sensors to repeat and output network.

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

NIS-RP Repeater

2018-05-16T15:55:54Z

Arl:

NIS-TH Temperature Hygrometry Sensor

2018-05-07T07:03:55Z

Arl: /* TH Temperature Hygrometry sensor properties */

[[Category:Sensors]]
[[File:2 Exp Humidity and Temperature sensor.png|thumb|400px|RTD Temperature 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

= TH Temperature Hygrometry sensor properties =

== Humidity Sensor Specification ==

Specified range : [0RH - 90RH]

Accuracy tolerance : Typ +-2% RH

Long-term drift : Typ <0.25% RH/year

== Temperature Sensor Specification ==

Specified range : [-40°C to 90°C]

Accuracy tolerance : typ +-0.3°C

Long Term Drift : max <0.03°C/year

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

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

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

bit 4 : indicates the presence of <th_hygro> field.

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) :
<th_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.bit4 == 1) :
<th_hygro>: 2*<nb_meas> bytes containing the hygrometry values in 0.01 %. Each hygrometry value is an unsigned integer on 16 bits in big endian [0..9999].

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

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): N/A
12(0x0C): N/A
13(0x0D): ...

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 <th_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 ==

Power consumption calculator based on the number of measurements and transmissions.

MG003-L-EU Configuration Tool Java

2018-05-03T10:07:26Z

Arl: /* Installation / Execution */

[[Category:Gateways]]

=== Prerequisite ===

Nemeus Java application to control the gateway requests that the JAVA Runtime Evaluation 8 kit is installed onto the computer. This one can be found on [http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html http://www.oracle.com/technetwork/java/javase/downloads/jre8-downloads-2133155.html ])

=== Installation / Execution ===

Nemeus JAVA Application is made of only one file : o_NemeusCustomerGateway.jar. This one can be put in any folder.To execute the JAVA application, the following command must be executed in a Command DOS windows in the folder in which the file is available.

[http://store.nemeus.fr/apps/gatewayTool/ Nemeus Java Gateway Application] Used to manage the gateway via Network interface

java -jar o_NemeusCustomerGateway.jar

=== Logs ===

During execution, the JAVA application records information in a log file which is created in same folder of the .jar file at the time this one is started. The generated log file stays the same during all the JAVa application execution. The file format is log-mgw-<xxxxx> where xxxx corresponds to the date and time of the JAVA application start

=== master window ===
The following figure gives an overview of the JAVA application.

[[File:Mg003-screenshot-start.png|thumb|mg003 Java screenshoot start]]

This one is based on followings
# The application title and the version of application on top
# The Action window on the left side
# The configuration folder on the right side
# The configuration parameters in the center windows
# The devices configuration (LoRa WAN server configuration) at the bottom left

NIS-IO Digital Sensor

2018-04-17T12:06:14Z

Arl:

[[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"
|+4 Inputs Device wiring
|-
|rowspan="2"|IN0
|1 : IN0+
|rowspan="8"|JP1 1-2 : No pull for voltage input JP1 2-3 : Pull-up for dry contact
|-
|2 : GND
|-
|rowspan="2"|IN1
|3 : IN1+
|-
|4 : GND
|-
|rowspan="2"|IN2
|5 : IN2+
|-
|6 : GND
|-
|rowspan="2"|IN3
|7 : GND
|-
|8 : IN3+
|}

== Hardware description ==
<section begin=Input Electrical Characteristics />
=== Input Electrical Characteristics ===

Two modes selectable with jumper:
* Voltage level detection, polarity agnostic
* Integrated pull-UP for dry contact input

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

<section begin=Output Electrical Characteristics />
=== Output Electrical Characteristics ===
* ESD Protected
* Thermal shutdown with auto restart
* Short circuit and overload protection
* Overvoltage protection
* Current limitation
* Can drive resistive, inductive and capacitive loads

;Maximum Voltage 42V
;ON resistance 50mΩ
;Nominal load current 3A
<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 ==

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

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(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 ==

NIS-AX Motion Sensor

2018-03-08T16:29:31Z

Arl: /* get the samples from the fifo */

[[File:2 Exp Motion 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

= Accelerometer sensor properties =

This sensor has full scales of ±2g/±4g/±8g/±16g and is capable of measuring accelerations with output data rates from 1 Hz to 5.3 kHz.

* Impact detection
* Tilt measurement
* 3D orientation measurement
* Activity and inactivity duration measurement
* vibration monitoring system

This sensor can check the vibrational footprint and thus the health status of your machine several times a day and provide data to the server. This system makes it possible to carry out maintenance based on reliability by anticipating problems. This system also allows daily measurements to be made on machines in dangerous, remote and inaccessible locations.
It can detect whether the machine is running or not.

== Frequency response (mg/Hz) ==

=== Comparison for 80Hz vibration ==

[[File:Computer-80Hz-vibration.png|400px]]
[[File:Embedded-80Hz-vibration.png|400px]]

=== Comparison for 230Hz vibration ==

[[File:Computer-230Hz-vibration.png|400px]]
[[File:Embedded-230Hz-vibration.png|400px]]

=== Comparison for 330Hz vibration ==

[[File:Computer-330Hz-vibration.png|400px]]
[[File:Embedded-330Hz-vibration.png|400px]]

=== Comparison for 430Hz vibration ==

[[File:Computer-430Hz-vibration.png|400px]]
[[File:Embedded-430Hz-vibration.png|400px]]

=== Comparison for 530Hz vibration ==

[[File:Computer-530Hz-vibration.png|400px]]
[[File:Embedded-530Hz-vibration.png|400px]]

== Freefall tests ==
To test human fall, we made tests at 1344Hz.
These tests were carried out from a height of 75 cm, representing a worse case, where the fall is from a very low height.

[[File:Freefall-75cm-1344Hz-states.png|400px]]

=== state 1 ===
Initial state, in the case shown, gravity appears on the Z axis, the sensor being positioned horizontally.

=== state 2 ===
Free fall, we get an acceleration that decreases for a short moment. That's the condition we can detect. The vectorial sum of the 3 axes tends towards 0G.
in our example, the stable part of the free fall lasts about 230ms for a height of 75cm.

From the measurement, we can see that a correct threshold would be 3000 raw. Which is 183mg. (3000/16384, because +-2g: 4g dynamic on 16bits: 16384 raw per 1g)
For the THS_REG: 1 LSb = 16 mg @ FS = ±2 g leads to 11 (183/16).

=== state 3 ===
Impact. For the test carried out, the impact took place on a flexible surface (foam). Nevertheless, we can measure a large shock. The idea is to detect this activity following the detection of free fall.

=== state 4 ===
bouncing. Following the impact, a few jolts may appear, depending on the environment in which the fall occurs.

=== state 5 ===
After a fall, the human body may not move for some time. The vector sum always corresponds to gravity, however the sensor may have changed its orientation.

=== tests with different ODR values ===

[[File:Freefall-75cm-25Hz-states3.png|400px]]

==== get the samples from the fifo ====
Following the interruption of freefall, the previous 32 samples are recovered, and we continue to retrieve the subsequent samples.
Thanks to this process, it is possible to analyze the buffer and condition the alert accordingly.

[[File:Freefall-75cm-25Hz-interrupt-FF-reverse.png|400px]]

NIS-AX Motion Sensor

2018-03-08T15:19:40Z

Arl: /* get the samples from the fifo */

[[File:2 Exp Motion 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

= Accelerometer sensor properties =

This sensor has full scales of ±2g/±4g/±8g/±16g and is capable of measuring accelerations with output data rates from 1 Hz to 5.3 kHz.

* Impact detection
* Tilt measurement
* 3D orientation measurement
* Activity and inactivity duration measurement
* vibration monitoring system

This sensor can check the vibrational footprint and thus the health status of your machine several times a day and provide data to the server. This system makes it possible to carry out maintenance based on reliability by anticipating problems. This system also allows daily measurements to be made on machines in dangerous, remote and inaccessible locations.
It can detect whether the machine is running or not.

== Frequency response (mg/Hz) ==

=== Comparison for 80Hz vibration ==

[[File:Computer-80Hz-vibration.png|400px]]
[[File:Embedded-80Hz-vibration.png|400px]]

=== Comparison for 230Hz vibration ==

[[File:Computer-230Hz-vibration.png|400px]]
[[File:Embedded-230Hz-vibration.png|400px]]

=== Comparison for 330Hz vibration ==

[[File:Computer-330Hz-vibration.png|400px]]
[[File:Embedded-330Hz-vibration.png|400px]]

=== Comparison for 430Hz vibration ==

[[File:Computer-430Hz-vibration.png|400px]]
[[File:Embedded-430Hz-vibration.png|400px]]

=== Comparison for 530Hz vibration ==

[[File:Computer-530Hz-vibration.png|400px]]
[[File:Embedded-530Hz-vibration.png|400px]]

== Freefall tests ==
To test human fall, we made tests at 1344Hz.
These tests were carried out from a height of 75 cm, representing a worse case, where the fall is from a very low height.

[[File:Freefall-75cm-1344Hz-states.png|400px]]

=== state 1 ===
Initial state, in the case shown, gravity appears on the Z axis, the sensor being positioned horizontally.

=== state 2 ===
Free fall, we get an acceleration that decreases for a short moment. That's the condition we can detect. The vectorial sum of the 3 axes tends towards 0G.
in our example, the stable part of the free fall lasts about 230ms for a height of 75cm.

From the measurement, we can see that a correct threshold would be 3000 raw. Which is 183mg. (3000/16384, because +-2g: 4g dynamic on 16bits: 16384 raw per 1g)
For the THS_REG: 1 LSb = 16 mg @ FS = ±2 g leads to 11 (183/16).

=== state 3 ===
Impact. For the test carried out, the impact took place on a flexible surface (foam). Nevertheless, we can measure a large shock. The idea is to detect this activity following the detection of free fall.

=== state 4 ===
bouncing. Following the impact, a few jolts may appear, depending on the environment in which the fall occurs.

=== state 5 ===
After a fall, the human body may not move for some time. The vector sum always corresponds to gravity, however the sensor may have changed its orientation.

=== tests with different ODR values ===

[[File:Freefall-75cm-25Hz-states3.png|400px]]

==== get the samples from the fifo ====
Following the interruption of freefall, the previous 32 samples are found again, and we continue to retrieve the following samples.
Thanks to this process, it is possible to analyze the buffer and condition the alert accordingly.

[[File:Freefall-75cm-25Hz-interrupt-FF-reverse.png|400px]]

NIS-AX Motion Sensor

2018-03-08T15:15:26Z

Arl: /* Freefall tests */

[[File:2 Exp Motion 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

= Accelerometer sensor properties =

This sensor has full scales of ±2g/±4g/±8g/±16g and is capable of measuring accelerations with output data rates from 1 Hz to 5.3 kHz.

* Impact detection
* Tilt measurement
* 3D orientation measurement
* Activity and inactivity duration measurement
* vibration monitoring system

This sensor can check the vibrational footprint and thus the health status of your machine several times a day and provide data to the server. This system makes it possible to carry out maintenance based on reliability by anticipating problems. This system also allows daily measurements to be made on machines in dangerous, remote and inaccessible locations.
It can detect whether the machine is running or not.

== Frequency response (mg/Hz) ==

=== Comparison for 80Hz vibration ==

[[File:Computer-80Hz-vibration.png|400px]]
[[File:Embedded-80Hz-vibration.png|400px]]

=== Comparison for 230Hz vibration ==

[[File:Computer-230Hz-vibration.png|400px]]
[[File:Embedded-230Hz-vibration.png|400px]]

=== Comparison for 330Hz vibration ==

[[File:Computer-330Hz-vibration.png|400px]]
[[File:Embedded-330Hz-vibration.png|400px]]

=== Comparison for 430Hz vibration ==

[[File:Computer-430Hz-vibration.png|400px]]
[[File:Embedded-430Hz-vibration.png|400px]]

=== Comparison for 530Hz vibration ==

[[File:Computer-530Hz-vibration.png|400px]]
[[File:Embedded-530Hz-vibration.png|400px]]

== Freefall tests ==
To test human fall, we made tests at 1344Hz.
These tests were carried out from a height of 75 cm, representing a worse case, where the fall is from a very low height.

[[File:Freefall-75cm-1344Hz-states.png|400px]]

=== state 1 ===
Initial state, in the case shown, gravity appears on the Z axis, the sensor being positioned horizontally.

=== state 2 ===
Free fall, we get an acceleration that decreases for a short moment. That's the condition we can detect. The vectorial sum of the 3 axes tends towards 0G.
in our example, the stable part of the free fall lasts about 230ms for a height of 75cm.

From the measurement, we can see that a correct threshold would be 3000 raw. Which is 183mg. (3000/16384, because +-2g: 4g dynamic on 16bits: 16384 raw per 1g)
For the THS_REG: 1 LSb = 16 mg @ FS = ±2 g leads to 11 (183/16).

=== state 3 ===
Impact. For the test carried out, the impact took place on a flexible surface (foam). Nevertheless, we can measure a large shock. The idea is to detect this activity following the detection of free fall.

=== state 4 ===
bouncing. Following the impact, a few jolts may appear, depending on the environment in which the fall occurs.

=== state 5 ===
After a fall, the human body may not move for some time. The vector sum always corresponds to gravity, however the sensor may have changed its orientation.

=== tests with different ODR values ===

[[File:Freefall-75cm-25Hz-states3.png|400px]]

==== get the samples from the fifo ====
Following the interruption of freefall, the previous 32 samples are found again, and we continue to retrieve the following samples.
Thanks to this process, it is possible to analyze the buffer and condition the alert accordingly.
[[File:Freefall-75cm-25Hz-interrupt-FF-reverse.png|400px]]

File:Freefall-75cm-25Hz-interrupt-FF-reverse.png

2018-03-08T15:12:17Z

Arl:

NIS-AX Motion Sensor

2018-03-08T14:08:07Z

Arl: /* state 2 */

NIS-AX Motion Sensor

2018-03-08T13:53:06Z

Arl: /* Freefall tests */

[[File:2 Exp Motion 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

= Accelerometer sensor properties =

This sensor has full scales of ±2g/±4g/±8g/±16g and is capable of measuring accelerations with output data rates from 1 Hz to 5.3 kHz.

* Impact detection
* Tilt measurement
* 3D orientation measurement
* Activity and inactivity duration measurement
* vibration monitoring system

This sensor can check the vibrational footprint and thus the health status of your machine several times a day and provide data to the server. This system makes it possible to carry out maintenance based on reliability by anticipating problems. This system also allows daily measurements to be made on machines in dangerous, remote and inaccessible locations.
It can detect whether the machine is running or not.

== Frequency response (mg/Hz) ==

=== Comparison for 80Hz vibration ==

[[File:Computer-80Hz-vibration.png|400px]]
[[File:Embedded-80Hz-vibration.png|400px]]

=== Comparison for 230Hz vibration ==

[[File:Computer-230Hz-vibration.png|400px]]
[[File:Embedded-230Hz-vibration.png|400px]]

=== Comparison for 330Hz vibration ==

[[File:Computer-330Hz-vibration.png|400px]]
[[File:Embedded-330Hz-vibration.png|400px]]

=== Comparison for 430Hz vibration ==

[[File:Computer-430Hz-vibration.png|400px]]
[[File:Embedded-430Hz-vibration.png|400px]]

=== Comparison for 530Hz vibration ==

[[File:Computer-530Hz-vibration.png|400px]]
[[File:Embedded-530Hz-vibration.png|400px]]

== Freefall tests ==
To test human fall, we made tests at 1344Hz.
These tests were carried out from a height of 75 cm, representing a worse case, where the fall is from a very low height.

[[File:Freefall-75cm-1344Hz-states.png|400px]]

=== state 1 ===
Initial state, in the case shown, gravity appears on the Z axis, the sensor being positioned horizontally.

=== state 2 ===
Free fall, we get an acceleration that decreases for a short moment. That's the condition we can detect. The vectorial sum of the 3 axes tends towards 0G.
in our example, the stable part of the free fall lasts about 230ms for a height of 75cm.

=== state 3 ===
Impact. For the test carried out, the impact took place on a flexible surface (foam). Nevertheless, we can measure a large shock. The idea is to detect this activity following the detection of free fall.

=== state 4 ===
bouncing. Following the impact, a few jolts may appear, depending on the environment in which the fall occurs.

=== state 5 ===
After a fall, the human body may not move for some time. The vector sum always corresponds to gravity, however the sensor may have changed its orientation.

=== tests with different ODR values ===

[[File:Freefall-75cm-25Hz-states3.png|400px]]

File:Freefall-75cm-25Hz-states3.png

2018-03-08T13:52:02Z

Arl:

NIS-AX Motion Sensor

2018-03-08T11:48:48Z

Arl: /* state 2 */

[[File:2 Exp Motion 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

= Accelerometer sensor properties =

This sensor has full scales of ±2g/±4g/±8g/±16g and is capable of measuring accelerations with output data rates from 1 Hz to 5.3 kHz.

* Impact detection
* Tilt measurement
* 3D orientation measurement
* Activity and inactivity duration measurement
* vibration monitoring system

This sensor can check the vibrational footprint and thus the health status of your machine several times a day and provide data to the server. This system makes it possible to carry out maintenance based on reliability by anticipating problems. This system also allows daily measurements to be made on machines in dangerous, remote and inaccessible locations.
It can detect whether the machine is running or not.

== Frequency response (mg/Hz) ==

=== Comparison for 80Hz vibration ==

[[File:Computer-80Hz-vibration.png|400px]]
[[File:Embedded-80Hz-vibration.png|400px]]

=== Comparison for 230Hz vibration ==

[[File:Computer-230Hz-vibration.png|400px]]
[[File:Embedded-230Hz-vibration.png|400px]]

=== Comparison for 330Hz vibration ==

[[File:Computer-330Hz-vibration.png|400px]]
[[File:Embedded-330Hz-vibration.png|400px]]

=== Comparison for 430Hz vibration ==

[[File:Computer-430Hz-vibration.png|400px]]
[[File:Embedded-430Hz-vibration.png|400px]]

=== Comparison for 530Hz vibration ==

[[File:Computer-530Hz-vibration.png|400px]]
[[File:Embedded-530Hz-vibration.png|400px]]

== Freefall tests ==
To test human fall, we made tests at 1344Hz.
These tests were carried out from a height of 75 cm, representing a worse case, where the fall is from a very low height.

[[File:Freefall-75cm-1344Hz-states.png|400px]]

=== state 1 ===
Initial state, in the case shown, gravity appears on the Z axis, the sensor being positioned horizontally.

=== state 2 ===
Free fall, we get an acceleration that decreases for a short moment. That's the condition we can detect. The vectorial sum of the 3 axes tends towards 0G.
in our example, the stable part of the free fall lasts about 230ms for a height of 75cm.

=== state 3 ===
Impact. For the test carried out, the impact took place on a flexible surface (foam). Nevertheless, we can measure a large shock. The idea is to detect this activity following the detection of free fall.

=== state 4 ===
bouncing. Following the impact, a few jolts may appear, depending on the environment in which the fall occurs.

=== state 5 ===
After a fall, the human body may not move for some time. The vector sum always corresponds to gravity, however the sensor may have changed its orientation.

NIS-AX Motion Sensor

2018-03-08T11:45:45Z

Arl: /* Accelerometer sensor properties */

[[File:2 Exp Motion 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

= Accelerometer sensor properties =

This sensor has full scales of ±2g/±4g/±8g/±16g and is capable of measuring accelerations with output data rates from 1 Hz to 5.3 kHz.

* Impact detection
* Tilt measurement
* 3D orientation measurement
* Activity and inactivity duration measurement
* vibration monitoring system

This sensor can check the vibrational footprint and thus the health status of your machine several times a day and provide data to the server. This system makes it possible to carry out maintenance based on reliability by anticipating problems. This system also allows daily measurements to be made on machines in dangerous, remote and inaccessible locations.
It can detect whether the machine is running or not.

== Frequency response (mg/Hz) ==

=== Comparison for 80Hz vibration ==

[[File:Computer-80Hz-vibration.png|400px]]
[[File:Embedded-80Hz-vibration.png|400px]]

=== Comparison for 230Hz vibration ==

[[File:Computer-230Hz-vibration.png|400px]]
[[File:Embedded-230Hz-vibration.png|400px]]

=== Comparison for 330Hz vibration ==

[[File:Computer-330Hz-vibration.png|400px]]
[[File:Embedded-330Hz-vibration.png|400px]]

=== Comparison for 430Hz vibration ==

[[File:Computer-430Hz-vibration.png|400px]]
[[File:Embedded-430Hz-vibration.png|400px]]

=== Comparison for 530Hz vibration ==

[[File:Computer-530Hz-vibration.png|400px]]
[[File:Embedded-530Hz-vibration.png|400px]]

== Freefall tests ==
To test human fall, we made tests at 1344Hz.
These tests were carried out from a height of 75 cm, representing a worse case, where the fall is from a very low height.

[[File:Freefall-75cm-1344Hz-states.png|400px]]

=== state 1 ===
Initial state, in the case shown, gravity appears on the Z axis, the sensor being positioned horizontally.

=== state 2 ===
Free fall, we get an acceleration that decreases for a short moment. That's the condition we can detect. The vectorial sum of the 3 axes tends towards 0G.

=== state 3 ===
Impact. For the test carried out, the impact took place on a flexible surface (foam). Nevertheless, we can measure a large shock. The idea is to detect this activity following the detection of free fall.

=== state 4 ===
bouncing. Following the impact, a few jolts may appear, depending on the environment in which the fall occurs.

=== state 5 ===
After a fall, the human body may not move for some time. The vector sum always corresponds to gravity, however the sensor may have changed its orientation.

File:Freefall-75cm-1344Hz-states.png

2018-03-08T10:22:28Z

Arl:

NIS-MB Modbus Modem

2018-03-06T17:36:25Z

Arl: /* Wiring */

[[Category:Sensors]]
[[File:|thumb|400px|Modbus Modem]]

= 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

= Features =

* three modes: UART CMOS level, RS232 and RS485 bus.
* Modbus slave device.
* allows to connect a PLC to sigfox or LoRaWAN network.

= Wiring =

[[File:Full config ids.png|picture of sensor pcb and box]]

{| class="wikitable"
|+Target settings
|-
|Target connection
|-
|1 : GND
|-
|2 : GND
|-
|3 : CMOS_UART_TX
|-
|4 : CMOS_UART_RX
|-
|5 : A_RS485
|-
|6 : B_RS485
|-
|7 : RX_RS232
|-
|8 : TX_RS232
|-
|}

JP1 and JP2 are NC.

By software configuration, three possible modes are available: UART CMOS level, RS232 and RS485 bus.

Connect your power supply to the terminal block as shown in the picture.

NIS-MB Modbus Modem

2018-03-06T17:35:52Z

Arl: Created page with "Category:Sensors Modbus Modem = General information = {{:NIS Overview}} = Mechanics = * Dimensions 60 x 95 x 85mm (109mm including fixing brackets)..."

[[Category:Sensors]]
[[File:|thumb|400px|Modbus Modem]]

= 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

= Features =

* three modes: UART CMOS level, RS232 and RS485 bus.
* Modbus slave device.
* allows to connect a PLC to sigfox or LoRaWAN network.

= Wiring =

[[File:Full config ids.png|picture of sensor pcb and box]]

{| class="wikitable"
|+Target settings
|-
|Target connection
|-
|1 : GND
|-
|2 : GND
|-
|3 : CMOS_UART_TX
|-
|4 : CMOS_UART_RX
|-
|5 : A_RS485
|-
|6 : B_RS485
|-
|7 : RX_RS232
|-
|8 : TX_RS232
|-
|}

By software configuration, three possible modes are available: UART CMOS level, RS232 and RS485 bus.

Connect your power supply to the terminal block as shown in the picture.

NIS-RP Repeater

2018-03-06T15:50:22Z

Arl: Created page with "Repeater = General information = {{:NIS Overview}} = Mechanics = * Dimensions 60 x 95 x 85mm (109mm including fixing brackets) * 96mm spacing between b..."

[[File:|thumb|400px|Repeater]]

= 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

= Features =

*Compatible with Nemeus NIS series of sensors.

*Low requirements on sensors of other brands to make them repeatable. Contact us for a complete list of requirements.

*Allows to increase the network coverage, and to reach uncovered areas.

*by software configuration, two possible modes:
** LoRawan sensor repeater to Lorawan network.
** LoRawan sensor repeater to Sigfox network.

*Very high autonomy thanks to a fine management of the sensor listening windows.

*Dual battery to reach the same autonomy as the sensors.

*possibility to repeat several sensors with the same repeater.

*Configuration in ABP or OTAA protocol.

*The repeater can use the sensor identifiers (transparent mode), or use its own identifiers (encapsulated mode).

*Fully bidirectional, it can also repeat the downlink channel, with delay.

= Power consumption =

Power consumption depends on the number of measurements and transmissions.

NIS-LX Luminosity Sensor

2018-03-06T13:46:54Z

Arl:

[[File:Exp PE light sensor.png|thumb|400px|Luminosity 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

= Luminosity sensor properties =
* ADC resolution 16 bits
* From 5.7m lux to 10000 lux
* low power
* high sensitivity
* Optional RGB spectral response
* reject IR in light sources
* rejects 50Hz and 60Hz flicker caused by artificial light sources

= Wiring =

There is nothing to be wired, because the sensor is integrated. It is mounted on the surface of the housing cover.

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

Some examples (in hexadecimal):

“820119”: the frame indicates

== 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)

The downlink frame has the following format:

<cmd>: 1 byte containing WRITE_CFG_CMD=0x02

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

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

NIS-LX Luminosity Sensor

2018-03-06T13:42:42Z

Arl: Created page with " Luminosity Sensor = General information = {{:NIS Overview}} = Mechanics = * Dimensions 60 x 95 x..."

[[File:Exp PE light sensor.png|thumb|400px|Luminosity 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

= Luminosity sensor properties =

* low power
* high sensitivity
* Optional RGB spectral response
* reject IR in light sources
* rejects 50Hz and 60Hz flicker caused by artificial light sources

= Wiring =

There is nothing to be wired, because the sensor is integrated. It is mounted on the surface of the housing cover.

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

Some examples (in hexadecimal):

“820119”: the frame indicates

== 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)

The downlink frame has the following format:

<cmd>: 1 byte containing WRITE_CFG_CMD=0x02

== Power consumption ==

Power consumption calculator based on the number of measurements and transmissions.

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

MM002-xx-EU AT Commands

2018-02-26T09:32:28Z

Arl: /* AT+RF=SPER, */

[[Category:MM002]]
[[Category:Modules]]
AT commands are used as an interface with Nemeus Communication modules. Modules can be driven at 3 different levels:

* Radio level: embedded AT server uses RF SX127x driver API (LoRa™and FSK modulations can be used).
* LoRa™WAN level: embedded AT server uses LoRa™WAN library API(available only when the library is present in embedded software).
* SIGFOX™ level: embedded AT server uses SIGFOX™ library API(available only when the library is present in embedded software).

'''When radio level is used''', no device personalization is required, it is up to AT client application to implement network layer according to the network the device is attached (the module doesn’t know the network).

'''When LoRa™WAN level is used''', the device is personalized with the following parameters:

* Whatever the activation type, a 64 bits device unique identifier.
* When Activation By Personalization (ABP) is used:
** An AES128 network security key for MIC computation and encryptionof MAC control commands on port 0.
** An AES128 application security key for encryption of applicationpayloads (not required when data encryption is disabled on themodule).
* When Over The Air Activation (OTAA) is used:
** A 64 bits application unique identifier.
** An AES128 application Key used to derive the network andapplication security keys.

In first software versions (before 15W40) the module generates unique identifiers and keys, these default LoRa™WAN personalization parameters are modifiable by AT commands. It allows customers to personalize their devices according to the network operator rules.

In further software versions, modules are personalized with Nemeus OUI during production phase and they can’t be modified. In this case the device unique identifier is read-only and the AES128 keys are hidden. The application unique identifier is still modifiable by AT command.

'''When SIGFOX™ level is used''', the device is personalized with the following parameters:

* The read-only device unique identifier.
* The hidden AES128 security key.
* The initial read-only Portability Access Code (PAC).

Before driving the module, the AT client application must activate the level it wants to use.

Only one level can be activated at a time.

When activating a level, a previously activated level is automatically deactivated.

[[File:Mm002_serial_diagram.png|center|500px]]
 
For evaluation/test purpose, Nemeus recommends to use NemeusATK java application to drive the module.
 
{{TOC limit|3}}

== UART configuration ==

The UART configuration for Modem connection is as follows:

* Baud Rate : 38400
* Data : 8 bits
* Parity : None
* Stop : 1 bit
* Flow control : None
* End line character : <LF>

 
 

E.g. Typical configuration given by ‘stty’ command on linux:

''speed 38400 baud; rows 0; columns 0; line = 0;''

''intr = ^C; quit = ^\; erase = ^?; kill = ^U; eof = ^D; eol = <undef>; eol2 = <undef>;swtch = <undef>; start = ^Q; stop = ^S; susp = ^Z; rprnt = ^R; werase = ^W; lnext = ^V;flush = ^O; min = 1; time = 0;''

''-parenb -parodd cs8 hupcl -cstopb cread clocal –crtsct signbrk -brkint -ignpar -parmrk -inpck -istrip -inlcr -igncr -icrnl -ixon -ixoff –iuclc -ixany -imaxbel -iutf8''

''-opost -olcuc -ocrnl -onlcr -onocr -onlret -ofill -ofdel nl0 cr0 tab0 bs0 vt0 ff0 -isig -icanon -iexten -echo -echoe -echok -echonl -noflsh -xcase -tostop –echoprt -echoctl -echoke''

 

== AT commands ==

----
At command are split according to communication layers. This is a list of main AT commands for SW given in ‘compatibility’ paragraph. The full list and limitation can be found in SW delivery note.

Formalism is the following:

 
 
[[File:AT-command-line.png|center]]
 
 

For each group among RF, RFRX, RFTX, MAC and SFX, the command AT+<group>= HELP describes available sub-commands. Example:

AT+MAC= HELP
+MAC: <cmd>,<param_1>,…,<param_N>
+MAC: <cmd> are ON,OFF,?,SET,SCH,RCH,STI,RTI,SRX,RRX,SNDTXT,SNDBIN,RCVTXT,RCVBIN,STOPRCV,SNDLCR,DEVUID,DEVADDR,APPUID,APPKEY,NSKEY,APPSKEY
+MAC: <cmd>? Lists parameters of <cmd> if any
OK

When a sub-command has parameter, AT+<group>= <cmd>? Describes the parameter list. Example:

AT+MAC=SNDTXT?
+MAC: SNDTXT,<textpayload>,<nbrepeat>,<port>,<mode>
OK

When command is unknown “command not found (‘try help’)” is returned.

AT commands are not cancelable, thus AT client application must wait for AT response before sending a new command.

 

== Generic Parameter description ==

----
Following table describes mains parameters used with AT commands.

 

{| border="1"
|-
|
'''Values'''

|
'''Description'''

|
'''Type'''

|-
|
'''<mod>'''

|
Modulation to be use

|
LORA/FSK

|-
|
'''<freq>'''

|
Carrier frequency

|
Expressed in Hertz *

|-
|
'''<pwr>'''

|
Tx power (range depends on Module definition; e.g. MM001 -1dBm to 14dBm)

|
In dBm *

 

|-
|
'''<bw>'''

|
Bandwidth from 125kHz to 500 kHz

|
In Hertz *

 

|-
|
'''<dr>'''

|
Spreading Factor in LoRa mode

Data rate in FSK mode

|
6/7 to 12 *

In kb/s

|-
|
'''<cr>'''

|
Coding Rate (LoRa mode only)

|
1 to 4

|-
|
'''<min/maxdr>'''

|
Data rate range

|
SF7BW125 to SF12BW125, SF7BW250 or FSK50KBPS

|-
|
'''<tx/rxcrcon>'''

|
Flag for CRC check activation in TX or RX

|
True or false

|-
|
'''<preamble>'''

|
Length of the preamble

|
6 to 65535

|-
|
'''<f_dev>'''

|
Frequency deviation (FSK mode only)

|
 

|-
|
'''<fixed_len>'''

|
When true, PHY payload is constant (no header)

|
True or false

|-
|
'''<tx/rxiqinv'''

|
Flag for IQ inversion in TX or RX (LoRa mode only)

|
True or false

|-
|
'''<rxw1>'''

|
Delay before RX windows 1

|
In ms

|-
|
'''<rxw2>'''

|
Delay before RX windows 2 ; NOTE: rx_w2 must be longer than rx_w1.

|
In ms

|-
|
'''<tstamp>'''

|
Rx ot Tx timestamp

|
In ticks

|-
|
'''<symbtimeout>'''

|
Number of symbols before RX timeout

|
5 to 1023

|-
|
'''<port>'''

|
MAC port

|
0 to 10

|-
|
'''<textpayload>'''

|
Payload to send or received payload in ASCII

|
ASCII string

|-
|
'''< binarypayload>'''

|
Payload to send or received payload in hexadecimal coded in ASCII

|
ASCII string containing 0 to F characters

|-
|
'''<chan>'''

|
Identifies one of the 8 MAC channels

|
0 to 7

|-
|
'''<enable>'''
|
Indicates the status of a channel
|
True or false
|-
|
'''<nbrepeat>'''
|
Number of repetitions when sending a payload.

At MAC level this parameter indicates if data confirmed must be used or not (0 means unacked mode>).

|
0 to N

|-
|
'''<interval>'''
|
Time interval between repetitions
|
In ms
|-
|
'''<hexaddress>'''
|
Address of a registry in hexadecimal
|
 
|-
|
'''<nbbytes>'''
|
 
|
0 to 4
|-
|
'''<byteN>'''
|
Byte to write
|
0x00 to 0xFF
|-
|
'''<margin>'''
|
Link demodulation margin above the demodulation floor computed by the nearest gateway
|
0 to 254 in dB
|-
|
'''<gwcnt>'''
|
Number of gateways which received the MAC message
|
1 to N
|-
|
'''<devuid>'''
|
Device unique identifier
|
8 bytes
|-
|
'''<devaddr>'''
|
Device address (4 LSB of <devuid>)
|
4 bytes
|-
|
'''<more>'''
|
Indicates if more downlink data is pending
|
true or false
|-
|
'''<mode>'''
|
LoRa MAC transmission mode
|
0 for confirmed data
not 0 for unconfirmed data
|-
|
'''<rxw1freq>'''
|
Channel frequency used for Rx window 1

|
In Hz, 0 means same as Tx frequency

|-
|
'''<eirp>'''

|
Effective Isotropic Radiated Power received in TxParamSetupReq (Asian band only)

|
In dBm

|-
|
'''<updwell>'''

|
Uplink dwell time received in TxParamSetupReq (Asian band only)

|
0 means no limit

1 means 400 ms

|-
|
'''<dwdwell>'''

|
Downlink dwell time received in TxParamSetupReq (Asian band only)

|
0 means no limit

1 means 400 ms

|-
|
'''<backoff>'''

|
Ack mode retransmission back-off procedure

|
false means disabled

true means enabled

|}
 

* Depends on Module in use

 

== Generic Response description ==

----
 

Every AT command send a response of one of the following types:

 

{| border="1"
|-
|
'''Values'''

|
'''Description'''

|
'''Visible output'''

|-
|
 

|
'''Generic'''

|
 

|-
|
'''<CR><LF>OK<CR><LF>'''

|
OK response

 

|
OK

|-
|
'''<CR><LF>ERROR<CR><LF>'''

|
ERROR response

 

|
ERROR

|-
|
'''<CR><LF>ERROR NOACK<CR><LF>'''

|
ERROR response due to a missing ACK

|
ERROR_NOACK

 

|-
|
'''<CR><LF>+MAC: '''

|
Response from MAC layer

 

|
+MAC:

|-
|
'''<CR><LF>+RFTX: '''

|
Response from RF layer (TX)

 

|
+RFTX:

|-
|
'''<CR><LF>+RFRX: '''

|
Response from RF layer (RX)

 

|
+RFRX:

|-
|
'''<CR><LF>+DEBUG: '''

|
Response from debug layer

|
+DEBUG:

|-
|
 

|
 

|
 

|}
 

 

 

 

 

== AT Generic commands ==

----
Intentionally left blank

 

 

 

 

 

 

== AT RF commands ==

----
RF commands are dealing with the RF Layer. This layer should be started before using most of RF commands listed in this section (unless stated otherwise).

3 groups of commands exist:

* +RF group: commands common to TX and RX functions.
* +RFTX group: commands dedicated to TX functions.
* +RFRX group: commands dedicated to RX functions.
 
----
=== AT+RF=HELP ===

This command is used to know the list of sub-commands.

==== Response ====

OK.

==== Example ====
AT+RF=HELP
+RF: <cmd>
+RF: <cmd> are ON,OFF,?,RPER,SPER,RSW,SSW
+RF: <cmd>? Lists parameters of <cmd> if any
OK
 
----
=== AT+RF=ON ===

This command is used to start RF layer (Radio driver) and is mandatory in order to use most of RF commands listed in this section (unless otherwise stated).

==== Response ====

ERROR is returned if either LoRa™WAN stack or SIGFOX™ stack is using the radio (Tx or Rx is ongoing).

Else OK is returned.

If LoRa™WAN stack was ON (but not using the radio), it is automatically set to OFF.

If SIGFOX™ stack was ON (but not using the radio), it is automatically set to OFF.

 
----
=== AT+RF=OFF ===

This command is used to stop RF layer (Radio driver). After calling this command, most of RF commands listed in this section will return ERROR (unless stated otherwise).

RF layer stop (Radio driver).

==== Response ====

Always OK.

 
----
=== AT+RF=? ===

This command is used to read the current RF layer state.

==== Response ====

Always OK.

==== Example ====
AT+RF=?
+RF: OFF
OK
 
----
=== AT+RF=RPER ===

This command is used to read the Packet Error Rate state.

==== Response ====

Always OK.

==== Example ====
AT+RF=RPER
+RF: false
OK
 
----
=== AT+RF=SPER, ===
This command is used to set the Packet Error Rate state and the power offset

The following formalism is used. It can be checked by the AT+RF=SPER?command:

+RF=SPER,<per_state>,<pwroffset>,<loracsoffset>,<fskcsoffset>,<freqcoffset>

<per_state> PER state, unchanged when absent.

<pwroffset> is the Power offset

<loracoffset> is the RSSI Power offset in LoRa (dB)

<fskcoffset> is the RSSI Power offset in Fsk and Sigfox (dB)

<freqcoffset> is the frequency offset in Sigfox (Hz) (Available in 17w01 and newer versions)

When PER state is true, a counter is added at the beginning of Tx frames. This counter is used on Rx side to compute the Packet Error Rate.

==== Response ====

OK if <per_state> is “true”, “false” or omitted.

ERROR if <per_state> is syntactically incorrect.

==== Example ====
AT+RF=SPER,true
OK
 
----

=== AT+RF=RSW ===

This command is used to read the current LoRa and FSK synchro words. Synchro words are in hexadecimal format (see formalism on SSW command)

==== Response ====

Always OK.

==== Example ====
AT+RF=RSW
+RF: 12,69817E96
OK
 
----
=== AT+RF=SSW, ===
This command is used to set the synchro words.

AT+RF=SSW,<LoRa_SyncWord>,<Fsk_SyncWord>

<LoRa_SyncWord> LoRa Synchro Word (one byte)

<Fsk_SyncWord> FSK Synchro Word (up to six bytes)

A synchro word is unchanged when related parameter is absent.

==== Response ====

OK if parameters are correct or omitted.

ERROR if FSK synchro word is too long (6 bytes/12 hexa digits max) or number of digits is not even.

==== Example ====
AT+RF=SSW, 12,69817E96
OK
 
----
=== AT+RFTX=HELP ===

This command is used to know the list of sub-commands.

==== Response ====

OK.

==== Example ====
AT+RFTX=HELP
+RFTX: <cmd>,<param_1>,…,<param_N>
+RFTX: <cmd> are ?,SET,SEND,SNDTXT,SNDBIN,START,STOP
+RFTX: <cmd>? Lists parameters of <cmd> if any
OK
 
----
=== AT+RFTX=? ===

Read TX parameters. This command does not need the RF layer to be ON.

==== Response ====

Always OK.

+RFTX: <mod>,<freq>,<pwr>,<bw>,<dr>,<cr>,<txcrcon>,<preamble>,<fdev>,<fixedlen>,<txiqinv>,<rxw1>,<rxw2>,<tstamp>,<symbtimeout>,<rxiqinv>,<rxcrcon>

==== Example ====
AT+RFTX=?
+RFTX : LORA,868100000,14,125000,7,1,true,8,0,false,false,0,0,0,5,false,true
OK
 
----
=== AT+RFTX=SET, ===
Write Tx parameters. This command does not need the RF layer to be ON. Only modified parameters can be specified.

The following formalism is used. It can be checked by the '''''AT+RFTX=SET?''''' command:

+RFTX= SET,<mod>,<freq>,<pwr>,<bw>,<dr>,<cr>,<txcrcon>,<preamble>,<fdev>,<fixedlen>,<txiqinv>,<rxw1>,<rxw2>,<tstamp>,<symbtimeout>,<rxiqinv>,<rxcrcon>,<rxaftertx>

The parameters <symbtimeout>, <rxiqinv> and <rxcrcon> are used only when an Rx window is specified.

<tstamp> is the absolute clock time of the module. If the time is over, the frame is immediately transmitted. Usually this timestamp is a delay added to an Rx timestamp (feature not fully implemented)

==== Response ====

Always OK.

==== Example ====

To set the <pwr> to 12 and the <txcrcon> to false:

AT+RFTX=SET,,,12,,,,false
OK
 
----

=== AT+RFTX=SEND, (for test purpose) ===
Transmit <nb_frames> numbered frames every <interval> ms.

AT+RFTX= SEND,<nb_frames>,<interval>

Default values : <nb_frames> = 1, <interval> = 500 (ms).

If <per_state> is true (see AT+RF=SPER command), transmitted frames contain a counter on 4 bytes followed by a 32 bytes fixed pattern.

This command is used as a generator for Packet Error Rate (PER) computing.

==== Response ====

OK if <nb_frames> have been successfully sent.

ERROR if RF layer is OFF or if one frame has not been successfully sent.

==== Example ====
AT+RFTX=SEND,3,500
OK
 
----
=== AT+RFTX=START (for test purpose) ===

FSK continuous transmission.

==== Response ====

OK if RF layer is ON.

ERROR if RF layer is OFF.

==== Example ====
AT+RFTX=START
OK
 
----
=== AT+RFTX=STOP (for test purpose) ===

Stop FSK continuous transmission.

==== Response ====

OK if RF layer is ON.

ERROR if RF layer is OFF.

==== Example ====
AT+RFTX=STOP
OK
 
----
=== AT+RFTX=SNDTXT, ===
Repeat <nbrepeat> text frames every 500 ms.

AT+RFTX= SNDTXT,<txt>,<nbrepeat>

Default values : <nbrepeat> = 1.

<txt> parameter is transmitted as received on serial link, the module doesn’t manage any character set.

If <per_state> is true (see AT+RF=SPER command), a 4 bytes counter is added at the beginning of the frame.

==== Response ====

OK if <nbrepeat> have been successfully sent.

ERROR if RF layer is OFF or if one frame has not been successfully sent.

==== Example ====
AT+RFTX=SNDTXT,HELLO WORLD,3
OK
 
----
=== AT+RFTX=SNDBIN, ===
Repeat <nbrepeat> binary frames every 500 ms.

AT+RFTX= SNDBIN,<bin>,<nbrepeat>

Default values : <nbrepeat > = 1

<bin> parameter is hexadecimal coded in ASCII (2 ASCII characters for 1 binary byte).

If <per_state> is true (see AT+RF=SPER command), a 4 bytes counter is added at the beginning of the frame.

==== Response ====

OK if <nbrepeat> have been successfully sent.

ERROR if RF layer is OFF or if one frame has not been successfully sent.

==== Example ====

To send 2 times the 3 bytes 1A 2B 3C:

AT+RFTX=SNDBIN,1A2B3C,2
OK
 
----
=== AT+RFRX=HELP ===

This commandis used to know the list of sub-commands.

==== Response ====

OK.

==== Example ====
AT+RFRX=HELP
+RFRX: <cmd>,<param_1>,…,<param_N>
+RFRX: <cmd> are ?,SET,RECV,START,STOP,CONTRX,LVL
+RFRX: <cmd>? Lists parameters of <cmd> if any
OK
 
----
=== AT+RFRX=? ===

Read RX parameters.

==== Response ====

Always OK.

+RFRX: <mod>,<freq>,<bw>,<dr>,<cr>,<rxcrcon>,<fixedlen>,<rxiqinv>,<''timeout''>,<''symbtimeout''>,<lnaboost>

<''timeout''> and <''symbtimeout''> parameters are no more used by radio stack (they are still present for compatibility with previous module versions).

==== Example ====
AT+RFRX=?
,true
OK
 
----
=== AT+RFRX=SET, ===
Set Rx parameters. Only modified parameter can be specified.

The following formalism is used. It can be check by the '''''AT+RFRX=SET?'''''command:<mod>,<freq>,<bw>,<dr>,<cr>,<rxcrcon>,<fixedlen>,<rxiqinv>,<''timeout''>,<''symbtimeout''>,<lnaboost>

<''timeout''> and <''symbtimeout''> parameters are no more used by radio stack (they are still present for compatibility with previous module versions).

==== Response ====

Always OK

==== Example ====

To set <dr> parameter to 7:

AT+RFRX=SET,,,,7
OK
 
----
=== AT+RFRX=RECV (for test purpose) ===

Single frame reception with PER computation if <per_state> is true (see +RF=SPER command).

RF layer comes back to IDLE state after reception or after AT+RFRX=STOP command.

==== Response ====

OK if RF layer is ON and not already receiving.

ERROR if RF layer is OFF or is already receiving.

+RFRX: <per>,<rssi>,<snr>,<crcerr>,<tstamp>,<binary payload>

Then, when a frame is received the unsolicited response below is sent:

If <per_state> is true (see +RF=SPER command):

+RFRX: 100%,-35.00,7.00,0,1521551302,12000000CAFEDECA…

Where 100% is the PER, -35.00 is the RSSI level, 7.00 is the SNR, 0 is “no CRC error”, 1521551302 is the Rx clock time in ms and 12000000CAFEDECA is the received payload, starting with the 4 bytes counter.

If <per_state> is false:

+RFRX: ,-35.00,7.00,0,1521551302,CAFEDECA…

PER is not displayed and the 4 bytes counter is not present in the payload (it means that Tx device also has <per_state> set to false.

After frame reception the Rx is automatically stopped.

==== Example ====
AT+RFRX=RECV
OK
+RFRX: 100%,-35.00,7.00,0,1521551302,12000000CAFEDECA
 
----
=== AT+RFRX=START (for test purpose) ===

Continuous reception with PER computation if <per_state> is true (see +RF=SPER command).

RF layer stays in RX until Rx stop command is sent (see AT+RFRX=STOP)

==== Response ====

OK if RF layer is ON and not already receiving.
ERROR if RF layer is OFF or is already receiving.

When a TX has been performed during Reception, An AT+RFRX=STOP command may be needed to avoid ERROR from this command

After frame reception RF layer stays in RX (RX stop command must be used to leave RX mode).

==== Example ====
AT+RFRX=START
OK
+RFRX: 100%,-35.00,7.00,0,1521551302,12000000CAFEDECA
+RFRX: 100%,-32.00,7.00,0,1521554506,13000000CAFEDECA
…
 
----
=== AT+RFRX=STOP ===

Stop single or continuous reception.

==== Response ====

OK if RF layer is in RX.

ERROR if RF layer is not in RX.

==== Example ====
AT+RFRX=STOP
OK
 
----
=== AT+RFRX=CONTRX ===

Continuous reception without PER computation.

==== Response ====

OK if RF layer is ON and not already receiving.

ERROR if RF layer is OFF or is already receiving.

Then, for each received frame, the unsolicited response below is sent:

+RFRX: <rssi>,<snr>,<crcerr>,<tstamp>,<binary payload>

 
----
=== AT+RFRX=LVL (for test purpose) ===

Last reception parameters read (RSSI, SNR)

==== Response ====

OK if RF layer is ON.

ERROR if RF layer is OFF.

Response information is as below:

+RFRX: LVL,<rssi>,<snr>

==== Example ====
AT+RFRX=LVL
+RFRX: LVL,-77.00,8.00
OK
 
----
=== Informative examples ===

==== LoRa Communication ====

Below is an example where two Modules are configured to communicate on a specific frequency.

First we setup the Module A and start a continuous RX, then we can setup the Module B.

 

'''Module A'''

{| border="0"
|-
|
AT+RF=ON
OK
|
:Set the RF ON
|-
|
AT+RFRX=SET,LORA,,125000,7
OK
|
:Set some RX parameters. Let the channel to default frequency
|-
|
AT+RFRX=CONTRX
OK
|
:Start a Continuous RX
|-
|
…..
|
:Wait RX (set module B)
|-
|
+RFRX: -78.00,3.00,0,152987007,CAFE
|
:receive 0xCAFE hexa frame, rssi -78, snr 3, at timestamp 152987007 ms
|-
|
AT+RFRX=STOP
|
:Stop continuous Rx
|}
'''Module B'''

{| border="0"
|-
|
AT+RF=ON
OK
|
:Set the RF ON
|-
|
AT+RFTX=SET,LORA,868100000,14,125000,7
OK
|
:set Tx modulation LoRa, freq 868100000, Tx power 14dbm, bandwidth 125KHz, SF7
|-
|
AT+RFTX=SNDBIN,CAFE,1
OK
|
:send 0xCAFE hexa frame 1 time
|-
|
…..
|
:
|}
 

==== FSK Communication ====

Below is an example where two Modules are configured to communicate on a specific frequency. For FSK some rules apply on selected "bandwith/datarate" in RX and "frequency deviation/datarate" in TX. This is described in ([[MM002-xx-EU datasheet#Reference|sx1272 datasheet]])

First we setup the Module A and start a continuous RX, then we can setup the Module B.

 

'''Module A'''

{| border="0"
|-
|
AT+RF=ON
OK
|
:Set the RF ON
|-
|
AT+RFRX=SET,FSK,868100000,125000,1200
OK
|
:Set some RX parameters.freq 868100000,Bandwith 125 000, Datarate 1200
|-
|
AT+RFRX=CONTRX
OK
|
:Start a Continuous RX
|-
|
…..
|
:Wait RX (set module B)
|-
|
+RFRX: -78.00,3.00,0,152987007,CAFE
|
:receive 0xCAFE hexa frame, rssi -78, snr 3, at timestamp 152987007 ms
|-
|
AT+RFRX=STOP
|
:Stop continuous Rx
|}
'''Module B'''

{| border="0"
|-
|
AT+RF=ON
OK
|
:Set the RF ON
|-
|
AT+RFTX=SET,FSK,868100000,14,,1200,,,,50000
OK
|
:set Tx modulation FSK, freq 868100000, Tx power 14dbm, Datarate 1200, Deviation Frequency 50 000
|-
|
AT+RFTX=SNDBIN,CAFE,1
OK
|
:send 0xCAFE hexa frame 1 time
|-
|
…..
|
:
|}
 

== AT LoRa™WAN (MAC) commands ==

----
3 types of AT strings are specified:

* MAC commands: AT+MAC=<cmd>,<param1>,…,<paramN>.
* MAC solicited responses: +MAC: <param1>,…,<paramN>. These responses are sent in response to MAC commands, just before the OK response, that’s the reason why the <cmd> is not present in the solicited responses. Several solicited responses may be sent between the MAC command and the OK response.
* MAC unsolicited responses: +MAC: <cmd>,<param1>,…,<paramN>. These responses are not necessarily sent between the MAC command and the OK response, that’s the reason why the <cmd> is present in the unsolicited responses.

When an AT client application just need to send and receive frames, the following commands are used:

* AT+MAC=? to know the current MAC mode (ABP or OTAA, Class A or C).
* AT+MAC=OFF and AT+MAC=ON,… to change the MAC mode.
* AT+MAC=DEVADRR and unsolicited +MAC: DEVADDR,… to know the current state of an OTAA device.
* AT+MAC=SNDBIN,… to send uplink frame.
* +MAC: RCVBIN,… when receiving downlink frames and to know Rx windows termination.

All other commands are not really required, they are mainly used by NemeusATK Java application to manage the LoRa™WAN layer (for IOT purpose, device provisioning …).

 
----
=== AT+MAC=HELP ===

This commandis used to know the list of sub-commands.

==== Response ====

OK.

==== Example ====
AT+MAC= HELP
+MAC: <cmd>,<param_1>,…,<param_N>
+MAC: <cmd> are ON,OFF,?,SCH,RCH,SDR,RDR,STI,RTI,SRX2,RRX2,SNDTXT,SNDBIN,RCVTXT,RCVBIN,STOPRCV,SNDLCR,DEVUID,DEVADDR,APPUID,APPKEY,NSKEY,APPSKEY
+MAC: <cmd>? Lists parameters of <cmd> if any
OK
 
----
=== AT+MAC=ON, ===
This command is used to start LoRa™WAN layer and is mandatory in order to use most of MAC commands listed in this section (unless otherwise stated).

If Radio stack was ON, it is automatically set to OFF.

''AT+MAC=ON,<minor_ver>,<class>,<otaa>''

*<minor_ver> can be 1 or 3 (default is 3 for LoRa™WAN V1.0). V1 is no more maintained.
*<class> is A or C.
*<otaa> is 0 for ABP and 1 for OTAA.

==== Response ====

If SIGFOX™ stack is using the radio ERROR is returned.

Else OK is returned.

==== Example ====

Start LoRa™WAN layer in class A with OTAA:

AT+MAC=ON,3,A,1
OK
 
----

=== AT+MAC=OFF ===

Stop LoRa™WAN layer.

==== Response ====

Always OK.

 
----
=== AT+MAC=? ===

Read current LoRa™WAN layer status.

To change LoRa™WAN layer status, AT+MAC=OFF and AT+MAC=ON,… must be performed.

==== Response ====

Always OK.

+MAC: <state>,<minor_ver>,<class>,<ch_pages>,<ism_band>,<otaa>

<state> is ON, OFF or DUAL. DUAL means that LoRa™WAN and SIGFOX™ stacks are both ON.

<minor_ver> can be '''V'''1 or '''V'''3 (default is 3 for LoRa™WAN V1.0).

<class> is A or C.

<page> is the number of pages of 16 channels available at LoRa™WAN layer (in terms of memory space).

<ism_band> is 4 for EU433MHz, 7 for China779-787MHz, 8 is EU863-870MHz and 9 for US902-928MHz. ISM band can’t be modified dynamically, it is set at compilation time.

<otaa> is 0 or 2 for ABP and 1 for OTAA (2 means ABP, and OTAA is not supported by the module).

 

==== Example ====

A class A US902-928MHz device with 80 channels (5*16) which doesn’t support OTAA:

AT+MAC=?
+MAC: ON,V3,A,5,9,2
OK
 
----
=== AT+MAC=SNDBIN, ===
Binary frame transmission.

AT+MAC= SNDBIN,<binpyload>,<nbrepeat>,<port>,<mode>

If <mode> value is 0 then the frame is sent in unacknowledged mode (default value when mode is omitted).

If <mode> value is > 0, then the frame is sent in acknowledged mode.

<nbrepeat> specifies the number of repetitions in acknowledged mode (0 when omitted). In unacknowledged mode nbrep is used instead (see AT+MAC=RDR command).

If <port> is omitted then port 2 is used by default (port 1 is reserved to embedded generic application).

==== Response ====

OK if MAC is ON and frame has been successfully sent (and acked if acked mode was requested).

ERROR if MAC is OFF or frame has not been successfully sent (or not acked after repetitions if acked mode was requested).

ERROR also if SIGFOX™ stack is using the radio.

ERROR also when port is reserved regarding LoRa™WAN standard.

==== Unsolicited responses ====

The unsolicited responses below are sent when AT client application has registered to receive unsolicited events (see AT+MAC=RCH command).

+MAC: SND,<busytime>

<busytime> is in ms.

This unsolicited response can be sent 2 times:

* One time with busytime > 0 if no channel was free due to duty cycle restriction
* One time with busytime = 0 at Tx time.

 

+MAC: RCH,<chan>,,,,,<busytime>,<page>

<busytime> is in ms.

Sent for each enabled channel.

 

==== Example ====
AT+MAC=SNDBIN,1A2B3C,3,1,0
+MAC: SND,4355
+MAC: SND,0
+MAC: RCH,0,,,,,4480,0
+MAC: RCH,1,,,,,4480,0
+MAC: RCH,2,,,,,4480,0
OK
On duty cycle expiry (4480 ms after the Tx), channels become available:
+MAC: RCH,0,,,,,0,0
+MAC: RCH,1,,,,,0,0
+MAC: RCH,2,,,,,0,0
 
----
=== AT+MAC=RCVBIN, ===
Register for receiving downlink frames on specified port, payload is output as binary hexa string.

AT+MAC= RCVBIN,<port>

'''This command is no more required because all downlink frames are routed on serial link except when the port is used by an embedded application.'''

==== Response ====

OK if MAC is ON and port is valid and free.

ERROR if MAC is OFF or port is invalid or port is already used by an embedded application.

==== Unsolicited Response ====

+MAC: RCVBIN,<port>,<more>,<binarypayload>,<rssi>,<snr>

When <more> is true, it means that more downlink frames are pending in MAC server. If piggyback setting is disabled and device class is A, LoRa™WAN layer will automatically poll the server to receive more downlink frames.

The RCVBIN unsolicited response is always sent after a Tx, even if no frame has been received. It indicates the end of Rx windows.

For a class A device, it is sent when a downlink frame has been received or at the end of the Rx window 2 (if no downlink frame has been received).

For a class C device, it is sent when a downlink frame has been received or at the end of the Rx window 1 (if no downlink frame has been received).

If the Tx was in ack mode, the RCVBIN is sent before the OK (or ERROR NOACK) response of the Tx (SNDBIN or SNDTXT command).

If the Tx was in unack mode, the RCVBIN is sent after the OK response of the Tx (SNDBIN or SNDTXT command).

==== Example ====
AT+MAC= RCVBIN,2
OK

Then when a frame is received on port 2 and more downlink frames are pending:

+MAC: RCVBIN,2,true,1A2B3C4D,-43.00,7.00
 
----
=== AT+MAC=SNDTXT, ===
It is the same command as AT+MAC=SNDBIN except that the payload is interpreted as text and is transmitted as received on serial link (no translation from hexa ASCII to hexa binary is performed).

AT+MAC= SNDTXT,<textpayload>,<nbrepeat>,<port>,<mode>

Text frame transmission.

If <mode> value is 0 then the frame is sent in unacknowledged mode (default value when mode is omitted).

If <mode> value is > 0, then the frame is sent in acknowledged mode.

<nbrepeat> specifies the number of repetitions in acknowledged mode (0 when omitted). In unacknowledged mode nbrep is used instead (see AT+MAC=RDR command).

If <port> is omitted then port 2 is used by default (port 1 is reserved to embedded generic application)

==== Response ====

OK if MAC is ON and frame has been successfully sent (and acked if acked mode was requested).

ERROR if MAC is OFF or frame has not been successfully sent (or not acked after repetitions if acked mode was requested).

ERROR also if SIGFOX™ stack is using the radio.

ERROR also when port is reserved regarding LoRa™WAN standard.

==== Unsolicited responses ====

The unsolicited responses below are sent when AT client application has registered to receive unsolicited events (see AT+MAC=RCH command).

+MAC: SND,<busytime>

<busytime> is in ms.

This unsolicited response can be sent 2 times:

* One time with busytime > 0 if no channel was free due to duty cycle restriction
* One time with busytime = 0 at Tx time.

 

+MAC: RCH,<chan>,,,,,<busytime>,<page>

<busytime> is in ms.

Sent for each enabled channel.

 

==== Example ====
AT+MAC= SNDTXT,HELLO WORLD,3,1,0
+MAC: SND,4355
+MAC: SND,0
+MAC: RCH,0,,,,,4480,0
+MAC: RCH,1,,,,,4480,0
+MAC: RCH,2,,,,,4480,0
OK
On duty cycle expiry (4480 ms after the Tx), channels become available:
+MAC: RCH,0,,,,,0,0
+MAC: RCH,1,,,,,0,0
+MAC: RCH,2,,,,,0,0
 
----
=== AT+MAC=RCVTXT, ===
Register for receiving downlink frames on specified port, payload is output as text string (translation to binary hexa string is not performed).

AT+MAC=RCVTXT,<port>

'''This command is no more required because all downlink frames are routed on serial link except when the port is used by an embedded application.'''

'''By default, downlink payload are processed as binary payload, thus if the AT client application needs to receive the payload as text (without any binary hexa string translation), it must uses this command.'''

==== Response ====

OK if MAC is ON and port is valid and free.

ERROR if MAC is OFF or port is invalid or port is already used by an embedded application.

==== Unsolicited Response ====

+MAC: RCVTXT,<port>,<more>,<textpayload>,<rssi>,<snr>

When <more> is true, it means that more downlink frames are pending in MAC server. If piggyback setting is disabled and device class is A, LoRa™WAN layer will automatically poll the server to receive more downlink frames.

==== Example ====
AT+MAC=RCVTXT,2
OK

Then when a frame is received on port 2 and more downlink frames are pending:

+MAC: RCVTXT,2,true,HELLO WORLD,-43.00,7.00
 
----
=== AT+MAC= STOPRCV, ===
Unregister for receiving downlink frames on specified port.

AT+MAC=STOPRCV,<port>

==== Response ====

OK if MAC is ON and port is valid.

ERROR if MAC is OFF or port is invalid.

 

 
----
=== AT+MAC=SNDLCR, ===
Send a Link Check Request.

AT+MAC=SNDLCR,<nbrepeat>

<nbrepeat> = 0 means the LCR message is sent in unack mode on port 0.

<nbrepeat> != 0 means the LCR message is sent in ack mode on port 0 with <nbrepeat> transmissions.

==== Response ====

OK if MAC is ON and Link Check Answer has been received.

ERROR if MAC is OFF or Link Check Answer has not been received and Tx was in unack mode.

ERROR NOACK if Link Check Answer has not been received and Tx was in ack mode.

ERROR also if SIGFOX™ stack is using the radio.

Received data is sent back as

+MAC: <margin>,<gwcnt>,<rssi>,<snr>

==== Example ====
AT+MAC=SNDLCR
+MAC: 20,3,-45.00,8.00
OK
 
----
=== AT+MAC=RCH, ===
Read MAC channels command.

AT+MAC=RCH,<chan>,<page>,<unsol_evt>

<chan> specifies the channel to read (all channels of the page if omitted or if 16)

<page> specifies the channel page (all pages if omitted or if number of available pages returned by AT+MAC=? response).

<unsol_evt> specifies if unsolicited events are required (0 when not required). The unsolicited events inform the AT client application when a MAC parameter has been changed by the LoRa™WAN layer.

 

==== Response ====

OK if parameters are syntactically correct.

For each channel, the following information is output:

+MAC: <chan>,<frequency>,<mindr>,<maxdr>,<dutycycle>,<busytime>,<page>,<rxw1freq>

<chan>: the channel index in the page (0 to 15).

<frequency>: the frequency in Hz (0 means channel is disabled).

<mindr>: minimum datarate allowed on the channel.

<maxdr>: maximum datarate allowed on the channel.

<dutycycle>: restricted duty cycle assigned to the channel (applies only when more restricted than ISM regulation specification).

<busytime>: time in ms before the channel can be used again for Tx (due to duty cycle restrictions).

<page>: channel page (0 to number of available pages returned by AT+MAC=? response).

<rxw1freq>: frequency used to open Rx window 1. 0 means same frequency as <frequency> parameter (available only from LoRaWAN V1.0.2, if the parameter is absent in the response, it means the firmware version is older).

==== Unsolicited response ====

The unsolicited response below is sent when <busytime> changes and AT client application has registered to receive unsolicited events (see AT+MAC=RCH command).

+MAC: RCH,<chan>,,,,,<busytime>,<page>

==== Example ====
AT+MAC=RCH
+MAC: 0,868100000,SF12BW125,SF7BW125,100,0,0,0
+MAC: 1,868300000,SF12BW125,SF7BW125,100,0,0,869525000
+MAC: 2,868500000,SF12BW125,SF7BW125,100,0,0,0
+MAC: 3,868850000,SF12BW125,SF7BW125,1000,0,0,0
…
+MAC: 15,000000000,SF12BW125,FSK50KBPS,1,0,0,0
OK
 
----
=== AT+MAC=SCH, ===
Set MAC channel command.

AT+MAC=SCH,<chan>,<frequency>,<min_dr>,<max_dr>,<dutycycle>,<page>

Only modified parameters can be specified.

Written parameters are not saved in file system, thus they are lost after a new MAC OFF/ON or a device reset.

The parameter list can be found by '''''AT+MAC=SCH?'''''Command.

<dutycycle> is applied only if it is more restricted than the ISM regulation specification. 1 means 100%, 10 means 10%, 100 means 1%, ...

<rxw1freq> is available only from LoRaWAN V1.0.2

==== Response ====

OK if parameters are syntactically correct.

==== Unsolicited response ====

The unsolicited response below is sent when LoRa™WAN layer modifies a channel and AT client application has registered to receive unsolicited events (see AT+MAC=RCH command).

+MAC: SCH,<chan>,<frequency>,<mindr>,<maxdr>,<dutycycle>,<page>,<rxw1freq>

==== Example ====

To modify channel 0:

AT+MAC=SCH,0,868100000,SF12BW125,SF7BW125,100,0,0
OK
 
----

=== AT+MAC= RDR ===

Read current MAC datarate command.

==== Response ====

Always OK.

+MAC: <dr>,<txpwr>,<chanmask>,<chanmaskctrl>,<nbrep>,<eirp>,<updwell>,<dwdwell>

<eirp>, <updwell> and <dwdwell> parameters are present only in case of Asian band firmware

==== Unsolicited response ====

The unsolicited response below is sent when current datarate changes and AT client application has registered to receive unsolicited events (see AT+MAC=RCH command).

+MAC: RDR,<dr>,<txpwr>,<chanmask>,<chanmaskctrl>,<nbrep>,<eirp>,<updwell>,<dwdwell>

==== Example ====
AT+MAC=RDR
+MAC: SF12BW125,11,001F,0,0
OK
 
----
=== AT+MAC=SDR, ===
Set MAC data rate command.

AT+MAC=SDR,<dr>,<txpwr>,<chanmask>,<chanmaskctrl>,<nbrep>

Only modified parameters can be specified.

Written parameters are not saved in file system, thus they are lost after a new MAC OFF/ON or a device reset.

Set the data rate, Tx power and number of repetitions for uplink transmission (applied to all channels compatible with the datarate). <nbrep> applies only to unconfirmed transmissions.

<chanmask> and <chanmaskctrl> specify the channels usable for uplink access.

The parameter list can be found by '''''AT+MAC=SDR?'''''Command.

<eirp>, <updwell> and <dwdwell> parameters are present only in case of Asian band.

==== Response ====

OK if parameters are syntactically correct.

==== Example ====

To modify current datarate:

AT+MAC=SDR,SF12BW125,10,001F,0,0

 

OK
 
----
=== AT+MAC=RTI ===

Read MAC Time Information command.

Read common channel time information.

==== Response ====

Always OK.

+MAC: <rxw1>,<''rxw2''>,<symbtimeout>

==== Unsolicited response ====

The unsolicited response below is sent when current time info changes and AT client application has registered to receive unsolicited events (see AT+MAC=RCH command).

+MAC: RTI,<rxw1>,<''rxw2''>,<symbtimeout>

==== Example ====
AT+MAC= RTI
+MAC: 1000,2000,6
OK
 
----
=== AT+MAC= STI, ===
Set MAC time information command.

AT+MAC=STI,<rxw1>,<rxw2>,<symbtimeout>

Only modified parameter can be specified.

Written parameters are not saved in file system, thus they are lost after a new MAC OFF/ON or a device reset.

The parameter list can be found by '''''AT+MAC=STI?'''''Command.

The parameters <rxw1> and <symbtimeout> are common to all channels.

The <''rxw2''> parameter is no more used because <''rxw2''> value is set to <rxw1> value + 1000 ms. It is still present for compatibility with old devices.

==== Response ====

Always OK.

==== Example ====

To modify time info:

AT+MAC=STI,1000,,6
OK
 
----
=== AT+MAC=RRX ===

Read MAC Rx information command.

==== Response ====

Always OK.

+MAC: <rx2frequency>,<rx2dr>,<rx1droffset>

==== Unsolicited response ====

The unsolicited response below is sent when current Rx info changes and AT client application has registered to receive unsolicited events (see AT+MAC=RCH command).

+MAC: RRX,<rx2frequency>,<rx2dr>,<rx1droffset>

==== Example ====
AT+MAC=RRX
+MAC: 869525000,SF9BW125,0
OK
 
----
=== AT+MAC=SRX, ===
Set MAC Rx information command.

Only modified parameters can be specified.

The parameter list can be found by '''''AT+MAC=SRX?'''''Command.

The parameters are common to all channels.

==== Response ====

OK if parameters are syntactically correct.

==== Example ====

To modify Rx parameters:

AT+MAC=SRX,869525000,SF9BW125,0
OK
 
----
=== AT+MAC=RSW ===

This command is used to read the current LoRa™ and FSK synchro words used by LoRa™WAN layer. Synchro words are in hexadecimal format.

==== Response ====

Always OK.

+MAC: <LoRa™ sync_word>,<FSK sync_word>

==== Example ====
AT+MAC=RSW
+MAC: 34,C194C1
OK
 
----
=== AT+MAC=SSW, ===
This command is used to set the synchro words used by LoRa™WAN layer.

AT+MAC=SSW,<LoRaSyncWord>,<FskSyncWord>

Only modified parameters can be specified.

A synchro word is unchanged when related parameter is absent.

Synchro words are in hexadecimal.

The parameter list can be found by '''''AT+MAC=SSW?'''''Command.

==== Response ====

OK if parameters are correct or omitted.

ERROR if FSK synchro word is too long (6 bytes/12 hexa digits max) or number of digits is not even.

==== Example ====
AT+MAC=SSW,34,C194C1
OK
 
----
=== AT+MAC=RVAR ===

This command is used to read the miscellaneous LoRa™WAN variables.

This variables are Tx/Rx counters, aggregated DC and data encryption.

==== Response ====

Always OK.

+MAC: <txcounter>,<rxcounter>,<aggregateddc>,<encryption>

<aggregateddc> values: 1 means 100%, 10 means 10%, 100 means 1%, …

<encryption> values: 0 means no encryption, != 0 means encryption enabled.

==== Unsolicited response ====

The unsolicited response below is sent only when current aggregated DC changes and AT client application has registered to receive unsolicited events (see AT+MAC=RCH command).

+MAC: RVAR,,,<aggregateddc>

==== Example ====
AT+MAC=RVAR
+MAC: 0,0,1,1
OK
 
----
=== AT+MAC=SVAR, ===
This command is used to set some LoRa™WAN variables.

AT+MAC=SVAR,<txcounter>,<aggregateddc>,<encryption>

Only modified parameters can be specified.

The parameter list can be found by '''''AT+MAC=SVAR?'''''Command.

==== Response ====

Always OK.

==== Example ====

To disable encryption:

AT+MAC=SVAR,,,0
OK
 
----
=== AT+MAC=RADR ===

This command is used to read the current LoRa™WAN ADR, piggyback and back-off states.

'''The ack mode retransmission back-off procedure was initially linked to ADR bit. When ADR bit was on/off, the back-off procedure was on/off. From now, the back-off procedure is linked to the back-off state, it allows to enable ADR bit without enabling the back-off procedure. If <backoff> parameter is absent in RADR response, it means that back-off procedure is still linked to ADR bit (older firmware version).'''

==== Response ====

Always OK.

+MAC: <adr>,<piggyback>,<backoff>

<adr>, <piggyback> and <backoff> values: true or false.

==== Example ====
AT+MAC=RADR
+MAC: true,false,false
OK
 
----
=== AT+MAC=SADR, ===
This command is used to set some LoRa™WAN ADR and piggyback states.

AT+MAC=SADR,<adr>,<piggyback>,<backoff>

Only modified parameters can be specified.

The parameter list can be found by '''''AT+MAC=SADR?'''''Command.

When ADR state value is changed, ADR ack counter is reset.

==== Response ====

OK if parameters are correct.

==== Example ====

To enable piggyback:

AT+MAC=SADR,,true
OK
 
----

=== AT+MAC=RDEVUID ===

Read device unique identifier.

Device UID is coded on 8 bytes.

''This command obsoletes AT+MAC=DEVUID command.''

''Old command still works and returns the same response.''

==== Response ====

Always OK

UID is returned as

+MAC: <devuid>,<rand_seed>,<read_only>

When read_only value is 1, it means that the device unique identifier is built from Nemeus 36 bits OUI (70B3D5326xxxxxxx). In this case the device UID can’t be modified and the security keys are not readable.

==== Example ====
AT+MAC=RDEVUID
0010203,306A0327,1
OK
 
----
=== AT+MAC=SDEVUID, ===
This command is used to modify device UID.

AT+MAC=SDEVUID,<devuid>

Device UID must be writable.

If MAC layer is on in OTAA mode, a MAC off/on is automatically performed.

==== Response ====

OK if <devuid> length is 16 characters and device UID is writable.

==== Example ====
AT+MAC=SDEVUID,0102030405060708
OK
 
----
=== AT+MAC=RDEVADDR ===

Read device address.

''This command obsoletes AT+MAC=DEVADDR command.''

''Old command still works and returns the same solicited response.''

''Warning: unsolicited response changed, old one is no more sent!!!''

==== Response ====

Always OK

Address is returned as

+MAC: <devaddr>,<networkid>

In ABP mode, the device address is the 4 LSB of the device unique identifier.

In OTAA mode, the device address is assigned by the network.

==== Unsolicited response ====

The unsolicited response below is sent when device is in OTAA mode and at least one AT+MAC=? command has been sent.

+MAC: RDEVADDR,<devaddr>,<networkid>

==== Example ====

Read device address of an OTAA device when not yet joint to network:

AT+MAC=?
+MAC: ON,V3,A,1,8,1
OK
AT+MAC=RDEVADDR
+MAC: 00000000,000000
OK

After receipt of valid join accept, unsolicited response is sent:

DEVADDR,0870C367,010203
 
----
=== AT+MAC=SDEVADDR, ===
This command is used to modify device address when ABP mode is used.

AT+MAC=SDEVADDR,<devaddr>

If MAC layer is on in ABP mode, a MAC off/on is automatically performed.

==== Response ====

OK if <devaddr> length is 8 characters.

==== Example ====
AT+MAC=SDEVADDR,01020304
OK
 
----
=== AT+MAC=RAPPUID ===

Read application Unique ID.

Application UID is coded on 8 bytes.

By default it is set to 0000000000000000.

It can be modified by sending the following AT command:

AT+GA=DIND,1,8301000008xxxxxxxxxxxxxxxx0000

Where xxxxxxxxxxxxxxxx is the new application UID LSB first.

MAC layer must be restarted to take into account new application UID (AT+MAC=OFF and AT+MAC=ON).

Application UID can also be modified using AT+MAC=SAPPUID,<app_uid>.

''This command obsoletes AT+MAC=APPUID command.''

''Old command still works and returns the same response.''

==== Response ====

Always OK

Application UID is returned as

+MAC: <appuid>

==== Example ====

Read default application UID:

AT+MAC=RAPPUID
+MAC: 0000000000000000
OK

Set application UID to FEDCBA9876543210:

0000
OK

Restart MAC layer:

AT+MAC=OFF
OK
AT+MAC=ON
OK

Read new application UID:

AT+MAC=RAPPUID
+MAC: FEDCBA9876543210
OK
 
----
=== AT+MAC=SAPPUID, ===
This command is used to modify application UID.

AT+MAC=SAPPUID,<appuid>

If MAC layer is on in OTAA mode, a MAC off/on is automatically performed.

==== Response ====

OK if <appuid> length is 16 characters.

==== Example ====
AT+MAC=SAPPUID,0102030405060708
OK
 
----
=== AT+MAC=RAPPKEY ===

Read application key.

Application Key is coded on 16 bytes.

The byte order is the one you can use when you to register the key at network side.

It has been reversed compared to old AT+MAC=APPKEY response.

This command is available only when device unique identifier is not read only.

''This command obsoletes AT+MAC=APPKEY command.''

''Old command still works and returns the <appkey> in reverse order.''

==== Response ====

OK when device UID is writable.

ERROR when device UID is read only.

Application key is returned as

+MAC: <appkey>

==== Example ====
AT+MAC=RAPPKEY
+MAC: A8FA642E2E3245BB9B8CAC7E2456EF3C
OK

Old command still returns:

AT+MAC=APPKEY
+MAC: 3CEF56247EAC8C9BBB45322E2E64FAA8
OK
 
----
=== AT+MAC=RNSKEY ===

Read Network Session Key.

Network Session Key is coded on 16 bytes.

The byte order is the one you can use when you to register the key at network side.

It has been reversed compared to old AT+MAC=NSKEY response.

This command is available only when device unique identifier is not read only.

''This command obsoletes AT+MAC=NSKEY command.''

''Old command still works and returns the <nskey> in reverse order.''

==== Response ====

OK when device UID is writable.

ERROR when device UID is read only.

Network session key is returned as

+MAC: <nskey>

==== Example ====
AT+MAC=RNSKEY
+MAC: A8F1642E2E32453B9B8CAC7C2456EF72
OK

Old command still returns:

AT+MAC=NSKEY
+MAC: 72EF56247CAC8C9B3B45322E2E64F1A8
OK
 
----
=== AT+MAC=RAPPSKEY ===

Read application session key.

Application session key is coded on 16 bytes.

The byte order is the one you can use when you to register the key at network side.

It has been reversed compared to old AT+MAC=APPSKEY response.

This command is available only when device unique identifier is not read only.

''This command obsoletes AT+MAC=APPSKEY command.''

''Old command still works and returns the <appskey> in reverse order.''

==== Response ====

OK when device UID is writable.

ERROR when device UID is read only.

Application session key is returned as

+MAC: <appskey>

==== Example ====
AT+MAC=RAPPSKEY
+MAC: A8FA672E2E4245BB9ECCCA7E64F54C38
OK

Old command still returns:

AT+MAC=APPSKEY
+MAC: 384CF5647ECACC9EBB45422E2E67FAA8
OK
 
----
=== Informative examples ===
==== Device start ====

AT client application can detect a device start or restart when the unsolicited response +DEBUG: START,<version> is received. Depending on initialization timing, AT client application is not sure to receive this unsolicited response, that’s the reason why it is recommended that AT client application use AT+MAC=? command to synchronize with the device.

 

'''OTAA case:'''

 

+DEBUG: START,Nemeus-mm002-MASTER_NEMEUS_15W39-data-manager
AT+MAC=?
+MAC: ON,V3,A,1,8,1
OK
AT+MAC=RDEVADDR
+MAC: 00000000,000000
OK
+MAC: RDEVADDR,0870C367,010203

The device is ready to send uplink frames.

 

'''ABP case:'''

 

+DEBUG: START,Nemeus-mm002-MASTER_NEMEUS_15W39-data-manager
AT+MAC=?
+MAC: ON,V3,A,1,8,0
OK

The device is ready to send uplink frames.

 

 

==== Send unconfirmed binary frame ====

 

'''No downlink frame:'''

AT+MAC=SNDBIN,CAFE,0,2,0
OK
+MAC: RCVBIN,2,false,,0.00,0.00

'''One downlink frame:'''

AT+MAC=SNDBIN,CAFE,0,2,0
OK
+MAC: RCVBIN,2,false,DECA,-85.00,7.00

'''Two downlink frames and piggyback is not set:'''

AT+MAC=SNDBIN,CAFE,0,2,0
OK
+MAC: RCVBIN,2,true,DECA,-55.00,10.00
+MAC: RCVBIN,2,false,DEFC,-73.00,9.00

'''Two downlink frames and piggyback is set:'''

AT+MAC=SNDBIN,CAFE,0,2,0
OK
+MAC: RCVBIN,2,true,DECA,-55.00,10.00
AT+MAC=SNDBIN,,0,2,0
OK
+MAC: RCVBIN,2,false,DEFC,-73.00,9.00
==== Send confirmed binary frame ====

 

'''Ack received, no downlink frame:'''

AT+MAC=SNDBIN,CAFE,0,2,1
+MAC: RCVBIN,0,false,,-60.00,7.00
OK

'''Ack not received:'''

AT+MAC=SNDBIN,CAFE,0,2,1
+MAC: RCVBIN,2,false,,0.00,0.00
ERROR NOACK

'''One downlink frame:'''

AT+MAC=SNDBIN,CAFE,0,2,1
+MAC: RCVBIN,2,false,DECA,-85.00,7.00
OK

'''Two downlink frames and piggyback is not set:'''

AT+MAC=SNDBIN,CAFE,0,2,1
+MAC: RCVBIN,2,true,DECA,-55.00,10.00
OK
+MAC: RCVBIN,2,false,DEFC,-73.00,9.00

'''Two downlink frames and piggyback is set:'''

AT+MAC=SNDBIN,CAFE,0,2,1
+MAC: RCVBIN,2,true,DECA,-55.00,10.00
OK
AT+MAC=SNDBIN,,0,2,1
+MAC: RCVBIN,2,false,DEFC,-73.00,9.00
OK

 

 

 

 

 

== AT SIGFOX™ commands ==

----
These commands are available only on Nemeus modules embedding SIGFOX™ library. If the library is not embedded then ERROR is returned.

3 type of AT strings are specified:

* SF commands: AT+SF=<cmd>,<param1>,…,<paramN>.
* SF solicited responses: +SF: <param1>,…,<paramN>. These responses are sent in response to SF commands, just before the OK response, that’s the reason why the <cmd> is not present in the solicited responses. Several solicited responses may be sent between the SF command and the OK response.
* SF unsolicited responses: +SF: <cmd>,<param1>,…,<paramN>. These responses are not necessarily sent between the SF command and the OK response, that’s the reason why the <cmd> is present in the unsolicited responses.

When an AT client application just need to send and receive frames, the following commands are used:

* AT+SF=? to know the current SIGFOX™ layer state.
* AT+SF=OFF and AT+SF=ON to stop and start SIGFOX™ layer.
* AT+SF=SNDBIN,… to send uplink frame.
* AT+SF=SNDBIT,… to send uplink bit.
* AT+SF=SNDOOB to send uplink out of band message (keep alive messages).
* +SF: RCVBIN,… when receiving downlink frames.

All other commands are not really required, they are mainly used to configure SIGFOX™ layer and to perform SIGFOX™ qualification tests.

SIGFOX™ proprietary AT command set is also supported but not described in this document.

 
----
=== AT+SF=HELP ===

This commandis used to know the list of sub-commands.

==== Response ====

OK.

==== Example ====
AT+SF=HELP
+SF: <cmd>,<param_1>,…,<param_N>
+SF: <cmd> are ON,OFF,?,SNDBIN,SNDBIT,SNDOOB,SREP,RREP,STXF,RTXF,SRXF,RRXF,STXP,RTXP
+SF: <cmd>? Lists parameters of <cmd> if any
OK
 
----
=== AT+SF=ON ===

This command is used to start SIGFOX™ layer and is mandatory in order to use most of SF commands listed in this section (unless otherwise stated).

If Radio stack was ON, it is automatically set to OFF.

==== Response ====

If LoRa™WAN stack is using the radio ERROR is returned.

Else OK is returned.

==== Example ====

 

AT+SF=ON
OK
 
----
=== AT+SF=OFF ===

Stop SIGFOX™ layer.

==== Response ====

If SIGFOX™ stack is using the radio ERROR is returned.

Else OK is returned.

==== Example ====

 

AT+SF=OFF
OK
 
----
=== AT+SF=? ===

Read current SIGFOX™ layer status.

==== Response ====

If SIGFOX™ library is embedded OK is returned.

Else ERROR is returned.

+SF: <state>,<NMS_lib_ver>,<SFX_lib_ver>,<dev_id>,<initial_pac>

<state> is ON, OFF or DUAL. DUAL means that LoRa™WAN and SIGFOX™ stacks are both ON.

<NMS_lib_ver> is the version of Nemeus library used to communicate with SIGFOX™ network.

<SFX_lib_ver> is the version of SIGFOX™ library.

<dev_id> is the device unique identifier on SIGFOX™ network.

<initial_pac> is the first Portability Access Code used to register the device on SIGFOX™ network. It is used one time for first registration.

==== Example ====

 

AT+SF=?
+SF: ON,NMS-SFX-LIB-1.2,UDL1-1.6.0,000ABCDE,0123456789ABCDEF
OK
 
----
=== AT+SF=SNDBIN, ===
Binary frame transmission.

AT+SF=SNDBIN,<binpayload>,<ack>

If <ack> value is 0 then the frame is sent in unacknowledged mode (default value when <ack> is omitted).

If <ack> value is 1, then the frame is sent in acknowledged mode.

The frame is sent when channel becomes free regarding duty cycle limitations.

 

==== Response ====

+SF: <time_on_air> is sent just before the solicited response OK. The time on air is in ms, it is used by client application to manage duty cycle.

OK if SIGFOX™ layer is ON and frame has been successfully sent (and acked if ack mode was requested).

ERROR if SIGFOX™ layer is OFF or frame has not been successfully sent (or not acked after repetitions if ack mode was requested).

==== Unsolicited responses ====

An indication about Tx date:

+SF: SND,<busytime>

<busytime> is in ms.

It can be sent 2 times:

* One time with busytime > 0 if Tx subband was not free due to duty cycle restriction
* One time with busytime = 0 at Tx time.

The unsolicited response below is sent when ack mode was requested.

+SF: RCVBIN,<binpayload>,<rssi>

 

==== Example ====
AT+SF=SNDBIN,CAFE,1
+SF: SND,4576
+SF: SND,0
+SF: 6282
OK
+SF: RCVBIN,0123456789ABCDEF,-85.00
 
----
=== AT+SF=SNDBIT, ===
Bit transmission.

AT+SF=SNDBIT,<bitvalue>,<ack>

If <ack> value is 0 then the bit is sent in unacknowledged mode (default value when <ack> is omitted).

If <ack> value is 1, then the bit is sent in acknowledged mode.

==== Response ====

+SF: <time_on_air> is sent just before the solicited response OK. The time on air is in ms, it is used by client application to manage duty cycle.

OK if SIGFOX™ layer is ON and frame has been successfully sent (and acked if ack mode was requested).

ERROR if SIGFOX™ layer is OFF or frame has not been successfully sent (or not acked after repetitions if ack mode was requested).

==== Unsolicited responses ====

An indication about Tx date:

+SF: SND,<busytime>

<busytime> is in ms.

It can be sent 2 times:

* One time with busytime > 0 if Tx subband was not free due to duty cycle restriction
* One time with busytime = 0 at Tx time.

The unsolicited response below is sent when ack mode was requested.

+SF: RCVBIN,<binpayload>,<rssi>

 

==== Example ====
AT+SF=SNDBIT,0,1
+SF: SND,6422
+SF: SND,0
+SF: 4589
OK
+SF: RCVBIN,0123456789ABCDEF,-85.00
 
----
=== AT+SF=SNDOOB ===

Out Of Band message transmission.

==== Response ====

+SF: <time_on_air> is sent just before the solicited response OK. The time on air is in ms, it can be used by client application to manage duty cycle.

OK if SIGFOX™ layer is ON and frame has been successfully sent.

ERROR if SIGFOX™ layer is OFF or frame has not been successfully sent.

==== Unsolicited responses ====

An indication about Tx date:

+SF: SND,<busytime>

<busytime> is in ms.

It can be sent 2 times:

* One time with busytime > 0 if Tx subband was not free due to duty cycle restriction
* One time with busytime = 0 at Tx time.

==== Example ====
AT+SF=SNDOOB
+SF: SND,3987
+SF: SND,0
+SF: 4589
OK
 
----
=== AT+SF=RREP ===

Read Tx repetitions used in acked mode.

==== Response ====

+SF: <repeat> is sent just before the solicited response OK.

Default value is 2 repetitions.

Always OK.

==== Example ====
AT+SF=RREP
+SF: 2
OK
 
----
=== AT+SF=SREP, ===

Set Tx repetitions used in acked mode.

AT+SF=SREP,<repeatnb>

==== Response ====

Default value is 2 repetitions.

OK if number of repetitions <= 2.

ERROR if number of repetitions > 2.

==== Example ====
AT+SF=SREP,1
OK
AT+SF=SREP,3
ERROR
 
----
=== AT+SF=RTXF ===

Read output carrier macro channel.

==== Response ====

+SF: <tx_frequency> is sent just before the solicited response OK.

Default value is 868130000 Hz.

Always OK.

==== Example ====
AT+SF=RTXF
+SF: 868130000
OK
 
----
=== AT+SF=STXF, ===
Set output carrier macro channel.

==== Response ====

OK if 863000000 <= tx_frequency <= 870000000.

ERROR if tx_frequency is not in valid range.

==== Example ====
AT+SF=STXF,868200000
OK
AT+SF=STXF,862200000
ERROR
 
----
=== AT+SF=RRXF ===

Read reception carrier macro channel.

==== Response ====

+SF: <rx_frequency> is sent just before the solicited response OK.

Default value is 869525000 Hz.

Always OK.

==== Example ====
AT+SF=RRXF
+SF: 869525000
OK
 
----
=== AT+SF=SRXF, ===
Set reception carrier macro channel.

AT+SF=SRXF,<rx_frequency>

==== Response ====

OK if 863000000 <= rx_frequency <= 870000000.

ERROR if rx_frequency is not in valid range.

==== Example ====
AT+SF=SRXF,869525000
OK
AT+SF=SRXF,869525000
ERROR
 
----
=== AT+SF=RTXP ===

Read Tx power.

==== Response ====

+SF: <tx_power> is sent just before the solicited response OK.

Default value is 14 dBm.

Always OK.

==== Example ====
AT+SF=RTXP
+SF: 14
OK
 
----
=== AT+SF=STXP, ===
Set Tx power.

==== Response ====

OK if tx_power <= 14 dBm.

ERROR if tx_power > 14 dBm.

==== Example ====
AT+SF=STXP,10
OK
AT+SF=STXP,20
ERROR

 

== AT Generic command ==

----
AT Generic command can be used to activate/deactivate some generic functionalities.

 
----
=== AT+GA= DIND,1,8801 ===

This command is use to know the status of PowerSaving.

==== Response ====

+GA : DIND,1,0801<pwr_state>

Always OK.

pwr_state 00 powersaving OFF
pwr_state 01 powersaving ON

==== Example ====
AT+GA= DIND,1,8801

+GA : DIND,1,080100

OK.

 
----
=== AT+GA= DIND,1,8802<pwr_state> ===
 
'''WARNING: CONNECT CORRECTLY THE WAKEUP PIN BEFORE ACTIVATION OF POWERSAVING'''
 
This command is use to set the PowerSaving.
pwr_state 00 powersaving OFF
pwr_state 01 powersaving ON

PowerSaving can be activated once after boot-up, and from this point will go in stop mode as soon as possible and is wake-up by RTC or Wakeup pin.
Please note that once power-saving is activated, user should toggle wake-up pin before sending an AT command.

If the module is reset, the powersaving is set back to OFF. So User should ensure setting it to ON after any reset

==== Response ====

Always OK.

==== Example ====
AT+GA= DIND,1,880201

OK

 
----

== AT debug command ==

----
AT debug command can be used to activate/deactivate some debug functionalities.

 
----
=== AT+DEBUG= HELP ===

This commandis use to know the list of sub-commands.

==== Response ====

OK.

==== Example ====
AT+DEBUG= HELP
+DEBUG: <cmd>,<param_1>,…,<param_N>
+DEBUG: <cmd> are MVER,MVOFF,MVON,MV?,MEOFF,MEON,ME?,MPOFF,MPON,MP?,RREAD,RWRITE
+DEBUG: <cmd>? Lists parameters of <cmd> if any
OK
 
----
=== AT+DEBUG=MVER ===

Read Mcu software version.

Furthermore, when the device boots the software version is sent as an unsolicited response:

+DEBUG: START,<version>

This unsolicited response can be used to detect a reset of the device.

==== Response ====

Always OK.

+DEBUG: MVER,<version>

==== Example ====

AT boot:

+DEBUG: START,Nemeus 1.x

When requested:

AT+DEBUG= MVER
+DEBUG: MVER,Nemeus 1.x
OK

 

 
----
=== AT+DEBUG= MVOFF ===

Disable Mcu Verbose print on the UART

==== Response ====

Always OK.

==== Example ====
AT+DEBUG= MVOFF
OK
 
----
=== AT+DEBUG= MVON ===

Enable Mcu Verbose print on the UART

==== Response ====

OK if software is compiled with debug traces.

ERROR if software is compiled without debug traces.

==== Example ====
AT+DEBUG= MVON
OK
 
----
=== AT+DEBUG= MV? ===

Read current verbose mode.

==== Response ====

Always OK.

+DEBUG: <verbose>

==== Example ====
AT+DEBUG= MV?
+DEBUG: MVON
OK
 
----
=== AT+DEBUG= MEOFF ===

Disable UART echo mode.

==== Response ====

Always OK.

==== Example ====
AT+DEBUG= MEOFF
OK
 
----
=== AT+DEBUG= MEON ===

Enable UART echo mode.

==== Response ====

Always OK.

==== Example ====
AT+DEBUG= MEON
OK
 
----
=== AT+DEBUG= ME? ===

Read current echo mode.

==== Response ====

Always OK.

+DEBUG: <echo>

==== Example ====
AT+DEBUG= ME?
+DEBUG: MEON
OK
 
----
=== AT+DEBUG= MPOFF ===

Disable the sending of shell prompt on UART.

==== Response ====

Always OK.

==== Example ====
AT+DEBUG= MPOFF
OK
 
----
=== AT+DEBUG= MPON ===

Enable the sending of shell prompt on UART.

==== Response ====

Always OK.

==== Example ====
AT+DEBUG= MPON
OK
 
----
=== AT+DEBUG= MP? ===

Read current prompt mode.

==== Response ====

Always OK.

+DEBUG: <prompt>

==== Example ====
AT+DEBUG= MP?
+DEBUG: MPON
OK

Smart IoT Sensor - HW

2018-01-19T13:07:38Z

Arl:

[[Category:Smart IoT Sensor]]
== Features ==

{| class="wikitable"
|-
! Front !! Back
|-
| [[File:SIS_PCB_front.jpg|320px]] || [[File:SIS_PCB_back.jpg|320px]]
|-
|
* reset button
* battery connector
* micro-usb port
* micro-hdmi (reserved)
* MCU/BLE switch
* Debugger connector
||
* user button
* user LED
* charging LED
* mm002 module
* BLE module
|}

== Electrical Specification ==

== Included Modules and chipsets ==
=== LoRa/Sigfox MM002 ===

[http://www.nemeus.fr/en/nemeus-mm002-2/ NEMEUS: MM002 datasheet]

The Nemeus MM002 is wired using UART and a wakeup pin.

{| class="wikitable"
!colspan="5"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on sensor
|Function pin on Arduino
|Atmel label
|-
|28
|PA19
|TX
|RX (Serial2)
|SERCOM1/PAD[3]
|-
|27
|PA18
|RX
|TX (Serial2)
|SERCOM1/PAD[2]
|-
|9
|PA04
|WakeUp
|A3
|
|}

=== Bluetooth Smart nRF51822 ===
[http://infocenter.nordicsemi.com/pdf/nRF51822_PS_v3.1.pdf Nordic Semi: nRF51822 datasheet]

the nRF51822 is wired to an Arduino UART port. (Variant AC : 256KB Flash / 32KB Ram)

{| class="wikitable"
!colspan="7"|Pinning relations
|-
|Physical pin (SAMD)
|Physical pin (nRF51)
|Port pin (SAMD)
|Port pin (nRF51)
|Function pin on sensor
|Function pin on Arduino
|Atmel label
|-
|31
|17
|PB23
|P0.11
|TX
|RX (Serial)
|SERCOM5/PAD[3]
|-
|30
|15
|PB22
|P0.09
|RX
|TX (Serial)
|SERCOM5/PAD[2]
|}

=== GPS/GNSS SIM33ELA ===
[https://www.silabs.com/Support%20Documents/RegisteredDocs/BGM111_datasheet.pdf SIMCom: SIM33ELA datasheet]

The SIM33 GPS is wired using UART to the Arduino.

{| class="wikitable"
!colspan="5"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on sensor
|Function pin on Arduino
|Atmel label
|-
|15
|PA10
|RX
|TX (Serial1)
|SERCOM0/PAD[2]
|-
|16
|PA11
|TX
|RX (Serial1)
|SERCOM0/PAD[3]
|-
|3
|PA02
|Power enable
|A0
|
|-
|29
|PA20
|Fix GPS
|6
|
|}

== Included Sensors ==
===ADXL345===
The ADXL345 accelerometer is wired to the I2C bus, and can use two interrupts to manage acceleration events (tap, activity...).

{| class="wikitable"
!colspan="4"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on sensor
|Function pin on Arduino
|-
|31
|PA22
|SDA
|SDA
|-
|32
|PA23
|SCL
|SCL
|-
|7
|PB08
|Interrupt 1
|A1
|-
|8
|PB09
|Interrupt 2
|A2
|}

===BMP280===

The BMP280 temperature and pressure sensor is wired on I2C bus.

{| class="wikitable"
!colspan="4"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on sensor
|Function pin on Arduino
|-
|31
|PA22
|SDA
|SDA
|-
|32
|PA23
|SCL
|SCL
|}

== GPIO available ==

You can use these additional pins :
{| class="wikitable"
!colspan="3"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on Arduino
|-
|x
|GND
|x
|-
|47
|PB02
|A5
|-
|10
|PA05
|A4
|-
|9
|PA04
|A3
|-
|x
|3V3
|x
|-
|21
|PA12
|MISO
|-
|20
|PB11
|SCK
|-
|19
|PB10
|MOSI
|-
|4
|PA03
|AREF
|-
|31
|PA22
|SDA (shared with sensors)
|-
|32
|PA23
|SCL (shared with sensors)
|-
|26
|PA17
|13
|-
|30
|PA21
|7
|-
|11
|PA06
|8
|-
|12
|PA07
|9
|}

=== Additional UARTs ===

==== Remap PB10/PB11 as UART ====
PB10/11 are dedicated to SPI connection to external devices.

If you don't need SPI, you can reuse these GPIOs as another UART

{| class="wikitable"
!colspan="3"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on Arduino
|-
|23
|PB10
|MOSI / SERCOM4 TX
|-
|24
|PB11
|SCK / SERCOM4 RX
|}

==== Remap PA22/PA23 as UART ====

PA22/PA23 are already used as I2C by 2 embedded sensors :
* BMP280 (Temperature and pressure sensor)
* ADXL345 (Accelerometer)

If you don't need them, you can reuse these GPIOs as another UART

{| class="wikitable"
!colspan="3"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on Arduino
|-
|32
|PA22
|SDA / SERCOM3 TX
|-
|33
|PA23
|SCL / SERCOM3 RX
|}

==== Example of scenario ====

This scenario sends "TEST" string to the UART and prints received data coming from the UART to the serial monitor.

To test this scenario, you can connect together the RX and TX pins of the corresponding UART, you will see the "TEST" string in the serial monitor.

It uses SPI GPIOs (MOSI/SCK). If you comment the first line (SERIAL_USE_SPI_PINS), it will use the I2C GPIOs (SDA/SCL).

/* choose to remap SPI or I2C as UART */
#define SERIAL_USE_SPI_PINS

#ifdef SERIAL_USE_SPI_PINS
/*
* PB10 = MOSI = Serial3 TX = SERCOM4/PAD[2]
* PB11 = SCK = Serial3 RX = SERCOM4/PAD[3] */
Uart Serial3( &sercom4, 24, 23, SERCOM_RX_PAD_3, UART_TX_PAD_2 ) ;
#define UART_ISR SERCOM4_Handler

#else

/*
* PA22 = SDA = Serial3 TX = SERCOM3/PAD[0]
* PA23 = SCL = Serial3 RX = SERCOM3/PAD[1] */
Uart Serial3( &sercom3, 33, 32, SERCOM_RX_PAD_1, UART_TX_PAD_0 ) ;
#define UART_ISR SERCOM3_Handler

#endif

void UART_ISR()
{
Serial3.IrqHandler();
}

void setup() {
SerialUSB.begin(115200);
while(!SerialUSB){;;}

SerialUSB.println("Start");

Serial3.begin(115200);
while(!Serial3){;;}
}

void loop()
{
/* Send string to UART */
Serial3.println("TEST");
delay(1000);

while(Serial3.available())
{
/* echo received data to the serial monitor */
SerialUSB.print((char)Serial3.read());
}
}

== Buttons and LEDs ==

=== Reset Button ===
A reset button est available on board: pushing the reset button will only reset the SAMD21.
In others words, the Arduino bootloader will restart and jump to the user's application.

If the reset is pushed twice, the MCU will remain in bootloader mode, allowing USB emulation and serial communication.

=== User Button ===
The user button is connected in pull down to the MCU.

{| class="wikitable"
!colspan="4"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on sensor
|Function pin on Arduino
|-
|25
|PA16
|USER button
|11
|}

=== LED ===

The RGB leds are wired on simple GPIOS.

{| class="wikitable"
!colspan="4"|Pinning relations
|-
|Physical pin
|Port pin
|Function pin on sensor
|Function pin on Arduino
|-
|23
|PA14
|BLUE
|2
|-
|14
|PA09
|GREEN
|3
|-
|24
|PA15
|RED
|5
|}

== Battery ==

A LP552036 battery is included and fit in the case. It could be plug to the 2 pins battery connector available on board. Battery is managed thanks to the power and charging management IC.
So, when USB is plugged, the USB will charge the battery and power the device.

The LED indicates current status:
* No color: Device is not plus to a USB powered
* RED : Device is plug to an USB power source and charge is ongoing
* GREEN : Device is plug to an USB power source and charge is complete

Unless the battery is empty, the Smart IoT Sensor can work by itself without any external connection.
Please note however that if you need such behaviour, the SW embedded should not loop on USB serial sensing

== Case ==

The Smart IoT Sensor features a 50*50*25mm case.
All the hardware is all-included inside the case. There is no visible outside antenna.

The case has one miniUSB connector for USB communication on one side, and works as power supply as well.

The user LED is visible on the top of the case.

== Antennas ==

=== Bluetooth Smart antenna ===

The board embeds an RF Ceramic Antenna.

=== GPS/GNSS (SIM33ELA) antenna ===

The antenna is integrated on the module.

=== LoRa/Sigfox (MM002) antenna ===

We provide a finely tuned PCB antenna onboard.

There is also an UFL connector in case you need an external antenna.

== SWD Debug Port ==

The SWD 9 pins connector onboard can be used with your SWD debugger.

We suggest you to use a [https://www.segger.com/jlink-adapters.html#CM_9pin J-Link 9-pin Cortex-M Adapter] with the [https://www.segger.com/jlink_base.html J-Link BASE SWD debug probe]

The SWD switch allows you to choose the SAMD21 or the BLE as SWD target for the debug probe.

===SWD connection to the SAMD21===

You received your board with a preloaded firmware in the SAMD chipset.
If you bricked your board, this procedure can be used to re-flash the arduino firmware.

Set the SWD switch to MCU position.
launch JLinkGDBServer:
/opt/SEGGER/JLink/JLinkGDBServer -if SWD -device ATSAMD21G18 -speed 4000

You should see "Listening on TCP/IP port 2331"

From gdb, connect to the gdbserver:
arm-none-eabi-gdb
(gdb) target remote localhost:2331
(gdb) restore bootloader.hex

===SWD connection to the nRF51822===

You received your board with a preloaded firmware in the BLE chipset.
This firmware is a basic UART to BLE demonstration software.

We describe this procedure in case you need to re-flash the bluetooth firmware to match your specific needs.

Set the SWD switch to BLE position.

The full support can be found from [Nordic https://devzone.nordicsemi.com/tutorials/7/]
Here is an abstract for the UART BLE example:

Install GNU Make
sudo apt-get install build-essential checkinstall

Download [http://developer.nordicsemi.com/ Nrf51 SDK 11.0.0].

Download [http://developer.nordicsemi.com/ nRF5x Command Line Tools].

Set the toolchain path in makefile.windows or makefile.posix depending on platform you are using:
<SDK>/components/toolchain/gcc/Makefile.[platform]

You have to choose the correct LD script for the nRF51822. Please use pca10028 for 256kB of flash and 32KB of ram.
Update this file:
<SDK>/examples/bsp/pca10028.h
#define RX_PIN_NUMBER 9
#define TX_PIN_NUMBER 11
#define HWFC false

We need to update the main file in uart_init() function :
<SDK>/examples/ble_peripheral/ble_app_uart/main.c
APP_UART_FLOW_CONTROL_DISABLED
UART_BAUDRATE_BAUDRATE_Baud9600

Now, we can build it, go to:
<SDK>/examples/ble_peripheral/ble_app_uart/pca10028/s130/armgcc

build and flash the BLE chip:
make
make flash_softdevice
make flash

== Certification ==

NIS-AX Motion Sensor

2017-12-20T16:01:03Z

Arl:

NIS-AX Motion Sensor

2017-12-20T08:48:52Z

Arl: /* Accelerometer sensor properties */

NIS-AX Motion Sensor

2017-12-19T17:48:48Z

Arl:

NIS-AX Motion Sensor

2017-12-19T17:47:36Z

Arl:

File:Computer-530Hz-vibration.png

2017-12-19T17:43:58Z

Arl:

File:Embedded-530Hz-vibration.png

2017-12-19T17:43:45Z

Arl:

File:Computer-430Hz-vibration.png

2017-12-19T17:43:28Z

Arl: