Merge pull request #37 from Love4yzp/main

update indicator_lorawan README

Author: Love4yzp

CHANGELOG.md

@@ -11,11 +11,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
+## 2023-12-18                
+### Changed
+- Update indicator_lorawan demo README
+
+## 2023-12-15
+### Changed
+- File structure to dependent
+### Fixed
+- LoRaWAN frequency change rebooting
+
+## 2023-11-23
+### Changed
+-  Modify sdkconfig.defaults for lvgl,photo,squareline_demo
+### Added
+-  Add Project Share to README
+
 ## 2023-11-17
 ### Changed
 -  No longer need patching IDF (thx to Hermit from SqureLine Studio)
 -  Update README to compile with ESP-IDF v5.1.1
 
+## 2023-10-31
+### Added
+-  lorawan demo and fix bugs
+
 ## 2023-10-09
 ### Fixed
 - Connection bug in Home Assistant (dc0b8b7).

README.md

@@ -39,6 +39,7 @@ The project includes various examples that demonstrate how to effectively use ES
 - `lvgl_demos` Demonstrated some demos of lvgl.
 - `photo_demo` Demonstrates how to display a photo of yourself.
 - `squareline_demo` Demonstrates how to display the UI file exported by the squareline project.
+- `lorawan_demo` Demonstrates how to communicate using lorawan in SenseCAP Indicator.
 
 ## Usage
 

components/LoRaWAN/Kconfig.projbuild

@@ -1,4 +1,4 @@
-menu "LoRWAN"
+menu "LoRaWAN"
     menu "Enable built-in REGION"
         config REGION_EU868
             bool "Enable EU868"

examples/indicator_lorawan/README.md

@@ -1,31 +1,28 @@
-# Indicator Basis Demo
-
-This demo mainly implements time, sensor data display, and some configuration functions.
-
-<figure class="third">
-    <img src="./docs/page1.png" width="480"/> <img src="./docs/page2.png" width="480"/>
-    <img src="./docs/page3.png" width="480"/> <img src="./docs/page4.png" width="480"/>
-</figure>
-
-## Function
-- [x] Time display.
-- [x] CO2, tVOC, Temperature and Humidity data real-time display.
-- [x] CO2, tVOC, Temperature and Humidity history data display.
-- [x] Wifi config.
-- [x] Display config.
-- [x] time config.
-
-
-## How to use example
-
-Please first read the [User Guide](https://wiki.seeedstudio.com/SenseCAP_Indicator_Get_Started) of the SenseCAP Indicator Board to learn about its software and hardware information.
-
-
-### Build and Flash
-
-1. The project configure PSRAM with Octal 120M by default. please see [here](../../tools/patch/README.md#idf-patch) to enable `PSRAM Octal 120M` feature.
-2. Run `idf.py -p PORT flash monitor` to build, flash and monitor the project.
-
-(To exit the serial monitor, type ``Ctrl-]``.)
-
-See the [Getting Started Guide](https://docs.espressif.com/projects/esp-idf/en/latest/get-started/index.html) for full steps to configure and use ESP-IDF to build projects.
+# SenseCAP Indicator LoRaWAN Demo
+
+## Introduction
+The SenseCAP Indicator LoRaWAN Demo, developed for the ESP32 platform, showcases the application of LoRaWAN technology in environmental monitoring. It provides a user-friendly interface for managing LoRaWAN network connections and transmitting sensor data.
+
+## Usage
+![LoRaWAN Screen](./feature.png)
+The LoRaWAN screen is the user's gateway to control the device's network connection activities. It automates the connection to the LoRaWAN network and efficiently transmits captured sensor data.
+
+### Console Commands
+To adjust device settings, use the `lorawan` command in the console. This command allows you to set essential parameters like EUI, Join EUI, and App Key, crucial for connecting and authenticating your device with a LoRaWAN network.
+
+
+### Examples
+```sh
+lorawan --eui <Your_EUI> --join_eui <Your_Join_EUI> --app_key <Your_App_Key>
+```
+1. **Set EUI**:
+   ```sh
+   lorawan --eui 0004A30B001C0530
+   ```
+   This sets the EUI of your device.
+
+2. **Set Join EUI and App Key**:
+   ```sh
+   lorawan --join_eui 70B3D57ED0007E4A --app_key 8AFE71A145B253E49C3031AD06827777
+   ```
+   Use this to set the Join EUI and App Key for network authentication.

examples/indicator_lorawan/feature.png

@@ -331,7 +331,7 @@ int indicator_cmd_init(void)
     repl_config.max_cmdline_length = 1024;
 
     register_lorawan();
-    register_lorawan_test();
+    // register_lorawan_test();
 
     esp_console_dev_uart_config_t hw_config = ESP_CONSOLE_DEV_UART_CONFIG_DEFAULT();
     ESP_ERROR_CHECK(esp_console_new_repl_uart(&hw_config, &repl_config, &repl));