Описание библиотек ардуино на русском. Установка библиотек в Arduino IDE. Примеры из библиотек

В библиотеке уже есть большая часть кода который вам не нужно будет писать, библиотека облегчает работу с определённым модулем или одним из их типов и ее всего лишь необходимо подключить в вашем скетче.

К примеру если вы хотите вывести текст на LCD дисплей без подключения библиотеки, то Вам нужно передать ему несколько байт команд и данных, что займет несколько строк кода, а главное, что Вам нужно знать тип микроконтроллера под управлением которого работает LCD дисплей, назначение команд которыми он управляется, знать архитектуру его памяти, адреса и назначение регистров, для чего потребуется найти и перечитать его datasheet.

В то время как при написании кода с использованием библиотеки (например LiquidCrystal_I2C.h) Вы сможете вывести текст на дисплей вызвав всего одну функцию библиотеки:

Lcd.print(“my text”);

Подключить любую библиотеку можно такой командой:

"#include <файл.h>"

<файл.h> – это и есть та самая библиотека, которую мы подключаем.

Так же вы можете посмотреть пример подключения библиотеки в статье .

Перед тем как начать пользоваться методами и функциями библиотеки, её нужно:

  • скачать (загрузить на Ваш компьютер),
  • установить (разместить в нужной папке),
  • подключить (вставить текст “#include <файл.h>” в скетч).

Каждая библиотека должна содержать 2 файла с расширениями .h и .cpp .

Файлы первого типа содержат:

  • описание класса,
  • константы,
  • переменные.

Второй тип содержит коды методов.

Дополнительно нужно понимать, что файлы .h и .cpp могут не лежать в корне скачанного архива. Также могут с основными файлами идти "keywords.txt" и папка с примерами (examples).

Как установить библиотеку?

После того как Вы скачали (загрузили) библиотеку на свой компьютер, её нужно установить. Установить библиотеку можно вручную или сделать это средствами Arduino IDE:

Установка библиотеки посредством Arduino IDE

Это мы сделаем через меню. Зайдите в меню:

Скетч – Подключить библиотеку – Добавить.ZIP библиотеку

В появившемся окне нажмите на иконку «Этот компьютер» и выберите папку «Загрузки». Если при скачивании ZIP архива с сайта, Вы указывали путь для сохранения файла, то вместо папки «Загрузки» укажите путь к файлу.

Выберите ZIP файл библиотеки, который Вы скачали. Название файла может не соответствовать названию библиотеки. После чего нажмите на кнопку «Открыть » (Open ).

На этом установка библиотеки завершена, можно приступить к её подключению в скетч.

Важно! После установки Arduino IDE на компьютере создается отдельная папка для хранения всех библиотек. Для ОС Linux "Scetchbook", располагается в /home/. Для ОС Windows папка "Arduino", располагается в /Мои документы/.

Установка библиотеки вручную

Распакуйте скаченный Вами ZIP архив и поместите папку (имя папки обычно совпадает с названием библиотеки) из данного архива в папку:

Этот компьютер Документы Arduino libraries

Если во время копирования Arduino IDE была запущена (открыта), то нужно закрыть все окна этой программы, после чего запустить (открыть) Arduino IDE и можно приступать к подключению библиотеки в скетч.

Дело в том, что программа постоянно развивается и количество её версий постоянно растёт. Если Вы захотите установить новую версию Arduino IDE, то библиотеки находящиеся в папке (Этот компьютер → Документы → Arduino → libraries) будут доступны и в старой, и в новой (установленной) версии Arduino IDE, а библиотеки находящиеся в папке libraries программы Arduino IDE старой версии (которая была установлена ранее) будут доступны только в ней (пока Вы их не скопируете в новую).

Где найти нужную библиотеку?

Для удобства на нашем сайте есть целый раздел, который так и называется - . Большинство библиотек можно найти в Интернете в открытом доступе.

Также ряд стандартных наборов можно найти на официальном сайта Ардуино: arduino.cc .

Какие библиотеки уже установлены?

Как мы уже обсуждали - сама интегрированная среда разработки уже идет с некоторым .

Есть два способа посмотреть установленные библиотеки.

Способ 1

Чтобы посмотреть какой набор уже установлен нужно перейти во вкладку:

Способ 2

Второй способ - воспользоваться меню "Скетч" и подменю "Подключить библиотеку". Таким образом можно также увидеть список библиотек.

Заходим в Скетч и выбираем Подключить библиотеку:

Скетч → Подключить библиотеку

Возможные ошибки

Иногда при установке библиотек или в процессе их использования могут возникать некоторые ошибки. Ниже разберем основные.

‘xxxx’ does not name a type

Ошибка появляется тогда, когда библиотека еще не установлена.

Также ошибка возникает если папка или библиотека имеет неправильное название.

Может быть указан неправильный адрес расположения папки или не перезапущена среда разработки Arduino IDE!

Неправильное расположение папки

Проверьте, находятся ли все библиотеки по нужному адресу. Адреса папок для разных операционных систем мы приводили выше.

Неправильное наименование библиотеки

Ошибка появляется тогда, когда имя после тега #include не соответствует названию библиотеки.

Неполная библиотека

Не хватает всех нужных файлов и папок.

Зависимости библиотеки

Необходимо подключить дополнительные зависимые библиотеки без которых правильная/корректная работа невозможна.

Освоившись с программным обеспечением Arduino, используя встроенные функции, вы можете расширить возможности вашего Arduino, используя дополнительные библиотеки.

Библиотека — это некоторый набор кода, который облегчает подключения датчика, экрана, шилда и так далее. Например, встроенная библиотека LiquidCrystal облегчает взаимодействие с . В Интернете можно найти сотни различных дополнительных библиотек. Для того, чтобы воспользоваться этими библиотеками, их нужно сначала установить.

Используем Library Manager

Чтобы установить новую библиотеку в Arduino IDE , можно воспользоваться Library Manager , который появился в версии .

В меню Эскиз выбираем Include Library → Manage Libraries...

После этого откроется менеджер библиотек и вы увидите список библиотек, которые уже установлены или готовы к установке. Уже установленные библиотеки помечены как INSTALLED .

В этом примере мы будем устанавливать библиотеку Encoder . Найдите ее в списке и выберете версию, которую вы хотели бы установить. В некоторых библиотеках вам будет доступна только одна версия, поэтому не волнуйтесь, если не увидите меню выбора версии библиотеки.

После этого появится индикатор процесса установки и после ее завершения статус библиотеки Encoder сменится на INSTALLED . Теперь эта библиотека станет доступной для добавления в наши программы, используя меню Эскиз → Include Library .

Импорт библиотеки в виде файла .zip

Часто библиотеки можно встретить в виде упакованной в zip -архив папки. Название этой папки является именем библиотеки. Внутри папки обязаельно будет файл .cpp и заголовочный .h файл. Также часто можно встретить файл keywords.txt , папку с кодом примеров использования этой библиотеки и другие требуемые для этой библиотеки файлы.

После скачивания библиотеки в виде zip -архива его не нужно распаковывать. Для установки запакованной библиотеки служит меню Эскиз → Include Library → Add .ZIP Library.

После этого нужно указать путь к zip -файлу библиотеки. Этот zip -файл будет распакован и помещен в папку libraries в директорию со скетчами Arduino .

Нужно отметить, что после установки библиотека становится доступной через меню Эскиз → Include Library , но для того, чтобы стали доступны файлы примеров этой библиотеки, используя меню Файл → Образцы, необходимо перезапустить Arduino IDE .

Ручная установка библиотеки

Для ручной установки библиотеки, прежде всего, нужно закрыть приложение Arduino IDE . Затем распакуйте, скаченный zip-файл. Например, мы хотим установить гипотетическую библиотеку RobotoshaArduino . Распаковав файл RobotoshaArduino.zip , мы должны получить папку RobotoshaArduino с файлами типа RobotoshaArduino.cpp и RobotoshaArduino.h внутри. Если после распаковки мы получаем файлы без папки, то нужно создать вручную папку RobotoshaArduino , поместив внутрь полученные библиотечные файлы.

После этого необходимо переместить эту папку в папку libraries , расположение которой зависит от используемой вами операционной системы.

Для Windows, по умолчанию, это:

Мои документы\Arduino\libraries

Для пользователей Mac OS X :

~/Документы/Arduino/libraries

В Linux это будет папка libraries с вашими скетчами.

Очень важно, чтобы библиотечные файлы .cpp и .h находились в отдельной папке (как в примере RobotoshaArduino ). Если поместить файлы .cpp и .h просто в папку libraries , то библиотека работать не будет.

После перезапуска Arduino IDE добавленная библиотека станет доступна для подключения ее к свои программам через меню Эскиз → Include Library .

Как вы оцениваете эту публикацию?

Библиотеки для Arduino - это удобное средство для распространения кода. Например, это могут быть драйвера к оборудованию или часто используемые функции.

В этом гайде подробно рассмотрено как устанавливать библиотеки на ваш компьютер.

Существует два основных вида библиотек Arduino: стандартные и дополнительные.

Стандартные библиотеки

В Arduino IDE есть набор стандартных библиотек, которые используются очень часто. Эти библиотеки поддерживают все примеры, которые включены в Arduino IDE. Стандартные библиотеки поддерживают функции для работы с наиболее распространенным периферийным оборудованием, например: серводвигатели или LCD экраны.

Стандартные библиотеки устанавливаются в папку "Libraries" при установке Arduino IDE. Если у вас установлено несколько версий IDE, в каждой версии будет свой набор библиотек. Настоятельно не рекомендуется изменять стандартные библиотеки и устанавливать дополнительные в ту же папку.

Дополнительные библиотеки

В интернете выложено огромное количество дополнительных библиотек с удобным функционалом и драйверами для различного периферийного оборудования. В основном библиотеки выкладываются на Arduino Playground, Github и Google Code. Написанием библиотек для Arduino часто занимаются компании-производители сенсоров, датчиков, печатных плат и т.п. Например, Adafruit предлагает более 100 библиотек, которые поддерживают все модели плат Arduino.

Устанавливайте дополнительные библиотеки в папку Libraries. Благодаря этому их можно использовать во всех версиях Arduino IDE. После обновления версии вам не придется их переустанавливать!

Куда устанавливать библиотеки

Важно установить библиотеки в правильную папку. Иначе компилятор не сможет их отыскать, когда вы будете компилировать и загружать ваш код.

Папка, где хранятся все скетчи Arduino, создается автоматически при установке IDE.

На Linux папка называется "Scetchbook" и обычно расположена в /home/<username>

На Windows и Macintosh, папка называется "Arduino" и находится она папке Documents (Мои документы).

Обратите внимание, это важно! В папке "Мои документы" автоматически создается еще папка под названием "Arduino"!

Дополнительные библиотеки должны располагаться в папке "Libraries", которая находится внутри "Scetchbook" или "Arduino". Именно там IDE будет искать дополнительно установленные библиотеки.

Начиная с версии Arduino IDE 1.0.2 и позже, папка "Libraries" создается автоматически. На более ранних версиях ее надо создать перед установкой вашей первой библиотеки.

Откройте меню и выберите "File->Preferences" в Arduino IDE.

>

Найдите расположение ваших скетчей. Обычно это папка "Arduino" в папке "Мои документы".

После того, как вы определили путь, перейдите в эту папку с помощью проводника.


Если папка "Libraries" отсутствует, создайте новую папку.


Переименуюте ее в "Libraries".

Установка библиотек в Windows

Для установки библиотеки в Windows, следуйте инструкции, приведенной ниже.

Закройте Arduino IDE

Убедитесь, что Arduino IDE закрыта, так как сканирование библиотек происходит только при загрузке IDE. Новая библиотека не будет работать, пока вы не перезагрузите IDE.

Скачайте Zip Файл с Github.


Скопируйте разархивированную папку


Вставьте ее в вашу папку с библиотеками.


Дайте ей корректное имя. Arduino IDE не распознает папки с тире в названии. Так что придется переименовать папку. Можно использовать нижние тире.


Перезапустите Arduino IDE и проверьте, появилась ли библиотека в пункте меню File->Examples.

Для проверки загрузите один из примеров.


Перед загрузкой примера на плату, проведите проверку скетча.


Установка библиотек на Mac OSX

Для корректной установки дополнительных библиотек на Mac OSX, следуйте инструкции, которая приведена ниже

Закройте Arduino IDE.

Скачайте архив с библиотекой с Github.


Найдите скачанный архив в папке загрузок на вашем маке.


Разархивируйте и скопируйте библиотеку в папку с библиотеками, которая была создана при установке Arduino IDE.


Дайте библиотеке корректное имя. Как и в случае с Windows, папки с тире не читаются.


Перезапустите Arduino IDE. Библиотека должна появиться в меню File->Examples.

Загрузите один из примеров.


Проверьте корректность скетча перед его загрузкой на вашу Arduino.

Установка библиотек на Linux

Для установки пользовательских библиотек на Linux, следуйте инструкции, которая представлена ниже.

Опять таки, закрываем Ardino IDE.

Скачиваем архив с нужной нам библиотекой.


Сохраняем архив на жесткий диск нашего ПК.


Находим скачанный архив в папке для загрузок.


Разархивируем библиотеку и копируем в папку Sketchbook/Libraries.


Даем папке корректное имя. Без тире!


Перезапускаем Arduino IDE и проверяем, появилась ли библиотека в папке File->Examples menu.

Загружаем один из примеров.


Проверяем, компилируется ли файл примера без ошибок.


Распространенные ошибки при установке библиотек для Arduino

"xxxx" does not name a type


Это самая распространенная ошибка при работе с внешними библиотеками. Причина - компилятор не может найти библиотеку. Возможные причины возникновения этой ошибки:

  • Библиотека не установлена (смотрите инструкцию по установке выше).
  • Неправильное расположение папки.
  • Неправильное имя папки.
  • Неправильное имя библиотеки.
  • Вы забыли перезагрузить Arduino IDE.

Ниже расписаны решения возможных проблем

Неправильное расположение папки

IDE находит только стандартные библиотеки и дополнительные, которые установлены в папке "Libraries". Библиотеки, которые расположены в других местах, не будут инициализироваться

Папка с библиотекой должна быть в корне папки "Libraries". Если вы создадите дополнительную подпапку, IDE не обнаружит библиотеку.

Примечание: в некоторых хранилищах в интернете, библиотеки выложены с дополнительным уровнем вложенности папок. Проверьте этот момент. Файлы библиотеки должны находится в первой папке, без дополнительных подпапок.

Не полная библиотека

Не стоит переименовывать файлы в библиотеке с использованием заглавных букв, тире и т.п.

Неправильное имя папки

IDE не обнаруживает папки с определенными символами в названии. К сожалению, IDE не поддерживает тире, которые генерируются в именах файлов на Github. Поэтому после скачивания архива, переименуйте папку. Новое имя не должно содержать тире. Можно просто заменить все символы (‘-‘) на (‘_’).

Неправильное имя библиотеки

Имя, которые вы указываете в директиве #include в вашем скетче, должно полностью соответствовать имени класса в библиотеке (с учетом регистра букв!). Если имя не будет совпадать, IDE не подключит нужные функции, классы и т.п. В примерах, которые прилагаются к библиотекам, имена указаны правильно. Так что для избежания случайных ошибок, можно их просто копировать и вставлять в ваш код.

Несколько версий библиотек

Если у вас несколько версий библиотеки, Arduino IDE будет пытаться одновременно прогрузить их все. В результате может вылезти ошибка при компиляции. Так что старые или нерабочие версии надо удалять или перемещать из каталога библиотек.

Зависимые библиотеки

Некоторые библиотеки зависят от других библиотек. Например, большинство библиотек Graphic Display Libraries от Adafruit зависят от Adafruit GFX Library. То есть, для использования первой библиотеки вам надо иметь установленную вторую.

“Базовые” библиотеки

Некоторые библиотеки нельзя использовать напрямую. Хороший пример, библиотека GFX Library. Эта библиотека обеспечивает работу большинства дисплеев от Adafruit, но не может использоваться без библиотеки драйверов для этого дисплея.

Забыли закрыть Arduino IDE

Не забывайте, что IDE ищет библиотеки при загрузке. Перед использованием новой установленной библиотеки, Arduino IDE надо перезагрузить.

Оставляйте Ваши комментарии, вопросы и делитесь личным опытом ниже. В дискуссии часто рождаются новые идеи и проекты!