Skip to content

BuildClub-PresidencyUniversity/GuideBook

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 

Repository files navigation

GuideBook


Title: General Lab Instructions for Innovation Lab


Quiet Environment:

  1. Minimize Noise:

    • Keep noise levels to a minimum to provide a conducive working environment for everyone.
    • Use headphones when listening to audio, and set devices to low volume.
  2. Respect Concentration:

    • Respect the need for concentration during project work.
    • Use designated discussion areas for group conversations to avoid disturbing others.

Lab Etiquette:

  1. No Food Consumption:

    • Strictly refrain from eating or drinking in the lab area.
    • Utilize designated break areas for meals and snacks.
  2. Clean Workspaces:

    • Maintain a clean and organized workspace at all times.
    • Dispose of waste properly in designated bins.

Equipment Handling:

  1. Handle PCs with Care:

    • Treat computers and equipment with care and respect.
    • Avoid unnecessary force or rough handling when using peripherals and devices.
  2. Equipment Check-Out:

    • Sign out any equipment you borrow and return it promptly.
    • Report any malfunction or damage to lab staff immediately.
  3. Secure Personal Items:

    • Secure personal belongings to avoid clutter and ensure the safety of your possessions.
    • Use designated storage areas for bags and personal items.

Lab Safety:

  1. Emergency Procedures:

    • Familiarize yourself with emergency procedures, including the location of exits and emergency equipment.
    • Report any unsafe conditions or incidents promptly.
  2. Appropriate Attire:

    • Wear appropriate attire for the lab environment, including closed-toe shoes.
    • Avoid loose clothing that may pose a safety risk.

Project Collaboration:

  1. Collaboration Spaces:

    • Utilize designated collaboration spaces for group discussions and project work.
    • Respect others' space and projects during collaborative efforts.
  2. Innovation and Respect:

    • Encourage an atmosphere of innovation and creativity.
    • Respect diverse projects and ideas within the lab community.

Pro Tips:

  • Communication Channels:

    • Use communication channels effectively, such as project management tools or designated discussion platforms.
  • Scheduled Breaks:

    • Plan breaks in coordination with project timelines to maintain focus and productivity.
  • Project Documentation:

    • Keep thorough documentation of project work for future reference and collaboration.

Title: Arduino UNO & Mega Best Practices


Dos:

  1. Understanding Basics:

    • Do: Learn fundamental Arduino programming and electronics principles.
    • Do: Explore online resources and documentation for comprehensive understanding.
  2. Code Modularity:

    • Do: Write modular code with well-commented sections.
    • Do: Break down complex tasks into smaller functions for better code readability.
  3. Component Compatibility:

    • Do: Ensure components adhere to Arduino specifications.
    • Do: Check voltage (5V for UNO/Mega) and current requirements before connecting components.
  4. Documentation:

    • Do: Document projects with circuit diagrams and code explanations.
    • Do: Share documentation with the Arduino community for feedback.
  5. Power Management:

    • Do: Utilize external power sources when necessary.
    • Do: Monitor power consumption to prevent damage to the board or connected components.

Don'ts:

  1. Overloading Pins:

    • Don't: Exceed recommended current limits on Arduino pins (typically 20mA per pin).
    • Don't: Overload the board with peripherals without considering power requirements.
  2. Ignoring Heat:

    • Don't: Ignore heating issues; monitor the board's temperature during extended operations.
    • Don't: Overwork the board to the point of overheating.
  3. Skipping Prototyping:

    • Don't: Skip the prototyping phase; test on a breadboard before permanent connections.
    • Don't: Connect components directly without preliminary testing.
  4. Neglecting Error Handling:

    • Don't: Neglect error handling in your code; anticipate and handle potential issues.
    • Don't: Assume everything will work perfectly; include error-checking mechanisms.
  5. Disregarding Safety:

    • Don't: Disregard safety precautions when working with high voltage or sensitive components.
    • Don't: Forget to disconnect power sources before modifying connections.

Pro Tips:

  • Community Engagement:

    • Engage with the Arduino community for support and inspiration.
    • Share projects on forums for valuable feedback.
  • Version Control:

    • Utilize version control systems (e.g., Git) for managing and tracking code changes.
  • Optimization:

    • Optimize code for performance and memory usage.
    • Explore advanced features of the Arduino IDE to enhance programming skills.

Title: Arduino Nano Best Practices


Dos:

  1. Understanding Basics:

    • Do: Familiarize yourself with fundamental Arduino programming and electronics concepts.
    • Do: Refer to online resources and documentation for comprehensive learning.
  2. Code Modularity:

    • Do: Write modular code with clear comments.
    • Do: Break down complex tasks into smaller functions for improved code organization.
  3. Component Compatibility:

    • Do: Ensure components adhere to Arduino Nano specifications.
    • Do: Check voltage (5V) and current requirements before connecting components.
  4. Documentation:

    • Do: Document projects with circuit diagrams and code explanations.
    • Do: Share documentation with the Arduino community for valuable feedback.
  5. Power Management:

    • Do: Use an external power source when needed.
    • Do: Monitor power consumption to prevent damage to the board or connected components.

