{"id":7280,"date":"2022-02-11T04:01:41","date_gmt":"2022-02-11T04:01:41","guid":{"rendered":"http:\/\/fastbitlab.com\/?p=7280"},"modified":"2023-08-08T16:50:14","modified_gmt":"2023-08-08T11:20:14","slug":"fsm-lecture-31-adding-arduino-library-to-project-in-platformio","status":"publish","type":"post","link":"https:\/\/fastbitlab.com\/blog\/fsm-lecture-31-adding-arduino-library-to-project-in-platformio\/","title":{"rendered":"FSM Lecture 31- Adding arduino Library to project in platformIO"},"content":{"rendered":"
\n
\n
\n
\n

 <\/p>\n<\/div>\n

\n

Adding arduino Library to project in platformIO<\/span><\/strong><\/h1>\n
\n
\n
\n

 <\/p>\n

<\/div>\n

 <\/p>\n<\/div>\n<\/div>\n<\/div>\n

In this article, let\u2019s explore Arduino\u2019s official LCD library.  <\/span><\/p>\n

1. For that, you have to go Arduino<\/a><\/span> website, go to the Documentation, go to Reference as shown in Figure 1.<\/span><\/p>\n

\"Go
Figure 1. Go to Arduino reference<\/span><\/figcaption><\/figure>\n

 <\/p>\n

2. In the Reference, you find libraries; click on that( Figure 2).<\/span><\/p>\n

\"Arduino
Figure 2. Arduino Libraries<\/span><\/figcaption><\/figure>\n

 <\/p>\n

3. In the Libraries,  click on \u2018Display\u2019 as shown in Figure 3.<\/span><\/p>\n

\"Arduino
Figure 3. Arduino display<\/span><\/figcaption><\/figure>\n

 <\/p>\n

4. In the Display, the official libraries\u2192 click on LiquidCrystal.<\/span><\/p>\n

\"LiquidCrystal\"
Figure 4. LiquidCrystal<\/span><\/figcaption><\/figure>\n

 <\/p>\n

LiquidCrystal:<\/span><\/strong><\/span><\/p>\n

Allows communication with alphanumerical liquid crystal displays(LCDs).<\/span><\/p>\n

\"LiquidCrystal
Figure 5. LiquidCrystal Library<\/span><\/figcaption><\/figure>\n

 <\/p>\n

To learn more about the LiquidCrystal library(as shown in Figure 5), LiquidCrystal displays based on the Hitachi\u2019s HD44780(or a compatible) chipset, and we are using the same chipset based 16×2 LCD. There are various examples of code they have given. And at the right-hand side, you see the methods (different methods) or functions of the LiquidCrystal library.<\/span><\/p>\n

 <\/p>\n

In our project, since we are using a PlatformIO Extension, we have first to install <\/span>LiquidCrystal Library<\/b>. I will show you how to install that library.<\/span><\/span><\/p>\n

\"
Figure 6. PlatformIO Home page<\/span><\/figcaption><\/figure>\n

 <\/p>\n

There is a Home button, or you go here ‘PlatformIO.’ A Home button(as shown in Figure 6)\u2192 Click on that, Quick Access\u2192 PIO Home\u2192 Open. And then go to libraries, and in the library search LiquidCrystal<\/strong>.<\/span><\/p>\n

LiquidCrystal<\/b> should be by Arduino. Because that\u2019s an official one, click on LiquidCrystal by Arduino(as shown in Figure 7).<\/span><\/span><\/p>\n

\"
Figure 7. Liquid crystal Library<\/span><\/figcaption><\/figure>\n

 <\/p>\n

Add to project as shown in Figure 8. <\/span> <\/span><\/span><\/p>\n

\"
Figure 8. Add to project<\/span><\/figcaption><\/figure>\n

 <\/p>\n

You add to the project and select your project. StateMachine_projects\\003Protimer is my project. I will choose that and Add. <\/span><\/p>\n

\"Adding
Figure 9. Projectwise Library adding<\/span><\/figcaption><\/figure>\n

 <\/p>\n

This is Project wise library adding. You can either add project-wise or workspace-wise; you can also do that. We will do it project-wise. <\/span><\/p>\n

 <\/p>\n

Once you add that, you can see that in the platformio.ini, that is added here library dependency as shown in Figure 10.<\/span><\/p>\n

\"Adding
Figure 10. Platformio.ini file<\/span><\/figcaption><\/figure>\n

 <\/p>\n

If you want to print text, you can use the <\/span>print<\/b> method. If you want to know how to use this print method, open the print() documentation. It explains how to use that. Figure 11 shows the example of the print() function.<\/span><\/span><\/p>\n

\"print()
Figure 11. print() function Example<\/span><\/figcaption><\/figure>\n

 <\/p>\n

If you want to print \u201cHelloWorld\u201d on the LCD, you must first create the lcd object. Lcd object and LiquidCrystal class, and the PINs of the Arduino board (as shown in Figure 11) you used to connect the LCD to the Arduino board. So, you have to mention that carefully. <\/span><\/p>\n

The documentation explains what order you have to mention the Arduino pins. <\/span><\/p>\n

\"Adding
Figure 12. LiquidCrystal<\/span><\/figcaption><\/figure>\n

 <\/p>\n

You can go to the LiquidCrystal() function. It says that you have to create the object or supply the argument to the object in this order(as shown in Figure 12).<\/span><\/p>\n

First, LiquidCrystal(rs,enable,d4,d5,d6,d7). If you use RW, that is the Read-Write pin. If you use the Read-Write pin of the LCD, then the Read-Write pin must come second. The last two are not used in our application, so this is for an 8-bit communication. We will use LiquidCrystal(rs, rw, enable,d4,d5,d6,d7). I will show you how to use that while coding. <\/span><\/p>\n

 <\/p>\n

#ifndef<\/span> LCD_H\r\n#define<\/span> LCD_H\r\n#include<\/span><Arduino.h>\r\n\r\nvoid<\/span> lcd_clear(void<\/span>);\r\nvoid<\/span> lcd_print_char(char<\/span> c);\r\nvoid<\/span> lcd_scroll_left(void<\/span>);\r\nvoid<\/span> lcd_scroll_right(void<\/span>);\r\nvoid<\/span> lcd_set_cursor(int<\/span> c, int<\/span> r);\r\nvoid<\/span> lcd_no_auto_scroll(void<\/span>);\r\nvoid<\/span> lcd_begin(void<\/span>);\r\nvoid<\/span> lcd_move_cursor_R_to_L(void<\/span>);\r\nvoid<\/span> lcd_move_cursor_L_to_R(void<\/span>);\r\nvoid<\/span> lcd_cursor_off(void<\/span>);\r\nvoid<\/span> lcd_cursor_blinkoff(void<\/span>);\r\nvoid<\/span> lcd_insert_number(int<\/span> num);\r\nvoid<\/span> lcd_print_string(String<\/span> s);\r\n\r\n#endif<\/span><\/pre>\n
We will go to the lcd.h file of our project, and we will add all these(as shown in Figure 12) a wrapper function. We will support all these functions to deal with the LCD.   <\/span><\/p>\n