Move project configurations to Kconfig.projbuild file

Project configurations can be set using ESP IDF's menuconfig command
Improve variable names for better understanding
Improve logging

Author: nipunchamikara

.gitignore

@@ -2,5 +2,6 @@
 build
 cmake-build-debug
 sdkconfig
+sdkconfig.old
 dependencies.lock
 .clang-format

Makefile

@@ -40,6 +40,10 @@ clean: ## Clean the project
 	. $(IDF_PATH)/export.sh && \
         idf.py clean
 
+configure: ## Open the IDF menuconfig
+	. $(IDF_PATH)/export.sh && \
+        idf.py menuconfig
+
 full-clean: ## Clean the project and the build directory
 	. $(IDF_PATH)/export.sh && \
         idf.py fullclean

README.md

@@ -38,10 +38,31 @@ These ports can be found by running the following in the terminal:
 ls /dev/tty*
 ```
 
-To build and flash the firmware to the ESP32 devices, use the following commands:
+First, install and configure ESP-IDF:
 
 ```sh
 make install
+```
+
+Before building and flashing, configure the project:
+
+```sh
+make configure
+```
+
+The following configuration options are available specific to the project under the `Project Configuration` menu:
+
+- Total Devices: The total number of ESP32 devices in the network.
+- Set Device ID?: Boolean value whether to set the device ID or not. If checked, the device ID can be set.
+- Device ID: The device ID of the ESP32 device. This is only available if `Set Device ID?` is checked.
+- Less Interference Channel: The channel with less interference. This is the channel that the ESP32 devices will use
+  for communication.
+- Send Frequency: The frequency at which the ESP32 devices send packets to each other.
+- Timeout: The number of frequency cycles before the next device sends a packet again.
+
+To build and flash the firmware to the ESP32 devices, use the following commands:
+
+```sh
 make build
 make flash DEVICE=<device_id>
 make monitor DEVICE=<device_id>
@@ -50,9 +71,6 @@ make monitor DEVICE=<device_id>
 Replace `<device_id>` with the device ID of the ESP32 device you want to flash. The device ID should be an integer.
 If the device ID is not specified, the default device ID is 0.
 
