6.5.1

Author: QL

GPLv3.txt

@@ -1,43 +1,42 @@
 QP-nano FRAMEWORK EXCEPTION FOR ARDUINO
 
-Version 1.1, 22 June 2016
+Version 2.0, July 16, 2019
 
-Copyright (c) 2016 Quantum Leaps, LLC. <https://www.state-machine.com/>
+Copyright (c) 2005-2019 Quantum Leaps, LLC. <https://www.state-machine.com/>
 
 Everyone is permitted to copy and distribute verbatim copies of this
 license document, but changing it is not allowed.
 
-This QP-nano Framework Exception for Arduino ("Exception") is an
-additional permission under section 7 of the GNU General Public
-License, version 3 ("GPLv3"). It applies to the QP-nano source code
-(the "QP-nano Framework") that is distributed as part of the
+This QP/C++ and QP-nano Framework Exception for Arduino ("Exception")
+is an additional permission under section 7 of the GNU General Public
+License, version 3 ("GPLv3"). It applies to the QP/C++ and QP-nano
+source code (the "QP Frameworks") that is distributed as part of the
 QP-Arduino Support Package.
 
-When you use QP-nano Framework inside your program, the QP-nano
-framework code is combined with your code of the program. The purpose
-of this Exception is to allow non-GPL (including proprietary)
-programs to use, in this way, the QP-nano Framework code covered
-by this Exception.
+When you use QP Frameworks inside your program, the QP Frameworks' code
+is combined with your code of the program. The purpose of this Exception
+is to allow non-GPL (including proprietary) programs to use, in this way,
+the QP Frameworks' code covered by this Exception.
 
 0. Definitions.
-"QP-nano Framework for Arduino" is a lightweight real-time framework,
+"QP Frameworks" are lightweight real-time embedded frameworks (RTEFs)
 as well as all supporting ports and examples, as distributed from:
 <https://sourceforge.net/projects/qpc/files> and
 <https://github.com/QuantumLeaps>
 
 "Arduino-Certified Board" means any board with an Arduino-supported
-CPU that bears an official Arduino logo and/or is officially
-certified under the Arduino Certified Program
+CPU that bears an official Arduino logo and/or is officially certified
+under the Arduino Certified Program
 (see <http://arduino.cc/en/ArduinoCertified>).
 
 "Target Code" refers to output from any compiler and linker in
 executable form suitable for execution by an embedded microcontroller.
 
 
 1. Grant of Additional Permission
-As a special Exception, the copyright holder of QP-nano gives you
+As a special Exception, the copyright holder of QP Frameworks gives you
 permission to propagate a work of Target Code formed by combining
-the QP-nano Framework with your own source code without the requirement
+the QP Frameworks with your own source code without the requirement
 to expose your propriatory source code, provided that all Target Code
 will execute on Arduino-Certified Board(s).
 

QP-Arduino_GPL_Exception.txt

@@ -1,99 +1,60 @@
-This README provides a quick overview of QP-nano for Arduino.
+This README provides a quick overview of QP for Arduino.
 Please refer to the companion webiste to this project at:
 
 https://www.state-machine.com/arduino
 
 
 Software Installation on Windows
 ================================
-The QP-nano adaptation for Arduino is distributed in a single ZIP
-archive qpn-<ver>_arduino-1.8.x.zip, where <ver> stands for version of
-the QP-nano framework.
+The QP adaptation for Arduino is distributed in a single ZIP
+archive qp-<ver>_arduino-1.8.x.zip, where <ver> stands for version of
+the QP frameworks.
 
-You need to unzip the qpn-<ver>_arduino-1.8.x.zip archive into your
+You need to unzip the qp-<ver>_arduino-1.8.x.zip archive into your
 Arduino-Sketchbook folder. To find out where your Sketchbook folder is,
 or to configure a different location for your Sketchbook folder, you
 need to open the Arduino IDE and select File | Preferences menu. The
 sketchbook location will be shown at the top of the Preferences dialog
 box. Once you identify the Sketchbook folder, you simply unzip the whole
 archive to your Sketchbook.
-
-
-Software Installation on MacOS
-==============================
-The Mac funtionality has been tested, but other users will likely find
-issues. Please submit issues at https://sourceforge.net/p/qpc/bugs/ and
-submit questions and suggestions at
-https://sourceforge.net/p/qpc/discussion/668726/
-
-Install Dependencies
---------------------
-1. Install the AVR-GCC tooltrain for Mac OS X. Following are the commands
-to install using Homebrew (must have Homebrew installed):
-
-  > ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
-  > brew tap osx-cross/avr
-  > brew install avr-libc
-  > brew install avrdude --with-usb
-
-2. Install Arduino for Mac OS X by placing the Arduino application in the
-Applications folder. Open the application at least one time to overcome
-security warnings.
-
-3. Install Install QP-nano for Arduino into your Documents/Arduino folder
-(documentation refers to this as the Arduino Sketchbook folder).
-
-4. Install QM.
-
-Instructions for Configuring External Tools for a Model
-
-1. Ensure the model is not open in QM.
-
-2. Copy the Blinky model's settings
-(libraries/qpn_avr/examples/blinky/.blinky.macos) from your Arduino
-Sketchbook folder to the model's folder.
-
-3. Rename the settings file to your model's name (i.e., .mymodel).
-
-4. Open QM and edit the settings from External Tools.
-
-Once you have a working .model file, copy it to other models and use it as
-a starting point.
-
-Known Issues
-------------
-1. The serialterm External Tool is working by opening a Terminal window.
-An additional Terminal window also appears and can be safely closed. When
-the Terminal window displaying the Arduino's output is closed, the port is
-busy and can no longer be accessed. Work-around is to unplug and
-re-connect the Arduino from the Mac's USB port.
-
-
-Building the Examples in the QM Modeling Tool
-=============================================
-
+
+
+Provided Libraries
+==================
+The archive qp-<ver>_arduino-1.8.x.zip contains two external libraries
+for Arduino:
+
+qpcpp_sam -- QP/C++ framework for SAM-based Arduinos (ARM Cortex-M)
+qpn_avr   -- QP-nano framework for AVR based Arduinos
+
+
+Working with the Examples
+=========================
+Each QP library contains the examples sub-directory, which contans the
+QM model file and the generated code. The intended way of working with
+the examples is to use the QM modeling tool to modify the state diagrams
+and the code, and to use the Arduino IDE only to build and upload
+the code to the Arduino board(s).
+
 ****
-NOTE: To start working with the freeware QM modeling tool, you need to
-download the tool from https://sourceforge.net/projects/qpc/files/QM.
+NOTE: The preferences in the Arduino IDE should be set up to
+"Use external editor" so that the IDE will update the code each time
+it is re-generated by the QM modeling tool.
 ****
-
-Each QP-nano example for Arduino (in the examples_avr folder) contains
-a QM model, which is a file with the extension .qm., such as
-<Sketchbook>\examples_avr\blinky\blinky.qm. These models and the QM
-modeling tool take Arduino programming to the next level. Instead of
-coding the state machines by hand, you draw them with the free QM
-modeling tool, attach simple action code to states and transitions, and
-you generate the complete Arduino sketch automatically-—literally by a
-press of a button.
+
+When you unzip the archive into your Sketchbook directory, the examples
+provided in each QP library shows up in the Arduino IDE under the menu:
+
+File|Examples|Examples from Custom Libraries
 
 
 Licensing
 =========
-The QP-nano framework for Arduino is licensed under the modified GPLv3
-license (see file GPLv3.txt) with the QP-Arduino Exception (see file
-QP-Arduino_GPL_Exception.txt). Specifically, the Exception removes the
-requirement to expose your propriatory source code as long as you deploy
-it on an Arduino-Certified board.
+The QP real-time embedded frameworks for Arduino are licensed under the
+modified GPLv3 license with the QP-Arduino Exception (see file
+QP-Arduino_GPL_Exception.txt in the root of the archive). Specifically,
+the Exception removes the requirement to expose your propriatory source
+code as long as you deploy it on an Arduino-Certified board.
 
 The QM graphical modeling tool is freeware. The QM tool is provided
 under the terms of a simple End-User License Agreement (EULA).
@@ -105,11 +66,6 @@ Please refer to the companion webiste to this project at:
 
 https://www.state-machine.com/arduino
 
-Specifically, the Application Note: "Event-Driven Arduino Programming
-with QP and QM" is available from:
-
-https://www.state-machine.com/doc/AN_Event-Driven_Arduino_QP-nano.pdf
-
 
 Support Questions
 =================