Initial commit

2026-10-04 23:07:37 +00:00 · 2016-05-10 22:49:53 -07:00
commit 4f9945c533
1335 changed files with 616850 additions and 0 deletions
@@ -0,0 +1,65 @@
+<a href="https://github.com/openthread/openthread">![Logo](doc/images/openthread_logo.png)</a>
+
+[![Build Status](https://travis-ci.com/openthread/openthread.svg?token=s77bfgh3PmZjpphKXGGK&branch=master)](https://travis-ci.com/openthread/openthread)
+
+OpenThread is an open-source implementation of the [Thread](http://threadgroup.org/technology/ourtechnology) networking protocol. With OpenThread, Nest is making the technology used in Nest products more broadly available to accelerate the development of products for the connected home.
+
+The Thread specification defines an IPv6-based reliable, secure and low-power wireless device-to-device communication protocol for home applications. More information about Thread can be found on [threadgroup.org](http://www.threadgroup.org/).
+
+## Features
+- Highly portable: OS and platform agnostic, with a radio abstraction layer
+- Implements the End Device, Router, Leader & Border Router roles
+- Small memory footprint
+
+OpenThread implements all Thread networking layers, including IPv6, 6LoWPAN, IEEE 802.15.4 with MAC security, Mesh Link Establishment, and Mesh Routing.
+
+
+# Who is behind OpenThread
+
+![Logo](doc/images/openthread_contrib.png)
+
+Nest, along with ARM, Atmel, a subsidiary of Microchip Technology, Dialog Semiconductor,  Qualcomm Technologies, Inc., a subsidiary of Qualcomm Incorporated and Texas Instruments Incorporated are contributing to the ongoing development of OpenThread.
+
+
+# Getting Started
+
+The easiest way to get started is to run the CLI example in `/examples/cli`. See the [CLI example README](examples/cli/README.md) for more details.
+
+
+## What's included
+
+In the repo you'll find the following directories and files
+
+File/Folder	 | Provides
+-------|--------
+doc | Doxygen docs
+examples | Sample applications demonstrating various parts of OpenThread
+include | Includes header files for OpenThread API
+src | The core implementation of the Thread standard
+tests | Unit and Thread conformance tests
+third_party | Third-party code used by OpenThread
+
+
+# Getting Help
+
+Submit bugs and feature requests to [issue tracker](https://github.com/openthread/openthread/issues). Usage questions? Post questions to [Stack Overflow](http://stackoverflow.com/) using the [[openthread] tag](http://stackoverflow.com/questions/tagged/openthread). We also use Google Groups for discussion and announcements:
+
+* [openthread-announce](https://groups.google.com/forum/#!forum/openthread-announce) - subscribe for release notes and new updates on OpenThread
+* [openthread-users](https://groups.google.com/forum/#!forum/openthread-users) - the best place for users to discuss OpenThread and interact with the OpenThread team
+* [openthread-devel](https://groups.google.com/forum/#!forum/openthread-devel) - team members discuss the on-going development of OpenThread
+
+
+# Versioning
+
+OpenThread follows [the Semantic Versioning guidelines](http://semver.org/) for release cycle transparency and to maintain backwards compatibility. OpenThread's versioning is independent of the Thread protocol specification version but will clearly indicate which version of the specification it currently supports.
+
+
+# Contributing
+
+See the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
+
+
+# License
+
+OpenThread is released under the [BSD 3-Clause license](LICENSE).
+See the [LICENSE](LICENSE) file for more information.