Conventions used
There are a number of text conventions used throughout this book.
Code in text
: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: "After installation, it integrates itself to the VSCode UI where you can find all the functionality that idf.py
of ESP-IDF provides."
A block of code is set as follows:
#define GPIO_LED 2 #define GPIO_LED_PIN_SEL (1ULL << GPIO_LED) #define GPIO_BUTTON 5
When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:
static void button_handler(void *arg); static void init_hw(void)
Any command-line input or output is written as follows:
$ ls -R
Bold: Indicates a new term, an important word, or words that you see on screen. For example, words in menus or dialog boxes appear in the text like this. Here is an example: "Click on the New Project button on the PIO home."
Tips or important notes
Appear like this.