Getting started may be the most challenging part of every new library. This guide is describing how to start with the library quickly and effectively
Library is primarly hosted on Github.
You can get it by:
Downloading latest release from releases area on Github
mainbranch for latest stable version
developbranch for latest development
Clone from Github
This is used when you do not have yet local copy on your machine.
Open console and navigate to path in the system to clone repository to. Use command
Clone repository with one of available options below
git clone --recurse-submodules https://github.com/MaJerle/lwespcommand to clone entire repository, including submodules
git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwespto clone development branch, including submodules
git clone --recurse-submodules --branch main https://github.com/MaJerle/lwespto clone latest stable branch, including submodules
examplesdirectory and run favourite example
Update cloned to latest version
Open console and navigate to path in the system where your repository is located. Use command
git pull origin maincommand to get latest changes on
git pull origin developcommand to get latest changes on
git submodule update --init --remoteto update submodules to latest version
This is preferred option to use when you want to evaluate library and run prepared examples. Repository consists of multiple submodules which can be automatically downloaded when cloning and pulling changes from root repository.
Add library to project
At this point it is assumed that you have successfully download library, either cloned it or from releases page. Next step is to add the library to the project, by means of source files to compiler inputs and header files in search path
lwespfolder to your project, it contains library files
lwesp/src/includefolder to include path of your toolchain. This is where C/C++ compiler can find the files during compilation process. Usually using
Add source files from
lwesp/src/folder to toolchain build. These files are built by C/C++ compiler. CMake configuration comes with the library, allows users to include library in the project as subdirectory and library.
lwesp/src/include/lwesp/lwesp_opts_template.hto project folder and rename it to
Build the project
If you are using CMake build system, you can add the library to the project by adding the library’s folder
add_directory() CMake command, followed by linking the target with
Configuration file is used to overwrite default settings defined for the essential use case.
Library comes with template config file, which can be modified according to the application needs.
and it should be copied (or simply renamed in-place) and named
Default configuration template file location:
File must be renamed to
lwesp_opts.h first and then copied to the project directory where compiler
include paths have access to it by using
If you are using CMake build system, define the variable
LWESP_OPTS_DIR before adding library’s directory to the CMake project.
Variable must set the output directory path. CMake will copy the template file there, and name it as required.
Configuration options list is available available in the Configuration section. If any option is about to be modified, it should be done in configuration file
1/** 2 * \file lwesp_opts_template.h 3 * \brief Template config file 4 */ 5 6/* 7 * Copyright (c) 2023 Tilen MAJERLE 8 * 9 * Permission is hereby granted, free of charge, to any person 10 * obtaining a copy of this software and associated documentation 11 * files (the "Software"), to deal in the Software without restriction, 12 * including without limitation the rights to use, copy, modify, merge, 13 * publish, distribute, sublicense, and/or sell copies of the Software, 14 * and to permit persons to whom the Software is furnished to do so, 15 * subject to the following conditions: 16 * 17 * The above copyright notice and this permission notice shall be 18 * included in all copies or substantial portions of the Software. 19 * 20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, 21 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES 22 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE 23 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT 24 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, 25 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 26 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 27 * OTHER DEALINGS IN THE SOFTWARE. 28 * 29 * This file is part of LwESP - Lightweight ESP-AT parser library. 30 * 31 * Author: Tilen MAJERLE <email@example.com> 32 * Version: v1.1.2-dev 33 */ 34#ifndef LWESP_OPTS_HDR_H 35#define LWESP_OPTS_HDR_H 36 37/* Rename this file to "lwesp_opts.h" for your application */ 38 39/* 40 * Open "include/lwesp/lwesp_opt.h" and 41 * copy & replace here settings you want to change values 42 */ 43 44#endif /* LWESP_OPTS_HDR_H */
If you prefer to avoid using configuration file, application must define
a global symbol
LWESP_IGNORE_USER_OPTS, visible across entire application.
This can be achieved with
-D compiler option.