Как подключить библиотеку в ардуино: Установка и подключение библиотек Arduino

keywords.txt состоит из четырех полей, разделенных одной настоящей табуляцией (не пробелами):

  KEYWORD KEYWORD_TOKENTYPE REFERENCE_LINK RSYNTAXTEXTAREA_TOKENTYPE
  

Поле можно оставлять пустым.

KEYWORD_TOKENTYPE	Используйте для	Свойство темы
KEYWORD1	типов данных	редактор.data_type.style
KEYWORD2	функций	editor.function.style
KEYWORD3	строений	editor.function.style
ЛИТЕРАЛЬНЫЙ1	константы	editor.reserved_word_2.style
ЛИТЕРАЛЬНЫЙ2	?	редактор.function. style

В этом поле указывается страница справочника по языку Arduino, открываемая через Arduino. Щелкните правой кнопкой мыши IDE > Найти в ссылке или Справка > Найти в ссылке , когда курсор находится на этом ключевом слове. В целом нет смысла определять поле REFERENCE_LINK для ключевых слов сторонней библиотеки, поскольку они вряд ли быть в Справочнике по языку Arduino.

В среде Arduino IDE 1.6.5 и новее это поле переопределяет KEYWORD_TOKENTYPE . В предыдущих версиях IDE RSYNTAXTEXTAREA_TOKENTYPE Поле игнорируется, вместо него используется KEYWORD_TOKENTYPE .

RSYNTAXTEXTAREA_TOKENTYPE	Свойство темы	Эквивалент KEYWORD_TOKENTYPE
RESERVED_WORD	editor. reserved_word.style	KEYWORD3
RESERVED_WORD_2	редактор.reserved_word_2.style	ЛИТЕРАЛЬНЫЙ1
DATA_TYPE	editor.data_type.style	KEYWORD1
ПРЕДПРОЦЕССОР	editor.preprocessor.style	KEYWORD3
LITERAL_BOOLEAN	editor.literal_boolean.style	ЛИТЕРАЛЬНЫЙ1

Файл флага разработки

Обычно среда Arduino IDE обрабатывает содержимое папки библиотеки как доступное только для чтения.Это сделано для того, чтобы пользователи не случайно модифицируя примеры эскизов. В процессе разработки библиотеки вы можете захотеть отредактировать примеры эскизов в разместить с помощью Arduino IDE. В Arduino IDE 1.6.6 и новее режим только для чтения можно отключить, добавив файл с именем .development в корень папки библиотеки. Файл library.properties должен также присутствовать. Индексатор Менеджера библиотек не будет выбирайте выпуски, содержащие файл .development, поэтому не помещайте этот файл в удаленный репозиторий.

Полный пример

Гипотетическая библиотека под названием «Сервопривод», соответствующая спецификации:

  Сервопривод /
Серво / library.properties
Серво / ключевые слова.txt
Серво / SRC /
Серво / src / Servo.h
Серво / SRC / Servo.cpp
Servo / src / ServoTimers.h
Сервопривод / примеры /
Сервопривод / примеры / Sweep / Sweep.ino
Сервопривод / примеры / Pot / Pot.ino
Сервопривод / дополнительные функции /
Серво / дополнительные функции / Servo_Connectors.pdf
  

Работа с несколькими архитектурами

