added some more docs

JestureApp · Apr 17, 2023 · facfc7d · facfc7d
1 parent 8de7280
commit facfc7d
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 14 deletions.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2022 Jesture
+Copyright (c) 2022 JestureApp
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/README.md b/README.md
@@ -1,4 +1,8 @@
-# Jesture Pipe
+# JesturePipe
+JesturePipe is the backend pipeline for the Jesture application. 
+
+## Prerequisites
+* OpenCV
 
 ## Bazel Workspace Setup
 ```starlark

diff --git a/TODO.md b/TODO.md
diff --git a/jesturepipe/jesturepipe.h b/jesturepipe/jesturepipe.h
@@ -62,39 +62,51 @@ class JesturePipe : private mediapipe::CalculatorGraph {
 
     bool isRunning() const;
 
+    /// \brief Adds a frame to the pipeline at the given timestamp
     absl::Status AddFrame(std::unique_ptr<mediapipe::ImageFrame> frame,
                           unsigned long timestamp);
 
+    /// \brief Adds a callback for gesture recognition
     absl::Status OnGestureRecognition(
         std::function<absl::Status(int gesture_id, unsigned long timestamp)>
             packet_callback);
 
+    /// \brief Adds a callback for gesture recordings
     absl::Status OnRecordedGesture(
         std::function<absl::Status(Gesture gesture, unsigned long timestamp)>
             packet_callback);
 
+    /// \brief Adds a callback for hand landmarks
     absl::Status OnLandmarks(
         std::function<absl::Status(
             std::vector<mediapipe::NormalizedLandmarkList> multi_hand_landmarks,
             unsigned long timestamp)>
             packet_callback);
 
+    /// \brief Adds a callback for hand presences
     absl::Status OnHandPresence(
         std::function<absl::Status(bool present, unsigned long timestamp)>
             packet_callback);
 
+    /// \brief Checks whether or not the pipeline is currently recording
     bool IsRecording() const;
 
+    /// \brief Sets the recording mode for the pipeline
     absl::Status SetRecording(bool);
 
+    /// \brief Sets the gesture associated with the given id
     void SetGesture(int gesture_id, Gesture gesture);
 
+    /// \brief Removes the gesture associated with the given id
     void RemoveGesture(int gesture_id);
 
+    /// \brief Removes all gestures
     void ClearGestures();
 
+    /// \brief Sets the action associated with the given gesture id
     void SetAction(int gesture_id, ActionList actions);
 
+    /// \brief Removes the action associated with the given gesture id
     void RemoveAction(int gesture_id);
 
    private:

diff --git a/repositories.bzl b/repositories.bzl
@@ -146,11 +146,16 @@ def jesturepipe_repositories():
         path = "/opt/homebrew",
     )
 
-    maybe(
-        git_repository,
+    # maybe(
+    #     git_repository,
+    #     name = "actions",
+    #     remote = "[email protected]:jesture/actions.git",
+    #     # tag = "v0.1.1",
+    #     commit = "81a1fc11b6ac9e7bfa039e05499739b58164f9c1",
+    #     shallow_since = "1681110432 +0000",
+    # )
+    http_archive(
         name = "actions",
-        remote = "[email protected]:jesture/actions.git",
-        # tag = "v0.1.1",
-        commit = "81a1fc11b6ac9e7bfa039e05499739b58164f9c1",
-        shallow_since = "1681110432 +0000",
+        strip_prefix = "Actions-1.0.0",
+        url = "https://github.com/JestureApp/Actions/archive/refs/tags/v1.0.0.zip",
     )