Update README.md

Author: zmasood-sh

deployment-examples/SIOOnDemandAnalytics/README.md

@@ -12,6 +12,79 @@ The other pipeline is a vanilla Folder Watch pipeline.
 
 REST API Flask module is bringing it all together, providing a front-end implementation of the API. Upon request for an analytics, it finds the most recent file generated by the live pipeline, and serves JSON containing the image and relevant analytics. Another flavor of that API will serve an image/jpg, which is useful for debugging.
 
+## Special Instructions for Jetson Devices
+
+When deploying on Jetson devices, additional configuration is required:
+
+1. Set the `SIO_DOCKER_TAG_VARIANT` environment variable to the appropriate value:
+   ```bash
+   export SIO_DOCKER_TAG_VARIANT=-r32.7.3-arm64v8
+   ```
+2. Configure Docker to use the NVIDIA runtime:
+   ```bash
+   export SIO_DOCKER_RUNTIME=nvidia
+   ```
+3. Modify `docker-compose` to add the network:
+   ```yaml
+   networks:
+     sh-device-ui_sh-ui-net:
+       external: true
+   ```
+4. Add the following to the analytics service in `docker-compose`:
+   ```yaml
+   networks:
+     sh-device-ui_sh-ui-net:
+       aliases:
+         - sioanalytics
+   ```
+5. Update the pipeline configuration to use the camera URL:
+   ```json
+   "VIDEO_IN": "rtsp://sh-ui-backend:8555/live"
+   ```
+   To automate this step, use a `sed` command to replace the `VIDEO_IN` URL in `pipelines.json`:
+   ```bash
+   sed -i 's|"VIDEO_IN".*:.*"rtsp://.*"|"VIDEO_IN": "rtsp://sh-ui-backend:8555/live"|' config/analytics/pipelines.json
+   ```
+
+## Testing the API
+
+After everything is running, you can test the API by running:
+```bash
+curl http://<camera_ip or localhost>:8080/alpr/v1.0/locations/100
+```
+This will return an output similar to the following:
+```json
+{
+  "location": {
+    "id": 100
+  },
+  "streamDetail": [
+    {
+      "image": [
+        {
+          "id": 1,
+          "imageData": "",
+          "licensePlate": {
+            "lpRegion": "unknown",
+            "lpString": "unknown",
+            "lpnConfidence": 0
+          },
+          "vehicle": {
+            "color": "unknown",
+            "make": "unknown",
+            "model": "unknown"
+          }
+        }
+      ],
+      "preferredImage": 1,
+      "stream": {
+        "id": 1
+      }
+    }
+  ]
+}
+```
+
 ## Client
 
 A sample client is implemented in `SIOOnDemandAnalytics/clients/OnDemandTest.py`.