updated to 2019 standards till embedded programming

gitbook/computer-controlled_machining.md

@@ -2,10 +2,10 @@
 
 ## Computer controlled machining
 
-Group assignment
-* Test runout, alignment, speeds, feeds and toolpaths for your machine 
-Individual assignment
-* Make something [big](http://blog.ted.com/2008/07/15/digitally_fabbe/) (on a CNC machine).
+Group assignment:
+* Test runout, alignment, speeds, feeds, and toolpaths for your machine 
+Individual assignment:
+* Make (design+mill+assemble) something [big](http://blog.ted.com/2008/07/15/digitally_fabbe/).
 
 ### Learning outcomes
 
@@ -22,10 +22,8 @@ Individual assignment
 ## FAQ
 
 ### How big is big?
-> Answer:
-1. Big enough to show you understand many of the possibilities of CNC machining - drill, pocket, dogbones, nesting, etc.
+> Answer: Big enough to show you understand many of the possibilities of CNC machining - drill, pocket, dogbones, nesting, etc.
 
 ### Does it have to be wood or wood products?
-> Answer:
-1. No. But the lab is only responsible for providing you with a full size wood board. 
+> Answer: No. But the lab is only responsible for providing you with a full size wood board. 
 

gitbook/electronics_design.md

@@ -2,9 +2,12 @@
 
 ## Electronics Design
 
-* Use the test equipment in your lab to observe the operation of a microcontroller circuit board (group project)
+Group assignment:
+* Use the test equipment in your lab to observe the operation of a microcontroller circuit board
+Individual assignment:
 * Redraw the echo hello-world board, add (at least) a button and LED (with current-limiting resistor), check the design rules, make it (_if you have time this week, test it_).
-_optional: simulate its operation. Measure its operation_
+Extra credit: 
+* Simulate its operation. Render it.
 
 ### Learning outcomes
 
@@ -20,12 +23,8 @@ _optional: simulate its operation. Measure its operation_
 ## FAQ
 
 ### Can I modify an existing design board?
-> Answer:
-1. Yes as long as you acknowledge the original design and explain your contribution to the board.
+> Answer: Yes as long as you acknowledge the original design and explain your contribution to the board.
 
 ### Do I need to create a schematic file?
-> Answer:
-1. If your software does not generate it no, otherwise yes. You can draw or use kokopelli which does not create schematic files.
-
-> NB.  Also, if you make a board and it doesn't work; franken-hack that board (with jumper wires etc) until it does work, then make a new one with the knowledge you have gained.
+> Answer: If your software does not generate it no, otherwise yes. You can draw or use kokopelli which does not create schematic files.
 

gitbook/embedded_programming.md

@@ -2,7 +2,9 @@
 
 ## Embedded Programming
 
-* Compare the performance and development workflows for other architectures (group project)
+Group assignment:
+* Compare the performance and development workflows for other architectures
+Individual assignment:
 * Read a microcontroller [data sheet](http://academy.cba.mit.edu/classes/embedded_programming/doc8183.pdf).
 * Program your [board](http://academy.cba.mit.edu/classes/electronics_design/index.html) to do something, with as many different programming languages and programming environments as possible.
 
@@ -22,11 +24,11 @@
 ## FAQ
 
 ### If I adjust existing code, is that now my code?
-> Answer:
-1. You must acknowledge whoever made it. See [General Essentials](http://fabacademy.org/2018/docs/FabAcademy-Assessment/general_essentials.html).
-2. To succeed in this project, experiment with changing the code, understand how that worked, and write your own.
+> Answer: If you use someone's else code as a starting point, remember that you must acknowledge whoever made it. See [General Essentials](http://fabacademy.org/2018/docs/FabAcademy-Assessment/general_essentials.html). To succeed in this project, experiment with changing the code, understand how that worked, and write your own.
 
 ### How do I prove I've read the Data Sheet?
-> Answer:
-1. Point out things in your code and board design that you learnt from the Data Sheet. Also point to other weeks when you used a Data Sheet.
+> Answer: Point out things in your code and board design that you learnt from the Data Sheet. Also point to other weeks when you used a Data Sheet.
+
+### How should I put my code on my website?
+> Answer: As a file for download, same as all your other assignments. Keep your webpage tidy and easy to read.
 

json/computer-controlled_machining.json

 {
-    "faq": "### How big is big?\n> Answer:\n1. Big enough to show you understand many of the possibilities of CNC machining - drill, pocket, dogbones, nesting, etc.\n\n### Does it have to be wood or wood products?\n> Answer:\n1. No. But the lab is only responsible for providing you with a full size wood board. \n", 
+    "faq": "### How big is big?\n> Answer: Big enough to show you understand many of the possibilities of CNC machining - drill, pocket, dogbones, nesting, etc.\n\n### Does it have to be wood or wood products?\n> Answer: No. But the lab is only responsible for providing you with a full size wood board. \n", 
     "tasks": [
         {
             "checklist": [
@@ -8,7 +8,7 @@
                 "Described problems and how you fixed them", 
                 "Included your design files and \u2018hero shot\u2019 photos of final object"
             ], 
-            "description": "Group assignment\n* Test runout, alignment, speeds, feeds and toolpaths for your machine \nIndividual assignment\n* Make something [big](http://blog.ted.com/2008/07/15/digitally_fabbe/) (on a CNC machine).\n", 
+            "description": "Group assignment:\n* Test runout, alignment, speeds, feeds, and toolpaths for your machine \nIndividual assignment:\n* Make (design+mill+assemble) something [big](http://blog.ted.com/2008/07/15/digitally_fabbe/).\n", 
             "name": "Computer controlled machining", 
             "outcomes": [
                 "Demonstrate 2D design development for CNC production", 
@@ -16,7 +16,7 @@
             ]
         }
     ], 
-    "version": 2018, 
+    "version": 2019, 
     "unit": "Computer controlled machining", 
     "unit_id": "computer-controlled_machining"
 }
\ No newline at end of file

json/electronics_design.json

 {
-    "faq": "### Can I modify an existing design board?\n> Answer:\n1. Yes as long as you acknowledge the original design and explain your contribution to the board.\n\n### Do I need to create a schematic file?\n> Answer:\n1. If your software does not generate it no, otherwise yes. You can draw or use kokopelli which does not create schematic files.\n\n> NB.  Also, if you make a board and it doesn't work; franken-hack that board (with jumper wires etc) until it does work, then make a new one with the knowledge you have gained.\n", 
+    "faq": "### Can I modify an existing design board?\n> Answer: Yes as long as you acknowledge the original design and explain your contribution to the board.\n\n### Do I need to create a schematic file?\n> Answer: If your software does not generate it no, otherwise yes. You can draw or use kokopelli which does not create schematic files.\n", 
     "tasks": [
         {
             "checklist": [
@@ -7,7 +7,7 @@
                 "Explained problems and how you fixed them, including how you worked with design rules for milling (DRC in EagleCad and KiCad)", 
                 "Included original design files (Eagle, KiCad, Inkscape, .cad - whatever)"
             ], 
-            "description": "* Use the test equipment in your lab to observe the operation of a microcontroller circuit board (group project)\n* Redraw the echo hello-world board, add (at least) a button and LED (with current-limiting resistor), check the design rules, make it (_if you have time this week, test it_).\n_optional: simulate its operation. Measure its operation_\n", 
+            "description": "Group assignment:\n* Use the test equipment in your lab to observe the operation of a microcontroller circuit board\nIndividual assignment:\n* Redraw the echo hello-world board, add (at least) a button and LED (with current-limiting resistor), check the design rules, make it (_if you have time this week, test it_).\nExtra credit: \n* Simulate its operation. Render it.\n", 
             "name": "Electronics Design", 
             "outcomes": [
                 "Select and use software for circuit board design", 
@@ -15,7 +15,7 @@
             ]
         }
     ], 
-    "version": 2018, 
+    "version": 2019, 
     "unit": "Electronics Design", 
-    "unit_id": "3d_scanning_and_printing"
+    "unit_id": "electronics_design"
 }
\ No newline at end of file

json/embedded_programming.json

 {
-    "faq": "### If I adjust existing code, is that now my code?\n> Answer:\n1. You must acknowledge whoever made it. See [General Essentials](http://fabacademy.org/2018/docs/FabAcademy-Assessment/general_essentials.html).\n2. To succeed in this project, experiment with changing the code, understand how that worked, and write your own.\n\n### How do I prove I've read the Data Sheet?\n> Answer:\n1. Point out things in your code and board design that you learnt from the Data Sheet. Also point to other weeks when you used a Data Sheet.\n", 
+    "faq": "### If I adjust existing code, is that now my code?\n> Answer: If you use someone's else code as a starting point, remember that you must acknowledge whoever made it. See [General Essentials](http://fabacademy.org/2018/docs/FabAcademy-Assessment/general_essentials.html). To succeed in this project, experiment with changing the code, understand how that worked, and write your own.\n\n### How do I prove I've read the Data Sheet?\n> Answer: Point out things in your code and board design that you learnt from the Data Sheet. Also point to other weeks when you used a Data Sheet.\n\n### How should I put my code on my website?\n> Answer: As a file for download, same as all your other assignments. Keep your webpage tidy and easy to read.\n", 
     "tasks": [
         {
             "checklist": [
@@ -9,7 +9,7 @@
                 "Described the programming process/es you used", 
                 "Included your code"
             ], 
-            "description": "* Compare the performance and development workflows for other architectures (group project)\n* Read a microcontroller [data sheet](http://academy.cba.mit.edu/classes/embedded_programming/doc8183.pdf).\n* Program your [board](http://academy.cba.mit.edu/classes/electronics_design/index.html) to do something, with as many different programming languages and programming environments as possible.\n", 
+            "description": "Group assignment:\n* Compare the performance and development workflows for other architectures\nIndividual assignment:\n* Read a microcontroller [data sheet](http://academy.cba.mit.edu/classes/embedded_programming/doc8183.pdf).\n* Program your [board](http://academy.cba.mit.edu/classes/electronics_design/index.html) to do something, with as many different programming languages and programming environments as possible.\n", 
             "name": "Embedded Programming", 
             "outcomes": [
                 "Identify relevant information in a microcontroller data sheet.", 
@@ -17,7 +17,7 @@
             ]
         }
     ], 
-    "version": 2018, 
+    "version": 2019, 
     "unit": "Embedded Programming", 
-    "unit_id": "embedded_programming.md"
+    "unit_id": "embedded_programming"
 }
\ No newline at end of file

src/computer-controlled_machining.yaml

 unit: Computer controlled machining
 unit_id: computer-controlled_machining
-version: 2018
+version: 2019
 tasks:
 - name: Computer controlled machining
   description: |
-    Group assignment
-    * Test runout, alignment, speeds, feeds and toolpaths for your machine 
-    Individual assignment
-    * Make something [big](http://blog.ted.com/2008/07/15/digitally_fabbe/) (on a CNC machine).
+    Group assignment:
+    * Test runout, alignment, speeds, feeds, and toolpaths for your machine 
+    Individual assignment:
+    * Make (design+mill+assemble) something [big](http://blog.ted.com/2008/07/15/digitally_fabbe/).
   outcomes:
   - Demonstrate 2D design development for CNC production
   - Describe workflows for CNC production
@@ -18,9 +18,7 @@ tasks:
   - Included your design files and ‘hero shot’ photos of final object
 faq: |
   ### How big is big?
-  > Answer:
-  1. Big enough to show you understand many of the possibilities of CNC machining - drill, pocket, dogbones, nesting, etc.
+  > Answer: Big enough to show you understand many of the possibilities of CNC machining - drill, pocket, dogbones, nesting, etc.
 
   ### Does it have to be wood or wood products?
-  > Answer:
-  1. No. But the lab is only responsible for providing you with a full size wood board. 
+  > Answer: No. But the lab is only responsible for providing you with a full size wood board. 

src/electronics_design.yaml

 unit: Electronics Design
-unit_id: 3d_scanning_and_printing
-version: 2018
+unit_id: electronics_design
+version: 2019
 tasks:
 - name: Electronics Design
   description: |
-    * Use the test equipment in your lab to observe the operation of a microcontroller circuit board (group project)
+    Group assignment:
+    * Use the test equipment in your lab to observe the operation of a microcontroller circuit board
+    Individual assignment:
     * Redraw the echo hello-world board, add (at least) a button and LED (with current-limiting resistor), check the design rules, make it (_if you have time this week, test it_).
-    _optional: simulate its operation. Measure its operation_
+    Extra credit: 
+    * Simulate its operation. Render it.
   outcomes:
   - Select and use software for circuit board design
   - Demonstrate workflows used in circuit board design
@@ -16,11 +19,7 @@ tasks:
   - Included original design files (Eagle, KiCad, Inkscape, .cad - whatever)
 faq: |
   ### Can I modify an existing design board?
-  > Answer:
-  1. Yes as long as you acknowledge the original design and explain your contribution to the board.
+  > Answer: Yes as long as you acknowledge the original design and explain your contribution to the board.
 
   ### Do I need to create a schematic file?
-  > Answer:
-  1. If your software does not generate it no, otherwise yes. You can draw or use kokopelli which does not create schematic files.
-
-  > NB.  Also, if you make a board and it doesn't work; franken-hack that board (with jumper wires etc) until it does work, then make a new one with the knowledge you have gained.
+  > Answer: If your software does not generate it no, otherwise yes. You can draw or use kokopelli which does not create schematic files.

src/embedded_programming.yaml

 unit: Embedded Programming
-unit_id: embedded_programming.md
-version: 2018
+unit_id: embedded_programming
+version: 2019
 tasks:
 - name: Embedded Programming
   description: |
-    * Compare the performance and development workflows for other architectures (group project)
+    Group assignment:
+    * Compare the performance and development workflows for other architectures
+    Individual assignment:
     * Read a microcontroller [data sheet](http://academy.cba.mit.edu/classes/embedded_programming/doc8183.pdf).
     * Program your [board](http://academy.cba.mit.edu/classes/electronics_design/index.html) to do something, with as many different programming languages and programming environments as possible.
   outcomes:
@@ -18,10 +20,10 @@ tasks:
   - Included your code
 faq: |
   ### If I adjust existing code, is that now my code?
-  > Answer:
-  1. You must acknowledge whoever made it. See [General Essentials](http://fabacademy.org/2018/docs/FabAcademy-Assessment/general_essentials.html).
-  2. To succeed in this project, experiment with changing the code, understand how that worked, and write your own.
+  > Answer: If you use someone's else code as a starting point, remember that you must acknowledge whoever made it. See [General Essentials](http://fabacademy.org/2018/docs/FabAcademy-Assessment/general_essentials.html). To succeed in this project, experiment with changing the code, understand how that worked, and write your own.
 
   ### How do I prove I've read the Data Sheet?
-  > Answer:
-  1. Point out things in your code and board design that you learnt from the Data Sheet. Also point to other weeks when you used a Data Sheet.
+  > Answer: Point out things in your code and board design that you learnt from the Data Sheet. Also point to other weeks when you used a Data Sheet.
+
+  ### How should I put my code on my website?
+  > Answer: As a file for download, same as all your other assignments. Keep your webpage tidy and easy to read.