Merge pull request #19 from BIRDSOpenSource/main

updating development branch

Author: MwithHeart

_site/about/index.html

@@ -0,0 +1,78 @@
+---
+title: How to Assemble the Access Board
+nav_order: 
+parent: How-to guides
+layout: default
+lang: en
+---
+
+# Assembling the Access Board
+
+## Overview
+
+This guide explains how to assemble the Access Board, including crimping wires, soldering components, and final assembly.
+
+## Before You Start
+
+Before assembling the Access Board, ensure you have:
+
+* **Tools:**
+  * Wire crimping tool
+  * Soldering iron and solder
+  * Wire strippers
+  * Multimeter
+  * Tweezers
+  * Screwdrivers (if applicable)
+  
+* **Materials:**
+  * Access Board PCB
+  * Connectors
+  * Wires (specified gauge and type)
+  * Headers and pins
+  * Resistors, capacitors, and other required components
+  * Heat shrink tubing (optional for insulation)
+
+## 1. Preparing the Components
+
+1.1. Gather all components listed in the BOM (Bill of Materials).
+1.2. Verify that all components are undamaged and match the required specifications.
+1.3. Arrange components in an organized manner for easy access during assembly.
+
+## 2. Crimping Wires and Attaching Connectors
+
+2.1. Measure and cut wires according to the specified lengths.
+2.2. Strip approximately 2-3mm of insulation from each wire end.
+2.3. Insert stripped wire ends into the connector pins.
+2.4. Use the crimping tool to securely crimp the connectors onto the wires.
+2.5. Verify the integrity of the crimp by gently pulling on the wire.
+
+## 3. Soldering Components to the PCB
+
+3.1. Place resistors, capacitors, and other passive components onto the designated pads.
+3.2. Secure components by bending leads slightly if necessary.
+3.3. Heat the soldering iron to the appropriate temperature (~350°C for leaded solder, ~400°C for lead-free solder).
+3.4. Apply solder to each pad, ensuring a strong connection without excessive solder.
+3.5. Trim excess component leads with wire cutters.
+
+## 4. Attaching Headers and Connectors
+
+4.1. Insert headers into the corresponding slots on the PCB.
+4.2. Solder each pin carefully, ensuring no bridges or cold joints.
+4.3. Inspect all connections with a magnifying glass or microscope.
+4.4. Use a multimeter to check for continuity and correct placement.
+
+## 5. Final Assembly and Testing
+
+5.1. Connect all crimped wires to the designated headers or connectors.
+5.2. Secure any loose wires using heat shrink tubing or zip ties.
+5.3. Power up the board with a regulated power source and check for voltage at key points.
+5.4. Perform a basic functionality test according to system requirements.
+
+## See Also
+
+* [Assembling the Programming Board](assembling_programming_board.md)
+* [Assembling the Access Cable](assembling_access_cable.md)
+* [Flashing the Firmware](flashing_firmware.md)
+
+[Previous]({{site.url}}/how-tos){: .btn .btn-purple }
+[Next]({{site.url}}/how-tos){: .btn}

_site/index.html

