From 25acc8159ffd03748acc9a6f95c53b73df574665 Mon Sep 17 00:00:00 2001 From: AghaSaad04 Date: Thu, 31 Oct 2019 01:12:31 +0500 Subject: [PATCH 1/4] [Documentation] --- CONTRIBUTING.md | 13 ++++ README.adoc | 25 ------- README.md | 182 ++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 195 insertions(+), 25 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 README.adoc create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..db35fa2 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,13 @@ +# Contribution Guidlines + +This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/arduino/EduIntro/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community. + +The following are some guidelines to observe when creating issues or PRs: + +- Be friendly; it is important that we can all enjoy a safe space as we are all working on the same project and it is okay for people to have different ideas + +- [Use code blocks](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code); it helps us help you when we can read your code! On that note also refrain from pasting more than 30 lines of code in a post, instead [create a gist](https://gist.github.com/) if you need to share large snippets + +- Use reasonable titles; refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile: + +- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library \ No newline at end of file diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 7ec3219..0000000 --- a/README.adoc +++ /dev/null @@ -1,25 +0,0 @@ -= Liquid Crystal Library for Arduino = - -This library allows an Arduino board to control LiquidCrystal displays (LCDs) based on the Hitachi HD44780 (or a compatible) chipset, which is found on most text-based LCDs. - -For more information about this library please visit us at -http://www.arduino.cc/en/Reference/LiquidCrystal - -== License == - -Copyright (C) 2006-2008 Hans-Christoph Steiner. All rights reserved. -Copyright (c) 2010 Arduino LLC. All right reserved. - -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/README.md b/README.md new file mode 100644 index 0000000..eab2c83 --- /dev/null +++ b/README.md @@ -0,0 +1,182 @@ +# Liquid Crystal Library for Arduino + +## Description + +This library allows an Arduino board to control LiquidCrystal displays (LCDs) based on the Hitachi HD44780 (or a compatible) chipset, which is found on most text-based LCDs. The library works within either 4- or 8-bit mode (i.e. using 4 or 8 data lines in addition to the rs, enable, and, optionally, the rw control lines). + +## Installation + +![image](https://user-images.githubusercontent.com/36513474/67681689-a5eee280-f9af-11e9-837d-350f8f0aebd0.png) + +### First Method + +1. In the Arduino IDE, navigate to Sketch > Include Library > Manage Libraries +1. Then the Library Manager will open and you will find a list of libraries that are already installed or ready for installation. +1. Then search for EduIntro using the search bar. +1. Click on the text area and then select the specific version and install it. + +### Second Method + +1. Navigate to the Releases page. +1. Download the latest release. +1. Extract the zip file +1. In the Arduino IDE, navigate to Sketch > Include Library > Add .ZIP Library + +## Features + +- ### Easy to use + + It is simple, basic and very easy to understand. The user only needs to import the library in his code and start using its functions. + +- ### Compatible chipset + + ![image](https://user-images.githubusercontent.com/36513474/67893895-4e03d780-fb79-11e9-814b-d8fa03689344.png) + + Using Liquid Crystal library, Arduino board can control liquid displays based on the Hitachi HD44780 chipset. These chipset LCDs are easily available, come in different shapes and sizes. + +- ### No technical details required + + A key benefit of using this liquid crystal library is that there is no need to care that much about the technical details or timings when using the display. The library happily does all of this. + +- ### Extendable + + The library is extendable, therefore it can grow to support new LCD control devices such as I2C, SPI, Serial, 1wire, RF, CAM, etc. + +- ### Intuitive syntax + + Liquid Crystal has a simple and intuitive syntax to handle variables and functions. The user only needs to import the library and calls its functions + +- ### Give back + + Liquid Crystal is free for everyone. The licensed library can be copied, redistributed and used in the projects, assignments or anywhere. + +## Functions + +- LiquidCrystal() +- begin() +- clear() +- home() +- setCursor() +- write() +- print() +- cursor() +- noCursor() +- blink() +- noBlink() +- display() +- noDisplay() +- scrollDisplayLeft() +- scrollDisplayRight() +- autoscroll() +- noAutoscroll() +- leftToRight() +- rightToLeft() +- createChar() + +## Example + +There are many examples implemented where this library is used. You can find other examples from [Github-Liquid-Crystal](https://github.com/arduino-libraries/LiquidCrystal/tree/master/examples) and [Arduino-Reference](https://www.arduino.cc/en/Reference/LiquidCrystal). The following are the few examples of this library. + +### Blink + +This sketch prints "Hello World!" to the LCD and makes the cursor block blink. + +```C++ +#include + +const int rs = 12, en = 11, d4 = 5, d5 = 4, d6 = 3, d7 = 2; +LiquidCrystal lcd(rs, en, d4, d5, d6, d7); + +void setup() { + lcd.begin(16, 2); + lcd.print("Hello World!"); +} + +void loop() { + lcd.noBlink(); + delay(3000); + lcd.blink(); + delay(3000); +} +``` + +### Display + +This sketch prints "Hello World!" to the LCD and uses the display() and noDisplay() functions to turn on and off the display. + +```C++ +#include +const int rs = 12, en = 11, d4 = 5, d5 = 4, d6 = 3, d7 = 2; +LiquidCrystal lcd(rs, en, d4, d5, d6, d7); + +void setup() { + lcd.begin(16, 2); + lcd.print("Hello World!"); +} + +void loop() { + lcd.noDisplay(); + delay(500); + lcd.display(); + delay(500); +} +``` + +You can find liquid crystal tutorials from [here](https://www.arduino.cc/en/Tutorial/HelloWorld?from=Tutorial.LiquidCrystal) + +## Contributing + +If you want to contribute to this project: + +- Report bugs and errors +- Ask for enhancements +- Create issues and pull requests +- Tell others about this library +- Contribute new protocols + +Please read [CONTRIBUTING.md](https://github.com/arduino-libraries/LiquidCrystal/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. + +## Credits + +The authors of this library are Arduino and Adafruit. This Library is maintained by Arduino . + +Based on previous work by: + +- T. Igoe +- D. A. Mellis +- C. Maglie +- M. Faccihin +- M. kooijman +- A. Guadalupi +- F. Vanzati +- Zeveland +- S. Fitzgerald +- J. Nussbaum +- I. Gupta +- C. Park +- A. Daftery +- A. K. Sahoo +- Isaac + +## Current stable version + +**version:** v1.0.7 + +## License + +Copyright (C) 2006-2008 Hans-Christoph Steiner. All rights reserved. +Copyright (c) 2010 Arduino LLC. All right reserved. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA From 65bfb467f5cb7b86cc279f9190e35eeb7361aef2 Mon Sep 17 00:00:00 2001 From: Agha Saad Fraz Date: Fri, 1 Nov 2019 14:53:36 +0500 Subject: [PATCH 2/4] [Fix library name] Signed-off-by: Agha Saad Fraz --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index eab2c83..bbc60fa 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ This library allows an Arduino board to control LiquidCrystal displays (LCDs) ba 1. In the Arduino IDE, navigate to Sketch > Include Library > Manage Libraries 1. Then the Library Manager will open and you will find a list of libraries that are already installed or ready for installation. -1. Then search for EduIntro using the search bar. +1. Then search for LiquidCrystal using the search bar. 1. Click on the text area and then select the specific version and install it. ### Second Method From a6f956e06b58a37b58160fb9bb3c1ee06341f6a5 Mon Sep 17 00:00:00 2001 From: Agha Saad Fraz Date: Fri, 1 Nov 2019 14:56:04 +0500 Subject: [PATCH 3/4] [Update URL] Signed-off-by: Agha Saad Fraz --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db35fa2..aad1f1f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contribution Guidlines -This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/arduino/EduIntro/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community. +This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/arduino-libraries/LiquidCrystal/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community. The following are some guidelines to observe when creating issues or PRs: @@ -10,4 +10,4 @@ The following are some guidelines to observe when creating issues or PRs: - Use reasonable titles; refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile: -- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library \ No newline at end of file +- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library From a6d78f2e2adebafa99ba45046436769647987aa1 Mon Sep 17 00:00:00 2001 From: AghaSaad04 Date: Thu, 21 Nov 2019 17:21:07 +0500 Subject: [PATCH 4/4] [Update documentation] --- CONTRIBUTING.md | 6 +- README.adoc | 117 +++++++++++++++++++++++++++++++ README.md | 182 ------------------------------------------------ 3 files changed, 120 insertions(+), 185 deletions(-) create mode 100644 README.adoc delete mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index db35fa2..0895929 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contribution Guidlines +# Contribution Guidelines -This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/arduino/EduIntro/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community. +This library is the culmination of the expertise of many members of the open source community who have dedicated their time and hard work. The best way to ask for help or propose a new idea is to [create a new issue](https://github.com/arduino-libraries/LiquidCrystal/issues/new) while creating a Pull Request with your code changes allows you to share your own innovations with the rest of the community. The following are some guidelines to observe when creating issues or PRs: @@ -10,4 +10,4 @@ The following are some guidelines to observe when creating issues or PRs: - Use reasonable titles; refrain from using overly long or capitalized titles as they are usually annoying and do little to encourage others to help :smile: -- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library \ No newline at end of file +- Be detailed; refrain from mentioning code problems without sharing your source code and always give information regarding your board and version of the library. diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..9b4fd22 --- /dev/null +++ b/README.adoc @@ -0,0 +1,117 @@ +Liquid Crystal Library for Arduino +---------------------------------- + +Description +~~~~~~~~~~~ + +This library allows an Arduino board to control LiquidCrystal displays (LCDs) based on the Hitachi HD44780 (or a compatible) chipset, which is found on most text-based LCDs. The library works within either 4- or 8-bit mode (i.e. using 4 or 8 data lines in addition to the rs, enable, and, optionally, the rw control lines). + +Installation +~~~~~~~~~~~~ +image:https://user-images.githubusercontent.com/36513474/69337317-5fc13200-0c82-11ea-802d-d1bd9cc0a1b1.png[alt="Liquid Crystal Icon"] + +First Method +^^^^^^^^^^^^ + +1. In the Arduino IDE, navigate to Sketch > Include Library > Manage Libraries +1. Then the Library Manager will open and you will find a list of libraries that are already installed or ready for installation. +1. Then search for LiquidCrystal using the search bar. +1. Click on the text area and then select the specific version and install it. + +Second Method +^^^^^^^^^^^^^ + +1. Navigate to the https://github.com/arduino-libraries/LiquidCrystal/releases[Releases page^]. +1. Download the latest release. +1. Extract the zip file +1. In the Arduino IDE, navigate to Sketch > Include Library > Add .ZIP Library + +Features +~~~~~~~~ + +* **Compatible chipset** ++ +image:https://user-images.githubusercontent.com/36513474/67893895-4e03d780-fb79-11e9-814b-d8fa03689344.png[alt="chipset"] + + Using Liquid Crystal library, Arduino board can control liquid displays based on the Hitachi HD44780 chipset. These chipset LCDs are easily available, come in different shapes and sizes. + +* **No technical details required** + + A key benefit of using this liquid crystal library is that there is no need to care that much about the technical details or timings when using the display. The library happily does all of this. + +* **Extendable** + + The library is extendable, therefore it can grow to support new LCD control devices such as I2C, SPI, Serial, 1wire, RF, CAM, etc. + +* **Give back** + + Liquid Crystal is free for everyone. The licensed library can be copied, redistributed and used in the projects, assignments or anywhere. + +Functions +~~~~~~~~~ + +* LiquidCrystal() +* begin() +* clear() +* home() +* setCursor() +* write() +* print() +* cursor() +* noCursor() +* blink() +* noBlink() +* display() +* noDisplay() +* scrollDisplayLeft() +* scrollDisplayRight() +* autoscroll() +* noAutoscroll() +* leftToRight() +* rightToLeft() +* createChar() + +Example +~~~~~~~ + +There are many examples implemented where this library is used. You can find examples https://github.com/arduino-libraries/LiquidCrystal/tree/master/examples[here^] and on https://www.arduino.cc/en/Reference/LiquidCrystal[Arduino-Reference^]. + +You can find liquid crystal tutorials https://www.arduino.cc/en/Tutorial/HelloWorld?from=Tutorial.LiquidCrystal[here^]. + +Contributing +~~~~~~~~~~~~ + +If you want to contribute to this project: + +- Report bugs and errors +- Ask for enhancements +- Create issues and pull requests +- Tell others about this library +- Contribute new protocols + +Please read https://github.com/arduino-libraries/LiquidCrystal/blob/master/CONTRIBUTING.md[CONTRIBUTING.md^] for details on our code of conduct, and the process for submitting pull requests to us. + +Credits +~~~~~~~ + +The authors of this library are Arduino and Adafruit. This Library is maintained by Arduino info@arduino.cc + +License +~~~~~~~ + +Copyright (C) 2006-2008 Hans-Christoph Steiner. All rights reserved. +Copyright (c) 2010 Arduino LLC. All right reserved. + +This library is free software; you can redistribute it and/or +modify it under the terms of the GNU Lesser General Public +License as published by the Free Software Foundation; either +version 2.1 of the License, or (at your option) any later version. + +This library is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public +License along with this library; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA diff --git a/README.md b/README.md deleted file mode 100644 index eab2c83..0000000 --- a/README.md +++ /dev/null @@ -1,182 +0,0 @@ -# Liquid Crystal Library for Arduino - -## Description - -This library allows an Arduino board to control LiquidCrystal displays (LCDs) based on the Hitachi HD44780 (or a compatible) chipset, which is found on most text-based LCDs. The library works within either 4- or 8-bit mode (i.e. using 4 or 8 data lines in addition to the rs, enable, and, optionally, the rw control lines). - -## Installation - -![image](https://user-images.githubusercontent.com/36513474/67681689-a5eee280-f9af-11e9-837d-350f8f0aebd0.png) - -### First Method - -1. In the Arduino IDE, navigate to Sketch > Include Library > Manage Libraries -1. Then the Library Manager will open and you will find a list of libraries that are already installed or ready for installation. -1. Then search for EduIntro using the search bar. -1. Click on the text area and then select the specific version and install it. - -### Second Method - -1. Navigate to the Releases page. -1. Download the latest release. -1. Extract the zip file -1. In the Arduino IDE, navigate to Sketch > Include Library > Add .ZIP Library - -## Features - -- ### Easy to use - - It is simple, basic and very easy to understand. The user only needs to import the library in his code and start using its functions. - -- ### Compatible chipset - - ![image](https://user-images.githubusercontent.com/36513474/67893895-4e03d780-fb79-11e9-814b-d8fa03689344.png) - - Using Liquid Crystal library, Arduino board can control liquid displays based on the Hitachi HD44780 chipset. These chipset LCDs are easily available, come in different shapes and sizes. - -- ### No technical details required - - A key benefit of using this liquid crystal library is that there is no need to care that much about the technical details or timings when using the display. The library happily does all of this. - -- ### Extendable - - The library is extendable, therefore it can grow to support new LCD control devices such as I2C, SPI, Serial, 1wire, RF, CAM, etc. - -- ### Intuitive syntax - - Liquid Crystal has a simple and intuitive syntax to handle variables and functions. The user only needs to import the library and calls its functions - -- ### Give back - - Liquid Crystal is free for everyone. The licensed library can be copied, redistributed and used in the projects, assignments or anywhere. - -## Functions - -- LiquidCrystal() -- begin() -- clear() -- home() -- setCursor() -- write() -- print() -- cursor() -- noCursor() -- blink() -- noBlink() -- display() -- noDisplay() -- scrollDisplayLeft() -- scrollDisplayRight() -- autoscroll() -- noAutoscroll() -- leftToRight() -- rightToLeft() -- createChar() - -## Example - -There are many examples implemented where this library is used. You can find other examples from [Github-Liquid-Crystal](https://github.com/arduino-libraries/LiquidCrystal/tree/master/examples) and [Arduino-Reference](https://www.arduino.cc/en/Reference/LiquidCrystal). The following are the few examples of this library. - -### Blink - -This sketch prints "Hello World!" to the LCD and makes the cursor block blink. - -```C++ -#include - -const int rs = 12, en = 11, d4 = 5, d5 = 4, d6 = 3, d7 = 2; -LiquidCrystal lcd(rs, en, d4, d5, d6, d7); - -void setup() { - lcd.begin(16, 2); - lcd.print("Hello World!"); -} - -void loop() { - lcd.noBlink(); - delay(3000); - lcd.blink(); - delay(3000); -} -``` - -### Display - -This sketch prints "Hello World!" to the LCD and uses the display() and noDisplay() functions to turn on and off the display. - -```C++ -#include -const int rs = 12, en = 11, d4 = 5, d5 = 4, d6 = 3, d7 = 2; -LiquidCrystal lcd(rs, en, d4, d5, d6, d7); - -void setup() { - lcd.begin(16, 2); - lcd.print("Hello World!"); -} - -void loop() { - lcd.noDisplay(); - delay(500); - lcd.display(); - delay(500); -} -``` - -You can find liquid crystal tutorials from [here](https://www.arduino.cc/en/Tutorial/HelloWorld?from=Tutorial.LiquidCrystal) - -## Contributing - -If you want to contribute to this project: - -- Report bugs and errors -- Ask for enhancements -- Create issues and pull requests -- Tell others about this library -- Contribute new protocols - -Please read [CONTRIBUTING.md](https://github.com/arduino-libraries/LiquidCrystal/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. - -## Credits - -The authors of this library are Arduino and Adafruit. This Library is maintained by Arduino . - -Based on previous work by: - -- T. Igoe -- D. A. Mellis -- C. Maglie -- M. Faccihin -- M. kooijman -- A. Guadalupi -- F. Vanzati -- Zeveland -- S. Fitzgerald -- J. Nussbaum -- I. Gupta -- C. Park -- A. Daftery -- A. K. Sahoo -- Isaac - -## Current stable version - -**version:** v1.0.7 - -## License - -Copyright (C) 2006-2008 Hans-Christoph Steiner. All rights reserved. -Copyright (c) 2010 Arduino LLC. All right reserved. - -This library is free software; you can redistribute it and/or -modify it under the terms of the GNU Lesser General Public -License as published by the Free Software Foundation; either -version 2.1 of the License, or (at your option) any later version. - -This library is distributed in the hope that it will be useful, -but WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -Lesser General Public License for more details. - -You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA