forked from Teapot321/M5Client
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
0.3.5 - bug fixes and other minor changes
- Loading branch information
1 parent
dc8cb32
commit 963bfe8
Showing
5 changed files
with
75 additions
and
48 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,60 +1,88 @@ | ||
# M5ClientMX 🌟 | ||
# 🎉 M5ClientMX | ||
|
||
Добро пожаловать в проект **M5ClientMX**! Это приложение создано для упрощения процесса прошивки микропрограмм на различные устройства M5, что позволяет вам легко поддерживать оборудование в актуальном состоянии и обеспечивать его оптимальную работу. 🚀 | ||
Добро пожаловать в **M5ClientMX** — удобный инструмент для управления устройствами серии M5Stack! 🚀 | ||
|
||
## Функции 🛠️ | ||
- **Удобный интерфейс**: Интуитивный дизайн для легкой навигации и работы. | ||
- **Управление прошивками**: Легко скачивайте и прошивайте микропрограммы для различных устройств M5. | ||
- **Отслеживание прогресса**: Отображение текущего статуса во время установки прошивки. | ||
- **Установка драйверов**: Упростите процесс установки необходимых драйверов для ваших устройств. | ||
- **Пользовательские уведомления**: Получайте уведомления об успехах или ошибках с полезной информацией. | ||
## 📖 Описание | ||
|
||
## Начало работы 🚀 | ||
M5ClientMX — это приложение с графическим интерфейсом, которое позволяет: | ||
- 📦 **Устанавливать прошивки** на устройства. | ||
- ⚙️ **Управлять конфигурацией** в настройках | ||
- 🔌 **Работать с COM-портами** для подключения устройств. | ||
- 🌍 **Поддерживать несколько языков** (включая русский и английский). | ||
- 🖥️ **Автоматически загружать зависимости и драйверы** для устройств. | ||
|
||
### Предварительные требования | ||
- Java Development Kit (JDK) 21 или выше | ||
- Grable (для сборки проекта) | ||
- Совместимое устройство M5 | ||
--- | ||
|
||
## 🛠️ Основные возможности | ||
|
||
### 🔧 Управление прошивками | ||
- Выберите устройство и прошивку. | ||
- Установите прошивку с отслеживанием прогресса. | ||
|
||
### 🗂️ Работа с настройками | ||
- Настройте язык, устройство, COM-порт и другие параметры. | ||
- Сохраните настройки в файл конфигурации. | ||
|
||
### 🌐 Мультиязычность | ||
- Поддерживаются русский и английский языки. | ||
- Переключение языка на лету через интерфейс. | ||
|
||
### 🔌 Подключение устройств | ||
- Автоматическое обнаружение COM-портов. | ||
- Быстрая установка драйверов для поддерживаемых устройств. | ||
|
||
### ⚡ Установка зависимостей | ||
- Установка `esptool` и необходимых библиотек автоматически. | ||
|
||
--- | ||
|
||
## 🚀 Установка и запуск | ||
|
||
# **Установка** | ||
### 1. 📥 Скачайте репозиторий | ||
Скачайте или клонируйте проект с помощью кнопки **Code → Download ZIP**. | ||
|
||
## Сборка и запуск приложения | ||
### 2. 🛠️ Настройка | ||
- Убедитесь, что у вас установлены **Java 21** и **JavaFX**. | ||
- Создайте файл `miroshka_config.properties` (создается автоматически при первом запуске). | ||
|
||
### Клонируйте репозиторий | ||
git clone https://github.com/Miroshka000/M5ClientMX.git | ||
cd M5ClientMX | ||
### 3. ▶️ Запуск | ||
- Запустите приложение с помощью вашей IDE (например, IntelliJ IDEA) или выполните сборку через Maven. | ||
|
||
--- | ||
|
||
## **Соберите проект и запустите приложение** | ||
./gradlew build | ||
./gradlew run | ||
## 💡 Использование | ||
|
||
## **Создание файла (.exe)** | ||
1. Подключите устройство через USB. | ||
2. Выберите устройство и порт в интерфейсе. | ||
3. Выберите прошивку и нажмите **Установить**. | ||
4. Наслаждайтесь простотой работы! 😊 | ||
|
||
./gradlew jpackage | ||
--- | ||
|
||
После выполнения команды `./gradlew jpackage`, установочный файл (.exe) для запуска приложения будет находиться в папке `build/installer/M5ClientMX` | ||
## 🔧 Требования | ||
- **Java 11 или выше**. | ||
- **Windows** для полной поддержки драйверов. | ||
- Поддерживаемые устройства: `Plus2`, `Card`, `Plus1`. | ||
|
||
--- | ||
|
||
### Использование 🖥️ | ||
- **Выберите ваше устройство**: Выберите подходящее устройство из выпадающего списка. | ||
- **Выберите COM порт**: Выберите правильный COM порт, подключенный к вашему устройству. | ||
- **Выберите прошивку**: Выберите прошивку, которую хотите установить, из доступных вариантов. | ||
- **Установите драйверы**: При необходимости нажмите кнопку для установки требуемых драйверов для вашего устройства. | ||
- **Прошивка устройства**: Нажмите кнопку "Установить", чтобы начать процесс прошивки, и наблюдайте за индикатором выполнения. | ||
## 🏗️ Планируемые улучшения | ||
- 🌟 Добавить поддержку macOS и Linux. | ||
- 🔍 Расширить выбор прошивок. | ||
- 📱 Создать мобильную версию для Android. | ||
|
||
## Вклад в проект 🤝 | ||
Мы приветствуем участие сообщества! Если хотите помочь улучшить проект, создайте форк репозитория, внесите изменения и отправьте pull request. | ||
--- | ||
|
||
### Сообщение об ошибках 🐛 | ||
Если вы столкнулись с проблемами или ошибками, пожалуйста, сообщите о них в [разделе проблем](https://github.com/Miroshka000/M5ClientMX/issues) этого репозитория. | ||
## 📩 Обратная связь | ||
Если у вас есть вопросы или предложения: | ||
- Создайте [Issue](https://github.com/Miroshka000/M5ClientMX/issues). | ||
- Напишите нам на [GitHub Discussions](https://github.com/Miroshka000/M5ClientMX/discussions). | ||
|
||
## Лицензия 📄 | ||
Этот проект лицензирован по лицензии MIT - см. файл [LICENSE](LICENSE) для подробностей. | ||
--- | ||
|
||
## Благодарности 🙏 | ||
- [Esptool](https://github.com/espressif/esptool) за предоставление инструмента для прошивки микропрограмм. | ||
- [Apache Commons IO](https://commons.apache.org/proper/commons-io/) за утилиты для работы с файлами. | ||
## 📝 Лицензия | ||
Проект распространяется под лицензией **GPL-3.0 license**. Подробнее в [LICENSE](LICENSE.txt). 🧾 | ||
|
||
--- | ||
|
||
Спасибо, что ознакомились с **M5ClientMX**! Мы надеемся, что этот инструмент поможет вам в ваших проектах и улучшит ваш опыт работы с устройствами M5 🎉 | ||
✨ **Спасибо, что используете M5ClientMX!** 🛠️ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -6,7 +6,7 @@ plugins { | |
} | ||
|
||
group = "miroshka" | ||
version = "0.3.4" | ||
version = "0.3.5" | ||
|
||
repositories { | ||
mavenCentral() | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters