файлы описаний перенесены в папку docs

This commit is contained in:
klassents 2024-12-24 11:14:58 +07:00
parent 8e2b77a8dc
commit 723732fb2d
5 changed files with 44 additions and 16 deletions

View File

@ -4,12 +4,12 @@
## Установка пакета в ArduinoIDE ## Установка пакета в ArduinoIDE
Для установки пакета в параметрах ArduinoIDE необходимо добавить ссылку `https://elron.tech/files/package_elbear_beta_index.json` в поле "Дополнительные ссылки для Менеджера плат". Для установки пакета в параметрах ArduinoIDE необходимо добавить ссылку `https://elron.tech/files/package_elbear_beta_index.json` в поле "Дополнительные ссылки для Менеджера плат".
Подробные шаги по установке и начальной настройке описаны в [инструкции](./Instructions.md). Подробные шаги по установке и начальной настройке описаны в [инструкции](./docs/Instructions.md).
## Платы, входящие в состав пакета ## Платы, входящие в состав пакета
Пакет включает в себя поддержку следующих плат: Пакет включает в себя поддержку следующих плат:
- [Elbear Ace-Uno](./Elbear_description.md) 8 Mb / 16 Mb / 32 Mb - [Elbear Ace-Uno](./docs/Elbear_description.md) 8 Mb / 16 Mb / 32 Mb
- [START-MIK32](./Start_mik32_description.md) - [START-MIK32](./docs/Start_mik32_description.md)
## Особенности использования пакета в ArduinoIDE ## Особенности использования пакета в ArduinoIDE
### Цифровые выводы ### Цифровые выводы

View File

@ -1 +0,0 @@
new

View File

@ -1,7 +1,7 @@
# Elbear Ace-Uno # Elbear Ace-Uno
Особенности работы с платами Elbear Ace-Uno в среде программирования ArduinoIDE. Особенности работы с платами Elbear Ace-Uno в среде программирования ArduinoIDE.
### Функциональное назначение выводов ### Функциональное назначение выводов
![Pinout](docs/pinout.PNG) ![Pinout](pinout.PNG)
### Цифровые выводы ### Цифровые выводы
На плате Elbear Ace-Uno доступны встроенные светодиод и кнопка. Для их использования необходимо воспользоваться макросами `LED_BUILTIN` и `BTN_BUILTIN`, передавая их в качестве аргументов функции вместо номера цифрового вывода. Макросу `LED_BUILTIN` соответствует номер вывода D22, а макросу `BTN_BUILTIN` - D23. На плате Elbear Ace-Uno доступны встроенные светодиод и кнопка. Для их использования необходимо воспользоваться макросами `LED_BUILTIN` и `BTN_BUILTIN`, передавая их в качестве аргументов функции вместо номера цифрового вывода. Макросу `LED_BUILTIN` соответствует номер вывода D22, а макросу `BTN_BUILTIN` - D23.
#### ШИМ #### ШИМ

View File

