Files

99 lines
5.1 KiB
Markdown

# 📚 Централизованная база знаний DS_Library
Единый каталог документации по аппаратным драйверам, библиотекам и утилитам для STM32.
> **Навигация:** Ссылки на документацию ведут на файлы в папке `docs/`, а ссылки в крайней правой колонке — на репозитории https://git.domstudent.ru/Library.
## 📦 Как подключать библиотеки к своим проектам
Все библиотеки в данном каталоге оформлены как независимые Git-репозитории. Чтобы добавить любой драйвер в свой проект, используйте механизм подмодулей **Git Submodules**:
```bash
# Пример добавления датчика температуры TMP112
git submodule add https://git.domstudent.ru/Library/DS_TMP112
# Пример добавления дисплея ST7789V
git submodule add https://git.domstudent.ru/Library/DS_ST7789V
```
# Полное удаление подключенного субмодуля
Для корректного удаления субмодуля из репозитория Git (чтобы не осталось «битых» ссылок в конфигурации), выполните следующие шаги:
```bash
# 1. Деинициализируйте субмодуль (удаляет настройки из .git/config и локальные файлы)
git submodule deinit -f Library/DS_TMP112
# 2. Удалите директорию субмодуля из индекса Git и рабочего дерева
git rm -f Library/DS_TMP112
# 3. Очистите внутренний кэш самого Git (важно для возможности повторного добавления)
rm -rf .git/modules/Library/DS_TMP112
# 4. Закоммитьте изменения в основном репозитории
git commit -m "Удален субмодуль DS_TMP112"
```
---
## 📺 Дисплеи и Графика (Displays)
| Компонент | Документация | Исходный код |
| :--- | :--- | :--- |
| **DS_ST7789V** | [Инструкция](./docs/DS_ST7789V.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_ST7789V) |
| **DS_ILI9341** | [Инструкция](./docs/DS_ILI9341.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_ILI9341) |
| **DS_MAX7219** | [Инструкция](./docs/DS_MAX7219.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_MAX7219) |
---
## 🌡 Датчики (Sensors)
| Компонент | Документация | Исходный код |
| :--- | :--- | :--- |
| **DS_TMP112** | [Инструкция](./docs/DS_TMP112.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_TMP112) |
| **DS_BMP180** | [Инструкция](./docs/DS_BMP180.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_BMP180) |
| **DS_INA226** | [Инструкция](./docs/DS_INA226.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_INA226) |
---
## 💾 Память и Интерфейсы
| Компонент | Документация | Исходный код |
| :--- | :--- | :--- |
| **DS_SN65HVD230**| [Инструкция](./docs/DS_SN65HVD230.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_SN65HVD230) |
| **DS_W25X40CL** | [Инструкция](./docs/DS_W25X40CL.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_W25X40CL) |
| **DS_VirtualComPort**| [Инструкция](./docs/DS_VirtualComPort.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_VirtualComPort) |
---
## 🕹 Управление (HMI)
| Компонент | Документация | Исходный код |
| :--- | :--- | :--- |
| **DS_Button** | [Инструкция](./docs/DS_Button.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_Button) |
| **DS_Encoder** | [Инструкция](./docs/DS_Encoder.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_Encoder) |
---
## 🚗 Автомобильные интерфейсы
| Компонент | Документация | Исходный код |
| :--- | :--- | :--- |
| **DS_Accord_8_F-CAN** | [Инструкция](./docs/DS_Accord_8_F-CAN.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_Accord_8_F-CAN) |
## 🛠 Утилиты
| Компонент | Документация | Исходный код |
| :--- | :--- | :--- |
| **DS_I2CScanner** | [Инструкция](./docs/DS_I2CScanner.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_I2CScanner) |
| **DS_UpdateCMakeList**| [Инструкция](./docs/DS_UpdateCMakeList.md) | [Репозиторий](https://git.domstudent.ru/Library/DS_UpdateCMakeList) |
---
## 📁 Структура
```text
DS_Library_Docs/
├── README.md
└── docs/ # Файлы технического описания
```