Библиотеки, помещенные в подпапку библиотек папки скетчей (также известную как «каталог пользователя»), будут доступны для все платы, которые могут включать несколько процессоров различной архитектуры. Предоставить архитектурно-зависимый код или оптимизации, авторы библиотеки могут использовать макрос препроцессора ARDUINO_ARCH_XXX ( #define ), где XXX – имя архитектура (как определено названием папка архитектуры платформы платы). Например, ARDUINO_ARCH_AVR будет определен при компиляции для плат на базе AVR.

Пример:

  # если определено (ARDUINO_ARCH_AVR)
  // Код, специфичный для AVR
#elif defined (ARDUINO_ARCH_SAM)
  // Специальный код SAM
#еще
  // общий, не зависящий от платформы код
#endif
  

В качестве альтернативы, если библиотека работает только на определенных архитектурах, вы можете предоставить явное сообщение об ошибке (вместо допустив сбой компиляции трудным для понимания образом):

  # если определено (ARDUINO_ARCH_AVR)
  // Код, специфичный для AVR
#elif defined (ARDUINO_ARCH_SAM)
  // Специальный код SAM
#еще
  #error «Эта библиотека поддерживает только платы с процессором AVR или SAM. ”
#endif
  

Старый формат библиотеки (до 1.5)

Для поддержки старых библиотек (из Arduino IDE 1.0.x), Arduino IDE / Pro IDE и Arduino CLI также будут компилироваться. библиотеки, в которых отсутствует файл метаданных library.properties. В результате эти библиотеки должны вести себя так же, как в Arduino. IDE 1.0.x, хотя они будут доступны для всех плат, включая платы без AVR (которых не было в Arduino IDE 1.0.x).

Установка ESP32 в Arduino IDE (Windows, Mac OS X, Linux)

Существует надстройка для Arduino IDE, которая позволяет вам программировать ESP32 с помощью Arduino IDE и ее языка программирования.В этом руководстве мы покажем вам, как установить плату ESP32 в Arduino IDE, независимо от того, используете ли вы Windows, Mac OS X или Linux.

Посмотреть видеоурок

Это руководство доступно в видеоформате (смотрите ниже) и в письменном формате (продолжайте читать эту страницу).

Если у вас возникнут проблемы во время процедуры установки, ознакомьтесь с Руководством по поиску и устранению неисправностей ESP32.

Если вам нравится ESP32, запишитесь на наш курс: Изучите ESP32 с Arduino IDE.

Предварительные требования: установлена ​​Arduino IDE

Перед тем, как начать эту процедуру установки, убедитесь, что на вашем компьютере установлена ​​последняя версия Arduino IDE. Если вы этого не сделаете, удалите его и установите снова. В противном случае это может не сработать.

Имея последнюю версию программного обеспечения Arduino IDE, установленную с arduino.cc/en/Main/Software, продолжайте изучение этого руководства.

Вам нужна плата ESP32? Купить можно здесь.

Установка надстройки ESP32 в Arduino IDE

Чтобы установить плату ESP32 в IDE Arduino, выполните следующие инструкции:

1. В вашей Arduino IDE перейдите к File > Preferences

2. Введите https: // dl. espressif.com/dl/package_esp32_index.json в поле «Дополнительные URL-адреса Board Manager», как показано на рисунке ниже. Затем нажмите кнопку «ОК»:

   Примечание: , если у вас уже есть URL-адрес платы ESP8266, вы можете разделить URL-адреса запятой следующим образом:

    https://dl.espressif.com/dl/package_esp32_index .json, http://arduino.esp8266.com/stable/package_esp8266com_index.json 

3. Откройте диспетчер плат. Перейдите к Tools > Board > Boards Manager…

4. Найдите ESP32 и нажмите кнопку установки для « ESP32 by Espressif Systems »:

5. Вот и все.Его следует установить через несколько секунд.

Тестирование установки

Подключите плату ESP32 к компьютеру. Открыв Arduino IDE, выполните следующие действия:

1. Выберите свою плату в меню Tools > Board (в моем случае это DOIT ESP32 DEVKIT V1 )

2. Выберите порт (если вы не видите COM-порт в вашей Arduino IDE, вам необходимо установить драйверы CP210x USB для UART Bridge VCP):

3.Откройте следующий пример в разделе Файл > Примеры > WiFi (ESP32) > WiFiScan

4. В вашей Arduino IDE откроется новый скетч:

5. Нажмите кнопку Загрузить в среде Arduino IDE. Подождите несколько секунд, пока код компилируется и загружается на вашу доску.

6. Если все прошло, как ожидалось, вы должны увидеть сообщение « Готово, загрузка. ”сообщение.

7. Откройте монитор последовательного порта Arduino IDE со скоростью 115200:

8.Нажмите кнопку ESP32 на плате Включить , и вы должны увидеть сети, доступные рядом с вашим ESP32:

Поиск и устранение неисправностей

Если вы попытаетесь загрузить новый скетч в ESP32 и получите сообщение об ошибке « Произошла фатальная ошибка: Не удалось подключиться к ESP32: Истекло время ожидания… Подключение… ». Это означает, что ваш ESP32 не находится в режиме прошивки / загрузки.

После выбора правильного имени платы и порта COM выполните следующие действия:

• Удерживайте кнопку « BOOT » на плате ESP32

• Нажмите кнопку « Загрузить » в Arduino IDE, чтобы загрузить свой скетч:

• После того, как вы увидите « Подключение…. »в Arduino IDE, уберите палец с кнопки« BOOT »:

• После этого вы должны увидеть сообщение « Готово, загрузка »

Вот и все. На вашем ESP32 должен быть запущен новый скетч. Нажмите кнопку « ENABLE », чтобы перезапустить ESP32 и запустить новый загруженный скетч.

Вам также придется повторять эту последовательность кнопок каждый раз, когда вы хотите загрузить новый эскиз. Но если вы хотите решить эту проблему раз и навсегда без необходимости нажимать кнопку BOOT , следуйте рекомендациям в следующем руководстве:

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

Заключение

Это краткое руководство, которое показывает, как подготовить вашу Arduino IDE для ESP32 на ПК с Windows, Mac OS X или Linux. Если у вас возникнут какие-либо проблемы во время процедуры установки, ознакомьтесь с руководством по устранению неполадок ESP32.

Теперь вы можете начать создавать свои собственные проекты Интернета вещей с помощью ESP32!

Спасибо за чтение.

Arduino – JavaTpoint

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

Библиотеки в Arduino написаны на C или C ++ (.cpp). Эти библиотеки позволяют нам манипулировать данными и работать с оборудованием.

Чтобы реализовать любую библиотеку в Arduino IDE, перейдите в Sketch -> Import Library .

Для загрузки доступно несколько библиотек. Мы также можем создать свою собственную библиотеку.

Давайте обсудим некоторые библиотеки.

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

Стандартные библиотеки перечислены ниже:

EEPROM

Это означает Электронная стираемая программируемая память только для чтения . EEPROM связан с микроконтроллером, присутствующим на платах AVR или Arduino. Библиотека EEPROM позволяет нам читать байты, хранящиеся в памяти, когда питание платы выключено.

Размер EEPROM различается на разных платах, например, 1 КБ или 1024 байта на ATmega328P. Он также может иметь размер 4 КБ или 4096 байт на микроконтроллере ATmega2560 и т. Д.

Библиотека объявлена ​​как:

#include

Например, чтение EEPROM, очистка EEPROM, запись EEPROM, получение EEPROM, обновление EEPROM, установка EEPROM, итерация EEPROM и т. Д.

Библиотека Ethernet

Библиотека Ethernet работает с платой Arduino Ethernet Shield и другими связанными устройствами. Библиотека Ethernet позволяет нам подключить плату Arduino к Интернету.

Шина SPI действует как промежуточное звено между платой и экраном.

Соответствующая библиотека:

#include #include

Например, TelnetClient, WebServer, WebClientRepeating, WebClient, ChatServer, DnsWebClient, UdpNtpClient, UdpSendReceiveString, и т. Д.

Библиотека фирм

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

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

Соответствующая библиотека:

#include

Библиотека GSM

Библиотека GSM существует в среде IDE версии 1.0.4 и выше.

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

Библиотека объявлена ​​как:

#include h>

Библиотека жидких кристаллов

Это библиотека, которая позволяет Arduino обмениваться данными с ЖК-дисплеями, основанными на совместимом чипсете Hitachi HD44780.Такие наборы микросхем встречаются на большинстве типов текстовых ЖК-дисплеев. Он работает в 8-битном или 4-битном режиме. Здесь битовый режим обозначает строки данных в дополнение к линиям управления enable, rs и rw (необязательно).

Библиотека объявлена ​​как:

#include

Примеры: Hello World, Cursor, Blink, и т. Д.

SD-библиотека

Позволяет записывать или читать с SD-карт. Например, Arduino Ethernet Shield.Имена файлов включают пути, разделенные косой чертой, которые передаются в библиотеку SD. Но SPI используется для связи между SD-картой и Arduino.

Библиотека объявлена ​​как:

#include #include

Примеры: файлы дампа, файлы списка, чтение и запись и т. Д.

Сервобиблиотека

Библиотека сервопривода позволяет Arduino работать с серводвигателями. Он позволяет управлять интегрированным валом и шестернями.Мы также можем расположить вал под разными углами от 0 до 180 градусов. Библиотека сервоприводов на платах Arduino может поддерживать до 12 двигателей, а на плате Arduino Mega она может поддерживать до 48 двигателей.

Библиотека объявлена ​​как:

#include

Библиотека SPI

SPI ( Serial Peripheral Interface ) – это протокол последовательной передачи данных. Микроконтроллеры используют последовательный протокол для быстрой связи на небольших расстояниях с одним или несколькими периферийными устройствами.

Требуемое соединение SPI является полнодуплексным, что позволяет устройствам одновременно отправлять и получать данные.

Библиотека объявлена ​​как:

#include

Примеры: файлы дампа, файлы списка, чтение и запись и т. Д.

Библиотека шагового двигателя

Библиотека Stepper в Arduino позволяет управлять биполярными или униполярными шаговыми двигателями.

Библиотека объявлена ​​как:

#include <Степпер.h>

Шаговый двигатель включает шаговое управление скоростью, шаговый двигатель на один оборот и т. Д.

Программная последовательная библиотека

Программная последовательная библиотека обеспечивает последовательную связь через цифровые входы / выходы. Контакты 0 и 1 встроены в Arduino для последовательного интерфейса. Мы можем включить в наш код несколько последовательных портов, которые могут работать со скоростью до 115200 бит / с (бит в секунду).

Библиотека объявлена ​​как:

#include

Библиотека TFT LCD

Библиотека TFT LCD включена в версию IDE 1.0.5 и выше. Это позволяет Arduino взаимодействовать с ЖК-экраном TFT. Кроме того, он помогает рисовать изображения, фигуры, линии и текст на экране.

Слот для SD-карты, присутствующий на встроенном экране, можно использовать для реализации библиотеки SD.

Библиотека TFT для связи зависит от библиотеки SPI с SD-картой и экраном.

Библиотека объявлена ​​как:

#include #include

Библиотека WiFi

Библиотека WiFi позволяет Arduino устанавливать соединение с Интернетом. Это может быть сервер для приема входящих подключений или клиент для исходящих подключений.

Персональное шифрование, поддерживаемое библиотекой WiFi, – это WPA2 и WEP, за исключением WPA2 Enterprise. Arduino использует шину SPI для связи с экраном WiFi.

Библиотека объявлена ​​как:

# включить

Примеры включают WiFiWebClient, WiFiWebServer и т. Д.

Аудиотека

Аудиотека совместима только с платой Arduino Due. Это позволяет плате воспроизводить файлы .wav с определенных устройств хранения, таких как SD-карта.

Он воспроизводит звуки, используя контакты DAC0 и DAC1.

Библиотека объявлена ​​как:

#include

Примером является простой аудиоплеер.

Аудио нулевая библиотека

Он позволяет плате (Arduino Zero, MKR1000 и MKRZero) воспроизводить. wav файлы с устройств хранения, таких как SD-карта.

Arduino Zero и MKR1000 воспроизводит звук с помощью вывода DAC0.

Библиотека объявлена ​​как:

#include

Примером является простой нулевой аудиоплеер.

Звуковая библиотека Arduino

Звуковая библиотека Arduino позволяет плате анализировать и воспроизводить аудиоданные, которые предоставляются Arduino на плате на базе SAMD21 с использованием шины I2S. Платы на базе SAMD21 – это Arduino Zero, MKR1000, MKRZero или Genuino Zero.

Библиотека объявлена ​​как:

#include

Примеры включают WavePlayBack, ClapDetector, WhistleDetector и т. Д.

Теперь давайте обсудим процесс установки библиотеки в Arduino.

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

Шаги перечислены ниже:

Менеджер библиотек Arduino

• Нам нужно открыть диспетчер библиотек, чтобы установить новую библиотеку в Arduino. Нажмите Sketch -> Include Library -> Manage Libraries , как показано ниже:

• Появится диалоговое окно с различными библиотеками, как показано ниже:

• Появится список библиотек, готовых к установке.Нам нужно выбрать конкретную библиотеку -> выбрать версию -> нажать кнопку Установить , как показано ниже:

Иногда для загрузки доступна только одна версия. В таком случае выпадающий список версии не появится. Значит, это нормально.

Нам нужно дождаться загрузки библиотеки. Скачивание будет зависеть от скорости соединения.

Метка INSTALLED появится перед библиотекой, которая уже установлена ​​на нашем компьютере.

Импорт библиотеки .zip

Если мы хотим добавить нашу собственную библиотеку, мы можем выбрать нужную папку на нашем компьютере. Конкретный zip-файл, содержащий библиотеку, можно импортировать в Arduino.

Показано ниже:

Мы также можем перепроверить с помощью опции Sketch -> Include library , чтобы увидеть, присутствуют ли добавленные библиотеки в списке или нет.

Распаковывать загруженную библиотеку не требуется. Файл останется в формате.zip формат.

Мы можем загрузить сторонние библиотеки, начиная с Arduino IDE версии 1.0.5.

Что нужно для написания хорошей библиотеки Arduino?

Написать приличную библиотеку непросто. Мнения разработчиков о том, как должна выглядеть такая библиотека, разнятся. Я думаю, что у надежной библиотеки должна быть подробная документация, а разработчики должны покрывать ее модульными тестами. Кроме того, достойная библиотека должна скрывать сложность и предлагать интуитивно понятный и простой в использовании интерфейс.

Большую часть времени я занимался разработкой программного обеспечения, работая над крупными проектами. Мы создали их на надежных фреймворках и в большинстве случаев также написали соответствующие модульные и интеграционные тесты. Я считаю, что хорошо написанные тесты могут сэкономить ваше время, которое вы в конечном итоге потратите на отладку и другие действия.

Я получил свой комплект Arduino около полутора лет назад и очень быстро понял структуру. Создатели создали Arduino для любителей и программистов-самоучок. С одной стороны, это привлекает к электронике большое сообщество людей; с другой стороны, качество публикуемого кода сильно различается.Когда мне нужна была библиотека для моих проектов Arduino, я часто проверял код на GitHub, который часто не поддерживался. Поддерживаемые библиотеки часто не имели надлежащей документации. У большинства из них не было модульных тестов.

Зачем вам тестировать свой код? Посмотрите следующее видео.

В 1996 году первый полет ракеты-носителя Ariane 5 закончился масштабной катастрофой, вызванной ошибкой программирования. Прочтите полную историю здесь.

Arduino не такая уж критичная и дорогая, но я все же считаю, что написание тестов того стоит.Обратной стороной является то, что на разработку требуется дополнительное время. Я бы сказал, что каждый проект индивидуален, и вам нужно решить, стоит ли тратить время на написание тестов. На мой взгляд, тесты принесут вам большую пользу, если вы реализуете какой-то конечный автомат. Это повсеместно в Arduino, и тесты позволяют с уверенностью изменять код. Кроме того, библиотеки Arduino обычно крошечные, всего сотни строк кода по сравнению с тысячами строк в приложениях Android или где-либо еще. Чтобы тщательно протестировать свою библиотеку, вам часто нужно написать менее 10 тестовых примеров.Например, я смог написать модульные тесты для библиотеки реле менее чем за три часа, и я все еще учился использовать среду тестирования.

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

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

Для обнаружения лопаточных прессов я изначально использовал библиотеку OneButton Arduino. Однако он не очень хорошо интегрировался с моей существующей базой кода, а также не транслировал такие события, что была отпущена какая-то кнопка. Подобные события очень важны для меня, потому что мне нужно знать, что какое-то действие произошло мгновенно. Задержка от 50 до 100 миллисекунд сильно влияет на задержку. В конце концов, я решил написать собственную библиотеку.

ObjectButton

ObjectButton – это библиотека Arduino для обнаружения общих действий кнопок при изменении на входных контактах GPIO. Эта библиотека должна легко интегрироваться с объектами C ++, отсюда и название.

Ограничения функции обратного вызова

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

 Копировать 
 1extern "C" {
 
 2 typedef void (* callbackFunction) (void); 
 
 3} 
 

На практике вы регистрируете обратный вызов следующим образом:

 Копия 
 1... 
 
 2 
 
 3void onClick () {
 
 4 Serial.println («Была нажата кнопка»); 
 
 5}; 
 
 6 
 
 7 
 
 8 Кнопка OneButton = OneButton (INPUT_PIN, true); 
 
 9button.attachClick (onClick); 
 

Следующий подход отлично подходит для регистрации функций типа C, но не для функций-членов объекта C ++. Это потому, что все функции-члены имеют неявный (первый) параметр – , это .

Чтобы обойти ограничение, вы можете:

• Передать адрес статической функции-члена, которая будет вызывать функцию-член, запущенную на конкретном объекте.
• Создать некоторую функцию C вне любого объекта, которая будет вызывать функцию-член. на объекте

 Копия 
 1... 
 
 Контроллер 2LedController = LedController (); 
 
 3 
 
 4void onClick () {
 
 5 controller.turnLedOn (); 
 
 6}; 
 

Примечание. Лямбда / анонимные функции, насколько мне известно, недоступны в Arduino. Arduino не полностью поддерживает стандарт C ++.

Listeners

Вместо передачи ссылки на функцию обратного вызова ObjectButton представляет Listeners . Такой подход широко используется в Android.Мы определяем слушателя как абстрактный класс. Слушатель определяет контракт между нашей библиотекой и кодом, написанным пользователем.

Например, слушатель для получения событий onClick определяется следующим образом:

 Копировать 
 1class IOnClickListener {
 
 2public: 
 
 3 virtual ~ IOnClickListener () = default; 
 
 4 
 
 5 виртуальная пустота onClick (ObjectButton & button) = 0; 
 
 6}; 
 

Пользователь пишет класс C ++, который наследуется от этого абстрактного класса.Вам необходимо реализовать все виртуальные функции. Когда вы регистрируете такой класс в библиотеке, внутренний код в библиотеке может безопасно вызывать функцию onClick (...) .

 Копировать 
 1 # include  
 
 2 # include  
 
 3 
 
 4class OnClickListener: частный виртуальный IOnClickListener {
 
 = 5public: 
 
 6 OnClickListener (по умолчанию) 
 
 7 .... 
 
 8 
 
 9private: 
 
 10 void onClick (ObjectButton & button) override; 
 
 11... 
 
 12}; 
 
 13 
 
 14void OnClickListener :: onClick (ObjectButton & button) {
 
 15 
 
 16} 
 

Вы зарегистрируете слушателя в библиотеке следующим образом:

 Copy 
 1 
 9000ton4 2ObjectButton (кнопка = ObjectButton .); 
 
 3 
 
 4OnClickListener onClickListener = OnClickListener (); 
 
 5button.setOnClickListener (onClickListener); 
 

Как структурировать код

Когда вы пишете свою собственную библиотеку Arduino, это совершенно новый опыт по сравнению с написанием обычного проекта Arduino.На этот раз вы, , напишите код, который кто-то другой использует в своем проекте. В библиотеке нет функций setup () и loop () , которые нужно реализовать. Arduino дает вам рекомендации о том, как структурировать код. Некоторые из них являются обязательными, другие – необязательными, но рекомендуются. Ваша цель должна заключаться в том, чтобы сделать вашу библиотеку простой в использовании для всех, даже для новичков. Например, убедитесь, что у вас есть какая-то функция begin () , которая инициализирует ваш код. Вы часто видите этот паттерн в Arduino.

Предположим следующее о ваших пользователях:

• Они могут не иметь опыта программирования
• Они не понимают указатели
• Они не понимают, что такое конструктор и деструктор
• Они знакомы с begin () и end () функций из других библиотек
• Они ожидают, что имена функций будут camelCase, то есть getPressure ()

Одна из ваших основных целей должна заключаться в том, чтобы скрыть всю сложность и предоставить множество примеров использования вашей библиотеки .Arduino предоставляет несколько справочных руководств; вы должны хотя бы проверить это:

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

Цели для достижения

Как видите, охват модульных тестов и документация – это лишь некоторые из целей, которые необходимо достичь.

Абстракция высокого уровня

Когда вы пытаетесь придумать достойный дизайн библиотеки, начните с ручки и бумаги. В качестве вдохновения посмотрите официальные библиотеки Arduino.Все они хорошо написаны. Я кратко упомяну библиотеку Servo. Представьте, что вы хотите управлять сервоприводом. Какие функции вы хотели бы иметь? Возможно, вам понадобится какая-то функция, чтобы указать выходной контакт, к которому вы подключаете сервопривод. Вам также понадобится функция, которая сообщает серво, на сколько он должен повернуться, и функция, которая сообщает текущее положение вашего сервопривода. И это почти все, что вам нужно как пользователю. Вы не беспокоите пользователей подробностями реализации; все они скрыты.

В моем случае я хотел предоставить способ регистрации обратных вызовов, способ настройки интервала противодействия и способ настройки значений тайм-аута, используемых для обнаружения событий щелчка, двойного щелчка и длительного нажатия. В большинстве случаев пользователи просто регистрируют обратный вызов и не заботятся обо всех значениях по умолчанию, но рекомендуется дать пользователям возможность настроить поведение. Однако не раскрывайте все ценности. Вместо этого подумайте о сценариях использования и решите, что имеет смысл раскрывать. Как правило, после принятия дизайнерских решений моя библиотека инициализируется 1 или 2 строками кода.Идеально! Не стесняйтесь проверить примеры того, как использовать библиотеку.

Еще одна вещь, о которой вам нужно подумать, – это структурировать код в отношении тестирования. Когда вы пишете код, постарайтесь продумать, как его протестировать. Как правило, вам следует избегать одного большого занятия. Вместо этого разбейте свой код на несколько более мелких классов. Позже вы можете протестировать их отдельно от остальной системы. Их функции должны делать только одно, а их имя должно подсказывать вам, что они должны делать, не читая документацию.В нормальных условиях эти функции короткие – менее десяти строк кода. Код, реализующий конечный автомат, обычно огромен. Однако вы можете перенести большую часть функциональности во вспомогательные функции. Когда вы это сделаете, ваш конечный автомат предоставит высокоуровневую картину того, что он делает. Вот пример из моего кода для уведомления слушателей о возникновении события клика.

Вместо этого кода:

 Скопируйте 
 1if (timeDelta> m_clickTicks) {
 
 2 m_state = State :: BUTTON_NOT_PRESSED; 
 
 3 если (m_onClickListener! = Nullptr) 
 
 4 m_onClickListener-> onClick (* this); 
 
 5} 
 

Вы перемещаете логику в другую функцию, например:

 Копировать 
 1if (timeDelta> m_clickTicks) {
 
 2 m_state = State :: BUTTON_NOT_PRESSED; 
 
 3 notifyOnClick (); 
 
 4} 
 
 5 
 
 6 
 
 7void ObjectButton :: notifyOnClick () {
 
 8 if (m_onClickListener! = Nullptr) 
 
 9 m_onClickListener-> onClick (* this); 
 
 10} 
 

Если вы посмотрите на отредактированный код, вы с первого взгляда увидите, что он делает.В коде конечного автомата может быть много предложений if ... else ; все, что делает его более читаемым, – хорошо. Кроме того, теперь вы можете писать тесты в ObjectButton :: notifyOnClick () , что намного проще, чем писать тесты, которые проверяют тот же код в коде основного конечного автомата.

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

Документация

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

Есть два подхода:

• Напишите документацию к вашему коду отдельно. Взгляните на библиотеку Sphinx, чтобы увидеть примеры. Sphinx использует reStructuredText в качестве языка разметки.
• Напишите документацию внутри вашего кода. Такой подход широко используется в мире Java и его генераторе документации Javadoc.

Я предлагаю объединить оба подхода. Начните с документирования того, что делает ваша библиотека. Включите блок-схемы, диаграммы и все, что вам может быть полезно. Markdown отлично подходит для этой цели. Более того, вы можете поместить свои документы в то же хранилище, что и ваш основной код. Например, вы можете создать папку docs для хранения этих документов. Если вы используете GitHub или GitLab, вы можете сохранять документы внутри Wiki. Технически это отдельный репозиторий git, но он привязан к вашему проекту и легко доступен.

После того, как вы написали общий обзор библиотеки, пора писать комментарии внутри вашего кода. Я решил использовать Doxygen: это стандарт де-факто, и его легко настроить. Кроме того, он поддерживает несколько стилей комментариев, включая стиль Javadoc.

Doxygen

Если вы хотите создать документацию Doxygen, вам нужно создать Doxyfile. Это шаблон для Doxygen с различными настройками, например, названием вашего проекта, расположением исходного кода и т. Д.Мне посчастливилось найти Doxyfile, который кто-то адаптировал для Arduino. Одной из важнейших настроек было включение файлов * .ino . Doxygen обычно не знает, что эти файлы содержат действительный код C / C ++. Если вам когда-нибудь понадобится этот шаблон, просто возьмите мой и измените имя и путь к проекту.

Если вы хотите узнать подробности о том, как добавлять комментарии в код, лучше всего проверить веб-страницу Doxygen.

Вот пример комментария внутри кода:

 Копировать 
 1 
 
 2 
 
 3 
 
 4 
 
 5 
 
 6 
 
 7IOnClickListener * m_onClickListener = nullptr; 
 
 8 
 
 9 
 
 10 
 
 11 
 
 12 
 
 13 
 
 14 
 
 15IOnDoubleClickListener * m_onDoubleClickListener = nullptr; 
 

Комментарий Javadoc начинается с / ** , который по-прежнему является действительным комментарием C ++.Альтернативный синтаксис выглядит так: /// . Также обратите внимание на такие флаги, как @see . Это поможет вам создавать гиперссылки на другие классы и функции.

После того, как вы задокументировали свой код, создать документацию очень просто. В вашем Doxyfile есть вся информация.

 Копировать 
 1doxygen <путь к doxyfile> 
 

Вы можете разместить сгенерированную документацию где угодно. Это статическая HTML-страница без внешних зависимостей. Я размещаю документацию на страницах GitHub бесплатно.Для вдохновения сгенерированная документация для одного из моих проектов находится здесь.

keywords.txt

Отлично, теперь у вас есть достойная документация. Ваша библиотека сейчас в лучшем состоянии, чем, может быть, 80 процентов библиотек. В качестве следующего шага создайте файл keywords.txt . Arduino IDE имеет минимальные возможности подсветки синтаксиса. Следовательно, нам нужно записать все функции, классы и переменные в этот файл и назначить правильный тип. Код будет выделен только тогда, когда IDE Arduino сопоставит ключевое слово с вашим определением.Создание файла keywords.txt является обязательным, если вы хотите, чтобы ваша библиотека была включена в официальный реестр библиотек Arduino.

 Копировать 
 1 #################################### 
 
 2 # Типы данных ( KEYWORD1) 
 
 3 #################################### 
 
 4 
 
 5IOnClickListener KEYWORD1 
 
 6IOnDoubleClickListener KEYWORD1 
 
 7IOnPressListener KEYWORD1 
 
 8 
 
 9 ########################################### #### 
 
 10 # Методы и функции (KEYWORD2) 
 
 11 ################################ ###### 
 
 12 
 
 13getId KEYWORD2 
 
 14setOnClickListener KEYWORD2 
 
 15setOnDoubleClickListener KEYWORD2 
 

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

Примеры

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

Все примеры являются файлами проекта Arduino ( * .ino ), которые вы можете скомпилировать из Arduino IDE. Если вы работали с Arduino, я уверен, что вы более чем знакомы.

Для вдохновения взгляните на примеры из моей библиотеки.

Автоматическое тестирование

Теперь у вас есть библиотека, которая хорошо документирована и предположительно проста в использовании. В качестве следующего шага напишите несколько модульных тестов, чтобы убедиться, что ваш код выполняет то, что он должен делать.Автоматическое тестирование по-прежнему не характерно для библиотек Arduino, и я не удивлен. Если мы посмотрим на другие среды программирования, они часто поставляются с официальной средой тестирования или, по крайней мере, с хорошо известной сторонней средой. В Java и Android это JUnit; Python имеет встроенный модуль unittest, иногда люди также используют pytest; мир C ++ использует Googletest. Arduino не предоставляет официальной среды тестирования, и вы не найдете много статей по этой теме.

Ручное тестирование везде

Большинство разработчиков Arduino тестируют свой код вручную.Когда код в какой-то мере работает, он считается завершенным. Если они сломают код в будущих обновлениях, они могут долго этого не замечать. Не очень хорошая вещь!

Другой вариант использования – проверка того, что ваш код работает на нескольких аппаратных платах. Если вы протестируете его вручную на Arduino Uno, как вы узнаете, что ваша библиотека также работает на Леонардо? Если вы подтвердите свой код вручную на нескольких платформах, вы потеряете время. Если вы не отметите все поддерживаемые платформы, у вас нет гарантии, что код будет работать на всех досках.

Компиляция библиотеки для разных плат

Надеюсь, вы согласитесь, что автоматическая компиляция для нескольких плат имеет смысл. Его легко настроить, и поэтому я думаю, что каждая библиотека Arduino должна это делать!

У вас есть несколько вариантов, как это сделать:

Подход PlatformIO

У проектов PlatformIO всегда есть файл platformio.ini. Здесь вы определяете конфигурацию всего проекта, включая платформы, для которых вы создаете двоичные файлы. Каждая платформа представляет собой отдельную плату Arduino или даже другую архитектуру процессора.

 Копия 
 1; Arduino Uno: первая целевая плата 
 
 2 [env: uno] 
 
 3platform = atmelavr 
 
 4board = uno 
 
 5framework = arduino 
 
 6 
 
 7; Arduino Mega: вторая целевая плата 
 
 8 [env: megaatmega2560] 
 
 9platform = atmelavr 
 
 10board = megaatmega2560 
 
 11framework = arduino 
 

Если вы хотите создать код для нескольких целевых платформ, просто введите следующие команды:

 Копировать 
 1 
 
 2pio run -e uno 
 
 3pio run -e megaatmega2560 
 

Эти команды можно добавить в сценарий оболочки, который можно запускать повторно.Через несколько секунд вы узнаете, что ваш код компилируется или произошла ошибка.

Примеры построения подходов

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

Хотя написание примеров необязательно, в каждой хорошо поддерживаемой библиотеке должен быть хотя бы один. А когда вы это сделаете, подготовка вашего кода для работы со сценариями сборки займет считанные минуты. Я не вижу причин не использовать его!

Написание модульных тестов

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

Я нашел несколько сторонних фреймворков для тестирования для использования с Arduino:

Каждый из этих фреймворков поддерживает запуск тестов на собственных машинах, что означает, что вы можете запускать тесты на обычном ПК без подключенной к нему платы Arduino.Это полезно, особенно если вы хотите настроить непрерывную интеграцию на удаленном сервере.

Для ObjectButton я выбрал ArduinoCI в качестве среды тестирования. Но здесь нельзя сделать неправильный выбор. Просмотрите все варианты и решите, что лучше для вас.

Почему ArduinoCI?

ArduinoCI дает хороший обзор фреймворков для тестирования. Что привлекло мое внимание, так это то, что он поддерживает насмешку над оборудованием Arduino. Представьте, что вы хотите имитировать действие нажатия кнопки. Как это сделать, не нажимая физическую кнопку? Если у вас есть контроль над входными контактами и внутренним таймером, вы можете имитировать жест программно.И это то, что ArduinoCI предоставляет в наше распоряжение.

Кроме того, этот фреймворк компилирует все тесты в собственный код и поддерживает непрерывную интеграцию. Единственное, чего мне не хватает, так это отчетов о покрытии кода.

Test Features

Все ваши тестовые файлы помещаются в папку test . Вы обычно называете их протестированной функцией. ObjectButton должен уметь распознавать три типа различных действий.

Я создал три тестовых файла для их представления и один тестовый файл для проверки основных функций:

• action_click.cpp для запуска всех модульных тестов, связанных с нажатием кнопки
• action_double_click.cpp для запуска модульных тестов, связанных с двойным щелчком
• action_press_release.cpp для запуска модульных тестов, связанных с нажатием кнопки, длительным нажатием и т. д.
• sanity_checks.cpp для проверки таких функций, как getId , чтобы вернуть правильный идентификатор кнопки

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

Написание модульного теста

Давайте проведем тест, который проверяет, правильно ли наша библиотека определяет действие щелчка.

Чтобы написать тест на действие щелчка, сначала нужно понять, что такое щелчок , . Вы когда-нибудь думали об этом? Обычно, когда мы пользуемся вещами, мы не рассуждаем, как именно они работают, но когда мы хотим протестировать действие клика, мы должны определить, что такое клик и как он будет обнаруживаться.Затем мы можем написать тест, чтобы зафиксировать поведение.

Определение: Щелчок – это действие, которое происходит, когда пользователь нажимает кнопку, а затем отпускает ее. Нажатие и отпускание должно произойти до истечения тайм-аута щелчка, а также кнопку нельзя касаться снова в течение этого времени (возможно, это будет действие двойного щелчка).

Теперь, когда мы определили, что такое щелчок, мы можем смоделировать щелчок в нашем тесте:

• Пользователь нажимает кнопку
• Пользователь отпускает кнопку
• Нажатие и отпускание кнопки произошло в течение определенного времени ожидания щелчка

Ниже приведен реальный пример из моего набора тестов:

 Копировать 
 1unittest (receive_on_click_event_after_default_click_ticks) {
 
 2 ListenerMock testMock = ListenerMock (INPUT_PIN, true); 
 
 3 GodmodeState * state = GODMODE (); 
 
 4 
 
 5 
 
 6 state-> digitalPin [INPUT_PIN] = LOW; 
 
 7 testMock.getButton (). Tick (); 
 
 8 
 
 9 
 
 10 состояние-> микросхемы = (DEFAULT_DEBOUNCE_TICKS_MS + 1) * 1000; 
 
 11 testMock.getButton (). Tick (); 
 
 12 
 
 13 
 
 14 состояние-> digitalPin [INPUT_PIN] = HIGH; 
 
 15 состояний-> микросхемы = (DEFAULT_CLICK_TICKS_MS + 1) * 1000; 
 
 16 testMock.getButton (). Tick (); 
 
 17 
 
 18 
 
 19 testMock.getButton (). Tick (); 
 
 20 
 
 21 
 
 22 assertEqual (1, testMock.getPressEventsReceivedCount ()); 
 
 23 assertEqual (1, testMock.getReleaseEventsReceivedCount ()); 
 
 24 assertEqual (1, testMock.getClickEventsReceivedCount ()); 
 
 25 assertEqual (0, testMock.getDoubleClickEventsReceivedCount ()); 
 
 26 assertEqual (0, testMock.getLongPressStartEventsReceivedCount ()); 
 
 27 assertEqual (0, testMock.getLongPressEndEventReceivedCount ()); 
 
 28} 
 

Состояние: пользователь нажал кнопку В этом случае мы считаем кнопку нажатой, когда уровень напряжения на входном контакте равен 0 вольт.Благодаря ArduinoCI мы можем легко смоделировать это:

 Копировать 
 1state-> digitalPin [INPUT_PIN] = LOW; 
 

состояние – это указатель на структуру ArduinoCI, которая управляет «виртуальным» Arduino, выполняющим наш тест.

Итак, мы нажали кнопку, и нам нужно отпустить ее через определенное время. Если бы мы просто изменили напряжение на входном контакте, внутренний таймер все равно вернул бы то же значение – 0. Практически не прошло времени. Чтобы смоделировать время, нам нужно установить микросхемы , т.е.e .:

 Копировать 
 1state-> micros = (DEFAULT_DEBOUNCE_TICKS_MS + 1) * 1000; 
 

Обратите внимание, что вы управляете таймером, задавая время в микросекундах, а не в миллисекундах (как используется функцией millis () ).

Состояние: пользователь отпустил кнопку Пользователь некоторое время удерживает кнопку; пора выпустить его.

 Копировать 
 1state-> digitalPin [INPUT_PIN] = HIGH; 
 
 2state-> micros = (DEFAULT_CLICK_TICKS_MS + 1) * 1000; 
 

Мы только что установили входной контакт на 3.3 вольта, что имитирует отпускание кнопки. При необходимости вы также можете сместить внутренний таймер, чтобы смоделировать реальный сценарий.

Обнаружила ли библиотека действие щелчка? Наш модульный тест точно имитирует действие щелчка. Если наша библиотека работает правильно, она уведомит наш OnClickListener об этом действии. Обычно мы проверяем результаты в конце теста:

 Копировать 
 1assertEqual (1, testMock.getClickEventsReceivedCount ()); 
 

Приведенный выше код проверяет, отправил ли ObjectButton ровно одно уведомление о событии щелчка.Чтобы фиксировать все события, о которых сообщает моя библиотека, я создал вспомогательный слушатель, зарегистрированный для всех событий, поддерживаемых библиотекой. Этот слушатель увеличивает внутренний счетчик каждый раз при получении события. Это показывает, что вы не ограничены только фреймворком, но можете расширить фреймворк в соответствии со своими конкретными потребностями.

Доверие

Почему полезно иметь модульные тесты? Это уверенность в том, что мой код делает то, что должен. Как и в предыдущем тестовом примере, вы пишете другие тесты.Они должны фиксировать ожидаемое поведение – то, что вы указали, что ваша библиотека должна делать – и проверять, что ваша библиотека это делает.

Написание тестов занимает много времени, а их выполнение – нет. Вы можете повторно запустить набор тестов в течение нескольких секунд. Это особенно полезно, когда вы работаете над новой функцией и хотите убедиться, что вы не повлияли на существующие функции, вызвав ошибку. В случае ObjectButton, вся внутренняя логика происходит в конечном автомате. Те из вас, кто реализовал государственную машину, знают, насколько это может быть утомительно.Иногда на первый взгляд непонятно, что делает код. Если вы измените реализацию конечного автомата, высока вероятность появления ошибки. Но если у вас есть рабочий набор тестов, вы можете убедиться, что все по-прежнему работает, и вы всегда можете быть уверены в своем коде.

Новая функция == новые тесты

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

Заключение

В этом посте я написал о необходимых действиях для создания качественных библиотек Arduino. Эти принципы применимы и к вашим проектам. Вы все равно должны задокументировать, что делает ваш код, и хотя бы подумать о написании некоторых тестов. Вы можете запустить набор тестов из командной строки.Веб-разработчики знакомы с рабочим процессом.

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

Если у вас есть вопросы или у вас есть ощущение, что я что-то забыл, дайте мне знать в комментариях. Спасибо!

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

Что происходит, когда у вас есть случайный чип или датчик, который вы хотите связать с Arduino, но не знаете как? Конечно, вы ищете уже существующую библиотеку.А где размещено и доступно множество библиотек? Место, где энергичные разработчики собирают код, публикуют обновления и сотрудничают с другими: Github!

Многие библиотеки Arduino доступны на GitHub. Это действительно укрепляет дух работы с открытым исходным кодом. Если вы нашли нужную библиотеку на GitHub, добавить ее в IDE Arduino относительно просто. Однако, если вы новичок в GitHub (или Arduino IDE), вы можете пропустить простые шаги.

Шаг 1: Arduino IDE

Убедитесь, что у вас запущен хотя бы 1.0.5 или 1.5.x IDE Arduino (примечание: теперь 1.6.x содержит все)

1.5.x – это более «экспериментальная» ветвь IDE. На момент публикации он стал намного более стабильным, но по-прежнему ориентирован на более продвинутые платы Arduino: Yún, (Intel) Galieo и Due. Так что, если у вас есть плата Nano, Uno или Mega, вы можете придерживаться ветки 1.0.x.

Причина, по которой вам нужна эта версия IDE, заключается в том, что она добавляет поддержку критически важной функции «Добавить библиотеку…».

Шаг 2: Загрузите библиотеку

Вы могли заметить, что на странице GitHub вы можете перемещаться по различным файлам библиотеки.Может возникнуть соблазн просто загрузить файлы .cpp и .h, а затем выяснить, куда их поместить. В библиотеку Arduino входит еще пара файлов, так что это не лучший вариант. Вместо этого на странице проекта найдите кнопку «Загрузить ZIP».

Пример GitHub – Ищите загрузку ZIP

Это загружает последнюю версию файлов в правильные каталоги в виде ZIP-файла.

Шаг 3. Переименуйте библиотеку!

Хорошо, этот шаг обязательно сбивает с толку людей.В этом примере мы используем библиотеку Adafruit NeoPixel, которая при загрузке становится «Adafruit_NeoPixel-master.zip».

Это будет проблемой, потому что IDE Arduino не любит такие символы, как «_» и «-».

Шаг 3A) разархивируйте библиотеку и переименуйте папку

