Merge branch 'master' of github.com:badgeteam/hackerhotel-2024-firmwa…

…re-esp32c6

components/badge-communication/CMakeLists.txt

@@ -1,5 +1,5 @@
 idf_component_register(
-        SRCS "badge_comms.c" "ieee802154.c"
+        SRCS "badge-communication.c" "ieee802154.c"
         INCLUDE_DIRS "include"
         PRIV_INCLUDE_DIRS "priv_include"
         REQUIRES

components/badge-communication/badge_comms.c → components/badge-communication/badge-communication.c

@@ -1,12 +1,15 @@
-#include "badge_comms.h"
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2024 Hugo Trippaers
+
+#include "badge-communication.h"
 #include "esp_check.h"
 #include "esp_err.h"
 #include "esp_ieee802154.h"
 #include "esp_log.h"
 #include "esp_mac.h"
 #include "freertos/portmacro.h"
 #include "freertos/semphr.h"
-#include "ieee802154_header.h"
+#include "ieee802154.h"
 #include "memory.h"
 
 static const char* TAG = "badge_comms";
@@ -108,7 +111,8 @@ void badge_comms_send_message(badge_comms_message_t* comms_message) {
 
     ieee802154_address_t src = {
         .mode         = ADDR_MODE_LONG,
-        .long_address = {eui64[0], eui64[1], eui64[2], eui64[3], eui64[4], eui64[5], eui64[6], eui64[7]}};
+        .long_address = {eui64[0], eui64[1], eui64[2], eui64[3], eui64[4], eui64[5], eui64[6], eui64[7]}
+    };
 
     ieee802154_address_t dst = {.mode = ADDR_MODE_SHORT, .short_address = TargetAddress};
 

components/badge-communication/ieee802154.c

@@ -1,19 +1,8 @@
-// Copyright [2024] [Hugo Trippaers]
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//        http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2024 Hugo Trippaers
 
+#include "ieee802154.h"
 #include "esp_log.h"
-#include "ieee802154_header.h"
 #include <stdbool.h>
 #include <string.h>
 
@@ -46,7 +35,8 @@ uint8_t ieee802154_header(
             .informationElementsPresent = false,
             .destAddrType               = dst->mode,
             .frameVer                   = FRAME_VERSION_STD_2003,
-            .srcAddrType                = src->mode};
+            .srcAddrType                = src->mode
+    };
 
     bool src_present     = src != NULL && src->mode != ADDR_MODE_NONE;
     bool dst_present     = dst != NULL && dst->mode != ADDR_MODE_NONE;

components/badge-communication/include/badge_messages.h → components/badge-communication/include/badge-communication-protocol.h

@@ -1,6 +1,8 @@
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2024 Hugo Trippaers
+
 #pragma once
 
-#include "badge_messages.h"
 #include "freertos/FreeRTOS.h"
 
 #define nicknamelength 32

components/badge-communication/include/badge_comms.h → components/badge-communication/include/badge-communication.h

@@ -1,6 +1,9 @@
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2024 Hugo Trippaers
+
 #pragma once
 
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
 #include "esp_err.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"

components/badge-communication/priv_include/ieee802154_header.h → components/badge-communication/priv_include/ieee802154.h

@@ -1,16 +1,5 @@
-// Copyright [2024] [Hugo Trippaers]
-//
-// Licensed under the Apache License, Version 2.0 (the "License");
-// you may not use this file except in compliance with the License.
-// You may obtain a copy of the License at
-//
-//        http://www.apache.org/licenses/LICENSE-2.0
-//
-// Unless required by applicable law or agreed to in writing, software
-// distributed under the License is distributed on an "AS IS" BASIS,
-// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-// See the License for the specific language governing permissions and
-// limitations under the License.
+// SPDX-License-Identifier: MIT
+// SPDX-FileCopyrightText: 2024 Hugo Trippaers
 
 #pragma once
 

components/badge-communication/readme.md

@@ -8,7 +8,7 @@ This component wraps the communication to a pub-sub like model.
 ### message types
 
 a message type is like the 'topic' of a pub-sub model, which identifies the contents should be read.
-these message types are defined in the struct `badge_comms_message_type_t`, which is found in `badge_messages.h`.
+these message types are defined in the struct `badge_comms_message_type_t`, which is found in `badge-communication-protocol.h`.
 
 ### listeners
 
@@ -30,7 +30,7 @@ this function broadcasts a message to all nearby bodges.
 ## adding a new message type
 
 a new feature might require a new message type.
-to add a message type goto `badge_comms_message_type_t` in `badge_messages.h`, and add a new message.
+to add a message type goto `badge_comms_message_type_t` in `badge-communication-protocol.h`, and add a new message.
 the message type should be assigned a number, this to make it explicitly clear what the message identifier are.
 
 now that we have a message type, we need a struct to define how and what data is sent.

