Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1....

22
Adeunis 283 rue Louis Néel - Parc Technologique Pré Roux 38920 CROLLES - France www.adeunis.com KARE Device management platform Guide utilisateur / User Guide Version 1.11

Transcript of Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1....

Page 1: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

Adeunis283 rue Louis Néel - Parc Technologique Pré Roux 38920 CROLLES - Francewww.adeunis.com

KARE

Device management platform

Guide utilisateur / User Guide

Version 1.11

Page 2: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

2 of 22

FR

TABLE OF CONTENT1. INTRODUCTION 3

1.1. Context 31.2. COMPATIBILITY 31.3. ACCESS to the platform 3

2. STEPS TO FOLLOW 43. DECLARATION OF THE SENSORS ON THE BACKENDS 5

3.1. Sigfox network 53.1.1 Create a dedicated Device Type 53.1.2 Creation of the KARE Callbacks 6

3.2. LoRaWAN public network: Objenious 83.2.1 Create a routing scenario 83.2.2 Create an API key 9

3.3. LoRaWAN public network: Orange 103.3.1 Creation of the API key 10

3.4. Actility Network 114. ROLES AND ACCESS 12

4.1. Admin 124.2. Technician 12

5. DECLARE YOUR PARK OF SENSORS 135.1. Create the tree view of your sites 135.2. Declare one or several sensors 13

5.2.1 One by one declaration, manual function 135.2.2 Declaration or modification of several sensors - import/export function 14

5.3. Device Management activation 165.3.1 Step 0 : Sensor start-up 175.3.2 Step 1 : Device management activation 175.3.3 Step 2: Configuration recovery, part 1 175.3.4 Step 3: Configuration recovery, part 2 17

6. SENSORS MANAGEMENT 186.1. Alarms and thresholds 18

6.1.1 Configuration of the thresholds and alarms 186.1.2 Analyze the alarms 19

6.2. Sensors’ configuration 196.2.1 Visualization of the configuration 196.2.2 Modification of the configuration 19

6.3. Synchronization of the whole or a part of the configuration 206.4. Timeline of the sensor 206.5. Battery life and simulator 20

6.5.1 “Estimated” battery life 206.5.2 “Measured” battery life 206.5.3 Autonomy simulator 20

7. API ON KARE 218. HISTORY 22

Page 3: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

3 of 22

FR

1. INTRODUCTION

1.1. CONTEXT

The KARE platform is a Device Management service allowing the product user to maintain its fleet of adeunis® sensors. The platform allows to follow the sensor product life with several indicators and tools.

The platform enables to:

Supervise the health of the fleet of sensors

• Sensors’ autonomy• Reception, non reception • Radio link quality

Control the use of the sensors

• Subscription • Radio regulations

Act on the sensors

• Simulation of the sensor autonomy

• Change the sensor configura-tion remotely

1.2. COMPATIBILITY

The public networks supported are Sigfox, Objenious (LoRaWAN), Orange (LoRaWAN) and Actility (LoRaWAN).

The KARE Platform is compliant with all adeunis sensors with an APP firmware newer or equivalent to a 1.2.x version.

The following sensors are nos supported by the KARE platform: • Pulse V1 (ARF8046, ARF8048), • Sensors V1 (ARF8045, ARF8047), • FTD (ARF812x), • REPEATER Sigfox (ARF8168) • Reference Transmitter for REPEATER Sigfox (ARF8260)

1.3. ACCESS TO THE PLATFORM

Available on web browser (preferably Chrome), copy/paste the following link: https://kare.adeunis-connect.com/

For the first connexion, an email with your login will be sent to you and will ask you to create your password.

Page 4: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

4 of 22

FR

2. STEPS TO FOLLOW

Creation of the group (LoRaWAN) or DevType (Sigfox) dedicated to the KARE products on the

backend of the operators

Declaration of the sensors on the operators’ backend into the group or devtype previously created

Create the callbacks (Sigfox) or

Create the API keys (LoRaWAN)

