„Readme.md“ ändern

Readme.md

@@ -39,6 +39,15 @@ Macros are defined to help use the library easily, making possible to modify the
 
 ## Content types
 
+This library depends on some indexes to display content, that's why it's important to keep in mind that all screens are described by two parameters: Content Type and Content Index. Indexes are assigned according to the order in which the elements were created.  
+  
+On the other hand, type is defined according to the following.
+
+1. Menu
+2. Graph
+3. Setting
+
+Those integer values are recognized by screen and lead to the different content screens configured.
 
 ## Classes
 
@@ -490,8 +499,93 @@ These methods' sole task is to call the methods to increase or decrease the posi
 
 ##### goTo()
 
-This method changes the screen and allows to enter a new screen if an option in a menu is currently selected, for that, it needs to check the content currently displayed and retrieve the destination indexes and types using the methods from Menu. Furthermore, it is in charge of storing the current screen as a previous screen inside of the screen to be displayed, where it makes use the other methods defined in Menu, Graph, etc.
+This method changes the screen and allows to enter a new screen if an option in a menu is currently selected, for that, it needs to check the content currently displayed and retrieve the destination indexes and types using the methods from Menu. Furthermore, it is in charge of storing the current screen as a previous screen inside of the screen to be displayed, where it makes use the other methods defined in Menu, Graph, etc. That is done in the following lines:
+
+    void goTo(){
+        if(this->contentType == 0){
+        int newScreen = this->menu[this->currentScreen].extractDestinationIndex();
+        int newContentType = this->menu[this->currentScreen].extractDestinationType();
+        if (newContentType == 0){
+            this->menu[newScreen].setPreviousScreen(this->currentScreen);
+            this->menu[newScreen].setPreviousContentType(this->contentType);
+        }
+        else if(newContentType == 1){
+            this->graph[newScreen].setPreviousScreen(this->currentScreen);
+            this->graph[newScreen].setPreviousContentType(this->contentType);
+            this->graph[newScreen].reset();
+            this->graph[newScreen].redrawFlag();
+        }
+        else if(newContentType == 2){
+
+        }
+        this->contentType = newContentType;
+        this->currentScreen = newScreen;
+        this->redraw = true;
+        }
+    }
+
+##### goBack()
+
+This method does the opposite to the previous one, it retrieves the data of the previous screen stored in the current screen and sets the former as the current screen in the attributes of the object Screen, that way it allows the user to return to a preceding screen.
+
+##### plusAction() and minusAction()
+
+Depending on the type of screen the user is at, this methods determine whether the options plus and minus increase or decrease positions or modify variables or do something else. This methods are planned to be used from Keyboard.
 
 ### Keyboard class
 
-### Implementation
+This class permits the usage of buttons to control the interface.
+
+#### Attributes
+
+The attributes used in this class are:
+
+    private:
+
+    byte goTo;
+    byte goBack;
+    byte plus;
+    byte minus;
+    byte debounceTime;
+
+    Screen *screen;
+
+Where:
+
+* **goTo**, **goBack**, **plus** and **minus**: This variables hold the pins where these buttons are configured.
+* ***screen**: This is a pointer to the object Screen created, giving place to the interaction between both of them.
+
+#### Methods
+
+The methods listed below are defined for Keyboard:
+
+##### Keyboard
+
+This is the constructor for Keyboard, here the buttons are defined and the pointer to the Screen object is selected. The prototype is:
+
+    Keyboard(byte goTo, byte goBack, byte plus, byte minus, byte debounceTime, Screen * screen)
+
+The debounceTime parameter is a number in milliseconds that the buttons are going to be checked by the debouncing methods.
+
+##### Debouncing functions
+
+This group of methods is used to eliminate the effect of physical buttons bouncing, waiting a specified number of millisenconds. This depends on REFRESH, as is shown belown:
+
+    void checkGoTo(){
+        static char cont;
+        if(digitalRead(this->goTo) == LOW)
+            cont++;
+        else
+        cont = 0;
+        if(cont == debounceTime/REFRESH){
+            this->screen->goTo();
+        }
+    }
+
+##### control()
+
+Finally, the debouncing methods are called in the main method of Keyboard, which is control(), this should run in a loop, to make it work continuously.
+
+### Implementation
+
+In the example...