Browse Source

Improved keyboard pin assignment, added connection diagram and expanded documentation.

master
parent
commit
8b2aea8994
3 changed files with 23 additions and 45 deletions
  1. BIN
      Connection Diagram_UI.png
  2. +11
    -11
      DisplayESP32.ino
  3. +12
    -34
      Readme.md

BIN
Connection Diagram_UI.png View File

Before After
Width: 814  |  Height: 848  |  Size: 25 KiB

+ 11
- 11
DisplayESP32.ino View File

@ -427,8 +427,8 @@ class Screen{
display.setTextColor(SSD1306_WHITE); display.setTextColor(SSD1306_WHITE);
// Text position // Text position
display.setCursor(0, 20);
display.println("Bienvenido");
display.setCursor(25, 20);
display.println("Welcome");
display.setTextSize(1); display.setTextSize(1);
@ -556,7 +556,7 @@ class Keyboard{
byte minus; byte minus;
byte debounceTime; byte debounceTime;
Screen * screen;
Screen *screen;
public: public:
@ -640,8 +640,8 @@ class Keyboard{
} }
}; };
Screen screen, * disp = &screen;
Keyboard keyboard(14, 4, 12, 13, 40, disp);
Screen screen;
Keyboard keyboard(13, 12, 14, 27, 30, &screen);
void setup(){ void setup(){
screen.configure(true); screen.configure(true);
@ -665,13 +665,13 @@ void setup(){
screen.createOption(1, "Test", 1, 3); screen.createOption(1, "Test", 1, 3);
screen.createOption(1, "Working?", 1, 4); screen.createOption(1, "Working?", 1, 4);
screen.increasePos();
screen.increasePos();
screen.goTo();
// screen.increasePos();
// screen.increasePos();
// screen.goTo();
// screen.graphAssignValue(2, 50); // screen.graphAssignValue(2, 50);
screen.goBack();
screen.increasePos();
screen.goTo();
// screen.goBack();
// screen.increasePos();
// screen.goTo();
// screen.goBack(); // screen.goBack();
// screen.decreasePos(); // screen.decreasePos();
} }


+ 12
- 34
Readme.md View File

@ -2,45 +2,23 @@
# Basic Instructions of Repository DisplayESP32 # Basic Instructions of Repository DisplayESP32
**This repository aims to provide some functions for creating a user interface for the display Adafruit SSD1306 on microcontroller ESP32**
**This repository aims to provide some functions for creating a user interface for the display
Adafruit SSD1306 on microcontroller ESP32**
For such, new classes are implemented, which are included in the *.ino* code included in this repo.
## To begin with ## To begin with
To be able to use this repository, it's important to first connect the display to the microcontroller, the following diagram shows the way it should be done when using an ESP32-WROOM board.
*Considers that the Wiki page is not considered by the git system*.
To be able to use this repository, it's important to first connect the display to the
microcontroller correctly. The following diagram shows how it should be done when using an ESP32-WROOM board.
![Connection diagram used for DisplayESP32 repository!](Connection Diagram.png "Connection diagram")
It is possible to see that the display used in this project uses I2C protocol, thus only two pins are needed to allow
communication with the microcontroller.
On the other hand, the keyboard uses one pin for each button (configured as Pull up), and a connection to Ground.
## Classes
## Projects and Issues tab
In this section, the created classes are discussed, to better understand how each of them works.
To organize your progress, use the issues and projects tabs. In this way, it is possible to schedule your tasks and set milestones. Thus, each week can start by reviewing the pending tasks, organize your week tasks, and at the end of the week check and mark your progress.
### Issues and Labels
Let us start by setting some milestones (proposal, prototype, software function, etc.), set a Due Date, and its description. With your milestones, it will be easy to organize issues and track your progress.
After defining a milestone,
- **task**
- **bug**
- **improve**
- **
The `git-template` includes 9 basic labels to use each time you create an issue. These labels are detailed next:
- bug: Somethign is not working as expected or getting wrong results
- duplicated: This issue or pull request already exists
- further work: General advices to be considered in future elements, projects or submodules
- help wanted: Some help is required by supervisors; directions, raw material, material, review results, or laboratory assistance
- improve: Something has to be improved or rebuiled to improve expected results
- question: Something needs a fast review or guidance to focus the aim of the project
- submodules: The project should considers to create a submodule element to integrate in this project
- task: Assigned task to complete a milestone or project element; the assigned collaborators have to complete the task
- wiki: Elements or information to be included in the Wiki page
### Projects
**Considers that this is the main repository. Thus, create projects for main elements (circuit stage, specific behaivior, component, document, simulation, or submodule, etc.) to manage components or submodules related with the main repository**.
In the project always create three main boards: Todo, In Progress and Done.
###Option class

Loading…
Cancel
Save