Provision of the form FOC_KARE

Reception of the email of the creation of your

KARE account

Creation of the other accounts administrators or technicians on KARE

Creation of tree structure of the sites to

supervise

Declaration of the sensors on KARE

Activation of the sensors

Alert tracking Act on the sensors

Steps that can be performed by adeunis if the “subscriptions” service has been purchased

Page 5: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

5 of 22

FR

3. DECLARATION OF THE SENSORS ON THE BACKENDS

To enable the transmission of the data to the KARE platform, it is mandatory to configure the backends with the right URL. It is also needed to create and save the authentication key for the LoRaWAN Orange and LoRaWAN Objenious network in order to be able to send downlink to the sensors.

This paragraph does not concern you if Adeunis is in charge of your subscriptions for your sensors.

3.1. Sigfox network

IMPORTANT: To work with the KARE platform, the Sigfox sensors should be configured with downlinks activated (value of S307≠ 0).

IMPORTANT: the ‘DEVICE TYPE’ with all the sensors that should run onto the KARE platform must not include FTD Sigfox (ARF8121AA). This Filed Test Dive will no longer be functional.

RECOMMENDATION: It is recommended to create a dedicated ‘Device Type’ for KARE. This ‘Device Type’ host only sensors declared on KARE. In this way, the KARE sensors will be dissociate from other sensors and will not cause unnecessary additional communication.

Go onto https://backend.sigfox.com/auth/login and log in.

3.1.1 Create a dedicated Device Type

Back-end Sigfox

Go on “Device Type”

Choose the name of the DevType

Click on “New”

Choose “Regular (raw payload)” in

“Payload parsing”

Choose the associated contract that allows

downlink

Choose “CALLBACK” in “downlink mode”

Choose the group in which to create the

DevType

Page 6: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

6 of 22

FR

3.1.2 Creation of the KARE Callbacks

3.1.2.01 Creation of the callback for UPLINK

In the Device Type created

Click on “CALLBACK” Choose «Custom callback»

Click on “New”

Insert “https://data.kare.adeunis-connect.com/sigfox2”

in “Url pattern”

Choose “SERVICE” and “DATA ADVANCED” in

“Type”

Choose “URL” in “Channel”

Choose “POST” in “Use http Method”

Insert “application/json” in “Content type”

Check “Send SNI”

In “Body”, insert :{"deviceId":"{device}","longitude":{fixedLng},"latitude":{fixedLat},"dataframe":"{data}","timestamp":{time},"fcount":{seqNumber},"lqi":"{lqi}","duplicates":{duplicates}}

*FOR YOUR INFORMATION: you have to pay for the function “duplicates”, it allows the access to the RSSI and SNR information. If you have not subscribed to this option, delete this line in the callback. In this case, only the LQI will be proposed by KARE.

Page 7: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

7 of 22

FR

3.1.2.02 Creation of the callback BIDIR

PAY ATTENTION: only one BIDIR CALLBACK is accepted on Sigfox. The KARE callback must be the only bidirectional callback for one DevType.

In the Device Type created

Click on “CALLBACK” Choose “Custom callback”

Click on “New”

Insert “https://api.kare.adeunis-connect.com/

sigfox/callback/downlink” in “Url pattern”

Choose “DATA BIDIR”Choose “URL” in “Channel”

Choose “POST” in “Use http Method”

Insert “X-AUTH-TOKEN” in “header”

Check “Send SNI”

In «Body», insert:{"deviceId":"{device}","rssi":{rssi},"snr":{snr},"dataframe":"{data}","timestamp":{time},"ack":{ack}} Insert

“permanent_iotalk_token” in “value”

Insert “application/json” in “Content type”

Page 8: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

8 of 22

FR

3.1.2.03 Callback activation

Once created, do not forget to activate the “callback BIDIR” clicking on the circle in the “Downlink” column, and verifying that the 2 callbacks has the check-box “Enable” checked. INFO: if you are not able to activate the callback BIDIR, it can be because the CALLBACK mode (“Downlink mode” section) is not activated for this DevType (in the “Informations” of the DevType you can edit).

