Skip to content

Commit 9cd8bcd

Browse files
authored
Update README.md
add some infromation about version 0.1.1
1 parent 4d0d621 commit 9cd8bcd

File tree

1 file changed

+63
-2
lines changed

1 file changed

+63
-2
lines changed

README.md

Lines changed: 63 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,63 @@
1-
# Airngin-esp32-mqtt-client
2-
Arduino Library for Client Connection to the AirNgin Broker
1+
# AirNgin ESP32 MQTT Client
2+
**Arduino Library for Client Connection to the AirNgin Broker**
3+
4+
این کتابخانه آردوینو برای پلتفرم اینترنت اشیا **AirNgin** طراحی و توسعه داده شده است. با استفاده از این کتابخانه که به‌صورت مداوم به‌روزرسانی می‌شود، می‌توانید به‌راحتی و بدون نگرانی به بروکر **AirNgin** متصل شوید.
5+
6+
---
7+
8+
## مراحل اولیه استفاده
9+
قبل از استفاده از این کتابخانه، لازم است که در **پنل تولیدکنندگان AirNgin** به آدرس زیر عضو شوید و ابزار (Device) مورد نظر خود را ثبت کنید:
10+
11+
🔗 [https://panel.airngin.com](https://panel.airngin.com)
12+
13+
برای راهنمایی بیشتر، می‌توانید از آموزش‌های موجود در سایت استفاده کنید:
14+
15+
🔗 [اتصال 2 رله به برد توسعه ESP32](https://airngin.com/%d8%a7%d8%aa%d8%b5%d8%a7%d9%84-2-%d8%b1%d9%84%d9%87-%d8%a8%d8%b1%d8%af-%d8%a8%d8%a7-%d8%a8%d8%b1%d8%af-%d8%aa%d9%88%d8%b3%d8%b9%d9%87-esp32-wroom-32d-%d8%a8%d8%a7-%da%a9%d8%aa%d8%a7%d8%a8/)
16+
17+
---
18+
19+
## امکانات کتابخانه
20+
این کتابخانه تمامی امکانات لازم را فراهم کرده است تا شما بتوانید با **کمترین حجم کدنویسی**، بردهای خود را توسعه داده و به دنیای اینترنت اشیا متصل کنید. برخی از ویژگی‌های کلیدی این کتابخانه عبارت‌اند از:
21+
22+
- اتصال خودکار به بروکر و مدیریت قطعی‌ها و فرآیند اتصال دوباره
23+
- قابلیت آپدیت OTA فریمور ابزار از راه دور
24+
- امکان ریست، ریبوت و فعال‌سازی حالت AP از راه دور توسط تولیدکننده (با اجازه کاربر)
25+
- پنل کانفیگ برای راه‌اندازی سریع ابزار
26+
27+
---
28+
29+
## پنل کانفیگ
30+
در نمونه کد `simple.ino`، پین **32** به‌عنوان یک **پوش‌باتن** در نظر گرفته شده است. هنگامی که این پوش‌باتن به مدت **6 ثانیه** فشار داده شود، پنل کانفیگ راه‌اندازی می‌شود و برد ESP32 شما به حالت **Access Point (AP)** می‌رود و یک شبکه وای‌فای ایجاد می‌کند.
31+
32+
در این حالت می‌توانید با استفاده از نرم‌افزار موبایل یا با اتصال به ابزار (رمز عبور: `00000000`) و وارد کردن آدرس **192.168.1.1**، به پنل کانفیگ دسترسی پیدا کنید.
33+
34+
---
35+
36+
## اتصال خودکار به بروکر
37+
این کتابخانه به‌صورت خودکار به بروکر متصل می‌شود و در صورت بروز قطعی، فرآیند اتصال مجدد را مدیریت می‌کند.
38+
39+
---
40+
41+
## قابلیت آپدیت OTA
42+
این قابلیت به شما اجازه می‌دهد تا به‌صورت **از راه دور** فریمور ابزار خود را به‌روزرسانی کنید. این ویژگی برای رفع مشکلات نرم‌افزاری و اضافه کردن قابلیت‌های جدید به ابزار بسیار مفید است.
43+
44+
---
45+
46+
## مدیریت راه دور
47+
با استفاده از این کتابخانه، می‌توانید از راه دور عملیات زیر را انجام دهید (البته با اجازه کاربر ابزار):
48+
49+
- **ریست کردن ابزار**
50+
- **ریبوت کردن ابزار**
51+
- **فعال‌سازی حالت AP**
52+
- **تست ابزار**
53+
54+
---
55+
56+
## متدهای Callback متنوع
57+
این کتابخانه از متدهای متنوعی برای مدیریت پیام‌ها و رویدادهای مختلف پشتیبانی می‌کند.
58+
59+
### فعال‌سازی Callback سراسری
60+
اگر متغیر سراسری زیر را **`true`** کنید، تنها یک Callback عمومی به نام `myMqttCallback` فعال می‌شود:
61+
62+
```cpp
63+
#define CALL_Global_Mqtt_CALLBACK true

0 commit comments

Comments
 (0)