Add LED status

Improve gitignore Refactor WiFi part Add partitions scheme Add default config Add ZigBee menu Add ZigBee support

Author: alexbegoon

.gitignore

@@ -1,4 +1,25 @@
+.config
+*.o
+*.pyc
+
+.DS_Store
+.cache/
+
+.vscode/
+
+*.sublime-project
+*.sublime-workspace
+
 .idea
+cmake-build-*/
+
+*.swp
+*.swo
+
 /build/
 cmake-*
 /sdkconfig.old
+/sdkconfig
+dependencies.lock
+managed_components
+venv

CMakeLists.txt

@@ -2,5 +2,10 @@ cmake_minimum_required(VERSION 3.16)
 
 set(EXTRA_COMPONENT_DIRS vendor/esp-idf-lib/components)
 
+execute_process(COMMAND git rev-parse --short HEAD
+ OUTPUT_VARIABLE GIT_COMMIT_HASH
+ OUTPUT_STRIP_TRAILING_WHITESPACE)
+add_definitions(-DGIT_COMMIT_HASH="${GIT_COMMIT_HASH}")
+
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 project(xiao_esp32c6_wifi_sensor)

README.md

@@ -14,6 +14,7 @@
 - [Getting Started](#getting-started)
 - [Hardware](#hardware)
 - [Software](#software)
+- [ZigBee](#zigbee)
 - [Contributing](#contributing)
 - [License](#license)
 - [TODO](#todo)
@@ -31,6 +32,7 @@ The Smart IoT Sensor is a power-efficient device built using the [XIAO ESP32C6](
 - **Environmental Sensing**: Supports [Bosch BME280](https://www.bosch-sensortec.com/products/environmental-sensors/humidity-sensors-bme280/) and [BME680](https://www.bosch-sensortec.com/products/environmental-sensors/gas-sensors/bme680/) sensors for temperature, humidity, and pressure measurements.
 - **Power Management**: Efficiently manages power using LiPo batteries with built-in charge management.
 - **Deep Sleep Mode**: Extends battery life by enabling deep sleep between data transmissions.
+- **ZigBee Connectivity**: Seamless integration with ZigBee networks. Supports standard ZigBee clusters, easily pair your sensor with ZigBee coordinators like Home Assistant.
 - **Optional Features**:
  - Battery voltage monitoring
  - Connection duration tracking
@@ -313,6 +315,21 @@ Follow these steps to set up your Smart IoT Sensor:
  idf.py -p <TARGET_PORT> flash
  ```
 
+## ZigBee
+ZigBee can be activated in the menu:
+```bash
+idf.py menuconfig
+```
+Navigate to `XIAO Sensor Configuration` → `Select Sensor Connection Type` → `ZigBee`.
+
+Next, go to `Component config` → `Zigbee` → `Zigbee Enable` and set it to ON. Then, go to `XIAO Sensor Configuration` → `ZigBee Configuration` and set a `Sensor ID`.
+
+Build and flash the firmware. After that, the sensor will be ready and will begin commissioning.
+
+To add the sensor to Home Assistant: go to `Settings` → `Devices & Services` → `Devices` → `Add Device` → `Add Zigbee device`. Once completed, your sensor will appear on the Devices page:
+
+<img alt="SensorXIAO_zb_device.png" src="assets/SensorXIAO_zb_device.png" width="500"/>
+
 ## Contributing
 
 Contributions are welcome! Please follow these steps:

assets/SensorXIAO_zb_device.png

@@ -6,5 +6,7 @@ idf_component_register(SRCS
  "sensor_gpio.c"
  "sensor_adc.c"
  "sensor_bme.c"
+ "sensor_zb.c"
+ "sensor_led.c"
  INCLUDE_DIRS "."
 )

main/CMakeLists.txt

@@ -1,6 +1,25 @@
 menu "XIAO Sensor Configuration"
+ choice SENSOR_CONNECTION_TYPE
+ prompt "Select Sensor Connection Type"
+ default SENSOR_CONNECTION_WIFI_MQTT
+ help
+ Choose the type of sensor connection to use.
+ - **WiFi + MQTT**: WiFi and MQTT.
+ - **ZigBee**: ZigBee.
+
+ config SENSOR_CONNECTION_WIFI_MQTT
+ bool "WiFi + MQTT"
+ help
+ Enable WiFi and MQTT connection.
 
+ config SENSOR_CONNECTION_ZIGBEE
+ bool "ZigBee"
+ help
+ Enable ZigBee connection.
+
+ endchoice
  menu "Wi-Fi Configuration"
+ depends on SENSOR_CONNECTION_WIFI_MQTT
  config ESP_WIFI_SSID
  string "WiFi SSID"
  default "myssid"
@@ -112,6 +131,7 @@ menu "XIAO Sensor Configuration"
  endmenu
 
  menu "MQTT Configuration"
+ depends on SENSOR_CONNECTION_WIFI_MQTT
  config MQTT_BROKER_URI
  string "MQTT Broker URI"
  default "mqtt://192.168.1.100"
@@ -130,7 +150,7 @@ menu "XIAO Sensor Configuration"
  help
  MQTT topic for publishing sensor data.
 
- config MQTT_SENSOR_ID
+ config SENSOR_ID
  string "Sensor ID"
  default "7i29r9k9ltaxmbev"
  help
@@ -139,7 +159,7 @@ menu "XIAO Sensor Configuration"
  This ID is used to construct MQTT topics for publishing data.
 
  **Example:**
- If `MQTT_TOPIC` is set to "xiao/sensor" and `MQTT_SENSOR_ID` is "7i29r9k9ltaxmbev",
+ If `MQTT_TOPIC` is set to "xiao/sensor" and `SENSOR_ID` is "7i29r9k9ltaxmbev",
  the resulting MQTT topic for data will be:
  `xiao/sensor/7i29r9k9ltaxmbev/data`
 
@@ -202,6 +222,19 @@ menu "XIAO Sensor Configuration"
  Password for authenticating with the MQTT broker.
  endmenu
 
+ menu "ZigBee Configuration"
+ depends on SENSOR_CONNECTION_ZIGBEE
+ config SENSOR_ID
+ string "Sensor ID"
+ default "7i29r9k9ltaxmbev"
+ help
+ Unique identifier for the sensor.
+ config ZIGBEE_ANTENNA_EXTERNAL
+ bool "External Antenna"
+ help
+ Use an external antenna for ZigBee connectivity.
+ endmenu
+
  # Sensor Type Selection
  choice SENSOR_TYPE
  prompt "Select Sensor Type"

main/Kconfig.projbuild

@@ -0,0 +1,7 @@
+## IDF Component Manager Manifest File
+dependencies:
+ espressif/esp-zboss-lib: "~1.5.0"
+ espressif/esp-zigbee-lib: "~1.5.0"
+ ## Required IDF version
+ idf:
+ version: ">=5.3.1"

main/idf_component.yml

@@ -11,14 +11,25 @@
  */
 
 #include "sdkconfig.h"
-#include <cJSON.h>
+
 #include "sensor_nvs.h"
-#include "sensor_wifi.h"
-#include "sensor_mqtt.h"
 #include "sensor_gpio.h"
 #include "esp_sleep.h"
 #include "sys/time.h"
 
+#if !defined CONFIG_SENSOR_ID
+#error Define CONFIG_SENSOR_ID in idf.py menuconfig to compile source code.
+#endif
+
+#ifdef CONFIG_SENSOR_CONNECTION_WIFI_MQTT
+#include "sensor_wifi.h"
+#include "sensor_mqtt.h"
+#endif
+
+#ifdef CONFIG_SENSOR_CONNECTION_ZIGBEE
+#include "sensor_zb.h"
+#endif
+
 #ifdef CONFIG_ENABLE_BATTERY_CHECK
 #include "sensor_adc.h"
 #endif
@@ -34,15 +45,16 @@ float humidity = 0;
 float pressure = 0;
 
 void app_main(void) {
-
 #ifdef CONFIG_ENABLE_BATTERY_CHECK
  init_adc();
  get_battery_voltage(&battery_voltage);
  ESP_LOGI(TAG, "Battery Voltage: %.2f V", battery_voltage);
+ ESP_LOGI(TAG, "SW version: %s", GIT_COMMIT_HASH);
  deinit_adc();
 #endif
  init_nvs();
  init_gpio();
+ init_led();
 #ifndef CONFIG_SENSOR_NO_SENSOR
  init_bme();
  read_bme(&temperature, &humidity, &pressure);
@@ -51,59 +63,44 @@ void app_main(void) {
  struct timeval start_to_connect;
  gettimeofday(&start_to_connect, NULL);
 
+#ifdef CONFIG_SENSOR_CONNECTION_WIFI_MQTT
  init_wifi_sta();
  esp_mqtt_client_handle_t mqtt_client = init_mqtt_client();
+#endif
+
+#ifdef CONFIG_SENSOR_CONNECTION_ZIGBEE
+ init_zb();
+
+ start_zb();
+#endif
 
  struct timeval end_to_connect;
  gettimeofday(&end_to_connect, NULL);
 
+#ifdef CONFIG_SENSOR_CONNECTION_WIFI_MQTT
  int rssi = -100;
  esp_wifi_sta_get_rssi(&rssi);
  ESP_LOGI(TAG, "RSSI: %d", rssi);
 
- // Create cJSON object
- cJSON *json = cJSON_CreateObject();
- cJSON_AddStringToObject(json, "ID", CONFIG_MQTT_SENSOR_ID);
- cJSON_AddNumberToObject(json, "RSSI", rssi);
- cJSON_AddNumberToObject(json, "battery_voltage", battery_voltage);
-
- char temperature_str[16];
- snprintf(temperature_str, sizeof(temperature_str), "%.2f", temperature);
- cJSON_AddStringToObject(json, "temperature", temperature_str);
-
- char humidity_str[16];
- snprintf(humidity_str, sizeof(humidity_str), "%.2f", humidity);
- cJSON_AddStringToObject(json, "humidity", humidity_str);
+ char *json_string = (char *)malloc(MQTT_MSG_MAX_LEN * sizeof(char));
+ mqtt_prepare_json(json_string, rssi, battery_voltage, temperature, humidity, pressure, start_to_connect, end_to_connect);
 
- char pressure_str[16];
- snprintf(pressure_str, sizeof(pressure_str), "%.2f", pressure);
- cJSON_AddStringToObject(json, "pressure", pressure_str);
+ mqtt_publish(mqtt_client, json_string);
 
- cJSON_AddNumberToObject(json, "connection_duration_ms",
- (end_to_connect.tv_sec - start_to_connect.tv_sec) * 1000 +
- (end_to_connect.tv_usec - start_to_connect.tv_usec) / 1000);
-
- // Convert cJSON to string
- char *json_string = cJSON_PrintUnformatted(json);
-
- while (true) {
- mqtt_publish(mqtt_client, json_string);
-
- // Cleanup
- free(json_string);
- cJSON_Delete(json);
+ // Cleanup
+ free(json_string);
+#endif
 
-  int wakeup_time_sec = CONFIG_WAKEUP_TIME_SEC;
+ int wakeup_time_sec = CONFIG_WAKEUP_TIME_SEC;
 
-  if (wakeup_time_sec < 5 || wakeup_time_sec > 86400) {
-  ESP_LOGW(TAG, "Invalid WAKEUP_TIME_SEC: %d. Using default 300 seconds.", wakeup_time_sec);
-  wakeup_time_sec = 300;
-  }
+ if (wakeup_time_sec < 5 || wakeup_time_sec > 86400) {
+ ESP_LOGW(TAG, "Invalid WAKEUP_TIME_SEC: %d. Using default 300 seconds.", wakeup_time_sec);
+ wakeup_time_sec = 300;
+ }
 
-  ESP_LOGI(TAG, "Enabling timer wakeup, %ds\n", wakeup_time_sec);
-  ESP_ERROR_CHECK(esp_sleep_enable_timer_wakeup(wakeup_time_sec * 1000000));
+ ESP_LOGI(TAG, "Enabling timer wakeup, %ds\n", wakeup_time_sec);
+ ESP_ERROR_CHECK(esp_sleep_enable_timer_wakeup(wakeup_time_sec * 1000000));
 
- // enter deep sleep
- esp_deep_sleep_start();
- }
+ // Enter deep sleep
+ //esp_deep_sleep_start();
 }

main/main.c

@@ -66,6 +66,10 @@ void init_bme(void) {
  gpio_reset_pin(CONFIG_BME280_POWER_PIN);
  gpio_set_direction(CONFIG_BME280_POWER_PIN, GPIO_MODE_OUTPUT);
 
+ gpio_set_level(CONFIG_BME280_POWER_PIN, HIGH);
+ vTaskDelay(pdMS_TO_TICKS(100));
+ gpio_set_level(CONFIG_BME280_POWER_PIN, LOW);
+ vTaskDelay(pdMS_TO_TICKS(100));
  gpio_set_level(CONFIG_BME280_POWER_PIN, HIGH);
  ESP_LOGI(TAG, "BME280 powered on");
 

main/sensor_bme.c

@@ -15,7 +15,7 @@
 #define HIGH 1
 
 void init_gpio(void) {
-#ifdef CONFIG_WIFI_ANTENNA_EXTERNAL
+#if defined(CONFIG_WIFI_ANTENNA_EXTERNAL) || defined(CONFIG_ZIGBEE_ANTENNA_EXTERNAL)
  gpio_reset_pin(GPIO_NUM_3);
  gpio_set_direction(GPIO_NUM_3, GPIO_MODE_OUTPUT);
  gpio_set_level(GPIO_NUM_3, LOW);