Merge pull request #1 from SimLinkModule/example_blehr

Example blehr

Author: fabiankuffer

.gitignore

@@ -1,3 +1,2 @@
 build/
-sdkconfig
-sdkconfig.old
+sdkconfig

.vscode/settings.json

@@ -3,6 +3,12 @@
     "idf.port": "/dev/ttyUSB0",
     "idf.flashType": "UART",
     "files.associations": {
-        "regex": "cpp"
+        "regex": "cpp",
+        "random": "c",
+        "array": "c",
+        "string": "c",
+        "string_view": "c",
+        "ble_svc_gap.h": "c",
+        "console.h": "c"
     }
 }

CMakeLists.txt

@@ -1,8 +1,6 @@
-# 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
+# The following 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.5)
 
 include($ENV{IDF_PATH}/tools/cmake/project.cmake)
-project(SimLinkSoftware)
+project(blehr)

Makefile

@@ -0,0 +1,8 @@
+#
+# This is a project Makefile. It is assumed the directory this Makefile resides in is a
+# project subdirectory.
+#
+
+PROJECT_NAME := blehr
+
+include $(IDF_PATH)/make/project.mk

components/nimble_peripheral_utils/CMakeLists.txt

@@ -0,0 +1,3 @@
+idf_component_register(SRCS "misc.c" "scli.c"
+                       INCLUDE_DIRS "."
+                       PRIV_REQUIRES bt console driver)

components/nimble_peripheral_utils/esp_peripheral.h

@@ -0,0 +1,29 @@
+/*
+ * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
+
+#ifndef H_ESP_PERIPHERAL_
+#define H_ESP_PERIPHERAL_
+
+#include <stdbool.h>
+#include "nimble/ble.h"
+#include "modlog/modlog.h"
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Console */
+int scli_init(void);
+int scli_receive_key(int *key);
+
+/** Misc. */
+void print_bytes(const uint8_t *bytes, int len);
+void print_addr(const void *addr);
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

components/nimble_peripheral_utils/misc.c

@@ -0,0 +1,30 @@
+/*
+ * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
+
+#include "esp_peripheral.h"
+
+/**
+ * Utility function to log an array of bytes.
+ */
+void
+print_bytes(const uint8_t *bytes, int len)
+{
+    int i;
+
+    for (i = 0; i < len; i++) {
+        MODLOG_DFLT(INFO, "%s0x%02x", i != 0 ? ":" : "", bytes[i]);
+    }
+}
+
+void
+print_addr(const void *addr)
+{
+    const uint8_t *u8p;
+
+    u8p = addr;
+    MODLOG_DFLT(INFO, "%02x:%02x:%02x:%02x:%02x:%02x",
+                u8p[5], u8p[4], u8p[3], u8p[2], u8p[1], u8p[0]);
+}

components/nimble_peripheral_utils/scli.c

