RAK2171 Quick Start Guide
Prerequisites
What Do You Need?
Before going through each and every step in the guide of the RAK2171 WisNode TrackIt, make sure to prepare the necessary items listed below:
- RAK2171 WisNode TrackIt
- WisGate Edge gateway
- An Android or iOS device with Bluetooth
What’s Included in the Package?
- 2 pcs RAK2171 WisNode TrackIt
- 2 pcs Charging cable with magnetic plate
- 2 pcs Protective silicone case
Product Configuration
WisNode TrackIt supports three working modes:
LoRaWAN Mode
To fully utilize the WisNode TrackIt and the TrackIt App in this mode, you need to use RAK WisGate Edge gateway/s.
In this mode, the WisNode TrackIt is configured via the TrackIt application on your phone. The TrackIt application automatically registers the RAK2171 trackers in the WisGate Edge gateways' Built-in Network Server.
- Download and install the TrackIt App on your smartphone.
- Turn on the Bluetooth on tour smartphone.
- Start the TrackIt App. Location permission may be requested, allow it.
- Agree with the Terms and Conditions and the Privacy Policy, and press the Sign in with RAK ID button.
- Sign in with your RAK ID or sign up for a new RAK ID if you don’t have an account. If you do not have a RAK ID, press the Create new link and fill the needed information.
- After you log in, the App will prompt you to add a tracker. To start the pairing process, press the + ADD TRACKER button.
-
Hold the Power button of your RAK2171 for 3 seconds to turn it on. If the device was turned on previously, you may need to restart it, as the Bluetooth is available for pairing for 3 minutes.
-
Press the Start Pairing in the app. An information screen will be displayed to inform you of the process.
If the tracker is turned off or the Bluetooth pair period has expired, you will see a Tracker not found message. Restart the tracker and try again.
- After successful pairing, you will see a configuration screen, where you will be able to change the tracker's default name and the working mode. This section is for the LoRaWAN mode, so press the LoRaWAN button to change the mode from LoRa P2P to LoRaWAN.
-
You will see two options: RAK Embedded NS and Third Party NS. For this mode, press RAK Embedded NS.
-
Confirm that the gateway is powered and ready by pressing the GATEWAY ON button.
- You will be prompted to connect to the Wi-Fi AP of your RAK gateway. Press the GO TO WI-FI SETTINGS button. You will be redirected to your phone's Wi-Fi settings, where you need to find the RAK WisGate Edge gateway Wi Fi AP and connect to it. You will be promoted for the gateway's login credentials.
- By default,
- Username: root
- Password: root
- After successful login, the TrackIt app will create an application in the gateway's built-In NS and will register the TrackIt device automatically. Once you are done, press the VIEW ON MAP button to see the WisNode TrackIt location on the application map.
LoRa Peer-to-Peer (P2P) Mode
In this mode, no LoRaWAN gateway is needed, but you need at least two RAK2171 devices. One of the trackers is permanently connected via Bluetooth to the TrackIt App on your smartphone and acts a Host. The other tracker/s is/are registered as Client and send their data to the Host tracker.
- Download and install the TrackIt App on your smartphone.
- Turn on the Bluetooth on tour smartphone.
- Start the TrackIt App. Location permission may be requested, allow it.
- Agree with the Terms and Conditions and the Privacy Policy, and press the Sign in with RAK ID button.
- Sign in with your RAK ID or sign up for a new RAK ID if you don’t have an account. If you do not have a RAK ID, press the Create new link and fill the needed information.
- After you log in, the App will prompt you to add a tracker. To start the pairing process, press the + ADD TRACKER button.
-
Hold the Power button of your RAK2171 for 3 seconds to turn it on. If the device was turned on previously, you may need to restart it, as the Bluetooth is available for pairing for 3 minutes.
-
Press the Start Pairing in the app. An information screen will be displayed to inform you of the process.
If the tracker is turned off or the Bluetooth pair period has expired, you will see a Tracker not found message. Restart the tracker and try again.
- After successful pairing, you will see a configuration screen, where you will be able to change the tracker's default name and the working mode.
- Select the LoRa P2P mode and press ADD. Your tracker is now added as a Host, then press the VIEW ON MAP button to see its location. As the Host should be always connected to your smartphone, this is also your position.
The first Tracker you add will act as a Host. All other trackers added will be Clients.
- To add a Client tracker, press the + button on the map. The adding process is the same as for the Host. If you go to the map and slide up the menu at the bottom, you will see the registered trackers, their role, and battery status.
Third-Party LoRaWAN Network Server (LNS) Mode
In this mode, any LoRaWAN NS can be used (TTN, Helium, or other). The RAK TrackIt App acts only as a configuration tool for the trackers, no map or location data is available in the App.
- Download and install the TrackIt App on your smartphone.
- Turn on the Bluetooth on tour smartphone.
- Start the TrackIt App. Location permission may be requested, allow it.
- Agree with the Terms and Conditions and the Privacy Policy, and press the Sign in with RAK ID button.
- Sign in with your RAK ID or sign up for a new RAK ID if you don’t have an account. If you do not have a RAK ID, press the Create new link and fill the needed information.
- After you log in, the App will prompt you to add a tracker. To start the pairing process, press the + ADD TRACKER button.
-
Hold the Power button of your RAK2171 for 3 seconds to turn it on. If the device was turned on previously, you may need to restart it, as the Bluetooth is available for pairing for 3 minutes.
-
Press the Start Pairing in the app. An information screen will be displayed to inform you of the process.
If the tracker is turned off or the Bluetooth pair period has expired, you will see a Tracker not found message. Restart the tracker and try again.
- After successful pairing, you will see a configuration screen, where you will be able to change the tracker's default name and the working mode. Press the LoRaWAN button to change the mode from LoRa P2P to LoRaWAN.
-
You will see two options: RAK Embedded NS and Third Party NS. For this mode, press Third Party NS.
-
You can see the RAK2171 Device EUI, Application EUI, Application Key, Class, and Join mode. From the Region menu, you can select the LoRaWAN band to be used.
- For now, the Class and Join mode can't be changed.
- All LoRaWAN bands will be added with next firmware updates.
- Press CONFIRM to choose the selected LoRaWAN region. Then, press CONTINUE.
- A notification will be displayed, that in Third-party LNS mode the device's position data will be not available on the TrackIt App's map as the data will be sent to the Third-party Network Server directly.
TrackIt LoRaWAN Payload
TrackIt is the latest GPS LoRaWAN tracker by RAKwireless. The name hints what is the device’s purpose – to track something, whether it is a person, an asset, an animal, or anything else. In addition to the tracking application, the device can be used to send SOS or a 6-level alarm signal, based on movement, vibration, fall, etc. The different payloads of the device are explained in this section.
Header/Payload Type/Message ID
1 byte | 1 byte | ||
---|---|---|---|
HEADER | Payload time | Reserved | Message ID |
2 bits | 6 bits | 3 bits | 5 bits |
- Header - by default, the Header is 11.
- Payload type – different payload types are explained in this table above.
- Message ID – an internal counter for the message. The first 5 bits are for the message ID. The other 3 are reserved.
Header/Payload Type
The different payload types that TrackIt can send are explained below. If the GPS has a fix, it will send data of the location. If a 6-level alarm is activated in the application, the device will send a message when the working pattern is activated.
With 5 clicks on the power button, the device will start sending SOS messages. When the SOS is canceled, a message will also be sent.
0b’1100 1010 | No Location | 0xCA |
0b’1100 1011 | Location | 0xCB |
0b’1100 1100 | Send SOS | 0xCC |
0b’1100 1101 | Cancel SOS | 0xCD |
0b’1100 1110 | 6-level alarm | 0xCE |
Working Patterns in 6-level Alarm
- Mild Vibration
- Violent Vibration
- Movement
- Mild Shaking
- Violent Shaking
- Fall
No Location Payload
The device will send No location payload when the GPS has no fix.
1 byte | 2 byte | 3-6 byte | 7-10 byte | 11 byte | 12-16 byte |
---|---|---|---|---|---|
Header/Payload Type | Message ID | Application ID | Device ID | Battery Level | Time |
- Header/Payload Type: 1 byte
- Message ID: 1 byte (3 reserved bits + 5 bits to be used for the ID)
- Application ID: 4 bytes
- Device ID: 4 bytes
- Battery: 1 byte
- Time: 4 bytes
- Status: 1 byte – 8 bits
- Bit 0 – shows if Extended Prediction Orbit (EPO) worked. This allows the device to predict where satellites will be in the sky.
- Bit 1 – shows if the device is charging.
- Bit 2 and 3 show if there is GPS fix:
- 00: Open the GPS fix
- 01: Locating
- 10: Successful
- 11: Failed
Location Payload
The device will send Location payload when the GPS has a fix.
1 byte | 2 byte | 3-6 byte | 7-10 byte | 11-14 byte | 15-18 byte | 19 byte | 20 byte | 21 byte | 22-25 byte |
---|---|---|---|---|---|---|---|---|---|
Header/Payload Type | Message ID | Application ID | Device ID | Longitude | Accuracy | GPS Start Number | Battery | Time | Status |
- Header/Payload Type: 1 byte
- Message ID: 1 byte (3 reserved bits + 5 bits to be used for the ID)
- Application ID: 4 bytes
- Device ID: 4 bytes
- Longitude: 4 bytes
- Latitude: 4 bytes
- Accuracy: 1 byte
- GPS Start Number: 1 byte
- Battery: 1 byte
- Time: 4 bytes
- Status: 1 byte
- Bit 0 – shows if Extended Prediction Orbit (EPO) worked. This allows the device to predict where satellites will be in the sky.
- Bit 1 – shows if the device is charging
- Bit 2 and 3 show if there is a GPS fix:
- 00: Open the GPS fix
- 01: Locating
- 10: Successful
- 11: Failed
Send SOS Payload
SOS type payload has two subtypes of payload – SOS without user data and SOS with user data. The user has the option to set information about themselves via the application in the payload – Name, Phone Number, and Country code. To activate the SOS, the user needs to press 5 times the power button of the TrackIt.
Payload Without User's Data
1 byte | 2 byte | 3-6 byte | 7-10 byte | 11-14 byte | 15-18 byte |
---|---|---|---|---|---|
Header/Payload Type | Message ID | Application ID | Device ID | Longitude | Latitude |
Payload With User Data
1 byte | 2 byte | 3-6 byte | 7-10 byte | 11-14 byte | 15-18 byte | 19-28 byte | 29-39 byte | 40-50 byte |
---|---|---|---|---|---|---|---|---|
Header/Payload Type | Message ID | Application ID | Device ID | Longitude | Latitude | Contact Name | Country Code | Phone Number |
- Header/Payload Type: 1 byte
- Message ID: 1 byte (3 reserved bits + 5 bits to be used for the ID)
- Application ID: 4 bytes
- Device ID: 4 bytes
- Longitude: 4 bytes
- Latitude: 4 bytes
- User’s name: max length is 10 bytes
- Country code: max length is 11 bytes
- Phone number: max length is 11 bytes
Cancel SOS Payload
This payload will be sent when the SOS is canceled. To cancel the SOS, the user needs to press 5 times the power button of the TrackIt.
1 byte | 2 byte | 3-6 byte | 7-10 byte |
---|---|---|---|
Header/Payload Type | Message ID | Application ID | Device ID |
- Header/Payload Type: 1 byte
- Message ID: 1 byte (3 reserved bits + 5 bits to be used for the ID)
- Application ID: 4 bytes
- Device ID: 4 bytes
6-level Sensitivity Alarm Payload
The 6-level sensitivity alarm is configured in the application of the TrackIt. The device will send data only when a chosen Working Pattern is activated. These are the different Working Patterns in 6-level alarm:
- Mild Vibration
- Violent Vibration
- Movement
- Mild Shaking
- Violent Shaking
- Fall
1 byte | 2 byte | 3-6 byte | 7-10 byte | 11 byte |
---|---|---|---|---|
Header/Payload Type | Message ID | Application ID | Device ID | Level |
- Header/Payload Type: 1 byte
- Message ID: 1 byte (3 reserved bits + 5 bits to be used for the ID)
- Application ID: 4 bytes
- Device ID: 4 bytes
- Level: 1 byte