Merge branch 'develop'

makersmakingchange · Jul 18, 2022 · fa69f24 · fa69f24
2 parents 8650988 + e6e969d
commit fa69f24
Show file tree

Hide file tree

Showing 20 changed files with 3,360 additions and 907 deletions.
diff --git a/LipSync_Manual.pdf → Documentation/LipSync_Assembly_Guide.pdf b/LipSync_Manual.pdf → Documentation/LipSync_Assembly_Guide.pdf
diff --git a/LipSync_BOM.csv → Documentation/LipSync_BOM.csv b/LipSync_BOM.csv → Documentation/LipSync_BOM.csv
diff --git a/Documentation/LipSync_BOM.xlsx b/Documentation/LipSync_BOM.xlsx
diff --git a/Documentation/LipSync_Command_List.pdf b/Documentation/LipSync_Command_List.pdf
diff --git a/Mounting_Document.pdf → Documentation/LipSync_Mounting_Guide.pdf b/Mounting_Document.pdf → Documentation/LipSync_Mounting_Guide.pdf
diff --git a/Documentation/LipSync_Startup_Guide.pdf b/Documentation/LipSync_Startup_Guide.pdf
diff --git a/Documentation/LipSync_User_Guide.pdf b/Documentation/LipSync_User_Guide.pdf
diff --git a/Documentation/Word/LipSync_Command_List.docx b/Documentation/Word/LipSync_Command_List.docx
diff --git a/Documentation/Word/LipSync_Mounting_Guide.docx b/Documentation/Word/LipSync_Mounting_Guide.docx
diff --git a/Documentation/Word/LipSync_Startup_Guide.docx b/Documentation/Word/LipSync_Startup_Guide.docx
diff --git a/Documentation/Word/LipSync_User_Guide.docx b/Documentation/Word/LipSync_User_Guide.docx
diff --git a/Hardware/Housing_design/3D_Print_Settings.txt b/Hardware/Housing_design/3D_Print_Settings.txt
@@ -0,0 +1,37 @@
+Print all components in orientation of STL file. Parts are designed to print with a 0.40 mm nozzle. Neutral, non-obtrusive filament colors (e.g. black, grey, white) are preferred for the rear housing and front housing unless the user requests otherwise. 
+
+----------------------------
+First print:
+LipSync_Rear_Housing
+
+Infill: 20%
+Layer Height: 0.2mm
+Support Material: No
+Raft: No
+Walls: 3
+----------------------------
+
+----------------------------
+Second print:
+1X LipSync_Front_Housing
+2X LipSync_Button 
+1X LipSync_Joystick_Stand (Optional; Recommended)
+
+Infill: 20%
+Layer Height: 0.2mm
+Support Material: No
+Raft: No
+----------------------------
+
+
+----------------------------
+Third print:
+1X LipSync_Joystick_Front_Plate
+1X LipSync_Joystick_Rocker
+1X LipSync_Joystick_Base
+
+Infill: 50%
+Layer Height: 0.2mm
+Support Material: Yes
+Raft: No
+----------------------------
diff --git a/Hardware/Housing_design/LipSync_Rear_Housing.STL b/Hardware/Housing_design/LipSync_Rear_Housing.STL
diff --git a/...Housing_design/LipSync_Joystick_Stand.STL → ..._design/Optional/LipSync_Joystick_Jig.STL b/...Housing_design/LipSync_Joystick_Stand.STL → ..._design/Optional/LipSync_Joystick_Jig.STL
diff --git a/Hardware/Housing_design/Print_Settings.txt b/Hardware/Housing_design/Print_Settings.txt
diff --git a/LipSync_BOM.xlsx b/LipSync_BOM.xlsx
diff --git a/LipSync_Startup_Guide.pdf b/LipSync_Startup_Guide.pdf
diff --git a/LipSync_User_Guide.pdf b/LipSync_User_Guide.pdf
diff --git a/README.md b/README.md
@@ -4,10 +4,15 @@
 <img align="center" src="https://raw.githubusercontent.com/makersmakingchange/blog/gh-pages/_resources/images/LipSync_Logo.jpg" width="50%" height="50%" alt="LipSync Logo"/>
 </p>
 
-The LipSync is an assistive technology device which is being developed to allow quadriplegics and other people with limited hand use the ability to use touchscreen mobile devices by manipulation of a mouth-operated joystick with integrated sip and puff controls. We are releasing all of our work open-source, to make the Lipsync a solution that can be made at the community level for less than $300.
+The LipSync is an assistive technology device that allows quadriplegics and other people with limited hand function to use touchscreen mobile devices, tablets, and computers by manipulation of a mouth-operated joystick with integrated sip and puff controls. This is an Open-Source Hardware project, so the Lipsync can be made at the community level for less than $300.
 
 This GitHub repository will serve as a database for all files and documentation associated with the LipSync project.
 
