No description
Find a file
Tom Burdick 9f85a70a04 doc: Revamp sensor docs
Docs now start at a high level, discussing sensors, attributes,
channels, and reading data from them.

Followed by more detailed usage guides in how to solve common problems
sensor users may run into.

Additionally renames the sensor_api sphinx tag to sensor

Signed-off-by: Tom Burdick <thomas.burdick@intel.com>
2024-07-16 16:49:24 -04:00
.github ci: compliance: add a PR description check step 2024-07-11 18:37:09 -04:00
arch arch: riscv: fix exception_depth with RISCV_ALWAYS_SWITCH_THROUGH_ECALL 2024-07-12 05:55:26 -04:00
boards boards: nrf54h20: extend and fix documentation 2024-07-12 16:11:15 -04:00
cmake toolchain: arcmwdt: don't set STDC_LIB_EXT1 macro in case of minimal libc 2024-07-12 09:34:58 -04:00
doc doc: Revamp sensor docs 2024-07-16 16:49:24 -04:00
drivers drivers: interrupt_controller: nuclei_eclic: do not modifiy trap entry 2024-07-12 16:09:22 -04:00
dts drivers: serial: lpc11u6x: allow to configure data polarity 2024-07-12 06:29:56 -04:00
include/zephyr toolchain: gcc: fix SECTION_DATA_PROLOGUE for XIP 2024-07-12 16:09:36 -04:00
kernel build: Prefix missed generated syscall includes 2024-07-11 18:24:58 -04:00
lib lib/libc: minimal: remove deprecated headers 2024-07-12 20:38:20 -04:00
misc cmake: modules: dts: use devicetree stub file 2023-10-20 12:18:17 -07:00
modules modules: mbedtls: fix MBEDTLS_PSA_P256M_DRIVER_RAW Kconfig option 2024-07-15 10:36:58 -04:00
samples doc: Revamp sensor docs 2024-07-16 16:49:24 -04:00
scripts MAINTAINERS: add bugs scripts to CI 2024-07-12 16:10:13 -04:00
share sysbuild: check for existence of APPLICATION_CONFIG_DIR 2024-06-27 10:58:11 -04:00
snippets dts: nordic: nrf54l15: Add mbox VEVIF nodes 2024-06-15 04:41:47 -04:00
soc soc/espressif/esp32c6: Do not set HAS_PM or HAS_POWEROFF 2024-07-16 12:53:09 -04:00
submanifests submanifests: update tflite-micro 2024-06-28 07:50:12 -04:00
subsys rtio: workq: Initialize Work item before using it 2024-07-13 10:27:58 -04:00
tests tests: uart_elementary: Correct typos 2024-07-15 15:15:36 -04:00
.checkpatch.conf checkpatch: ignore EXPORT_SYMBOL 2024-04-05 12:19:36 +02:00
.clang-format clang-format: add array-for-each to correct formatting issues 2024-05-28 18:56:24 +02:00
.codecov.yml yamllint: fix all yamllint comments errors 2023-01-04 01:16:45 +09:00
.editorconfig editorconfig: Improve verbosity 2022-04-28 08:55:39 -04:00
.gitattributes
.gitignore .gitignore: do not ignore .\#* files 2024-06-11 19:44:54 -04:00
.gitlint gitlint: do not allow treewide as an area in commit messages 2024-04-10 09:22:24 +02:00
.mailmap mailmap: sort alphabetically 2023-05-15 13:23:32 -04:00
.yamllint scripts: compliance: add support for YAMLLint 2023-01-04 17:29:23 +01:00
CMakeLists.txt llext: disable verbose for SLID generation scripts 2024-07-09 17:21:18 +02:00
CODE_OF_CONDUCT.md coc: Update Code of Conduct to latest Contributor Covenant 2023-12-21 09:38:23 +00:00
CODEOWNERS drivers: disk: remove sdmmc_sdhc.h since no longer used 2024-06-14 18:50:47 -04:00
CONTRIBUTING.rst
Kconfig
Kconfig.zephyr kconfig: llvm: Set default opt level to -Oz when building with LLVM 2024-06-14 19:05:50 -04:00
LICENSE
MAINTAINERS.yml MAINTAINERS: Add kconfig preprocessor doc to DT 2024-07-16 18:17:34 +02:00
README.rst doc: README: Rework Resources section 2023-10-17 19:05:20 +03:00
SDK_VERSION SDK_VERSION: Use Zephyr SDK 0.16.8 2024-06-04 22:59:31 -04:00
VERSION release: Zephyr v3.7.0-rc3 2024-07-13 14:07:16 -04:00
version.h.in version.h.in: Do not use @template@ 2024-05-24 18:05:41 -04:00
west.yml west: update altera hal 2024-07-13 10:47:22 -04:00
zephyr-env.cmd
zephyr-env.sh