-If the device is being flash for the first time, set the `DEFAULT_DEVICE_ID` variable in the `constants.h` file to the
-device ID of the device being flashed.
-
 To flash the firmware and then monitor the serial output, use:
 
 ```sh

main/Kconfig.projbuild

@@ -0,0 +1,41 @@
+menu "Project Configuration"
+    config TOTAL_DEVICES
+        int "Total Devices"
+        default 1
+        help
+            Total number of ESP32 devices in the network.
+
+    config IS_SET_DEVICE_ID
+        bool "Set Device ID?"
+        default "n"
+        help
+            Whether to set the device ID of the ESP32 to a specific value.
+
+    config DEVICE_ID
+        depends on IS_SET_DEVICE_ID
+        int "Device ID"
+        default 0
+        range 0 TOTAL_DEVICES
+        help
+            The device ID of the ESP32. This is a unique integer value that identifies the device in the network.
+            The range of the device ID is from 0 to TOTAL_DEVICES - 1.
+
+    config LESS_INTERFERENCE_CHANNEL
+        int "Less Interference Channel"
+        default 11
+        range 1 13
+        help
+            Channel number to be used for Wi-Fi. This is the channel number that has the least interference in the area.
+
+    config SEND_FREQUENCY
+        int "Send Frequency"
+        default 25
+        help
+            Frequency at which the device sends data to the server in Hertz.
+
+    config CYCLE_TIMEOUT
+        int "Cycle Timeout"
+        default 10
+        help
+            Timeout for receiving packet from previous device in frequency cycles.
+endmenu

main/app_main.c

@@ -16,16 +16,16 @@
 /**
  * Returns the number of devices between the current and last device IDs.
  * @param device_id The current device ID.
- * @param last_id The last device ID.
+ * @param previous_packet_device_id The previous packet sender device ID.
  * @return The number of devices between the current and last device IDs.
  */
-uint8_t turns_away(const uint8_t device_id, const uint8_t last_id) {
+uint8_t turns_away(const uint8_t device_id, const uint8_t previous_packet_device_id) {
   // device 2, last device 0, 2 - 0 = 2
-  if (device_id > last_id) {
-    return device_id - last_id;
+  if (device_id > previous_packet_device_id) {
+    return device_id - previous_packet_device_id;
   }
   // device 0, last device 2, 3 - 2 + 0 = 1
-  return TOTAL_DEVICES - last_id + device_id;
+  return CONFIG_TOTAL_DEVICES - previous_packet_device_id + device_id;
 }
 
 void app_main() {
@@ -37,10 +37,12 @@ void app_main() {
   }
   ESP_ERROR_CHECK(ret);
 
-  // Get the device ID from NVS or set the default ID
+#if CONFIG_IS_SET_DEVICE_ID
+  store_device_id(CONFIG_DEVICE_ID);
+#endif
+
   payload.device_id = get_device_id();
-  ESP_LOGI(TAG, "Device ID: %d", payload.device_id);
-  last_id = (payload.device_id + TOTAL_DEVICES - 1) % TOTAL_DEVICES;
+  prev_packet_device_id = (payload.device_id + CONFIG_TOTAL_DEVICES - 1) % CONFIG_TOTAL_DEVICES;
 
   // Initialize the payload length and index
   payload.csi_data_arr_len = 0;
@@ -75,10 +77,10 @@ void app_main() {
 
     // Determine the multiplier based on the distance between the current and last device IDs
     // This multiplier is used to increase the timeout count for devices further away
-    const int multiplier = turns_away(payload.device_id, last_id);
+    const int multiplier = turns_away(payload.device_id, prev_packet_device_id);
 
     // If the timeout count exceeds the timeout threshold, send CSI data
-    if (timeout_count >= TIMEOUT * multiplier * multiplier) {
+    if (timeout_count >= CONFIG_CYCLE_TIMEOUT * multiplier * multiplier) {
       ESP_LOGW(TAG, "ESP-NOW Timeout %d", timeout_count);
       send_csi_data(last_time_index++);
       timeout_count = 0;

main/app_nvs.c

@@ -18,7 +18,7 @@ void store_device_id(const uint8_t device_id) {
   ESP_ERROR_CHECK(nvs_set_u8(nvs_handle, "device_id", device_id));
   ESP_ERROR_CHECK(nvs_commit(nvs_handle));
   nvs_close(nvs_handle);
-  ESP_LOGI(TAG, "Device ID stored: %d", device_id);
+  ESP_LOGI(TAG, "Setting device ID to %d", device_id);
 }
 
 uint8_t get_device_id() {
@@ -27,11 +27,10 @@ uint8_t get_device_id() {
   uint8_t device_id;
   const esp_err_t ret = nvs_get_u8(nvs_handle, "device_id", &device_id);
   if (ret == ESP_ERR_NVS_NOT_FOUND) {
-    ESP_LOGI(TAG, "Device ID not found, setting default ID: %d", DEFAULT_DEVICE_ID);
-    store_device_id(DEFAULT_DEVICE_ID);
-  } else {
-    ESP_LOGI(TAG, "Device ID found: %d", device_id);
+    ESP_LOGI(TAG, "Device ID of device has not been set. Shutting down...");
+    esp_restart();
   }
+  ESP_LOGI(TAG, "Using device ID %d", device_id);
   nvs_close(nvs_handle);
   return device_id;
 }

main/constants.h

@@ -1,16 +1,11 @@
 #ifndef CONSTANTS_H
 #define CONSTANTS_H
 
-#define CONFIG_LESS_INTERFERENCE_CHANNEL 11
-#define CONFIG_SEND_FREQUENCY 25
-#define TOTAL_DEVICES 4
-#define DEFAULT_DEVICE_ID 2
-#define TIMEOUT 10
 #define MICROSECONDS_IN_SECOND 1000000
 #define BROADCAST_ADDR {0xff, 0xff, 0xff, 0xff, 0xff, 0xff}
 #define TAG "csi_send_recv"
 #define CSI_DATA_LENGTH 256
-#define CSI_DATA_ARR_LEN 4
+#define CSI_DATA_ARR_LEN CONFIG_TOTAL_DEVICES
 #define ORG_ID {0x18, 0xfe, 0x34}
 #define PAYLOAD_MAGIC_NUMBER {0x0F, 0xA7, 0x5A, 0x09}
 

main/csi_data.c

@@ -10,7 +10,7 @@
 
 payload_t payload;
 
-uint8_t last_id;
+uint8_t prev_packet_device_id;
 
 uint16_t last_time_index;
 
@@ -100,7 +100,7 @@ void wifi_csi_rx_cb(void *ctx, wifi_csi_info_t *info) {
   }
 
   // Check if the device ID is valid
-  if (p->device_id >= TOTAL_DEVICES)
+  if (p->device_id >= CONFIG_TOTAL_DEVICES)
     return;
 
   if (payload.device_id != 0) {
@@ -133,13 +133,13 @@ void wifi_csi_rx_cb(void *ctx, wifi_csi_info_t *info) {
   if (payload.device_id == 0)
     print_payload(p);
 
-  last_id = p->device_id;
+  prev_packet_device_id = p->device_id;
   last_time_index = p->time_index;
   timeout_count = 0;
   payload.csi_data_arr_len = min(payload.csi_data_arr_len + 1, CSI_DATA_ARR_LEN - 1);
   payload_index++;
 
-  if (payload.device_id == (p->device_id + 1) % TOTAL_DEVICES) {
+  if (payload.device_id == (p->device_id + 1) % CONFIG_TOTAL_DEVICES) {
     // Print payload of sent packet if current device is the first device
     if (payload.device_id == 0)
       print_payload(&payload);

main/csi_data.h

@@ -40,7 +40,7 @@ extern payload_t payload;
 /**
  * The last device ID from which CSI data was received.
  */
-extern uint8_t last_id;
+extern uint8_t prev_packet_device_id;
 
 /**
  * The time index of the last received CSI data.

sdkconfig.defaults

@@ -17,3 +17,9 @@ CONFIG_ESP_TASK_WDT_TIMEOUT_S=30
 
 CONFIG_ESPTOOLPY_MONITOR_BAUD_921600B=y
 CONFIG_ESPTOOLPY_MONITOR_BAUD=921600
+
+#
+# ESP-IDF Project Configuration
+#
+CONFIG_TOTAL_DEVICES=4
+CONFIG_DEVICE_ID=0