Merge pull request #64 from thatliuser/cleanup

Cleanup code and GitHub Actions

.clang-format

@@ -1 +1,11 @@
-{ BasedOnStyle: LLVM, UseTab: Never, IndentWidth: 4, TabWidth: 4, BreakBeforeBraces: Allman, AllowShortIfStatementsOnASingleLine: false, IndentCaseLabels: false, ColumnLimit: 0, AccessModifierOffset: -4, NamespaceIndentation: All, FixNamespaceComments: false }
+BasedOnStyle: LLVM
+UseTab: Never
+IndentWidth: 4
+TabWidth: 4
+BreakBeforeBraces: Allman
+AllowShortIfStatementsOnASingleLine: false
+IndentCaseLabels: false
+ColumnLimit: 0
+AccessModifierOffset: -4
+NamespaceIndentation: All
+FixNamespaceComments: false

.github/workflows/build.yml

@@ -0,0 +1,18 @@
+name: Compile check
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v4
+    - name: Polyfill AWS certificates
+      run: |
+        cd components/ClientComponent/
+        touch ca.crt client.crt client.key aws.url
+    - name: Build ESP-IDF project
+      uses: espressif/esp-idf-ci-action@v1
+      with:
+        esp_idf_version: v5.3.1
+        target: esp32

.github/workflows/format.yml

@@ -0,0 +1,16 @@
+name: Format check
+on: [push]
+
+jobs:
+  format-check:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Run clang-format
+      uses: DoozyX/[email protected]
+      with:
+        source: 'components main'
+        exclude: 'managed_components components/hx711'
+        clangFormatVersion: 18
+        style: file
+

.gitignore

@@ -14,4 +14,6 @@ components/ClientComponent/aws.url
 components/ClientComponent/ca.crt
 components/ClientComponent/client.crt
 components/ClientComponent/client.key
-
+dependencies.lock
+sdkconfig*
+!sdkconfig.defaults

components/ClientComponent/Serialize.cpp

@@ -1,23 +1,27 @@
 #include "Serialize.hpp"
 #include <esp_mac.h>
 
