1. Manuals
  2. Brands
  3. NKE Manuals
  4. Server
  5. LWC
  6. User manual

NKE LWC User Manual

Hide thumbs
Table of Contents

Advertisement

Quick Links

Download this manual
LWC S
ERVER
U
G
SER
UIDE

Advertisement

Table of Contents
loading
Need help?

Need help?

Do you have a question about the LWC and is the answer not in the manual?

Questions and answers

Summary of Contents for NKE LWC

  • Page 1 LWC S ERVER UIDE...
  • Page 2 Nke Watteco products are not designed, authorized or warranted to be suitable for use in life saving or life support devices or systems. Inclusion of Nke Watteco products in such applications is understood to be fully at the Customer's risk.

  • Page 3: Document History

    September 2017 Change ZCL to APP and ZIP to AIP, add packet buffer reset cmd, add PBFE error, change for downlink INDIC and add WHT resource All Rights Reserved – nke Watteco® LWC Server User Guide Page 3 of 28...
  • Page 4 [APP\MAC\PHY]_IND_PAR: indications configurations for each protocol layer ..........24 6.4.12 LAST_RX (LRX): display the delay since the last received frame ............... 25 6.4.13 REBOOT (RBT): allows to restart the LWC Server application................26 6.4.14 RX_PARAMS (RXP): allows to modify the RX parameters ................. 27 6.4.15 WITH_HOST (WHT): Gives the Host the control on the “Re-Join”...

  • Page 5: Introduction

    This document describes all the commands that can be used with the LWC Server (or LoRa USB Dongle) through the serial port. In this document can be found the general way of functioning for the LWC Server, the meaning of the leds colors and the serial port configuration needed by the LWC Server to work correctly.

  • Page 6: Leds Interface

    ERIAL ORT 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: 0x0403/0x6015). The serial port configuration is the following:...

  • Page 7: Exchanges Description

     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 All Rights Reserved –...
  • Page 8 OMMON SYNTAX FOR ALL THE COMMANDS 6.2.1 S PECIAL CHARACTERS The following characters are used in both ways: HOST -> LWC and LWC -> HOST. <EOL> 0x0D End Of Line. This character is specific to the end of an operation (Request, Response, Indication or Commentary) <RespType>...
  • Page 9 LoRaWAN class of an end-device : can be A or C <EDAM> {ABP|A}|{OTA|O} Activation mode of an end-device. <RX2DR> 0..2 Datarate used by the LWC Server to answer on the RX2 window of end-devices This Datarate is included between 0 (SF12) and 2 (SF10). <FPort> 1..255 LoRaWAN Port used <FCountUp>...
  • Page 10 Bad command The command is unavailable on the specified ressource BADR Bad reference The reference (Port, DevEUI…) is not know by the LWC Server BADP Bad port The specified port is invalid: it does not appear in the list of paired DevEUI.

  • Page 11: Available Resources

    <RGet><MS>0<MS><status> Actions : This command asks the display of the LWC Server’s online help or a resource specific online help. The online help is displayed as several lines prefixed by one <RmkStart> character. At the end of the help, the <RmkEnd>...
  • Page 12 LWC Server User Guide 6.4.3 IDENTITY (IDY): (EUI DISPLAYS THE DONGLE IDENTITY This command asks the LWC Server to display its IDs: EUI and Addr. 6.4.3.1 <G > COMMAND Request: <Get><MS>0<MS>{IDENTITY|IDY} Use example (applying 5.2): GET 0 IDY Response: <RGet><MS>0<MS><status><MS>{IDENTITY|IDY}=<DevEUI><FS><DevAddr>...
  • Page 13 <DevRefMode>::= {DEVEUI|DE}|{DEVADR|DA}|{DEVPORT|DP} : This parameter defines how the end-devices are identified by the LWC Server during 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.
  • Page 14 LWC Server User Guide 6.4.5 PROV_DEF_PAR (PDP): DEFAULT PROVISIONING PARAMETERS This resource is used to configure the end-devices default provisioning parameters on the LWC Server. 6.4.5.1 <S > C OMMAND Request: <Set><MS>0<MS>{PROV_DEF_PAR|PDP}<Op><ProvDefPar> <ProvDefPar> ::= [<EDAM>]<FS>[<Class>]<FS>[<RX2DR>]<FS>[<NWSK>]<FS>[<APSK>]<FS>[<AppEUI>] <FS>[<AppKey>] <Op> ::= "=" If a parameter is missing in the command (ex: SET 0 PDP=OTA,C,0,,,,), then it is defined with the default parameters.
  • Page 15 6.4.6 DEV_PROV_PAR (DPP): DEVICE PROVISIONING MANAGEMENT This resource is used to either get the provisioning information of an end-device or to add a new end-device to the LWC Server’s provisioned end-devices list. Both OTAA and ABP are supported. 6.4.6.1 <S > C...
  • Page 16 : Reference of the end-device to delete (DevEUI, DevAddr, Port or « All ») Use example: DEL 0 DPP=4 NOTE: The use of « All » or « * » allows to delete all the provisioned end-devices list in the LWC Server Beware, this action is non-reversible. Response: <RDel><MS><status>0<MS>{DEV_PROV_PAR|DPP}=<DevRef>...
  • Page 17 LWC Server User Guide <DevParamOut> ::= <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,2B7E151628AED2A6ABF7158809CF4F3C,2B7E151 628AED2A6ABF7158809CF4F3C,70B3D5E75F600000, 2B7E151628AED2A6ABF7158809CF4F3C All Rights Reserved – nke Watteco® LWC Server User Guide Page 17 of 28...
  • Page 18 LWC Server User Guide 6.4.7 DEV_PROV_LIST (DPL): PROVISIONED END DEVICES LIST MANAGEMENT This resource allows to obtain the full list of all the provisioned end-devices on the LWC Server. 6.4.7.1 <G > C OMMAND Request: <Get><MS>0<MS>{DEV_PROV_LIST|DPL} Use example: GET 0 DPL Response: <RGet><MS>0<MS><status>{DEV_PROV_LIST|DPL}={<DevParam>[<LS>]}*...
  • Page 19 If the end-device (identified by DevRef) is a class C or if there is no packets inside the packets buffer, then the LWC Server send back a “Packet Buffer Empty” error (or PBFE), cf. §6.3. All Rights Reserved – nke Watteco®...
  • Page 20 <Indic><MS><DevRef><MS>APP=<Direction><FS><HexStr> <Direction> : Frame direction Uplink (End-device  LWC Server) {UP | U} : {DOWN | D} : Downlink (LWC Server  End-device) <HexStr> ::= The ZCL frame presented as an hexadecimal string. Example: INDIC 70B3D5E75E000204 APP=UP,110A0050000641090307000009B70E9204 INDIC 70B3D5E75F0000D9 APP=DOWN,110000000002 All Rights Reserved –...
  • Page 21 If the end-device (identified by DevRef) is a class C or if there is no packets inside the packets buffer, then the LWC Server send back a “Packet Buffer Empty” error (or PBFE), cf. §6.3. All Rights Reserved – nke Watteco®...
  • Page 22 <Indic><MS><DevRef><MS>MAC=<Direction><FS><FPort><FS><FCountUp><FS><HexStr> <Direction> : Frame direction Uplink (End-device  LWC Server) {UP | U} : {DOWN | D} : Downlink (LWC Server  End-device) Join Request (End-device  LWC Server) {JOIN REQUEST | JR} : Join Accept (LWC Server  End-device) {JOIN ACCEPT | JA} : <HexStr>...

  • Page 23: Phy: Physical Frame Reception

    This resource allows to receipt frames on a physical level. Thus, if the indication on the physical level is activated (via PHY_IND_PAR, cf. §6.4.11), the LWC Server will display every frame received at the physical level, even if the end-device sending the frame is not provisioned on the LWC Server.
  • Page 24 INDICATIONS CONFIGURATIONS FOR EACH PROTOCOL LAYER This resource allows to select the data to display when a frame is received by the LWC Server. The resource can be developed in 3 distinct parameters for the 3 different layers used: APP (Application), MAC (Medium Access Control) or PHY (Physical).
  • Page 25 DISPLAY THE DELAY SINCE THE LAST RECEIVED FRAME This resource allows to display the delay (in minutes) since the last reception of a frame from a particular end- device or for all the sensor (on the LWC Server point of view). 6.4.12.1 <S >...
  • Page 26 6.4.13.1 <S > C OMMAND Request: <Set><MS>0<MS>{REBOOT|RBT}[<Op><DelaySec>] <DelaySec> ::= It is possible to specify a delay in seconds before the software reboot of the LWC Server. Use example: SET 0 RBT=1 Actions:  If Delay = 0 or empty, the reboot is done immediately ...
  • Page 27 LWC Server User Guide 6.4.14 RX_PARAMS (RXP): ALLOWS TO MODIFY THE PARAMETERS This resource allows to modify the Datarate (corresponds to a SF) used by the LWC Server, as well as the 3 listening frequencies. 6.4.14.1 <S > C OMMAND Request: <Set><MS>0<MS>{RX_PARAMS|RXP}<Op>[<Freq1>]<FS>[<Freq2>]<FS>[<Freq3>]<FS>[<R...
  • Page 28 OST THE CONTROL ON THE This resource allows the user to decide between two modes of working for the LWC Server. Either to manage by itself when an already paired end-device tries to do another Join Request (it will send back a Join Accept). Or let the Host manages it (the LWC Server will not answer the end-device until the Host saves it again).

Table of Contents