+## More info at
+
+- [Makers Making Change Project Page](https://www.makersmakingchange.com/project/lipsync/)
+- [Makers Making Change Forum Thread](https://makersmakingchange.com/forum/topic/lipsync-by-makers-making-change/)
+
 ## Compatibility 
 
  <table style="width:100%">
@@ -42,6 +47,25 @@ This GitHub repository will serve as a database for all files and documentation
   </tr>
   </table> 
 
+## Getting Started
+There are several options for obtaining a LipSync device.
+1. Build it yourself
+2. Request a volunteer maker to build one for you.
+
+### 1. Build it Yourself
+All the information you need to build a LipSync is avaiable in this repository. You'll need to order a number of off-the-shelf components, order a set of custom printed circuit boards and 3D print a number of components.
+
+### 2. Volunteer Build
+You can submit a build request through the Makers Making Change Website. A volunteer maker will build a LipSync and the requestor is responsible for the cost of materials and any shipping.
+
+First, you'll need to [sign up](https://www.makersmakingchange.com/sign-up/) to create an account. Once your account is activated, you can log in.
+
+Second, [submit a build request](https://makersmakingchange.com/request-a-build?project_id=1657) for a LipSync.
+
+Once a volunteer maker agrees to take on your request, communicate with them to discuss details and reimbursement.
+
+
+
 ## Download
 
  <table style="width:100%">
@@ -53,51 +77,51 @@ This GitHub repository will serve as a database for all files and documentation
   </tr>
     <tr>
     <td>LipSync All</td>
-    <td>2.0</td>
+    <td>3.0</td>
     <td>ZIP</td>
-    <td><a href="https://github.com/makersmakingchange/LipSync/archive/master.zip">LipSync-master.zip</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/archive/refs/heads/master.zip">LipSync.zip</a></td>
   </tr>
   <tr>
-    <td>LipSync Manual</td>
+    <td>LipSync Assembly Guide</td>
     <td>1.6</td>
     <td>PDF</td>
-    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/LipSync_Manual.pdf">LipSync_Manual.pdf</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Documentation/LipSync_Assembly_Guide.pdf">LipSync_Assembly_Guide.pdf</a></td>
   </tr>
   <tr>
     <td>LipSync Startup Guide</td>
-    <td>1.6</td>
+    <td>1.8</td>
     <td>PDF</td>
-    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/LipSync_Startup_Guide.pdf">LipSync_Startup_Guide.pdf</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Documentation/LipSync_Startup_Guide.pdf">LipSync_Startup_Guide.pdf</a></td>
   </tr>
   <tr>
     <td>LipSync User Guide</td>
-    <td>1.1</td>
+    <td>1.3</td>
     <td>PDF</td>
-    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/LipSync_User_Guide.pdf">LipSync_User_Guide.pdf</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Documentation/LipSync_User_Guide.pdf">LipSync_User_Guide.pdf</a></td>
   </tr>
   <tr>
-     <td>Mounting Document</td>
+     <td>LipSync Mounting Guide</td>
      <td>1.0</td>
      <td>PDF</td>
-     <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Mounting_Document.pdf">Mounting_Document.pdf</a></td>
+     <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Documentation/LipSync_Mounting_Guide.pdf">LipSync_Mounting_Guide.pdf</a></td>
   </tr>
   <tr>
     <td>LipSync BOM (XLSX)</td>
-    <td>September 16, 2019</td>
+    <td>September 1, 2021</td>
     <td>XLSX</td>
-    <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/LipSync_BOM.xlsx">LipSync_BOM.xlsx</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Documentation/LipSync_BOM.xlsx">LipSync_BOM.xlsx</a></td>
   </tr>
   <tr>
     <td>LipSync BOM (CSV)</td>
-    <td>September 16, 2019</td>
+    <td>September 1, 2021</td>
     <td>CSV</td>
-    <td><a href="https://raw.githubusercontent.com/makersmakingchange/LipSync/master/LipSync_BOM.csv" download target="_blank">LipSync_BOM.csv</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Documentation/LipSync_BOM.csv">LipSync_BOM.csv</a></td>
   </tr>
   <tr>
     <td>LipSync Firmware</td>
-    <td>2.7</td>
+    <td>3.0</td>
     <td>INO</td>
-    <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Software/LipSync_Firmware/LipSync_Firmware.ino">LipSync_Firmware.ino</a></td>
+    <td><a href="https://raw.githubusercontent.com/makersmakingchange/LipSync/master/Software/LipSync_Firmware/LipSync_Firmware.ino">LipSync_Firmware.ino</a></td>
   </tr>
   <tr>
     <td>LipSync Interface Board Layout</td>
@@ -115,55 +139,56 @@ This GitHub repository will serve as a database for all files and documentation
     <td>JLCPCB LipSync Interface Board Gerber</td>
     <td>2.71</td>
     <td>ZIP</td>
-    <td><a href="https://raw.githubusercontent.com/makersmakingchange/LipSync/master/Hardware/PCB_design/Gerber/LipSync_Interface_Board/JLCPCB_LipSync_Interface_Board.zip">JLCPCB_LipSync_Interface_Board.zip</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/PCB_design/Gerber/LipSync_Interface_Board/JLCPCB_LipSync_Interface_Board.zip">JLCPCB_LipSync_Interface_Board.zip</a></td>
   </tr>
   <tr>
     <td>OSHPark LipSync Interface Board Gerber</td>
     <td>2.71</td>
     <td>ZIP</td>
-    <td><a href="https://raw.githubusercontent.com/makersmakingchange/LipSync/master/Hardware/PCB_design/Gerber/LipSync_Interface_Board/OSHPark_LipSync_Interface_Board.zip">OSHPark_LipSync_Interface_Board.zip</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/PCB_design/Gerber/LipSync_Interface_Board/OSHPark_LipSync_Interface_Board.zip">OSHPark_LipSync_Interface_Board.zip</a></td>
   </tr>
   <tr>
     <td>PCBWay LipSync Interface Board Gerber</td>
     <td>2.71</td>
     <td>ZIP</td>
-    <td><a href="https://raw.githubusercontent.com/makersmakingchange/LipSync/master/Hardware/PCB_design/Gerber/LipSync_Interface_Board/PCBWay_LipSync_Interface_Board.zip">PCBWay_LipSync_Interface_Board.zip</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/PCB_design/Gerber/LipSync_Interface_Board/PCBWay_LipSync_Interface_Board.zip">PCBWay_LipSync_Interface_Board.zip</a></td>
   </tr>
   <tr>
     <td>Seeed Fusion LipSync Interface Board Gerber</td>
     <td>2.71</td>
     <td>ZIP</td>
-    <td><a href="https://raw.githubusercontent.com/makersmakingchange/LipSync/master/Hardware/PCB_design/Gerber/LipSync_Interface_Board/Seeed_Fusion_LipSync_Interface_Board.zip">Seeed_Fusion_LipSync_Interface_Board.zip</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/PCB_design/Gerber/LipSync_Interface_Board/Seeed_Fusion_LipSync_Interface_Board.zip">Seeed_Fusion_LipSync_Interface_Board.zip</a></td>
   </tr>
   <tr>
     <td rowspan="9">Housing_design</td>
-    <td rowspan="9">2.2d</td>
+    <td rowspan="9">3.0</td>
     <td rowspan="9">STL</td>
-    <td><a href="https://raw.githubusercontent.com/makersmakingchange/LipSync/master/Hardware/Housing_design/LipSync_Button.STL">LipSync_Button.STL</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/LipSync_Button.stl">LipSync_Button.STL</a></td>
   </tr>
   <tr>
-  <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/Housing_design/LipSync_Front_Housing.STL">LipSync_Front_Housing.STL</a></td>
+  <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/LipSync_Front_Housing.STL">LipSync_Front_Housing.STL</a></td>
   </tr>
   <tr>
-	<td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/Housing_design/LipSync_Joystick_Base.STL">LipSync_Joystick_Base.STL</a></td>
+	<td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/LipSync_Joystick_Base.STL">LipSync_Joystick_Base.STL</a></td>
 </tr>
 <tr>
-  <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/Housing_design/LipSync_Joystick_Front.STL">LipSync_Joystick_Front.STL</a></td>
+  <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/LipSync_Joystick_Front.STL">LipSync_Joystick_Front.STL</a></td>
 </tr>
 <tr>
-  <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/Housing_design/LipSync_Joystick_Rocker.STL">LipSync_Joystick_Rocker.STL</a></td>
+  <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/LipSync_Joystick_Rocker.STL">LipSync_Joystick_Rocker.STL</a></td>
 </tr>
 <tr>
-    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/LipSync_Joystick_Stand.STL">LipSync_Joystick_Stand.STL</a></td>
+    <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/Optional/LipSync_Joystick_Jig.STL">LipSync_Joystick_Jig.STL</a></td>
 </tr>
 <tr>
-  <td><a href="https://github.com/makersmakingchange/LipSync/raw/master/Hardware/Housing_design/LipSync_Rear_Housing.STL">LipSync_Rear_Housing.STL</a></td>
+  <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/LipSync_Rear_Housing.STL">LipSync_Rear_Housing.STL</a></td>
 </tr>
 <tr>
-  <td><a href="https://raw.githubusercontent.com/makersmakingchange/LipSync/master/Hardware/Housing_design/Print_Settings.txt">Print_Settings.txt</a></td>
+  <td><a href="https://github.com/makersmakingchange/LipSync/blob/master/Hardware/Housing_design/3D_Print_Settings.txt">3D_Print_Settings.txt</a></td>
 </tr>
 </table> 
 
+
 ## Resources
 
 <table style="width:100%">
@@ -172,35 +197,19 @@ This GitHub repository will serve as a database for all files and documentation
     <th>Link</th>
   </tr>
   <tr>
-    <td>LipSync Firmware and Calibration Tutorial</td>
+    <td>LipSync Firmware and Calibration Video</td>
     <td><a href="https://www.youtube.com/watch?v=RnpA24WH0Qk">Video</a></td>
+  <tr>
+    <td>LipSync Joystick Calibration Video</td>
+    <td><a href="https://www.youtube.com/watch?v=Daf-54y6SBg">Video</a></td>
   </tr>
     <tr>
-    <td>LipSync Build Tutorial</td>
+    <td>LipSync Build Video</td>
     <td><a href="https://www.youtube.com/watch?v=lBXpbkp5DW4&list=PLhoPg9bDvBR4CSFRfNbQ87ALnfaHOyM3C">Video</a></td>
   </tr>
 </table> 
 
-## Updates 
-For latest updates regarding the project we encourage you to visit our <a href="https://www.makersmakingchange.com/news/">blog</a> and <a href="https://hackaday.io/project/13424-lipsync">Hackaday</a> page.
-
-
-## Contact Us
-
-For technical questions, to get involved or share your LipSync experience we encourage you to contact [email protected].
-
-<p align="center">
-<a href="https://twitter.com/MakerMakeChange">
-         <img alt="Twitter" img align="center" src="https://i.imgur.com/OvSm9h3.png"></a> 
-<a href="https://www.instagram.com/makersmakingchange/">
-         <img alt="Instagram" img align="center" src="https://i.imgur.com/ouUS0Xa.png"></a>        
-<a href="https://www.facebook.com/makersmakechange/?fref=tag"> 
-         <img alt="Facebook" img align="center" src="https://i.imgur.com/Ok6Jn8P.png"></a>  
-<a href="https://www.youtube.com/channel/UCtn0ODz_yq_w9Uy6lUXGX-A"> 
-         <img alt="Youtube" img align="center" src="https://i.imgur.com/roSOrQE.png"></a>            
-</p>
-<br>
-<hr>
+## License
 <br>
 <p align="center">
 <a href="https://www.oshwa.org">
@@ -211,3 +220,22 @@ For technical questions, to get involved or share your LipSync experience we enc
 This is an open source hardware project and adheres to the Open Source Hardware (OSHW) Statement of Principle 1.0 and Open Source Hardware (OSHW) Definition 1.0 found at <a href="http://www.oshwa.org">www.oshwa.org</a>
 </p>
 
+## About Makers Making Change
+<img src="https://www.makersmakingchange.com/wp-content/uploads/logo/mmc_logo.svg" width="500" alt="Makers Making Change Logo">
+
+Makers Making Change is an initiative of [Neil Squire](https://www.neilsquire.ca/), a Canadian non-profit that helps people with disabilities.
+
+We are committed to creating a network of volunteer makers who support people with disabilities in their communities through building cost-effective assistive devices. Check out our library of free, open-source assistive technologies with parts and build instructions.
+
+ - [www.MakersMakingChange.com](https://www.makersmakingchange.com/)
+ - [GitHub](https://github.com/makersmakingchange)
+ - [Thingiverse](https://www.thingiverse.com/makersmakingchange/about)
+ - Twitter: [@makermakechange](https://twitter.com/makermakechange)
+ - Instagram: [@makersmakingchange](https://www.instagram.com/makersmakingchange)
+
+### Contact Us
+
+For technical questions, to get involved, or share your experience we encourage you to visit the [MMC Device Page](https://makersmakingchange.com/assistive-devices/), [MMC Forum](https://makersmakingchange.com/forum/), or contact [email protected]
+
+<hr>
+