-cJSON* Client::serialize(float fullness, uint32_t usage, bool overflow, int32_t weight) {
+cJSON *Client::serialize(float fullness, uint32_t usage, bool overflow, int32_t weight)
+{
     // Use the ESP32's MAC address as a UUID (since it is a UUID)
     uint8_t mac_addr_arr[6];
     uint64_t mac_addr;
-    if (esp_base_mac_addr_get(mac_addr_arr) != ESP_OK) {
+    if (esp_base_mac_addr_get(mac_addr_arr) != ESP_OK)
+    {
         // TODO: Handle mac address being unset properly
         mac_addr = 0x112233445566;
-    } else {
+    }
+    else
+    {
         mac_addr =
-            ((uint64_t)mac_addr_arr[5] <<  0) |
-            ((uint64_t)mac_addr_arr[4] <<  8) |
+            ((uint64_t)mac_addr_arr[5] << 0) |
+            ((uint64_t)mac_addr_arr[4] << 8) |
             ((uint64_t)mac_addr_arr[3] << 16) |
             ((uint64_t)mac_addr_arr[2] << 24) |
             ((uint64_t)mac_addr_arr[1] << 32) |
             ((uint64_t)mac_addr_arr[0] << 40);
     }
-    cJSON* root = cJSON_CreateObject();
+    cJSON *root = cJSON_CreateObject();
     cJSON_AddNumberToObject(root, "bin_id", mac_addr);
     cJSON_AddNumberToObject(root, "fullness", fullness);
     cJSON_AddNumberToObject(root, "usage", usage);

components/ClientComponent/include/Client.hpp

@@ -1,7 +1,7 @@
 #ifndef CLIENT_HPP
 #define CLIENT_HPP
 
-#include <stdint.h>
+#include <stddef.h>
 
 namespace Client
 {

components/ClientComponent/include/Credentials.hpp

@@ -5,12 +5,12 @@
 // To make sure compilation succeeds, ensure ca.crt, client.crt, aws.url and client.key exist!
 // https://docs.espressif.com/projects/esp-idf/en/stable/esp32/api-guides/build-system.html#embedding-binary-data
 // AWS root CA certificate
-extern const uint8_t AWS_CA_CRT[]      asm("_binary_ca_crt_start");
+extern const uint8_t AWS_CA_CRT[] asm("_binary_ca_crt_start");
 // Device-local certificate
-extern const uint8_t AWS_CLIENT_CRT[]  asm("_binary_client_crt_start");
+extern const uint8_t AWS_CLIENT_CRT[] asm("_binary_client_crt_start");
 // Device-local private key
-extern const uint8_t AWS_CLIENT_KEY[]  asm("_binary_client_key_start");
+extern const uint8_t AWS_CLIENT_KEY[] asm("_binary_client_key_start");
 // URL of AWS endpoint
-extern const uint8_t AWS_URL[]         asm("_binary_aws_url_start");
+extern const uint8_t AWS_URL[] asm("_binary_aws_url_start");
 
 #endif

components/ClientComponent/include/Serialize.hpp

@@ -4,7 +4,8 @@
 #include <cJSON.h>
 #include <stdint.h>
 
-namespace Client {
+namespace Client
+{
     /*
      * @brief Serialize data from sensors for API interaction.
      *
@@ -19,7 +20,7 @@ namespace Client {
      *
      * @return cJSON* root of a JSON object containing sensor data. Make sure to free this after you are done using it.
      */
-    cJSON* serialize(float fullness, uint32_t usage, bool overflow, int32_t weight);
+    cJSON *serialize(float fullness, uint32_t usage, bool overflow, int32_t weight);
 }
 
 #endif

components/FullnessComponent/include/FullnessMetric.hpp

@@ -11,8 +11,8 @@
 
 #include "IDistance.hpp"
 #include <array>
-#include <cstdint>
 #include <cstddef>
+#include <cstdint>
 
 namespace Fullness
 {

components/TaskComponent/cameraTask.cpp

@@ -79,8 +79,6 @@ static camera_config_t camera_config = {
     // CAM_PIN_PWDN
     // .pin_reset = CAM_PIN_RESET,
 
-
-
     .pin_pwdn = CAM_PIN_PWDN,
     .pin_reset = CAM_PIN_RESET,
     .pin_xclk = CAM_PIN_XCLK,
@@ -164,8 +162,6 @@ void buffer_to_string(uint8_t *buffer, size_t buffer_length, char *output, size_
     // snprintf(output + pos, output_size - pos, "]");
 }
 
-
-
 static esp_err_t init_camera(void)
 {
     // initialize the camera
@@ -194,20 +190,15 @@ void CameraTask::taskFunction(void *task)
     CameraTask *cameraTask = static_cast<CameraTask *>(task);
     cameraTask->setup();
     cameraTask->loop();
-
 }
 
 void CameraTask::setup()
 {
 }
 
-
-
 void CameraTask::loop()
 {
 
-
-
     //  xTaskCreatePinnedToCore(taskFunction, mName, mStackSize, this, mPriority, nullptr, 1);
     gpio_reset_pin(flashPIN);
     gpio_set_direction(flashPIN, GPIO_MODE_OUTPUT);
@@ -235,8 +226,6 @@ void CameraTask::loop()
 
     Client::clientPublishStr("Started Camera");
 
-
-
     sensor_t *s = esp_camera_sensor_get();
     if (s != NULL)
 
@@ -250,8 +239,6 @@ void CameraTask::loop()
         Client::clientPublishStr("Adjusted Camera");
     }
 
-
-
     camera_fb_t *fb = NULL;
     while (1)
 
@@ -282,5 +269,4 @@ void CameraTask::loop()
         }
         vTaskDelay(33 / portTICK_PERIOD_MS);
     }
-
 }

components/TaskComponent/clientTask.cpp

@@ -10,7 +10,7 @@ static const char *name = "clientTask";
 static const int priority = 1;
 static const uint32_t stackSize = 4096;
 
-ClientTask::ClientTask(QueueHandle_t &messageQueue): Task(name, priority, stackSize)
+ClientTask::ClientTask(QueueHandle_t &messageQueue) : Task(name, priority, stackSize)
 {
 }
 

components/TaskComponent/fullnessTask.cpp

@@ -2,7 +2,6 @@
 #include "FullnessMetric.hpp"
 #include "esp_log.h"
 
-
 using namespace Zotbins;
 
 static const char *name = "fullnessTask";

components/TaskComponent/include/cameraTask.hpp

@@ -9,12 +9,12 @@
 #ifndef CAMERA_TASK_HPP
 #define CAMERA_TASK_HPP
 
-#include "task.hpp"
+#include "driver/gpio.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
-#include "freertos/task.h"
 #include "freertos/semphr.h"
-#include "driver/gpio.h"
+#include "freertos/task.h"
+#include "task.hpp"
 
 namespace Zotbins
 {

components/TaskComponent/include/clientTask.hpp

@@ -9,10 +9,10 @@
 #ifndef CLIENT_TASK_HPP
 #define CLIENT_TASK_HPP
 
-#include "task.hpp"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
 #include "freertos/task.h"
+#include "task.hpp"
 
 namespace Zotbins
 {
@@ -57,7 +57,6 @@ namespace Zotbins
          *
          */
         void loop();
-
     };
 }
 

components/TaskComponent/include/fullnessTask.hpp

@@ -9,10 +9,10 @@
 #ifndef FULLNESS_TASK_HPP
 #define FULLNESS_TASK_HPP
 
-#include "task.hpp"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
 #include "freertos/task.h"
+#include "task.hpp"
 
 namespace Zotbins
 {

components/TaskComponent/include/servoTask.hpp

@@ -9,10 +9,10 @@
 #ifndef SERVO_TASK_HPP
 #define SERVO_TASK_HPP
 
-#include "task.hpp"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
 #include "freertos/task.h"
+#include "task.hpp"
 
 namespace Zotbins
 {

components/TaskComponent/include/task.hpp

@@ -51,7 +51,7 @@ namespace Zotbins
          *
          */
         const int mPriority;
-        
+
         /**
          * @brief Task size of task
          *

components/TaskComponent/include/usageTask.hpp

@@ -9,12 +9,12 @@
 #ifndef USAGE_TASK_HPP
 #define USAGE_TASK_HPP
 
-#include "task.hpp"
+#include "driver/gpio.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
-#include "freertos/task.h"
 #include "freertos/semphr.h"
-#include "driver/gpio.h"
+#include "freertos/task.h"
+#include "task.hpp"
 
 namespace Zotbins
 {
@@ -67,7 +67,6 @@ namespace Zotbins
          */
         QueueHandle_t &mMessageQueue;
         gpio_num_t DETECT_PIN = GPIO_NUM_16;
-
     };
 }
 

components/TaskComponent/include/weightTask.hpp

@@ -9,10 +9,10 @@
 #ifndef WEIGHT_TASK_HPP
 #define WEIGHT_TASK_HPP
 
-#include "task.hpp"
 #include "freertos/FreeRTOS.h"
 #include "freertos/queue.h"
 #include "freertos/task.h"
+#include "task.hpp"
 
 namespace Zotbins
 {

components/TaskComponent/servoTask.cpp

@@ -1,20 +1,20 @@
 #include "servoTask.hpp"
+#include "driver/mcpwm_prelude.h"
+#include "esp_log.h"
 #include "freertos/FreeRTOS.h"
 #include "freertos/task.h"
-#include "esp_log.h"
-#include "driver/mcpwm_prelude.h"
 
 using namespace Zotbins;
 
 // Please consult the datasheet of your servo before changing the following parameters
 #define SERVO_MIN_PULSEWIDTH_US 500  // Minimum pulse width in microsecond
-#define SERVO_MAX_PULSEWIDTH_US 2500  // Maximum pulse width in microsecond
-#define SERVO_MIN_DEGREE        -90   // Minimum angle
-#define SERVO_MAX_DEGREE        90    // Maximum angle
+#define SERVO_MAX_PULSEWIDTH_US 2500 // Maximum pulse width in microsecond
+#define SERVO_MIN_DEGREE -90         // Minimum angle
+#define SERVO_MAX_DEGREE 90          // Maximum angle
 
-#define SERVO_PULSE_GPIO             15        // GPIO connects to the PWM signal line
-#define SERVO_TIMEBASE_RESOLUTION_HZ 1000000  // 1MHz, 1us per tick
-#define SERVO_TIMEBASE_PERIOD        20000    // 20000 ticks, 20ms
+#define SERVO_PULSE_GPIO 15                  // GPIO connects to the PWM signal line
+#define SERVO_TIMEBASE_RESOLUTION_HZ 1000000 // 1MHz, 1us per tick
+#define SERVO_TIMEBASE_PERIOD 20000          // 20000 ticks, 20ms
 
 static inline uint32_t example_angle_to_compare(int angle)
 {
@@ -49,7 +49,7 @@ void ServoTask::setup() // TODO: could refactor into setup later but there are a
 
 void ServoTask::loop()
 {
-        ESP_LOGI(name, "Create timer and operator");
+    ESP_LOGI(name, "Create timer and operator");
     mcpwm_timer_handle_t timer = NULL;
     mcpwm_timer_config_t timer_config = {
         .group_id = 0,
@@ -74,8 +74,7 @@ void ServoTask::loop()
     mcpwm_comparator_config_t comparator_config = {
         .flags = {
             .update_cmp_on_tez = true,
-        }
-    };
+        }};
     ESP_ERROR_CHECK(mcpwm_new_comparator(oper, &comparator_config, &comparator));
 
     mcpwm_gen_handle_t generator = NULL;
@@ -101,12 +100,14 @@ void ServoTask::loop()
 
     int angle = 0;
     int step = 2;
-    while (1) {
+    while (1)
+    {
         ESP_LOGI(name, "Angle of rotation: %d", angle);
         ESP_ERROR_CHECK(mcpwm_comparator_set_compare_value(comparator, example_angle_to_compare(angle)));
-        //Add delay, since it takes time for servo to rotate, usually 200ms/60degree rotation under 5V power supply
+        // Add delay, since it takes time for servo to rotate, usually 200ms/60degree rotation under 5V power supply
         vTaskDelay(pdMS_TO_TICKS(500));
-        if ((angle + step) > 60 || (angle + step) < -60) {
+        if ((angle + step) > 60 || (angle + step) < -60)
+        {
             step *= -1;
         }
         angle += step;