Merge pull request #60 from tapis-project/dev

Version 0.6.0

Author: khsa1

.github/workflows/docker-image.yml

@@ -724,6 +724,43 @@ jobs:
           tags: tapis/detection_reporter_plugin:${{ env.TRAPS_REL }}
           build-args: REL=${{ env.TRAPS_REL }}
 
+  video_generating_plugin:
+    runs-on: ubuntu-latest
+    environment: main
+    needs: camera_traps_py_313
+    steps:
+      - name: Set TRAPS_REL
+        run: |
+          if [[ ${{ github.event_name == 'workflow_dispatch' }} == true ]]; then
+            TRAPS_REL=${{ inputs.release_tag }}
+          elif [[ ${{ github.event_name == 'push' }} == true ]]; then
+            TRAPS_REL=latest
+          elif [[ ${{ github.event_name == 'pull_request' }} == true ]]; then
+            TRAPS_REL=latest
+          else
+            TRAPS_REL=${{ github.event.release.tag_name }}
+          fi
+          echo "TRAPS_REL=$TRAPS_REL" >> "$GITHUB_ENV"
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push oracle_plugin
+        uses: docker/build-push-action@v5
+        with:
+          context: external_plugins/video_generating_plugin
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: tapis/video_generating_plugin:${{ env.TRAPS_REL }}
+          build-args: REL=${{ env.TRAPS_REL }}
+
   custom_install:
     runs-on: ubuntu-latest
     environment: main
@@ -785,7 +822,7 @@ jobs:
   trigger_tests:
     runs-on: ubuntu-latest
     environment: main
-    needs: [engine, image_scoring_plugin_server_py_313, image_scoring_plugin_ultralytics_py_313, image_scoring_plugin_yolov5_py_38, image_scoring_plugin_py_nano_38, image_generating_plugin, image_detecting_plugin, power_measuring_plugin, oracle_plugin, detection_reporter_plugin, custom_install]
+    needs: [engine, image_scoring_plugin_server_py_313, image_scoring_plugin_ultralytics_py_313, image_scoring_plugin_yolov5_py_38, image_scoring_plugin_py_nano_38, image_generating_plugin, image_detecting_plugin, power_measuring_plugin, oracle_plugin, detection_reporter_plugin, video_generating_plugin, custom_install]
     steps:
       - name: Check if tests are disabled
         run: |

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "camera-traps"
-version = "0.5.0"
+version = "0.6.0"
 edition = "2021"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

Cargo.toml

@@ -4,8 +4,8 @@
 # its value will be the tag assigned to all images that get built.
 # For example:
 #
-#    export TRAPS_REL=0.5.0
-#    export TRAPS_REL=0.5.
+#    export TRAPS_REL=0.6.0
+#    export TRAPS_REL=0.6.
 #
 # NOTE: Right now, building with tag `latest` is not supported. Instead,
 #       build a semantic version and then tag the result as latest.
@@ -56,7 +56,10 @@ build-detection:
 build-detecting:
 	cd external_plugins/image_detecting_plugin && docker build -t tapis/image_detecting_plugin:${TRAPS_REL} --build-arg REL=${TRAPS_REL} .; cd ../..
 
-build-py-plugins: build-camerapy build-scoring-server build-generating build-power build-oracle build-detection build-detecting
+build-video:
+	cd external_plugins/video_generating_plugin/ && docker build -t tapis/video_generating_plugin:${TRAPS_REL} --build-arg REL=${TRAPS_REL} .; cd ../..
+
+build-py-plugins: build-camerapy build-scoring-server build-generating build-power build-oracle build-detection build-detecting build-video
 
 build-installer: 
 	cd installer && docker build -t tapis/camera-traps-installer:${TRAPS_REL} --build-arg REL=${TRAPS_REL} .; cd ../

Makefile

@@ -1,6 +1,6 @@
 # camera-traps
 
-The Camera Traps application is both a simulator and IoT device software for utilizing machine learning on the edge in field research. The first implementation specializes in applying computer vision (detection and classification) to wildlife images for animal ecology studies. Two operational modes are supported: "simulation" mode and "demo" mode. When executed in simulation mode, the software serves as a test bed for studying ML models, protocols and techniques that optimize storage, execution time, power and accuracy. It requires an input dataset of images to act as the images that would be generated an IoT camera device; it uses these images to drive the simulation. 
+The Camera Traps application is both a simulator and IoT device software for utilizing machine learning on the edge in field research. The first implementation specializes in applying computer vision (detection and classification) to wildlife images for animal ecology studies. Two operational modes are supported: "simulation" mode and "demo" mode. When executed in simulation mode, the software serves as a test bed for studying ML models, protocols and techniques that optimize storage, execution time, power and accuracy. Simulation mode accepts two different input types: (1) an input dataset of images to act as the images that would be generated an IoT camera device or (2) an input video file that would be captured by a camera which is then processed by an image detecting plugin that saves frames with motion in them; it uses these images to drive the simulation. 
 
 Conversely, when run in "demo" mode, the application serves as software that can be deployed onto actual, Linux-based camera trap devices in the wild. In this case, the Camera Traps software relies on a digital camera accessible over a Linux device mount (the default `/dev/video0` location can be re-configured), and it drives the camera directly using the Linux Motion activation software, which comes bundled with the as a plugin with Camera Traps. It includes a detection reporter plugin and MQTT component which coordinate to communicate in real time when a configurable object of interest has been detected (up to a configurable confidence threshold). As a proof of concept of the capabilities of the software, we are producing a demo integration with drone software developed by the Stewart Lab at OSU which enables the Camera Traps software to communicate over a local network to a nearby drone whenever an object of interest is detected. 
 
