Feedback

Exercise 1 – Interfacing with ADC using Zephyr API

In this exercise, we will learn how to interact with an ADC (SAADC) on a Nordic device using the Zephyr ADC API.

Exercise steps

Open the code base of the exercise by navigating to Create a new application in the nRF Connect for VS Code extension, select Copy a sample, and search for Lesson 6 – Exercise 1. Make sure to use the version directory that matches the SDK version you are using.

Alternatively, in the GitHub repository for this course, go to the base code for this exercise, found in l6/l6_e1.

1. Enable the ADC API and driver in prj.conf

CONFIG_ADC=y

Copy

CONFIG_ADC=y

Kconfig

2. Define the ADC channel configuration in devicetree

2.1 Create a devicetree overlay file for your board.

In the boards directory of the application, l6_e1/boards, rename the overlay file to the name of the build target for the board you are using, for example nrf52840dk_nrf52840.overlay.

2.2 Inside the devicetree overlay file, under the root node , create a zephyr,user node and set its io-channels to the ADC channel(s), you would like to use

In this exercise, we will only use one channel which is channel 0.

Add the following in your devicetree overlay file:

/ {
	zephyr,user {
		io-channels = <&adc 0>;
	};
};

Copy

/ {
	zephyr,user {
		io-channels = <&adc 0>;
	};
};

Devicetree

Note: you could specify multiple channels and have them separated by a comma (Ex: <&adc 0>, <&adc 1>, <&adc 2>, <&adc 7>;)

2.3 Configure the ADC channel(s)

Add the following in your devicetree overlay file (outside the root node):

All other DKs
nRF54L Series DK

&adc {
	#address-cells = <1>;
	#size-cells = <0>;
	status = "okay";
	channel@0 {
		reg = <0>;
		zephyr,gain = "ADC_GAIN_1_6";
		zephyr,reference = "ADC_REF_INTERNAL";
		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
		zephyr,input-positive = <NRF_SAADC_AIN0>; /* P0.02 for nRF52xx, P0.04 for nRF5340 */
		zephyr,resolution = <12>;
	};
};

Copy

&adc {
	#address-cells = <1>;
	#size-cells = <0>;
	status = "okay";
	channel@0 {
		reg = <0>;
		zephyr,gain = "ADC_GAIN_1_6";
		zephyr,reference = "ADC_REF_INTERNAL";
		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
		zephyr,input-positive = <NRF_SAADC_AIN0>; /* P0.02 for nRF52xx, P0.04 for nRF5340 */
		zephyr,resolution = <12>;
	};
};

Devicetree

On the nRF54L Series SoC, a 14-bit resolution is used, and ADC_GAIN_1_4 gain.

&adc {
	#address-cells = <1>;
	#size-cells = <0>;
	status = "okay";
	channel@0 {
		reg = <0>;
		zephyr,gain = "ADC_GAIN_1_4";
		zephyr,reference = "ADC_REF_INTERNAL";
		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
		zephyr,input-positive = <NRF_SAADC_AIN4>; /* P1.11 for the nRF54L15 DK */
		zephyr,resolution = <14>;
	};
};

Copy

&adc {
	#address-cells = <1>;
	#size-cells = <0>;
	status = "okay";
	channel@0 {
		reg = <0>;
		zephyr,gain = "ADC_GAIN_1_4";
		zephyr,reference = "ADC_REF_INTERNAL";
		zephyr,acquisition-time = <ADC_ACQ_TIME_DEFAULT>;
		zephyr,input-positive = <NRF_SAADC_AIN4>; /* P1.11 for the nRF54L15 DK */
		zephyr,resolution = <14>;
	};
};

Devicetree

The 0 after the @ in channel and reg signify that we are referencing channel 0 of the ADC.

We will populate the properties of the adc node which are described in here with all possible values for each property.

The gain zephyr,gain is set to ADC_GAIN_1_6, which means that the reading will be multiplied by 1/6. For the nRF54L Series SoCs, ADC_GAIN_1_4 gain is used.