BIDIR deactivated BIDIR activated «Enable» checked

Once all these steps are realized you can declare all adeunis devices you want to supervise with KARE in this DeviceType.

3.2. LoRaWAN public network: Objenious

INFORMATION: You have to configure the Objenious backend in order to make it communicate with KARE. During this configuration, you will create a routing scenario (for uplink) and an API key (for downlink). At the end of this procedure, you will have to give this API key to your contact at adeunis in order to finalize your KARE account.

INFORMATION: It is mandatory to have a “Data Access” offer with KARE platform.

RECOMMENDATION: It is advised to create a dedicated group for sensors that will be declared on KARE. In this way, the other sensors of your fleet will not cause unnecessary additional communication.

Go on https://spot.objenious.com/ and log in.

3.2.1 Create a routing scenario

«Connexions» section

Click on «Routing scenario»

Give a name to the scenario

Click on «Create a routing scenario»

Choose “Message”in “content” and click

on create

Choose the group dedi-cated to KARE

Choose “Uplinks only” and

“HTTP”

Choose “Tous”

Insert “https://data.kare.adeunis-connect.com/ob-jenious” in “Send an http

ticket”

Page 9: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

9 of 22

FR

3.2.2 Create an API key

Section “Connections”

Click on “API keys” Give a designation to this API key

Click on “Add an API key”

Choose the group for which you want to

create this key

Choose role“ROLE_CLIENT_TECH-

MANAGER”

This generated key should be given to your Adeunis contact to finalize the account creation.

Page 10: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

10 of 22

FR

«Configuration» section

Click on “API Keys” Give a name to this API key

Click on “Add”

Uncheck all the “Roles”

Keep the “Queues restriction” empty

Keep empty “Valid until”

Choose the date of today in “Valid from”

Check “Customized” in “Profile”

3.3. LoRaWAN public network: Orange

INFORMATION: You have to create an API key to enable the KARE platform to interact with the Orange backend. This configuration will enable the platform KARE to receive and transmit frames to your declared sensor on the platform. All the elements created by KARE on the backend must not be deleted. To identify it easily, here the list:- FIFO named ADEUNIS_KARE (visible in “Configuration”> Message bus > FIFO queues)

Go on https://liveobjects.orange-business.com/#/login and log in.

3.3.1 Creation of the API key

Check “Reading” and “Writing” for “User”

Check “Reading” for “Bus access”

Check “Reading” and “Writing” for “Device”, “Data processing” and “Bus Configuration”

Once validated, the API key is available. It should be transmitted to your adeunis contact in order to finalize your account creation.

WARNING: This API key is visible only one time, during the creation. It is advised to save it.

Page 11: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

11 of 22

FR

3.4. Actility Network

INFORMATION: You will have to configure the Actility backend to enable the communication with the KARE platform. At the end of the proce-dure, you should transmit the API key to your adeunis contact in order to finalize your account creation.

Go on: https://partners.thingpark.com/ and log in.

Click on “Device Man-ager”

Click on “Create”Select “Application Servers”

Select “AS routing profiles” in the menu

Call the server “KARE” and click on “Create”

Copy the following URL in “destination”: https://data.kare.adeunis-connect.com/

actility click on “Add”

In the section “Add a route” click on “Add”

Choose “Blast” in “Rout-ing strategy” and click on

“Save”

Click on “Create”

Click on “Add” dans Destinations

Call it “KARE” and click on “Create”

Select “Local applica-tion server” then select

“KARE”

From the home page of the LoRaWAN Developper Portal

select “DX API Console”

Click on “Add” and “Save”

Click on “ThingPark DX Admin API” in the

dropdown list on the top of the page

Click on /oauth/token

Fill “Grant_type” in “client_crentials”

Go on: https://dx-api.thingpark.com/getstart-

ed/#/and note your profile

ThingPark name

Fill “Client_id” with your “thingpark-profile”/”thing-

park-login”ex: dev1-api/o.poulat@

adeunis.com

Fill your password

Page 12: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

12 of 22

FR

4. ROLES AND ACCESS

Two roles are available: ‘Admin’ and ‘Technician’. Each role has given rights regarding the functionalities or the sensor visualization, described here after.

To add a user to the KARE platform:

“Administration” section

Click on “Users man-agement”

Click on “Add a user”

4.1. Admin

The admin profile can access to all the functionalities of the platform including the creation of other users “Admin” or “Technician”.

Visualization of the sensors: an admin can access to all the sensors of the sites declared on its account.

4.2. Technician The technician profile can access to all the functionalities of the application exept the following ones: • Creation of user accounts• Sensor association to an other technician• Thresholds configuration• Assets import • Site creation

Visualization of the sensors: A technician can access to all the sensors of the site that are attached to its profile (given during the technician account creation and/or during the creation or modification of a site). He has also access to all the items that he create manually (zone, subzone, sensors).

The copied key should be given to your adeunis contact in order to finalize your account creation.

Further more, when you create a device in the “Device Manager” section, please do not forget to fill the information about your adeunis sensor and to select “KARE” as “Application server routing profile” at the end of the form.

Select “False” in “RenewToken”

Select “infinite” in “ValidityPeriod”

Copy the key in “access token” in “response

body” Pay attention

the key is very long.

Page 13: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

13 of 22

FR

PAY ATTENTION: when a site is created with a format it can not be modified. For example: if a site is created with a format “zone and sub-zone”, all the sensors will have to be declared in the sub-zone. We advise you to think about the tree view before to create it.

RECOMMENDATION: if you want to change the tree view created, we advise you to create a new one corresponding to your needs and to transfer the device inside before deleting it.

Once the tree view created you can declare your sensors.

5.2. Declare one or several sensors

5.2.1 One by one declaration, manual function

REMINDER: As explained in the previous paragraph it is mandatory to have created sites to declare manually the devices.

“Assets” section

Click on “Declare a site”

Click on “Declare a zone”

Click on “Declare a subzone”

“Assets” section

Click on «Declare a sensor»

During the sensor declaration, if the sensor is activated on the field, the commis-sioning date must be filled. This date is used to estimate the remaining autono-my of the sensor. If this information is incorrect the calculation will be wrong too.

On the other hand, if the sensor is still in park mode, let the commissioning empty. KARE will start the autonomy calculation after the first frame received.

5. DECLARE YOUR PARK OF SENSORS

5.1. Create the tree view of your sites

To declare manually your sensors you have to create first the tree view of the sites where the sensors are installed. There is 3 different tree views formats : • Site > Sensor(s)• Site > Zone(s) > Sensor(s)• Site > Zone(s) > Sub-zone(s) > Sensor(s)

The creation of the tree view can also be done through the import file (see section 5.2.2).

To create a site, a zone or a sub-zone manually:

Page 14: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

14 of 22

FR

5.2.2 Declaration or modification of several sensors - import/export function

To declare a fleet of sensors or to modify a fleet of sensors without having to go enter each device window, you can upload a .csv or .txt file.

“Assets” section

Click on “Assets import”

Through this file you will be able to create the tree view of your fleet of sensors (site, zone and sub-zone) and simultaneously upload all your sensors on the platform. Afterward you will be able to modify the information of your sensors or your sites using the export function and uploading again the modified file.

To help you, download and use the example file given at the top of the page next to the title:

To be sure that the import will be successful, please respect the following indications regarding the information to provide in the file.

Columns name Description Type / Values Behavior when an element is added:

Behavior when an element is modified:

SITE_NAME Site name Character stringMandatory, to indicate at the creation of the site

Can be modified if the associated customer and the address are still the same. If one of the 2 criteria is changed, KARE creates a new site.

CLIENT_NAME Customer name Character string Optional Modifiable

ADDRESS Site address Character string Mandatory (if a site is filled in)Can be modified if the associated customer and the site name are still the same.