main/application.c

@@ -1,6 +1,6 @@
 #include "application.h"
 #include "application_settings.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
 #include "bsp.h"
 #include "driver/dedic_gpio.h"
 #include "driver/gpio.h"

main/main.c

@@ -1,6 +1,6 @@
 #include "application.h"
-#include "badge_comms.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
+#include "badge-communication.h"
 #include "bsp.h"
 #include "driver/dedic_gpio.h"
 #include "driver/gpio.h"

main/modules/screen_battleship.c

@@ -1,7 +1,7 @@
 #include "screen_battleship.h"
 #include "application.h"
-#include "badge_comms.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
+#include "badge-communication.h"
 #include "bsp.h"
 #include "esp_err.h"
 #include "esp_log.h"
@@ -182,7 +182,8 @@ void AddShiptoBuffer(int _shiplenght, int _shiporientation, int _x, int _y) {
         {11 + 16 * (_shiplenght - 1), 0},
         {5 + 16 * (_shiplenght - 1), 7},
         {11 + 16 * (_shiplenght - 1), 1},
-        {16, 0}};
+        {16, 0}
+    };
 
     // diagonal ship coordonates orientation southeasty
     int od[10][2] = {
@@ -195,7 +196,8 @@ void AddShiptoBuffer(int _shiplenght, int _shiporientation, int _x, int _y) {
         {6, -6},
         {9 + 8 * (_shiplenght - 1), 2 + 15 * (_shiplenght - 1)},
         {6 + 8 * (_shiplenght - 1), 11 + 15 * (_shiplenght - 1)},
-        {-3 + 8 * (_shiplenght - 1), 8 + 15 * (_shiplenght - 1)}};
+        {-3 + 8 * (_shiplenght - 1), 8 + 15 * (_shiplenght - 1)}
+    };
 
     switch (_shiporientation) {
         case west:

main/modules/screen_billboard.c

@@ -1,5 +1,5 @@
 #include "application.h"
-#include "badge_comms.h"
+#include "badge-communication.h"
 #include "bsp.h"
 #include "esp_err.h"
 #include "esp_log.h"

main/modules/screen_hangman.c

@@ -1,7 +1,7 @@
 #include "screen_hangman.h"
 #include "application.h"
-#include "badge_comms.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
+#include "badge-communication.h"
 #include "bsp.h"
 #include "esp_err.h"
 #include "esp_log.h"
@@ -195,7 +195,8 @@ static const char* const victorian_words[] = {
     "Vapour",
     "Wireless",
     "Withal",
-    "Workhouse"};
+    "Workhouse"
+};
 static const char* const victorian_definitions[] = {
     "Home, a place where you live. ",
     "To take leave, to disappear.",
@@ -368,7 +369,8 @@ static const char* const victorian_definitions[] = {
     "An institution set up to look after the poor, disabled or old who cannot sustain themselves. Conditions were "
     "deliberately below what the lowest paid labourer could expect in order to 'encourage' poor people to work. People "
     "in the workhouse often lived in harsh conditions and many people would rather die than go there. More were built "
-    "after the 1834 Poor Law. "};
+    "after the 1834 Poor Law. "
+};
 // real data
 #if (release_type == production)
 static const char* const english_words[] = {

main/modules/screen_home.c

@@ -1,6 +1,6 @@
 #include "screen_home.h"
 #include "application.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
 #include "bsp.h"
 #include "coprocessor.h"
 #include "esp_err.h"

main/modules/screen_pointclick.c

@@ -1,6 +1,6 @@
 #include "screen_pointclick.h"
 #include "application.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
 #include "bsp.h"
 #include "esp_err.h"
 #include "esp_log.h"

main/modules/screen_repertoire.c

@@ -1,7 +1,7 @@
 #include "screen_repertoire.h"
 #include "application.h"
-#include "badge_comms.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
+#include "badge-communication.h"
 #include "bsp.h"
 #include "esp_err.h"
 #include "esp_ieee802154.h"

main/modules/screen_scrambled.c

@@ -1,7 +1,7 @@
 #include "screen_scrambled.h"
 #include "application.h"
-#include "badge_comms.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
+#include "badge-communication.h"
 #include "bsp.h"
 #include "esp_err.h"
 #include "esp_log.h"

main/modules/screen_settings.c

@@ -1,7 +1,7 @@
 #include "screen_settings.h"
 #include "application.h"
-#include "badge_comms.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
+#include "badge-communication.h"
 #include "bsp.h"
 #include "esp_err.h"
 #include "esp_log.h"

main/modules/screen_template.c

@@ -1,6 +1,6 @@
 #include "application.h"
-#include "badge_comms.h"
-#include "badge_messages.h"
+#include "badge-communication-protocol.h"
+#include "badge-communication.h"
 #include "bsp.h"
 #include "esp_err.h"
 #include "esp_log.h"