commit d765d114e0487577de2fc0eade24f59b9c944291 Author: PaulStoffregen Date: Sat Jun 7 06:33:39 2014 -0700 Import Tlc5940 version r014_2 diff --git a/Doxyfile b/Doxyfile new file mode 100644 index 0000000..92175c3 --- /dev/null +++ b/Doxyfile @@ -0,0 +1,1356 @@ +# Doxyfile 1.5.5 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded +# by quotes) that should identify the project. + +PROJECT_NAME = "Arduino Tlc5940 Library" + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = "r14 - 2009-05-07" + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Farsi, Finnish, French, German, Greek, +# Hungarian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, Polish, +# Portuguese, Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, +# and Ukrainian. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. + +STRIP_FROM_PATH = + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful is your file systems +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = NO + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = NO + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the DETAILS_AT_TOP tag is set to YES then Doxygen +# will output the detailed description near the top, like JavaDoc. +# If set to NO, the detailed description appears after the member +# documentation. + +DETAILS_AT_TOP = YES + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = NO + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also make the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = NO + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = NO + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = NO + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = NO + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = NO + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespace are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = NO + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = YES + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = NO + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = NO + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or define consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and defines in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# If the sources in your project are distributed over multiple directories +# then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy +# in the documentation. The default is NO. + +SHOW_DIRECTORIES = NO + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = YES + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# This WARN_NO_PARAMDOC option can be abled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx +# *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 + +FILE_PATTERNS = + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = NO + +# The EXCLUDE tag can be used to specify files and/or directories that should +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used select whether or not files or +# directories that are symbolic links (a Unix filesystem feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = NO + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER +# is applied to all files. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = NO + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C and C++ comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES (the default) +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = NO + +# If the REFERENCES_RELATION tag is set to YES (the default) +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = NO + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentstion. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = NO + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If the tag is left blank doxygen +# will generate a default style sheet. Note that doxygen will try to copy +# the style sheet file to the HTML output directory, so don't put your own +# stylesheet in the HTML output directory as well, or it will be erased! + +HTML_STYLESHEET = + +# If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, +# files or namespaces will be aligned in HTML using tables. If set to +# NO a bullet list will be used. + +HTML_ALIGN_MEMBERS = YES + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. For this to work a browser that supports +# JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox +# Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). + +HTML_DYNAMIC_SECTIONS = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index at +# top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. + +DISABLE_INDEX = NO + +# This tag can be used to set the number of enum values (range [1..20]) +# that doxygen will group on one line in the generated HTML documentation. + +ENUM_VALUES_PER_LINE = 4 + +# If the GENERATE_TREEVIEW tag is set to YES, a side panel will be +# generated containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (for instance Mozilla 1.0+, +# Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are +# probably better off using the HTML help feature. + +GENERATE_TREEVIEW = NO + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = YES + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, a4wide, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4wide + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = NO + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = NO + +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = YES + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# in the INCLUDE_PATH (see below) will be search if a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = VPRG_ENABLED:=1 XERR_ENABLED:=1 + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all function-like macros that are alone +# on a line, have an all uppercase name, and do not end with a semicolon. Such +# function macros are typically used for boiler-plate code, and will confuse +# the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. +# Optionally an initial location of the external documentation +# can be added for each tagfile. The format of a tag file without +# this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths or +# URLs. If a location is present for each tag, the installdox tool +# does not have to be run to correct the links. +# Note that each tag file must have a unique name +# (where the name does NOT include the path) +# If a tag file is not located in the directory in which doxygen +# is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option is superseded by the HAVE_DOT option below. This is only a +# fallback. It is recommended to install and use dot, since it yields more +# powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = YES + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = NO + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# the CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = NO + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = NO + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = NO + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = NO + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are png, jpg, or gif +# If left blank png will be used. + +DOT_IMAGE_FORMAT = png + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MAX_DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 50 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is enabled by default, which results in a transparent +# background. Warning: Depending on the platform used, enabling this option +# may lead to badly anti-aliased labels on the edges of a graph (i.e. they +# become hard to read). + +DOT_TRANSPARENT = YES + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = NO + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- + +# The SEARCHENGINE tag specifies whether or not a search engine should be +# used. If set to NO the values of all tags below this one will be ignored. + +SEARCHENGINE = NO diff --git a/README.md b/README.md new file mode 100644 index 0000000..354994d --- /dev/null +++ b/README.md @@ -0,0 +1,13 @@ +#Tlc5940 Library# + +16 channel PWM LED driver based on the Texas Instruments TLC5940 chip. + +http://www.pjrc.com/teensy/td_libs_Tlc5940.html + +http://code.google.com/p/tlc5940arduino/ + +http://playground.arduino.cc/Learning/TLC5940 + +https://github.com/PaulStoffregen/Tlc5940 + +![Tlc5940 with Teensy 2.0](http://www.pjrc.com/teensy/td_libs_Tlc5940_1.jpg) diff --git a/Tlc5940.cpp b/Tlc5940.cpp new file mode 100644 index 0000000..4f850b5 --- /dev/null +++ b/Tlc5940.cpp @@ -0,0 +1,494 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +/** \file + Tlc5940 class functions. */ + +#include +#include + +#include "tlc_config.h" +#include "Tlc5940.h" + +/** Pulses a pin - high then low. */ +#define pulse_pin(port, pin) port |= _BV(pin); port &= ~_BV(pin) + +/** This will be true (!= 0) if update was just called and the data has not + been latched in yet. */ +volatile uint8_t tlc_needXLAT; + +/** Some of the extened library will need to be called after a successful + update. */ +volatile void (*tlc_onUpdateFinished)(void); + +/** Packed grayscale data, 24 bytes (16 * 12 bits) per TLC. + + Format: Lets assume we have 2 TLCs, A and B, daisy-chained with the SOUT of + A going into the SIN of B. + - byte 0: upper 8 bits of B.15 + - byte 1: lower 4 bits of B.15 and upper 4 bits of B.14 + - byte 2: lower 8 bits of B.0 + - ... + - byte 24: upper 8 bits of A.15 + - byte 25: lower 4 bits of A.15 and upper 4 bits of A.14 + - ... + - byte 47: lower 8 bits of A.0 + + \note Normally packing data like this is bad practice. But in this + situation, shifting the data out is really fast because the format of + the array is the same as the format of the TLC's serial interface. */ +uint8_t tlc_GSData[NUM_TLCS * 24]; + +/** Don't add an extra SCLK pulse after switching from dot-correction mode. */ +static uint8_t firstGSInput; + +/** Interrupt called after an XLAT pulse to prevent more XLAT pulses. */ +ISR(TIMER1_OVF_vect) +{ + disable_XLAT_pulses(); + clear_XLAT_interrupt(); + tlc_needXLAT = 0; + if (tlc_onUpdateFinished) { + sei(); + tlc_onUpdateFinished(); + } +} + +/** \defgroup ReqVPRG_ENABLED Functions that Require VPRG_ENABLED + Functions that require VPRG_ENABLED == 1. + You can enable VPRG by changing + \code #define VPRG_ENABLED 0 \endcode to + \code #define VPRG_ENABLED 1 \endcode in tlc_config.h + + You will also have to connect Arduino digital pin 6 to TLC pin 27. (The + pin to be used can be changed in tlc_config.h). If VPRG is not enabled, + the TLC pin should grounded (remember to unconnect TLC pin 27 from GND + if you do enable VPRG). */ +/* @{ */ /* @} */ + +/** \defgroup CoreFunctions Core Libary Functions + These function are all prefixed with "Tlc." */ +/* @{ */ + +/** Pin i/o and Timer setup. The grayscale register will be reset to all + zeros, or whatever initialValue is set to and the Timers will start. + \param initialValue = 0, optional parameter specifing the inital startup + value */ +void Tlc5940::init(uint16_t initialValue) +{ + /* Pin Setup */ + XLAT_DDR |= _BV(XLAT_PIN); + BLANK_DDR |= _BV(BLANK_PIN); + GSCLK_DDR |= _BV(GSCLK_PIN); +#if VPRG_ENABLED + VPRG_DDR |= _BV(VPRG_PIN); + VPRG_PORT &= ~_BV(VPRG_PIN); // grayscale mode (VPRG low) +#endif +#if XERR_ENABLED + XERR_DDR &= ~_BV(XERR_PIN); // XERR as input + XERR_PORT |= _BV(XERR_PIN); // enable pull-up resistor +#endif + BLANK_PORT |= _BV(BLANK_PIN); // leave blank high (until the timers start) + + tlc_shift8_init(); + + setAll(initialValue); + update(); + disable_XLAT_pulses(); + clear_XLAT_interrupt(); + tlc_needXLAT = 0; + pulse_pin(XLAT_PORT, XLAT_PIN); + + + /* Timer Setup */ + + /* Timer 1 - BLANK / XLAT */ + TCCR1A = _BV(COM1B1); // non inverting, output on OC1B, BLANK + TCCR1B = _BV(WGM13); // Phase/freq correct PWM, ICR1 top + OCR1A = 1; // duty factor on OC1A, XLAT is inside BLANK + OCR1B = 2; // duty factor on BLANK (larger than OCR1A (XLAT)) + ICR1 = TLC_PWM_PERIOD; // see tlc_config.h + + /* Timer 2 - GSCLK */ +#if defined(TLC_ATMEGA_8_H) + TCCR2 = _BV(COM20) // set on BOTTOM, clear on OCR2A (non-inverting), + | _BV(WGM21); // output on OC2B, CTC mode with OCR2 top + OCR2 = TLC_GSCLK_PERIOD / 2; // see tlc_config.h + TCCR2 |= _BV(CS20); // no prescale, (start pwm output) +#elif defined(TLC_TIMER3_GSCLK) + TCCR3A = _BV(COM3A1) // set on BOTTOM, clear on OCR3A (non-inverting), + // output on OC3A + | _BV(WGM31); // Fast pwm with ICR3 top + OCR3A = 0; // duty factor (as short a pulse as possible) + ICR3 = TLC_GSCLK_PERIOD; // see tlc_config.h + TCCR3B = _BV(CS30) // no prescale, (start pwm output) + | _BV(WGM32) // Fast pwm with ICR3 top + | _BV(WGM33); // Fast pwm with ICR3 top +#else + TCCR2A = _BV(COM2B1) // set on BOTTOM, clear on OCR2A (non-inverting), + // output on OC2B + | _BV(WGM21) // Fast pwm with OCR2A top + | _BV(WGM20); // Fast pwm with OCR2A top + TCCR2B = _BV(WGM22); // Fast pwm with OCR2A top + OCR2B = 0; // duty factor (as short a pulse as possible) + OCR2A = TLC_GSCLK_PERIOD; // see tlc_config.h + TCCR2B |= _BV(CS20); // no prescale, (start pwm output) +#endif + TCCR1B |= _BV(CS10); // no prescale, (start pwm output) + update(); +} + +/** Clears the grayscale data array, #tlc_GSData, but does not shift in any + data. This call should be followed by update() if you are turning off + all the outputs. */ +void Tlc5940::clear(void) +{ + setAll(0); +} + +/** Shifts in the data from the grayscale data array, #tlc_GSData. + If data has already been shifted in this grayscale cycle, another call to + update() will immediately return 1 without shifting in the new data. To + ensure that a call to update() does shift in new data, use + \code while(Tlc.update()); \endcode + or + \code while(tlc_needXLAT); \endcode + \returns 1 if there is data waiting to be latched, 0 if data was + successfully shifted in */ +uint8_t Tlc5940::update(void) +{ + if (tlc_needXLAT) { + return 1; + } + disable_XLAT_pulses(); + if (firstGSInput) { + // adds an extra SCLK pulse unless we've just set dot-correction data + firstGSInput = 0; + } else { + pulse_pin(SCLK_PORT, SCLK_PIN); + } + uint8_t *p = tlc_GSData; + while (p < tlc_GSData + NUM_TLCS * 24) { + tlc_shift8(*p++); + tlc_shift8(*p++); + tlc_shift8(*p++); + } + tlc_needXLAT = 1; + enable_XLAT_pulses(); + set_XLAT_interrupt(); + return 0; +} + +/** Sets channel to value in the grayscale data array, #tlc_GSData. + \param channel (0 to #NUM_TLCS * 16 - 1). OUT0 of the first TLC is + channel 0, OUT0 of the next TLC is channel 16, etc. + \param value (0-4095). The grayscale value, 4095 is maximum. + \see get */ +void Tlc5940::set(TLC_CHANNEL_TYPE channel, uint16_t value) +{ + TLC_CHANNEL_TYPE index8 = (NUM_TLCS * 16 - 1) - channel; + uint8_t *index12p = tlc_GSData + ((((uint16_t)index8) * 3) >> 1); + if (index8 & 1) { // starts in the middle + // first 4 bits intact | 4 top bits of value + *index12p = (*index12p & 0xF0) | (value >> 8); + // 8 lower bits of value + *(++index12p) = value & 0xFF; + } else { // starts clean + // 8 upper bits of value + *(index12p++) = value >> 4; + // 4 lower bits of value | last 4 bits intact + *index12p = ((uint8_t)(value << 4)) | (*index12p & 0xF); + } +} + +/** Gets the current grayscale value for a channel + \param channel (0 to #NUM_TLCS * 16 - 1). OUT0 of the first TLC is + channel 0, OUT0 of the next TLC is channel 16, etc. + \returns current grayscale value (0 - 4095) for channel + \see set */ +uint16_t Tlc5940::get(TLC_CHANNEL_TYPE channel) +{ + TLC_CHANNEL_TYPE index8 = (NUM_TLCS * 16 - 1) - channel; + uint8_t *index12p = tlc_GSData + ((((uint16_t)index8) * 3) >> 1); + return (index8 & 1)? // starts in the middle + (((uint16_t)(*index12p & 15)) << 8) | // upper 4 bits + *(index12p + 1) // lower 8 bits + : // starts clean + (((uint16_t)(*index12p)) << 4) | // upper 8 bits + ((*(index12p + 1) & 0xF0) >> 4); // lower 4 bits + // that's probably the ugliest ternary operator I've ever created. +} + +/** Sets all channels to value. + \param value grayscale value (0 - 4095) */ +void Tlc5940::setAll(uint16_t value) +{ + uint8_t firstByte = value >> 4; + uint8_t secondByte = (value << 4) | (value >> 8); + uint8_t *p = tlc_GSData; + while (p < tlc_GSData + NUM_TLCS * 24) { + *p++ = firstByte; + *p++ = secondByte; + *p++ = (uint8_t)value; + } +} + +#if VPRG_ENABLED + +/** \addtogroup ReqVPRG_ENABLED + From the \ref CoreFunctions "Core Functions": + - \link Tlc5940::setAllDC Tlc.setAllDC(uint8_t value(0-63)) \endlink - sets + all the dot correction data to value */ +/* @{ */ + +/** Sets the dot correction for all channels to value. The dot correction + value correspondes to maximum output current by + \f$\displaystyle I_{OUT_n} = I_{max} \times \frac{DCn}{63} \f$ + where + - \f$\displaystyle I_{max} = \frac{1.24V}{R_{IREF}} \times 31.5 = + \frac{39.06}{R_{IREF}} \f$ + - DCn is the dot correction value for channel n + \param value (0-63) */ +void Tlc5940::setAllDC(uint8_t value) +{ + tlc_dcModeStart(); + + uint8_t firstByte = value << 2 | value >> 4; + uint8_t secondByte = value << 4 | value >> 2; + uint8_t thirdByte = value << 6 | value; + + for (TLC_CHANNEL_TYPE i = 0; i < NUM_TLCS * 12; i += 3) { + tlc_shift8(firstByte); + tlc_shift8(secondByte); + tlc_shift8(thirdByte); + } + pulse_pin(XLAT_PORT, XLAT_PIN); + + tlc_dcModeStop(); +} + +/* @} */ + +#endif + +#if XERR_ENABLED + +/** Checks for shorted/broken LEDs reported by any of the TLCs. + \returns 1 if a TLC is reporting an error, 0 otherwise. */ +uint8_t Tlc5940::readXERR(void) +{ + return ((XERR_PINS & _BV(XERR_PIN)) == 0); +} + +#endif + +/* @} */ + +#if DATA_TRANSFER_MODE == TLC_BITBANG + +/** Sets all the bit-bang pins to output */ +void tlc_shift8_init(void) +{ + SIN_DDR |= _BV(SIN_PIN); // SIN as output + SCLK_DDR |= _BV(SCLK_PIN); // SCLK as output + SCLK_PORT &= ~_BV(SCLK_PIN); +} + +/** Shifts a byte out, MSB first */ +void tlc_shift8(uint8_t byte) +{ + for (uint8_t bit = 0x80; bit; bit >>= 1) { + if (bit & byte) { + SIN_PORT |= _BV(SIN_PIN); + } else { + SIN_PORT &= ~_BV(SIN_PIN); + } + pulse_pin(SCLK_PORT, SCLK_PIN); + } +} + +#elif DATA_TRANSFER_MODE == TLC_SPI + +/** Initializes the SPI module to double speed (f_osc / 2) */ +void tlc_shift8_init(void) +{ + SIN_DDR |= _BV(SIN_PIN); // SPI MOSI as output + SCLK_DDR |= _BV(SCLK_PIN); // SPI SCK as output + TLC_SS_DDR |= _BV(TLC_SS_PIN); // SPI SS as output + + SCLK_PORT &= ~_BV(SCLK_PIN); + + SPSR = _BV(SPI2X); // double speed (f_osc / 2) + SPCR = _BV(SPE) // enable SPI + | _BV(MSTR); // master mode +} + +/** Shifts out a byte, MSB first */ +void tlc_shift8(uint8_t byte) +{ + SPDR = byte; // starts transmission + while (!(SPSR & _BV(SPIF))) + ; // wait for transmission complete +} + +#endif + +#if VPRG_ENABLED + +/** Switches to dot correction mode and clears any waiting grayscale latches.*/ +void tlc_dcModeStart(void) +{ + disable_XLAT_pulses(); // ensure that no latches happen + clear_XLAT_interrupt(); // (in case this was called right after update) + tlc_needXLAT = 0; + VPRG_PORT |= _BV(VPRG_PIN); // dot correction mode +} + +/** Switches back to grayscale mode. */ +void tlc_dcModeStop(void) +{ + VPRG_PORT &= ~_BV(VPRG_PIN); // back to grayscale mode + firstGSInput = 1; +} + +#endif + +/** Preinstantiated Tlc variable. */ +Tlc5940 Tlc; + +/** \defgroup ExtendedFunctions Extended Library Functions + These functions require an include statement at the top of the sketch. */ +/* @{ */ /* @} */ + +/** \mainpage + The Texas Instruments TLC5940 + is a 16-channel, constant-current sink LED driver. Each channel has + an individually adjustable 4096-step grayscale PWM brightness control and + a 64-step, constant-current sink (no LED resistors needed!). This chip + is a current sink, so be sure to use common anode RGB LEDs. + + Check the tlc5940arduino + project on Google Code for updates. To install, unzip the "Tlc5940" + folder to <Arduino Folder>/hardware/libraries/ + +   + + \section hardwaresetup Hardware Setup + The basic hardware setup is explained at the top of the Examples. A good + place to start would be the BasicUse Example. (The examples are in + File->Sketchbook->Examples->Library-Tlc5940). + + All the options for the library are located in tlc_config.h, including + #NUM_TLCS, what pins to use, and the PWM period. After changing + tlc_config.h, be sure to delete the Tlc5940.o file in the library folder + to save the changes. + +   + + \section libref Library Reference + \ref CoreFunctions "Core Functions" (see the BasicUse Example and Tlc5940): + - \link Tlc5940::init Tlc.init(int initialValue (0-4095))\endlink - Call this is + to setup the timers before using any other Tlc functions. + initialValue defaults to zero (all channels off). + - \link Tlc5940::clear Tlc.clear()\endlink - Turns off all channels + (Needs Tlc.update()) + - \link Tlc5940::set Tlc.set(uint8_t channel (0-(NUM_TLCS * 16 - 1)), + int value (0-4095))\endlink - sets the grayscale data for channel. + (Needs Tlc.update()) + - \link Tlc5940::setAll Tlc.setAll(int value(0-4095))\endlink - sets all + channels to value. (Needs Tlc.update()) + - \link Tlc5940::get uint16_t Tlc.get(uint8_t channel)\endlink - returns + the grayscale data for channel (see set). + - \link Tlc5940::update Tlc.update()\endlink - Sends the changes from any + Tlc.clear's, Tlc.set's, or Tlc.setAll's. + + \ref ExtendedFunctions "Extended Functions". These require an include + statement at the top of the sketch to use. + + \ref ReqVPRG_ENABLED "Functions that require VPRG_ENABLED". These + require VPRG_ENABLED == 1 in tlc_config.h + +   + + \section expansion Expanding the Library + Lets say we wanted to add a function like "tlc_goCrazy(...)". The first + thing to do is to create a source file in the library folder, + "tlc_my_crazy_functions.h". + A template for this .h file is + \code +// Explination for my crazy function extension + +#ifndef TLC_MY_CRAZY_FUNCTIONS_H +#define TLC_MY_CRAZY_FUNCTIONS_H + +#include "tlc_config.h" +#include "Tlc5940.h" + +void tlc_goCrazy(void); + +void tlc_goCrazy(void) +{ + uint16_t crazyFactor = 4000; + Tlc.clear(); + for (uint8_t channel = 4; channel < 9; channel++) { + Tlc.set(channel, crazyFactor); + } + Tlc.update(); +} + +#endif + * \endcode + * Now to use your library in a sketch, just add + * \code +#include "tlc_my_crazy_functions.h" + +// ... + +tlc_goCrazy(); + \endcode + If you would like to share your extended functions for others to use, + email me (acleone ~AT~ gmail.com) with the file and an example and I'll + include them in the library. + +   + + \section bugs Contact + If you found a bug in the library, email me so I can fix it! + My email is acleone ~AT~ gmail.com + +   + + \section license License - GPLv3 + Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + diff --git a/Tlc5940.h b/Tlc5940.h new file mode 100644 index 0000000..9b5ae0e --- /dev/null +++ b/Tlc5940.h @@ -0,0 +1,87 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC5940_H +#define TLC5940_H + +/** \file + Tlc5940 library header file. */ + +#include +#include "tlc_config.h" + +#ifdef TLC_ATMEGA_8_H + +/** Enables the Timer1 Overflow interrupt, which will fire after an XLAT + pulse */ +#define set_XLAT_interrupt() TIFR |= _BV(TOV1); TIMSK = _BV(TOIE1) +/** Disables any Timer1 interrupts */ +#define clear_XLAT_interrupt() TIMSK = 0 + +#else + +/** Enables the Timer1 Overflow interrupt, which will fire after an XLAT + pulse */ +#define set_XLAT_interrupt() TIFR1 |= _BV(TOV1); TIMSK1 = _BV(TOIE1) +/** Disables any Timer1 interrupts */ +#define clear_XLAT_interrupt() TIMSK1 = 0 + +#endif + +/** Enables the output of XLAT pulses */ +#define enable_XLAT_pulses() TCCR1A = _BV(COM1A1) | _BV(COM1B1) +/** Disables the output of XLAT pulses */ +#define disable_XLAT_pulses() TCCR1A = _BV(COM1B1) + +extern volatile uint8_t tlc_needXLAT; +extern volatile void (*tlc_onUpdateFinished)(void); +extern uint8_t tlc_GSData[NUM_TLCS * 24]; + +/** The main Tlc5940 class for the entire library. An instance of this class + will be preinstantiated as Tlc. */ +class Tlc5940 +{ + public: + void init(uint16_t initialValue = 0); + void clear(void); + uint8_t update(void); + void set(TLC_CHANNEL_TYPE channel, uint16_t value); + uint16_t get(TLC_CHANNEL_TYPE channel); + void setAll(uint16_t value); +#if VPRG_ENABLED + void setAllDC(uint8_t value); +#endif +#if XERR_ENABLED + uint8_t readXERR(void); +#endif + +}; + +void tlc_shift8_init(void); +void tlc_shift8(uint8_t byte); + +#if VPRG_ENABLED +void tlc_dcModeStart(void); +void tlc_dcModeStop(void); +#endif + +// for the preinstantiated Tlc variable. +extern Tlc5940 Tlc; + +#endif + diff --git a/changelog.txt b/changelog.txt new file mode 100644 index 0000000..111401b --- /dev/null +++ b/changelog.txt @@ -0,0 +1,48 @@ +2009-05-07 + - Added support for the Arduino Mega + +2009-04-19 + - Bug fix in tlc_fades.h (incrementing a pointer after removing something + from the fadeBuffer array). Also tlc_updateFades() will wait till after + an update if it's just removed the last fade. + - Updated the core function documentation. + +2009-03-05 + - Fixed the missing pin definitions for the ATmega328p + +2009-02-16 + - Added tlc_servos.h and example (thank you Steve Pomeroy) + - Cleaned up some older documentation + - Added trailing newlines to c, h, cpp, and pde files + +2009-02-03 + - Added support for the Sanguino (ATmega xx4 series) + - Added support for the ATmega 8 + - Moved the project to Google Code: + http://code.google.com/p/tlc5940arduino/ + - Fixed a bug in tlc_fades.h: assignment of struct arrays + - Cleaned up the whitespace in the library: 4 spaces instead of tabs + +2009-01-25 + - Added tlc_fades.h + - Added include "tlc_config.h" to Tlc5940.h so it's not required + in the sketch + - Added Tlc.setAll(value) + - Changed a few for loops in Tlc5940.cpp: used *p++ instead of having + p++ in the increment section of the for loop; changed to while loops + +2008-11-26 + - Tlc.init() sets all channels to zero and updates. + - Added TLC_PWM_PERIOD and TLC_GSCLK_PERIOD to tlc_config.h + - Added TLC_CHANNEL_TYPE to tlc_config.h - Adds support for up to 4096 TLCs. + (if TLC_CHANNEL_TYPE is uint16_t) + - Changed the examples to use TLC_CHANNEL_TYPE + - set DATA_TRANSFER_MODE default to TLC_SPI + +2008-11-11 + - Added tlc_animations.h and examples + - Fixed SPI mode - (don't use enums as constants + "#if A == 1" doesn't work) + +2008-10-31 + - Initial Release diff --git a/examples/BasicAnimations/AnimationCreator.class b/examples/BasicAnimations/AnimationCreator.class new file mode 100644 index 0000000..7f2f23d Binary files /dev/null and b/examples/BasicAnimations/AnimationCreator.class differ diff --git a/examples/BasicAnimations/AnimationCreator.java b/examples/BasicAnimations/AnimationCreator.java new file mode 100644 index 0000000..0c493e5 --- /dev/null +++ b/examples/BasicAnimations/AnimationCreator.java @@ -0,0 +1,86 @@ +/* + * First Attempt at generating the TLC output code from an image. + * Run this with "java AnimationCreator" + * It will read any image file in the current directory and create an animation for the TLC library. + * + * Right now this only works with 1 TLC with 16 LEDS connected to it, where + * output0 is the bottom and output15 is the top. + * + * For best results make your files 16 pixels high and as wide as you want. Each vertical pixel + * corresponds to an LED output. + * + * Alex Leone , 2008-11-12 + */ + +import java.util.*; +import java.awt.*; +import java.awt.image.*; +import java.io.*; +import javax.imageio.*; + +public class AnimationCreator { + + public static void main(String[] args) throws IOException { + if (args.length == 0) { + autoProcess(); + } + } + + public static void autoProcess() throws IOException { + File currentDirectory = new File ("."); + File[] files = currentDirectory.listFiles(); + int animationCount = 1; + for (File file : files) { + if (!file.isFile()) + continue; + String fileName = file.getName(); + String suffix = fileName.substring(fileName.indexOf('.') + 1); + if(!canReadFormat(suffix)) + continue; + String baseName = fileName.substring(0, fileName.indexOf('.')); + String varName = "ani_" + baseName.toLowerCase(); + String outputName = varName + ".h"; + System.out.println("Writing " + outputName); + BufferedImage image = ImageIO.read(file); + PrintStream output = new PrintStream(new File(outputName)); + output.println("#define " + varName.toUpperCase() + "_FRAMES " + image.getWidth()); + output.println("uint8_t " + varName + "[NUM_TLCS * 24 * " + varName.toUpperCase() + "_FRAMES] PROGMEM = {"); + int[] rowRGB = new int[16]; + for (int w = 0; w < image.getWidth(); w++) { + for (int h = 0; h < 16; h++) { + rowRGB[h] = image.getRGB(w, 15 - h); + } + parseRow(rowRGB, output); + } + output.println("};"); + System.out.println("Wrote " + image.getWidth() + " frames to " + outputName); + animationCount++; + } + } + + // Returns true if the specified format name can be read + public static boolean canReadFormat(String formatName) { + Iterator iter = ImageIO.getImageReadersByFormatName(formatName); + return iter.hasNext(); + } + + public static double rgbToGrayscaleIntensity(int rgb) { + Color c = new Color(rgb); + return 0.2989 * c.getRed() + 0.5870 * c.getGreen() + 0.1140 * c.getBlue(); + } + + public static void parseRow(int[] rowRGB, PrintStream output) { + output.print("\t"); + for (int i = rowRGB.length - 1; i >= 0; i -= 2) { + int a = (255 - (int)Math.round(rgbToGrayscaleIntensity(rowRGB[i]))); + int b = (255 - (int)Math.round(rgbToGrayscaleIntensity(rowRGB[i - 1]))); + output.print(((a >> 4) & 0xFF) + "," + (((a << 4) | (b >> 8)) & 0xFF) + "," + (b & 0xFF) + ","); + //System.out.print( + // "GS_DUO(" + (255 - Math.round(rgbToGrayscaleIntensity(rowRGB[i]))) + "," + + // (255 - Math.round(rgbToGrayscaleIntensity(rowRGB[i - 1]))) + "),"); + } + output.println(); + } + + +} \ No newline at end of file diff --git a/examples/BasicAnimations/Arduino.png b/examples/BasicAnimations/Arduino.png new file mode 100644 index 0000000..9b1578e Binary files /dev/null and b/examples/BasicAnimations/Arduino.png differ diff --git a/examples/BasicAnimations/BasicAnimations.pde b/examples/BasicAnimations/BasicAnimations.pde new file mode 100644 index 0000000..cd2643d --- /dev/null +++ b/examples/BasicAnimations/BasicAnimations.pde @@ -0,0 +1,52 @@ +/* + Writes "Ardunio" with Persistance of Vision (POV) with 16 LEDs (output 0 + is on bottom, output 15 is top). The animation below doesn't work with + more than 1 TLC. + + I generated the animation with the included java code: + /hardware/libraries/Tlc5940/examples/BasicAnimations + + To use the code, run + java AnimationCreator + in the folder above and it will parse all images in the folder to + .h files. For best results use images that are 16 pixels high. + + See the BasicUse example for hardware setup. + + Alex Leone , 2009-02-03 */ + +#include "Tlc5940.h" +#include "tlc_animations.h" +#include "ani_arduino.h" + +void setup() +{ + Tlc.init(); +} + +void loop() +{ + // checks to see if the animation is finished playing + if (!tlc_onUpdateFinished) { + + delay(100); + + /* + void tlc_playAnimation(prog_uint8_t *animation, uint16_t frames, + uint16_t periodsPerFrame); + periods per frame is PWM periods, 1.024ms per frame (0 is valid - this + will play the animation as fast as possible). + + Plays an animation in the "background". + Don't call Tlc.update() while this is running. + You can check if this is done with !tlc_onUpdateFinished */ + tlc_playAnimation(ani_arduino, ANI_ARDUINO_FRAMES, 3); + + + // If you don't want to do anything until it's finished, use: + // while (!tlc_onUpdateFinished); + + } + +} + diff --git a/examples/BasicAnimations/ani_arduino.h b/examples/BasicAnimations/ani_arduino.h new file mode 100644 index 0000000..dc92f1a --- /dev/null +++ b/examples/BasicAnimations/ani_arduino.h @@ -0,0 +1,84 @@ +#define ANI_ARDUINO_FRAMES 80 +uint8_t ani_arduino[NUM_TLCS * 24 * ANI_ARDUINO_FRAMES] PROGMEM = { + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,16,6,176,206, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,16,65,10,64,247,15,240,255, + 0,0,0,0,0,0,0,0,0,0,0,0,1,160,122,13,192,255,15,240,254,11,192,89, + 0,0,0,0,0,0,0,0,4,4,240,179,15,192,255,15,240,255,8,32,33,0,0,0, + 0,0,0,0,0,37,8,128,231,15,240,255,15,144,169,15,240,255,0,0,0,0,0,0, + 0,0,94,12,16,255,15,240,255,13,64,113,1,48,0,15,240,255,0,0,0,0,0,0, + 0,0,255,15,240,243,9,192,56,0,0,0,0,0,0,15,240,255,0,0,0,0,0,0, + 0,0,255,15,240,243,9,208,57,0,0,0,0,0,0,15,240,255,0,0,0,0,0,0, + 0,0,93,12,0,255,15,240,255,13,80,114,1,64,0,15,240,255,0,0,0,0,0,0, + 0,0,0,0,0,36,8,112,230,15,240,255,15,144,170,15,240,255,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,4,4,224,178,15,192,255,15,240,255,8,32,32,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,1,144,121,13,176,255,15,240,254,11,160,86, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,64,10,48,246,15,240,255, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,16,6,160,206, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,2,9,224,248,7,32,24,0,16,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,109,15,240,115,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,208,15,240,25,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,248,15,240,1,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,253,15,240,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,16,90,11,176,237,15,192,237,11,176,90,0,16,0, + 0,0,0,0,0,0,0,0,6,11,0,255,15,240,255,15,240,255,15,240,255,11,16,6, + 0,0,0,0,0,0,0,0,125,15,240,247,7,48,26,0,48,26,7,16,246,15,240,126, + 0,0,0,0,0,0,0,0,221,15,240,100,0,0,0,0,0,0,0,0,98,15,240,222, + 0,0,0,0,0,0,0,0,250,15,240,14,0,0,0,0,0,0,0,0,13,15,240,249, + 0,0,0,0,0,0,0,0,226,15,240,14,0,0,0,0,0,0,0,0,13,15,240,223, + 0,0,0,0,0,0,0,0,130,15,240,103,0,0,0,0,0,0,0,0,100,15,240,131, + 0,0,0,0,0,0,0,0,5,10,112,248,7,96,27,0,64,27,7,64,247,10,112,6, + 15,240,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 15,240,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,255,15,240,255,15,240,255,15,240,253,14,144,173,3,32,0, + 0,0,0,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,144,57, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,3,2,224,201,15,240,186, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,46,15,240,242, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,4,15,240,246, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,23,15,240,206, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,111,15,240,102, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,13,6,32,246,9,80,0, + 0,0,0,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 15,240,255,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 15,240,255,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,255,15,240,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,0,9,64,246,6,48,13,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,100,15,240,111,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,208,15,240,24,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,250,15,240,4,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,241,15,240,47,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,186,15,240,202,2,240,3,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,57,15,144,255,15,240,255,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,0,3,32,173,14,144,253,15,240,255,15,240,255,15,240,255, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0, + 0,0,0,0,0,0,0,0,0,0,0,73,11,80,235,15,176,235,11,80,74,0,0,0, + 0,0,0,0,0,0,0,0,0,8,80,255,15,240,255,15,240,255,15,240,255,8,144,0, + 0,0,0,0,0,0,0,0,72,15,240,254,8,128,31,0,64,31,8,128,254,15,240,74, + 0,0,0,0,0,0,0,0,179,15,240,137,0,0,0,0,0,0,0,0,136,15,240,181, + 0,0,0,0,0,0,0,0,234,15,240,32,0,0,0,0,0,0,0,0,31,15,240,235, + 0,0,0,0,0,0,0,0,251,15,240,5,0,0,0,0,0,0,0,0,4,15,240,251, + 0,0,0,0,0,0,0,0,234,15,240,33,0,0,0,0,0,0,0,0,32,15,240,235, + 0,0,0,0,0,0,0,0,179,15,240,142,0,0,0,0,0,0,0,0,138,15,240,180, + 0,0,0,0,0,0,0,0,69,15,240,255,8,224,33,0,80,32,8,176,254,15,240,72, + 0,0,0,0,0,0,0,0,0,8,16,255,15,240,255,15,240,255,15,240,255,8,80,0, + 0,0,0,0,0,0,0,0,0,0,0,70,11,48,234,15,176,234,11,48,72,0,0,0, +}; + diff --git a/examples/BasicUse/BasicUse.pde b/examples/BasicUse/BasicUse.pde new file mode 100644 index 0000000..8178175 --- /dev/null +++ b/examples/BasicUse/BasicUse.pde @@ -0,0 +1,101 @@ +/* + Basic Pin setup: + ------------ ---u---- + ARDUINO 13|-> SCLK (pin 25) OUT1 |1 28| OUT channel 0 + 12| OUT2 |2 27|-> GND (VPRG) + 11|-> SIN (pin 26) OUT3 |3 26|-> SIN (pin 11) + 10|-> BLANK (pin 23) OUT4 |4 25|-> SCLK (pin 13) + 9|-> XLAT (pin 24) . |5 24|-> XLAT (pin 9) + 8| . |6 23|-> BLANK (pin 10) + 7| . |7 22|-> GND + 6| . |8 21|-> VCC (+5V) + 5| . |9 20|-> 2K Resistor -> GND + 4| . |10 19|-> +5V (DCPRG) + 3|-> GSCLK (pin 18) . |11 18|-> GSCLK (pin 3) + 2| . |12 17|-> SOUT + 1| . |13 16|-> XERR + 0| OUT14|14 15| OUT channel 15 + ------------ -------- + + - Put the longer leg (anode) of the LEDs in the +5V and the shorter leg + (cathode) in OUT(0-15). + - +5V from Arduino -> TLC pin 21 and 19 (VCC and DCPRG) + - GND from Arduino -> TLC pin 22 and 27 (GND and VPRG) + - digital 3 -> TLC pin 18 (GSCLK) + - digital 9 -> TLC pin 24 (XLAT) + - digital 10 -> TLC pin 23 (BLANK) + - digital 11 -> TLC pin 26 (SIN) + - digital 13 -> TLC pin 25 (SCLK) + - The 2K resistor between TLC pin 20 and GND will let ~20mA through each + LED. To be precise, it's I = 39.06 / R (in ohms). This doesn't depend + on the LED driving voltage. + - (Optional): put a pull-up resistor (~10k) between +5V and BLANK so that + all the LEDs will turn off when the Arduino is reset. + + If you are daisy-chaining more than one TLC, connect the SOUT of the first + TLC to the SIN of the next. All the other pins should just be connected + together: + BLANK on Arduino -> BLANK of TLC1 -> BLANK of TLC2 -> ... + XLAT on Arduino -> XLAT of TLC1 -> XLAT of TLC2 -> ... + The one exception is that each TLC needs it's own resistor between pin 20 + and GND. + + This library uses the PWM output ability of digital pins 3, 9, 10, and 11. + Do not use analogWrite(...) on these pins. + + This sketch does the Knight Rider strobe across a line of LEDs. + + Alex Leone , 2009-02-03 */ + +#include "Tlc5940.h" + +void setup() +{ + /* Call Tlc.init() to setup the tlc. + You can optionally pass an initial PWM value (0 - 4095) for all channels.*/ + Tlc.init(); +} + +/* This loop will create a Knight Rider-like effect if you have LEDs plugged + into all the TLC outputs. NUM_TLCS is defined in "tlc_config.h" in the + library folder. After editing tlc_config.h for your setup, delete the + Tlc5940.o file to save the changes. */ + +void loop() +{ + int direction = 1; + for (int channel = 0; channel < NUM_TLCS * 16; channel += direction) { + + /* Tlc.clear() sets all the grayscale values to zero, but does not send + them to the TLCs. To actually send the data, call Tlc.update() */ + Tlc.clear(); + + /* Tlc.set(channel (0-15), value (0-4095)) sets the grayscale value for + one channel (15 is OUT15 on the first TLC, if multiple TLCs are daisy- + chained, then channel = 16 would be OUT0 of the second TLC, etc.). + + value goes from off (0) to always on (4095). + + Like Tlc.clear(), this function only sets up the data, Tlc.update() + will send the data. */ + if (channel == 0) { + direction = 1; + } else { + Tlc.set(channel - 1, 1000); + } + Tlc.set(channel, 4095); + if (channel != NUM_TLCS * 16 - 1) { + Tlc.set(channel + 1, 1000); + } else { + direction = -1; + } + + /* Tlc.update() sends the data to the TLCs. This is when the LEDs will + actually change. */ + Tlc.update(); + + delay(75); + } + +} + diff --git a/examples/CircularLightBuffer/CircularLightBuffer.pde b/examples/CircularLightBuffer/CircularLightBuffer.pde new file mode 100644 index 0000000..5930bbf --- /dev/null +++ b/examples/CircularLightBuffer/CircularLightBuffer.pde @@ -0,0 +1,48 @@ +/* + A circular light buffer. If you manage to construct a circle of LEDs, + definitely send in pictures. What this sketch does is take an analog + reading off of analog pin 0 and add it to the current value of the last LED. + If the resultant sum is greater than 4095, it turns the LED off, + otherwise sets LED 0 to the value of the sum. + + If you ground pin 12, it will set LED 0 to zero. + + Then it shifts all the LED values up one (so LED 0 becomes LED 1) and sets + LED 0 to the value shifted off the last LED (so if one LED is on, it will + go in a circle forever). + + See the BasicUse example for hardware setup. + + Alex Leone , 2009-02-04 */ + +#include "Tlc5940.h" +#include "tlc_shifts.h" + +// which analog pin to use +#define ANALOG_PIN 0 + +// which pin to clear the LEDs with +#define CLEAR_PIN 12 + +// how many millis for one full revolution over all the LEDs +#define SCOPE_PERIOD (2000 * NUM_TLCS) +#define LED_PERIOD SCOPE_PERIOD / (NUM_TLCS * 16) + +void setup() +{ + pinMode(CLEAR_PIN, INPUT); + digitalWrite(CLEAR_PIN, HIGH); // enable pull-up + Tlc.init(); +} + +void loop() +{ + // shiftUp returns the value shifted off the last pin + uint16_t sum = tlc_shiftUp() + analogRead(ANALOG_PIN) * 4; + if (digitalRead(CLEAR_PIN) == LOW || sum > 4095) + sum = 0; + Tlc.set(0, sum); + Tlc.update(); + delay(LED_PERIOD); +} + diff --git a/examples/FadeScope/FadeScope.pde b/examples/FadeScope/FadeScope.pde new file mode 100644 index 0000000..c880a24 --- /dev/null +++ b/examples/FadeScope/FadeScope.pde @@ -0,0 +1,45 @@ +/* + A simple 1-d oscilliscope: scan all the channels, setting the PWM output + value to 4x the analog pin 0 value (0 - 1024 * 4 = 4096). The value will + fade to zero as the channels keep scanning. + + See the BasicUse example for hardware setup. + + Alex Leone , 2009-02-03 */ + +#include "Tlc5940.h" +#include "tlc_fades.h" + +// which analog pin to use +#define ANALOG_PIN 0 + +// how many millis to strobe over all the LEDs +#define SCOPE_PERIOD (1000 * NUM_TLCS) +#define LED_PERIOD SCOPE_PERIOD / (NUM_TLCS * 16) + +TLC_CHANNEL_TYPE channel; + +void setup() +{ + Tlc.init(); +} + +void loop() +{ + uint32_t lastMillis = millis(); + tlc_addFade(channel, // led channel + analogRead(ANALOG_PIN) * 4, // start fade value (0-4095) + 0, // end fade value (0-4095) + lastMillis + 2, // start millis + lastMillis + (uint16_t)SCOPE_PERIOD / 4 // end millis + ); + if (channel++ == NUM_TLCS * 16) { + channel = 0; + } + uint32_t currentMillis; + do { + currentMillis = millis(); + tlc_updateFades(currentMillis); + } while (currentMillis - lastMillis <= LED_PERIOD); +} + diff --git a/examples/Fades/Fades.pde b/examples/Fades/Fades.pde new file mode 100644 index 0000000..926bdf6 --- /dev/null +++ b/examples/Fades/Fades.pde @@ -0,0 +1,38 @@ +/* + Fades a line down the channels, with max value and duration based on + the voltage of analog pin 0. + Try grounding analog 0: everything should turn off. + Try putting +5V into analog 0: everything should turn on. + + See the BasicUse example for hardware setup. + + Alex Leone , 2009-02-03 */ + +#include "Tlc5940.h" +#include "tlc_fades.h" + +TLC_CHANNEL_TYPE channel; + +void setup() +{ + Tlc.init(); +} + +void loop() +{ + if (tlc_fadeBufferSize < TLC_FADE_BUFFER_LENGTH - 2) { + if (!tlc_isFading(channel)) { + uint16_t duration = analogRead(0) * 2; + int maxValue = analogRead(0) * 2; + uint32_t startMillis = millis() + 50; + uint32_t endMillis = startMillis + duration; + tlc_addFade(channel, 0, maxValue, startMillis, endMillis); + tlc_addFade(channel, maxValue, 0, endMillis, endMillis + duration); + } + if (channel++ == NUM_TLCS * 16) { + channel = 0; + } + } + tlc_updateFades(); +} + diff --git a/examples/Servos/Servos.pde b/examples/Servos/Servos.pde new file mode 100644 index 0000000..7503c40 --- /dev/null +++ b/examples/Servos/Servos.pde @@ -0,0 +1,40 @@ +/* + This sketch sweeps a servo on channel 0. + + To connect a servo: + 1. Put a 2k-5k pull-up resistor (R0 below; I've tried with 3.3k) between the + servo control output pin and +5v. + 2. Connect that same pin to the servo's control line like so + + servo data pin + | _____ + OUTn ----+----[_____]---+5v + R0 + + Steve Pomeroy , 2009-01-20 */ + +#include "Tlc5940.h" +#include "tlc_servos.h" + +#define SERVO_CHANNEL 0 +#define DELAY_TIME 20 + +void setup() +{ + tlc_initServos(); // Note: this will drop the PWM freqency down to 50Hz. +} + +void loop() +{ + for (int angle = 0; angle < 180; angle++) { + tlc_setServo(SERVO_CHANNEL, angle); + Tlc.update(); + delay(DELAY_TIME); + } + for (int angle = 180; angle >= 0; angle--) { + tlc_setServo(SERVO_CHANNEL, angle); + Tlc.update(); + delay(DELAY_TIME); + } +} + diff --git a/examples/UsingProgmem/UsingProgmem.pde b/examples/UsingProgmem/UsingProgmem.pde new file mode 100644 index 0000000..6a4d7de --- /dev/null +++ b/examples/UsingProgmem/UsingProgmem.pde @@ -0,0 +1,60 @@ +/* + Setting grayscale from progmem to save RAM. If you want to play + multiple "frames", (an animation), see the BasicAnimations Example. + + See the BasicUse example for hardware setup. + + Alex Leone , 2009-02-03 */ + +#include "Tlc5940.h" + +// Extended functions (they start with tlc_...) require another include +#include "tlc_progmem_utils.h" + +/* + This is an array in program memory. Program memory is 16kB instead of + 1024 bytes for regular variables in SRAM. + + The format for this array is + GS_DUO(OUT15, OUT14), ... GS_DUO(OUT1, OUT0) + + If you have more than one TLC, the format is + GS_DUO(TLC2.OUT15, TLC2.OUT14), ... GS_DUO(TLC2.OUT1, TLC2.OUT0), + GS_DUO(TLC1.OUT15, TLC1.OUT14), ... GS_DUO(TLC1.OUT1, TLC1.OUT0) + + The pattern below will only work with 1 TLC. Copy + Paste the 4 lines + inside the curly brackets for each additional TLC. */ +uint8_t gsArray1[NUM_TLCS * 24] PROGMEM = { + GS_DUO((4095 * 16)/16, (4095 * 15)/16), GS_DUO((4095 * 14)/16, (4095 * 13)/16), + GS_DUO((4095 * 12)/16, (4095 * 11)/16), GS_DUO((4095 * 10)/16, (4095 * 9)/16), + GS_DUO((4095 * 8)/16, (4095 * 7)/16), GS_DUO((4095 * 6)/16, (4095 * 5)/16), + GS_DUO((4095 * 4)/16, (4095 * 3)/16), GS_DUO((4095 * 2)/16, (4095 * 1)/16), +}; + +void setup() +{ + Tlc.init(); +} + +void loop() +{ + // Display the pattern (brightness ramp over the outputs) + tlc_setGSfromProgmem(gsArray1); + Tlc.update(); + + // Fade each channel to zero + for (TLC_CHANNEL_TYPE channel = 0; channel < NUM_TLCS * 16; channel++) { + int16_t initialValue = Tlc.get(channel); + while (initialValue > 0) { + initialValue -= 5; + if (initialValue < 0) { + initialValue = 0; + } + Tlc.set(channel, initialValue); + + // wait until the data has been sent to the TLCs before continuing + while (Tlc.update()); + } + } +} + diff --git a/gpl.txt b/gpl.txt new file mode 100644 index 0000000..20d40b6 --- /dev/null +++ b/gpl.txt @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, 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 +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If 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 convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "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 PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM 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 PROGRAM (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 PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. \ No newline at end of file diff --git a/keywords.txt b/keywords.txt new file mode 100644 index 0000000..8a710a1 --- /dev/null +++ b/keywords.txt @@ -0,0 +1,46 @@ +####################################### +# Syntax Coloring Map For TLC5940 +####################################### + +####################################### +# Datatypes (KEYWORD1) +####################################### + +Tlc5940 KEYWORD1 + +####################################### +# Methods and Functions (KEYWORD2) +####################################### + +init KEYWORD2 +clear KEYWORD2 +update KEYWORD2 +set KEYWORD2 +get KEYWORD2 +setAll KEYWORD2 +setAllDC KEYWORD2 +readXERR KEYWORD2 +tlc_setGSfromProgmem KEYWORD2 +tlc_setDCfromProgmem KEYWORD2 +tlc_playAnimation KEYWORD2 +tlc_addFade KEYWORD2 +tlc_removeFade KEYWORD2 +tlc_shiftUp KEYWORD2 +tlc_shiftDown KEYWORD2 + +####################################### +# Instances (KEYWORD2) +####################################### + +Tlc KEYWORD2 + +####################################### +# Constants (LITERAL1) +####################################### + +NUM_TLCS LITERAL1 +tlc_needXLAT LITERAL1 +tlc_GSData LITERAL1 +tlc_onUpdateFinished LITERAL1 +TLC_FADE_BUFFER_LENGTH LITERAL1 +tlc_fadeBufferSize LITERAL1 \ No newline at end of file diff --git a/pinouts/ATmega_8.h b/pinouts/ATmega_8.h new file mode 100644 index 0000000..a09b033 --- /dev/null +++ b/pinouts/ATmega_8.h @@ -0,0 +1,86 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_ATMEGA_8_H +#define TLC_ATMEGA_8_H + +#if DATA_TRANSFER_MODE == TLC_SPI +#warning SPI cannot be used on the ATmega8 because it interferes with timer2 +#warning setting DATA_TRANSFER_MODE to TLC_BITBANG +#define DATA_TRANSFER_MODE TLC_BITBANG +#endif + +/** \file + SPI and timer pins for the ATmega8. Don't edit these. All + changeable pins are defined in tlc_config.h */ + +/** VPRG (Arduino digital pin 8) -> VPRG (TLC pin 27) */ +#define DEFAULT_VPRG_PIN PB0 +#define DEFAULT_VPRG_PORT PORTB +#define DEFAULT_VPRG_DDR DDRB + +/** XERR (Arduino digital pin 12) -> XERR (TLC pin 16) */ +#define DEFAULT_XERR_PIN PB4 +#define DEFAULT_XERR_PORT PORTB +#define DEFAULT_XERR_DDR DDRB +#define DEFAULT_XERR_PINS PINB + +/** SIN (Arduino digital pin 7) -> SIN (TLC pin 26) */ +#define DEFAULT_BB_SIN_PIN PD7 +#define DEFAULT_BB_SIN_PORT PORTD +#define DEFAULT_BB_SIN_DDR DDRD +/** SCLK (Arduino digital pin 4) -> SCLK (TLC pin 25) */ +#define DEFAULT_BB_SCLK_PIN PD4 +#define DEFAULT_BB_SCLK_PORT PORTD +#define DEFAULT_BB_SCLK_DDR DDRD + +/** MOSI (Arduino digital pin 11) -> SIN (TLC pin 26) */ +#define TLC_MOSI_PIN PB3 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +/** SCK (Arduino digital pin 13) -> SCLK (TLC pin 25) */ +#define TLC_SCK_PIN PB5 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +/** SS will be set to output as to not interfere with SPI master operation. + If you have changed the pin-outs and the library doesn't seem to work + or works intermittently, make sure this pin is set correctly. This pin + will not be used by the library other than setting its direction to + output. */ +#define TLC_SS_PIN PB2 +#define TLC_SS_DDR DDRB + +/** OC1A (Arduino digital pin 9) -> XLAT (TLC pin 24) */ +#define XLAT_PIN PB1 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +/** OC1B (Arduino digital pin 10) -> BLANK (TLC pin 23) */ +#define BLANK_PIN PB2 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +/** OC2B (Arduino digital pin 3) -> GSCLK (TLC pin 18) */ +#define GSCLK_PIN PD3 +#define GSCLK_PORT PORTD +#define GSCLK_DDR DDRD + +#endif + diff --git a/pinouts/ATmega_xx4.h b/pinouts/ATmega_xx4.h new file mode 100644 index 0000000..a10e7ea --- /dev/null +++ b/pinouts/ATmega_xx4.h @@ -0,0 +1,80 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_ATMEGA_XX8_H +#define TLC_ATMEGA_XX8_H + +/** \file + SPI and timer pins for the ATmega164/324/644. Don't edit these. All + changeable pins are defined in tlc_config.h */ + +/** VPRG (Sanguino digital pin 15) -> VPRG (TLC pin 27) */ +#define DEFAULT_VPRG_PIN PD7 +#define DEFAULT_VPRG_PORT PORTD +#define DEFAULT_VPRG_DDR DDRD + +/** XERR (Sanguino digital pin 6) -> XERR (TLC pin 16) */ +#define DEFAULT_XERR_PIN PB6 +#define DEFAULT_XERR_PORT PORTB +#define DEFAULT_XERR_DDR DDRB +#define DEFAULT_XERR_PINS PINB + +/** SIN (Sanguino digital pin 5) -> SIN (TLC pin 26) */ +#define DEFAULT_BB_SIN_PIN PB5 +#define DEFAULT_BB_SIN_PORT PORTB +#define DEFAULT_BB_SIN_DDR DDRB +/** SCLK (Sanguino digital pin 7) -> SCLK (TLC pin 25) */ +#define DEFAULT_BB_SCLK_PIN PB7 +#define DEFAULT_BB_SCLK_PORT PORTB +#define DEFAULT_BB_SCLK_DDR DDRB + +/** MOSI (Sanguino digital pin 5) -> SIN (TLC pin 26) */ +#define TLC_MOSI_PIN PB5 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +/** SCK (Sanguino digital pin 7) -> SCLK (TLC pin 25) */ +#define TLC_SCK_PIN PB7 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +/** SS will be set to output as to not interfere with SPI master operation. + If you have changed the pin-outs and the library doesn't seem to work + or works intermittently, make sure this pin is set correctly. This pin + will not be used by the library other than setting its direction to + output. */ +#define TLC_SS_PIN PB4 +#define TLC_SS_DDR DDRB + +/** OC1A (Sanguino digital pin 13) -> XLAT (TLC pin 24) */ +#define XLAT_PIN PD5 +#define XLAT_PORT PORTD +#define XLAT_DDR DDRD + +/** OC1B (Sanguino digital pin 12) -> BLANK (TLC pin 23) */ +#define BLANK_PIN PD4 +#define BLANK_PORT PORTD +#define BLANK_DDR DDRD + +/** OC2B (Sanguino digital pin 14) -> GSCLK (TLC pin 18) */ +#define GSCLK_PIN PD6 +#define GSCLK_PORT PORTD +#define GSCLK_DDR DDRD + +#endif + diff --git a/pinouts/ATmega_xx8.h b/pinouts/ATmega_xx8.h new file mode 100644 index 0000000..e9e9093 --- /dev/null +++ b/pinouts/ATmega_xx8.h @@ -0,0 +1,80 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_ATMEGA_XX8_H +#define TLC_ATMEGA_XX8_H + +/** \file + SPI and timer pins for the ATmega168/48/88. Don't edit these. All + changeable pins are defined in tlc_config.h */ + +/** VPRG (Arduino digital pin 8) -> VPRG (TLC pin 27) */ +#define DEFAULT_VPRG_PIN PB0 +#define DEFAULT_VPRG_PORT PORTB +#define DEFAULT_VPRG_DDR DDRB + +/** XERR (Arduino digital pin 12) -> XERR (TLC pin 16) */ +#define DEFAULT_XERR_PIN PB4 +#define DEFAULT_XERR_PORT PORTB +#define DEFAULT_XERR_DDR DDRB +#define DEFAULT_XERR_PINS PINB + +/** SIN (Arduino digital pin 7) -> SIN (TLC pin 26) */ +#define DEFAULT_BB_SIN_PIN PD7 +#define DEFAULT_BB_SIN_PORT PORTD +#define DEFAULT_BB_SIN_DDR DDRD +/** SCLK (Arduino digital pin 4) -> SCLK (TLC pin 25) */ +#define DEFAULT_BB_SCLK_PIN PD4 +#define DEFAULT_BB_SCLK_PORT PORTD +#define DEFAULT_BB_SCLK_DDR DDRD + +/** MOSI (Arduino digital pin 11) -> SIN (TLC pin 26) */ +#define TLC_MOSI_PIN PB3 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +/** SCK (Arduino digital pin 13) -> SCLK (TLC pin 25) */ +#define TLC_SCK_PIN PB5 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +/** SS will be set to output as to not interfere with SPI master operation. + If you have changed the pin-outs and the library doesn't seem to work + or works intermittently, make sure this pin is set correctly. This pin + will not be used by the library other than setting its direction to + output. */ +#define TLC_SS_PIN PB2 +#define TLC_SS_DDR DDRB + +/** OC1A (Arduino digital pin 9) -> XLAT (TLC pin 24) */ +#define XLAT_PIN PB1 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +/** OC1B (Arduino digital pin 10) -> BLANK (TLC pin 23) */ +#define BLANK_PIN PB2 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +/** OC2B (Arduino digital pin 3) -> GSCLK (TLC pin 18) */ +#define GSCLK_PIN PD3 +#define GSCLK_PORT PORTD +#define GSCLK_DDR DDRD + +#endif + diff --git a/pinouts/Arduino_Mega.h b/pinouts/Arduino_Mega.h new file mode 100644 index 0000000..6bf735a --- /dev/null +++ b/pinouts/Arduino_Mega.h @@ -0,0 +1,81 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef ARDUINO_MEGA_H +#define ARDUINO_MEGA_H + +/** \file + SPI and timer pins for the Arduino Mega. Don't edit these. All + changeable pins are defined in tlc_config.h */ + +/** VPRG (Mega pin 50) -> VPRG (TLC pin 27) */ +#define DEFAULT_VPRG_PIN PB3 +#define DEFAULT_VPRG_PORT PORTB +#define DEFAULT_VPRG_DDR DDRB + +/** XERR (Mega pin 10) -> XERR (TLC pin 16) */ +#define DEFAULT_XERR_PIN PB4 +#define DEFAULT_XERR_PORT PORTB +#define DEFAULT_XERR_DDR DDRB +#define DEFAULT_XERR_PINS PINB + +/** SIN (Mega pin 51) -> SIN (TLC pin 26) */ +#define DEFAULT_BB_SIN_PIN PB2 +#define DEFAULT_BB_SIN_PORT PORTB +#define DEFAULT_BB_SIN_DDR DDRB +/** SCLK (Mega pin 52) -> SCLK (TLC pin 25) */ +#define DEFAULT_BB_SCLK_PIN PB1 +#define DEFAULT_BB_SCLK_PORT PORTB +#define DEFAULT_BB_SCLK_DDR DDRB + +/** MOSI (Mega pin 51) -> SIN (TLC pin 26) */ +#define TLC_MOSI_PIN PB2 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +/** SCK (Mega pin 52) -> SCLK (TLC pin 25) */ +#define TLC_SCK_PIN PB1 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +// SS (Mega pin 53) +/** SS will be set to output as to not interfere with SPI master operation. + If you have changed the pin-outs and the library doesn't seem to work + or works intermittently, make sure this pin is set correctly. This pin + will not be used by the library other than setting its direction to + output. */ +#define TLC_SS_PIN PB0 +#define TLC_SS_DDR DDRB + +/** OC1A (Mega pin 11) -> XLAT (TLC pin 24) */ +#define XLAT_PIN PB5 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +/** OC1B (Mega pin 12) -> BLANK (TLC pin 23) */ +#define BLANK_PIN PB6 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +/** OC2B (Mega pin 9) -> GSCLK (TLC pin 18) */ +#define GSCLK_PIN PH6 +#define GSCLK_PORT PORTH +#define GSCLK_DDR DDRH + +#endif + diff --git a/pinouts/Teensy_xxU4.h b/pinouts/Teensy_xxU4.h new file mode 100644 index 0000000..5b38736 --- /dev/null +++ b/pinouts/Teensy_xxU4.h @@ -0,0 +1,39 @@ +#ifndef TLC_Teensy_xxU4_h +#define TLC_Teensy_xxU4_h + +#if DATA_TRANSFER_MODE == TLC_BITBANG +#error "If you want bitbang mode, insert pin defs here" +#endif + +// MOSI (Teensy pin 2) -> SIN (TLC pin 26) +#define TLC_MOSI_PIN 2 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +// SCK (Teensy pin 1) -> SCLK (TLC pin 25) +#define TLC_SCK_PIN 1 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +// SS (Teensy pin 0) +#define TLC_SS_PIN 0 +#define TLC_SS_DDR DDRB + +// OC1A (Teensy pin 14) -> XLAT (TLC pin 24) +#define XLAT_PIN 5 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +// OC1B (Teensy pin 15) -> BLANK (TLC pin 23) +#define BLANK_PIN 6 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +// OC3A (Teensy pin 9) -> GSCLK (TLC pin 18) +#define GSCLK_PIN 6 +#define GSCLK_PORT PORTC +#define GSCLK_DDR DDRC +#define TLC_TIMER3_GSCLK 1 + +#endif + diff --git a/pinouts/Teensypp_xxx6.h b/pinouts/Teensypp_xxx6.h new file mode 100644 index 0000000..a6eb57a --- /dev/null +++ b/pinouts/Teensypp_xxx6.h @@ -0,0 +1,38 @@ +#ifndef TLC_Teensypp_xxx6_H +#define TLC_Teensypp_xxx6_H + +#if DATA_TRANSFER_MODE == TLC_BITBANG +#error "If you want bitbang mode, insert pin defs here" +#endif + +// MOSI (Teensy++ pin 22) -> SIN (TLC pin 26) +#define TLC_MOSI_PIN 2 +#define TLC_MOSI_PORT PORTB +#define TLC_MOSI_DDR DDRB + +// SCK (Teensy++ pin 21) -> SCLK (TLC pin 25) +#define TLC_SCK_PIN 1 +#define TLC_SCK_PORT PORTB +#define TLC_SCK_DDR DDRB + +// SS (Teensy++ pin 20) +#define TLC_SS_PIN 0 +#define TLC_SS_DDR DDRB + +// OC1A (Teensy++ pin 25) -> XLAT (TLC pin 24) +#define XLAT_PIN 5 +#define XLAT_PORT PORTB +#define XLAT_DDR DDRB + +// OC1B (Teensy++ pin 26) -> BLANK (TLC pin 23) +#define BLANK_PIN 6 +#define BLANK_PORT PORTB +#define BLANK_DDR DDRB + +// OC2B (Teensy++ pin 1) -> GSCLK (TLC pin 18) +#define GSCLK_PIN 1 +#define GSCLK_PORT PORTD +#define GSCLK_DDR DDRD + +#endif + diff --git a/pinouts/chip_includes.h b/pinouts/chip_includes.h new file mode 100644 index 0000000..7dc1a6f --- /dev/null +++ b/pinouts/chip_includes.h @@ -0,0 +1,118 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_CHIP_INCLUDES_H +#define TLC_CHIP_INCLUDES_H + +/** \file + Includes the chip-specfic defaults and pin definitions. */ + +#include + +#ifndef PB0 +#define PB0 PORTB0 +#define PB1 PORTB1 +#define PB2 PORTB2 +#define PB3 PORTB3 +#define PB4 PORTB4 +#define PB5 PORTB5 +#define PB6 PORTB6 +#define PB7 PORTB7 +#endif +#ifndef PC0 +#define PC0 PORTC0 +#define PC1 PORTC1 +#define PC2 PORTC2 +#define PC3 PORTC3 +#define PC4 PORTC4 +#define PC5 PORTC5 +#define PC6 PORTC6 +#define PC7 PORTC7 +#endif +#ifndef PD0 +#define PD0 PORTD0 +#define PD1 PORTD1 +#define PD2 PORTD2 +#define PD3 PORTD3 +#define PD4 PORTD4 +#define PD5 PORTD5 +#define PD6 PORTD6 +#define PD7 PORTD7 +#endif +#ifndef PH0 +#define PH0 PORTH0 +#define PH1 PORTH1 +#define PH2 PORTH2 +#define PH3 PORTH3 +#define PH4 PORTH4 +#define PH5 PORTH5 +#define PH6 PORTH6 +#define PH7 PORTH7 +#endif + +/* Chip Specific Pinouts */ +#if defined (__AVR_ATmega168__) \ + || defined (__AVR_ATmega168P__) \ + || defined (__AVR_ATmega88P__) \ + || defined (__AVR_ATmega88__) \ + || defined (__AVR_ATmega48P__) \ + || defined (__AVR_ATmega48__) \ + || defined (__AVR_ATmega328P__) + +/* Diecimila / Duemilanove / almost everything */ +#include "ATmega_xx8.h" + +#elif defined (__AVR_ATmega8__) + +/* ATmega8 */ +#include "ATmega_8.h" + +#elif defined (__AVR_ATmega164P__) \ + || defined (__AVR_ATmega324P__) \ + || defined (__AVR_ATmega644__) \ + || defined (__AVR_ATmega644P__) + +/* Sanguino */ +#include "ATmega_xx4.h" + +#elif defined (__AVR_ATmega640__) \ + || defined (__AVR_ATmega1280__) \ + || defined (__AVR_ATmega1281__) \ + || defined (__AVR_ATmega2560__) \ + || defined (__AVR_ATmega2561__) + +/* Arduino Mega */ +#include "Arduino_Mega.h" + +#elif defined (__AVR_ATmega32U4__) + +/* Teensy 2.0 */ +#include "Teensy_xxU4.h" + +#elif defined (__AVR_AT90USB646__) \ + || defined (__AVR_AT90USB1286__) + +/* Teensy++ 2.0 */ +#include "Teensypp_xxx6.h" + +#else +#error "Unknown Chip!" +#endif + +#endif + diff --git a/tlc_animations.h b/tlc_animations.h new file mode 100644 index 0000000..0882db9 --- /dev/null +++ b/tlc_animations.h @@ -0,0 +1,88 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_ANIMATIONS_H +#define TLC_ANIMATIONS_H + +/** \file + TLC Animation functions. These play animations from PROGMEM. */ + +#include +#include + +#include "tlc_config.h" +#include "Tlc5940.h" +#include "tlc_progmem_utils.h" + +/** The currently playing animation */ +prog_uint8_t *tlc_currentAnimation; +/** The number of frames in the current animation */ +volatile uint16_t tlc_animationFrames; +/** The number of PWM periods to display each frame - 1 */ +volatile uint16_t tlc_animationPeriodsPerFrame; +/** The current number of periods we've displayed this frame for */ +volatile uint16_t tlc_animationPeriodsWait; + +volatile void tlc_animationXLATCallback(void); +void tlc_playAnimation(prog_uint8_t *animation, uint16_t frames, uint16_t periodsPerFrame); + +/** \addtogroup ExtendedFunctions + \code #include "tlc_animations.h" \endcode + - void tlc_playAnimation(prog_uint8_t *animation, uint16_t frames, + uint16_t periodsPerFrame) - plays an animation from progmem. */ +/* @{ */ + +/** Plays an animation from progmem in the "background" (with interrupts). + \param animation A progmem array of grayscale data, length NUM_TLCS * + 24 * frames, in reverse order. Ensure that there is not an update + waiting to happen before calling this. + \param frames the number of frames in animation + \param periodsPerFrame number of PWM periods to wait between each frame + (0 means play the animation as fast as possible). + The default PWM period for a 16MHz clock is 1.024ms. */ +void tlc_playAnimation(prog_uint8_t *animation, uint16_t frames, uint16_t periodsPerFrame) +{ + tlc_currentAnimation = animation; + tlc_animationFrames = frames; + tlc_animationPeriodsPerFrame = periodsPerFrame; + tlc_animationPeriodsWait = 0; + tlc_onUpdateFinished = tlc_animationXLATCallback; + tlc_animationXLATCallback(); +} + +/** This is called by the XLAT interrupt every PWM period to do stuff. */ +volatile void tlc_animationXLATCallback(void) +{ + if (tlc_animationPeriodsWait) { + tlc_animationPeriodsWait--; + set_XLAT_interrupt(); + } else { + if (tlc_animationFrames) { + tlc_setGSfromProgmem(tlc_currentAnimation + + (--tlc_animationFrames * NUM_TLCS * 24)); + tlc_animationPeriodsWait = tlc_animationPeriodsPerFrame; + Tlc.update(); + } else { // animation is done + tlc_onUpdateFinished = 0; + } + } +} + +/* @} */ + +#endif diff --git a/tlc_config.h b/tlc_config.h new file mode 100644 index 0000000..9a81d1e --- /dev/null +++ b/tlc_config.h @@ -0,0 +1,173 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_CONFIG_H +#define TLC_CONFIG_H + +#include + +/** \file + Configuration for the Arduino Tlc5940 library. After making changes to + this file, delete Tlc5940.o in this folder so the changes are applied. + + A summary of all the options: + - Number of TLCs daisy-chained: NUM_TLCS (default 1) + - Enable/Disable VPRG functionality: VPRG_ENABLED (default 0) + - Enable/Disable XERR functionality: XERR_ENABLED (default 0) + - Should the library use bit-banging (any pins) or hardware SPI (faster): + DATA_TRANSFER_MODE (default TLC_SPI) + - Which pins to use for bit-banging: SIN_PIN, SIN_PORT, SIN_DDR and + SCLK_PIN, SCLK_PORT, SCLK_DDR + - The PWM period: TLC_PWM_PERIOD (be sure to change TLC_GSCLK_PERIOD + accordingly!) + + How to change the pin mapping: + - Arduino digital pin 0-7 = PORTD, PD0-7 + - Arduino digital pin 8-13 = PORTB, PB0-5 + - Arduino analog pin 0-5 = PORTC, PC0-5 */ + +/** Bit-bang using any two i/o pins */ +#define TLC_BITBANG 1 +/** Use the much faster hardware SPI module */ +#define TLC_SPI 2 + +/* ------------------------ START EDITING HERE ----------------------------- */ + +/** Number of TLCs daisy-chained. To daisy-chain, attach the SOUT (TLC pin 17) + of the first TLC to the SIN (TLC pin 26) of the next. The rest of the pins + are attached normally. + \note Each TLC needs it's own IREF resistor */ +#define NUM_TLCS 1 + +/** Determines how data should be transfered to the TLCs. Bit-banging can use + any two i/o pins, but the hardware SPI is faster. + - Bit-Bang = TLC_BITBANG + - Hardware SPI = TLC_SPI (default) */ +#define DATA_TRANSFER_MODE TLC_SPI + +/* This include is down here because the files it includes needs the data + transfer mode */ +#include "pinouts/chip_includes.h" + +/* Set DATA_TRANSFER_MODE to TLC_BITBANG and change the pins below if you need + to use different pins for sin and sclk. The defaults are defined in + pinouts/ATmega_xx8.h for most Arduino's. */ + +#if DATA_TRANSFER_MODE == TLC_BITBANG +/** SIN (TLC pin 26) */ +#define SIN_PIN DEFAULT_BB_SIN_PIN +#define SIN_PORT DEFAULT_BB_SIN_PORT +#define SIN_DDR DEFAULT_BB_SIN_DDR +/** SCLK (TLC pin 25) */ +#define SCLK_PIN DEFAULT_BB_SCLK_PIN +#define SCLK_PORT DEFAULT_BB_SCLK_PORT +#define SCLK_DDR DEFAULT_BB_SCLK_DDR +#endif + + +/** If more than 16 TLCs are daisy-chained, the channel type has to be uint16_t. + Default is uint8_t, which supports up to 16 TLCs. */ +#define TLC_CHANNEL_TYPE uint8_t + +/** Determines how long each PWM period should be, in clocks. + \f$\displaystyle f_{PWM} = \frac{f_{osc}}{2 * TLC\_PWM\_PERIOD} Hz \f$ + \f$\displaystyle TLC\_PWM\_PERIOD = \frac{f_{osc}}{2 * f_{PWM}} \f$ + This is related to TLC_GSCLK_PERIOD: + \f$\displaystyle TLC\_PWM\_PERIOD = + \frac{(TLC\_GSCLK\_PERIOD + 1) * 4096}{2} \f$ + \note The default of 8192 means the PWM frequency is 976.5625Hz */ +#define TLC_PWM_PERIOD 8192 + +/** Determines how long each period GSCLK is. + This is related to TLC_PWM_PERIOD: + \f$\displaystyle TLC\_GSCLK\_PERIOD = + \frac{2 * TLC\_PWM\_PERIOD}{4096} - 1 \f$ + \note Default is 3 */ +#define TLC_GSCLK_PERIOD 3 + +/** Enables/disables VPRG (TLC pin 27) functionality. If you need to set dot + correction data, this needs to be enabled. + - 0 VPRG is not connected. TLC pin 27 must be grounded! (default) + - 1 VPRG is connected + \note VPRG to GND inputs grayscale data, VPRG to Vcc inputs dot-correction + data */ +#define VPRG_ENABLED 0 + +/** Enables/disables XERR (TLC pin 16) functionality to check for shorted/broken + LEDs + - 0 XERR is not connected (default) + - 1 XERR is connected + \note XERR is active low */ +#define XERR_ENABLED 0 + +/* You can change the VPRG and XERR pins freely. The defaults are defined in + the chip-specific pinouts: see pinouts/ATmega_xx8.h for most Arduino's. */ + +#if VPRG_ENABLED +/** VPRG (TLC pin 27) */ +#define VPRG_PIN DEFAULT_VPRG_PIN +#define VPRG_PORT DEFAULT_VPRG_PORT +#define VPRG_DDR DEFAULT_VPRG_DDR +#endif + +#if XERR_ENABLED +/** XERR (TLC pin 16) */ +#define XERR_PIN DEFAULT_XERR_PIN +#define XERR_PORT DEFAULT_XERR_PORT +#define XERR_DDR DEFAULT_XERR_DDR +#define XERR_PINS DEFAULT_XERR_PINS +#endif + +/* ------------------------- STOP EDITING HERE ----------------------------- */ + +#if DATA_TRANSFER_MODE == TLC_SPI +/** SIN (TLC pin 26) */ +#define SIN_PIN TLC_MOSI_PIN +#define SIN_PORT TLC_MOSI_PORT +#define SIN_DDR TLC_MOSI_DDR +/** SCLK (TLC pin 25) */ +#define SCLK_PIN TLC_SCK_PIN +#define SCLK_PORT TLC_SCK_PORT +#define SCLK_DDR TLC_SCK_DDR +#endif + + + +#if !(DATA_TRANSFER_MODE == TLC_BITBANG \ + || DATA_TRANSFER_MODE == TLC_SPI) +#error "Invalid DATA_TRANSFER_MODE specified, see DATA_TRANSFER_MODE" +#endif + +/* Various Macros */ + +/** Arranges 2 grayscale values (0 - 4095) in the packed array format (3 bytes). + This is for array initializers only: the output is three comma seperated + 8-bit values. */ +#define GS_DUO(a, b) ((a) >> 4), ((a) << 4) | ((b) >> 8), (b) + + +#if VPRG_ENABLED +/** Arranges 4 dot correction values (0 - 63) in the packed array format. + \see setDCtoProgmemArray */ +#define DC_QUARTET(a, b, c, d) ((a) << 2) | ((b) >> 4), \ + ((b) << 4) | ((c) >> 2), \ + ((c) << 6) | (d) +#endif + +#endif + diff --git a/tlc_fades.h b/tlc_fades.h new file mode 100644 index 0000000..cb466a6 --- /dev/null +++ b/tlc_fades.h @@ -0,0 +1,211 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_FADES_H +#define TLC_FADES_H + +/** \file + TLC fading functions. */ + +#include + +#include "Tlc5940.h" + +#if defined(ARDUINO) && ARDUINO >= 100 +#include "Arduino.h" +#else +#include "WProgram.h" +#endif + +#ifndef TLC_FADE_BUFFER_LENGTH +/** The default fade buffer length (24). Uses 24*13 = 312 bytes of ram. */ +#define TLC_FADE_BUFFER_LENGTH 24 +#endif + +/** Data for a single fade */ +struct Tlc_Fade { + TLC_CHANNEL_TYPE channel; /**< channel this fade is on */ + int16_t startValue; /**< value when the fade starts (0 - 4095) */ + int16_t changeValue; /**< start + changeValue = endValue (0 - 4095) */ + uint32_t startMillis; /**< millis() when to start */ + uint32_t endMillis; /**< millis() when to end */ +} tlc_fadeBuffer[TLC_FADE_BUFFER_LENGTH]; + +/** The current fade buffer size */ +uint8_t tlc_fadeBufferSize; + +uint8_t tlc_updateFades(); +uint8_t tlc_updateFades(uint32_t currentMillis); +uint8_t tlc_addFade(struct Tlc_Fade *fade); +uint8_t tlc_addFade(TLC_CHANNEL_TYPE channel, int16_t startValue, + int16_t endValue, uint32_t startMillis, uint32_t endMillis); +uint8_t tlc_isFading(TLC_CHANNEL_TYPE channel); +uint8_t tlc_removeFades(TLC_CHANNEL_TYPE channel); +static void tlc_removeFadeFromBuffer(struct Tlc_Fade *current, + struct Tlc_Fade *end); + +/** \addtogroup ExtendedFunctions + \code #include "tlc_fades.h" \endcode + - uint8_t tlc_updateFades() - updates all fades + - uint8_t tlc_updateFades(uint32_t currentMillis) - updates fades using + currentMillis as the current time + - uint8_t tlc_addFade(struct Tlc_Fade *fade) - copies fade into the + fade buffer + - uint8_t tlc_addFade(TLC_CHANNEL_TYPE channel, int16_t startValue, + int16_t endValue, uint32_t startMillis, uint32_t endMillis) - adds + a fade to the fade buffer + - uint8_t tlc_isFading(TLC_CHANNEL_TYPE channel) - returns 1 if there's + a fade on this channel in the buffer + - uint8_t tlc_removeFades(TLC_CHANNEL_TYPE channel) - removes all fades + on channel */ +/* @{ */ + +/** Adds a fade to the buffer. + \param fade the fade to be copied into the buffer + \returns 0 if the fade buffer is full, fadeBufferSize if added successfully +*/ +uint8_t tlc_addFade(struct Tlc_Fade *fade) +{ + if (tlc_fadeBufferSize == TLC_FADE_BUFFER_LENGTH) { + return 0; // fade buffer full + } + struct Tlc_Fade *p = tlc_fadeBuffer + tlc_fadeBufferSize++; + p->channel = fade->channel; + p->startValue = fade->startValue; + p->changeValue = fade->changeValue; + p->startMillis = fade->startMillis; + p->endMillis = fade->endMillis; + return tlc_fadeBufferSize; +} + +/** Adds a fade to the fade buffer. + \param channel the ouput channel this fade is on + \param startValue the value at the start of the fade + \param endValue the value at the end of the fade + \param startMillis the millis() when to start the fade + \param endMillis the millis() when to end the fade + \returns 0 if the fade buffer is full, fadeBufferSize if added successfully +*/ +uint8_t tlc_addFade(TLC_CHANNEL_TYPE channel, int16_t startValue, + int16_t endValue, uint32_t startMillis, uint32_t endMillis) +{ + if (tlc_fadeBufferSize == TLC_FADE_BUFFER_LENGTH) { + return 0; // fade buffer full + } + struct Tlc_Fade *p = tlc_fadeBuffer + tlc_fadeBufferSize++; + p->channel = channel; + p->startValue = startValue; + p->changeValue = endValue - startValue; + p->startMillis = startMillis; + p->endMillis = endMillis; + return tlc_fadeBufferSize; +} + +/** Checks to see if any fades are happening on channel + \param channel the channel to check + \returns 1 if there is a fade in the buffer on this channel, 0 otherwise */ +uint8_t tlc_isFading(TLC_CHANNEL_TYPE channel) +{ + struct Tlc_Fade *end = tlc_fadeBuffer + tlc_fadeBufferSize; + for (struct Tlc_Fade *p = tlc_fadeBuffer; p < end; p++) { + if (p->channel == channel) { + return 1; + } + } + return 0; +} + +/** Removes any fades from the fade buffer on this channel. + \param channel which channel the fades are on + \returns how many fades were removed */ +uint8_t tlc_removeFades(TLC_CHANNEL_TYPE channel) +{ + uint8_t removed = 0; + struct Tlc_Fade *end = tlc_fadeBuffer + tlc_fadeBufferSize; + for (struct Tlc_Fade *p = tlc_fadeBuffer; p < end; p++) { + if (p->channel == channel) { + removed++; + tlc_removeFadeFromBuffer(p, --end); + } + } + return removed; +} + +/** Copies the end of the buffer to the current and decrements + tlc_fadeBufferSize. This will change the end of the buffer (pass by + reference) + \param current the fade to be removed + \param endp the end of the fade buffer (pointer to pointer) */ +static void tlc_removeFadeFromBuffer(struct Tlc_Fade *current, + struct Tlc_Fade *endp) +{ + if (endp != current) { // if this is not the last fade + current->channel = endp->channel; + current->startValue = endp->startValue; + current->changeValue = endp->changeValue; + current->startMillis = endp->startMillis; + current->endMillis = endp->endMillis; + } + tlc_fadeBufferSize--; +} + +/** Updates fades using millis() + \returns 0 if there are no fades left in the buffer. */ +uint8_t tlc_updateFades() +{ + return tlc_updateFades(millis()); +} + +/** Updates any running fades. + \param currentMillis the current millis() time. + \returns 0 if there are no fades left in the buffer. */ +uint8_t tlc_updateFades(uint32_t currentMillis) +{ + struct Tlc_Fade *end = tlc_fadeBuffer + tlc_fadeBufferSize; + uint8_t needsUpdate = 0; + for (struct Tlc_Fade *p = tlc_fadeBuffer; p < end;){ + if (currentMillis >= p->endMillis) { // fade done + Tlc.set(p->channel, p->startValue + p->changeValue); + needsUpdate = 1; + tlc_removeFadeFromBuffer(p, --end); + continue; + } else { + uint32_t startMillis = p->startMillis; + if (currentMillis >= startMillis) { + Tlc.set(p->channel, p->startValue + p->changeValue + * (int32_t)(currentMillis - startMillis) + / (int32_t)(p->endMillis - startMillis)); + needsUpdate = 1; + } + } + p++; + } + if (needsUpdate) { + Tlc.update(); + if (tlc_fadeBufferSize == 0) { + while (tlc_needXLAT) + ; + } + } + return tlc_fadeBufferSize; +} + +/* @} */ + +#endif + diff --git a/tlc_progmem_utils.h b/tlc_progmem_utils.h new file mode 100644 index 0000000..dd648fb --- /dev/null +++ b/tlc_progmem_utils.h @@ -0,0 +1,131 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_PROGMEM_UTILS_H +#define TLC_PROGMEM_UTILS_H + +/** \file + PROGMEM utility functions for setting grayscale or dot correction data + from PROGMEM. See the UsingProgmem Example for an example. */ + +#include +#include + +#include "tlc_config.h" +#include "Tlc5940.h" + +void tlc_setGSfromProgmem(prog_uint8_t *gsArray); +#if VPRG_ENABLED +void tlc_setDCfromProgmem(prog_uint8_t *dcArray); +#endif + +/** \addtogroup ExtendedFunctions + \code #include "tlc_progmem_utils.h" \endcode + - void tlc_setGSfromProgmem(prog_uint8_t *gsArray) - copies the progmem + grayscale to current grayscale array. Requires a + \link Tlc5940::update Tlc.update() \endlink. + - void tlc_setDCfromProgmem(prog_uint8_t *dcArray) - shifts the data from a + progmem dot correction array (doesn't need an update). */ +/* @{ */ + +/** Sets the grayscale data from an array in progmem. This doesn't shift out + any data: call Tlc.update(). An example: + \code +#include "tlc_progmem_utils.h" +prog_uint8_t gsArray1[NUM_TLCS * 24] = { + GS_DUO((4095 * 16)/16, (4095 * 15)/16), GS_DUO((4095 * 14)/16, (4095 * 13)/16), + GS_DUO((4095 * 12)/16, (4095 * 11)/16), GS_DUO((4095 * 10)/16, (4095 * 9)/16), + GS_DUO((4095 * 8)/16, (4095 * 7)/16), GS_DUO((4095 * 6)/16, (4095 * 5)/16), + GS_DUO((4095 * 4)/16, (4095 * 3)/16), GS_DUO((4095 * 2)/16, (4095 * 1)/16), +}; + +// sometime after Tlc.init() +tlc_setGSfromProgmem(gsArray1); +Tlc.update(); + \endcode + This would set a ramp of values from OUT0 to OUT15. (Although the + NUM_TLCS * 24 looks like an error, each #GS_DUO is 3 bytes). The array + would have to be expanded if #NUM_TLCS != 1. + + The format of the grayscale array is explained in #tlc_GSData. + + \param gsArray A progmem array of grayscale data. */ +void tlc_setGSfromProgmem(prog_uint8_t *gsArray) +{ + prog_uint8_t *gsArrayp = gsArray; + uint8_t *gsDatap = tlc_GSData; + while (gsDatap < tlc_GSData + NUM_TLCS * 24) { + *gsDatap++ = pgm_read_byte(gsArrayp++); + *gsDatap++ = pgm_read_byte(gsArrayp++); + *gsDatap++ = pgm_read_byte(gsArrayp++); + } +} + + +#if VPRG_ENABLED + +/** \addtogroup ReqVPRG_ENABLED + From tlc_progmem_utils.h: + - tlc_setDCfromProgmem(prog_uint8_t *dcArray) - shifts the data from a + progmem dot correction array (doesn't need an update). */ +/* @{ */ + +/** Sets the dot correction data from an array in progmem. An example: + \code +#include "tlc_progmem_utils.h" +prog_uint8_t dcArray1[NUM_TLCS * 12] = { + DC_QUARTET(32, 63, 32, 63), DC_QUARTET(32, 63, 32, 63), + DC_QUARTET(32, 63, 32, 63), DC_QUARTET(32, 63, 32, 63), +}; + +// sometime after Tlc.init() +tlc_setDCfromProgmem(dcArray1); + \endcode + This would set every other channel to have a dot correction value of 32. + (Although the NUM_TLCS * 12 looks like an error, each #DC_QUARTET is 3 + bytes). The array would have to be expanded if #NUM_TLCS != 1. + + The Format of the array is similar to #tlc_GSData, the last channel of + the last TLC is the first value in the array. In the example above, + the first 32 is setting OUT15, and the last 63 is setting OUT0. + + \param dcArray A progmem array of dot correction data to be shifted out. + \see \link Tlc5940::setAllDC Tlc.setAllDC \endlink */ +void tlc_setDCfromProgmem(prog_uint8_t *dcArray) +{ + tlc_dcModeStart(); + + prog_uint8_t *p = dcArray; + prog_uint8_t *dcArrayEnd = dcArray + NUM_TLCS * 12; + while (p < dcArrayEnd) { + tlc_shift8(pgm_read_byte(p++)); + } + XLAT_PORT |= _BV(XLAT_PIN); + XLAT_PORT &= ~_BV(XLAT_PIN); + + tlc_dcModeStop(); +} + +/* @} */ + +#endif + +/* @} */ + +#endif + diff --git a/tlc_servos.h b/tlc_servos.h new file mode 100644 index 0000000..ca00226 --- /dev/null +++ b/tlc_servos.h @@ -0,0 +1,131 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_SERVOS_H +#define TLC_SERVOS_H + +/** \file + TLC servo functions. */ + +#include +#include "Tlc5940.h" + +#ifndef SERVO_MAX_ANGLE +/** The maximum angle of the servo. */ +#define SERVO_MAX_ANGLE 180 +#endif +#ifndef SERVO_MIN_WIDTH +/** The 1ms pulse width for zero degrees (0 - 4095). */ +#define SERVO_MIN_WIDTH 204 +#endif +#ifndef SERVO_MAX_WIDTH +/** The 2ms pulse width for 180 degrees (0 - 4095). */ +#define SERVO_MAX_WIDTH 410 +#endif +#ifndef SERVO_TIMER1_TOP +/** The top value for XLAT and BLANK pulses. This is with the div8 prescale, + so + \f$\displaystyle f_{PWM} = \frac{f_{osc}}{2 * 8 * SERVO\_TIMER1\_TOP} \f$ + The default is 20000, which corresponds to 50Hz. */ +#define SERVO_TIMER1_TOP 20000 +#endif +#ifndef SERVO_TIMER2_TOP +/** The top value for GSCLK pulses. Related to SERVO_TIMER1_TOP by + \f$\displaystyle SERVO\_TIMER2\_TOP = + \frac{2 * 8 * SERVO\_TIMER1\_TOP}{4096} - 1 \f$ + The default is 77. */ +#define SERVO_TIMER2_TOP 77 +#endif + +void tlc_initServos(uint8_t initAngle = 0); +void tlc_setServo(TLC_CHANNEL_TYPE channel, uint8_t angle); +uint8_t tlc_getServo(TLC_CHANNEL_TYPE channel); +uint16_t tlc_angleToVal(uint8_t angle); +uint8_t tlc_valToAngle(uint16_t value); + +/** \addtogroup ExtendedFunctions + \code #include "tlc_servos.h" \endcode + - void tlc_initServos(uint8_t initAngle = 0) - initializes the tlc for + servos. + - void tlc_setServo(TLC_CHANNEL_TYPE channel, uint8_t angle) - sets a + servo to an angle + - uint8_t tlc_getServo(TLC_CHANNEL_TYPE channel) - gets the currently set + servo angle */ +/* @{ */ + +/** Initializes the tlc. + \param initAngle the initial angle to set all servos to + (0 - SERVO_MAX_ANGLE). */ +void tlc_initServos(uint8_t initAngle) +{ + Tlc.init(tlc_angleToVal(initAngle)); + TCCR1B &= ~(_BV(CS12) | _BV(CS11) | _BV(CS10)); // stop timer1 + ICR1 = SERVO_TIMER1_TOP; + TCNT1 = 0; +#ifdef TLC_ATMEGA_8_H + uint8_t oldTCCR2 = TCCR2; + TCCR2 = 0; + TCNT2 = 0; + OCR2 = SERVO_TIMER2_TOP / 2; + TCCR2 = oldTCCR2; +#else + uint8_t oldTCCR2B = TCCR2B; + TCCR2B = 0; + TCNT2 = 0; + OCR2A = SERVO_TIMER2_TOP; + TCCR2B = oldTCCR2B; +#endif + TCCR1B |= _BV(CS11); // start timer1 with div 8 prescale +} + +/** Sets a servo on channel to angle. + \param channel which channel to set + \param angle (0 - SERVO_MAX_ANGLE) */ +void tlc_setServo(TLC_CHANNEL_TYPE channel, uint8_t angle) +{ + Tlc.set(channel, tlc_angleToVal(angle)); +} + +/** Gets the current angle that channel is set to. + \param channel which channel to get */ +uint8_t tlc_getServo(TLC_CHANNEL_TYPE channel) +{ + return tlc_valToAngle(Tlc.get(channel)); +} + +/** Converts and angle (0 - SERVO_MAX_ANGLE) to the inverted tlc channel value + (4095 - 0). */ +uint16_t tlc_angleToVal(uint8_t angle) +{ + return 4095 - SERVO_MIN_WIDTH - ( + ((uint16_t)(angle) * (uint16_t)(SERVO_MAX_WIDTH - SERVO_MIN_WIDTH)) + / SERVO_MAX_ANGLE); +} + +/** Converts an inverted tlc channel value (4095 - 0) into an angle (0 - + SERVO_MAX_ANGLE). */ +uint8_t tlc_valToAngle(uint16_t value) +{ + return SERVO_MAX_ANGLE * (4095 - SERVO_MIN_WIDTH - value) + / (SERVO_MAX_WIDTH - SERVO_MIN_WIDTH); +} + +/* @} */ + +#endif + diff --git a/tlc_shifts.h b/tlc_shifts.h new file mode 100644 index 0000000..08b2c21 --- /dev/null +++ b/tlc_shifts.h @@ -0,0 +1,81 @@ +/* Copyright (c) 2009 by Alex Leone + + This file is part of the Arduino TLC5940 Library. + + The Arduino TLC5940 Library is free software: you can redistribute it + and/or modify it under the terms of the GNU General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + The Arduino TLC5940 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with The Arduino TLC5940 Library. If not, see + . */ + +#ifndef TLC_SHIFTS_H +#define TLC_SHIFTS_H + +/** \file + TLC channel shifting functions. */ + +#include "Tlc5940.h" + +uint16_t tlc_shiftUp(uint16_t zeroValue = 0); +uint16_t tlc_shiftDown(uint16_t topValue = 0); + +/** \addtogroup ExtendedFunctions + \code #include "tlc_shifts.h" \endcode + - uint16_t tlc_shiftUp(uint16_t zeroValue = 0) - shifts all channel data + up (OUT0 becomes OUT1 ...) and returns OUT15 + - uint16_t tlc_shiftDown(uint16_t topValue = 0) - shifts all channel data + down (OUT15 becomes OUT14 ...) and returns OUT0 */ +/* @{ */ + +/** Shifts all the channel data up (OUT0 becomes OUT1 ...). Needs a + Tlc.update() after. + \param zeroValue the value of channel 0. + \returns the value that was shifted off the end (OUT15) */ +uint16_t tlc_shiftUp(uint16_t zeroValue) +{ + uint16_t topValue = ((uint16_t)(*tlc_GSData) << 4) + | (*(tlc_GSData + 1) >> 4); + uint8_t *p = tlc_GSData + 1; + while (p < tlc_GSData + NUM_TLCS * 24 - 1) { + *(p - 1) = (*p << 4) | (*(p + 1) >> 4); + *p = (*(p + 1) << 4) | (*(p + 2) >> 4); + p += 2; + } + *(tlc_GSData + NUM_TLCS * 24 - 2) = (*(tlc_GSData + NUM_TLCS * 24 - 1) << 4) + | ((zeroValue & 0x0F00) >> 8); + *(tlc_GSData + NUM_TLCS * 24 - 1) = (uint8_t)zeroValue; + return topValue; +} + +/** Shifts all the channel data down (OUT 15 -> OUT 14 ...). Needs a + Tlc.update() after. + \param topValue the value of Tlc (n) channel 15. + \returns the value that was shifted off the bottom (OUT0) */ +uint16_t tlc_shiftDown(uint16_t topValue) +{ + uint8_t *p = tlc_GSData + NUM_TLCS * 24 - 2; + uint16_t zeroValue = + ((uint16_t)(*(tlc_GSData + NUM_TLCS * 24 - 2) & 0x0F) << 8) + | *(tlc_GSData + NUM_TLCS * 24 - 1); + while (p > tlc_GSData) { + *(p + 1) = (*p >> 4) | (*(p - 1) << 4); + *p = (*(p - 1) >> 4) | (*(p - 2) << 4); + p -= 2; + } + *(tlc_GSData + 1) = (*tlc_GSData >> 4) | ((uint8_t)topValue << 4); + *tlc_GSData = topValue >> 4; + return zeroValue; +} + +/* @} */ + +#endif +