background image

LWC Server User Guide

 

 
 

All Rights Reserved – nke Watteco®  

 

 

 

               

LWC  Server  User  Guide

 

 

 

 

 

            Page 7 of 25 

6

 

C

OMMAND 

I

NTERPRETER

 

6.1

 

E

XCHANGES DESCRIPTION

 

The  exchange  protocol  used  for  the  LoRaWAN  Coordinator  Command  Line  Interpreter  (LWCCLI)  is  built  with 
ASCII frame made up of 7 bits characters ended with the <EOL> character. 

It allows 2 types of simple exchanges: 

The “Request/Response”: 

 

HOST  

  

<Request>

  

  LWC 

 

HOST  

  

<Response>

  

  LWC 

 
The “Indications”: 

 

HOST  

  

<Indication>

  

  LWC 

The  responses  can  either  directly  return  the  required  data  or  constitute  a  simple  acknowledgement  to  the 
request. The requested data may be sent later as an 

<Indication>. 

Typically, this is the way of working 

for frames sent to the end-devices. 

A general representation of each 3 possible command lines can be seen here below: 

<Request>  ::= 

 

<Cmd>

<MS><DevRef>[<Param><Op><Val>]

<EOL> 

 

<Response> ::= 

 

<ResType><Cmd>

<MS><DevRef><MS><status>[<MS><Param>[<Oper><Val>]]

<EOL> 

 

<Indic> 

::= 

 

<Ind>

<MS><DevRef>[<MS><Param>[<Op><Val>]]

<EOL> 

 

Each <KeyWord> is defined in the following chapters 

 

N.B. 

 

The KeyWords accept two formats: a short one and a long one (ex: 

DEVICE_LIST

 <-> 

DL

). Indeed, a 

specific LWC Server parameter allows to choose the wanted format: 

VERBOSE

.  

 

All the non-numerical values has to respect the letter case 

 

Summary of Contents for LWC Server

Page 1: ...LWC SERVER USER GUIDE...

Page 2: ...n and operating safeguards must be provided by the customer to minimize inherent or procedural hazards Nke Watteco assumes no liability for applications assistance or customer product design Nke Watte...

Page 3: ...ghts Reserved nke Watteco LWC Server User Guide Page 3 of 25 DOCUMENT HISTORY Date Revision Modification Description July 2016 1 0 First revision March 2017 1 1 Correcting the SF limit March 2017 1 2...

Page 4: ...t the firmware version 11 6 4 3 IDENTITY IDY displays the dongle identity DevEUI and DevAddr 12 6 4 4 VERBOSE VRB LWC Server verbosity level 13 6 4 5 PROV_DEF_PAR PDP default provisioning parameters 1...

Page 5: ...perators errors etc And finally a complete list of all the available resources will be done with for each the command available and few examples 2 DEFINITIONS Port or Slot Index identifying a sensor f...

Page 6: ...sends or receives a frame when the red led flashes 5 SERIAL PORT CONFIGURATION The LWC Server has to be plugged on a USB port on the HOST machine The USB serial is done through the FT232X USB PID VID...

Page 7: ...uired data or constitute a simple acknowledgement to the request The requested data may be sent later as an Indication Typically this is the way of working for frames sent to the end devices A general...

Page 8: ...ting a response MS Main delimiter character LS Parameters delimiter inside a parameters list FS Field delimiter in a parameter containing several fields Rmk Character indicating a commentary until the...

Page 9: ...A C LoRaWAN class of an end device can be A or C EDAM ABP A OTA O Activation mode of an end device For the moment only the ABP is managed by the LWC Server RX2DR 0 2 Datarate used by the LWC Server t...

Page 10: ...the command BADV Bad value The value associated with the operand is invalid DRNF Device Reference Not found The end device reference given in the command line has not been found by the LWC Server DRI...

Page 11: ...specific online help The online help is displayed as several lines prefixed by one RmkStart character At the end of the help the RmkEnd character is displayed 6 4 2 FIRMWARE_INFO FWI INFORMATION DISPL...

