From d7a728c4985d1f3451d320b2c60ca3b94388b3db Mon Sep 17 00:00:00 2001 From: Lurkars Date: Wed, 15 Jul 2020 22:29:52 +0200 Subject: [PATCH] update README, renaming --- README.md | 20 +++++++++++++++++-- components/ena-interface/CMakeLists.txt | 6 +++--- ...ce-datetime.c => ena-interface-datetime.c} | 0 ...{interface-menu.c => ena-interface-menu.c} | 0 .../{interface.c => ena-interface.c} | 0 components/ena/CMakeLists.txt | 10 +++++----- components/ena/{beacons.c => ena-beacons.c} | 0 ...-advertise.c => ena-bluetooth-advertise.c} | 0 ...{bluetooth-scan.c => ena-bluetooth-scan.c} | 0 components/ena/{crypto.c => ena-crypto.c} | 0 components/ena/{storage.c => ena-storage.c} | 0 11 files changed, 26 insertions(+), 10 deletions(-) rename components/ena-interface/{interface-datetime.c => ena-interface-datetime.c} (100%) rename components/ena-interface/{interface-menu.c => ena-interface-menu.c} (100%) rename components/ena-interface/{interface.c => ena-interface.c} (100%) rename components/ena/{beacons.c => ena-beacons.c} (100%) rename components/ena/{bluetooth-advertise.c => ena-bluetooth-advertise.c} (100%) rename components/ena/{bluetooth-scan.c => ena-bluetooth-scan.c} (100%) rename components/ena/{crypto.c => ena-crypto.c} (100%) rename components/ena/{storage.c => ena-storage.c} (100%) diff --git a/README.md b/README.md index 6fba69d..bd5d8fb 100644 --- a/README.md +++ b/README.md @@ -101,11 +101,27 @@ E (909164) BT_HCI: btu_hcif_hdl_command_complete opcode 0x2005 status 0xc ## Structure -The project is divided in different files -* *ena-beacon* handles scanned data by storing temporary beacons, check for threshold and store beacons permanently +The project is divided in different components + +### ena + +The ena module contains the main functions of eps-ena with bluetooth scanning and adverting, storing data and handle beacons. +* *ena-beacons* handles scanned data by storing temporary beacons, check for threshold and store beacons permanently * *ena-crypto* covers cryptography part (key creation, encryption etc.) * *ena-storage* storage part to store own TEKs and beacons * *ena-bluetooth-scan* BLE scans for detecting other beacons * *ena-bluetooth-advertise* BLE advertising to send own beacons * *ena* run all together and timing for scanning and advertising * *main* start and run main program + +### ena-interface + +Adds interface functionality via touch pads for control and setup. + +### i2c-main + +Just start I2C driver for display and RTC. + +### ssd1306 + +I2C driver for a SSD1306 display. \ No newline at end of file diff --git a/components/ena-interface/CMakeLists.txt b/components/ena-interface/CMakeLists.txt index c5cd82b..41e429a 100644 --- a/components/ena-interface/CMakeLists.txt +++ b/components/ena-interface/CMakeLists.txt @@ -1,8 +1,8 @@ idf_component_register( SRCS - "interface.c" - "interface-datetime.c" - "interface-menu.c" + "ena-interface.c" + "ena-interface-datetime.c" + "ena-interface-menu.c" INCLUDE_DIRS "include" PRIV_REQUIRES ena diff --git a/components/ena-interface/interface-datetime.c b/components/ena-interface/ena-interface-datetime.c similarity index 100% rename from components/ena-interface/interface-datetime.c rename to components/ena-interface/ena-interface-datetime.c diff --git a/components/ena-interface/interface-menu.c b/components/ena-interface/ena-interface-menu.c similarity index 100% rename from components/ena-interface/interface-menu.c rename to components/ena-interface/ena-interface-menu.c diff --git a/components/ena-interface/interface.c b/components/ena-interface/ena-interface.c similarity index 100% rename from components/ena-interface/interface.c rename to components/ena-interface/ena-interface.c diff --git a/components/ena/CMakeLists.txt b/components/ena/CMakeLists.txt index 05fcd90..efcf715 100644 --- a/components/ena/CMakeLists.txt +++ b/components/ena/CMakeLists.txt @@ -1,11 +1,11 @@ idf_component_register( SRCS - "beacons.c" - "bluetooth-advertise.c" - "bluetooth-scan.c" - "crypto.c" "ena.c" - "storage.c" + "ena-beacons.c" + "ena-bluetooth-advertise.c" + "ena-bluetooth-scan.c" + "ena-crypto.c" + "ena-storage.c" INCLUDE_DIRS "include" PRIV_REQUIRES spi_flash diff --git a/components/ena/beacons.c b/components/ena/ena-beacons.c similarity index 100% rename from components/ena/beacons.c rename to components/ena/ena-beacons.c diff --git a/components/ena/bluetooth-advertise.c b/components/ena/ena-bluetooth-advertise.c similarity index 100% rename from components/ena/bluetooth-advertise.c rename to components/ena/ena-bluetooth-advertise.c diff --git a/components/ena/bluetooth-scan.c b/components/ena/ena-bluetooth-scan.c similarity index 100% rename from components/ena/bluetooth-scan.c rename to components/ena/ena-bluetooth-scan.c diff --git a/components/ena/crypto.c b/components/ena/ena-crypto.c similarity index 100% rename from components/ena/crypto.c rename to components/ena/ena-crypto.c diff --git a/components/ena/storage.c b/components/ena/ena-storage.c similarity index 100% rename from components/ena/storage.c rename to components/ena/ena-storage.c