Используйте все, что требуется для разархивирования вашей ОС, а затем переименуйте папку, удалив символы «_» и «-». IDE утверждает, что ей нужен только «Basic ASCII», что означает «только буквы и цифры».

[необязательно] Кроме того, GitHub добавляет слово «master.«Удалите и это тоже.

После этого у вас должна быть папка (или каталог) с названием «AdafruitNeoPixel».

Шаг 4. Установите библиотеку

Раньше этот Шаг было сложно сделать правильно. Вот почему в IDE теперь есть опция «Добавить библиотеку».

Для этого шага просто выполните «Добавить библиотеку» и перейдите в новый каталог библиотеки.

Шаг 5. Перезапустите среду IDE [необязательно]

Хотя этот шаг может быть необязательным, я считаю, что это хорошая идея.Перезапустите среду IDE, чтобы она правильно загрузила файл KEYWORD, Примеры и добавила библиотеку в меню библиотеки.

Ошибки

Если вы получили следующую ошибку, вернитесь к шагу 3.

Щелкните, чтобы увидеть полное сообщение об ошибке.

Вы, вероятно, пытаетесь напрямую импортировать этот ZIP-файл (который содержит «неправильное» имя каталога) или библиотека не поддерживает параметр «Добавить файл…». В таком случае опубликуйте ссылку на проект ниже и посмотрите, сможет ли кто-нибудь помочь.

