1.. _showcase-sense-tutorial-intro: 2 3============== 4Sense tutorial 5============== 6.. _repo: https://pigweed.googlesource.com/pigweed/showcase/sense/ 7 8Welcome to the :ref:`Sense <showcase-sense>` tutorial! If you want a hands-on, 9guided tour of the Sense `repo`_, you're in the right place. 10 11.. _Bazel quickstart: https://cs.opensource.google/pigweed/quickstart/bazel 12 13.. note:: 14 15 If you'd like to start a Bazel-based project from scratch from a 16 minimal starter repo, check out our `Bazel quickstart`_. 17 18.. _showcase-sense-tutorial-intro-expectations: 19 20-------------- 21What to expect 22-------------- 23Here's a very high-level overview of what your tutorial experience 24will include: 25 26#. You set up your computer (the "development host" or "host" for short) 27 so that it's ready to build the repo, flash binaries, and so on. 28#. You run a simulated version of unit tests and a basic bringup program 29 on your host. 30#. You run gradually more and more complex programs on physical hardware. 31 32.. _showcase-sense-tutorial-intro-prereqs: 33 34------------- 35Prerequisites 36------------- 37Please read over these prerequisites and make sure the tutorial is a good 38fit for you: 39 40.. _MicroPython Pico SDK: https://www.raspberrypi.com/documentation/microcontrollers/micropython.html 41.. _C/C++ Pico SDK: https://www.raspberrypi.com/documentation/microcontrollers/c_sdk.html 42.. _Pimoroni Enviro+ Pack: https://shop.pimoroni.com/products/pico-enviro-pack 43 44* **macOS or Linux development host**: Windows isn't supported with this particular 45 tutorial yet. 46 47* **Hardware setups** (all of the following setups are supported): 48 49 * (Recommended) Raspberry Pi Pico and `Pimoroni Enviro+ Pack`_: You'll be 50 able to complete the full tutorial. 51 52 * Raspberry Pi Pico only: You'll be able to complete most of the tutorial 53 except the last parts that require an Enviro+ Pack. 54 55 * No hardware (development host only): You can actually still try 56 out some of the tutorial! Pigweed provides a way to emulate the app 57 on your host. You'll need to stop at :ref:`showcase-sense-tutorial-flash`. 58 59* **Embedded development experience**: We assume that you're comfortable 60 with C++ and common tasks such as flashing a Pico over USB. You may still 61 be able to complete the tutorial without this background knowledge but should 62 expect the tutorial to be more challenging. 63 64You can use either the Pico 1 or Pico 2; we support both. 65 66.. _Pico W: https://www.raspberrypi.com/documentation/microcontrollers/raspberry-pi-pico.html#raspberry-pi-pico-w-and-pico-wh 67 68.. caution:: 69 70 **The Pico W is untested**. We are still in the process of verifying that 71 all parts of the tutorial work with the `Pico W`_. You are welcome to try 72 the tutorial with a Pico W, but please remember that some things may not 73 work yet. 74 75.. _showcase-sense-tutorial-intro-summary: 76 77------- 78Summary 79------- 80In this tutorial you'll see many Pigweed features working together that can 81help your team develop embedded systems more sustainably, robustly, and 82rapidly. 83 84Next, head over to :ref:`showcase-sense-tutorial-setup` to get your 85development host ready to run Sense. 86 87.. toctree:: 88 :maxdepth: 1 89 :hidden: 90 91 setup 92 explore 93 build 94 code_intelligence 95 host_tests 96 host_sim 97 flash 98 device_tests 99 rpc 100 automate 101 web 102 factory 103 bazel_cloud 104 production 105 crash_handler 106 outro 107