Contents of /HackyShark/HackyShark/README.md

HackySharkV2.0

Overview

The HackySharkV2.0 is an IoT device based on the ESP32-S3 chip, designed for Over-The-Air (OTA) updates and equipped with a WS2812B LED for status indication. It also features a WebSocket server for real-time data retrieval and utilizes the onboard USB as an HID keyboard.

Features

• OTA Updates: Easily update the firmware wirelessly.
• LED Control: Control WS2812B LED on IO8 to display various status indicators.
• WebSocket Server: Host a WebSocket server for data retrieval.
• HID Keyboard: Use the onboard USB to send keystrokes as an HID keyboard.

Project Structure

• include/config.h: Configuration settings including Wi-Fi credentials and LED pin definitions.
• src/HackyShark.ino: Main entry point of the application.
• src/led_control.h: Functions for controlling the WS2812B LED.
• src/ota_handler.h: Functions for managing OTA updates.
• src/websocket_server.h: Functions for WebSocket server management.
• src/keyboard_hid.h: Functions for HID keyboard functionality.
• lib/: Contains necessary libraries for the project.
• platformio.ini: Configuration file for PlatformIO.

Setup Instructions

1. Clone the repository.
2. Install the required libraries listed in platformio.ini.
3. Update include/config.h with your Wi-Fi credentials.
4. Upload the code to the HackySharkV2.0 device using PlatformIO.

Usage

Once the device is powered on and connected to Wi-Fi, you can access the WebSocket server to retrieve data and control the LED status indicators. The device can also receive OTA updates as needed.