From 56d5184e3cf1b7a492cb60f9a7e14a297ff025f7 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tom=C3=A1s=20L?= <37879596+Tomz295@users.noreply.github.com>
Date: Mon, 9 Dec 2024 17:31:15 -0500
Subject: [PATCH] Added Readme

---
 README.md   | 16 ++++++++++++++++
 URSentry.py |  2 +-
 dockerfile  |  2 +-
 3 files changed, 18 insertions(+), 2 deletions(-)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee3d53a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,16 @@
+# Requirements
+
+- Device running this code needs internet access (to get Unifi camera data)
+- Must be run on the same network as the UR10.
+- UR10's IP address is hardcoded into `main.py` and `dockermain.py`. Needs to be manualy changed (or rewrite the code so its a env variable instead).
+- The UR10 needs enough clearance, as it spins around alot and **WILL** hit things or people otherwise.
+
+### UNIFI_PASSWORD
+
+- **For Docker:** 
+    - `UNIFI_PASSWORD` must be set as an environment variable
+    - dockerfile is included in the project.
+- **For the rest**:
+    - `UNIFI_PASSWORD` must be set in a `.env` file. (See `.env.example`).
+    - Run `main.py` to run the program.
+
diff --git a/URSentry.py b/URSentry.py
index c9a87bf..922349a 100644
--- a/URSentry.py
+++ b/URSentry.py
@@ -327,7 +327,7 @@ if __name__ == "__main__":
     # sleep(2)
     # sentry.forward_position_to_base_angle_degrees(45)
 
-    print(sentry.robot.get_joint_angles())
+    #print(sentry.robot.get_joint_angles())
 
     # while True:
     #     print(sentry.robot.get_joint_speeds()[0])
diff --git a/dockerfile b/dockerfile
index 5944721..9a0fe50 100644
--- a/dockerfile
+++ b/dockerfile
@@ -1,6 +1,6 @@
 FROM python:3.12
 
-LABEL maintainer="Tomas Letelier"
+LABEL maintainer="Tomas Arturo Letelier Zamora"
 
 WORKDIR /usr/src/app