From cd6a06de6571ea4bf7e20d12a12078199b6ef3b2 Mon Sep 17 00:00:00 2001 From: rawhide kobayashi Date: Wed, 12 Feb 2025 16:30:36 -0600 Subject: [PATCH] init --- .flaskenv | 1 + .gitignore | 6 +++++ .vscode/extensions.json | 10 ++++++++ README.md | 13 ++++++++++- esp32/include/README | 39 +++++++++++++++++++++++++++++++ esp32/lib/README | 46 ++++++++++++++++++++++++++++++++++++ esp32/src/main.cpp | 46 ++++++++++++++++++++++++++++++++++++ esp32/test/README | 11 +++++++++ platformio.ini | 27 +++++++++++++++++++++ webui/.gitignore | 1 + webui/ipkvm/__init__.py | 5 ++++ webui/ipkvm/routes.py | 52 +++++++++++++++++++++++++++++++++++++++++ webui/launch.py | 4 ++++ 13 files changed, 260 insertions(+), 1 deletion(-) create mode 100644 .flaskenv create mode 100644 .gitignore create mode 100644 .vscode/extensions.json create mode 100644 esp32/include/README create mode 100644 esp32/lib/README create mode 100644 esp32/src/main.cpp create mode 100644 esp32/test/README create mode 100644 platformio.ini create mode 100644 webui/.gitignore create mode 100644 webui/ipkvm/__init__.py create mode 100644 webui/ipkvm/routes.py create mode 100644 webui/launch.py diff --git a/.flaskenv b/.flaskenv new file mode 100644 index 0000000..95693ad --- /dev/null +++ b/.flaskenv @@ -0,0 +1 @@ +FLASK_APP=webui/launch.py \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8d1f6c5 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.pio +.venv/ +.vscode/.browse.c_cpp.db* +.vscode/c_cpp_properties.json +.vscode/launch.json +.vscode/ipch diff --git a/.vscode/extensions.json b/.vscode/extensions.json new file mode 100644 index 0000000..080e70d --- /dev/null +++ b/.vscode/extensions.json @@ -0,0 +1,10 @@ +{ + // See http://go.microsoft.com/fwlink/?LinkId=827846 + // for the documentation about the extensions.json format + "recommendations": [ + "platformio.platformio-ide" + ], + "unwantedRecommendations": [ + "ms-vscode.cpptools-extension-pack" + ] +} diff --git a/README.md b/README.md index a0070e3..8cbf4fd 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,14 @@ # esp32-ip-kvm-and-oc-tuner -A bottom-of-the-barrel cheap IP KVM solution intended for homelabs with multiple computers already present. Plus, an automated OC tuner for Ryzen platforms! Roboclocker! \ No newline at end of file +A bottom-of-the-barrel cheap IP KVM solution intended for homelabs with multiple computers already present. Plus, an automated OC tuner for Ryzen platforms! Roboclocker! Use one server as a hub to access consumer hardware in your rack! + +TODO: +- Everything +- Learn Flask +- Learn graphviz +- Integrate viz.js +- Create OC tuning logic +- Create generic maps for AGESA +- Serial debug interpretation +- Implement KVM +- Implement daemons for OC clients \ No newline at end of file diff --git a/esp32/include/README b/esp32/include/README new file mode 100644 index 0000000..194dcd4 --- /dev/null +++ b/esp32/include/README @@ -0,0 +1,39 @@ + +This directory is intended for project header files. + +A header file is a file containing C declarations and macro definitions +to be shared between several project source files. You request the use of a +header file in your project source file (C, C++, etc) located in `src` folder +by including it, with the C preprocessing directive `#include'. + +```src/main.c + +#include "header.h" + +int main (void) +{ + ... +} +``` + +Including a header file produces the same results as copying the header file +into each source file that needs it. Such copying would be time-consuming +and error-prone. With a header file, the related declarations appear +in only one place. If they need to be changed, they can be changed in one +place, and programs that include the header file will automatically use the +new version when next recompiled. The header file eliminates the labor of +finding and changing all the copies as well as the risk that a failure to +find one copy will result in inconsistencies within a program. + +In C, the usual convention is to give header files names that end with `.h'. +It is most portable to use only letters, digits, dashes, and underscores in +header file names, and at most one dot. + +Read more about using header files in official GCC documentation: + +* Include Syntax +* Include Operation +* Once-Only Headers +* Computed Includes + +https://gcc.gnu.org/onlinedocs/cpp/Header-Files.html diff --git a/esp32/lib/README b/esp32/lib/README new file mode 100644 index 0000000..2593a33 --- /dev/null +++ b/esp32/lib/README @@ -0,0 +1,46 @@ + +This directory is intended for project specific (private) libraries. +PlatformIO will compile them to static libraries and link into executable file. + +The source code of each library should be placed in an own separate directory +("lib/your_library_name/[here are source files]"). + +For example, see a structure of the following two libraries `Foo` and `Bar`: + +|--lib +| | +| |--Bar +| | |--docs +| | |--examples +| | |--src +| | |- Bar.c +| | |- Bar.h +| | |- library.json (optional, custom build options, etc) https://docs.platformio.org/page/librarymanager/config.html +| | +| |--Foo +| | |- Foo.c +| | |- Foo.h +| | +| |- README --> THIS FILE +| +|- platformio.ini +|--src + |- main.c + +and a contents of `src/main.c`: +``` +#include +#include + +int main (void) +{ + ... +} + +``` + +PlatformIO Library Dependency Finder will find automatically dependent +libraries scanning project source files. + +More information about PlatformIO Library Dependency Finder +- https://docs.platformio.org/page/librarymanager/ldf.html diff --git a/esp32/src/main.cpp b/esp32/src/main.cpp new file mode 100644 index 0000000..969c4e9 --- /dev/null +++ b/esp32/src/main.cpp @@ -0,0 +1,46 @@ +#ifndef ARDUINO_USB_MODE +#error This ESP32 SoC has no Native USB interface +#elif ARDUINO_USB_MODE == 1 +#warning This sketch should be used when USB is in OTG mode +void setup() {} +void loop() {} +#else + +#include +#include +#include +#include +USBHIDMouse Mouse; +USBHIDKeyboard Keyboard; + +// put function declarations here: +int myFunction(int, int); + +void setup() { + // put your setup code here, to run once: + int result = myFunction(2, 3); + Serial.begin(115200); + Mouse.begin(); + Keyboard.begin(); + USB.begin(); +} + +void loop() { + //Keyboard.write(0x4C); + //Keyboard.pressRaw(HID_KEY_DELETE); + //Keyboard.releaseRaw(HID_KEY_DELETE); + // put your main code here, to run repeatedly: + /*if (Serial.available() > 0) { + char inChar = Serial.read(); + + + }*/ + sleep(1000); +} + +// put function definitions here: +int myFunction(int x, int y) { + return x + y; +} + +#endif /* ARDUINO_USB_MODE */ \ No newline at end of file diff --git a/esp32/test/README b/esp32/test/README new file mode 100644 index 0000000..9b1e87b --- /dev/null +++ b/esp32/test/README @@ -0,0 +1,11 @@ + +This directory is intended for PlatformIO Test Runner and project tests. + +Unit Testing is a software testing method by which individual units of +source code, sets of one or more MCU program modules together with associated +control data, usage procedures, and operating procedures, are tested to +determine whether they are fit for use. Unit testing finds problems early +in the development cycle. + +More information about PlatformIO Unit Testing: +- https://docs.platformio.org/en/latest/advanced/unit-testing/index.html diff --git a/platformio.ini b/platformio.ini new file mode 100644 index 0000000..cb511dd --- /dev/null +++ b/platformio.ini @@ -0,0 +1,27 @@ +; PlatformIO Project Configuration File +; +; Build options: build flags, source filter +; Upload options: custom upload port, speed and extra flags +; Library options: dependencies, extra library storages +; Advanced options: extra scripting +; +; Please visit documentation for the other options and examples +; https://docs.platformio.org/page/projectconf.html + +[common] + + +[env:rymcu-esp32-s3-devkitc-1] +platform = espressif32 +board = rymcu-esp32-s3-devkitc-1 +framework = arduino +build_flags = -DARDUINO_USB_MODE=0 +monitor_speed = 115200 + +[platformio] +src_dir = esp32/src +lib_dir = esp32/lib +include_dir = esp32/include +test_dir = esp32/test +data_dir = esp32/data +workspace_dir = esp32/.pio \ No newline at end of file diff --git a/webui/.gitignore b/webui/.gitignore new file mode 100644 index 0000000..ba0430d --- /dev/null +++ b/webui/.gitignore @@ -0,0 +1 @@ +__pycache__/ \ No newline at end of file diff --git a/webui/ipkvm/__init__.py b/webui/ipkvm/__init__.py new file mode 100644 index 0000000..363dc95 --- /dev/null +++ b/webui/ipkvm/__init__.py @@ -0,0 +1,5 @@ +from flask import Flask + +ui = Flask(__name__) + +from ipkvm import routes \ No newline at end of file diff --git a/webui/ipkvm/routes.py b/webui/ipkvm/routes.py new file mode 100644 index 0000000..ad58390 --- /dev/null +++ b/webui/ipkvm/routes.py @@ -0,0 +1,52 @@ +from ipkvm import ui +from flask import Response + +import cv2 + +camera = cv2.VideoCapture(0) # Use default webcam (index 0) + +# Get some basic properties +width = int(camera.get(cv2.CAP_PROP_FRAME_WIDTH)) +height = int(camera.get(cv2.CAP_PROP_FRAME_HEIGHT)) +fps = camera.get(cv2.CAP_PROP_FPS) +format = camera.get(cv2.CAP_PROP_FORMAT) + +camera.set(cv2.CAP_PROP_FRAME_WIDTH, 1920) +camera.set(cv2.CAP_PROP_FRAME_HEIGHT, 1080) +camera.set(cv2.CAP_PROP_FPS, 60) + +print(f"Current resolution: {width}x{height}") +print(f"Current FPS: {fps}") +print(f"Current format: {format}") + +def generate_frames(): + while True: + success, frame = camera.read() + if not success: + break + else: + # Encode frame as JPEG + ret, buffer = cv2.imencode('.jpg', frame) + frame = buffer.tobytes() + yield (b'--frame\r\n' + b'Content-Type: image/jpeg\r\n\r\n' + frame + b'\r\n') + + +@ui.route('/video_feed') +def video_feed(): + return Response(generate_frames(), + mimetype='multipart/x-mixed-replace; boundary=frame') + +@ui.route('/') +def index(): + return """ + + + Webcam Stream + + +

Webcam Stream

+ + + + """ \ No newline at end of file diff --git a/webui/launch.py b/webui/launch.py new file mode 100644 index 0000000..11854c3 --- /dev/null +++ b/webui/launch.py @@ -0,0 +1,4 @@ +from ipkvm import ui + +if __name__ == '__main__': + ui.run(host='0.0.0.0', port=5000, threaded=True) \ No newline at end of file