@ -3,12 +3,12 @@
2. Откройте меню `Файл -> Параметры`. 2. Откройте меню `Файл -> Параметры`.
3. Вставьте данную ссылку в поле "Дополнительные ссылки для Менеджера плат": 3. Вставьте данную ссылку в поле "Дополнительные ссылки для Менеджера плат":
`https://elron.tech/files/package_elbear_beta_index.json` `https://elron.tech/files/package_elbear_beta_index.json`
![Add_board](docs/Add_board.PNG) ![Add_board](Add_board.PNG)
4. Откройте меню `Инструменты -> Плата -> Менеджер плат...`. 4. Откройте меню `Инструменты -> Плата -> Менеджер плат...`.
5. В поиске найдите плату `Elbear Ace-Uno`, выберите нужную версию и нажмите кнопку `Установить`. 5. В поиске найдите плату `Elbear Ace-Uno`, выберите нужную версию и нажмите кнопку `Установить`.
![Install_board](docs/Install_board.PNG) ![Install_board](Install_board.PNG)
6. Процесс установки может занять некоторое время. Результаты установки отобразятся в поле `Вывод`, а так же во всплывающих уведомлениях. 6. Процесс установки может занять некоторое время. Результаты установки отобразятся в поле `Вывод`, а так же во всплывающих уведомлениях.
![Installation_process](docs/Installation_process.PNG) ![Installation_process](Installation_process.PNG)
Для загрузки скетчей по USB в ArduinoIDE необходимо, чтобы на плате Elbear Ace-Uno был специальный начальный загрузчик ([elbear_fw_bootloader](https://gitflic.ru/project/elron-tech/elbear_fw_bootloader)). Если он уже есть на плате, можно сразу переходить к работе. Если загрузчика еще нет или необходимо обновить его на плате, ниже описан процесс загрузки. Актуальная версия начального загрузчика входит в состав пакета поддержки, отдельно скачивать его не нужно. Для загрузки скетчей по USB в ArduinoIDE необходимо, чтобы на плате Elbear Ace-Uno был специальный начальный загрузчик ([elbear_fw_bootloader](https://gitflic.ru/project/elron-tech/elbear_fw_bootloader)). Если он уже есть на плате, можно сразу переходить к работе. Если загрузчика еще нет или необходимо обновить его на плате, ниже описан процесс загрузки. Актуальная версия начального загрузчика входит в состав пакета поддержки, отдельно скачивать его не нужно.
@ -18,23 +18,23 @@
1. Подключите плату Elbear Ace-Uno к ПК через программатор ELJTAG. 1. Подключите плату Elbear Ace-Uno к ПК через программатор ELJTAG.
2. В ArduinoIDE выберите программатор: `Инструменты -> Программатор -> mik32 uploader`. 2. В ArduinoIDE выберите программатор: `Инструменты -> Программатор -> mik32 uploader`.
3. Для записи начального загрузчика выберите `Инструменты -> Записать Загрузчик`. 3. Для записи начального загрузчика выберите `Инструменты -> Записать Загрузчик`.
![Bootloader](docs/Bootloader.png) ![Bootloader](Bootloader.png)
4. При возникновении проблем с загрузкой ознакомьтесь с разделом `Настройка программатора` в [инструкции](https://elron.tech/wp-content/uploads/2024/05/instrukcija-po-pervomu-zapusku.pdf) по первому запуску платы ELBEAR ACE-UNO. 4. При возникновении проблем с загрузкой ознакомьтесь с разделом `Настройка программатора` в [инструкции](https://elron.tech/wp-content/uploads/2024/05/instrukcija-po-pervomu-zapusku.pdf) по первому запуску платы ELBEAR ACE-UNO.
Теперь можно загружать скетчи в плату по USB. Теперь можно загружать скетчи в плату по USB.
## Начало работы ## Начало работы
1. Подключите плату к ПК по USB. 1. Подключите плату к ПК по USB.
2. Откройте ArduinoIDE и загрузите необходимый скетч. Для начала работы можно воспользоваться готовыми примерами, например - `Файл -> Примеры -> 01.Basics -> Blink`. 2. Откройте ArduinoIDE и загрузите необходимый скетч. Для начала работы можно воспользоваться готовыми примерами, например - `Файл -> Примеры -> 01.Basics -> Blink`.
![Blink_example](docs/Blink_example.png) ![Blink_example](Blink_example.png)
3. Выберите активную плату - `Инструменты -> Плата`. 3. Выберите активную плату - `Инструменты -> Плата`.
![Set_board](docs/Set_board.png) ![Set_board](Set_board.png)
4. Выберите используемый COM порт - `Инструменты -> Порт`. 4. Выберите используемый COM порт - `Инструменты -> Порт`.
![Set_port](docs/Set_port.png) ![Set_port](Set_port.png)
Выбранные плата и порт в ArduinoIDE должны отображаться следующим образом: Выбранные плата и порт в ArduinoIDE должны отображаться следующим образом:
![Selected_board_port](docs/Selected_board_port.png) ![Selected_board_port](Selected_board_port.png)
5. Проверьте скетч, нажав соответствующую кнопку. 5. Проверьте скетч, нажав соответствующую кнопку.
![Build_project](docs/Build_project.png) ![Build_project](Build_project.png)
6. Загрузите полученную прошивку на плату. 6. Загрузите полученную прошивку на плату.
![Flash_project](docs/Flash_project.png) ![Flash_project](Flash_project.png)
7. При необходимости можно открыть терминал и получать сообщения от платы по интерфейсу Serial. Для этого добавьте в скетч работу с интерфейсом и после загрузки прошивки выберите `Инструменты -> Монитор порта`. 7. При необходимости можно открыть терминал и получать сообщения от платы по интерфейсу Serial. Для этого добавьте в скетч работу с интерфейсом и после загрузки прошивки выберите `Инструменты -> Монитор порта`.
![Monitor](docs/Monitor.png) ![Monitor](Monitor.png)

View File

@ -0,0 +1,29 @@
# START-MIK32
Особенности работы с платой START-MIK32 в среде программирования ArduinoIDE.
### Функциональное назначение выводов
![Start_V1_pinout.png](docs/Start_V1_pinout.png)
### Загрузка скетчей
todo описать установку перемычек на плате
### Цифровые выводы
todo как номер вывода передавать в функции
На плате START-MIK32 доступны встроенные светодиоды и кнопка. Для их использования необходимо воспользоваться макросами `LED_BUILTIN` и `BTN_BUILTIN`, передавая их в качестве аргументов функции вместо номера цифрового вывода. Макросу `LED_BUILTIN` соответствует номер вывода D22, а макросу `BTN_BUILTIN` - D23.
#### ШИМ
На плате START-MIK32 доступны следующие выводы для формирования ШИМ-сигнала: D3, D5, D6, D9, D10, D11. Генерация сигнала осуществляется с помощью 32-битного таймера. Выводы D3, D5, D6, D9 подключены к таймеру 1, выводы D10, D11 подключены к таймеру 2. Выводы, подключенные к одному и тому же таймеру, выдают ШИМ-сигнал одинаковой частоты.
### Прерывания
На плате START-MIK32 доступно 8 прерываний, настраиваемых функцией `void attachInterrupt(uint8_t interruptNum, void (*userFunc)(void), int mode)`:
|Цифровой вывод|Номер прерывания|
|---------|---------|
|D2|0|
|D3|1|
|D4|2|
|D5|3|
|D8|4|
|D9|5|
|`BTN_BUILTIN`|6|
### Serial
Для работы доступно два последовательных интерфейса. Нулевой интерфейс доступен на выводах D0, D1, для работы с ним используется экземпляр класса под названием `Serial`. Нулевой интерфейс используется для вывода информации в Монитор порта в Arduino IDE.
Первый интерфейс доступен на выводах D7, D8, используемый экземпляр класса - `Serial1`.
todo доступные для работы скорости