@@ -9,6 +9,8 @@ Conversely, when run in "demo" mode, the application serves as software that can
 - CI4AI
 - Animal Ecology
 
+---
+
 # Explanation
 
 ## Architectual Overview
@@ -29,6 +31,7 @@ In general, plugins can also depend on their own environment variables and/or co
 | -------------------------- | ------------------------------- | -------------------------- | ----------------------------------- |
 | camera-traps application | TRAPS_CONFIG_FILE             | ~/traps.toml             | Can be 1st command line parameter |
 | image_gen_plugin         |                               | /input.json              |                                   |
+| video_generating_plugin  | TRAPS_VIDEO_OUTPUT_PATH       |                          |                                   | 
 | image_detecting_plugin   |                               | /etc/motion/motion.conf  |
 | detection_reporter_plugin| TRAPS_DETECTION_REPORTER_*    | /traps-detection.toml    |
 | image_store_plugin       | TRAPS_IMAGE_STORE_FILE        | ~/traps-image-store.toml |                                   |
@@ -159,6 +162,8 @@ When *image_recv_write_file_action* is specifed, the *image_recv_plugin* uses th
 The *image_uuid* and *image_format* are from the NewImageEvent.  The image_file_prefix can be the empty string and the image_format is always lowercased when used in the file name.
 
 
+---
+
 # How-To Guide
 
 ## Quick Start
@@ -232,7 +237,8 @@ allow_anonymous true
 
 In-memory representations of events are translated into flatbuffer binary streams plus a leading two byte sequence that identifies the event type.  These statically defined byte sequences are specified in the [events.rs](https://github.com/tapis-project/camera-traps/blob/main/src/events.rs) source file and repeated here for convenience.
 
-// Each event is assigned a binary prefix that zqm uses to route incoming binary streams to all of the event's subscribers.<br>
+Each event is assigned a binary prefix that zqm uses to route incoming binary streams to all of the event's subscribers.<br>
+```
 pub const NEW_IMAGE_PREFIX:           [u8; 2] = [0x01, 0x00];<br>
 pub const IMAGE_RECEIVED_PREFIX:      [u8; 2] = [0x02, 0x00];<br>
 pub const IMAGE_SCORED_PREFIX:        [u8; 2] = [0x03, 0x00];<br>
@@ -243,6 +249,7 @@ pub const PLUGIN_TERMINATING_PREFIX:  [u8; 2] = [0x11, 0x00];<br>
 pub const PLUGIN_TERMINATE_PREFIX:    [u8; 2] = [0x12, 0x00];<br>
 pub const MONITOR_POWER_START_PREFIX: [u8; 2] = [0x20, 0x00];<br>
 pub const MONITOR_POWER_STOP_PREFIX:  [u8; 2] = [0x21, 0x00];<br>
+```
 
 Each event sent or received begins with its two byte prefix followed by its serialized form as defined in the camera-traps flatbuffer definition file ([events.fbs](https://github.com/tapis-project/camera-traps/blob/main/resources/events.fbs)).  The following section describes how to generate Rust source code from this definition file, a similar process can be used for any language supported by flatbuffers.
 

README.md

@@ -1,5 +1,11 @@
 # Camera Traps Release Notes
 
+## Version 0.6.0
+This release includes three main improvements:
+1. A Video Generating plugin that uses a video file and a v4l2loopback virtual device to simulate a mounted camera stream, to use in conjunction with the Image Detecting plugin.
+2. Improved metric reporting.
+3. Set a minimum time between image events when using the Image Detecting plugin.
+
 ## Version 0.5.0
 This major release expands the camera-traps application with a new functional mode, referred to as `demo` mode. 
 Unlike the original simulation mode,

RELEASE_NOTES.md

@@ -128,6 +128,11 @@ def main():
             if is_detected_image(uuid):
                 update_csv('STORING', uuid, image_path=image_path, decision=destination)
 
+        elif isinstance(event, PluginTerminateEvent):
+            done = True
+            logger.info(f'Received Terminate event * and shutting down detection reporter plugin')
+            send_quit_command(socket)
+
 if __name__ == '__main__':
     logger.info("Detection reporter plugin starting...")
     main()

external_plugins/detection_reporter_plugin/detection_reporter.py

@@ -7,16 +7,18 @@ RUN find / -path /proc -prune -o -path /sys -prune -o -path /dev -prune -o -writ
 RUN apt update && apt install -y motion vim
 RUN pip install watchdog
 RUN pip install PILLOW
+RUN pip install PyYaml
 
 # Config files
 ADD motion.default /etc/default/motion
 ADD motion.conf /etc/motion/motion.conf
+RUN mkdir /var/log/motion
 
 # Code 
 ADD image_detecting_plugin.py /image_detecting_plugin.py
 ADD entry.sh /entry.sh 
 
-RUN chmod -R 0777 /oracle_plugin.py || true 
+RUN chmod -R 0777 /image_detecting_plugin.py || true
 
 
 ENTRYPOINT [ "/entry.sh" ]

external_plugins/image_detecting_plugin/Dockerfile

@@ -30,5 +30,7 @@ services:
     privileged: true 
     volumes:
       - ./image_data:/var/lib/motion
+    environment:
+      - MIN_SECONDS_BETWEEN_IMAGES=2
     depends_on:
       - engine

external_plugins/image_detecting_plugin/docker-compose.yml

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # Start the motion program to monitor the /data directory
-motion
+#motion
 
 # Start the image detecting plugin 
 python -u image_detecting_plugin.py