/ot-rtos

OpenThread RTOS, an integration of OpenThread, LwIP, and FreeRTOS.

Primary LanguageCBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

Build Status


OpenThread RTOS

The OpenThread RTOS project provides an integration of:

  1. OpenThread, an open-source implementation of the Thread networking protocol.
  2. LwIP, a small independent implementation of the TCP/IP protocol suite.
  3. FreeRTOS, a real time operating system for microcontrollers.

OpenThread RTOS includes a number of application-layer demonstrations, including:

  • MQTT, a machine-to-machine (M2M)/"Internet of Things" connectivity protocol.
  • HTTP, the underlying protocol used by the World Wide Web.
  • TCP, one of the main transport protocols in the Internet protocol suite.

Getting started

Linux simulation

git submodule update --init
mkdir build && cd build
cmake .. -DPLATFORM_NAME=linux
make -j12

This will build the CLI test application in build/ot_cli_linux.

Nordic nRF52840

git submodule update --init
mkdir build && cd build
cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/arm-none-eabi.cmake -DPLATFORM_NAME=nrf52
make -j12

This will build the CLI test application in build/ot_cli_nrf52840.hex. You can flash the binary with nrfjprog(Download) and connecting to the nRF52840 DK serial port. This will also build the demo application in build/ot_demo_101. See the Demo 101 README for a description of the demo application.

Contributing

We would love for you to contribute to OpenThread RTOS and help make it even better than it is today! See our Contributing Guidelines for more information.

Contributors are required to abide by our Code of Conduct and Coding Conventions and Style Guide.

We follow the philosophy of Scripts to Rule Them All.

License

OpenThread RTOS is released under the BSD 3-Clause license. See the LICENSE file for more information.

Please only use the OpenThread name and marks when accurately referencing this software distribution. Do not use the marks in a way that suggests you are endorsed by or otherwise affiliated with Nest, Google, or The Thread Group.

Need help?

OpenThread support is available on GitHub:

OpenThread

To learn more about OpenThread, see the OpenThread repository.