SITE_GPS_CO-ORDINATES

GPS coordinates of the site

Format: wX.YYYYYY, Z.YYYYYYWhere X is between -90 and +90, Y between 0 and 9, Z between -180 and 180

Mandatory (if a site is filled in) Modifiable

ZONE_NAME Zone name Character string OptionalCreates a new zone and moves the sensors inside. Do not delete the previous zone.

ZONE_GPS_CO-ORDINATES

GPS coordinates of the zone

Character string Optional Modifiable

SUBZONE_NAME Subzone name Character string OptionalCrreates a new subzone and moves the sensors inside. Do not delete the previous subzone.

SUBZONE_GPS_COORDINATES

GPS coordinates of the subzone

Character string Optional Modifiable

SENSOR_ID ID of the sensor Character string Mandatory Not modifiable

SENSOR_NAME Name of the sensor Character string Optional Modifiable

SENSOR_GPS_COORDINATES

GPS coordinates of the sensor

Character string Optional Modifiable

UPLINKS_PER_DAY

Number of uplinks authorized per day by the subscription

Positive integers Mandatory Modifiable

Page 15: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

15 of 22

FR

Columns name Description Type / Values Behavior when an element is added:

Behavior when an element is modified:

DOWNLINKS_PER_DAY

Number of downlinks per day authorised by the subscription

Positive integers Mandatory Modifiable

OPERATOR Operator

LoRa OrangeLoRa ObjeniousLoRa ActilitySigfox

Mandatory Modifiable

COMMENT Comment Character string Optional Modifiable

COMMISSION-ING_DATE_YYYY-MM-DD

Date when the device has been putted into service

Format of the date: AAAA-MM-JJ (ISO 8601)

Optional Not modifiable

BATTERY_RE-PLACEMENT_DATE_YYYY-MM-DD

Date when the battery has been changed in the sensor

Format of the date:AAAA-MM-JJ (ISO 8601)Date in the future not authorized.

Not authorized Optional

IMPORTANT:• The fields SENSOR_ID, UPLINKS_PER_DAY, DOWNLINKS_PER_DAY, and OPERATOR are mandatory on each line. So you can not have a line

containing only the information to create a site, you must have the information of a sensor.• Empty lines are not authorized. KARE will indicates that “the sensor id is not provided”. To verify that you have not empty lines in your file,

open it in .txt and delete all the useless “;” at the end.• The date format must be respected: AAAA-MM-JJ (ISO 8601) > be careful, when the file is open with excel the format of the date can be

automatically modifier and you will have to force it. • The renaming of a site breaks the link with the associated technician user. It is then necessary to return on the technician profile, to edit it

and to select the renamed site.

NOTE: rhe fields ADDRESS and SITE_GPS_COORDINATES are mandatory. However, if only one of the 2 is filled, the platform will deduce the other. The success of the operation is not guaranteed.

PAY ATTENTION: it is not recommended to upload more than 5 000 sensors at once.

Page 16: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

16 of 22

FR

5.3. Device Management activation

On the sensor page, a «Device Management activation» section indicates you in which step the sensor is regarding its activation on the KARE platform.

Here under the detailed activation process for the sensors on KARE. This picture can be fined through the «?» online:

Page 17: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

17 of 22

FR

5.3.1 Step 0 : Sensor start-up

This step start automatically after the sensor declaration on KARE and finish when a first frame is received.

5.3.2 Step 1 : Device management activation

The sensor will start this step receiving a first downlink from the platform. The reception by the device of this first frame will prove that the device is correctly declared on the operator’s backend and available to receive all the following downlink necessary for the activation.

This step allows to obtain the sensor type, the firmwares versions embedded in the device. 2 downlinks are sent by KARE replied by 1 frame for the LoRaWAN case and 2 frames for the Sigfox case.

This step, unlike the others, will block the activation if it is not completed. After 49 hours, if the sensor type is not recovered, the activation is KO and a“Manual activation” button will be available for the user to restart the operation.

