installation guide.md - ToufickShaikh/Picosack GitHub Wiki

Installation Guide for Picosack

This guide will walk you through the process of installing Picosack, the lightweight web server designed for ESP8266-based IoT devices. By following these steps, you'll be able to set up Picosack and start hosting web applications directly on your IoT device.

Prerequisites

Before you begin, make sure you have the following prerequisites in place:

  1. Arduino IDE: Ensure you have the latest version of the Arduino IDE installed on your computer. You can download it from the official Arduino website: https://www.arduino.cc/en/software

  2. ESP8266 Board Package: Install the ESP8266 board package in Arduino IDE. Here's how:

    • Open Arduino IDE and go to File > Preferences.
    • In the "Additional Boards Manager URLs" field, enter the following URL and click OK:
      http://arduino.esp8266.com/stable/package_esp8266com_index.json
      
    • Go to Tools > Board > Boards Manager.
    • Search for "esp8266" and install the board package by ESP8266 Community.
  3. ESP8266 Device: Have an ESP8266-based IoT device (e.g., NodeMCU, Wemos D1 Mini) ready for programming.

Installation Steps

  1. Download Picosack Repository:

    • Visit the Picosack GitHub repository: https://github.com/Toufick190/Picosack
    • Click on the "Code" button and select "Download ZIP" to download the repository as a ZIP file.
    • Extract the contents of the ZIP file to a location of your choice on your computer.
  2. Open Arduino IDE:

    • Launch the Arduino IDE on your computer.
  3. Add Picosack Library:

    • Go to Sketch > Include Library > Manage Libraries.
    • Search for "Picosack" in the Library Manager.
    • Click on "Picosack" and then click the "Install" button.
  4. Select ESP8266 Board:

    • Go to Tools > Board and select the appropriate ESP8266 board variant you are using (e.g., NodeMCU, Wemos D1 Mini).
  5. Upload Example Code:

    • In the Arduino IDE, go to File > Examples > Picosack and select one of the example sketches.
    • Modify the example code as needed for your project.
    • Connect your ESP8266 device to your computer using a USB cable.
  6. Upload to Device:

    • Click the "Upload" button in the Arduino IDE to compile and upload the code to your ESP8266 device.
    • Once the upload is complete, you should see the status messages in the Arduino IDE's console.
  7. Access Web Application:

    • After uploading the code, your IoT device will act as a web server.
    • Open a web browser and enter the IP address of your IoT device to access the hosted web application.

Congratulations! You have successfully installed Picosack and hosted a web application on your ESP8266-based IoT device. You can now explore Picosack's features and create your own web-enabled projects.

For more information and resources, refer to the Picosack GitHub Repository and the official documentation.