299bc62586
The code conventions suggest using header guards, but do not define how those should look like and instead point to existing files. However, not all existing files follow the same scheme, sometimes omitting header guards altogether, sometimes using non-standard names, making it easy to accidentally pick a "wrong" example. This commit ensures that all header files of the MicroPython project (that were not simply copied from somewhere else) follow the same pattern, that was already present in the majority of files, especially in the py folder. The rules are as follows. Naming convention: * start with the words MICROPY_INCLUDED * contain the full path to the file * replace special characters with _ In addition, there are no empty lines before #ifndef, between #ifndef and one empty line before #endif. #endif is followed by a comment containing the name of the guard macro. py/grammar.h cannot use header guards by design, since it has to be included multiple times in a single C file. Several other files also do not need header guards as they are only used internally and guaranteed to be included only once: * MICROPY_MPHALPORT_H * mpconfigboard.h * mpconfigport.h * mpthreadport.h * pin_defs_*.h * qstrdefs*.h |
||
|---|---|---|
| .. | ||
| core | ||
| memzip_files | ||
| add-memzip.sh | ||
| hal_ftm.c | ||
| hal_ftm.h | ||
| hal_gpio.c | ||
| help.c | ||
| lcd.c | ||
| led.c | ||
| led.h | ||
| lexerfrozen.c | ||
| lexermemzip.h | ||
| main.c | ||
| make-pins.py | ||
| Makefile | ||
| mk20dx256_af.csv | ||
| mk20dx256_prefix.c | ||
| mk20dx256.ld | ||
| modpyb.c | ||
| mpconfigport.h | ||
| pin_defs_teensy.c | ||
| pin_defs_teensy.h | ||
| qstrdefsport.h | ||
| README.md | ||
| reg.c | ||
| reg.h | ||
| servo.c | ||
| servo.h | ||
| std.h | ||
| teensy_hal.c | ||
| teensy_hal.h | ||
| teensy_pins.csv | ||
| timer.c | ||
| timer.h | ||
| uart.c | ||
| usb.c | ||
| usb.h | ||
Build Instructions for Teensy 3.1
Currently the Teensy 3.1 port of MicroPython builds under Linux and not under Windows.
The tool chain required for the build can be found at https://launchpad.net/gcc-arm-embedded.
Download the current Linux *.tar.bz2 file. Instructions regarding unpacking the file and moving it to the correct location as well as adding the extracted folders to the enviroment variable can be found at http://eliaselectronics.com/stm32f4-tutorials/setting-up-the-stm32f4-arm-development-toolchain/
In order to download the firmware image to the teensy, you'll need to use the downloader included with TeensyDuino. The following assumes that you have TeensyDuino installed and set the ARDUINO environment variable pointing to the where Arduino with TeensyDuino is installed.
cd teensy
ARDUINO=~/arduino-1.0.5 make
To upload MicroPython to the Teensy 3.1.
Press the Program button on the Teensy 3.1
sudo ARDUINO=~/arduino-1.0.5/ make deploy
Currently, the Python prompt is through the USB serial interface, i.e.
minicom -D /dev/ttyACM0
TIPS
Install 49-teensy.rules into /etc/udev/rules.d
If you install the 49-teensy.rules file from http://www.pjrc.com/teensy/49-teensy.rules
into your /etc/udev/rules.d folder then you won't need to use sudo:
sudo cp ~/Downloads/49-teensy.rules /etc/udev/rules.d
sudo udevadm control --reload-rules
Unplug and replug the teensy board, and then you can use: ARDUINO=~/arduino-1.0.5/ make deploy
Create a GNUmakefile to hold your ARDUINO setting.
Create a file call GNUmakefile (note the lowercase m) in the teensy folder with the following contents:
$(info Executing GNUmakefile)
ARDUINO=${HOME}/arduino-1.0.5
$(info ARDUINO=${ARDUINO})
include Makefile
GNUmakefile is not checked into the source code control system, so it will retain your settings when updating your source tree. You can also add additional Makefile customizations this way.
Tips for OSX
Set the ARDUINO environment variable to the location where Arduino with TeensyDuino is installed.
export ARDUINO=~/Downloads/Arduino.app/Contents/Java/
Search /dev/ for USB port name, which will be cu.usbmodem followed by a few numbers. The name of the port maybe different depending on the version of OSX. To access the Python prompt type:
screen <devicename> 115200