How to run an example
Explore with your favorite AI
Gemini & other AI
Copy this page’s context into your AI to explore how it works and what you can build.
Copy the prompt, then paste it into Gemini’s message box.
View prompt
Match the leaf configuration and development tool, then check the build → upload → execution result in order. This makes it easier to find where a problem starts. Choose a purpose or CPU from the example catalog and check the required items in the article.
1. Match your hardware
Section titled “1. Match your hardware”- Check the processor model number. Even examples using the same temperature and humidity sensor need different board selections and upload procedures for AVR, STM32, and ESP32.
- Gather the leaves and additional parts. Check the model numbers, power supply, antenna, SIM, and other requirements in the article, as well as the kit name. Turn off the power before assembling, attaching, or removing leaves.
- Choose the development tool. Open Arduino IDE sketches, PlatformIO projects, and STM32CubeIDE projects using their respective procedures. Start with your CPU under Development environment.
2. Obtain the source and libraries
Section titled “2. Obtain the source and libraries”Use the article’s source link to obtain all files required by the example. A sample with multiple files needs its headers and configuration files as well as the main .ino or main.cpp.
| Development tool | What to open and check |
|---|---|
| Arduino IDE | The sketch folder and .ino file. Install the libraries and board package specified in the article |
| PlatformIO | The project folder containing platformio.ini. Check board, lib_deps, and the upload destination |
| STM32CubeIDE | The project folder containing .project and .cproject. Obtain Core, Drivers, and the other project files together |
GitHub links to main or master can change as the source is updated. Use a complete set from the same revision instead of mixing old and new files. Keep a copy of a previously working project before updating it so you can compare the changes.
Libraries with similar names may be different implementations. Use the source specified in the article and check its CPU and Arduino Core requirements. For STM32, for example, see RTC and low-power library compatibility with the Core.
3. Check three stages
Section titled “3. Check three stages”| Stage | Success check | If it stops here |
|---|---|---|
| Build | Compilation completes without errors | Read the first error and check the board, CPU, and required libraries |
| Upload | The development tool reports a successful upload | Check the USB cable, port, power supply, and program switch |
| Execution | You obtain the LED pattern, serial output, received data, or other result described in the article | Check the switch to run mode, reset, wiring, and communication destination |
A successful build or upload is a separate check from successful operation. For communication examples, check the receiver or saved data as well as the transmitter log. Sensor values depend on the surroundings: check that readings are obtained and respond to changes, rather than expecting the same numbers as the screenshot.
4. If it does not work
Section titled “4. If it does not work”Start with the article’s troubleshooting section and the FAQ. When contacting support, include the leaves, development tool, sample URL, stage reached, and first error. Do not send passwords, tokens, or SIM identifiers.
In the catalog, Upcoming examples are not yet published. Previous versions & reference may use different procedures or conditions from current examples. Read any notices about discontinued external services before using them.