xref: /aosp_15_r20/external/pigweed/docs/index.rst (revision 61c4878ac05f98d0ceed94b57d316916de578985)
1:html_theme.sidebar_secondary.remove:
2
3.. _docs-root:
4
5=======
6Pigweed
7=======
8*Sustained, robust, and rapid embedded product development for large teams*
9
10-----------
11Get started
12-----------
13.. raw:: html
14
15   <!-- Add a little space between the H2 and the cards. This is an edge case
16        that only occurs on the homepage so it's best to just hack the fix
17        locally here. -->
18   <br>
19
20.. grid:: 1
21
22   .. grid-item-card:: :octicon:`rocket` Tour of Pigweed
23      :link: showcase-sense
24      :link-type: ref
25      :class-item: sales-pitch-cta-primary
26
27      Explore key Pigweed features, such as hermetic building, full C++
28      code intelligence in VS Code, communicating with devices over RPC,
29      host-side and on-device unit tests, and lots more in a guided
30      walkthrough.
31
32.. grid:: 2
33
34   .. grid-item-card:: :octicon:`code-square` Bazel quickstart
35      :link: https://cs.opensource.google/pigweed/quickstart/bazel
36      :link-type: url
37      :class-item: sales-pitch-cta-secondary
38
39      Fork our minimal, Bazel-based starter project to create a new
40      Pigweed project from scratch. The project includes a basic
41      blinky LED program that runs on Raspberry Pi Picos and can
42      be simulated on your development host.
43
44   .. grid-item-card:: :octicon:`list-ordered` More get started guides
45      :link: docs-get-started
46      :link-type: ref
47      :class-item: sales-pitch-cta-secondary
48
49      Set up a C++-based Zephyr project, set up GitHub Actions,
50      integrate Pigweed into an existing Bazel project, and more.
51
52---------------------------------------------
53Pigweed SDK launches with Raspberry Pi RP2350
54---------------------------------------------
55.. _Google Pigweed comes to our new RP2350: https://www.raspberrypi.com/news/google-pigweed-comes-to-our-new-rp2350/
56.. _Introducing the Pigweed SDK: https://opensource.googleblog.com/2024/08/introducing-pigweed-sdk.html
57
58The first preview release of the Pigweed SDK has launched with official
59hardware support for Raspberry Pi’s newest microprocessor products, the
60RP2350 and Pico 2! Check out the following blog posts to learn more:
61
62* `Google Pigweed comes to our new RP2350`_
63* `Introducing the Pigweed SDK`_
64
65----------------
66What is Pigweed?
67----------------
68.. raw:: html
69
70   <!-- Add a little space between the H2 and the cards. This is an edge case
71        that only occurs on the homepage so it's best to just hack the fix
72        locally here. -->
73   <br>
74
75.. grid:: 2
76
77   .. grid-item-card:: :octicon:`code-square` Libraries
78      :link: docs-concepts-embedded-development-libraries
79      :link-type: ref
80      :class-item: sales-pitch-cta-secondary
81
82      Over 150 libraries ("modules") enabling you to use modern C++ and
83      software development best practices without compromising performance,
84      code size, or memory
85
86   .. grid-item-card:: :octicon:`tools` Automation
87      :link: docs-concepts-build-system
88      :link-type: ref
89      :class-item: sales-pitch-cta-secondary
90
91      Easier automated building, testing, and linting for Bazel, GN,
92      and CMake projects
93
94.. grid:: 2
95
96   .. grid-item-card:: :octicon:`container` Environments
97      :link: docs-concepts-development-environment
98      :link-type: ref
99      :class-item: sales-pitch-cta-secondary
100
101      Hermetic and replicable development environments for your entire team -
102      no more struggling with toolchains and "it worked on my machine"
103
104   .. grid-item-card:: :octicon:`stack` Frameworks
105      :link: docs-concepts-full-framework
106      :link-type: ref
107      :class-item: sales-pitch-cta-secondary
108
109      Turnkey solutions for new projects that want to make full use of
110      everything that Pigweed offers
111
112--------------------
113Who's using Pigweed?
114--------------------
115.. _satellites: https://www.spinlaunch.com/
116.. _autonomous aerial drones: https://www.flyzipline.com/
117
118.. TODO: b/358432838 - Update this section once the banned word list is fixed.
119
120Pigweed has shipped in millions of devices, including Google's suite of Pixel
121devices, Nest thermostats, `satellites`_, and `autonomous aerial drones`_.
122
123--------------------
124Showcase: pw_console
125--------------------
126:ref:`module-pw_console` is our multi-purpose, pluggable REPL and log viewer.
127It's designed to be a complete development and manufacturing solution for
128interacting with hardware devices via :ref:`module-pw_rpc` over a
129:ref:`module-pw_hdlc` transport. Gone are the days of hacking together a REPL
130and log viewer for each new project!
131
132.. figure:: pw_console/images/python_completion.png
133   :alt: Using pw_console to interact with a device
134
135   Using pw_console to interact with a device
136
137.. _docs-root-changelog:
138
139---------------------
140What's new in Pigweed
141---------------------
142.. include:: changelog.rst
143   :start-after: .. changelog_highlights_start
144   :end-before: .. changelog_highlights_end
145
146See :ref:`docs-changelog-latest` in our changelog for details.
147
148----------
149Talk to us
150----------
151.. raw:: html
152
153   <!-- Add a little space between the H2 and the cards. This is an edge case
154        that only occurs on the homepage so it's best to just hack the fix
155        locally here. -->
156   <br>
157
158.. grid:: 1
159
160   .. grid-item-card:: :octicon:`comment-discussion` Chat room
161      :link: https://discord.gg/M9NSeTA
162      :link-type: url
163      :class-item: sales-pitch-cta-secondary
164
165      For real-time discussion with the Pigweed team, head over to our Discord.
166
167.. grid:: 2
168
169   .. grid-item-card:: :octicon:`device-camera-video` Monthly community meeting
170      :link: https://groups.google.com/g/pigweed
171      :link-type: url
172      :class-item: sales-pitch-cta-secondary
173
174      .. pigweed-live::
175
176   .. grid-item-card:: :octicon:`bug` Issues
177      :link: https://pwbug.dev
178      :link-type: url
179      :class-item: sales-pitch-cta-secondary
180
181      Found a bug? Got a feature request? Please create a new issue in our
182      tracker.
183
184.. toctree::
185   :maxdepth: 1
186   :hidden:
187
188   Home <self>
189   Tour <docs/showcases/sense/index>
190   docs/get_started/index
191   What's new <changelog>
192   modules
193   Source code <https://cs.pigweed.dev/pigweed>
194   docs/showcases/index
195   docs/concepts/index
196   docs/3p/index
197   docs/community/index
198   Developing & contributing <docs/contributing/index>
199   Blog <docs/blog/index>
200