Don'ts:

  1. Overloading Pins:

    • Don't: Exceed recommended current limits on Arduino Nano pins (typically 40mA per pin).
    • Don't: Overload the board with peripherals without considering power requirements.
  2. Ignoring Heat:

    • Don't: Ignore heating issues; monitor the board's temperature during extended operations.
    • Don't: Overwork the board to the point of overheating.
  3. Skipping Prototyping:

    • Don't: Skip the prototyping phase; test on a breadboard before permanent connections.
    • Don't: Connect components directly without preliminary testing.
  4. Neglecting Error Handling:

    • Don't: Neglect error handling in your code; anticipate and handle potential issues.
    • Don't: Assume everything will work perfectly; include error-checking mechanisms.
  5. Disregarding Safety:

    • Don't: Disregard safety precautions when working with high voltage or sensitive components.
    • Don't: Forget to disconnect power sources before modifying connections.

Caution Regarding Breadboard Connections:

  • Caution: When connecting Arduino Nano to a breadboard, ensure jumper wires are appropriately sized to avoid short circuits. Avoid overly short connections that may lead to accidental contact and potential damage to the board or connected components.

Pro Tips:

  • Community Engagement:

    • Engage with the Arduino community for support and inspiration.
    • Share projects on forums for valuable feedback.
  • Version Control:

    • Utilize version control systems (e.g., Git) for managing and tracking code changes.
  • Optimization:

    • Optimize code for performance and memory usage.
    • Explore advanced features of the Arduino IDE to enhance programming skills.

Title: Jetson Nano Best Practices


Dos:

  1. Understanding Basics:

    • Do: Familiarize yourself with the fundamental concepts of the Jetson Nano development kit.
    • Do: Refer to the official documentation and online resources for a comprehensive understanding.
  2. Code Optimization:

    • Do: Optimize your code for efficient GPU utilization.
    • Do: Leverage parallel processing capabilities for improved performance.
  3. Power Management:

    • Do: Use a high-quality power supply to meet the recommended power specifications.
    • Do: Be mindful of power consumption, especially when connecting external peripherals.
  4. Cooling Solutions:

    • Do: Implement adequate cooling solutions to prevent overheating.
    • Do: Monitor the temperature of the Jetson Nano during resource-intensive tasks.
  5. Peripheral Compatibility:

    • Do: Ensure that connected peripherals (sensors, cameras, etc.) are compatible with the Jetson Nano.
    • Do: Check power requirements and communication protocols.

Don'ts:

  1. Insufficient Power Supply:

    • Don't: Use an inadequate power supply; ensure it meets the recommended specifications.
    • Don't: Underestimate the power requirements when using additional peripherals.
  2. Neglecting Cooling:

    • Don't: Neglect cooling solutions; monitor and manage the temperature to avoid performance issues.
    • Don't: Overload the Jetson Nano without considering the need for additional cooling.
  3. Unoptimized Code:

    • Don't: Ignore code optimization for the GPU.
    • Don't: Neglect parallel processing capabilities for improved performance.
  4. Improper Handling:

    • Don't: Handle the Jetson Nano without proper ESD precautions.
    • Don't: Connect or disconnect peripherals while the device is powered.
  5. Disregarding Documentation:

    • Don't: Disregard the official documentation and guidelines.
    • Don't: Assume hardware or software compatibility without verification.

Caution Regarding Peripheral Connections:

  • Caution: When connecting peripherals to the Jetson Nano, ensure proper voltage levels and use appropriate connectors. Avoid hot-swapping peripherals to prevent potential damage.

Pro Tips:

  • Community Engagement:

    • Engage with the Jetson Nano community for support and collaboration.
    • Share your projects and seek advice on forums or online platforms.
  • Version Control:

    • Utilize version control systems (e.g., Git) for managing and tracking code changes.
  • Documentation:

    • Document your projects, including hardware setups and code explanations.
    • Share your documentation with the community to contribute and receive feedback.

Certainly! Here's a set of Dos and Don'ts for working with STM32 Blue Pill and Black Pill development boards:


Title: STM32 Blue Pill & Black Pill Best Practices


