Перевод README на русский язык
Some checks failed
Build and deploy Docs site to GitHub Pages / github-pages (push) Has been cancelled
Some checks failed
Build and deploy Docs site to GitHub Pages / github-pages (push) Has been cancelled
This commit is contained in:
UA1ZBE
151
README.md
151
README.md
@@ -1,120 +1,75 @@
|
|||||||
## About MeshCore
|
## MeshCore Simple Sensor — Heltec T114 + BME280
|
||||||
|
|
||||||
MeshCore is a lightweight, portable C++ library that enables multi-hop packet routing for embedded projects using LoRa and other packet radios. It is designed for developers who want to create resilient, decentralized communication networks that work without the internet.
|
Прошивка **Simple Sensor** на базе [MeshCore](https://github.com/meshcore-dev/MeshCore) для платы **Heltec T114** (без экрана) с датчиком **BME280** (температура, влажность, атмосферное давление).
|
||||||
|
|
||||||
## 🔍 What is MeshCore?
|
### 🎯 Назначение
|
||||||
|
|
||||||
MeshCore now supports a range of LoRa devices, allowing for easy flashing without the need to compile firmware manually. Users can flash a pre-built binary using tools like Adafruit ESPTool and interact with the network through a serial console.
|
Удалённый сенсорный узел mesh-сети. Автоматически считывает показания с BME280 и передаёт телеметрию в сеть. Поддерживает опрос данных, алерты при выходе за пороги и управление по последовательному порту или через LoRa.
|
||||||
MeshCore provides the ability to create wireless mesh networks, similar to Meshtastic and Reticulum but with a focus on lightweight multi-hop packet routing for embedded projects. Unlike Meshtastic, which is tailored for casual LoRa communication, or Reticulum, which offers advanced networking, MeshCore balances simplicity with scalability, making it ideal for custom embedded solutions., where devices (nodes) can communicate over long distances by relaying messages through intermediate nodes. This is especially useful in off-grid, emergency, or tactical situations where traditional communication infrastructure is unavailable.
|
|
||||||
|
|
||||||
## ⚡ Key Features
|
### 📻 Параметры радиоканала
|
||||||
|
|
||||||
* Multi-Hop Packet Routing
|
| Параметр | Значение |
|
||||||
* Devices can forward messages across multiple nodes, extending range beyond a single radio's reach.
|
|---|---|
|
||||||
* Supports up to a configurable number of hops to balance network efficiency and prevent excessive traffic.
|
| Частота | 868.856018 МГц |
|
||||||
* Nodes use fixed roles where "Companion" nodes are not repeating messages at all to prevent adverse routing paths from being used.
|
| Полоса (BW) | 62.5 кГц |
|
||||||
* Supports LoRa Radios – Works with Heltec, RAK Wireless, and other LoRa-based hardware.
|
| Spreading Factor | 7 |
|
||||||
* Decentralized & Resilient – No central server or internet required; the network is self-healing.
|
| Coding Rate | 4/7 |
|
||||||
* Low Power Consumption – Ideal for battery-powered or solar-powered devices.
|
| Хэш пути | 2 байта |
|
||||||
* Simple to Deploy – Pre-built example applications make it easy to get started.
|
| Мощность | 22 dBm |
|
||||||
|
|
||||||
## 🎯 What Can You Use MeshCore For?
|
### 🧩 Поддерживаемые датчики
|
||||||
|
|
||||||
* Off-Grid Communication: Stay connected even in remote areas.
|
Все датчики определяются автоматически на шине I2C (пины `PIN_WIRE1_SDA`/`PIN_WIRE1_SCL`):
|
||||||
* Emergency Response & Disaster Recovery: Set up instant networks where infrastructure is down.
|
|
||||||
* Outdoor Activities: Hiking, camping, and adventure racing communication.
|
|
||||||
* Tactical & Security Applications: Military, law enforcement, and private security use cases.
|
|
||||||
* IoT & Sensor Networks: Collect data from remote sensors and relay it back to a central location.
|
|
||||||
|
|
||||||
## 🚀 How to Get Started
|
- **BME280** — температура, влажность, давление
|
||||||
|
- AHTx0 — температура, влажность
|
||||||
|
- BMP280 — температура, давление
|
||||||
|
- SHTC3 — температура, влажность
|
||||||
|
- SHT4x — температура, влажность
|
||||||
|
- LPS22HB — давление
|
||||||
|
- INA219 / INA226 / INA260 / INA3221 — напряжение, ток, мощность
|
||||||
|
- MLX90614 — бесконтактная температура
|
||||||
|
- VL53L0X — дальномер
|
||||||
|
- BME680 / BMP085 — дополнительные датчики
|
||||||
|
|
||||||
- Watch the [MeshCore QuickStart Playlist](https://www.youtube.com/watch?v=iaFltojJrAc&list=PLshzThxhw4O4WU_iZo3NmNZOv6KMrUuF9) by The Comms Channel
|
Период опроса датчиков: **60 секунд** (настраивается).
|
||||||
- Watch the [MeshCore Technical Presentation](https://www.youtube.com/watch?v=OwmkVkZQTf4) by Liam Cottle.
|
|
||||||
- Read through our [Frequently Asked Questions](./docs/faq.md) and [Documentation](https://docs.meshcore.io).
|
|
||||||
- Flash the MeshCore firmware on a supported device.
|
|
||||||
- Connect with a supported client.
|
|
||||||
|
|
||||||
For developers;
|
### 🔧 Сборка
|
||||||
|
|
||||||
- Install [PlatformIO](https://docs.platformio.org) in [Visual Studio Code](https://code.visualstudio.com).
|
```bash
|
||||||
- Clone and open the MeshCore repository in Visual Studio Code.
|
pio run -e Heltec_t114_without_display_simple_sensor
|
||||||
- See the example applications you can modify and run:
|
```
|
||||||
- [Companion Radio](./examples/companion_radio) - For use with an external chat app, over BLE, USB or WiFi.
|
|
||||||
- [KISS Modem](./examples/kiss_modem) - Serial KISS protocol bridge for host applications. ([protocol docs](./docs/kiss_modem_protocol.md))
|
|
||||||
- [Simple Repeater](./examples/simple_repeater) - Extends network coverage by relaying messages.
|
|
||||||
- [Simple Room Server](./examples/simple_room_server) - A simple BBS server for shared Posts.
|
|
||||||
- [Simple Secure Chat](./examples/simple_secure_chat) - Secure terminal based text communication between devices.
|
|
||||||
- [Simple Sensor](./examples/simple_sensor) - Remote sensor node with telemetry and alerting.
|
|
||||||
|
|
||||||
The Simple Secure Chat example can be interacted with through the Serial Monitor in Visual Studio Code, or with a Serial USB Terminal on Android.
|
Генерация UF2 для заливки через USB (drag-n-drop):
|
||||||
|
```bash
|
||||||
|
pio run -e Heltec_t114_without_display_simple_sensor -t create_uf2
|
||||||
|
```
|
||||||
|
|
||||||
## ⚡️ MeshCore Flasher
|
Файл прошивки: `.pio/build/Heltec_t114_without_display_simple_sensor/firmware.uf2`
|
||||||
|
|
||||||
We have prebuilt firmware ready to flash on supported devices.
|
**Заливка:** подключи T114 по USB, дважды нажми RESET (или зажми BOOT при подключении) — появится диск `T114` — перетащи `firmware.uf2` на него.
|
||||||
|
|
||||||
- Launch https://meshcore.io/flasher
|
### 📡 Использование
|
||||||
- Select a supported device
|
|
||||||
- Flash one of the firmware types:
|
|
||||||
- Companion, Repeater or Room Server
|
|
||||||
- Once flashing is complete, you can connect with one of the MeshCore clients below.
|
|
||||||
|
|
||||||
## 📱 MeshCore Clients
|
После заливки и первой загрузки:
|
||||||
|
|
||||||
**Companion Firmware**
|
1. Подключись через Serial Monitor (115200 бод)
|
||||||
|
2. На экране появится `Sensor ID: <hex>` — публичный ключ устройства
|
||||||
|
3. Для управления используй CLI-команды:
|
||||||
|
- `help` — список команд
|
||||||
|
- `set name "Мой датчик"` — имя узла
|
||||||
|
- `set password mypass` — пароль администратора
|
||||||
|
- `phm 1` — хэш пути 2 байта (уже установлен по умолчанию)
|
||||||
|
- `io` — чтение/запись GPIO
|
||||||
|
|
||||||
The companion firmware can be connected to via BLE, USB or WiFi depending on the firmware type you flashed.
|
Другие устройства mesh-сети могут подключаться к сенсору и запрашивать телеметрию по протоколу MeshCore.
|
||||||
|
|
||||||
- Web: https://app.meshcore.nz
|
### 🔗 Совместимость
|
||||||
- Android: https://play.google.com/store/apps/details?id=com.liamcottle.meshcore.android
|
|
||||||
- iOS: https://apps.apple.com/us/app/meshcore/id6742354151?platform=iphone
|
|
||||||
- NodeJS: https://github.com/liamcottle/meshcore.js
|
|
||||||
- Python: https://github.com/fdlamotte/meshcore-cli
|
|
||||||
|
|
||||||
**Repeater and Room Server Firmware**
|
- Работает с Companion Radio (BLE/USB/WiFi)
|
||||||
|
- Поддерживает удалённое управление из мобильного приложения MeshCore
|
||||||
|
- Совместим с Repeater и Room Server для расширения сети
|
||||||
|
|
||||||
The repeater and room server firmwares can be setup via USB in the web config tool.
|
### 📜 Лицензия
|
||||||
|
|
||||||
- https://config.meshcore.io
|
Проект основан на MeshCore (MIT License). См. `license.txt`.
|
||||||
|
|
||||||
They can also be managed via LoRa in the mobile app by using the Remote Management feature.
|
|
||||||
|
|
||||||
## 🛠 Hardware Compatibility
|
|
||||||
|
|
||||||
MeshCore is designed for devices listed in the [MeshCore Flasher](https://meshcore.io/flasher)
|
|
||||||
|
|
||||||
## 📜 License
|
|
||||||
|
|
||||||
MeshCore is open-source software released under the MIT License. You are free to use, modify, and distribute it for personal and commercial projects.
|
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Please submit PR's using 'dev' as the base branch!
|
|
||||||
For minor changes just submit your PR and we'll try to review it, but for anything more 'impactful' please open an Issue first and start a discussion. Is better to sound out what it is you want to achieve first, and try to come to a consensus on what the best approach is, especially when it impacts the structure or architecture of this codebase.
|
|
||||||
|
|
||||||
Here are some general principals you should try to adhere to:
|
|
||||||
* Keep it simple. Please, don't think like a high-level lang programmer. Think embedded, and keep code concise, without any unnecessary layers.
|
|
||||||
* No dynamic memory allocation, except during setup/begin functions.
|
|
||||||
* Use the same brace and indenting style that's in the core source modules. (A .clang-format is prob going to be added soon, but please do NOT retroactively re-format existing code. This just creates unnecessary diffs that make finding problems harder)
|
|
||||||
|
|
||||||
Help us prioritize! Please react with thumbs-up to issues/PRs you care about most. We look at reaction counts when planning work.
|
|
||||||
|
|
||||||
## Road-Map / To-Do
|
|
||||||
|
|
||||||
There are a number of fairly major features in the pipeline, with no particular time-frames attached yet. In very rough chronological order:
|
|
||||||
- [X] Companion radio: UI redesign
|
|
||||||
- [X] Repeater + Room Server: add ACL's (like Sensor Node has)
|
|
||||||
- [X] Standardise Bridge mode for repeaters
|
|
||||||
- [ ] Repeater/Bridge: Standardise the Transport Codes for zoning/filtering
|
|
||||||
- [X] Core + Repeater: enhanced zero-hop neighbour discovery
|
|
||||||
- [ ] Core: round-trip manual path support
|
|
||||||
- [ ] Companion + Apps: support for multiple sub-meshes (and 'off-grid' client repeat mode)
|
|
||||||
- [ ] Core + Apps: support for LZW message compression
|
|
||||||
- [ ] Core: dynamic CR (Coding Rate) for weak vs strong hops
|
|
||||||
- [ ] Core: new framework for hosting multiple virtual nodes on one physical device
|
|
||||||
- [ ] V2 protocol spec: discussion and consensus around V2 packet protocol, including path hashes, new encryption specs, etc
|
|
||||||
|
|
||||||
## 📞 Get Support
|
|
||||||
|
|
||||||
- Report bugs and request features on the [GitHub Issues](https://github.com/ripplebiz/MeshCore/issues) page.
|
|
||||||
- Find additional guides and components on [my site](https://buymeacoffee.com/ripplebiz).
|
|
||||||
- Join [MeshCore Discord](https://meshcore.gg) to chat with the developers and get help from the community.
|
|
||||||
|
|||||||
Reference in New Issue
Block a user