Hardware ID

The hardware ID sample prints a unique hardware ID by using the Hardware ID library.

Requirements

The sample supports the following development kits:

Hardware platforms

PCA

Board name

Board target

nRF9160 DK

PCA10090

nrf9160dk

nrf9160dk/nrf9160/ns nrf9160dk/nrf9160

nRF5340 DK

PCA10095

nrf5340dk

nrf5340dk/nrf5340/cpuapp/ns nrf5340dk/nrf5340/cpuapp

nRF52840 DK

PCA10056

nrf52840dk

nrf52840dk/nrf52840

For more security, it is recommended to use the */ns variant of the board target. When built for this variant, the sample is configured to compile and run as a non-secure application using security by separation. Therefore, it automatically includes Trusted Firmware-M that prepares the required peripherals and secure services to be available for the application.

Overview

You can use this sample to try out the different hardware ID sources supported by the Hardware ID library.

Configuration

See Configuring and building for information about how to permanently or temporarily change the configuration.

By default, the hardware ID sample uses the hardware ID provided by Zephyr’s HW Info API. You can change the hardware ID source by using one of the following conf files:

Building and running

This sample can be found under samples/hw_id in the nRF Connect SDK folder structure.

For more security, it is recommended to use the */ns variant of the board target (see the Requirements section above.) When built for this variant, the sample is configured to compile and run as a non-secure application using security by separation. Therefore, it automatically includes Trusted Firmware-M that prepares the required peripherals and secure services to be available for the application.

To build the sample, follow the instructions in Building an application for your preferred building environment. See also Programming an application for programming steps and Testing and optimization for general information about testing and debugging in the nRF Connect SDK.

Note

When building repository applications in the SDK repositories, building with sysbuild is enabled by default. If you work with out-of-tree freestanding applications, you need to manually pass the --sysbuild parameter to every build command or configure west to always use it.

Testing

After programming the sample to your development kit, complete the following steps to test it:

  1. Connect to the kit that runs this sample with a terminal emulator (for example, the Serial Terminal app). See Testing and optimization for the required settings and steps.

  2. Reset the kit.

  3. Observe the following output:

    hw_id: DEADBEEF00112233

    If an error occurs, the sample prints the following message with the error code:

    hw_id_get failed (err -5)
hw_id: unsupported

Dependencies

This sample uses the following nRF Connect SDK library: