1.. zephyr:board:: rak5010
2
3RAK5010
4#######
5
6Overview
7********
8
9WisTrio NB-IoT Tracker Pro (RAK5010) is a tracker
10with integrated LTE CAT M1 & NB1, GPS, BLE, and sensors.
11It is built on the Quectel BG96 LTE CAT M1 & NB1 module,
12which has an integrated GPS receiver. The MCU running
13the board is a Nordic nRF52840 controller.
14
15As it has both GPS and BLE it can be used for outdoor
16and indoor scenarios, where location-based services need be present.
17
18The built-in sensors for RAK5010 are temperature and
19humidity sensor, motion sensor, pressure sensor, and light sensor.
20The extension IOs allow adding more sensors in addition to the on-board ones.
21
22This board is particularly suitable to be used as a
23quick testing and prototyping tool for applications
24requiring NB-IoT connectivity. Application development
25supports the GCC environment.
26
27Hardware
28********
29
30- nRF52840 ARM Cortex-M4F Processor
31- 32.768 kHz crystal oscillator
32- 1 Micro-AB USB OTG host/device
33- Quectel BG96, with LTE CAT M1, LTE NB1, and GNSS
34- iPEX connectors for the LTE and GPS antenna and an on-board ceramic antenna for the BLE.
35- nano-SIM and ESIM options.
36- Multiple interfaces, I2C, UART, GPIO, ADC
37- 1 user LED
38- 1 SHTC3 Humidity and Temperature Sensor
39- 1 OPT3001DNPR Ambient Light Sensor
40- 1 LPS22HB Pressure Sensor
41- 1 LIS3DH Motion Sensor
42- Powered by either Micro USB, 3.7V rechargeable battery or a 5V Solar Panel Port
43
44Supported Features
45==================
46
47The ``rak5010/nrf52840`` board configuration supports the following hardware features:
48
49+-----------+------------+----------------------+
50| Interface | Controller | Driver/Component     |
51+===========+============+======================+
52| ADC       | on-chip    | adc                  |
53+-----------+------------+----------------------+
54| CLOCK     | on-chip    | clock_control        |
55+-----------+------------+----------------------+
56| FLASH     | on-chip    | flash                |
57+-----------+------------+----------------------+
58| GPIO      | on-chip    | gpio                 |
59+-----------+------------+----------------------+
60| I2C(M)    | on-chip    | i2c                  |
61+-----------+------------+----------------------+
62| MPU       | on-chip    | arch/arm             |
63+-----------+------------+----------------------+
64| NVIC      | on-chip    | arch/arm             |
65+-----------+------------+----------------------+
66| PWM       | on-chip    | pwm                  |
67+-----------+------------+----------------------+
68| RADIO     | on-chip    | Bluetooth,           |
69|           |            | ieee802154           |
70+-----------+------------+----------------------+
71| RTC       | on-chip    | system clock         |
72+-----------+------------+----------------------+
73| SPI(M/S)  | on-chip    | spi                  |
74+-----------+------------+----------------------+
75| UART      | on-chip    | serial               |
76+-----------+------------+----------------------+
77| USB       | on-chip    | usb                  |
78+-----------+------------+----------------------+
79| WDT       | on-chip    | watchdog             |
80+-----------+------------+----------------------+
81
82Other hardware features have not been enabled yet for this board.
83
84Connections and IOs
85===================
86
87LED
88---
89
90* LED0 (green) = P0.12
91
92
93Programming and Debugging
94*************************
95
96The RAK5010 board shall be connected to a Segger Embedded Debugger Unit
97`J-Link OB <https://www.segger.com/jlink-ob.html>`_.  This provides a debug
98interface to the NRF52840 chip. You can use JLink to communicate with
99the NRF52840.
100
101Flashing
102========
103
104#. Download JLink from the Segger `JLink Downloads Page`_.  Go to the section
105   "J-Link Software and Documentation Pack" and install the "J-Link Software
106   and Documentation pack for Linux".  The application JLinkExe needs to be
107   accessible from your path.
108
109#. Run your favorite terminal program to listen for output.  Under Linux the
110   terminal should be :code:`/dev/ttyACM0`. For example:
111
112   .. code-block:: console
113
114      $ minicom -D /dev/ttyACM0 -o
115
116   The -o option tells minicom not to send the modem initialization string.
117   Connection should be configured as follows:
118
119   - Speed: 115200
120   - Data: 8 bits
121   - Parity: None
122   - Stop bits: 1
123
124#. Connect the RAK5010 board to your host computer using the USB debug port.
125   Then build and flash the :zephyr:code-sample:`hello_world` application.
126
127   .. zephyr-app-commands::
128      :zephyr-app: samples/hello_world
129      :board: rak5010/nrf52840
130      :goals: build flash
131
132   You should see "Hello World! rak5010_nrf52840" in your terminal.
133
134Debugging
135=========
136
137You can debug an application in the usual way.  Here is an example for the
138:zephyr:code-sample:`hello_world` application.
139
140.. zephyr-app-commands::
141   :zephyr-app: samples/hello_world
142   :board: rak5010/nrf52840
143   :maybe-skip-config:
144   :goals: debug
145
146References
147**********
148
149.. target-notes::
150
151.. _RAK5010 Product Description:
152    https://doc.rakwireless.com/datasheet/rakproducts/rak5010-wistrio-nb-iot-tracker-datasheet
153
154.. _JLink Downloads Page:
155    https://www.segger.com/downloads/jlink
156