Установка библиотек Sparkfun и Adafruit | ОРЕЛ

Autodesk EAGLE поставляется с множеством бесплатных библиотек прямо из коробки, но для некоторых это может стать проблемой.Вы когда-нибудь слышали об иллюзии выбора? Когда вам дается слишком много вариантов, вы не выбираете ни одного! Что делать, если у вас есть конкретный проект, над которым вы хотите работать из Sparkfun или Adafruit, и вам просто нужно использовать их определенные части?

К счастью, есть решение. Здесь пригодятся библиотеки частей Sparkfun и Adafruit, которые предоставят вам все части, необходимые для проекта, без каких-либо помех. Давайте узнаем, как использовать эти библиотеки в Autodesk EAGLE!

Шаг 1. Загрузите ваши библиотеки

Для начала вам необходимо загрузить библиотеки Sparkfun и / или Adafruit с соответствующих страниц Github.Вот как:

1. Откройте страницы Github библиотеки Sparkfun и библиотеки Adafruit на Github.
2. Выберите зеленый Clone или загрузите кнопку и выберите Download ZIP .
3. Как только ваши zip-файлы будут загружены, распакуйте их в выбранную папку.

Используйте зеленую кнопку «Клонировать» или «Загрузить», чтобы легко загрузить библиотеки Sparkfun и Adafruit с Github.

