From eaa8f1fe44fe8f7b8731288ac9f769fdecdb7a51 Mon Sep 17 00:00:00 2001 From: Simon John Date: Fri, 15 May 2015 18:09:00 +0100 Subject: [PATCH] Updated some documentation to clarify 1.5+ settings. Fixes #352 --- HISTORY.md | 1 + README.md | 3 ++- arduino-mk-vars.md | 24 ++++++++++++++---------- examples/TinySoftWareSerial/Makefile | 14 ++++++++++---- 4 files changed, 27 insertions(+), 15 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 087a4c7..2f7a32c 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -8,6 +8,7 @@ I tried to give credit whenever possible. If I have missed anyone, kindly add it - Tweak: Looks for submenu items first when parsing BOARDS_TXT (Issue #347) (https://github.com/sej7278) - Tweak: Various spelling/grammar/typo fixes (https://github.com/dcousens) +- Tweak: Clarified some 1.5+ issues in docs (Issue #352) (https://github.com/sej7278) ### 1.5 (2015-04-07) - New: Add support for new 1.5.x library layout (Issue #275) (https://github.com/lukasz-e) diff --git a/README.md b/README.md index 950b513..820649c 100644 --- a/README.md +++ b/README.md @@ -162,10 +162,11 @@ On Windows (using MSYS and PuTTY), you might want to set the following extra par MONITOR_PARMS = 8,1,n,N ``` -On Arduino 1.5.x installs, you should set the architecture to either `avr` or `sam` and if using a submenu CPU, then also set that: +On Arduino 1.5+ installs, you should set the architecture to either `avr` or `sam` and if using a submenu CPU type, then also set that: ```make ARCHITECTURE = avr + BOARD_TAG = atmegang BOARD_SUB = atmega168 ``` diff --git a/arduino-mk-vars.md b/arduino-mk-vars.md index 674a34f..e509bb4 100644 --- a/arduino-mk-vars.md +++ b/arduino-mk-vars.md @@ -40,7 +40,7 @@ ARDUINO_QUIET = 1 Directory where the `*.mk` files are stored. -Usually can be auto-detected as `AUTO_ARDUINO_DIR` (parent of `Arduino.mk`). +Usually can be auto-detected as parent of `Arduino.mk`. **Example:** @@ -96,7 +96,7 @@ RESET_CMD = ~/gertduino/reset **Description:** -Directory where the Arduino IDE and/or core files are stored. +Directory where the Arduino IDE and/or core files are stored. Usually can be auto-detected as `AUTO_ARDUINO_DIR`. **Example:** @@ -105,6 +105,8 @@ Directory where the Arduino IDE and/or core files are stored. ARDUINO_DIR = /usr/share/arduino # Mac OS X ARDUINO_DIR = /Applications/Arduino.app/Contents/Resources/Java +# Mac OSX with IDE 1.5+ +ARDUINO_DIR = /Applications/Arduino.app/Contents/Java ``` **Requirement:** *Optional* @@ -116,7 +118,7 @@ ARDUINO_DIR = /Applications/Arduino.app/Contents/Resources/Java **Description:** Directory where the Arduino platform dependent libraries are stored. -(Used only for Arduino 1.5.x) +(Used only for Arduino 1.5+) **Example:** @@ -150,9 +152,9 @@ ARDUINO_VERSION = 105 **Description:** -Architecture for Arduino 1.5 +Architecture for Arduino 1.5+ -Defaults to unset for 1.0 or `avr` for 1.5 +Defaults to unset for 1.0 or `avr` for 1.5+ **Example:** @@ -208,8 +210,10 @@ Path to Arduino `preferences.txt` file. Usually can be auto-detected as `AUTO_ARDUINO_PREFERENCES` from the defaults: -* on Linux : `~/.arduino/preferences.txt` -* on Mac OS X : `~/Library/Arduino/preferences.txt` +* on Linux (1.0): `~/.arduino/preferences.txt` +* on Linux (1.5+): `~/.arduino15/preferences.txt` +* on Mac OS X (1.0): `~/Library/Arduino/preferences.txt` +* on Mac OS X (1.5+): `~/Library/Arduino15/preferences.txt` **Example:** @@ -277,7 +281,7 @@ BOARD_TAG = uno or mega2560 **Description:** -1.5 submenu as listed in `boards.txt` +1.5+ submenu as listed in `boards.txt` **Example:** @@ -289,7 +293,7 @@ BOARD_TAG=diecimila BOARD_SUB=atmega168 ``` -**Requirement:** *Mandatory for 1.5 if using a submenu CPU* +**Requirement:** *Mandatory for 1.5+ if using a submenu CPU* ---- @@ -521,7 +525,7 @@ USB_PID = 0x8039 CPU speed in Hz Usually can be auto-detected as `build.f_cpu` from `boards.txt`, except in -some 1.6 cores like attiny where there is a clock submenu. +some 1.5+ cores like attiny where there is a clock submenu. **Example:** diff --git a/examples/TinySoftWareSerial/Makefile b/examples/TinySoftWareSerial/Makefile index 08f918d..ffe3afc 100644 --- a/examples/TinySoftWareSerial/Makefile +++ b/examples/TinySoftWareSerial/Makefile @@ -5,10 +5,16 @@ ALTERNATE_CORE = attiny # If not, you might have to include the full path. #ALTERNATE_CORE_PATH = /home/sudar/Dropbox/code/arduino-sketches/hardware/attiny/ -BOARD_TAG = attiny85-8 +# !!! Important. You have to use "make ispload" to upload when using ISP programmer +ISP_PROG = usbasp + +# 1.5+ example of submenu cpu +BOARD_TAG = attiny +BOARD_SUB = attiny85 + +# clock is a submenu too +F_CPU = 16000000L ARDUINO_LIBS = SoftwareSerial -include $(ARDMK_DIR)/Arduino.mk - -# !!! Important. You have to use make ispload to upload when using ISP programmer +include /usr/share/arduino/Arduino.mk