| nRF5 SDK v12.0.0 |

Choose documentation: | nRF5 SDK | S130 SoftDevice API | S132 SoftDevice API | S212 SoftDevice API | S332 SoftDevice API

All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Generating messages and records

The nRF5 SDK provides modules to generate valid NDEF records and compose them into NDEF messages.

Currently, the following messages and records are supported:

Text record

  Record that contains descriptive text. This record can be used in a message together with other records to provide extra information.

  See Text record generation for instructions on how to create a Text record and Text Record Example for a usage example. The API for the module is available here: Text records

URI message

  Message for accessing a specific address, for example a web page. This message contains the following record:

  - URI record: Record that contains the address to be opened.

  See URI message generation for instructions on how to create a URI message and URI Message Example for a usage example. The API for the module is available here: URI messages

Launch app message

  Message for launching an application. This message contains one or both of these records:

  - Android Application Record: Record for launching an application on Android devices.
  - Windows LaunchApp record: Record for launching an application on Windows Phone devices.

  See Launch app message generation for instructions on how to create a launch app message and Launch App Example for a usage example. The API for the module is available here: Launch app messages

BLE pairing messages

  Static Connection Handover messages for pairing with BLE devices. There are different types of messages depending on if they target Android devices, Windows Phone devices, or both. These messages contain one or more of the following records:

  - Handover Select (Hs) record: Record that groups one or more Alternative Carrier (ac) records, which contain information about alternative carriers. In this use case, the two alternative carrier records point to the LE OOB record and the EP OOB record that are included in the same message.
  - LE OOB record: Record for pairing with an Android BLE device.
  - EP OOB record: Record for pairing with a Windows Phone BLE device.

  See BLE pairing message generation for instructions on how to create a BLE pairing message and Experimental: Heart Rate Application with BLE pairing using NFC for a usage example. The API for the module is available here: BLE pairing messages

Custom messages

  Messages that are not covered by any of the other modules can be generated with a generic record and message generator. For example, this generator can be used for other standardized messages, or to create custom records.

  See Custom message generation for instructions on how to create custom records and messages. The API for the module is available here: Custom NDEF messages, Custom NDEF records

Text record generation

URI message generation

Launch app message generation

BLE pairing message generation

Custom message generation