Conifguring things for inital rollout

Author: Gautreaux

PossibleElaboratons.md ARCHIVE/PossibleElaboratons.mdPossibleElaboratons.md renamed to ARCHIVE/PossibleElaboratons.md

@@ -0,0 +1,47 @@
+# Auxillary Operations
+
+Other things that may need doing at some point
+
+## Changing device Name or Account Username/Password
+
+1. `sudo raspi-config`
+
+## Changing root password
+
+1. `sudo passwd root`
+
+## Changing WIFI network name
+
+1. `sudo vim /etc/hostapd/hostapd.conf`
+    
+1. ssid is network name
+
+1. wpa_passphrase is network password
+
+## Configure WIFI as Client
+
+1.
+
+## Uploading Files
+
+1. Use any SFTP compatible device. For example, with filezilla use the host 'sftp://pi-ip'
+
+1. After logging in, may need to go up several directories. Then into `/var/www/html`
+
+1. Transfer the files. Webserver provides `index.html` to clients. Server is launched with `python3 /var/www/html/server.py 192.168.4.1 8765 1 &`
+
+1. If necessary, alter python launch config:
+
+## Update Command Line Args for Server
+
+1. `sudo vim /etc/rc.local`
+
+1. update python line
+
+## Create a raspberry pi image
+
+1. Win32DiskImager
+
+1. Copy
+
+1. Can load this image to sd card in same utility or via raspberry pi imager

SETUP.md ARCHIVE/SETUP.mdSETUP.md renamed to ARCHIVE/SETUP.md

@@ -29,6 +29,9 @@ function initFunction() {
     socket.onmessage = onSocketReceive; //called each message received
     socket.onclose = onSocketClose; //called each close
 
+    if(typeof status != 'undefined'){
+        document.getElementById("statusPrintout").innerHTML = status;
+    }
 }
 
 //called when the socket establishes a connection to the server

AuxillaryOperations.md

@@ -2,6 +2,7 @@
     <script src = "backend.js"></script>
     <script src="joystick.js"></script>
     <script src="hostPort.js"></script>
+    <script src="statusfile.js"></script>
     <link rel="stylesheet" href="joystickStyles.css">
     <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
 </head>
@@ -13,4 +14,7 @@
             <div id="joystick"></div>
         </div>
     </div>
+    <div id="statusPrintout">
+        No status file provided
+    </div>
 </body>

Examples/JoystickDrive/backend.js

@@ -54,4 +54,8 @@
     -ms-transform: translate(-50%, -50%);
     transform: translate(-50%, -50%);
 
+}
+
+#statusPrintout{
+    width: 100%
 }

Examples/JoystickDrive/index.html

@@ -50,6 +50,13 @@ async def connectionHandler(websocket, path):
     return connectionHandler
 
 
+def writeStatus(message):
+    try:
+        with open('statusfile.js', 'w') as status:
+            print(f'status="Server status: {message}";', file=status)
+    except Exception:
+        pass
+
 #if the python module has been launched as the main one
 if __name__ == "__main__":
     #first, we allow for command line arguments formatted such:
@@ -71,13 +78,16 @@ async def connectionHandler(websocket, path):
     except (IndexError, ValueError):
         motorInterfaceType = 0
 
+    writeStatus("server booting")
+
     #next, write the host:port combo to a file that js can read.
     try:
         with open("hostPort.js", 'w') as fileOut:
             fileOut.write(f"myHost = '{host}';")
             fileOut.write(f"myPort = '{port}';")
         #with open() as syntax automatically closes the file on exit
     except (FileNotFoundError, FileExistsError, OSError) as e:
+        writeStatus("server crashed writing host-port file")
         print("Something went wrong trying to write the hostport.js file. Type:" + str(type(e)))
 
     print(f"Starting Server at {host}:{port}")
@@ -91,7 +101,7 @@ async def connectionHandler(websocket, path):
 
     #This outer while loop "solves" the race condition.
     #More on this at the end of the file.
-    failCtr = 5
+    failCtr = 0
     while(True):
         #start the server
         server = websockets.serve(buildConnectionHandler(interface), host, port)
@@ -101,6 +111,7 @@ async def connectionHandler(websocket, path):
             # under normal circumstances, this means we wait forever
             asyncio.get_event_loop().run_until_complete(server)
             print("server started successfully.")
+            writeStatus("server started nominally")
             failCtr = -1
             asyncio.get_event_loop().run_forever()
             #any code down here would not be reachable until the server closes its socket
@@ -110,13 +121,16 @@ async def connectionHandler(websocket, path):
             #the interrupt was fired (ctrl-c), time to exit
             #note, the interrupt wont happen till the next async event happens
             print("Exiting via KeyboardInterrupt")
+            writeStatus("Exited via keyboard interrupt")
             exit(-1)
         except OSError as e:
             failCtr+=1
-            if(failCtr > 5):
-                print("The server startup failed too many times, allowing exception to fire.")
+            if(failCtr % 10 == 0):
+                print("The server startup failed too many times")
                 print("\tThis may be a result of too many packages slowing down the loading of the network interface.")
-                raise e #allow the error to fire.
+                print(f"\t{e}")
+                # raise e #allow the error to fire.
+                writeStatus(f"Sever bind failure after {failCtr} retries")
             else:
                 sleep(5)
 

Examples/JoystickDrive/joystickStyles.css

@@ -0,0 +1 @@
+status="server started nominally";

Examples/JoystickDrive/server.py

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Spencer Gautreaux
+Copyright (c) 2020 Aggie Robotics
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Examples/JoystickDrive/statusfile.js

@@ -0,0 +1,49 @@
+# Quick Start
+
+1. Download the latest image from the releases tab 
+
+1. Put this image on an sd card via either raspbery pi imager utility or Win32DiskImager
+
+1. Provide power and go for it
+
+1. See [Auxillary Operations](AuxillaryOperations.md) for some common actions
+
+# Default Values
+
+Key Values in the default image
+
+## Accounts
+
+* Default username = `pi`
+
+* Default password = `raspberry`
+
+## Root
+
+* Root password, if prompted, is `AggieRobotics`
+
+## Key Files
+
+* Dir: `/var/www/html/`
+
+* `index.html`
+
+* `server.py`
+
+## Wifi
+
+* SSID (Network Name) = `Sumobot`
+
+* Password = `AggieRobotics`
+
+## DHCP
+
+* Range `192.168.4.1` to `192.168.4.20`
+
+* Host is `192.168.4.1`
+
+* Lease Time is `24h`
+
+## IPTables
+
+* All inbound connections on all interfaces redirect to local