|
Name |
|
Date |
Size |
#Lines |
LOC |
| .. | | - | - |
| .github/ | | 03-Aug-2024 | - | 3,207 | 2,467 |
| doc/ | | 03-Aug-2024 | - | 2,873 | 2,025 |
| etc/ | | 03-Aug-2024 | - | 852 | 713 |
| examples/ | | 03-Aug-2024 | - | 11,592 | 6,880 |
| include/openthread/ | | 03-Aug-2024 | - | 29,464 | 5,578 |
| script/ | | 03-Aug-2024 | - | 3,789 | 2,364 |
| src/ | | 03-Aug-2024 | - | 297,396 | 158,424 |
| tests/ | | 03-Aug-2024 | - | 152,750 | 92,342 |
| third_party/ | | 03-Aug-2024 | - | 646,218 | 459,892 |
| tools/ | | 03-Aug-2024 | - | 38,621 | 20,379 |
| zephyr/ | | 03-Aug-2024 | - | 33 | 4 |
| .clang-format | D | 03-Aug-2024 | 3.1 KiB | 114 | 112 |
| .clang-tidy | D | 03-Aug-2024 | 740 | 24 | 23 |
| .code-spell-ignore | D | 03-Aug-2024 | 132 | 21 | 20 |
| .codecov.yml | D | 03-Aug-2024 | 159 | 13 | 10 |
| .default-version | D | 03-Aug-2024 | 8 | 2 | 1 |
| .gitattributes | D | 03-Aug-2024 | 409 | 21 | 18 |
| .gitignore | D | 03-Aug-2024 | 537 | 56 | 50 |
| .gn | D | 03-Aug-2024 | 84 | 4 | 2 |
| .prettierrc | D | 03-Aug-2024 | 149 | 8 | 7 |
| AUTHORS | D | 03-Aug-2024 | 639 | 19 | 17 |
| BUILD.gn | D | 03-Aug-2024 | 3.3 KiB | 112 | 96 |
| CMakeLists.txt | D | 03-Aug-2024 | 6.8 KiB | 173 | 143 |
| CODE_OF_CONDUCT.md | D | 03-Aug-2024 | 5.3 KiB | 84 | 48 |
| CONTRIBUTING.md | D | 03-Aug-2024 | 9.1 KiB | 189 | 122 |
| LICENSE | D | 03-Aug-2024 | 1.5 KiB | 26 | 23 |
| NOTICE | D | 03-Aug-2024 | 1.3 KiB | 20 | 17 |
| README.md | D | 03-Aug-2024 | 8 KiB | 67 | 41 |
| SECURITY.md | D | 03-Aug-2024 | 299 | 2 | 1 |
| STYLE_GUIDE.md | D | 03-Aug-2024 | 13.4 KiB | 200 | 166 |
README.md
1[![OpenThread][ot-logo]][ot-repo] [![Build][ot-gh-action-build-svg]][ot-gh-action-build] [![Simulation][ot-gh-action-simulation-svg]][ot-gh-action-simulation] [![Docker][ot-gh-action-docker-svg]][ot-gh-action-docker] [![Coverage Status][ot-codecov-svg]][ot-codecov]
2
3---
4
5# What is OpenThread?
6
7OpenThread released by Google is... <a href="https://www.threadgroup.org/What-is-Thread/Thread-Benefits#certifiedproducts"> <img src="https://cdn.rawgit.com/openthread/openthread/ab4c4e1e/doc/images/certified.svg" alt="Thread Certified Component" width="150px" align="right"> </a>
8
9**...an open-source implementation of the [Thread](https://www.threadgroup.org/What-is-Thread/Overview) networking protocol.** Google Nest has released OpenThread to make the technology used in Nest products more broadly available to developers to accelerate the development of products for the connected home.
10
11**...OS and platform agnostic**, with a narrow platform abstraction layer and a small memory footprint, making it highly portable. It supports both system-on-chip (SoC) and network co-processor (NCP) designs.
12
13**...a Thread Certified Component**, implementing all features defined in the [Thread 1.3.0 specification](https://www.threadgroup.org/support#specifications), including all Thread networking layers (IPv6, 6LoWPAN, IEEE 802.15.4 with MAC security, Mesh Link Establishment, Mesh Routing) and device roles, as well as [Border Router](https://github.com/openthread/ot-br-posix) support.
14
15More information about Thread can be found at [threadgroup.org](http://threadgroup.org/). Thread is a registered trademark of the Thread Group, Inc.
16
17[ot-repo]: https://github.com/openthread/openthread
18[ot-logo]: https://github.com/openthread/openthread/raw/main/doc/images/openthread_logo.png
19[ot-gh-action-build]: https://github.com/openthread/openthread/actions?query=workflow%3ABuild+branch%3Amain+event%3Apush
20[ot-gh-action-build-svg]: https://github.com/openthread/openthread/workflows/Build/badge.svg?branch=main&event=push
21[ot-gh-action-simulation]: https://github.com/openthread/openthread/actions?query=workflow%3ASimulation+branch%3Amain+event%3Apush
22[ot-gh-action-simulation-svg]: https://github.com/openthread/openthread/workflows/Simulation/badge.svg?branch=main&event=push
23[ot-gh-action-docker]: https://github.com/openthread/openthread/actions?query=workflow%3ADocker+branch%3Amain+event%3Apush
24[ot-gh-action-docker-svg]: https://github.com/openthread/openthread/workflows/Docker/badge.svg?branch=main&event=push
25[ot-codecov]: https://codecov.io/gh/openthread/openthread
26[ot-codecov-svg]: https://codecov.io/gh/openthread/openthread/branch/main/graph/badge.svg
27
28# Who supports OpenThread?
29
30<a href="https://www.amazon.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-amazon.png" alt="Amazon" width="200px"></a><a href="https://www.aqara.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-aqara.png" alt="Aqara" width="200px"></a><a href="https://www.arm.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-arm.png" alt="ARM" width="200px"></a><a href="https://www.cascoda.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-cascoda.png" alt="Cascoda" width="200px"></a><a href="https://www.eero.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-eero.png" alt="Eero" width="200px"></a><a href="https://www.espressif.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-espressif-github.png" alt="Espressif" width="200px"></a><a href="https://www.google.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-google.png" alt="Google" width="200px"></a><a href="https://www.infineon.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-infineon.png" alt="Infineon" width="200px"></a><a href="https://mmbnetworks.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-mmb-networks.png" alt="MMB Networks" width="200px"></a><a href="https://www.nabucasa.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-nabu-casa.png" alt="Nabu Casa" width="200px"></a><a href="https://www.nanoleaf.me/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-nanoleaf.png" alt="Nanoleaf" width="200px"></a><a href="http://www.nordicsemi.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-nordic.png" alt="Nordic" width="200px"></a><a href="http://www.nxp.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-nxp.png" alt="NXP" width="200px"></a><a href="http://www.qorvo.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-qorvo.png" alt="Qorvo" width="200px"></a><a href="https://www.qualcomm.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-qc.png" alt="Qualcomm" width="200px"></a><a href="https://www.samsung.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-samsung.png" alt="Samsung" width="200px"></a><a href="https://www.silabs.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-silabs.png" alt="Silicon Labs" width="200px"></a><a href="https://www.st.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-stm.png" alt="STMicroelectronics" width="200px"></a><a href="https://www.synopsys.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-synopsys.png" alt="Synopsys" width="200px"></a><a href="https://www.telink-semi.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-telink-github.png" alt="Telink Semiconductor" width="200px"></a><a href="https://www.ti.com/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-ti.png" alt="Texas Instruments" width="200px"></a><a href="https://www.zephyrproject.org/"><img src="https://github.com/openthread/openthread/raw/main/doc/images/ot-contrib-zephyr.png" alt="Zephyr Project" width="200px"></a>
31
32# Getting started
33
34All end-user documentation and guides are located at [openthread.io](https://openthread.io). If you're looking to do things like...
35
36- Learn more about OpenThread features and enhancements
37- Use OpenThread in your products
38- Learn how to build and configure a Thread network
39- Port OpenThread to a new platform
40- Build an application on top of OpenThread
41- Certify a product using OpenThread
42
43...then [openthread.io](https://openthread.io) is the place for you.
44
45> Note: For users in China, end-user documentation is available at [openthread.google.cn](https://openthread.google.cn).
46
47If you're interested in contributing to OpenThread, read on.
48
49# Contributing
50
51We would love for you to contribute to OpenThread and help make it even better than it is today! See our [Contributing Guidelines](https://github.com/openthread/openthread/blob/main/CONTRIBUTING.md) for more information.
52
53Contributors are required to abide by our [Code of Conduct](https://github.com/openthread/openthread/blob/main/CODE_OF_CONDUCT.md) and [Coding Conventions and Style Guide](https://github.com/openthread/openthread/blob/main/STYLE_GUIDE.md).
54
55# License
56
57OpenThread is released under the [BSD 3-Clause license](https://github.com/openthread/openthread/blob/main/LICENSE). See the [`LICENSE`](https://github.com/openthread/openthread/blob/main/LICENSE) file for more information.
58
59Please 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.
60
61# Need help?
62
63OpenThread support is available on GitHub:
64
65- Bugs and feature requests — [submit to the Issue Tracker](https://github.com/openthread/openthread/issues)
66- Community Discussion - [ask questions, share ideas, and engage with other community members](https://github.com/openthread/openthread/discussions)
67