@@ -0,0 +1,146 @@
+/*
+ * SPDX-FileCopyrightText: 2021-2022 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Unlicense OR CC0-1.0
+ */
+
+#include <stdio.h>
+#include <ctype.h>
+#include "esp_log.h"
+#include <string.h>
+#include <esp_log.h>
+#include <esp_console.h>
+#include <freertos/FreeRTOS.h>
+#include <freertos/task.h>
+#include <freertos/queue.h>
+#include <driver/uart.h>
+#include "esp_peripheral.h"
+
+#define BLE_RX_TIMEOUT (30000 / portTICK_PERIOD_MS)
+
+static TaskHandle_t cli_task;
+static QueueHandle_t cli_handle;
+static int stop;
+
+static int enter_passkey_handler(int argc, char *argv[])
+{
+    int key;
+    char pkey[8];
+    int num;
+
+    if (argc != 2) {
+        return -1;
+    }
+
+    sscanf(argv[1], "%s", pkey);
+    ESP_LOGI("You entered", "%s %s", argv[0], argv[1]);
+    num = pkey[0];
+
+    if (isalpha(num)) {
+        if ((strcasecmp(pkey, "Y") == 0) || (strcasecmp(pkey, "Yes") == 0)) {
+            key = 1;
+            xQueueSend(cli_handle, &key, 0);
+        } else {
+            key = 0;
+            xQueueSend(cli_handle, &key, 0);
+        }
+    } else {
+        sscanf(pkey, "%d", &key);
+        xQueueSend(cli_handle, &key, 0);
+    }
+
+    return 0;
+}
+
+int scli_receive_key(int *console_key)
+{
+    return xQueueReceive(cli_handle, console_key, BLE_RX_TIMEOUT);
+}
+
+static esp_console_cmd_t cmds[] = {
+    {
+        .command = "key",
+        .help = "",
+        .func = enter_passkey_handler,
+    },
+};
+
+static int ble_register_cli(void)
+{
+    int cmds_num = sizeof(cmds) / sizeof(esp_console_cmd_t);
+    int i;
+    for (i = 0; i < cmds_num; i++) {
+        esp_console_cmd_register(&cmds[i]);
+    }
+    return 0;
+}
+
+static void scli_task(void *arg)
+{
+    int uart_num = (int) arg;
+    uint8_t linebuf[256];
+    int i, cmd_ret;
+    esp_err_t ret;
+    QueueHandle_t uart_queue;
+    uart_event_t event;
+
+    uart_driver_install(uart_num, 256, 0, 8, &uart_queue, 0);
+    /* Initialize the console */
+    esp_console_config_t console_config = {
+        .max_cmdline_args = 8,
+        .max_cmdline_length = 256,
+    };
+
+    esp_console_init(&console_config);
+
+    while (!stop) {
+        i = 0;
+        memset(linebuf, 0, sizeof(linebuf));
+        do {
+            ret = xQueueReceive(uart_queue, (void * )&event, (TickType_t)portMAX_DELAY);
+            if (ret != pdPASS) {
+                if (stop == 1) {
+                    break;
+                } else {
+                    continue;
+                }
+            }
+            if (event.type == UART_DATA) {
+                while (uart_read_bytes(uart_num, (uint8_t *) &linebuf[i], 1, 0)) {
+                    if (linebuf[i] == '\r') {
+                        uart_write_bytes(uart_num, "\r\n", 2);
+                    } else {
+                        uart_write_bytes(uart_num, (char *) &linebuf[i], 1);
+                    }
+                    i++;
+                }
+            }
+        } while ((i < 255) && linebuf[i - 1] != '\r');
+        if (stop) {
+            break;
+        }
+        /* Remove the truncating \r\n */
+        linebuf[strlen((char *)linebuf) - 1] = '\0';
+        ret = esp_console_run((char *) linebuf, &cmd_ret);
+        if (ret < 0) {
+            break;
+        }
+    }
+    vTaskDelete(NULL);
+}
+
+int scli_init(void)
+{
+    /* Register CLI "key <value>" to accept input from user during pairing */
+    ble_register_cli();
+
+    xTaskCreate(scli_task, "scli_cli", 4096, (void *) 0, 3, &cli_task);
+    if (cli_task == NULL) {
+        return ESP_FAIL;
+    }
+    cli_handle = xQueueCreate( 1, sizeof(int) );
+    if (cli_handle == NULL) {
+        return ESP_FAIL;
+    }
+    return ESP_OK;
+}

docs/infos

@@ -0,0 +1,7 @@
+Linux reicht es wenn irgendwie viel bytes im report sind, welches zum gerät geschickt wird.
+Windows und Android muss die report größe mit der größe des report deskriptors übereinstimmen.
+IOS benötigt eine sichere Verbindung und dann noch die erlaubnis auf das report zuzugreifen wenn es eine sichere verbindung ist. Zusätzlich darf während dem aufbau einer sicheren verbindung keine connection updates durchgeführt werden.
+
+Zusätzlich muss für ios die irk key von ios geräten zwischengespeichert werden, da nach einen neustart des ios geräts oder alle x minuten die bluetooth adresse erneurt wird und sonst das gerät sich nicht mehr mit dem esp verbinden kann.
+
+Resolvable private (RPA) --> Address randomly generated from an identity address and an identity resolving key (IRK).

docs/links

@@ -0,0 +1,8 @@
+mynewt.apache.org/latest/network/ble_hs/ble_att.html
+docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/bluetooth/nimble.index.html
+https://iotespresso.com/esp32-nimble-how-to-send-notifications/
+https://embeddedartistry.com/blog/2017/05/01/mixing-c-and-c-extern-c/
+
+
+// USE LINUX TOOL FOR HID PROFILE --> SONST FUNKTIONIERT ES NICHT
+//https://macchina.io/blog/internet-of-things/communication-with-low-energy-bluetooth-devices-on-linux/