How to find and set library dependencies and configuration?

[MikeLemon]

Hello, 

I've just recently started learning to develop on the nrf52 platform after 2 years of frustration trying to learn of how to develop on the Nordic platform I finally decided to purchase one of the only courses I could find that teach the "foundations" (which for this product is a must sins there is no way you naturally learn that)  and even after that I figured out that the course doesn't cover it and I dint my self just fighting basic IDE Errors.

So I decided to reach out for help here and ask:

How do you determine the required library files&drivers (From the default SDK say Version 16) before you use them as well as what exactly to configure in the "sdk_config.h" with the right parameters per peripheral library and drives?

Thanks for helping!

Op system: windows 10

IDE : Segger embedded studio

[Simon]

My approach:

• I always start with an existing project, most similar to the end goal and build on that
• I always use a BLE example (if your solution uses BLE, which I assume) as the base project and merge functionality from other projects into that. From my experience that is the easiest approach, not the other way around.
  • E.g. if I want to develop a solution with SPI and BLE, then I start with a BLE project (e.g. examples\ble_app_uart) and use an SPI example (e.g. examples\peripheral\spi) as a guideline of what to add into it
• Then I add the specific functions into the BLE example, for example, the function nrf_drv_spi_init(..) from examples\peripheral\spi.
• Then I go through these steps:
  • Put the function into main() and build the example
  • Get error messages
  • Go into main.c of examples\peripheral\spi right click on the function nrf_drv_spi_init(..) and go to the definition (source file) and declaration (header file) of the function
  • include the header file at the top of main.c of examples\ble_app_uart
  • Add the path of the header file as explained here and the source file as explained here into examples\ble_app_uart
  • Build the example (examples\ble_app_uart)
    • If no errors appear, you have successfully implemented the function
    • If an error appears, follow the steps below
  • Look into drivers/sub drivers, and check if the called function is grayed out, and check for the specific config that causes this (in examples\ble_app_uart)
  • Search for the config in the sdk_config.h of the SPI example (e.g. inside examples\peripheral\spi\pca10040\blank\config)
  • Copy this config, and the associated configs into the sdk_config.h file of the ble_app_uart project
    • E.g. if SPI_ENABLED is the config you are looking for, then include all the configs that are "caught" between <e> and  </e> 
      • // <e> SPI_ENABLED - nrf_drv_spi - SPI/SPIM peripheral driver - legacy layer
        //==========================================================
        #ifndef SPI_ENABLED
        #define SPI_ENABLED 1
        #endif
• Repeat these steps for all the functions you wish to implement
  • Be aware that most of the other SPI functions will work fine after completing this once, and you don't need to do it again

Following this approach has worked fine for me, and I have never really had any problems merging two projects. If you encounter any specific problems, please create a Devzone ticket and explain it in detail, and someone will help you. I also recommend you to read this and this thread regarding NRFX vs. legacy configurations.

Some links you may find helpful:

• https://devzone.nordicsemi.com/f/nordic-q-a/30862/create-a-new-project-in-segger-embedded-stuido/129639#129639
• https://devzone.nordicsemi.com/f/nordic-q-a/28196/graduating-from-example-to-production-project-file-structure
• https://devzone.nordicsemi.com/f/nordic-q-a/39240/starting-a-new-project-from-scratch
• https://devzone.nordicsemi.com/f/nordic-q-a/20093/what-is-the-best-way-to-merge-two-existing-examples-with-segger-embedded-studio
• https://devzone.nordicsemi.com/nordic/nordic-blog/b/blog/posts/merging-two-ble-examples-together
• https://devzone.nordicsemi.com/f/nordic-q-a/38054/how-to-combine-two-sdk_config-h-file
• https://www.youtube.com/watch?v=YZouRE_Ol8g&list=PLx_tBuQ_KSqGHmzdEL2GWEOeix-S5rgTV&index=1

Best regards,

Simon

[MikeLemon]

Hi Thanks for the detailed explanation about how to add the libraries ended up taking one example that contains most everything I needed and go from there,

But this doesn't answer my educational part of the question which was how do you figure out which other libraries you need to use for say "nrf_serial.h" and similar libraries like that how do you approach it?

[Simon]

MikeLemon said:

But this doesn't answer my educational part of the question which was how do you figure out which other libraries you need to use for say "nrf_serial.h" and similar libraries like that how do you approach it?

If you want to use the functions in "nrf_serial.h" you first have to add the associated source file nrf_serial.c. Then you should look in these files to see what libraries/drivers you need to add to your project. E.g. in nrf_serial.h these header files are listed:

#include <stdint.h>
#include <stdbool.h>

#include "nrf_drv_uart.h"
#include "nrf_queue.h"
#include "nrf_mtx.h"
#include "app_timer.h"

You need to add the paths to these files, in addition, you have to implement the associated source files.

In nrf_serial.c the following file is listed: 

#include "sdk_common.h"

You don't have to worry about this file if you start with an existing project, e.g. ble_app_template.

You repeat this process with the files nrf_drv_uart.h, nrf_queue.h, nrf_mtx.h and app_timer.h.

Best regards