.. raw:: html

   <a href="https://www.zephyrproject.org">
     <p align="center">
       <picture>
         <source media="(prefers-color-scheme: dark)" srcset="doc/_static/images/logo-readme-dark.svg">
         <source media="(prefers-color-scheme: light)" srcset="doc/_static/images/logo-readme-light.svg">
         <img src="doc/_static/images/logo-readme-light.svg">
       </picture>
     </p>
   </a>

   <a href="https://bestpractices.coreinfrastructure.org/projects/74"><img
   src="https://bestpractices.coreinfrastructure.org/projects/74/badge"></a>
   <a
   href="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml?query=branch%3Amain">
   <img
   src="https://github.com/zephyrproject-rtos/zephyr/actions/workflows/twister.yaml/badge.svg?event=push"></a>


The Zephyr Project is a scalable real-time operating system (RTOS) supporting
multiple hardware architectures, optimized for resource constrained devices,
and built with security in mind.

The Zephyr OS is based on a small-footprint kernel designed for use on
resource-constrained systems: from simple embedded environmental sensors and
LED wearables to sophisticated smart watches and IoT wireless gateways.

The Zephyr kernel supports multiple architectures, including ARM (Cortex-A,
Cortex-R, Cortex-M), Intel x86, ARC, Nios II, Tensilica Xtensa, and RISC-V,
SPARC, MIPS, and a large number of `supported boards`_.

.. below included in doc/introduction/introduction.rst


Getting Started
***************

Welcome to Zephyr! See the `Introduction to Zephyr`_ for a high-level overview,
and the documentation's `Getting Started Guide`_ to start developing.

.. start_include_here

Community Support
*****************

Community support is provided via mailing lists and Discord; see the Resources
below for details.

.. _project-resources:

Resources
*********

Here's a quick summary of resources to help you find your way around:

Getting Started
---------------

  | 📖 `Zephyr Documentation`_
  | 🚀 `Getting Started Guide`_
  | 🙋🏽 `Tips when asking for help`_
  | 💻 `Code samples`_

Code and Development
--------------------

  | 🌐 `Source Code Repository`_
  | 📦 `Releases`_
  | 🤝 `Contribution Guide`_

Community and Support
---------------------

  | 💬 `Discord Server`_ for real-time community discussions
  | 📧 `User mailing list (users@lists.zephyrproject.org)`_
  | 📧 `Developer mailing list (devel@lists.zephyrproject.org)`_
  | 📬 `Other project mailing lists`_
  | 📚 `Project Wiki`_

Issue Tracking and Security
---------------------------

  | 🐛 `GitHub Issues`_
  | 🔒 `Security documentation`_
  | 🛡️ `Security Advisories Repository`_
  | ⚠️ Report security vulnerabilities at vulnerabilities@zephyrproject.org

Additional Resources
--------------------
  | 🌐 `Zephyr Project Website`_
  | 📺 `Zephyr Tech Talks`_

.. _Zephyr Project Website: https://www.zephyrproject.org
.. _Discord Server: https://chat.zephyrproject.org
.. _supported boards: https://docs.zephyrproject.org/latest/boards/index.html
.. _Zephyr Documentation: https://docs.zephyrproject.org
.. _Introduction to Zephyr: https://docs.zephyrproject.org/latest/introduction/index.html
.. _Getting Started Guide: https://docs.zephyrproject.org/latest/develop/getting_started/index.html
.. _Contribution Guide: https://docs.zephyrproject.org/latest/contribute/index.html
.. _Source Code Repository: https://github.com/zephyrproject-rtos/zephyr
.. _GitHub Issues: https://github.com/zephyrproject-rtos/zephyr/issues
.. _Releases: https://github.com/zephyrproject-rtos/zephyr/releases
.. _Project Wiki: https://github.com/zephyrproject-rtos/zephyr/wiki
.. _User mailing list (users@lists.zephyrproject.org): https://lists.zephyrproject.org/g/users
.. _Developer mailing list (devel@lists.zephyrproject.org): https://lists.zephyrproject.org/g/devel
.. _Other project mailing lists: https://lists.zephyrproject.org/g/main/subgroups
.. _Code samples: https://docs.zephyrproject.org/latest/samples/index.html
.. _Security documentation: https://docs.zephyrproject.org/latest/security/index.html
.. _Security Advisories Repository: https://github.com/zephyrproject-rtos/zephyr/security
.. _Tips when asking for help: https://docs.zephyrproject.org/latest/develop/getting_started/index.html#asking-for-help
.. _Zephyr Tech Talks: https://www.zephyrproject.org/tech-talks