The following gains are supported on the nRF SAADC: 1/6, 1/5, 1/4, 1/3, 1/2, 1, 2, 4. This is defined in the product specification.

For the reference voltage zephyr,reference, we will use the internal +0.6, which is specified by ADC_REF_INTERNAL .

For the acquisition time zephyr,acquisition-time , we will use the default value set in the hardware ADC_ACQ_TIME_DEFAULT, which equals 10us.

For the analog input zephyr,input-positive, we will use a single-ended input by not specifying an input-negative property, and we will set it to AIN0 (NRF_SAADC_AIN0). Since single-ended mode is just differential mode with the negative end internally connected to GND, noise can cause slightly negative measurements.

Check the Hardware and Layout ->Pin assignment chapter in the Product specification to know which Pin is connected to the analog inputs on your choice of SoC/SiP. The mapping may differ from one nRF SoC to another, as demonstrated in the table below:

SoC/SiP	AIN0	AIN1	AIN2	AIN3	AIN4	AIN5	AIN6	AIN7
nRF52833	P0.02	P0.03	P0.04	P0.05	P0.28	P0.29	P0.30	P0.31
nRF5340	P0.04	P0.05	P0.06	P0.07	P0.25	P0.26	P0.27	P0.28
nRF9160	P0.13	P0.14	P0.15	P0.16	P0.17	P0.18	P0.19	P0.20

Important

Do not confuse the Arduino shield analog input marking (A0-A5) printed on your DK PCB with the input of the SAADC (AIN0-AIN7), as these two are not the same entity.

Be aware that it is possible to use the SADDC to measure the internal voltage by specifying NRF_SAADC_VDD or NRF_SAADC_VDDHDIV5 in zephyr,input-positive .

For the resolution zephyr,resolution, we will select 12 bits.(14 bits on nRF54L Series SoC).

For specifying multiple channels, see the ADC sample by Zephyr.

3. Retrieve the API-specific device structure for the ADC channel.

After we have defined the channel(s) we are interested in and its parameters (gain, reference, input mode, resolution, etc.) in the devicetree overlay, we can access it from the C code and set it up.

3.1 Include the header file of the Zephyr ADC API

#include <zephyr/drivers/adc.h>

Copy

#include <zephyr/drivers/adc.h>

3.2 Define a variable of type adc_dt_spec for each channel.

Since we are using only one channel in this exercise, we will use the ADC_DT_SPEC_GET() macro to get the io-channels defined at index 0.

static const struct adc_dt_spec adc_channel = ADC_DT_SPEC_GET(DT_PATH(zephyr_user));

Copy

static const struct adc_dt_spec adc_channel = ADC_DT_SPEC_GET(DT_PATH(zephyr_user));

3.3 We must validate that the ADC peripheral (SAADC) is ready before setting it up. This is done by calling adc_is_ready_dt().

if (!adc_is_ready_dt(&adc_channel)) {
	LOG_ERR("ADC controller devivce %s not ready", adc_channel.dev->name);
	return 0;
}

Copy

if (!adc_is_ready_dt(&adc_channel)) {
	LOG_ERR("ADC controller devivce %s not ready", adc_channel.dev->name);
	return 0;
}

3.4 Setup the ADC channel by calling adc_channel_setup_dt(). The setup will be based on the configurations we have set in the devicetree overlay file.

err = adc_channel_setup_dt(&adc_channel);
if (err < 0) {
	LOG_ERR("Could not setup channel #%d (%d)", 0, err);
	return 0;
}

Copy

err = adc_channel_setup_dt(&adc_channel);
if (err < 0) {
	LOG_ERR("Could not setup channel #%d (%d)", 0, err);
	return 0;
}

4. Define and initialize a sequence to store samples captured by the ADC.

4.1 Define a variable of type struct adc_sequence and a buffer of type int16_t to specify where the samples are to be written.

	int16_t buf;
	struct adc_sequence sequence = {
		.buffer = &buf,
		/* buffer size in bytes, not number of samples */
		.buffer_size = sizeof(buf),
		//Optional
		//.calibrate = true,
	};

