1.. zephyr:board:: rak4631
2
3Overview
4********
5
6RAK4631 is a WisBlock Core module for RAK WisBlock.
7It extends the WisBlock series with a powerful
8Nordic nRF52840 MCU that supports Bluetooth 5.0
9(Bluetooth Low Energy) and the newest LoRa transceiver
10from Semtech, the SX1262. The Semtech SX1262 has compared
11to the older SX127x series a lower power consumption at
12the same TX power. This makes the RAK4631 an ultra-low
13power communication solution. RAK4631 can be comfortably
14programmed with ZephyrRTOS.
15
16Hardware
17********
18
19To use a RAK4631, you need at least a WisBlock Base
20to plug the module in. WisBlock Base is the power
21supply for the RAK4631 module and has the
22programming/debug interface.
23
24- nRF52840 ARM Cortex-M4F Processor
25- 64 MHz CPU clock
26- 1 Micro-AB USB OTG host/device
27- Semtech SX1262 low power high range LoRa transceiver
28- iPEX connectors for the LORA antenna and BLE antenna.
29- Multiple interfaces, I2C, UART, GPIO, ADC
30- 2 user LEDs on RAK5005 mother Board
31- Powered by either Micro USB, 3.7V rechargeable battery or a 5V Solar Panel Port
32
33Supported Features
34==================
35
36.. zephyr:board-supported-hw::
37
38Connections and IOs
39===================
40
41LED
42---
43
44* LED1 (green) = P1.3
45* LED2 (blue) = P1.4
46
47Programming and Debugging
48*************************
49
50The RAK4631 board shall be connected to a Segger Embedded Debugger Unit
51`J-Link OB <https://www.segger.com/jlink-ob.html>`_.  This provides a debug
52interface to the NRF52840 chip. You can use JLink to communicate with
53the NRF52840.
54
55Flashing
56========
57
58#. Download JLink from the Segger `JLink Downloads Page`_.  Go to the section
59   "J-Link Software and Documentation Pack" and install the "J-Link Software
60   and Documentation pack for Linux".  The application JLinkExe needs to be
61   accessible from your path.
62
63#. Run your favorite terminal program to listen for output.  Under Linux the
64   terminal should be :code:`/dev/ttyACM0`. For example:
65
66   .. code-block:: console
67
68      $ minicom -D /dev/ttyACM0 -o
69
70   The -o option tells minicom not to send the modem initialization string.
71   Connection should be configured as follows:
72
73   - Speed: 115200
74   - Data: 8 bits
75   - Parity: None
76   - Stop bits: 1
77
78#. Connect the RAK4631 board to your host computer using the USB debug port.
79   Then build and flash the :zephyr:code-sample:`hello_world` application.
80
81   .. zephyr-app-commands::
82      :zephyr-app: samples/hello_world
83      :board: rak4631/nrf52840
84      :goals: build flash
85
86   You should see "Hello World! rak4631_nrf52840" in your terminal.
87
88Debugging
89=========
90
91You can debug an application in the usual way.  Here is an example for the
92:zephyr:code-sample:`hello_world` application.
93
94.. zephyr-app-commands::
95   :zephyr-app: samples/hello_world
96   :board: rak4631/nrf52840
97   :maybe-skip-config:
98   :goals: debug
99
100References
101**********
102
103.. target-notes::
104
105.. _RAK4631 Product Description:
106    https://docs.rakwireless.com/Product-Categories/WisBlock/RAK4631/Datasheet/#overview
107
108.. _JLink Downloads Page:
109    https://www.segger.com/downloads/jlink
110