background image

Documentation Center

📝

 NOTE:

This decoder script can be found on 

RUI3-Field-Tester GitHub repository  

which also includes a custom

decoder script for TTN and Helium.

4. After creating the device profile, you can now create an application and add the RAK10701 device. And then

attached the 

Device-profile

 you created. You have to take note of the DEVEUI and APPKEY in this section.

These parameters must match the ones in our RAK10701 Field Tester.

function

 

Decode

(

fPort

,

 bytes

,

 variables

)

 

{

 

    

var

 decoded 

=

 

{};

 

    

// avoid sending Downlink ACK to integration (Cargo)

 

    

if

 

((

fPort 

===

 

1

)

 

||

 

(

fPort 

===

 

2

)){

 

        

var

 lonSign 

=

 

(

bytes

[

0

]

 

>>

 

7

)

 

&

 

0x01

 

?

 

-

1

 

:

 

1

;

 

        

var

 latSign 

=

 

(

bytes

[

0

]

 

>>

 

6

)

 

&

 

0x01

 

?

 

-

1

 

:

 

1

;

 

 
        

var

 encLat 

=

 

((

bytes

[

0

]

 

&

 

0x3f

)

 

<<

 

17

)

 

+

 

            

(

bytes

[

1

]

 

<<

 

9

)

 

+

 

            

(

bytes

[

2

]

 

<<

 

1

)

 

+

 

            

(

bytes

[

3

]

 

>>

 

7

);

 

 
        

var

 encLon 

=

 

((

bytes

[

3

]

 

&

 

0x7f

)

 

<<

 

16

)

 

+

 

            

(

bytes

[

4

]

 

<<

 

8

)

 

+

 

            bytes

[

5

];

 

 
        

var

 hdop 

=

 bytes

[

8

]

 

/

 

10

;

 

        

var

 sats 

=

 bytes

[

9

];

 

 
        

var

 maxHdop 

=

 

2

;

 

        

var

 minSats 

=

 

5

;

 

 
        

if

 

((

hdop 

<

 maxHdop

)

 

&&

 

(

sats 

>=

 minSats

))

 

{

 

            

// Send only acceptable quality of position to mappers

 

            decoded

.

latitude 

=

 latSign 

*

 

(

encLat 

*

 

108

 

+

 

53

)

 

/

 

10000000

;

 

            decoded

.

longitude 

=

 lonSign 

*

 

(

encLon 

*

 

215

 

+

 

107

)

 

/

 

10000000

;

 

            decoded

.

altitude 

=

 

((

bytes

[

6

]

 

<<

 

8

)

 

+

 bytes

[

7

])

 

-

 

1000

;

 

            decoded

.

accuracy 

=

 

(

hdop 

*

 

5

 

+

 

5

)

 

/

 

10

 

            decoded

.

hdop 

=

 hdop

;

 

            decoded

.

sats 

=

 sats

;

 

        

}

 

else

 

{

 

            decoded

.

error 

=

 

"Need more GPS precision (hdop must be <"

 

+

 maxHdop 

+

 

                

" & sats must be >= "

 

+

 minSats 

+

 

") current hdop: "

 

+

 hdop 

+

 

" & sats:"

 

+

 sats

;

 

            decoded

.

latitude 

=

 latSign 

*

 

(

encLat 

*

 

108

 

+

 

53

)

 

/

 

10000000

;

 

            decoded

.

longitude 

=

 lonSign 

*

 

(

encLon 

*

 

215

 

+

 

107

)

 

/

 

10000000

;

 

            decoded

.

altitude 

=

 

((

bytes

[

6

]

 

<<

 

8

)

 

+

 bytes

[

7

])

 

-

 

1000

;

 

            decoded

.

accuracy 

=

 

(

hdop 

*

 

5

 

+

 

5

)

 

/

 

10

 

            decoded

.

hdop 

=

 hdop

;

 

            decoded

.

sats 

=

 sats

;

 

        

}

 

        

return

 decoded

;

 

    

}

 

    

return

 

null

;

 

 

 

js

Summary of Contents for RAK10701-P

Page 1: ...s Linux macOS for PC or iOS Android for mobile Software Tools WisToolBox for configuration and firmware update NOTE It is mandatory that you are within the coverage of the LoRaWAN Gateway of the network you are trying to join Without the coverage the Field Tester will not be useable Product Configuration RAK10701 P Field Tester Pro Physical Interface The user interface of the RAK10701 P Field Test...

Page 2: ... five seconds Figure 2 RAK10701 P button to turn on NOTE The same button can be used to power off You have to hold it as well for at least five seconds Figure 3 RAK10701 P power off 2 When the device initializes it will show the RAK logo on the screen If there is any initialization error it will be shown on the upper right section of the screen as well A properly working device should not have any...

Page 3: ... is located on top of the device beside the RP SMA connector of the LoRa Antenna If you are indoors there will be no reception of the GPS signal The latitude and longitude data will be empty Figure 6 RAK10701 P Main Page waiting for valid data 4 Once fully powered on the external button at the side can sleep or wake up the display on the LCD screen via a single press on it 5 If the device is conne...

Page 4: ...evice Configuration of RAK10701 P via WisToolBox is the same for all network server and will be covered in a separate section of the guide RAK10701 P Field Tester Pro Guide for the Helium Network RAK10701 P can be manually registered to Helium Console This is a public LoRaWAN network server that you can use for your LoRaWAN end devices powered by community driven Helium Hotspots This guide will sh...

Page 5: ...Documentation Center Figure 8 Heluim Console Figure 9 Console Home Page 2 Once you are logged in you can start adding your device You have two ways to add a device as shown in the image ...

Page 6: ...e name and click save NOTE The DEVEUI APPEUI and APPKEY are important in this step These values must be configured on your RAK10701 P device using WisToolBox which will be covered later in this guide Figure 11 Configuring Device Name 4 The device will be added to the blockchain and it will show pending beside its name ...

Page 7: ... This will allow you to group your device to have a common setting This will be needed to attach the needed integrations to the backend server of dev disk91 com You have to click the folder with the icon and add a Label name then click Save Label The newly created label should now be shown in the Devices console Figure 13 Add Label icon ...

Page 8: ... Label Name Figure 15 Label created successfully 6 Once the Label is created you have to associate it on the RAK10701 device You can attach the Label on the device by clicking the Add Label button Figure 16 Attach a label to the device ...

Page 9: ...wn on label selection 8 After successful attachment of Label on the devices it should show one 1 device is under that Label The device is properly labeled which is needed for the next steps Integrations and Flow Figure 18 Label added on the RAK10701 device 9 To connect the backend server you have to create an Integration Figure 19 Add integration ...

Page 10: ... the Endpoint URL you must put https dev disk91 com fieldtester helium v3 It is also needed to put the integration name before the clicking Add integration button Figure 21 Details of HTTP Integration 11 After preparing the device and the integration you can now proceed with creating the flow to connect them You have to click Flows and then the icon on NODES ...

Page 11: ...Documentation Center Figure 22 Setting up the Flows 12 You must select Labels and Integrations and then drag the correct blocks on the flows canvas Figure 23 Drag the rak10701 devices label ...

Page 12: ...sing your mouse cursor and dragging the line connector NOTE There is no need to save the changes created on the flows canvas since it is automatically saved as you do changes Figure 25 Connecting Labels to Integrations 14 The final step in the setting up of the Helium Console for RAK10701 is the setting up of packets You have to click on Packets and then the Add New Packet Config icon ...

Page 13: ...g Packets 15 You must also input a name on the Packet Config Name select Multiple Packets and drag the slider so it will show All Available Packets Once done you can now click on Create Packet Config Figure 27 Multiple packets configuration ...

Page 14: ...figuration of RAK10701 using WisToolBox Figure 29 Attaching multiple packets to the rak10701 devices label 17 You can now proceed on device configuration so that the proper EUIs and KEY will match the one in the Helium network RAK10701 P Field Tester Pro Guide for The Things Network This section shows how to use the RAK10701 P Field Tester Pro for LoRaWAN to The Things Stack 1 First log in to TTNv...

Page 15: ...E To connect RAK10701 P Field Tester Pro to TTNv3 you should already have connected a gateway in range to TTNv3 Or you have to be sure that you are in the range of a public gateway 2 Now that you are logged in to the platform the next step is to create an application In your console click Create an application ...

Page 16: ...input first the specific details and necessary information about your application then click Create application Figure 33 Creating an Application 4 If you had no error during the previous step you should now be on the application console page The next step is to add end devices to your TTN application ...

Page 17: ...ation 5 To register the RAK10701 P Field Tester Pro you need to click Manually first Figure 35 Adding end devices manually 6 Choose the following configurations in adding the end devices You must choose the correct Frequency Plan and the LoRaWAN version must be 1 0 3 ...

Page 18: ...ss and cluster settings then select Over the air action OTAA Figure 37 OTAA settings 8 Then input the LoRaWAN OTAA parameters For AppEUI you may click Fill with Zeros For AppKey and DevEUI you can click Generate Then the parameters will be automatically filled by the TTS platform Finally click Register End Device ...

Page 19: ...Take note of these OTAA parameters such as the AppEUI DevEUI and the AppKey as they are needed in the configuration of the RAK10701 P Field Tester Pro hardware later on in this guide Figure 39 OTAA device successfully registered to TTN 10 After adding the device to the LoRaWAN application link it to the backend server The first step is to create an API key ...

Page 20: ...reating API key 11 Configure the API key parameters You can put any names that will easily track your API You have to set the expiration date as well Then you must check Write downlink application traffic After the configuration you can now click Create API key ...

Page 21: ...42 API key parameters 12 This step is critical You need to copy the API key because this will be used on Webhook integration Figure 43 Copy API key 13 With the API key created you can proceed with creating the Webhook integration ...

Page 22: ...k 15 Configure the necessary parameters on the Webhook You can select any name for the webhook You then need to set the base URL going to disk19 server https dev disk91 com fieldtester ttn v3 add the API key from the previous step and lastly put a check on the Uplink message under Enabled event types ...

Page 23: ...Documentation Center Figure 46 Webhook parameters 16 After setting all the configurations you can now add the webhook Figure 47 Add Webhook 17 You should see now the newly created webhook ...

Page 24: ... In step one the Field Tester is sending out data packets over LoRaWAN These packets are received by one or multiple gateways These packets are forwarded from the LoRaWAN network server to another backend server When the packets are forwarded they include information about signal strength and the number of gateways that have received the packet Figure 49 Step 1 Field Tester Sending Uplink Payload ...

Page 25: ... connect to 1 To start with Chirpstack you must create a device profile for your RAK10701 P Field Tester Pro device You must select LoRaWAN MAC version 1 0 3 which is the LoRaWAN specification version that the RAK10701 Field Tester supports Figure 51 Creating Device Profile in Chirpstack 2 You must enable Device supports OTAA as the network join method as well Figure 52 Enable support for OTAA 3 Y...

Page 26: ...Documentation Center Figure 53 Custom Javascript Decoder for RAK10701 Field Mapper Here s the complete decoder script ...

Page 27: ...6 0x01 1 1 var encLat bytes 0 0x3f 17 bytes 1 9 bytes 2 1 bytes 3 7 var encLon bytes 3 0x7f 16 bytes 4 8 bytes 5 var hdop bytes 8 10 var sats bytes 9 var maxHdop 2 var minSats 5 if hdop maxHdop sats minSats Send only acceptable quality of position to mappers decoded latitude latSign encLat 108 53 10000000 decoded longitude lonSign encLon 215 107 10000000 decoded altitude bytes 6 8 bytes 7 1000 dec...

Page 28: ...Documentation Center Figure 54 Create application in Chirpstack Figure 55 Create device in Chirpstack ...

Page 29: ...Network Server profile Figure 57 Gateways registered in Chripstack 6 The next step after setting up the network server devices and gateway is the integration of the Chirpstack application to Datacake You must choose HTTP then click Edit Then you have to use this endpoint going to datacake https api datacake co integrations lorawan chirpstack ...

Page 30: ...7 The last step on the Chirpstack side is the creation of the API key This is needed to allow Datacake in sending downlink packets to the RAK10701 Field Tester Make sure the key is copied and saved somewhere it is only retrievable during the key creation Copy the Token and save it in a text editor ...

Page 31: ...API Key Figure 61 Creation of API Key 8 You can now proceed on Datacake and add a LoRaWAN device that will be linked to your RAK10701 created in ChirpStack You have to create an account if you do not have one yet Figure 62 Device list dashboard ...

Page 32: ...Documentation Center Figure 63 Selecting LoRaWAN Figure 64 Add new product ...

Page 33: ...e 9 Next step is to enable the downlink This is the step where you ll be needing the previously created API key in step 7 of this guide Take note that the ChirpStack URL should be based on your deployed Chirpstack network server After doing all configurations click update and save ...

Page 34: ...Documentation Center Figure 67 Configuration settings Figure 68 Chirpstack downlink configuration Figure 69 Chirpstack URL and API key ...

Page 35: ...Documentation Center 10 Just below the LoRaWAN section in datacake co you ll see the Payload Decoder This is a very critical step to ensure that all important data will be covered ...

Page 36: ...r encLon bytes 3 0x7f 16 bytes 4 8 bytes 5 var hdop bytes 8 10 var sats bytes 9 var maxHdop 2 var minSats 5 if hdop maxHdop sats minSats Send only acceptable quality of position to mappers decoded latitude latSign encLat 108 53 10000000 decoded longitude lonSign encLon 215 107 10000000 decoded altitude bytes 6 8 bytes 7 1000 decoded accuracy hdop 5 5 10 decoded hdop hdop decoded sats sats decoded ...

Page 37: ...nsole log Found Chirpstack format server_type 3 decoded is_chirpstack 1 else console log Unknown raw format var gw_lat var gw_long decoded num_gw 0 for idx_tst 0 idx_tst 10 idx_tst if typeof normalizedPayload gateways idx_tst undefined console log Found gateway with IDX idx_tst decoded num_gw 1 for idx 0 idx decoded num_gw idx var new_rssi normalizedPayload gateways normalizedPayload gateways idx ...

Page 38: ...tance decoded minDistance decoded minDistance 0 decoded minDistance new_distance 1000 if new_distance decoded maxDistance decoded maxDistance 0 decoded maxDistance new_distance 1000 switch decoded num_gw case 20 decoded hotspot_10 gw_lat 19 gw_long 19 case 19 decoded hotspot_09 gw_lat 18 gw_long 18 case 18 decoded hotspot_08 gw_lat 17 gw_long 17 case 17 decoded hotspot_07 gw_lat 16 gw_long 16 case...

Page 39: ...ed hotspot_01 gw_lat 0 gw_long 0 default break decoded maxMod parseInt decoded maxDistance 250 10 decoded minMod parseInt decoded minDistance 250 10 decoded maxDistance parseInt decoded maxMod 250 10 decoded minDistance parseInt decoded minMod 250 10 if decoded maxDistance 1 decoded maxDistance parseInt 250 10 if decoded minDistance 1 decoded minDistance parseInt 250 10 return decoded return null ...

Page 40: ... define to create the downlink to the RAK10701 Field Tester 11 The next step is to create the different data fields that are filled by the data decoder This is done in the Fields section of the device configuration just below the data encoder section Figure 70 Creation of data field The following fields are required Field Name Identifier returned value from the decoder Field Type function distance...

Page 41: ...create the automatic downlink to the device that is executed every time a data packet from the RAK10701 Field Tester arrives Take note that port number 2 is used by RAK10701 for downlinks and Trigger on measurements should be checked Figure 71 Chirpstack downlink configuration Field Tester LOCATION Location MinDistance MINDISTANCE Integer MaxDistance MAXDISTANCE Integer MinRSSI MINRSSI Float MaxRS...

Page 42: ... sizes This is the complete decoder script The first byte is usually a counter but it works well if the counter is ignored and always set to 1 13 You can now proceed on device configuration so that the proper EUIs and KEY will match the one in the network server Configuration of RAK10701 P Using WisToolBox function Encoder measurements port var buf buf 0 1 buf 1 measurements MINRSSI value 200 buf ...

Page 43: ...lBox application You can find more info on how to install and use the WisToolbox from its documentation 2 Click the CONNECT DEVICE button to launch WisToolBox Dashboard Figure 73 WisToolBox Desktop splash screen 3 Review the Connection settings parameters on the dashboard then click on the CONNECT button Figure 74 WisToolBox Desktop connection settings 4 On the WisToolBox Dashboard screen select t...

Page 44: ...terval of uplinks TX power and data rate can be done on the touchscreen of RAK10701 For the frequency plan change the device has to restart to activate this newly configured frequency band There will be a notification on the UI touchscreen LCD If you use WisToolBox to configure the band you have to restart the device manually and there will be no notification from the UI of the LCD 6 You will see ...

Page 45: ... uplinks TX power and data rate as needed You can use the arrows for navigation and click OK to save changes Figure 78 RAK10701 P settings button Figure 79 Configurable parameters Miscellaneous This part of the guide shows the Field Tester interface and how to update the firmware User Interface Firmware Update Field Tester Display Interface This section discusses the interfaces on the LCD of the d...

Page 46: ...status will be displayed until refreshed when new data is sent FAILED RAK10701 P Field Tester Pro failed to join the network Triggered by receive timeout There might be no available gateway reachable by the Field Tester SENDING RAK10701 P Field Tester Pro s data such as GPS is being uploaded via an uplink It will be displayed until the reception is completed or timed out Settings The field tester ...

Page 47: ...our different data plots on the field tester number of gateways RSSI SNR and approximate distance These graphs are accessible by touching the respective icons assigned to the parameter Figure 84 Accessing different data plots Figure 85 Distance plot Figure 86 RSSI plot ...

Page 48: ...8 GPS display Figure 89 GPS data Upgrading the Firmware It is recommended to update to the latest version of the firmware To do this download the latest RAK10701 P WisNode Field Tester firmware and use the WisToolBox to update the custom firmware 1 Drag the downloaded firmware to the WisToolBox custom firmware section ...

Page 49: ...ation Center Figure 90 WisToolBox firmware 2 After the firmware file is uploaded to the application you can now select UPGRADE DEVICE Figure 91 Upload the latest firmware Figure 92 Confirm upgrading of firmware ...

Page 50: ...d with no error you should see Firmware update successful notification and the RAK10701 P will restart automatically Figure 93 Ongoing upgrading of firmware Figure 94 Successful upload of latest firmware Last Updated 11 9 2022 8 19 58 AM ...

Reviews: