Самый простой способ сделать это-скопировать файлы заголовка и кода библиотеки в исходный каталог и включить их.

myproject/
    myproject.ino
    somelib.h
    somelib.cpp

В вашем коде вы можете включить "somelib.h".

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

Что касается структуры каталогов всего моего проекта, включая схемы и документацию, мой обычно выглядит так:

myproject/
  schematics/ - eagle files or whatever you may have
  docs/       - include relevant datasheets here
  test/       - any test cases or other code to test parts of the system.
  myproject/  - since Arduino code must be in a directory of the same name
    myproject.ino
    ...

Мой способ организации проекта arduino довольно прост, все мои проекты являются репозиториями git, так что есть, по крайней мере, следующее:

• проект/
  • проект.ino
  • Файл Makefile

У меня есть предпочтение использовать мой любимый редактор и файл создания, который я создал для работы с большинством вариантов использования (и я даже улучшил тот, которым скоро поделюсь).

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

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

• проект
  • проект.ino
  • Файл Makefile
  • project_hal_lib
    • библиотека 1
    • библиотека 2
    • библиотека 3
    • …

Тем не менее, с arduino 1.5.x предлагается новый способ указания библиотек, который позволит создавать и создавать проекты arduino так же, как мы уже делаем с pipy и virtualenv в python, т. Е. вы определяете набор необходимых библиотек, и они загружаются.

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

Структура каталогов

Одним из способов организации ваших проектов было бы:

• Проект - Родительский каталог

  • ProjectA - Каталог исходного кода, содержащий код Arduino

    1. Проект.ino
    2. заголовок.h
    3. implementation.cpp

  • документы - Ваш основной каталог документации

  • схемы - они могут храниться отдельно в отдельном репо Git или в части одного и того же репо

  • библиотеки - Это будут содержать ваши сторонние библиотеки.

    1. libA - Они могут храниться в качестве сторонних репозиториев
    2. libC - ...

  • лицензия

  • Файл README

  • Makefile - Необходим для обработки зависимостей между каталогами

Рабочий процесс

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

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

Вы можете сделать это с помощью подмодуля git добавить команду <repo.git><repo.git>. Чтобы поддерживать его в актуальном состоянии, вы можете использовать обновление подмодуля git <путь><путь>.

Когда дело доходит до обслуживания нескольких сторонних библиотек в вашем репозитории, чтобы каждая из них могла управляться самостоятельно или при необходимости обновляться, подмодуль git снова спасает ваш день!

Чтобы добавить репозиторий третьей стороны в библиотеки, используйте подмодуль команды git add <lib1.git> libs/lib1<lib1.git>. Затем, чтобы сохранить библиотеку в фиксированной точке цикла выпуска, проверьте библиотеку и сделайте фиксацию. Чтобы поддерживать библиотеку в актуальном состоянии, используйте команду git подмодуль обновить <путь><путь>.

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

По Сравнению С Подходом С Одним Каталогом

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

Этот подход позволяет поддерживать несколько репозиториев, но при этом возникает необходимость в файле Makefile для обработки процесса компиляции и компоновки.

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

Вы могли бы использовать файл makefile https://github.com/sudar/Arduino-Makefile для компиляции кодов Arduino. Вам не обязательно нужна IDE.

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

Если вам нужно поддерживать совместимость с IDE Arduino напрямую, вы можете использовать что-то вроде того, что я описал здесь:

https://gitlab.com/mikealger/ExampleArduinoProjectStructure/tree/master/ExampleSketchBook

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

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

удачи вам там

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

MyProject
|_MyProject
  |_MyProject.ino
  |_data
  |  |_documentation 
  |  |_PCB
  |  |_schematics
  |_src
     |_MyProjectLibrary1
     |_ThirdPartyLibrary

Папка MyProject (корневой каталог репозитория)

Причина, по которой я предлагаю, казалось бы, избыточную корневую папку MyProject, заключается в том, что вы упомянули об использовании GitHub. Когда вы загружаете (а не клонируете) содержимое репозитория GitHub, имя ветви или тега добавляется к имени репозитория (например, MyProject-master). В среде IDE Arduino требуется, чтобы имя папки скетча совпадало с именем файла скетча. Если вы откроете файл .ino, который находится в папке, не соответствующей имени скетча, IDE Arduino предложит вам создать папку с соответствующим именем скетча и переместить скетч в эту папку. В дополнение к тому, что это не очень хороший начальный опыт для пользователя, большая проблема заключается в том, что среда IDE Arduino может не копировать все другие связанные файлы во вновь созданную папку, что может привести к тому, что программа больше не будет компилироваться. Помещая скетч во вложенную папку, вы избегаете изменения имени папки скетча на GitHub.

Если проблема с именем файла GitHub не является для вас проблемой, то избыточная корневая папка не нужна.

папка с данными

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

папка src

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

#include "src/MyProjectLibrary1/MyProjectLibrary1.h"
#include "src/ThirdPartyLibrary/ThirdPartyLibrary.h"

Структура папок формата библиотеки Arduino 1.5 также поддерживается, вам нужно только соответствующим образом настроить инструкции #include.

Обратите внимание, что только Arduino IDE 1.6.10 (arduino-builder 1.3.19) и более новые версии поддерживают рекурсивную компиляцию скетчей.

К сожалению, некоторые библиотеки используют неправильный синтаксис #include для локальных включений файлов (например, #include <ThirdPartyLibrary.h><ThirdPartyLibrary.h> вместо #include "ThirdPartyLibrary.h"). Это по-прежнему работает, когда библиотека установлена в одну из папок библиотек Arduino, но не работает, когда библиотека поставляется в комплекте с скетчем. Поэтому для использования этого способа в некоторых библиотеках могут потребоваться незначительные изменения.

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

Возможность использовать встроенные библиотеки на месте также соответствует другой вашей цели:

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

Устранение требования ручной установки библиотек значительно упрощает использование проекта.

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