The activation can failed for several reasons, including:• if the sensor is not started-up• If the sensor has not be configured on the operator’s backend• If the routing parameters necessary are not configured on the operator’s backend• If the API keys (LoRaWAN case) are not configured or wrong• If downlinks are not activated on the sensor (Sigfox case) • If the sensor is not compatible with KARE• If the network coverage is bad and uplinks or downlinks are lost -> it is strongly advised to do the activation process with a good coverage.

If the activation process fail, you will not have access to the KARE functionalities such as the configuration of the sensor, the estimated remain-ing battery life... However the other functionalities will be available (LQI, RSSI, SNR, DutyCycle, subscription, alarms..)

After having find the reason of the failure, you can launch again the activation : NOTE: With a manual activation, the sensor will be directly in step 1.

Click on «Manual activation»

The platform informs you that the step 1 is

running again

The platform informs you that the step 1 has

failed

5.3.3 Step 2: Configuration recovery, part 1

Once the sensor type recovered, a new downlink is sent to the device to make it restart and to recover a first part of the configuration. This step will not block the activation. If after 25 hours the uplinks expected are not received, the device go to the next step. The only conse-quence will be that the configuration will be incomplete on KARE. You will have the possibility to launch again a synchronization for the missing information (see corresponding paragraph).

5.3.4 Step 3: Configuration recovery, part 2

During this step, KARE will send downlinks to recover the rest of the parameters not concerned by the step 1. This step will not block the activation. If after 25 hours the uplinks expected are not received, the device go to the next step. The only conse-quence will be that the configuration will be incomplete on KARE. You will have the possibility to launch again a synchronization for the missing information (see corresponding paragraph).

When all the steps are finished, the sensor will have the “Activated” status on KARE (even if the configuration is incomplete).

Page 18: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

18 of 22

FR

6. SENSORS MANAGEMENT

Once the sensor is activated, you have access to all the platform functionalities.

6.1. Alarms and thresholds

6.1.1 Configuration of the thresholds and alarms

An admin account can modify the thresholds that will trigger alarms. These thresholds apply for the hole fleet of sensors.

To modify the thresholds:

“Administration”Section

Click on “Thresholds manage-

ment”

Complete or modify the different fields

Hereunder all the thresholds that can be configured in KARE:

• The RSSI (Received Signal Strength Indication):• An alarm is sent when the RSSI threshold in dBm (to configure) is overpassed by the product for a configured period given in hour. • The return-to-normal alarm is sent when the threshold is not anymore overpassed for a configured period given in hour.

• The SNR (Signal-to-Noise Ratio):• An alarm is sent if the SNR threshold in dB (to configure for LoRaWAN and Sigfox) is overpassed for a configured period given in hour.• The return-to-normal alarm is sent when the threshold is not anymore overpassed for a configured period given in hour.

• The battery autonomy: • If the estimated autonomy is bellow a configured threshold the alarm is sent. • As soon as the estimated autonomy is higher than the configured threshold the return-to-normal alarm is sent.

• The non-reception of the data:• If no frame is received during a configured period given in hour, an alarm is sent.• As soon as a frame is received the return-to-normal alarm is sent.

For your information: an alarm linked to the subscription exists but the threshold is filled when the sensor is declared on the platform (number of uplinks allowed by day).

Page 19: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

19 of 22

FR

6.2. Sensors’ configuration

6.2.1 Visualization of the configuration

You can visualize easily on which section the

alarm is activated

Click on the red flag to go directly to the corre-

sponding section

The analyze button send you to the concerned

sensor page

6.1.2 Analyze the alarms

When an alarm is sent, you will receive an email.

In the alarms section you will be able to analyze the reason of the alarm and to acknowledge it.

The icon « nut » at the right top of the sensor page, allows to see the configuration of the sensor recovered by KARE. As explained before, the configuration can be incomplete if the step 2 or 3 have not been completed entirely. In this case the label “No value available” appears next to the registers concerned.

6.2.2 Modification of the configuration