Выбор места для хранения папок библиотек Sparkfun и Adafruit полностью зависит от вас.Чтобы хранить все в одном месте, мы решили создать новую папку в каталоге документов с именем eagle_external_lbrs , а затем мы добавили две папки библиотек Sparkfun и Adafruit.

Шаг 2. Обновите каталог библиотеки EAGLE

Теперь, когда у ваших новых библиотек Sparkfun и Adafruit появился новый дом на жестком диске вашего компьютера, пришло время обновить каталог EAGLE, чтобы их можно было найти. Чтобы это произошло, выполните следующие действия:

1. Откройте Autodesk EAGLE, и вы увидите панель управления.
2. Затем выберите Параметры »Каталоги , чтобы открыть диалоговое окно Каталоги .
3. Теперь вам нужно добавить путь к файлу, который хранится в ваших библиотеках Sparkfun и Adafruit, в поле Libraries . Ознакомьтесь с примечанием ниже о том, как это работает.

   Прочтите перед тем, как начать удаление файлов! Вместо удаления пути $ EAGLEDIR / lbr: вы добавите новый путь к файлу после каталога по умолчанию, используя точку с запятой (;) в Windows или двоеточие (:) на Mac.Ваш новый путь к файлу библиотек будет выглядеть примерно так: $ EAGLEDIR / lbr: / Users / / Documents / eagle_external_lbrs / Users / / Documents / eagle_external_lbrs – это место, где мы хранили наши новые библиотеки, но ваше имя пути, вероятно, будет другим. Нужен простой способ получить имя пути? Ознакомьтесь с этим руководством для Mac и этим руководством для Windows.

