Docker Asset Tracker Codec v1

Docker Asset Tracker Codec v1.8

V1.8 26/08/2019

ABEEWAY SAS ? contact@

Asset Tracker Codec v1.8.0 V1.8

NOTICE This document contains proprietary and confidential material of Abeeway SAS. This document is provided under and governed by either a license or confidentiality agreement. Any unauthorized reproduction, use, or disclosure of this material, or any part thereof, is strictly prohibited. The material provided in this document is believed to be accurate and reliable. However, no responsibility is assumed by Abeeway SAS for the use of this material. Abeeway SAS reserves the right to make changes to the material at any time and without notice. This document is intended for information and operational purposes only. No part of this document shall constitute any contractual commitment by Abeeway SAS.

REVISIONS Version 1.0 1.1 1.2

1.3

1.4 1.5 1.6 1.7 1.8

Primary Author(s) Hend Affes Patrick Beatini Hend Affes

PY Gueniffey

Mengxuan Zhao Mengxuan Zhao PY Gueniffey Mengxuan Zhao Mengxuan Zhao

Description of Version

Date Completed

Initial version

06/09/2018

Rework

10/09/2018

Update in line with AT 1.7.3

25/02/2019

Added downlink documentation encoder snippet

12/03/2019

Update in line with AT 1.8.0 05/04/2019

Dockerhub version

22/05/2019

Refactoring

22/05/2019

Docker v1.2

07/06/2019

-Aligned with User Guide -Iot Driver (Docker) v1.4 -Add Decoding Downlink -Optimization

26/08/2019

Page 2 of 54 Abeeway SAS, 2000 Route des Lucioles, Sophia-Antipolis, 06410 Biot, France

Restricted distribution

Asset Tracker Codec v1.8.0 V1.8

Table of Contents

1 Introduction

5

2 Installation

6

2.1 Prerequisite

6

2.2 Pull and run the codec with docker

6

2.3 Usage of the LoRa codec

7

2.3.1 Client code

8

3 Decoding an uplink

9

3.1 Description

9

3.2 Examples

14

3.2.1 Position message

14

3.2.2 Energy Status message

16

3.2.3 Heartbeat message

18

3.2.4 Activity Status message

20

3.2.5 Configuration message

21

3.2.6 Shock Detection message

23

3.2.7 Shutdown message

25

3.2.8 Event message

26

3.2.9 Debug message

28

4 Encoding a downlink

30

4.1 Overview

30

4.2 Request a position

30

4.2.1 Example

30

4.3 Operational mode change

32

4.3.1 Example

32

4.4 SOS start

33

4.4.1 Example

33

4.5 SOS stop

34

4.5.1 Example

34

4.6 Debug command

36

4.6.1 Example

36

Page 3 of 54 Abeeway SAS, 2000 Route des Lucioles, Sophia-Antipolis, 06410 Biot, France

Restricted distribution

Asset Tracker Codec v1.8.0 V1.8

4.6.2 Reset Device with reset action value specified

37

4.6.2.1 Example

38

4.6.3 Write New TX Power Index

39

4.6.3.1 Example

39

4.7 Parameter read

40

4.7.1 Examples

43

4.8 Parameter modification

44

4.8.1 Examples

47

4.8.1.1 Modify the GPS parameter:

47

4.8.1.2 Modify the BLE parameter:

48

4.8.1.3 Modify the Operational mode Parameters:

49

4.8.1.4 Modify the LORA parameters:

49

4.8.1.5 Modify the side operational mode parameters:

50

4.8.1.6 Modify misc parameters

51

4.8.1.7 Modify accelerometer parameters:

52

5 Decoding a downlink

53

Example

53

Page 4 of 54 Abeeway SAS, 2000 Route des Lucioles, Sophia-Antipolis, 06410 Biot, France

Restricted distribution

Asset Tracker Codec v1.8.0 V1.8

1 Introduction

This document describes the LoRa driver (Encoder/Decoder) for the Abeeway Asset Tracker 2 firmware version V1.8.0. It explains how to decode the uplinks and encode the downlinks messages. For a full description of the Abeeway trackers, It is advised to read the companion document: abeewayreference-guide-fw1.8.pdf. The document provides the installation information and the codec use. It also provides some codes and examples. To separate the examples from the rest of the documents, they are always enclosed by the following tags:

------------------------------ Snippet begin -------------------------------------------------------- Snippet end --------------------------The codec is provided as a docker image. Once the container is running, you can access the codec REST API using any REST API tool or client, for example: ------------------------------ Snippet begin --------------------------curl -X GET ------------------------------ Snippet end ---------------------------

Page 5 of 54 Abeeway SAS, 2000 Route des Lucioles, Sophia-Antipolis, 06410 Biot, France

Restricted distribution

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download