@@ -0,0 +1,62 @@
+---
+title: How to Assemble the Access Cable
+nav_order: 
+parent: How-to guides
+layout: default
+lang: en
+---
+
+
+# Assembling the Access Cable
+
+## Overview
+This guide explains how to assemble the access cable, including crimping wires, soldering, securing with Araldite, and verifying connections.
+
+## Before You Start
+Before assembling the access cable, ensure you have:
+
+* Crimping tool
+* Soldering iron and solder
+* Heat shrink tubing
+* Araldite epoxy
+* Multimeter for continuity checks
+* Wire stripper and cutter
+* Required connectors and wires
+
+## Steps
+
+1. **Prepare the Wires**
+    - Cut wires to the required length.
+    - Strip the insulation at the ends using a wire stripper.
+
+2. **Crimp the Connectors**
+    - Insert the stripped wire into the crimp terminal.
+    - Use the crimping tool to securely fasten the connection.
+    - Check for a firm grip by slightly pulling the wire.
+
+3. **Solder the Connections**
+    - Apply solder to each crimped terminal for extra strength and reliability.
+    - Ensure a clean and solid solder joint.
+
+4. **Secure with Heat Shrink Tubing**
+    - Slide heat shrink tubing over each soldered connection.
+    - Use a heat gun to shrink and insulate the connection.
+
+5. **Apply Araldite for Additional Securing**
+    - At the ends of the cable, apply Araldite epoxy to reinforce and protect the connections.
+    - Let it cure as per the manufacturer's instructions.
+
+6. **Check Connections**
+    - Use a multimeter to check continuity after each step.
+    - Ensure all connections are properly made before finalizing the assembly.
+
+## See Also
+* [Assembling the Access Board](assembling_access_board.md)
+* [Assembling the Programming Board](assembling_programming_board.md)
+* [Flashing the Software](flashing_microcontroller.md)
+
+
+
+
+[Previous]({{site.url}}/how-tos){: .btn .btn-purple }
+[Next]({{site.url}}/how-tos){: .btn}

how-tos/assemble_access_board.md