4. Нажмите OK, чтобы завершить изменения в каталоге.
5. Закройте и снова откройте Autodesk EAGLE.

При повторном открытии Autodesk EAGLE проверьте папку Libraries на панели управления , и вы должны увидеть свои недавно добавленные папки.

Вот как будет выглядеть ваш каталог библиотек после добавления новых библиотек Sparkfun и Adafruit.

Шаг 3. Активируйте новые библиотеки

Прежде чем вы сможете начать использовать свои библиотеки Sparkfun и Adafruit, вам необходимо активировать их в Autodesk EAGLE.Вот как это сделать:

1. Щелкните значок стрелки, чтобы развернуть папку «Библиотеки» на панели управления, пока не увидите новые папки Sparkfun и Adafruit.
2. Затем щелкните правой кнопкой мыши папку библиотек Sparkfun и / или Adafruit и выберите Использовать все .

Используйте все действия, чтобы подготовить библиотеки Sparkfun и Adafruit к использованию.

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

Не уверены, активны ли ваши библиотеки? Просто ищите зеленую точку!

Следует иметь в виду одну вещь: если вы хотите использовать только свои новые библиотеки Sparkfun или Adafruit, а , а не , ваши библиотеки EAGLE по умолчанию, то вам необходимо деактивировать их. Для этого

1. Щелкните значок Стрелка , чтобы развернуть папку Библиотеки на Панели управления до тех пор, пока вы не увидите папку lbr по умолчанию.
2. Затем щелкните правой кнопкой мыши папку lbr и выберите Не использовать .

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

Есть серая точка рядом с библиотекой? Это означает, что он отключен и не будет отображаться в результатах поиска.

Три простых шага

Вот и все, три простых шага для начала работы с новыми библиотеками Sparkfun и Adafruit! Если вы выберете значок Добавить в открытом проекте Autodesk EAGLE, вы должны увидеть все свои новые модные библиотеки, готовые к использованию.Работа только с теми библиотеками, которые вам нужны для конкретного проекта, поможет вам повысить эффективность процесса проектирования. Больше не нужно рыться в бесконечных папках в поисках подходящего электролитического конденсатора!

Готовы начать использовать свои собственные библиотеки Sparkfun и Adafruit в своем следующем проекте программного обеспечения для проектирования печатных плат? Попробуйте Autodesk EAGLE бесплатно сегодня!