tesla ble 4.0 (#41)

* move log.cpp from esphome-tesla-ble into tesla-ble

* feat: Add `Vehicle` class to manage Tesla BLE communication, command queuing, and authentication, supported by new adapter interfaces.

* feat(logging): Introduce logging framework with log levels and adapters

* add line number parameter to log functions for better traceability

* sort and reorganize imports

* feat(vehicle): Enhance command processing for wake commands and improve logging on timeouts

* bump to v4.0.0

Author: yoziru

CMakeLists.txt

@@ -9,8 +9,11 @@ set(TESLABLE_SRCS
     "src/errors.cpp"
     "src/message_builders.cpp"
     "src/peer.cpp"
+    "src/tb_logging.cpp"
     "src/tb_utils.cpp"
+    "src/vehicle.cpp"
     "src/vin_utils.cpp"
+    "src/logging_bridge.cpp"
 )
 
 # Protobuf generated source files
@@ -30,9 +33,12 @@ set(TESLABLE_PROTO_SRCS
 # Public headers
 set(TESLABLE_PUBLIC_HEADERS
     include/client.h
+    include/adapters.h
     include/errors.h
     include/peer.h
+    include/tb_logging.h
     include/tb_utils.h
+    include/vehicle.h
     include/vin_utils.h
 )
 
@@ -104,7 +110,7 @@ else()
 
     include(FetchContent)
     project(TeslaBLE
-            VERSION 3.4.0
+            VERSION 4.0.0
             DESCRIPTION "CPP Tesla BLE Library"
             LANGUAGES CXX C
     )

idf_component.yml

@@ -1,4 +1,4 @@
-version: "3.4.0"
+version: "4.0.0"
 description: "C++ library for Tesla BLE API communication"
 url: "https://github.com/yoziru/tesla-ble"
 dependencies:

include/adapters.h

@@ -0,0 +1,79 @@
+#pragma once
+
+#include <string>
+#include <vector>
+#include <cstdint>
+
+namespace TeslaBLE {
+
+/**
+ * @brief Abstract interface for BLE operations.
+ * 
+ * Platforms (ESPHome, Python/Bleak) must implement this to handle
+ * low-level BLE communication.
+ */
+class BleAdapter {
+public:
+    virtual ~BleAdapter() = default;
+
+    /**
+     * @brief Connect to a specific BLE device.
+     * @param address The MAC address or identifier of the device.
+     */
+    virtual void connect(const std::string& address) = 0;
+
+    /**
+     * @brief Disconnect from the current device.
+     */
+    virtual void disconnect() = 0;
+
+    /**
+     * @brief Write data to the vehicle.
+     * 
+     * The implementation should handle writing to the correct RX characteristic
+     * of the Tesla service.
+     * 
+     * @param data The raw bytes to send.
+     * @return true if written successfully (enqueued), false otherwise.
+     */
+    virtual bool write(const std::vector<uint8_t>& data) = 0;
+
+    // Callbacks for data reception and connection state should be handled 
+    // by registering the Vehicle instance with the platform's BLE handler,
+    // or by the platform calling Vehicle::on_rx_data().
+};
+
+/**
+ * @brief Abstract interface for persistent storage.
+ * 
+ * Used to securely store session keys, counters, and tokens.
+ */
+class StorageAdapter {
+public:
+    virtual ~StorageAdapter() = default;
+
+    /**
+     * @brief Load a value from storage.
+     * @param key The unique key identifier.
+     * @param buffer Output buffer to store the loaded data.
+     * @return true if found and loaded, false otherwise.
+     */
+    virtual bool load(const std::string& key, std::vector<uint8_t>& buffer) = 0;
+
+    /**
+     * @brief Save a value to storage.
+     * @param key The unique key identifier.
+     * @param buffer The data to save.
+     * @return true if saved successfully, false otherwise.
+     */
+    virtual bool save(const std::string& key, const std::vector<uint8_t>& buffer) = 0;
+
+    /**
+     * @brief Remove a value from storage.
+     * @param key The unique key identifier.
+     * @return true if removed successfully, false otherwise.
+     */
+    virtual bool remove(const std::string& key) = 0;
+};
+
+} // namespace TeslaBLE

include/defs.h

@@ -1,44 +1,36 @@
 #pragma once
 
-#ifdef ESP_PLATFORM
-
-#ifndef LOG_LOCAL_LEVEL
-#define LOG_LOCAL_LEVEL ESP_LOG_DEBUG
+#ifndef TESLA_LOG_TAG
+#define TESLA_LOG_TAG "TeslaBLE"
 #endif
-#include "esp_log.h"
-static const char *const TAG = "tesla_ble";
-#define LOG(...) ESP_LOGI(TAG, __VA_ARGS__)
-#define LOG_INFO(...) ESP_LOGI(TAG, __VA_ARGS__)
-#define LOG_DEBUG(...) ESP_LOGD(TAG, __VA_ARGS__)
-#define LOG_ERROR(...) ESP_LOGE(TAG, __VA_ARGS__)
-#define LOG_WARNING(...) ESP_LOGW(TAG, __VA_ARGS__)
-
-#else
-
-#include <cstdio>
-#include <cstring>
-#include <iostream>
-
-#define RESET_COLOR "\x1B[0m"
-#define INFO_COLOR "\x1B[1;34m"
-#define DEBUG_COLOR "\x1B[1;30m"
-#define WARNING_COLOR "\x1B[1;33m"
-#define ERROR_COLOR "\x1B[31m"
-#define LOG(...) log("[LOG]", RESET_COLOR, __VA_ARGS__)
-#define LOG_INFO(...) log("[INFO]", INFO_COLOR, __VA_ARGS__)
-#define LOG_DEBUG(...) log("[DEBUG]", DEBUG_COLOR, __VA_ARGS__)
-#define LOG_WARNING(...) log("[WARNING]", WARNING_COLOR, __VA_ARGS__)
-#define LOG_ERROR(...) log("[ERROR]", ERROR_COLOR, __VA_ARGS__)
-template <typename... Args>
-void log(const char *type, const char *color, const char *s, Args... args)
-{
-    printf("%s%s - ", color, type);
-    if constexpr (sizeof...(args) > 0) {
-        printf(s, args...);
-    } else {
-        printf("%s", s);
-    }
-    printf("%s\n", RESET_COLOR);
-}
 
+#include <cstdarg>
+#include "adapters.h"
+
+#ifdef ESP_PLATFORM
+#include <esp_log.h>
 #endif
+
+namespace TeslaBLE {
+
+enum class LogLevel {
+    ERROR,
+    WARN,
+    INFO,
+    DEBUG,
+    VERBOSE
+};
+
+typedef void (*LogCallback)(LogLevel level, const char* tag, int line, const char* format, va_list args);
+
+extern LogCallback g_log_callback;
+
+void log_internal(LogLevel level, const char* tag, int line, const char* format, ...);
+
+} // namespace TeslaBLE
+
+#define LOG_ERROR(format, ...)   TeslaBLE::log_internal(TeslaBLE::LogLevel::ERROR, TESLA_LOG_TAG, __LINE__, format, ##__VA_ARGS__)
+#define LOG_WARNING(format, ...) TeslaBLE::log_internal(TeslaBLE::LogLevel::WARN, TESLA_LOG_TAG, __LINE__, format, ##__VA_ARGS__)
+#define LOG_INFO(format, ...)    TeslaBLE::log_internal(TeslaBLE::LogLevel::INFO, TESLA_LOG_TAG, __LINE__, format, ##__VA_ARGS__)
+#define LOG_DEBUG(format, ...)   TeslaBLE::log_internal(TeslaBLE::LogLevel::DEBUG, TESLA_LOG_TAG, __LINE__, format, ##__VA_ARGS__)
+#define LOG_VERBOSE(format, ...) TeslaBLE::log_internal(TeslaBLE::LogLevel::VERBOSE, TESLA_LOG_TAG, __LINE__, format, ##__VA_ARGS__)

include/tb_logging.h

@@ -0,0 +1,40 @@
+#pragma once
+
+#include "car_server.pb.h"
+#include "signatures.pb.h"
+#include "universal_message.pb.h"
+#include "vcsec.pb.h"
+#include "errors.pb.h"
+#include <string>
+#include <cstdint>
+
+namespace TeslaBLE {
+
+const char *domain_to_string(UniversalMessage_Domain domain);
+const char *information_request_type_to_string(VCSEC_InformationRequestType request_type);
+const char *message_fault_to_string(UniversalMessage_MessageFault_E fault);
+const char *operation_status_to_string(UniversalMessage_OperationStatus_E status);
+const char *vcsec_operation_status_to_string(VCSEC_OperationStatus_E status);
+const char *vssec_signed_message_information_to_string(VCSEC_SignedMessage_information_E information);
+const char *closure_state_to_string(VCSEC_ClosureState_E state);
+const char *vehicle_lock_state_to_string(VCSEC_VehicleLockState_E state);
+const char *vehicle_sleep_status_to_string(VCSEC_VehicleSleepStatus_E state);
+const char *user_presence_to_string(VCSEC_UserPresence_E state);
+const char *generic_error_to_string(Errors_GenericError_E error);
+const char *carserver_operation_status_to_string(CarServer_OperationStatus_E status);
+
+void log_aes_gcm_personalized_signature_data(const char *tag, const Signatures_AES_GCM_Personalized_Signature_Data *data);
+void log_destination(const char *tag, const char *prefix, const UniversalMessage_Destination *dest);
+void log_information_request(const char *tag, const VCSEC_InformationRequest *msg);
+void log_message_status(const char *tag, const UniversalMessage_MessageStatus *status);
+void log_routable_message(const char *tag, const UniversalMessage_RoutableMessage *msg);
+void log_session_info_request(const char *tag, const UniversalMessage_SessionInfoRequest *req);
+void log_session_info(const char *tag, const Signatures_SessionInfo *req);
+void log_signature_data(const char *tag, const Signatures_SignatureData *sig);
+void log_vehicle_status(const char *tag, const VCSEC_VehicleStatus *msg);
+void log_vssec_signed_message_status(const char *tag, const VCSEC_SignedMessage_status *status);
+void log_vssec_whitelist_operation_status(const char *tag, const VCSEC_WhitelistOperation_status *status);
+void log_vcsec_command_status(const char *tag, const VCSEC_CommandStatus *msg);
+void log_carserver_response(const char *tag, const CarServer_Response *msg);
+
+} // namespace TeslaBLE

include/tb_utils.h

@@ -2,9 +2,12 @@
 
 #include <string>
 #include "pb.h"
+#include <vector>
 
 namespace TeslaBLE
 {
+  std::string format_hex(const uint8_t* data, size_t length);
+
   int pb_encode_fields(
       pb_byte_t *output_buffer,
       size_t *output_length,