Skip to content

Latest commit

 

History

History
204 lines (146 loc) · 6.03 KB

README.md

File metadata and controls

204 lines (146 loc) · 6.03 KB

Plan-Bee-

Hand crank Emergency Power Bank

Welcome! 👋

Introduction

Plan Bee

Andy, Jia Woei, Jinghui, Chermaine and Charissa are part of Plan Bee and we are making a prototype of an emergency hand crank power bank in fulfilment of the course PS5888: Making and Tinkering. In this particular repository, it would consists the C & C++ codes of our functions in our power bank for Arduino Uno and ESP32-WROOM-32D respectively. More Information can be found in our blog.


Content Of Repository

Listed below are the current codes for Plan Bee :

Hyperlinks to the respective folders

Click to view the table of content

Table of Content

Structure of repository

The structure of Plan Bee repository is as such:

Plan Bee 
│	README.md
│	LICENSE
│
├───	PCB Design
│	├─── PCB Main V1
│	├─── PCB Main V2
│	└─── PCB Main V3
│
├───	For Arduino
│	├─── INA226 for arduino uno
│	├─── INA3221 for arduino uno
│	├─── LED
│	└─── Voltage and Current sensor using ACS712 and potentiometer
│
├─── For ESP32
│	├─── for ILI9341
│	│    ├─── ILI9341_INA226
│	│    ├─── ILI9341_INA3221
│	│    ├─── graphictestILI9341
│	│    ├─── printextILI9341
│	│    └─── README.md
│	│
│	├─── for SH1106
│	│    ├─── SH1106 (using INA3221 and general use)
│	│    ├─── SH1106_forUsers (using INA3221 and for users)
│	│    └─── README.md
│	│
│	├─── for SSD1306
│	│    └───  INA3221_works
│	│
│	└─── intermediate
│	     ├─── Temperature
│	     └─── switch
│
├─── image
│	├─── Plan Bee Logo (ALIVE).png
│	├─── Plan Bee Logo (DEAD).png
│	├─── bee.jpg
│	└─── pinout.jpg
│
├─── modified libraries
│	├─── Adafruit_ILI9341
│	└─── TFT_eSPI
│


Libraries

These are libraries imported:

Current and Voltage Sensor

Display Screen

Datetime

Temperature Sensor

Encoder


Components

Currently, we use the following items for the functions:

Items Model No. 1 Model No. 2 Model No. 3
Current, Voltage Sensor INA3221 INA226 -
Display Screen SSD1306 SSH1106 ILI9341
Temperature Sensor DS18B20 - -
Encoder HW040 - -
Relay SRD-05VDC-SL-C - -
Button Tactile Push Button - -

Getting started

  1. Clone this repository into your working station, key in the following command in CMD(Windows) or Terminal(Mac or Linux).

For Windows/Mac, to save the repository content into a folder in Desktop:

cd Desktop

Followed by

git clone https://github.com/charutomo/Plan-Bee-

For Linux, to save the repository content into a folder in Desktop:

$ ls Desktop

Followed by

$ git clone https://github.com/charutomo/Plan-Bee-
  1. Install Arduino IDE(if you haven't) and download the libraries to have the full features.

  2. You can start upload code from the repository to test out.


Acknowledgement

Special thanks to Tony and Qi Jie for their guidance throughout the whole project of Plan Bee.


Further enquiries

Please direct your enquiries to [email protected] or under the issues section.


Thank you for your support! 😊