Copy

	int16_t buf;
	struct adc_sequence sequence = {
		.buffer = &buf,
		/* buffer size in bytes, not number of samples */
		.buffer_size = sizeof(buf),
		//Optional
		//.calibrate = true,
	};

4.2 Initialize the ADC sequence

	err = adc_sequence_init_dt(&adc_channel, &sequence);
	if (err < 0) {
		LOG_ERR("Could not initalize sequnce");
		return 0;
	}

Copy

	err = adc_sequence_init_dt(&adc_channel, &sequence);
	if (err < 0) {
		LOG_ERR("Could not initalize sequnce");
		return 0;
	}

5. Read a sample from the ADC by calling adc_read()

	err = adc_read(adc_channel.dev, &sequence);
	if (err < 0) {
		LOG_ERR("Could not read (%d)", err);
		continue;
	}

Copy

	err = adc_read(adc_channel.dev, &sequence);
	if (err < 0) {
		LOG_ERR("Could not read (%d)", err);
		continue;
	}

6. Convert raw value to mV by calling adc_raw_to_millivolts_dt() . This function relies on the parameters set in the devicetree overlay file.

err = adc_raw_to_millivolts_dt(&adc_channel, &val_mv);
/* conversion to mV may not be supported, skip if not */
if (err < 0) {
	        LOG_WRN(" (value in mV not available)\n");
	} else {
		LOG_INF(" = %d mV", val_mv);
		}

Copy

err = adc_raw_to_millivolts_dt(&adc_channel, &val_mv);
/* conversion to mV may not be supported, skip if not */
if (err < 0) {
	        LOG_WRN(" (value in mV not available)\n");
	} else {
		LOG_INF(" = %d mV", val_mv);
		}

Testing

7. Build and flash the application to your board.

8. Connect your analog input to a voltage source.

This could be a dedicated power supply, a PPK II kit, a battery, or you can simply connect a wire between the analog input (AIN0) and VDD as shown below.

Note

As mentioned before, you don’t have to have external wiring to measure the VDD, you can simply set it in zephyr,input-positive = <NRF_SAADC_VDD>

Note

On the nRF54L15 DK, connect P1.11 to either GND/VDDIO. By default, the VDDIO voltage is 1.8v but can be changed using the Board Configurator in nRF Connect for Desktop.

9. On your serial terminal, you should see the measured voltage in mV.

*** Booting nRF Connect SDK ***
*** Using Zephyr OS v3.7.99-0bc3393fb112 ***
[00:00:00.252,075] <inf> Lesson6_Exercise1: ADC reading[0]: adc@40007000, channel 0: Raw: 3401
[00:00:00.252,075] <inf> Lesson6_Exercise1:  = 2989 mV
[00:00:01.252,227] <inf> Lesson6_Exercise1: ADC reading[1]: adc@40007000, channel 0: Raw: 3404
[00:00:01.252,258] <inf> Lesson6_Exercise1:  = 2991 mV
[00:00:02.252,441] <inf> Lesson6_Exercise1: ADC reading[2]: adc@40007000, channel 0: Raw: 3401
[00:00:02.252,441] <inf> Lesson6_Exercise1:  = 2989 mV
[00:00:03.252,593] <inf> Lesson6_Exercise1: ADC reading[3]: adc@40007000, channel 0: Raw: 3404
[00:00:03.252,624] <inf> Lesson6_Exercise1:  = 2991 mV
[00:00:04.252,807] <inf> Lesson6_Exercise1: ADC reading[4]: adc@40007000, channel 0: Raw: 3399
[00:00:04.252,807] <inf> Lesson6_Exercise1:  = 2987 mV

Terminal

You could connect the wire now to GND and see the measured voltage.

