Template: Ecosystem integration
Provide a short introductory description of the tool or service (third-party), indicating the value it brings to nRF Connect SDK. Refer to the following instructions to create the description:
Provide a title that starts with the tool or service name with “integration” as a suffix, for example, “Memfault integration”.
Place the documentation inside the
List the file name with path in the
.. toctree:of the
Sections with * are optional and can be left out. All other sections are required. There could be more sections, which can be added after discussion with the tech writer team. However, it should have the mandatory sections from the template in the recommended format at the very least.
Describe the tool or service in one or two sentences maximum (full sentences, not sentence fragments), so that the user gets a clear idea of what the tool or service does. This introduction must be concise and clear, highlighting the features of the tool or service that it brings to nRF Connect SDK.
Provide an explanation of the tool or service. This is optional if the tool or service is described above.
Provide prerequisites that must be completed before the integration with the tool or service.
Mention any other tool or service integration that needs to be completed.
Before you start the nRF Connect SDK integration with AVSystem’s Coiote IoT Device Management, make sure that the following prerequisites are completed:
Provide a short description of Development Kit (DK) and nRF Connect SDK interaction with the tool or service and the key elements, for example, connectivity and onboarding.
You can include a diagram showing the interaction.
Explain in more detail how the integration of nRF Connect SDK with the tool or service works.
Try to explain the integration in steps. If possible, divide it into sections and provide a brief explanation in the overview with steps. For an example, see the Integrating Fast Pair section of the Using Google Fast Pair with the nRF Connect SDK documentation.
You can list the configuration that must be enabled for the integration to work (if applicable).
You can add information about overlay configuration files and how they are specified in the build system to enable specific features (if applicable). Following is an example for the overlay details for Memfault integration:
west build -b nrf9160dk_nrf9160_ns -- -DOVERLAY_CONFIG=overlay-memfault.conf
Add optional subsections for technical details. Give suitable titles (sentence style capitalization, thus only the first word capitalized). If there is nothing important to point out, do not include any subsections.
Add the details about applications and samples that use or implement the tool or service.
The following application uses the Memfault integration in nRF Connect SDK:
The following samples demonstrate the Memfault integration in nRF Connect SDK:
Add details about libraries that support the tool or service.
If there is no documentation for libraries, include the path.
Add details about scripts that are required for the tool or service integration.
If there is no documentation for scripts, include the path.
Provide a link to other relevant documentation for more information.
Do not duplicate links that have been mentioned in other sections before.
Describe licensing aspects of the tool or service and provide information on what is available to Nordic Semiconductor customers for development.
Refer to the third-party documentation or contact points.
Use this section to list all dependencies, like other tool or service references, certification requirements (if applicable).
Do not duplicate the dependencies that have been mentioned in other sections.
If possible, link to the respective dependencies.