Giter Club home page Giter Club logo

nrf5-sdk-for-mesh's Introduction

Welcome to nRF5 SDK for Mesh

The nRF5 SDK for Mesh is Nordic Semiconductor's implementation of the Bluetooth mesh. It allows applications to use the features provided by the Bluetooth mesh when running on Nordic's nRF5 Series chips.

This GitHub repository contains all the files from the official release zip package. It is provided for reference only, so that you can familiarize yourself with the repository structure and contents.

For detailed and structured documentation, see the nRF5 SDK for Mesh documentation website. There is no off-line documentation available for nRF5 SDK for Mesh, but you can build the documentation locally after downloading the package.

Repository structure

The nRF5 SDK for Mesh repository is organized as follows:

  • bin contains prebuilt binaries of all examples.
  • CMake contains CMake setup files and utility functions.
  • doc contains the main documentation and configuration files for Doxygen generation.
    • Main documentation refers to Getting started, Introduction, Libraries, and Migration guide sections available on the Mesh documentation website.
  • examples contains example applications using the Bluetooth mesh stack and supporting modules.
    • Each example contains its own readme file. This documentation is grouped in the Examples section on the Mesh documentation website.
  • external contains external dependencies used by the Bluetooth mesh stack and examples (App timer, uECC, Segger RTT, SDK fix, and the SoftDevice).
  • mesh contains the source code and unit tests for the Bluetooth mesh stack.
  • models contains the source code for various models.
    • You can find more information about the Simple OnOff model in models/vendor/ and in Getting started > Creating new models page on the nRF5 SDK for Mesh documentation website.
  • scripts contains useful scripts, such as a parser and communication script for the serial interface provided by the mesh stack.
    • You can fing more information about the Interactive PyACI script in the Libraries > Serial interface library section on the nRF5 SDK for Mesh documentation website.
  • tools contains tools useful for development.

Reporting issues

We appreciate all bug reports and fixes. Please report all issues on DevZone and someone from technical support will ensure they are tracked internally. Currently, we do not have a system in place for integrating fixes through the public GitHub mirror. For this reason, we cannot accept any pull requests.

nrf5-sdk-for-mesh's People

Contributors

ardo-nordic avatar ludvigsj avatar omkar3141 avatar thst-nordic avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.