souti/Arduino
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

first commit

Browse Source
This commit is contained in:
Jérôme Delacotte
2025-03-06 11:15:32 +01:00
commit 7b30d6e298
5276 changed files with 2108927 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

158
libraries/LCD03/LCD03.cpp Executable file
View File

@@ -0,0 +1,158 @@
/*
LCD03.cpp - Arduino library for I2C LCD03 display from Robot Electronics
see http://www.robot-electronics.co.uk/htm/Lcd03tech.htm
Copyright (c) 2013 Ben Arblaster. 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
*/
#include "LCD03.h"
#include <inttypes.h>
#include "Arduino.h"
#include <Wire.h>
char _i2c_address;
#ifdef ARDUINO_ARCH_esp826
uint8_t _sda_pin;
uint8_t _scl_pin;
LCD03::LCD03(char i2c_address, uint8_t sda_pin, uint8_t scl_pin) {
_sda_pin = sda_pin;
_scl_pin = scl_pin;
#else
LCD03::LCD03(char i2c_address) {
#endif
// Convert 8-bit address from LCD to 7-bit address for Wire
_i2c_address = i2c_address>>1;
}
void LCD03::begin(uint8_t cols, uint8_t rows) {
#ifdef ARDUINO_ARCH_esp826
Wire.begin(_sda_pin, _scl_pin);
#else
Wire.begin();
#endif
noCursor();
clear();
}
void LCD03::setCursor(uint8_t pos) {
pos++;
Wire.beginTransmission(_i2c_address);
Wire.write(REG_COMMAND);
Wire.write(LCD_CURSORPOS);
Wire.write(pos);
Wire.endTransmission();
}
void LCD03::setCursor(uint8_t col, uint8_t row) {
// convert LiquidCrystal col & rows to LCD03
col++;
row++;
Wire.beginTransmission(_i2c_address);
Wire.write(REG_COMMAND);
Wire.write(LCD_CURSORPOSXY);
Wire.write(row);
Wire.write(col);
Wire.endTransmission();
}
void LCD03::tabSet(uint8_t ts) {
Wire.beginTransmission(_i2c_address);
Wire.write(REG_COMMAND);
Wire.write(LCD_TABSET);
Wire.write(ts);
Wire.endTransmission();
}
void LCD03::createChar(uint8_t location, uint8_t charmap[]) {
// remap custom chars from 0-7 to match LiquidCrystal
location += LCD_CUSTOMCHAR_BASE;
Wire.beginTransmission(_i2c_address);
Wire.write(REG_COMMAND);
Wire.write(LCD_CUSTOMCHAR);
Wire.write(location);
for(int i = 0; i < 8; i++) {
Wire.write(charmap[i] |= LCD_CUSTOMCHAR_MASK);
}
Wire.endTransmission();
}
// get the free buffer capacity in bytes
uint8_t LCD03::bufferFreeBytes() {
Wire.requestFrom(_i2c_address, 1);
if(Wire.available()) {
return Wire.read();
}
}
uint16_t LCD03::readKeypad () {
Wire.requestFrom(_i2c_address, 3);
uint8_t lowByte;
uint8_t highByte;
uint16_t bothBytes;
// Don't care about the first byte
Wire.read();
// Read the low and high bytes
lowByte = Wire.read();
highByte = Wire.read();
bothBytes = (lowByte | highByte << 8);
return bothBytes;
}
// write a single byte in one transmission
size_t LCD03::write(uint8_t value) {
// remap custom chars to 0-7 to match LiquidCrystal
if(value < 8) {
value += LCD_CUSTOMCHAR_BASE;
}
send(value);
// assume write was a success
return 1;
}
// write multiple bytes in as many transmissions as required
size_t LCD03::write(const uint8_t *buffer, size_t size) {
Wire.beginTransmission(_i2c_address);
//wait until the buffer is empty enough
while(bufferFreeBytes() < BUFFER_LENGTH);
Wire.write(REG_COMMAND);
for(int i = 0; i < size; i++) {
// we've filled the I2C buffer, flush it and start a new transmission
if(i != 0 && i % (BUFFER_LENGTH-1) == 0) {
Wire.endTransmission();
//wait until the buffer is empty enough
while(bufferFreeBytes() < BUFFER_LENGTH);
Wire.beginTransmission(_i2c_address);
Wire.write(REG_COMMAND);
}
Wire.write(buffer[i]);
}
Wire.endTransmission();
// assume write was a success
return size;
}
// send a single byte command in a single transmission
void LCD03::send(uint8_t command) {
Wire.beginTransmission(_i2c_address);
Wire.write(REG_COMMAND);
Wire.write(command);
Wire.endTransmission();
}

192
libraries/LCD03/LCD03.h Executable file
View File

@@ -0,0 +1,192 @@
/*
LCD03.h - Arduino library for I2C LCD03 display from Robot Electronics
see http://www.robot-electronics.co.uk/htm/Lcd03tech.htm
Copyright (c) 2013 Ben Arblaster. 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
*/
#ifndef LCD03_h
#define LCD03_h
#include <inttypes.h>
#include <Wire.h>
#include "Print.h"
// default i2c address
#define I2C_ADDR 0xC6
// registers
#define REG_COMMAND 0x00
#define REG_KEYPADLOW 0x01
#define REG_KEYPADHIGH 0x02
#define REG_VERSION 0x03
// commands
#define LCD_NOOP 0x00
#define LCD_CURSORHOME 0x01
#define LCD_CURSORPOS 0x02
#define LCD_CURSORPOSXY 0x03
#define LCD_CURSOROFF 0x04
#define LCD_CURSORON 0x05
#define LCD_CURSORBLINK 0x06
#define LCD_BACKSPACE 0x08
#define LCD_TAB 0x09
#define LCD_CURSORDOWN 0x0A
#define LCD_CURSORUP 0x0B
#define LCD_CLEARDISPLAY 0x0C
#define LCD_LINEFEED 0x0D
#define LCD_CLEARCOLUMN 0x11
#define LCD_TABSET 0x12
#define LCD_BACKLIGHTON 0x13
#define LCD_BACKLIGHTOFF 0x14
#define LCD_CUSTOMCHAR 0x1B
// custom chars
#define LCD_CUSTOMCHAR_BASE 0x80
#define LCD_CUSTOMCHAR_MASK 0b11100000
// keypad values
#define KEYPAD_1 0x01
#define KEYPAD_2 0x02
#define KEYPAD_3 0x04
#define KEYPAD_4 0x08
#define KEYPAD_5 0x10
#define KEYPAD_6 0x20
#define KEYPAD_7 0x40
#define KEYPAD_8 0x80
#define KEYPAD_9 0x100
#define KEYPAD_STAR 0x200
#define KEYPAD_0 0x400
#define KEYPAD_HASH 0x800
class LCD03 : public Print {
public:
// Constructors
#ifdef ARDUINO_ARCH_esp8266
LCD03(char i2c_address=I2C_ADDR, uint8_t sda_pin=SDA, uint8_t scl_pin=SCL);
#else
LCD03(char i2c_address=I2C_ADDR);
#endif
// LiquidCrystal compatible functions
void begin(uint8_t cols, uint8_t rows);
void clear();
void home();
void setCursor(uint8_t);
void setCursor(uint8_t, uint8_t);
size_t write(uint8_t);
size_t write(const uint8_t *buffer, size_t size);
void cursor();
void noCursor();
void blink();
void noBlink();
void display();
void noDisplay();
void createChar(uint8_t, uint8_t[]);
// Unimplemented LiquidCrystal functions
//void scrollDisplayLeft();
//void scrollDisplayRight();
//void autoscroll();
//void noAutoscroll();
//void leftToRight();
//void rightToLeft();
// LCD03 extras
void newLine();
void cursorDown();
void cursorUp();
void clearColumn();
void backspace();
void tab();
void tabSet(uint8_t);
void backlight();
void noBacklight();
uint8_t bufferFreeBytes();
uint16_t readKeypad();
private:
char _i2c_address;
void send(uint8_t);
};
inline void LCD03::clear() {
send(LCD_CLEARDISPLAY);
}
inline void LCD03::backlight() {
send(LCD_BACKLIGHTON);
}
inline void LCD03::noBacklight() {
send(LCD_BACKLIGHTOFF);
}
// provided for compatibility with LiquidCrystal - only backlight is switched
inline void LCD03::display() {
send(LCD_BACKLIGHTON);
}
// provided for compatibility with LiquidCrystal - only backlight is switched
inline void LCD03::noDisplay() {
send(LCD_BACKLIGHTOFF);
}
inline void LCD03::home() {
send(LCD_CURSORHOME);
}
inline void LCD03::noBlink() {
send(LCD_CURSORON);
}
inline void LCD03::blink() {
send(LCD_CURSORBLINK);
}
inline void LCD03::noCursor() {
send(LCD_CURSOROFF);
}
inline void LCD03::cursor() {
send(LCD_CURSORON);
}
inline void LCD03::newLine() {
send(LCD_LINEFEED);
}
inline void LCD03::cursorDown() {
send(LCD_CURSORDOWN);
}
inline void LCD03::cursorUp() {
send(LCD_CURSORUP);
}
inline void LCD03::clearColumn() {
send(LCD_CLEARCOLUMN);
}
inline void LCD03::backspace() {
send(LCD_BACKSPACE);
}
inline void LCD03::tab() {
send(LCD_TAB);
}
#endif

502
libraries/LCD03/LICENSE Executable file
View File

@@ -0,0 +1,502 @@
GNU LESSER GENERAL PUBLIC LICENSE
Version 2.1, February 1999
Copyright (C) 1991, 1999 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
[This is the first released version of the Lesser GPL. It also counts
as the successor of the GNU Library Public License, version 2, hence
the version number 2.1.]
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
Licenses are intended to guarantee your freedom to share and change
free software--to make sure the software is free for all its users.
This license, the Lesser General Public License, applies to some
specially designated software packages--typically libraries--of the
Free Software Foundation and other authors who decide to use it. You
can use it too, but we suggest you first think carefully about whether
this license or the ordinary General Public License is the better
strategy to use in any particular case, based on the explanations below.
When we speak of free software, we are referring to freedom of use,
not price. Our General Public Licenses are designed to make sure that
you have the freedom to distribute copies of free software (and charge
for this service if you wish); that you receive source code or can get
it if you want it; that you can change the software and use pieces of
it in new free programs; and that you are informed that you can do
these things.
To protect your rights, we need to make restrictions that forbid
distributors to deny you these rights or to ask you to surrender these
rights. These restrictions translate to certain responsibilities for
you if you distribute copies of the library or if you modify it.
For example, if you distribute copies of the library, whether gratis
or for a fee, you must give the recipients all the rights that we gave
you. You must make sure that they, too, receive or can get the source
code. If you link other code with the library, you must provide
complete object files to the recipients, so that they can relink them
with the library after making changes to the library and recompiling
it. And you must show them these terms so they know their rights.
We protect your rights with a two-step method: (1) we copyright the
library, and (2) we offer you this license, which gives you legal
permission to copy, distribute and/or modify the library.
To protect each distributor, we want to make it very clear that
there is no warranty for the free library. Also, if the library is
modified by someone else and passed on, the recipients should know
that what they have is not the original version, so that the original
author's reputation will not be affected by problems that might be
introduced by others.
Finally, software patents pose a constant threat to the existence of
any free program. We wish to make sure that a company cannot
effectively restrict the users of a free program by obtaining a
restrictive license from a patent holder. Therefore, we insist that
any patent license obtained for a version of the library must be
consistent with the full freedom of use specified in this license.
Most GNU software, including some libraries, is covered by the
ordinary GNU General Public License. This license, the GNU Lesser
General Public License, applies to certain designated libraries, and
is quite different from the ordinary General Public License. We use
this license for certain libraries in order to permit linking those
libraries into non-free programs.
When a program is linked with a library, whether statically or using
a shared library, the combination of the two is legally speaking a
combined work, a derivative of the original library. The ordinary
General Public License therefore permits such linking only if the
entire combination fits its criteria of freedom. The Lesser General
Public License permits more lax criteria for linking other code with
the library.
We call this license the "Lesser" General Public License because it
does Less to protect the user's freedom than the ordinary General
Public License. It also provides other free software developers Less
of an advantage over competing non-free programs. These disadvantages
are the reason we use the ordinary General Public License for many
libraries. However, the Lesser license provides advantages in certain
special circumstances.
For example, on rare occasions, there may be a special need to
encourage the widest possible use of a certain library, so that it becomes
a de-facto standard. To achieve this, non-free programs must be
allowed to use the library. A more frequent case is that a free
library does the same job as widely used non-free libraries. In this
case, there is little to gain by limiting the free library to free
software only, so we use the Lesser General Public License.
In other cases, permission to use a particular library in non-free
programs enables a greater number of people to use a large body of
free software. For example, permission to use the GNU C Library in
non-free programs enables many more people to use the whole GNU
operating system, as well as its variant, the GNU/Linux operating
system.
Although the Lesser General Public License is Less protective of the
users' freedom, it does ensure that the user of a program that is
linked with the Library has the freedom and the wherewithal to run
that program using a modified version of the Library.
The precise terms and conditions for copying, distribution and
modification follow. Pay close attention to the difference between a
"work based on the library" and a "work that uses the library". The
former contains code derived from the library, whereas the latter must
be combined with the library in order to run.
GNU LESSER GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License Agreement applies to any software library or other
program which contains a notice placed by the copyright holder or
other authorized party saying it may be distributed under the terms of
this Lesser General Public License (also called "this License").
Each licensee is addressed as "you".
A "library" means a collection of software functions and/or data
prepared so as to be conveniently linked with application programs
(which use some of those functions and data) to form executables.
The "Library", below, refers to any such software library or work
which has been distributed under these terms. A "work based on the
Library" means either the Library or any derivative work under
copyright law: that is to say, a work containing the Library or a
portion of it, either verbatim or with modifications and/or translated
straightforwardly into another language. (Hereinafter, translation is
included without limitation in the term "modification".)
"Source code" for a work means the preferred form of the work for
making modifications to it. For a library, complete source code means
all the source code for all modules it contains, plus any associated
interface definition files, plus the scripts used to control compilation
and installation of the library.
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running a program using the Library is not restricted, and output from
such a program is covered only if its contents constitute a work based
on the Library (independent of the use of the Library in a tool for
writing it). Whether that is true depends on what the Library does
and what the program that uses the Library does.
1. You may copy and distribute verbatim copies of the Library's
complete source code as you receive it, in any medium, provided that
you conspicuously and appropriately publish on each copy an
appropriate copyright notice and disclaimer of warranty; keep intact
all the notices that refer to this License and to the absence of any
warranty; and distribute a copy of this License along with the
Library.
You may charge a fee for the physical act of transferring a copy,
and you may at your option offer warranty protection in exchange for a
fee.
2. You may modify your copy or copies of the Library or any portion
of it, thus forming a work based on the Library, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) The modified work must itself be a software library.
b) You must cause the files modified to carry prominent notices
stating that you changed the files and the date of any change.
c) You must cause the whole of the work to be licensed at no
charge to all third parties under the terms of this License.
d) If a facility in the modified Library refers to a function or a
table of data to be supplied by an application program that uses
the facility, other than as an argument passed when the facility
is invoked, then you must make a good faith effort to ensure that,
in the event an application does not supply such function or
table, the facility still operates, and performs whatever part of
its purpose remains meaningful.
(For example, a function in a library to compute square roots has
a purpose that is entirely well-defined independent of the
application. Therefore, Subsection 2d requires that any
application-supplied function or table used by this function must
be optional: if the application does not supply it, the square
root function must still compute square roots.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Library,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Library, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote
it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Library.
In addition, mere aggregation of another work not based on the Library
with the Library (or with a work based on the Library) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may opt to apply the terms of the ordinary GNU General Public
License instead of this License to a given copy of the Library. To do
this, you must alter all the notices that refer to this License, so
that they refer to the ordinary GNU General Public License, version 2,
instead of to this License. (If a newer version than version 2 of the
ordinary GNU General Public License has appeared, then you can specify
that version instead if you wish.) Do not make any other change in
these notices.
Once this change is made in a given copy, it is irreversible for
that copy, so the ordinary GNU General Public License applies to all
subsequent copies and derivative works made from that copy.
This option is useful when you wish to copy part of the code of
the Library into a program that is not a library.
4. You may copy and distribute the Library (or a portion or
derivative of it, under Section 2) in object code or executable form
under the terms of Sections 1 and 2 above provided that you accompany
it with the complete corresponding machine-readable source code, which
must be distributed under the terms of Sections 1 and 2 above on a
medium customarily used for software interchange.
If distribution of object code is made by offering access to copy
from a designated place, then offering equivalent access to copy the
source code from the same place satisfies the requirement to
distribute the source code, even though third parties are not
compelled to copy the source along with the object code.
5. A program that contains no derivative of any portion of the
Library, but is designed to work with the Library by being compiled or
linked with it, is called a "work that uses the Library". Such a
work, in isolation, is not a derivative work of the Library, and
therefore falls outside the scope of this License.
However, linking a "work that uses the Library" with the Library
creates an executable that is a derivative of the Library (because it
contains portions of the Library), rather than a "work that uses the
library". The executable is therefore covered by this License.
Section 6 states terms for distribution of such executables.
When a "work that uses the Library" uses material from a header file
that is part of the Library, the object code for the work may be a
derivative work of the Library even though the source code is not.
Whether this is true is especially significant if the work can be
linked without the Library, or if the work is itself a library. The
threshold for this to be true is not precisely defined by law.
If such an object file uses only numerical parameters, data
structure layouts and accessors, and small macros and small inline
functions (ten lines or less in length), then the use of the object
file is unrestricted, regardless of whether it is legally a derivative
work. (Executables containing this object code plus portions of the
Library will still fall under Section 6.)
Otherwise, if the work is a derivative of the Library, you may
distribute the object code for the work under the terms of Section 6.
Any executables containing that work also fall under Section 6,
whether or not they are linked directly with the Library itself.
6. As an exception to the Sections above, you may also combine or
link a "work that uses the Library" with the Library to produce a
work containing portions of the Library, and distribute that work
under terms of your choice, provided that the terms permit
modification of the work for the customer's own use and reverse
engineering for debugging such modifications.
You must give prominent notice with each copy of the work that the
Library is used in it and that the Library and its use are covered by
this License. You must supply a copy of this License. If the work
during execution displays copyright notices, you must include the
copyright notice for the Library among them, as well as a reference
directing the user to the copy of this License. Also, you must do one
of these things:
a) Accompany the work with the complete corresponding
machine-readable source code for the Library including whatever
changes were used in the work (which must be distributed under
Sections 1 and 2 above); and, if the work is an executable linked
with the Library, with the complete machine-readable "work that
uses the Library", as object code and/or source code, so that the
user can modify the Library and then relink to produce a modified
executable containing the modified Library. (It is understood
that the user who changes the contents of definitions files in the
Library will not necessarily be able to recompile the application
to use the modified definitions.)
b) Use a suitable shared library mechanism for linking with the
Library. A suitable mechanism is one that (1) uses at run time a
copy of the library already present on the user's computer system,
rather than copying library functions into the executable, and (2)
will operate properly with a modified version of the library, if
the user installs one, as long as the modified version is
interface-compatible with the version that the work was made with.
c) Accompany the work with a written offer, valid for at
least three years, to give the same user the materials
specified in Subsection 6a, above, for a charge no more
than the cost of performing this distribution.
d) If distribution of the work is made by offering access to copy
from a designated place, offer equivalent access to copy the above
specified materials from the same place.
e) Verify that the user has already received a copy of these
materials or that you have already sent this user a copy.
For an executable, the required form of the "work that uses the
Library" must include any data and utility programs needed for
reproducing the executable from it. However, as a special exception,
the materials to be distributed need not include anything that is
normally distributed (in either source or binary form) with the major
components (compiler, kernel, and so on) of the operating system on
which the executable runs, unless that component itself accompanies
the executable.
It may happen that this requirement contradicts the license
restrictions of other proprietary libraries that do not normally
accompany the operating system. Such a contradiction means you cannot
use both them and the Library together in an executable that you
distribute.
7. You may place library facilities that are a work based on the
Library side-by-side in a single library together with other library
facilities not covered by this License, and distribute such a combined
library, provided that the separate distribution of the work based on
the Library and of the other library facilities is otherwise
permitted, and provided that you do these two things:
a) Accompany the combined library with a copy of the same work
based on the Library, uncombined with any other library
facilities. This must be distributed under the terms of the
Sections above.
b) Give prominent notice with the combined library of the fact
that part of it is a work based on the Library, and explaining
where to find the accompanying uncombined form of the same work.
8. You may not copy, modify, sublicense, link with, or distribute
the Library except as expressly provided under this License. Any
attempt otherwise to copy, modify, sublicense, link with, or
distribute the Library is void, and will automatically terminate your
rights under this License. However, parties who have received copies,
or rights, from you under this License will not have their licenses
terminated so long as such parties remain in full compliance.
9. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Library or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Library (or any work based on the
Library), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Library or works based on it.
10. Each time you redistribute the Library (or any work based on the
Library), the recipient automatically receives a license from the
original licensor to copy, distribute, link with or modify the Library
subject to these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties with
this License.
11. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Library at all. For example, if a patent
license would not permit royalty-free redistribution of the Library by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Library.
If any portion of this section is held invalid or unenforceable under any
particular circumstance, the balance of the section is intended to apply,
and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
12. If the distribution and/or use of the Library is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Library under this License may add
an explicit geographical distribution limitation excluding those countries,
so that distribution is permitted only in or among countries not thus
excluded. In such case, this License incorporates the limitation as if
written in the body of this License.
13. The Free Software Foundation may publish revised and/or new
versions of the Lesser General Public License from time to time.
Such new versions will be similar in spirit to the present version,
but may differ in detail to address new problems or concerns.
Each version is given a distinguishing version number. If the Library
specifies a version number of this License which applies to it and
"any later version", you have the option of following the terms and
conditions either of that version or of any later version published by
the Free Software Foundation. If the Library does not specify a
license version number, you may choose any version ever published by
the Free Software Foundation.
14. If you wish to incorporate parts of the Library into other free
programs whose distribution conditions are incompatible with these,
write to the author to ask for permission. For software which is
copyrighted by the Free Software Foundation, write to the Free
Software Foundation; we sometimes make exceptions for this. Our
decision will be guided by the two goals of preserving the free status
of all derivatives of our free software and of promoting the sharing
and reuse of software generally.
NO WARRANTY
15. BECAUSE THE LIBRARY IS LICENSED FREE OF CHARGE, THERE IS NO
WARRANTY FOR THE LIBRARY, TO THE EXTENT PERMITTED BY APPLICABLE LAW.
EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR
OTHER PARTIES PROVIDE THE LIBRARY "AS IS" WITHOUT WARRANTY OF ANY
KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE
LIBRARY IS WITH YOU. SHOULD THE LIBRARY PROVE DEFECTIVE, YOU ASSUME
THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY
AND/OR REDISTRIBUTE THE LIBRARY AS PERMITTED ABOVE, BE LIABLE TO YOU
FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE
LIBRARY (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE LIBRARY TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
DAMAGES.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Libraries
If you develop a new library, and you want it to be of the greatest
possible use to the public, we recommend making it free software that
everyone can redistribute and change. You can do so by permitting
redistribution under these terms (or, alternatively, under the terms of the
ordinary General Public License).
To apply these terms, attach the following notices to the library. It is
safest to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least the
"copyright" line and a pointer to where the full notice is found.
<one line to give the library's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
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 Street, Fifth Floor, Boston, MA 02110-1301 USA
Also add information on how to contact you by electronic and paper mail.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the library, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the
library `Frob' (a library for tweaking knobs) written by James Random Hacker.
<signature of Ty Coon>, 1 April 1990
Ty Coon, President of Vice
That's all there is to it!

273
libraries/LCD03/README.md Executable file
View File

@@ -0,0 +1,273 @@
# LCD03 Arduino library
LCD03 is an [Arduino](http://arduino.cc/) library for [I2C](http://en.wikipedia.org/wiki/I²C) control of the LCD03 20x4 and 16x2 serial LCD modules from [Robot Electronics](http://www.robot-electronics.co.uk), see [the datasheet](http://www.robot-electronics.co.uk/htm/Lcd03tech.htm) for details. It aims to maintain compatibility with the Arduino [LiquidCrystal](http://arduino.cc/en/Reference/LiquidCrystal) library (version 0017 onwards) , though some features of LiquidCrystal are ommited and additonal features are provided. It supports all features of the LCD03 including custom characters and the ability to read the keypad. Supports Arudino 1.0.0 and newer on avr and ESP8266 architectures.
The library is released under the GNU LGPL 2.1.
For source, issues or to contribute, please see the [project page](https://github.com/andatche/arduino-lcd03) on GitHub.
## Downloading
The latest stable release is version 1.1.2 [(zip)](https://github.com/andatche/arduino-lcd03/archive/v1.1.2.zip) [(tar.gz)](https://github.com/andatche/arduino-lcd03/archive/v1.1.2.tar.gz) [(browse)](https://github.com/andatche/arduino-lcd03/tree/v1.1.2).
## Installing
Simply navigate to your Arduino libraries directory and clone the git repository into a directory named 'LCD03'.
```
$ cd ~/Documents/Arduino/libraries
$ git clone git://github.com/andatche/arduino-lcd03.git LCD03
```
To install without git, simple use the "ZIP" link from the GitHub page to grab a .zip of the repository and unzip it to a directory named 'LCD03' in your Arduino libraries directory.
You'll need to restart the Arduino IDE after installing before the library will be detected.
## Functions
The following public functions are exposed.
### LCD03([i2c_address], [i2c_sda], [i2c_scl])
New LCD03 at `i2c_address`. If `i2c_address` is omitted the LCD03's default I2C address (0xC6) is used. On ESP8266 architectures only, `i2c_sda` and `i2c_scl` can optionally be used to set the data (SDA) and clock (SCL) pins used for I2C.
*i2c_address (char): 8-bit I2C address of the display (optional, as displayed during LCD initilisation)*
*i2c_sda (uint8_t): the data (SDA) line pin for I2C (ESP8266 only, optional, defaults to setting SDA from Wire.h)*
*i2c_scl (uint8_t): the clock (SCL) line pin for I2C (ESP8266 only, optional, defaults to setting SCL from Wire.h)*
### begin(cols, rows)
Initialise the display of size `cols` * `rows`, clear the display and set the cursor to the top-left.
*cols (uint8_t): the number of display columns*
*rows (uint8_t): the number of display rows*
### clear()
Clear the display and return the cursor to the top-left.
### home()
Move the cursor to the top-left.
### setCursor(pos)
Move the cursor to `pos`.
*pos (uint8_t): cursor position (0-79)*
### setCursor(col, row)
Move the cursor to `col`, `row`.
*col (uint8_t): column, Arduino format (0-19)*
*row (uint8_t): row, Arduino format (0-3)*
### write(data)
Write a single character to the LCD. Custom characters are mapped to values 0-7.
*col (uint8_t): the character to write to the display*
**Returns** *size (size_t): the number of bytes written*
### print(data, [base])
Print text to the LCD.
*data (char, byte, int, long, or string): the data to print to the display*
*base (optional): the base in which to print numbers: BIN, DEC, OCT or HEX*
**Returns** *size (size_t): the number of bytes written*
### cursor()
Display the underline LCD cursor at the position to which the next character will be written.
### noCursor()
Hides the LCD cursor.
### blink()
Display the blinking (block) LCD cursor at the position to which the next character will be written.
### noBlink()
Turns off the blinking LCD cursor.
### display()
Provided for LiquidCrystal compatibility, turns on the backlight.
### noDisplay()
Provided for LiquidCrystal compatibility, turns off the backlight.
### createChar(num, data[]);
Create a custom character (gylph) for use on the LCD. Up to eight characters of 5x8 pixels are supported (numbered 0 to 7). The appearance of each custom character is specified by an array of eight bytes, one for each row. The five least significant bits of each byte determine the pixels in that row. To display a custom character on the screen, write() its number.
*num (uint8_t): where to store the character (0-7)*
*data (uint8_t[]): array containing pixel data*
### newLine()
Move the cursor to the first column of the next row.
### cursorDown()
Move the cursor down one row.
### cursorUp()
Move the cursor up one row.
### clearColumn()
Clear the column of the current cursor position.
### backspace()
Delete the character preceding the cursor position and move the cursor back one.
### tab()
Moves the cursor right by the tab space. Tab space is set using `setTab(width)` and default tab space is 4.
### tabSet(width);
Set the tab space.
*width (uint8_t): width of the tab space*
### backlight()
Turn on the LCD backlight.
### noBacklight()
Turn off the LCD backlight.
### bufferFreeBytes()
Return the number of free bytes in the LCD03's buffer.
**Returns** *free (uint8_t): the number of free bytes (0-64)*
### readKeypad()
Read the state of the (optionally) attached keypad. For more information see "Reading the keypad" below.
**Returns** *keys (uint16_t): 16-bit state of the keypad matrix*
## Example usage
Make sure you have the LCD03 library installed as above. To use LCD03 simply include Wire.h and "LCD03.h" in your sketch and instantiate a new LCD03 instance.
```c++
#include <Wire.h>
#include "LCD03.h"
// Create new LCD03 instance
LCD03 lcd;
void setup() {
// Initialise the LCD
lcd.begin(20, 4);
// Turn on the backlight
lcd.backlight();
// Write to the LCD
lcd.print("Hello world!");
// Wait for 5 seconds
delay(5000);
// Clear the LCD
lcd.clear();
}
void loop() {
// Set the cursor to the top left
lcd.home();
// Print the uptime in millis
lcd.print(millis());
}
```
## Reading the keypad
The `readKeypad()` function returns the 2-byte keypad matrix state (see datasheet) in a uint16_t. The library provides some handy definitions which can be used to check the state of a particular key with some simple comparison and bitwise operations.
### Definitions
* KEYPAD_1
* KEYPAD_2
* KEYPAD_3
* KEYPAD_4
* KEYPAD_5
* KEYPAD_6
* KEYPAD_7
* KEYPAD_8
* KEYPAD_9
* KEYPAD_0
* KEYPAD_STAR
* KEYPAD_HASH
### Example usage
The following examples show some common scenarios where you may want to check for particular inputs.
```c++
// Read the current state of the keypad
uint16_t keystate = lcd.readKeypad();
// Check if key 1 is pressed
if(keystate & KEYPAD_1 == KEYPAD_1) {
// Do something
}
// Check if key 1 is pressed exclusively
if(keystate == KEYPAD_1) {
// Do something
}
// Check if keys 1 and * are pressed simultaneously
if(keystate & (KEYPAD_1 | KEYPAD_STAR) == (KEYPAD_1 | KEYPAD_2)) {
// Do something
}
// Check if keys 1 and * are pressed simultaneously exclusively
if(keystate == (KEYPAD_1 | KEYPAD_STAR)) {
// Do something
}
```
## Contributing
1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request
## License
Copyright (c) 2013 Ben Arblaster. 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

53
libraries/LCD03/examples/CustomChars/CustomChars.ino Executable file
View File

@@ -0,0 +1,53 @@
/*
CustomChars.ino - Arduino library for I2C LCD03 display from Robot Electronics
see http://www.robot-electronics.co.uk/htm/Lcd03tech.htm
Copyright (c) 2013 Ben Arblaster. 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
*/
#include <Wire.h>
#include <LCD03.h>
// Create new LCD03 instance
LCD03 lcd;
// Define the custom char bytes
byte smiley[8] = {
0b00000,
0b00000,
0b01010,
0b00000,
0b00000,
0b10001,
0b01110,
0b00000
};
void setup() {
// Initialise a 20x4 LCD
lcd.begin(20, 4);
// create a new character
lcd.createChar(0, smiley);
}
// Fill the LCD with our custom smiley
void loop() {
// Write the first custom char to the LCD
lcd.write(0);
// Wait for 1 second
delay(1000);
}

49
libraries/LCD03/examples/HelloWorld/HelloWorld.ino Executable file
View File

@@ -0,0 +1,49 @@
/*
HelloWorld.ino - Arduino library for I2C LCD03 display from Robot Electronics
see http://www.robot-electronics.co.uk/htm/Lcd03tech.htm
Copyright (c) 2013 Ben Arblaster. 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
*/
#include <Wire.h>
#include <LCD03.h>
// Create new LCD03 instance
LCD03 lcd;
void setup() {
// Initialise a 20x4 LCD
lcd.begin(20, 4);
// Turn on the backlight
lcd.backlight();
// Write to the LCD
lcd.print("Hello world");
// Wait for 5 seconds
delay(5000);
// Clear the LCD
lcd.clear();
}
void loop() {
// Set the cursor to the top left
lcd.home();
// Print the uptime in millis
lcd.print(millis());
}

63
libraries/LCD03/examples/ReadKeypad/ReadKeypad.ino Executable file
View File

@@ -0,0 +1,63 @@
/*
ReadKeypad.ino - Arduino library for I2C LCD03 display from Robot Electronics
see http://www.robot-electronics.co.uk/htm/Lcd03tech.htm
Copyright (c) 2013 Ben Arblaster. 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
*/
#include <Wire.h>
#include <LCD03.h>
// Create new LCD03 instance
LCD03 lcd;
uint16_t keystate;
void setup() {
// Initialise a 20x4 LCD
lcd.begin(20, 4);
}
// Check they keypad state once a second and print to the LCD
void loop() {
// Clear the display and move the cursor to the top-left
lcd.clear();
// Read the keypad state
keystate = lcd.readKeypad();
// Check if key 1 is pressed
if(keystate & KEYPAD_1 == KEYPAD_1) {
lcd.print("Key 1 is pressed!");
}
// Check if key 1 is pressed exclusively
if(keystate == KEYPAD_1) {
lcd.print("Only key 1 is pressed!");
}
// Check if keys 1 and * are pressed simultaneously
if(keystate & (KEYPAD_1 | KEYPAD_STAR) == (KEYPAD_1 | KEYPAD_2)) {
lcd.print("Keys 1 and * are pressed!");
}
// Check if keys 1 and * are pressed simultaneously exclusively
if(keystate == (KEYPAD_1 | KEYPAD_STAR)) {
lcd.print("Only keys 1 and * are pressed!");
}
// Wait for 1 second
delay(1000);
}

60
libraries/LCD03/keywords.txt Executable file
View File

@@ -0,0 +1,60 @@
/*
keywords.txt - Arduino library for I2C LCD03 display from Robot Electronics
see http://www.robot-electronics.co.uk/htm/Lcd03tech.htm
Copyright (c) 2013 Ben Arblaster. 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
*/
# Datatypes (KEYWORD1)
LCD03 KEYWORD1
# Methods and Functions (KEYWORD2)
begin KEYWORD2
clear KEYWORD2
home KEYWORD2
setCursor KEYWORD2
write KEYWORD2
cursor KEYWORD2
noCursor KEYWORD2
blink KEYWORD2
noBlink KEYWORD2
display KEYWORD2
noDisplay KEYWORD2
createChar KEYWORD2
newLine KEYWORD2
cursorDown KEYWORD2
cursorUp KEYWORD2
clearColumn KEYWORD2
backspace KEYWORD2
tab KEYWORD2
tabSet KEYWORD2
backlight KEYWORD2
noBacklight KEYWORD2
bufferFreeBytes KEYWORD2
readKeypad KEYWORD2
# Constants (LITERAL1)
KEYPAD_1 LITERAL1
KEYPAD_2 LITERAL1
KEYPAD_3 LITERAL1
KEYPAD_4 LITERAL1
KEYPAD_5 LITERAL1
KEYPAD_6 LITERAL1
KEYPAD_7 LITERAL1
KEYPAD_8 LITERAL1
KEYPAD_9 LITERAL1
KEYPAD_STAR LITERAL1
KEYPAD_0 LITERAL1
KEYPAD_HASH LITERAL1

10
libraries/LCD03/library.properties Executable file
View File

@@ -0,0 +1,10 @@
name=LCD03
version=1.1.2
author=Ben Arblaster <ben@andatche.com>
maintainer=Ben Arblaster <ben@andatche.com>
sentence=A library for I2C control of the LCD03 20x4 and 16x2 serial LCD modules from Robot Electronics.
paragraph=It aims to maintain compatibility with the Arduino LiquidCrystal library (version 0017 onwards) , though some features of LiquidCrystal are ommited and additonal features are provided. It supports all features of the LCD03 including custom characters and the ability to read the keypad. Supports Arudino 1.0.0 and newer.
category=Display
url=https://andatche.com/code/arduino/lcd03/
architectures=avr,esp8266
includes=LCD03.h