Implement dynamic neighbors count (#69)

* Duplicate `rafting-button` project

* Remove README description

* Update SDK config file for new SDK version

* Define SDK path

* Define project goal

* Describe implementation plan

* Preload more files

* Fix typo

* Change device IDs

* Update header file definition

* Update check neighbor calculation

* Update `espnow_data_parser`

* Update `espnow_data_prepare` function

* Update sending callback processing

* Map related files

* Define header for `get_message_type` function

* Commented code related to NEIGHBORS message type

* Add `espnow` word into workspace dictionary

* Allocate memory for `espnow_send_neighbor_param_t`

* Implement function `espnow_data_neighbor_prepare` to prepare data

* Implement send info about inactive device

* Implement function to get neighbor check number

* Implement function for sending neighbor message

* Implement espnow_data_neighbor_parse function

* Implement parsing incoming NEIGHBORS message

* Rename send_neighbor_message to send_neighbor_message_to_all

* Implement response for HELLO_DS message

* Add task as a note

* Remove neighbor handling in standard case cycle

* Implement dynamic neighbor for all functions

* Fix pointer typing error

* Add C associations file

* Unify `espnow_data_parse` function header

* Fix struct pointer problem

* Fix struct name bug

* Fix passing parameter

* Fix passing parameter

* Add missing esp_err_t ret variable

* Fix do not free using memory

* Remove epoch message skipper

* Define SDK version & debug stackoverflow

* Restore new header definition

* Fix stack size problem

* Remove old README file

* Update README file

* Optimised images with calibre/image-actions

---------

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

Author: petrkucerak

code/README.md

@@ -2,6 +2,7 @@ Softwarová implementace.
 
 ## Seznam projektů
 
+- `dynamic-neighbors` - implementac v rámci předmětu DSV, která umožňuje dynamický počet sousedů
 - `esp-now-parameters` - měření latence ESP-NOW na ESP32
 - `hello-world` - testovací kód na ESP32S2
 - `measure-esp-now` - měření síťové infratruktury na ESP32S2

code/dynamic-neighbors/.gitignore

@@ -0,0 +1,30 @@
+.vscode/*
+doc/html/*
+doc/latex/*
+# Created by https://www.toptal.com/developers/gitignore/api/cmake
+# Edit at https://www.toptal.com/developers/gitignore?templates=cmake
+
+### CMake ###
+CMakeLists.txt.user
+CMakeCache.txt
+CMakeFiles
+CMakeScripts
+Testing
+Makefile
+cmake_install.cmake
+install_manifest.txt
+compile_commands.json
+CTestTestfile.cmake
+_deps
+build/
+
+### CMake Patch ###
+# External projects
+*-prefix/
+
+## ESP-IDF
+*.old
+dependencies.lock
+managed_components
+
+# End of https://www.toptal.com/developers/gitignore/api/cmake

code/dynamic-neighbors/CMakeLists.txt

@@ -0,0 +1,8 @@
+# For more information about build system see
+# https://docs.espressif.com/projects/esp-idf/en/latest/api-guides/build-system.html
+# The following five lines of boilerplate have to be in your project's
+# CMakeLists in this exact order for cmake to work correctly
+cmake_minimum_required(VERSION 3.16)
+
+include($ENV{IDF_PATH}/tools/cmake/project.cmake)
+project(rafting-button)

code/dynamic-neighbors/README.md

@@ -0,0 +1,74 @@
+# Hlasovací zařízení řešící koncenzus v distribuovaném systému
+
+> [!NOTE]
+> Generovano pomoc chatGPT z report.pdf
+
+## Úvod
+
+Cílem projektu bylo zrobustnit algoritmus, který obsluhuje distribuovanou síť tvořenou hlasovacími zařízeními. Konkrétně bylo cílem ošetřit chybové stavy a navrhnout a implementovat přístup, který zajistí, že v síti bude moci být připojeno 1–N zařízení.
+
+Síť je postavena na zařízeních ESP32, která jsou propojena pomocí protokolu ESP-NOW. Tento protokol spojuje horních pět vrstev OSI modelu do jedné, zvané ESP-NOW. Protokol má určité limity, jako je počet sousedů (maximálně 20 nešifrovaných) a velikost zprávy (maximálně 250 B). Tyto limity bylo nutné zohlednit při návrhu a implementaci.
+
+
+## Algoritmus a implementace
+
+Algoritmus tvoří tři základní komponenty: 
+
+1. Registrace zařízení do distribuované sítě (DS)
+2. Běžný chod a terminace zařízení
+3. Synchronizace času, distribuce logů a seznamu zařízení
+
+### Registrace zařízení
+
+Po spuštění zařízení odešle broadcast zprávu typu `HELLO_DS`. Ostatní zařízení v síti si jej přidají do seznamu sousedů a odešlou zprávu typu `NEIGHBOURS` s informacemi o DS (např. ID epochy). Pokud zařízení obdrží více než polovinu odpovědí, přechází do další fáze – běžného chodu DS.
+
+### Běžný chod
+
+Každá epocha má dvě fáze:
+
+1. **Volba lídra**: Probíhá podobně jako v algoritmu Raft. Lídr synchronizuje čas pomocí zpráv typu `TIME`. Pokud zařízení neobdrží zprávu do určitého timeoutu, spustí nové volby.
+2. **Běžný provoz**: Lídr distribuuje logy, seznamy sousedů a synchronizační zprávy. Pokud dojde k selhání zařízení, uživatel je informován o stavu.
+
+#### Role zařízení
+
+- **Lídr (MASTER)**: Rozesílá logy, seznamy sousedů a synchronizuje čas.
+- **Následovník (SLAVE)**: Pasivní zařízení.
+- **Kandidát**: Přechodná role během volby lídra.
+
+### Terminace zařízení
+
+Zařízení, které nepřijme více než tři zprávy úspěšně, je označeno jako neaktivní a terminováno z DS. Tato informace je poté rozeslána do celé sítě.
+
+### Přizpůsobení dynamickému počtu sousedů
+
+- **Ukládání dat**: Použit statický způsob ukládání sousedů (20 × 16 bytes) kvůli menší chybovosti a nižší výpočetní zátěži.
+- **Struktura packetu**: Přidán checksum typu `uint32_t`, reprezentující stav sousedů.
+- **Nový typ zprávy**: Zpráva obsahující seznam sousedů rozdělena na dvě části kvůli limitu velikosti zprávy.
+
+![Ukázka testování provozu](measure-set.jpg)
+
+
+## Spuštění kódu
+
+Pro spuštění kódu je třeba mít nainstalovaný framework `esp-idf`.
+
+```bash
+# Klonování repozitáře esp-idf
+git clone https://github.com/espressif/esp-idf.git
+# Přepnutí na vhodný release (testováno na v5.4)
+cd esp-idf
+./install.bat  # Nebo jiný vhodný instalátor pro použitý systém
+```
+
+### Kompilace a flashování
+
+Pro kompilaci a flashování kódu:
+
+```bash
+idf.py reconfigure  # Stažení a instalace komponent ESP-NOW
+idf.py build
+idf.py flash
+idf.py monitor
+```
+
+Doporučuje se nastavit automatické spuštění exportu. Při použití připraveného VSCode prostředí a správné konfiguraci cesty k esp-idf knihovně se export spustí automaticky při otevření terminálu.

code/dynamic-neighbors/components/espnow_utils/CMakeLists.txt

@@ -0,0 +1,3 @@
+idf_component_register(SRCS "espnow_utils.c"
+                    INCLUDE_DIRS "."
+                    REQUIRES esp_wifi esp_wifi peripheral)

code/dynamic-neighbors/components/espnow_utils/espnow_utils.c

@@ -0,0 +1,93 @@
+/**
+ * @file espnow_utils.c
+ * @brief Contains supported functions for the ESP-NOW protocol.
+ * @details This file provides functions for initializing and deinitializing
+ * ESP-NOW, initializing Wi-Fi, printing the device's MAC address, and comparing
+ * MAC addresses.
+ * @version 1.0
+ * @date 2023-06-08
+ * @author Petr Kucera ([email protected])
+ *
+ * @note This code is subject to the terms of the MIT license.
+ *
+ */
+
+#include "espnow_utils.h"
+#include "peripheral.h"
+#include <esp_log.h>
+#include <esp_mac.h>
+#include <esp_now.h>
+#include <esp_wifi.h>
+#include <freertos/FreeRTOS.h>
+#include <freertos/task.h>
+
+#define TRUE 1
+#define FALSE 0
+
+static const char *TAG = "ESPNOW_UTILS";
+
+void wifi_init(void)
+{
+   // 1. Initialize TCP/IP stack layer
+   ESP_ERROR_CHECK(esp_netif_init());
+
+   // 2. Create a loop for system tasks like Wi-Fi
+   ESP_ERROR_CHECK(esp_event_loop_create_default());
+
+   // 3. Initialize Wi-Fi with default configuration
+   wifi_init_config_t cfg = WIFI_INIT_CONFIG_DEFAULT();
+   ESP_ERROR_CHECK(esp_wifi_init(&cfg));
+
+   // 4. Set storage
+   ESP_ERROR_CHECK(esp_wifi_set_storage(WIFI_STORAGE_RAM));
+
+   // 5. Set current WiFi power save type
+   ESP_ERROR_CHECK(esp_wifi_set_ps(WIFI_PS_NONE));
+
+   // 6. Set Wi-Fi mode
+   ESP_ERROR_CHECK(esp_wifi_set_mode(WIFI_MODE_STA));
+   ESP_ERROR_CHECK(esp_wifi_start());
+   // ESP_ERROR_CHECK(esp_wifi_set_channel())
+}
+
+esp_err_t custom_espnow_init(void)
+{
+   // Initialize ESP-NOW
+   ESP_ERROR_CHECK(esp_now_init());
+
+   return ESP_OK;
+}
+
+esp_err_t custom_espnow_deinit(void)
+{
+   ESP_ERROR_CHECK(esp_now_deinit());
+
+   return ESP_OK;
+}
+
+void print_mac_address()
+{
+   uint8_t mac_addr[6];
+   ESP_ERROR_CHECK(esp_read_mac(mac_addr, ESP_MAC_BASE));
+   ESP_LOGI(TAG, "Device MAC address is: " MACSTR "\n", MAC2STR(mac_addr));
+}
+
+uint8_t is_device_mac(uint8_t *mac_addr)
+{
+   uint8_t tmp[6];
+   ESP_ERROR_CHECK(esp_read_mac(tmp, ESP_MAC_BASE));
+   for (uint8_t i = 0; i < 6; ++i) {
+      if (tmp[i] != mac_addr[i])
+         return FALSE;
+   }
+   return TRUE;
+}
+
+uint8_t is_same_mac(uint8_t *mac_1, uint8_t *mac_2)
+{
+   for (uint8_t i = 0; i < ESP_NOW_ETH_ALEN; ++i) {
+      if (mac_1[i] != mac_2[i])
+         return FALSE;
+   }
+   return TRUE;
+}

code/dynamic-neighbors/components/espnow_utils/espnow_utils.h

@@ -0,0 +1,64 @@
+/**
+ * @file espnow_utils.h
+ * @brief Contains functions for working with the ESP-NOW protocol.
+ * @details This file provides functions for initializing and deinitializing
+ * ESP-NOW, initializing Wi-Fi for ESP-NOW, printing the device's MAC address,
+ * and comparing MAC addresses.
+ * @version 1.0
+ * @date 2023-06-08
+ * @author Petr Kucera ([email protected])
+ *
+ * @note This code is subject to the terms of the MIT license.
+ *
+ */
+
+#ifndef ESPNOW_UTILS_H
+#define ESPNOW_UTILS_H
+
+#include "peripheral.h"
+#include <esp_now.h>
+#include <esp_types.h>
+#include <esp_wifi.h>
+#include <freertos/FreeRTOS.h>
+#include <freertos/task.h>
+
+/**
+ * @brief Initializes Wi-Fi for ESP-NOW.
+ */
+void wifi_init(void);
+
+/**
+ * @brief Initializes ESP-NOW.
+ * @return esp_err_t The result of the initialization.
+ */
+esp_err_t custom_espnow_init(void);
+
+/**
+ * @brief Deinitializes ESP-NOW.
+ * @return esp_err_t The result of the deinitialization.
+ */
+esp_err_t custom_espnow_deinit(void);
+
+/**
+ * @brief Prints the MAC address of the device.
+ */
+void print_mac_address();
+
+/**
+ * @brief Compares the device's MAC address with the provided address.
+ * @param mac_addr The MAC address to compare with the device's address.
+ * @return uint8_t Logic value indicating if the addresses match (1 - true, 0 -
+ * false).
+ */
+uint8_t is_device_mac(uint8_t *mac_addr);
+
+/**
+ * @brief Compares two MAC addresses.
+ * @param mac_1 The first MAC address to compare.
+ * @param mac_2 The second MAC address to compare.
+ * @return uint8_t Logic value indicating if the addresses match (1 - true, 0 -
+ * false).
+ */
+uint8_t is_same_mac(uint8_t *mac_1, uint8_t *mac_2);
+
+#endif // ESPNOW_UTILS_H

code/dynamic-neighbors/components/peripheral/CMakeLists.txt

@@ -0,0 +1,3 @@
+idf_component_register(SRCS "peripheral.c"
+                    INCLUDE_DIRS "."
+                    REQUIRES driver)

code/dynamic-neighbors/components/peripheral/peripheral.c

@@ -0,0 +1,81 @@
+/**
+ * @file peripheral.c
+ * @brief Contains functions for basic manipulation with peripherals.
+ * @version 1.0
+ * @date 2023-06-08
+ * @author Petr Kucera ([email protected])
+ *
+ * @note This code is subject to the terms of the MIT license.
+ *
+ */
+
+#include "peripheral.h"
+#include <driver/gpio.h>
+#include <freertos/FreeRTOS.h>
+#include <freertos/task.h>
+#include <stdio.h>
+
+void config_led(gpio_num_t gpio_num)
+{
+   // Set up GPIO direction as output
+   gpio_set_direction(gpio_num, GPIO_MODE_OUTPUT);
+}
+
+void turn_on_led(gpio_num_t gpio_num)
+{
+   // Set GPIO output level to HIGH (1)
+   gpio_set_level(gpio_num, 1);
+}
+
+void turn_off_led(gpio_num_t gpio_num)
+{
+   // Set GPIO output level to LOW (0)
+   gpio_set_level(gpio_num, 0);
+}
+
+void turn_on_buildin_led()
+{
+   gpio_set_direction(GPIO_NUM_2, GPIO_MODE_OUTPUT);
+   gpio_set_level(GPIO_NUM_2, 1);
+}
+
+void turn_off_buildin_led() { gpio_set_level(GPIO_NUM_2, 0); }
+
+void do_blink_task(uint16_t mils)
+{
+   config_led(GPIO_NUM_23);
+   turn_on_led(GPIO_NUM_23);
+   turn_on_buildin_led();
+
+   vTaskDelay(mils / portTICK_PERIOD_MS);
+
+   turn_off_led(GPIO_NUM_23);
+   turn_off_buildin_led();
+
+   vTaskDelete(NULL);
+}
+
+void do_blink(uint16_t mils)
+{
+   turn_on_led(GPIO_NUM_23);
+   turn_on_buildin_led();
+
+   vTaskDelay(mils / portTICK_PERIOD_MS);
+
+   turn_off_led(GPIO_NUM_23);
+   turn_off_buildin_led();
+}
+
+void turn_on_led_task(gpio_num_t gpio_num)
+{
+   turn_on_buildin_led();
+   turn_on_led(gpio_num);
+   vTaskDelete(NULL);
+}
+
+void turn_off_led_task(gpio_num_t gpio_num)
+{
+   turn_off_buildin_led();
+   turn_off_led(gpio_num);
+   vTaskDelete(NULL);
+}