From 40ead85e2fd6149d7e7e3e000c71c0971aa490dd Mon Sep 17 00:00:00 2001
From: "Ryan@interlock" <rtang@fsu.edu>
Date: Thu, 9 May 2024 16:15:21 -0400
Subject: [PATCH] update README.md

---
 README.md | 58 +++++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 50 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 019b59d..db16609 100644
--- a/README.md
+++ b/README.md
@@ -1,22 +1,64 @@
 # Introduction
 
-The interlock folder contains P1AM-100 code (which is Arduino MKX1000).
+The interlock folder contains P1AM-100 code (which is Arduino MKR1000).
 
-The Listen2Arduino.py is a script for listening the P1AM-100 output, and put the status, the tritium, Vaccum, and SubPump reading to the fsunuc.physics.fsu.edu database. 
+The Listen2Arduino.py is a script for listening the P1AM-100 output (via USB), and put the status, the tritium, Vaccum, and SubPump reading to the fsunuc.physics.fsu.edu database. It will also save the status into ~/data.txt. The data.txt is used for the statusDisplay to run the local dashboard. 
 
-## Setup using Arduino IDE 1.X
+A brief diagram to show the data flow
+
+```cpp
+P1AM --> Listen2Arduino.py 
+              +---> data.txt --> statusDisplay
+              +---> database
+```
+
+
+
+# Setup using Arduino IDE 1.X
 
 The P1AM.h library is needed. 
 
-## Setup system service for the Listen2Arduino.py
+* PA1M.h
+* Ethernet.h
+* liquidCrystal.h
 
-copy the listen2P1AM.service to /etc/systemd/system/
+also, need to add board MKR1000, use the baord manger, search for 
 
-run
+* Arduino SAMD Boards
 
-`sudo systemctl enable listen2P1AM.service`
-`sudo systemctl start listen2P1AM.service`
+# Setup the Raspberry Pi
+
+need to install the python package for InfluxDB-client
+
+```sh
+sudo python -m pip install --break-system-package inlfuxdb-client
+```
+
+## influx_token.txt
+
+the influx database need a token for access. the token for the interlock can be found in https://fsunuc.physics.fsu.edu/elog/LabMaintenance/7
 
 ## interlock database at fsunuc.physics.fsu.edu
 
 database name : interlock
+
+## Setup system service for the Listen2Arduino.py
+
+In order to make the Listen2Arduino.py to run at startup and as a background daemon, 
+copy the listen2P1AM.service to /etc/systemd/system/
+
+run
+```sh
+sudo systemctl daemen-reload
+sudo systemctl enable listen2P1AM.service`
+sudo systemctl start listen2P1AM.service`
+```
+
+## make a symbolic link to ~/data.txt
+
+Once the Listen2Arduino.py is running, it will create ~/data.txt, so that the local status display can read and update the status. create a symbolic link 
+
+```sh
+cd ~/Multi-SNICS_Interlock/statusDisplay/
+ln -s ~/data.txt .
+```
\ No newline at end of file