Arduino Library specification

Ref: https://arduino.github.io/arduino-cli/library-specification/

Layout of folders and files

Arduino
โ””โ”€โ”€ libraries
โ””โ”€โ”€ my_lib/
โ”œโ”€โ”€ examples/
โ”œโ”€โ”€ keywords.txt
โ”œโ”€โ”€ library.properties
โ””โ”€โ”€ src/
โ”œโ”€โ”€ my_lib.cpp
โ””โ”€โ”€ my_lib.h

Library metadata

library.properties

library.properties
name=
version=
author=
maintainer=
sentence=
paragraph=
category=[Display|Communication|Signal Input/Output|Sensors|Device Control|Timing|Data Storage|Data Processing|Other]
url=
architectures=*
# optional
dot_a_linkage=
includes=
precompiled=
ldflags=

Keywords(Syntax highlight)

keywords.txt is formatted in four fields which are separated by a single true tab (not spaces)

keywords.txt

keywords.txt
######################################
# Syntax Coloring Map For Wire
######################################
######################################
# Datatypes (KEYWORD1)
######################################
######################################
# Methods and Functions (KEYWORD2)
######################################
######################################
# Instances (KEYWORD2)
######################################
######################################
# Constants (LITERAL1)
######################################
Last updated on