The configuration parameters are proposed in group of downlinks (separated by gray dotted lines).

One group of downlink contains parameters that should be modified consistently. Even if only one parameter is modified, KARE will send a downlink containing all the parameters of the same group. If 25 hours later, no acknowledgment from the device have been received, a second downlink is sent. 2 retries are done before the configuration is considered as failed.

RECOMMENDATION: Once the sensor is activated on KARE, it is strongly advised to do not use an other alternative to configure the device (IoT Configurator, AT Commands, downlink from the operator backend, other..). This action will desynchronize the configuration given by KARE and the real configuration in the device.

Page of the concerned sensor

Click on the “nut” on the top of the page

Click on “Edit configuration”

Modify the concerned parameters

Click on “Validate”

Page 20: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

20 of 22

FR

6.3. Synchronization of the whole or a part of the configuration

As explained before, the configuration of the sensor can be incomplete. To recover the missing part or to be sure that the configuration in KARE is the same as inside the product you can use the function “synchronize the configuration”. Click on the “nut” on the top of the page, then click on “edit configuration”. 2 options: • You click on “Synchronize the configuration” and KARE will try to recover the entire configuration • You click on the synchronization button next to the groups of parameters where the information is missing.

In this case KARE will recover only the parameters associated to this groups.

PAY ATTENTION: the total synchronization of the configuration can take a long time and will depend on the frequency of the uplink.

6.5. Battery life and simulator

6.5.1 “Estimated” battery life

In the sensor page, you will find the “estimated battery life” section. KARE runs algorithm at the start of the product (commissioning date) and shows you the estimated autonomy based on its calculation. KARE updates the information based on the analyze of the rolling 15 days. This analyze is based on the number of uplinks, of downlinks, the typology of the product and its power consumption in each states.

It is as a consequence a theoretical estimation and not a precise measure and guaranteed. The more the battery is used the more the estimation is reliable.

6.5.2 “Measured” battery life

The “Low battery alarm” is linked to a measure executed on the device. This indicator is given by the sensor when the battery voltage is lower than a threshold defined by adeunis.

When this indicator shows “Low battery”, it is advised to change the battery on the device.

6.5.3 Autonomy simulator

The simulator of the remaining battery life appears only 15 days after the step 1 have been passed on KARE.

This simulator enables to check the impact of the configuration on the battery life. With this simulator you will be able to choose the right configuration and then to send it via the configuration section.

6.4. Timeline of the sensor

The icon « clock » at the top of the page enables to see the timeline of the sensor. This timeline shows all the actions that have been made by KARE on this sensor, such as:• State of the sensor (declaration ,activation...)• State of the alarms (apparition, return to normal)• Changes in the configuration

Page 21: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

21 of 22

FR

7. API on KARE

It is possible to integrate some of the functionalities of KARE directly in your application or platform thanks to the API.

To do it, you will have to generate a private key in the account of an admin profile.

Administrationsection

Click on «User management»

Click on “edit” next to the concerned user

Click on “generate” and copy the key

Click on “Save” to validate the API key

PAY ATTENTION: if you click again on “generate” the key will be modified. If the previous key was already used, do not forget to click on “can-cel” if it was not on purpose or copy the new one and change the key in your requests.

To know all the available requests through API check the associated Swagger: https://api.kare.adeunis-connect.com/swagger-ui.html#/Sensor-s32Api

Page 22: Device management platform...EN KARE - Guide utilisateur / User guide version V1.11 3 of 22 FR 1. INTRODUCTION 1.1. CONTEXT The KARE platform is a Device Management service allowing

EN

KARE - Guide utilisateur / User guide version V1.11

22 of 22

FR

8. HISTORY

Version Content Author

1.11 Add the LQI request in the advanced callback and modification of the BIDIR callback SigfoxAdd the export function and modification of the import table Add the synchronization function for the sensors configuration Add the API section

OPT

1.10 Changes in the Callback section for Sigfox Changes in the API section for Orange Add the Actility operator

OPT

1.9 New UG format OPT