Page 12: ...ONGLE IDENTITY DEVEUI AND DEVADDR This command asks the LWC Server to display its IDs DevEUI and DevAddr 6 4 3 1 GET COMMAND Request Get MS 0 MS IDENTITY IDY Use example applying 5 2 GET 0 IDY Respons...

Page 13: ...ring the exchanges Echo ON 1 OFF 0 This parameter asks to the LWC Server to copy on the serial interface all the commands that it receives Debug ON 1 OFF 0 Op If a parameter is missing in the command...

Page 14: ...C 0 2B7E151628AED2A6ABF7158809CF4F3C 2B7E151628AED2A6ABF7158809CF4F3C 70B3D5E75F600000 2B7E151628AED2A6ABF7158809CF4F3C Use example SET 0 PDP OTA A 1 2B7E151628AED2A6ABF7158809CF4F3C 2B7E151628AED2A6A...

Page 15: ...ample in ABP SET 0 DPP 70B3D5E75E000205 ABP A 0 00000205 2B7E151628AED2A6ABF7158809CF4F3C 2B7E151628AED2A6AB F7158809CF4F3C Use example in OTAA SET 0 DPP 70B3D5E75E000205 OTA A 0 00000205 70B3D5E75F60...

Page 16: ...consulted through the PROV_DEF_PAR resource 6 4 5 6 4 6 2 DEL COMMAND Request Del MS 0 MS DEV_PROV_PAR DPP DevRef DevRef Reference of the end device to delete DevEUI DevAddr Port or All Use example DE...

Page 17: ...aramOut Port FS DevEUI FS EDAM FS Class FS RX2DR FS DevAdr FS NW SK FS APSK FS AppEUI FS AppKey Response example RGET 0 SUCCESS DEV_PROV_PAR 3 70B3D5E75E000204 ABP A 0 00000204 2B7E151628AED2A6ABF7158...

Page 18: ...067 ABP C 0 01007067 2B7E151628AED2A6ABF7158809CF4F3C 2B7E151628AED2A6ABF7158809CF4F3C 70B3D5E75F600000 2B7E151628AED2A6ABF7158809CF4F3C 1 70B3D5E75F0000D9 OTA A 0 010000D9 4A551A036DF0F6CAA801656E6A7...

Page 19: ...0000204 SUCCESS ZCL Actions If the request succeed a frame is directly send to the end device if the latter is a class C device For the class A devices the frame is stored waiting for an uplink from t...

Page 20: ...MS DevRef MS status status StatusG cf 6 3 Response example RSET 0100676A SUCCESS MAC Actions If the request succeed a frame is directly send to the end device if the latter is a class C device For th...

Page 21: ...4 10 1 INDIC COMMAND Indication Indic MS DevRef MS PHY Direction FS Freq FS RSSI FS SNR FS H exStr Direction Frame direction NONE N None UP U Uplink End device LWC Server DOWN D Downlink LWC Server E...

Page 22: ...e or not ON 1 Show payload at corresponding layer OFF 0 Do not show payload at corresponding layer 6 4 11 1 SET COMMAND Request Set MS 0 MS ZCL MAC PHY _IND_PAR ZIP MIP PIP Direction ShowPay By defaul...

Page 23: ...LAST_RX LRX MinutesSinceLastUp status StatusG cf 6 3 NOTF Not found MinutesSinceLastUp Delay in minutes since the last frame received from an end device in particular or from any end device in the end...

Page 24: ...without any hardware action 6 4 13 1 SET COMMAND Request Set MS 0 MS REBOOT R DelaySec DelaySec It is possible to specify a delay in seconds before the software reboot of the LWC Server Use example S...

Page 25: ...rver is listening Hz from 860 MHz to 1020 MHz RXDR The Datarate used by the LWC Server to listen from 0 SF12 to 2 SF10 The default values are RXP 868100000 868300000 868500000 0 Use example SET 0 RXP...

Reviews: