Стандартные библиотеки ардуино. Установка библиотеки вручную
Одной из причин популярности Arduino является простота использования разнообразных периферийных устройств (модулей): дисплеев, драйверов двигателей, модулей беспроводной связи (Bluetooth, wi-fi, XBee или ISM) и т. д.
Программная среда Arduino (IDE) включает в себя множество полезных функций, облегчающих создание программ для новых проектов. Но, к сожалению, она не может иметь встроенную поддержку для каждого вновь появившегося нового оборудования (модуля) или компонента программного обеспечения.
Вместо этого осуществляется поддержка «библиотек», которые являются автономными модулями, предназначенными для расширения программной среды, добавления определенных функций или аппаратной поддержки.
Основным источником библиотек для Arduino являются производители аппаратного обеспечения, создающие их для обеспечения поддержки в IDE Arduino.
Где можно найти библиотеки к Ардуино
Если вам нужна поддержка Arduino для определенного оборудования (модуля), попробуйте просмотреть сайт производителя модуля. Вы также можете посетить сайт Arduino , в котором собрано множество популярных библиотек.
В противном случае попробуйте выполнить поиск в Google, например, наберите «Arduino library» и название вашего оборудования.
Как было уже сказано выше, в среде разработки Arduino есть предустановленные библиотеки. Чтобы функции библиотеки были доступны в нашей программе сначала необходимо ее подключить. Для этого используется директива #include.
Подключение встроенной библиотеки вызывается из меню «Скетч — Подключить библиотеку — …» далее выбираем необходимую библиотеку (в нашем случае «Servo»).
При выборе библиотеки, Arduino IDE автоматически добавит в ваш код соответствующую директиву #include.
#include
Если в IDE нет необходимой предустановленной библиотеки, то ее необходимо установить самостоятельно. Для этого есть 2 способа.
Первый способ: Добавление библиотеки из репозитория Ардуино.
Создатели Arduino разместили в интернете базу различных библиотек. Если вам не хватает какой-то библиотеки, то вы можете поискать ее в репозитории. Для этого выберите в меню «Скетч – Подключить библиотеку – Управлять библиотеками».
В этом окне вы можете скачать из интернета новую или обновить уже существующую библиотеку.
Второй способ: Добавление библиотеки, скаченной из интернета.
Поскольку в среде Arduino почти все легко и просто, установка дополнительных библиотек тоже не вызывает больших сложностей. В качестве примера мы покажем установку библиотеки для работы с радиомодулем системы беспроводной связи NRF24L01 от компании Nordic Semiconductor.
Библиотеки для Arduino, предназначенные для самых популярных модулей доступны на странице http://arduino.cc/libraries. Программное обеспечение (библиотеки) для менее популярных модулей, как правило, находятся на сайтах производителей этих модулей.
В случае радиомодуля NRF24L01, библиотека поддержки этого модуля в среде Arduino была создана на базе библиотеки, разработанной для микроконтроллеров AVR . Документацию по этой библиотеке и саму библиотеку можно скачать с сайта https://github.com/stanleyseow/arduino-nrf24l01
После того как вы скачали архив библиотеки arduino-nrf24l01-master.zip, необходимо ее установить в IDE. Для этого перейдите в меню «Скетч – Подключить библиотеку – Добавить ZIP библиотеку»
Затем укажите местоположение скаченного файла arduino-nrf24l01-master.zip и нажмите кнопку Open.
После этого, как правило, мы имеем установленную библиотеку. Но, к сожалению, часто бывает так, что Arduino сигнализирует ошибку «Выбранная папка/zip файл не содержит корректных библиотек»
В таком случае библиотеку можно установить вручную. Для этого необходимо распаковать скачанный файл arduino-nrf24l01-master.zip и папку «Mirf» скопировать в папку «libraries». Либо можно поместить папку «Mirf» в C:\….\Documents\Arduino\libraries (тогда библиотека будет доступна из IDE разных версий).
После перезагрузки IDE Arduino мы можем подключить данную библиотеку, а также воспользоваться примерами для радиомодуля NRF24L01
Как удалить библиотеку в Aрдуино
Если вы разобрались, как можно установить новую библиотеку в IDE, то для вас не будет проблемой и с ее удаление (в случае необходимости).
Все, что требуется от вас для удаления библиотеки, это удалить папку библиотеки из каталога «libraries» в IDE или (если библиотека установлена в «Документы») из каталога C:\….\Documents\Arduino\libraries
Для более легкой и продуктивной работы с Arduino есть возможность использовать дополнительные библиотеки. Библиотеки Arduino — это части программы для выполнения конкретных задач. С помощью библиотек можно выполнять сложные действия всего парой строк кода, потому что кто-то другой уже написал часть кода за вас.
В Arduino IDE удобный интерфейс для работы с библиотеками ардуино. Прямо из меню программы вы можете скачать, установить и подключить в свой скетч множество библиотек. Для большинства библиотек Arduino можно посмотреть примеры использования. Это поможет понять принцип работы библиотеки. Примеры можно доработать под свои нужды и использовать для реализации своих устройств.
Существуют стандартные библиотеки, которые устанавливаются вместе с Arduino IDE. Некоторые из них даже автоматически подключаются в скетч (например Serial).
Скачать стандартные библиотеки Arduino
Скачать стандартные библиотеки можно на официальном сайте Arduino .
Там вы найдете описания и примеры использования стандартных библиотек. Так же вы можете скачать все стандартные библиотеки одним архивом . В этом архиве не только стандартные библиотеки, но и множество дополнительных самых популярных библиотек для Ардуино.
Ниже приведены подробные описания и примеры использования стандартных библиотек Arduino.
- — Библиотека для обмена данными через последовательный порт (UART).
- — Библиотека для легкого и точного управления сервоприводами.
- — Библиотека для работы с интерфейсами связи TWI/I2C. Упрощает обмен данными с устройствами, датчиками и сенсорами.
- WiFi — Подключение к интернету с использованием WiFi шилда.
- TFT — Нужна для отрисовки текста, изображений и картинок на TFT дисплее Arduino.
- Stepper — Библиотека для управления шаговыми моторами.
- LiquidCrystal — Для работы Arduino с жидкокристаллическими экранами (LCD)
- Ethernet — Для подключения к интернету с использованием .
- SD — Библиотека для записи и считывания информации с SD карт памяти.
- GSM — Библиотека для подключения Ардуино к GSM сети. Необходима для отправки и получения SMS и звонков, а так же для выхода в интернет с помощью GPRS. Используется с .
- EEPROM — Библиотека для чтения и записи в энергонезависимую память Arduino.
Библиотеки Arduino представляют собой наиболее удобный способ разделения кода вроде кода драйверов устройств или часто используемых полезных функций.
В данном материале будет показано, как установить библиотеки Arduino для Windows, Mac OSX и Linux, а также будут рассмотрены общие проблемы, связанные с библиотеками Arduino. Статья будет полезна новичкам, впрочем, и заядлые пользователи Arduino могут узнать для кое-что новое.
Существует два типа библиотек: стандартные и пользовательские библиотеки.
Стандартные библиотеки Arduino
Среда разработки Arduino IDE поставляется вместе с набором стандартных библиотек основных полезных функций. Эти библиотеки поддерживают все примеры, включенные в IDE. Функционал стандартных библиотек включает в себя функции базовых видов коммуникации и поддерживает наиболее распространенные устройства вроде сервомоторов и символьных LCD-дисплеев. Стандартные библиотеки располагаются в каталоге Libraries (в папке с Arduino IDE). Если у вас установлены IDE разных версий, то каждая из них будет использовать свои библиотеки.
Пользовательские библиотеки
Сегодня существует большое количество библиотек для большей функциональности и для различных устройств. Такие библиотеки и драйверы зачастую доступны на Arduino Playground, Github и Google Code. Эти библиотеки желательно устанавливать в папку Libraries, которую нужно создать в общей папке с вашими скетчами. Тогда все версии IDE смогут использовать эти библиотеки. В Windows и Mac OS обычно папка со скетчами называется Arduino и располагается в папке Документы или Documents. Для Linux папка называется Sketchbook, и расположена она в /home/(username).
Версии IDE 1.0.2 создают папку Libraries автоматически, младшие версии это делать не умеют, поэтому данную процедуру нужно выполнить вручную.
Для начала откройте File-Preferences (Файл-Настройки).
Найдите расположение папки со скетчами (Sketchbook location).
Создайте там новую папку и назовите ее Libraries.
Устанавливаем библиотеки Arduino под Windows
Для начала закройте Arduino IDE, поскольку эта среда сканирует наличие библиотек только при своем запуске. Скачайте необходимую вам библиотеку в zip-архиве, например, с Github.
Откройте zip-файл и разархивируйте библиотеку в папку Libraries.
Дайте библиотеке нормальное имя. Например, IDE не воспримет библиотеку с дефисами в названии.
Запустите IDE и зайдите в File-Examples (Файл-Примеры). Там будут располагаться примеры, использующие возможности новой библиотеки.
Откройте пример и скомпилируйте его, чтобы удостовериться, что все работает правильно.
Устанавливаем библиотеки Arduino для Mac OSX
Найдите скачанную библиотеку в папке Downloads. OSX автоматически откроет zip-файл в данное месторасположение.
Перенесите библиотеку в папку Libraries.
Устанавливаем библиотеки Arduino для Linux
Закройте Arduino IDE. Скачайте zip-файл с репозитория.
Сохраните zip-файл в удобном для вас месте.
Откройте файл и распакуйте (Extract) содержимое в папку Sketchbook/Libraries.
При необходимости дайте библиотеке понятное имя без дефисов и прочих лишних символов. Перезапустите IDE и откройте один из примеров.
Его компиляция без ошибок будет означать правильность установки библиотеки.
Распространенные проблемы, связанные с библиотеками Arduino
"xxxx" does not name a type
Это наиболее частая ошибка, и связана она с тем, что компилятор не может найти библиотеку. Это может быть по следующим причинам: библиотека не установлена, неправильное расположение папки, неправильное наименование папки, неправильное наименование библиотеки, зависимости библиотеки, не перезапущена среда Arduino IDE.
Неправильное расположение папки
IDE ищет библиотеки только в папке стандартных библиотек и папке пользовательских библиотек. Библиотеки, расположенные в других местах, просто недоступны для поиска. Также библиотеку нельзя организовывать как подкаталог внутри другого каталога.
Неправильное наименование папки
Как ранее было указано, IDE не поймет названия, содержащие в себе символ ‘-‘. Обычно его заменяют на ‘_’.
Неправильное наименование библиотеки
Наименование, идущее после #include в вашей программе, должно полностью соответствовать имени библиотеки.
Неполная библиотека
Еще одной причиной, по которой библиотека может не заработать, является неполное ее скачивание с репозитория. Нужно скачивать все предлагаемые файлы и папки.
Несколько версий
Если у вас есть несколько версий библиотеки, то IDE попытается загрузить их все. Это вызовет ошибки при компиляции. Недостаточно просто переименовать библиотеки, лишние нужно убрать за пределы папки Libraries.
Зависимости библиотеки
Некоторые библиотеки зависят от других библиотек, поэтому нужно следить за тем, чтобы все необходимые библиотеки были запущены.
Многие скетчи (программы) работают с библиотеками. Библиотека облегчает работу с определённым модулем или одним из типов модулей. Например, если Вы хотите вывести текст на LCD дисплей без подключения библиотеки, то Вам нужно передать ему несколько байт команд и данных, что займет несколько строк кода, а главное, что Вам нужно знать тип микроконтроллера под управлением которого работает LCD дисплей, назначение команд которыми он управляется, знать архитектуру его памяти, адреса и назначение регистров, для чего потребуется найти и перечитать его datasheet. В то время как при написании кода с использованием библиотеки (например LiquidCrystal_I2C.h) Вы сможете вывести текст на дисплей вызвав всего одну функцию библиотеки: lcd.print("my text");
Перед тем как начать пользоваться методами и функциями библиотеки, её нужно скачать (загрузить на Ваш компьютер), установить (разместить в нужной папке) и подключить (вставить текст "#include <файл.h>" в скетч).
Скачивание библиотеки:
Если в наших уроках, описаниях или примерах используется библиотека, то мы указываем ссылку на скачивание этой библиотеки. Все наши библиотеки находятся в zip архиве, но не спешите доставать файлы из архива, это может не понадобиться, т.к. Arduino IDE сама может распаковывать архивы и размещать библиотеки в нужных папках (см. дальше).
Если Вы скачали архив библиотеки с сайта не указывая путь для сохранения файла, то скаченный (загруженный) Вами файл скорее всего находится в папке: Этот компьютер > Загрузки.
Установка библиотеки:
После того как Вы скачали (загрузили) библиотеку на свой компьютер, её нужно установить. Установить библиотеку можно вручную или сделать это средствами Arduino IDE:
Установка библиотеки средствами Arduino IDE:
Войдите в меню: Скетч > Подключить библиотеку > Добавить.ZIP библиотеку... .
В появившемся окне нажмите на иконку «Этот компьютер » и выберите папку «Загрузки ». Если при скачивании ZIP архива с сайта, Вы указывали путь для сохранения файла, то вместо папки «Загрузки» укажите путь к файлу.
Выберите ZIP файл библиотеки, который Вы скачали. Название файла может не соответствовать названию библиотеки. После чего нажмите на кнопку «Открыть » (Open ).
На этом установка библиотеки завершена, можно приступить к её подключению в скетч.
Установка библиотеки вручную:
Распакуйте скаченный Вами ZIP архив и поместите папку (имя папки обычно совпадает с названием библиотеки) из данного архива в папку: Этот компьютер > Документы > Arduino > libraries .
Если во время копирования Arduino IDE была запущена (открыта), то нужно закрыть все окна этой программы, после чего запустить (открыть) Arduino IDE и можно приступать к подключению библиотеки в скетч.
Примечание: папка libraries есть не только по указанному выше пути, но и в папке программы Arduino IDE (где находится файл arduino.exe). Скопировав библиотеку в эту папку, она тоже установится, но Мы не рекомендуем это делать. Дело в том, что программа Arduino IDE постоянно развивается и количество её версий постоянно растёт. Если Вы захотите установить новую версию Arduino IDE, то библиотеки находящиеся в папке Этот компьютер > Документы > Arduino > libraries, будут доступны и в старой, и в новой (установленной) версии Arduino IDE, а библиотеки находящиеся в папке libraries программы Arduino IDE старой версии (которая была установлена ранее) будут доступны только в ней (пока Вы их не скопируете в новую).
Подключение библиотеки:
Для того чтобы подключить библиотеку, нужно написать всего одну строку в начале скетча: "#include <файл.h>", например:
#include
Некоторые библиотеки работают используя методы и функции других библиотек, тогда нужно подключать две библиотеки, сначала подключается та, методы и функции которой использует вторая, например:
#include
Для работы с большинством библиотек, нужно создать объект (экземпляр класса библиотеки), через который будут доступны их функции и методы, например:
LiquidCrystal_I2C lcd(0x27,20,4); // lcd это объект библиотеки LiquidCrystal_I2C // через объект обращаются к функциям и методам библиотеки
Вместо lcd можно написать любое слово или сочетание букв и цифр, это название объекта через который можно обращаться к методам и функциям библиотеки. Если Вместо lcd Вы написали myLCD, то и ко всем методам и функциям библиотеки LiquidCrystal_I2C, нужно обращаться через указанное Вами имя объекта, например: myLCD.print("my text");
Примеры из библиотек:
Большинство библиотек содержат примеры. Это небольшие скетчи (программы) которые раскрывают функционал библиотеки. Наиболее удобный способ просмотра примеров, с помощью средств Arduino IDE. Выберите пункт меню: Файл > Примеры , откроется список с названиями библиотек у которых есть примеры. Наведите курсор на название библиотеки и Вы увидите список примеров содержащихся в ней, клик на примере приведёт к появлению нового окна Arduino IDE со скетчем примера.
Альтернативный способ просмотра примеров заключается в запуске файлов скетчей из папки:
путь
> libraries
> название библиотеки
> examples
> название примера
.
Поиск библиотек:
Библиотеки можно искать самостоятельно, а можно воспользоваться функционалом Arduino IDE.
Выберите пункт меню: Скетч > Подключить библиотеку > Управлять библиотеками... .
Откроется «Менеджер библиотек », в котором можно найти интересующую Вас библиотеку введя её название в строку поиска, дополнительно можно установить пункты «Тип» и «Тема».
Нажатие на описании библиотеки приведёт к появлению вкладки «Версия » и кнопки «Установка ». После нажатия на кнопку «Установка» можно приступать к подключению библиотеки в скетч "#include <файл.h>".
Библиотеки для 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 надо перезагрузить.
Оставляйте Ваши комментарии, вопросы и делитесь личным опытом ниже. В дискуссии часто рождаются новые идеи и проекты!