1- ![ QP framework] ( https://state-machine.com/img/qpn-arduino_banner.jpg )
2-
31This README provides a quick overview of QP-nano for Arduino.
42Please refer to the companion webiste to this project at:
53
6- https://state-machine.com/arduino
4+ https://www. state-machine.com/arduino
75
86
9- ---------------------------------------------------------------------------
10- ## Software Installation on Windows
7+ Software Installation on Windows
8+ ================================
119The QP-nano adaptation for Arduino is distributed in a single ZIP
1210archive qpn-<ver>_arduino-1.8.x.zip, where <ver> stands for version of
1311the QP-nano framework.
@@ -21,14 +19,15 @@ box. Once you identify the Sketchbook folder, you simply unzip the whole
2119archive to your Sketchbook.
2220
2321
24- ## Software Installation on MacOS
22+ Software Installation on MacOS
23+ ==============================
2524The Mac funtionality has been tested, but other users will likely find
2625issues. Please submit issues at https://sourceforge.net/p/qpc/bugs/ and
2726submit questions and suggestions at
2827https://sourceforge.net/p/qpc/discussion/668726/
2928
30-
31- ### Install Dependencies
29+ Install Dependencies
30+ --------------------
32311. Install the AVR-GCC tooltrain for Mac OS X. Following are the commands
3332to install using Homebrew (must have Homebrew installed):
3433
@@ -46,8 +45,8 @@ security warnings.
4645
47464. Install QM.
4847
48+ Instructions for Configuring External Tools for a Model
4949
50- ### Instructions for Configuring External Tools for a Model
51501. Ensure the model is not open in QM.
5251
53522. Copy the Blinky model's settings
@@ -61,20 +60,22 @@ Sketchbook folder to the model's folder.
6160Once you have a working .model file, copy it to other models and use it as
6261a starting point.
6362
64-
65- ## Known Issues
63+ Known Issues
64+ ------------
66651. The serialterm External Tool is working by opening a Terminal window.
6766An additional Terminal window also appears and can be safely closed. When
6867the Terminal window displaying the Arduino's output is closed, the port is
6968busy and can no longer be accessed. Work-around is to unplug and
7069re-connect the Arduino from the Mac's USB port.
7170
7271
73- ---------------------------------------------------------------------------
74- # Building the Examples in the QM Modeling Tool
72+ Building the Examples in the QM Modeling Tool
73+ =============================================
7574
76- > ** NOTE:** To start working with the freeware QM modeling tool, you need to
75+ ****
76+ NOTE: To start working with the freeware QM modeling tool, you need to
7777download the tool from https://sourceforge.net/projects/qpc/files/QM.
78+ ****
7879
7980Each QP-nano example for Arduino (in the examples_avr folder) contains
8081a QM model, which is a file with the extension .qm., such as
@@ -86,8 +87,8 @@ you generate the complete Arduino sketch automatically-
8687press of a button.
8788
8889
89- ---------------------------------------------------------------------------
90- # Licensing
90+ Licensing
91+ =========
9192The QP-nano framework for Arduino is licensed under the modified GPLv3
9293license (see file GPLv3.txt) with the QP-Arduino Exception (see file
9394QP-Arduino_GPL_Exception.txt). Specifically, the Exception removes the
@@ -98,22 +99,19 @@ The QM graphical modeling tool is freeware. The QM tool is provided
9899under the terms of a simple End-User License Agreement (EULA).
99100
100101
101- ---------------------------------------------------------------------------
102- # Documentation
102+ Documentation
103+ =============
103104Please refer to the companion webiste to this project at:
104105
105- https://state-machine.com/arduino
106+ https://www. state-machine.com/arduino
106107
107108Specifically, the Application Note: "Event-Driven Arduino Programming
108109with QP and QM" is available from:
109110
110- https://state-machine.com/doc/AN_Event-Driven_Arduino_QP-nano.pdf
111-
111+ https://www.state-machine.com/doc/AN_Event-Driven_Arduino_QP-nano.pdf
112112
113- ---------------------------------------------------------------------------
114- # How to get help?
115- - [ Free Support Forum] ( https://sourceforge.net/p/qpc/discussion/668726 )
116- - [ Bug Reports] ( https://sourceforge.net/p/qpc/bugs/ )
117- - [ Feature Requests] ( https://sourceforge.net/p/qpc/feature-requests/ )
118- - [ Quantum Leaps website] ( https://state-machine.com )
119113
114+ Support Questions
115+ =================
116+ Please submit any questions or comments to the free QP support forum at:
117+ http://sourceforge.net/p/qpc/discussion/668726
0 commit comments