Dos:

  1. Understanding Basics:

    • Do: Acquaint yourself with the fundamental concepts of STM32 microcontrollers.
    • Do: Refer to the official datasheets and reference manuals for comprehensive understanding.
  2. Code Modularity:

    • Do: Write modular and well-commented code.
    • Do: Break down complex tasks into smaller functions for better code organization.
  3. Peripheral Configuration:

    • Do: Configure peripherals accurately based on project requirements.
    • Do: Utilize CubeMX or other tools for simplified peripheral initialization.
  4. Power Management:

    • Do: Be mindful of power consumption; optimize code for power-efficient operation.
    • Do: Utilize low-power modes when applicable to conserve energy.
  5. External Crystal Usage:

    • Do: Use an external crystal for accurate clock generation.
    • Do: Configure the system clock settings for reliable operation.

Don'ts:

  1. Insufficient Power Supply:

    • Don't: Use an inadequate power supply; ensure it meets the voltage and current requirements.
    • Don't: Underestimate power needs when using additional peripherals.
  2. Neglecting Pull-up/Pull-down Resistors:

    • Don't: Neglect the use of pull-up/pull-down resistors when interfacing with external components.
    • Don't: Assume default pin states; configure GPIO pins properly.
  3. Unoptimized Code:

    • Don't: Neglect code optimization for efficient execution.
    • Don't: Overlook opportunities for optimizing memory usage.
  4. Overclocking:

    • Don't: Overclock the microcontroller beyond recommended specifications.
    • Don't: Compromise stability for marginal performance gains.
  5. Disregarding Datasheets:

    • Don't: Disregard the official datasheets and reference manuals.
    • Don't: Assume hardware or software behavior without verifying specifications.

Caution Regarding Breadboard Connections:

  • Caution: When using Blue Pill or Black Pill on a breadboard, be cautious of the physical size and pinout differences. Ensure correct pin connections and avoid short circuits.

Pro Tips:

  • Community Engagement:

    • Engage with the STM32 community for support and collaboration.
    • Share your projects and seek advice on forums or online platforms.
  • Version Control:

    • Utilize version control systems (e.g., Git) for managing and tracking code changes.
  • Documentation:

    • Document your projects, including hardware setups and code explanations.
    • Share your documentation with the community to contribute and receive feedback.

Title: ESP8266, ESP32, ESP8266-01 Best Practices


Dos:

  1. Voltage Compatibility:

    • Do: Ensure proper voltage levels for ESP8266 and ESP32 modules (typically 3.3V).
    • Do: Check the datasheets for specific voltage requirements for each pin.
  2. Power Supply Stability:

    • Do: Use a stable and regulated power supply within the recommended voltage range.
    • Do: Consider external power sources for stable operation, especially in projects with additional peripherals.
  3. Peripheral Voltage Matching:

    • Do: Match the voltage levels of external peripherals with the ESP module.
    • Do: Use level shifters if interfacing with components operating at different voltage levels.
  4. Deep Sleep Mode:

    • Do: Utilize deep sleep mode to conserve power when the module is not actively processing.
    • Do: Consider external triggers to wake up the module when needed.
  5. Breadboard Connections:

    • Do: Be mindful of voltage levels when using ESP8266-01 on a breadboard.
    • Do: Use voltage dividers or level shifters for proper connections on a breadboard.

Don'ts:

  1. Exceeding Voltage Limits:

    • Don't: Exceed the specified voltage limits for ESP8266 and ESP32.
    • Don't: Connect pins to voltages beyond their tolerance levels.
  2. Inadequate Power Supply:

    • Don't: Use an insufficient power supply; ensure it meets the voltage and current requirements.
    • Don't: Neglect the impact of power supply instability on module performance.
  3. Ignoring Deep Sleep Optimization:

    • Don't: Neglect optimizing code for deep sleep mode.
    • Don't: Overlook opportunities to minimize power consumption during sleep periods.
  4. Voltage Mismatch with Peripherals:

    • Don't: Connect peripherals with voltage levels that exceed ESP module tolerances.
    • Don't: Ignore the need for level shifters when interfacing with components at different voltage levels.
  5. Neglecting Breadboard Voltage Considerations:

    • Don't: Neglect voltage level differences when using ESP8266-01 on a breadboard.
    • Don't: Use direct connections without proper voltage management.

Caution Regarding ESP8266-01 on Breadboard:

  • Caution: When using ESP8266-01 on a breadboard, be aware of the limited GPIO pins and manage voltage levels carefully. Avoid short circuits and verify connections for proper functioning.

Pro Tips:

  • Community Engagement:

    • Engage with the ESP8266/ESP32 community for support and collaboration.
    • Share your voltage management techniques and learn from others in the community.
  • Version Control:

    • Utilize version control systems (e.g., Git) for managing and tracking code changes.
  • Documentation:

    • Document your projects, including voltage setups and code explanations.
    • Share your documentation with the community to contribute and receive feedback.

Title: Raspberry Pi 4B+, 5, and Zero W Best Practices