*** Booting nRF Connect SDK ***
*** Using Zephyr OS ***
[00:00:00.252,075] <inf> Lesson6_Exercise1: ADC reading[0]: adc@40007000, channel 0: Raw: 2
[00:00:00.252,075] <inf> Lesson6_Exercise1:  = 1 mV
[00:00:01.252,227] <inf> Lesson6_Exercise1: ADC reading[1]: adc@40007000, channel 0: Raw: 8
[00:00:01.252,258] <inf> Lesson6_Exercise1:  = 7 mV
[00:00:02.252,441] <inf> Lesson6_Exercise1: ADC reading[2]: adc@40007000, channel 0: Raw: 5
[00:00:02.252,441] <inf> Lesson6_Exercise1:  = 4 mV
[00:00:03.252,593] <inf> Lesson6_Exercise1: ADC reading[3]: adc@40007000, channel 0: Raw: -1
[00:00:03.252,624] <inf> Lesson6_Exercise1:  = -1 mV
[00:00:04.252,807] <inf> Lesson6_Exercise1: ADC reading[4]: adc@40007000, channel 0: Raw: 5
[00:00:04.252,807] <inf> Lesson6_Exercise1:  = 4 mV

Terminal

The small mV is due to noise. This is common for single-ended mode.

It’s worth noting that if you have a PPK II, you could use it as a variable-voltage supply. Simply connect the PPK II’s VOUT to the analog input pin, connect the PPK II’s GND to your DK GND, open the Power Profiler App in nRF Connect for Desktop, use the Source meter, and set the supply voltage to the desired value.

Note

The analog input measured should not exceed the internal voltage of the SoC/SiP. If you need to measure an analog input higher than the internal voltage, you must have the necessary voltage step-down circuit.

Make sure that the measured analog input has the same ground as your DK.

The solution for this exercise can be found in the GitHub repository, l6/l6_e1_sol.

Nordic Developer Academy Terms of Service

1. Introduction

‍These terms and conditions (“Terms of Use”) apply to the use of the Nordic Developer Academy, provided by Nordic Semiconductor ASA, org. nr. 966 011 726, a public limited liability company registered in Norway (“Nordic Semiconductor”). ‍

Nordic Developer Academy allows the user to take technical courses related to Nordic Semiconductor products, software and services, and obtain a certificate certifying completion of these courses. By completing the registration process for the Nordic Developer Academy, you are agreeing to be bound by these Terms of Use.

These Terms of Use are applicable as long as you have a user account giving you access to Nordic Developer Academy.‍

‍2. Access to and use of Nordic Developer Academy

‍‍Upon acceptance of these Terms of Use you are granted a non-exclusive right of access to, and use of Nordic Developer Academy, as it is provided to you at any time. Nordic Semiconductor provides Nordic Developer Academy to you free of charge, subject to the provisions of these Terms of Use and the Nordic Developer Academy Privacy Policy.

To access select features of Nordic Developer Academy, you need to create a user account. You are solely responsible for the security associated with your user account, including always keeping your login details safe.

You will able to receive an electronic certificate from Nordic Developer Academy upon completion of courses. By issuing you such a certificate, Nordic Semiconductor certifies that you have completed the applicable course, but does not provide any further warrants or endorsements for any particular skills or professional qualifications.

Nordic Semiconductor will continuously develop Nordic Developer Academy with new features and functionality, but reserves the right to remove or alter any existing functions without notice.

‍3. Acceptable use

You undertake that you will use Nordic Developer Academy in accordance with applicable law and regulations, and in accordance with these Terms of Use.‍ You must not modify, adapt, or hack Nordic Developer Academy or modify another website so as to falsely imply that it is associated with Nordic Developer Academy, Nordic Semiconductor, or any other Nordic Semiconductor product, software or service.

You agree not to reproduce, duplicate, copy, sell, resell or in any other way exploit any portion of Nordic Developer Academy, use of Nordic Developer Academy, or access to Nordic Developer Academy without the express written permission by Nordic Semiconductor. You must not upload, post, host, or transmit unsolicited email, SMS, or \”spam\” messages.