@@ -0,0 +1,51 @@
+---
+title: How to Assemble the Programming Board
+nav_order: 
+parent: How-to guides
+layout: default
+lang: en
+---
+
+# Assembling the Programming Board
+
+## Overview
+This guide explains how to assemble the programming board, including crimping wires, soldering, and final assembly steps.
+
+## Before You Start
+Before assembling the programming board, ensure you have the following:
+
+* Wire crimping tool
+* Soldering iron and solder
+* Heat shrink tubing
+* Required connectors and wires
+* PCB and components
+* Multimeter for testing
+* Safety goggles and gloves
+
+## Assembly Steps
+
+1. **Prepare the Components**
+    * Lay out all required components and verify their specifications.
+    * Cut wires to the appropriate lengths for connections.
+
+2. **Crimping Wires**
+    * Strip the wire ends to expose enough conductor for crimping.
+    * Use a crimping tool to attach the connectors securely.
+    * Verify crimped connections for stability and conductivity.
+
+3. **Soldering Components**
+    * Position components on the PCB as per the schematic layout.
+    * Heat the soldering iron and apply solder to each connection point.
+    * Inspect solder joints for a clean, strong connection.
+
+4. **Final Assembly**
+    * Secure all components in place and ensure proper alignment.
+    * Use heat shrink tubing for insulation where necessary.
+    * Check continuity with a multimeter before powering up.
+
+## See Also
+* [Troubleshooting Guide](#)
+* [Software Flashing Guide](#)
+
+[Previous]({{site.url}}/how-tos){: .btn .btn-purple }
+[Next]({{site.url}}/how-tos){: .btn}

how-tos/assemble_access_cable.md

@@ -0,0 +1,76 @@
+---
+title: How to Compile the Software
+nav_order: 
+parent: How-to guides
+layout: default
+lang: en
+---
+
+# Compiling the Software
+
+## Overview
+
+This guide explains how to compile the software for the PIC18F67J94 microcontroller using PIC C CCS v5.050. Note that previous BIRDS projects have used v5.076, so compatibility differences may exist.
+
+## Before you start
+
+Before compiling the software, ensure:
+
+* You have installed PIC C CCS v5.050 (or an alternative compatible version).
+* The source code is available and properly configured.
+* The necessary compiler settings are adjusted for your specific board.
+
+## Compiling the Software
+
+1. **Open the PIC C CCS Compiler**
+
+    Launch the CCS Compiler software and ensure your project directory is accessible.
+
+2. **Load the Project File**
+
+    - Navigate to `File > Open Project`.
+    - Select the `.prj` file corresponding to your board.
+
+3. **Verify Compiler Settings**
+
+    - Ensure the correct microcontroller (`PIC18F67J94`) is selected.
+    - Check that the compiler is set to the correct optimization and warning levels.
+    - Confirm the include paths and library dependencies are correctly configured.
+
+4. **Make Necessary Code Modifications**
+
+    If specific board settings need to be changed, update the following sections in the code:
+
+    ```c
+    // Example: Define board-specific configurations
+    #define BOARD_VERSION "v1.0"
+    #define USE_EXTERNAL_CLOCK 1
+    ```
+
+5. **Compile the Code**
+
+    - Click on `Compile` or use the shortcut (`Ctrl + F9`).
+    - The compiler will process the files and generate the necessary binaries.
+
+6. **Check for Errors and Warnings**
+
+    - If there are errors, review the error messages and adjust the code accordingly.
+    - Warnings should be noted but may not always require changes.
+
+7. **Verify the Output Files**
+
+    After a successful compilation, confirm the following output files are generated:
+
+    - `.hex` file (for flashing onto the microcontroller)
+    - `.lst` file (assembly listing)
+    - `.sym` file (symbol table)
+
+## See also
+
+* [Flashing the Software onto the Microcontroller]({{site.url}}/how-tos/flash_microcontroller.html)  
+* [Writing the Board-Specific Software File](writing_board_software.md)
+* [PIC C CCS Documentation](https://www.ccsinfo.com/)
+
+
+[Previous]({{site.url}}/how-tos){: .btn .btn-purple }
+[Next]({{site.url}}/how-tos/flash_microcontroller.html){: .btn}

how-tos/assemble_programming_board.md

@@ -0,0 +1,82 @@
+---
+title: How to Flash the Software
+nav_order: 
+parent: How-to guides
+layout: default
+lang: en
+---
+
+# Flashing the Software onto the Microcontroller
+
+## Overview
+
+This guide explains how to flash the compiled software onto the microcontroller using MPLAB IPE v6.0 and a PICkit3 programmer.
+
+> **Note:** Previous BIRDS projects may have used different versions of MPLAB IPE. Ensure that your setup is consistent with your project's requirements.
+
+## Before you start
+
+Before you proceed, ensure:
+
+* You have MPLAB IPE v6.0 installed on your system.
+* You have a functioning PICkit3 programmer.
+* The microcontroller is properly mounted on the subsystem board.
+* The compiled `.hex` file is available.
+* The necessary connections between the PICkit3 and the board are correctly set up.
+
+## Flashing the Microcontroller
+
+1. **Connect the PICkit3 to the board and computer.**
+   
+   - Plug the PICkit3 into the appropriate programming header on the subsystem board.
+   - Connect the PICkit3 to your computer via USB.
+
+2. **Launch MPLAB IPE.**
+   
+   - Open MPLAB IPE v6.0.
+   - In the `Device` dropdown, select the correct PIC microcontroller model (e.g., `PIC18F67J94`).
+
+3. **Establish communication with the device.**
+   
+   - Click the `Connect` button.
+   - Verify that MPLAB IPE successfully detects the microcontroller.
+
+4. **Load the compiled firmware.**
+   
+   - Click `Browse` in the `Hex File` section.
+   - Navigate to and select the compiled `.hex` file.
+
+5. **Configure programming settings.**
+   
+   - Ensure `Erase All Before Program` is selected.
+   - Verify that the correct voltage settings are applied (refer to board documentation).
+   - Disable `Code Protect` options unless needed.
+
+6. **Flash the microcontroller.**
+   
+   - Click `Program` to write the firmware to the microcontroller.
+   - Wait for the process to complete and check for success messages in the output log.
+
+7. **Verify the flashed firmware.**
+   
+   - Click `Verify` to ensure the program was correctly written.
+   - If verification fails, check wiring and try again.
+
+8. **Disconnect and test.**
+   
+   - Close MPLAB IPE.
+   - Disconnect the PICkit3.
+   - Power up the board and check if the software is functioning as expected.
+
+## See also
+
+* [MPLAB IPE User Guide](https://www.microchip.com/)
+* [PICkit3 Documentation](https://www.microchip.com/)
+* [Troubleshooting PICkit3 connection issues]
+
+
+
+
+
+[Previous]({{site.url}}/how-tos){: .btn .btn-purple }
+[Next]({{site.url}}/how-tos){: .btn}