Dos:

  1. Power Supply:

    • Do: Use a reliable power supply that meets the voltage and current requirements of each Raspberry Pi model.
    • Do: Consider an official power supply or one with similar specifications.
  2. Cooling Solutions:

    • Do: Implement adequate cooling solutions, especially for Raspberry Pi 4B+.
    • Do: Monitor temperatures and adjust cooling as needed for optimal performance.
  3. MicroSD Card Quality:

    • Do: Use a high-quality microSD card with sufficient capacity for storage.
    • Do: Consider using reputable brands known for reliability and endurance.
  4. Peripheral Compatibility:

    • Do: Ensure compatibility of peripherals (USB devices, cameras, etc.) with the specific Raspberry Pi model.
    • Do: Check power requirements and communication protocols.
  5. Proper Shutdown:

    • Do: Follow proper shutdown procedures to avoid potential data corruption on the microSD card.
    • Do: Use a shutdown command or the graphical interface to power off the Raspberry Pi safely.

Don'ts:

  1. Inadequate Power Supply:

    • Don't: Use an insufficient power supply; ensure it meets the voltage and current requirements.
    • Don't: Neglect the impact of power supply instability on Raspberry Pi performance.
  2. Neglecting Cooling:

    • Don't: Neglect cooling, especially for resource-intensive tasks on Raspberry Pi 4B+.
    • Don't: Overload the Raspberry Pi without considering the need for additional cooling.
  3. Low-Quality MicroSD Cards:

    • Don't: Use low-quality or counterfeit microSD cards.
    • Don't: Ignore the importance of a reliable storage medium for stability.
  4. Mismatched Peripheral Power:

    • Don't: Connect peripherals that exceed the power capabilities of the USB ports.
    • Don't: Overload the USB ports with devices that draw excessive current.
  5. Abrupt Shutdowns:

    • Don't: Abruptly disconnect power without shutting down the Raspberry Pi properly.
    • Don't: Underestimate the risk of data corruption due to sudden power loss.

Caution for Raspberry Pi Zero W:

  • Caution: Raspberry Pi Zero W has limited processing power and connectivity. Use it for lightweight projects and consider its constraints when planning projects.

Pro Tips:

  • Community Engagement:

    • Engage with the Raspberry Pi community for support and collaboration.
    • Share your projects and seek advice on forums or online platforms.
  • Documentation:

    • Document your projects, including hardware setups and code explanations.
    • Share your documentation with the community to contribute and receive feedback.
  • Storage Optimization:

    • Optimize storage usage by regularly cleaning up unnecessary files and logs.
    • Consider using external storage solutions for larger data requirements.

Title: Raspberry Pi Pico Best Practices


Dos:

  1. Voltage and Power:

    • Do: Operate the Raspberry Pi Pico within the specified voltage range (typically 3.3V).
    • Do: Use a stable power supply within the recommended voltage and current limits.
  2. Microcontroller Pin Usage:

    • Do: Refer to the datasheet and documentation for pin functionality and capabilities.
    • Do: Follow proper GPIO pin configurations based on your project requirements.
  3. MicroUSB Connectivity:

    • Do: Use the MicroUSB port for power and programming.
    • Do: Verify the USB cable quality to ensure reliable connectivity.
  4. Circuit Protection:

    • Do: Implement proper circuit protection measures, such as current-limiting resistors.
    • Do: Be cautious when interfacing with external components to prevent damage.
  5. Official Documentation:

    • Do: Refer to the official Raspberry Pi Pico documentation for comprehensive information.
    • Do: Stay updated on firmware releases and software libraries.

Don'ts:

  1. Exceeding Voltage Limits:

    • Don't: Exceed the specified voltage limits for Raspberry Pi Pico.
    • Don't: Connect pins to voltages beyond their tolerance levels.
  2. Unstable Power Supply:

    • Don't: Use an unstable or inadequate power supply.
    • Don't: Neglect the impact of power supply instability on Raspberry Pi Pico performance.
  3. Incorrect Pin Configurations:

    • Don't: Misconfigure GPIO pins without referring to the documentation.
    • Don't: Assume default pin states; configure pins properly for your project.
  4. Neglecting Circuit Protection:

    • Don't: Neglect the need for circuit protection when interfacing with external components.
    • Don't: Disregard the current requirements of connected devices.
  5. Ignoring Documentation:

    • Don't: Disregard the official documentation and guidelines.
    • Don't: Assume hardware or software behavior without verifying specifications.

Pro Tips:

  • Community Engagement:

    • Engage with the Raspberry Pi Pico community for support and collaboration.
    • Share your projects and seek advice on forums or online platforms.
  • Code Optimization:

    • Optimize your code for efficient execution on the Raspberry Pi Pico.
    • Utilize available software libraries to streamline development.
  • Version Control:

    • Utilize version control systems (e.g., Git) for managing and tracking code changes.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published