You are responsible for ensuring that the information you post and the content you share does not;

contain false, misleading or otherwise erroneous information
infringe someone else’s copyrights or other intellectual property rights
contain sensitive personal data or
contain information that might be received as offensive or insulting.
Such information may be removed without prior notice.

‍Nordic Semiconductor reserves the right to at any time determine whether a use of Nordic Developer Academy is in violation of its requirements for acceptable use.

Violation of the at any time applicable requirements for acceptable use may result in termination of your account. We will take reasonable steps to notify you and state the reason for termination in such cases.

‍4. Routines for planned maintenance

‍Certain types of maintenance may imply a stop or reduction in availability of Nordic Developer Academy. Nordic Semiconductor does not warrant any level of service availability but will provide its best effort to limit the impact of any planned maintenance on the availability of Nordic Developer Academy.

5. Intellectual property rights

‍Nordic Semiconductor retains all rights to all elements of Nordic Developer Academy. This includes, but is not limited to, the concept, design, trademarks, know-how, trade secrets, copyrights and all other intellectual property rights.

Nordic Semiconductor receives all rights to all content uploaded or created in Nordic Developer Academy. You do not receive any license or usage rights to Nordic Developer Academy beyond what is explicitly stated in this Agreement.

‍6. Liability and damages

‍Nothing within these Terms of Use is intended to limit your statutory data privacy rights as a data subject, as described in the Nordic Developer Academy Privacy Policy. ‍You acknowledge that errors might occur from time to time and waive any right to claim for compensation as a result of errors in Nordic Developer Academy. When an error occurs, you shall notify Nordic Semiconductor of the error and provide a description of the error situation.

You agree to indemnify Nordic Semiconductor for any loss, including indirect loss, arising out of or in connection with your use of Nordic Developer Academy or violations of these Terms of Use. ‍Nordic Semiconductor shall not be held liable for, and does not warrant that (i) Nordic Developer Academy will meet your specific requirements, (ii) Nordic Developer Academy will be uninterrupted, timely, secure, or error-free, (iii) the results that may be obtained from the use of Nordic Developer Academy will be accurate or reliable, (iv) the quality of any products, services, information, or other material purchased or obtained by you through Nordic Developer Academy will meet your expectations, or that (v) any errors in Nordic Developer Academy will be corrected.

You accept that this is a service provided to you without any payment and hence you accept that Nordic Semiconductor will not be held responsible, or liable, for any breaches of these Terms of Use or any loss connected to your use of Nordic Developer Academy. Unless otherwise follows from mandatory law, Nordic Semiconductor will not accept any such responsibility or liability.

‍7. Change of terms

‍Nordic Semiconductor may update and change the Terms of Use from time to time. Nordic Semiconductor will seek to notify you about significant changes before such changes come into force and give you a possibility to evaluate the effects of proposed changes. Continued use of Nordic Developer Academy after any such changes shall constitute your acceptance of such changes. You can review the current version of the Terms of Use at any time at https://academy.nordicsemi.com/terms-of-service/

‍8. Transfer of rights

‍Nordic Semiconductor is entitled to transfer its rights and obligation pursuant to these Terms of Use to a third party as part of a merger or acquisition process, or as a result of other organizational changes.

‍9. Third Party Services

‍‍To the extent Nordic Developer Academy facilitates access to services provided by a third party, you agree to comply with the terms governing such third party services. Nordic Semiconductor shall not be held liable for any errors, omissions, inaccuracies, etc. related to such third party services.

‍10. Dispute resolution

‍‍The Terms of Use and any other legally binding agreement between yourself and Nordic Semiconductor shall be subject to Norwegian law and Norwegian courts’ exclusive jurisdiction.

nRF Connect SDK Intermediate

Exercise 1 – Interfacing with ADC using Zephyr API

Exercise steps

Important

Note

Note

Note

Switch language?

Change summary

What's new in the latest version

General updates

Bluetooth LE updates

MCUboot & Partition Manager