Initial development branch source release

Author: Xykon

.gitmodules

@@ -7,7 +7,11 @@
 	url = https://github.com/atgreen/libffi
 [submodule "lib/lwip"]
 	path = lib/lwip
-	url = http://git.savannah.gnu.org/r/lwip.git
+	url = https://git.savannah.gnu.org/r/lwip.git
 [submodule "lib/berkeley-db-1.xx"]
 	path = lib/berkeley-db-1.xx
 	url = https://github.com/pfalcon/berkeley-db-1.xx
+[submodule "lib/stm32lib"]
+	path = lib/stm32lib
+	url = https://github.com/micropython/stm32lib
+	branch = work-F4-1.16.0+F7-1.7.0+L4-1.8.1

Jenkinsfile

@@ -7,29 +7,27 @@ node {
     stage('Checkout') {
         checkout scm
         sh 'rm -rf esp-idf'
-        sh 'git clone --recursive -b master https://github.com/pycom/pycom-esp-idf.git esp-idf'
-        sh 'git -C esp-idf checkout 4eab4e1b0e47c73b858c6b29d357f3d30a69c074'
-        sh 'git -C esp-idf submodule update'
+        sh 'git clone --depth=1 --recursive -b idf_dev https://github.com/pycom/pycom-esp-idf.git esp-idf'
     }
 
-    PYCOM_VERSION=get_version()
-    GIT_TAG = sh (script: 'git rev-parse --short HEAD', returnStdout: true).trim()
+	PYCOM_VERSION=get_version()
+	GIT_TAG = sh (script: 'git rev-parse --short HEAD', returnStdout: true).trim()
 
     stage('mpy-cross') {
         // build the cross compiler first
-        sh 'git tag -fa v1.8.6-849-' + GIT_TAG + ' -m \\"v1.8.6-849-' + GIT_TAG + '''\\";
+        sh 'git tag -fa v1.9.4-' + GIT_TAG + ' -m \\"v1.9.4-' + GIT_TAG + '''\\";
           cd mpy-cross;
           make clean;
           make all'''
     }
 
-    for (board in boards_to_build) {
-        stage(board) {
-            def parallelSteps = [:]
-            parallelSteps[board] = boardBuild(board)
-            parallel parallelSteps
-        }
-    }
+	for (board in boards_to_build) {
+    	stage(board) {
+    		def parallelSteps = [:]
+			parallelSteps[board] = boardBuild(board)
+			parallel parallelSteps
+  		}
+  	}
 
     stash includes: '**/*.bin', name: 'binary'
     stash includes: 'tests/**', name: 'tests'
@@ -39,19 +37,19 @@ node {
 }
 
 stage ('Flash') {
-    def parallelFlash = [:]
-    for (board in boards_to_test) {
-        parallelFlash[board] = flashBuild(board)
-    }
-    parallel parallelFlash
+	def parallelFlash = [:]
+	for (board in boards_to_test) {
+		parallelFlash[board] = flashBuild(board)
+	}
+	parallel parallelFlash
 }
 
 stage ('Test'){
-    def parallelTests = [:]
-    for (board in boards_to_test) {
-        parallelTests[board] = testBuild(board)
-    }
-    parallel parallelTests
+	def parallelTests = [:]
+	for (board in boards_to_test) {
+		parallelTests[board] = testBuild(board)
+	}
+	parallel parallelTests
 }
 
 
@@ -60,7 +58,7 @@ def boardBuild(name) {
     def name_short = name_u.split('_')[0]
     def app_bin = name.toLowerCase() + '.bin'
     return {
-            release_dir = "${JENKINS_HOME}/release/${JOB_NAME}/" + PYCOM_VERSION + "/" + GIT_TAG + "/"
+    		release_dir = "${JENKINS_HOME}/release/${JOB_NAME}/" + PYCOM_VERSION + "/" + GIT_TAG + "/"
         sh '''export PATH=$PATH:/opt/xtensa-esp32-elf/bin;
         export IDF_PATH=${WORKSPACE}/esp-idf;
         cd esp32;
@@ -69,24 +67,9 @@ def boardBuild(name) {
         sh '''export PATH=$PATH:/opt/xtensa-esp32-elf/bin;
         export IDF_PATH=${WORKSPACE}/esp-idf;
         cd esp32;
-        make TARGET=boot -j2 BOARD=''' + name_short
+        make -j3 release BOARD=''' + name_short + ' RELEASE_DIR=' + release_dir
 
-        sh '''export PATH=$PATH:/opt/xtensa-esp32-elf/bin;
-        export IDF_PATH=${WORKSPACE}/esp-idf;
-        cd esp32;
-        make TARGET=app -j2 BOARD=''' + name_short
-
-        sh '''cd esp32/build/'''+ name_u +'''/release;
-        mkdir -p firmware_package;
-        mkdir -p '''+ release_dir + ''';
-        cd firmware_package;
-        cp ../bootloader/bootloader.bin .;
-        mv ../application.elf ''' + release_dir + name + "-" + PYCOM_VERSION + '''-application.elf;
-        cp ../''' + app_bin + ''' appimg.bin;
-        cp ../lib/partitions.bin .;
-        cp ../../../../boards/''' + name_short + '''/''' + name_u + '''/script .;
-        cp ../''' + app_bin + ''' .;
-        tar -cvzf ''' + release_dir + name + "-" + PYCOM_VERSION + '''.tar.gz  appimg.bin  bootloader.bin   partitions.bin   script ''' + app_bin
+        sh 'mv esp32/build/'+ name_u + '/release/application.elf ' + release_dir + name + "-" + PYCOM_VERSION + '-application.elf'
     }
 }
 
@@ -114,17 +97,17 @@ def testBuild(short_name) {
   return {
     String device_name = get_device_name(short_name)
     String board_name_u = get_firmware_name(short_name)
-    node(get_remote_name(short_name)) {
-        sleep(5) //Delay to skip all bootlog
-        dir('tests') {
-            timeout(30) {
-                // As some tests are randomly failing... enforce script always returns 0 (OK)
-                    sh './run-tests --target=esp32-' + board_name_u + ' --device ' + device_name + ' || exit 0'
-                }
-            }
-            sh 'python esp32/tools/pypic.py --port ' + device_name +' --enter'
-            sh 'python esp32/tools/pypic.py --port ' + device_name +' --exit'
-    }
+	node(get_remote_name(short_name)) {
+		sleep(5) //Delay to skip all bootlog
+		dir('tests') {
+			timeout(30) {
+				// As some tests are randomly failing... enforce script always returns 0 (OK)
+            		sh './run-tests --target=esp32-' + board_name_u + ' --device ' + device_name + ' || exit 0'
+        		}
+        	}
+        	sh 'python esp32/tools/pypic.py --port ' + device_name +' --enter'
+        	sh 'python esp32/tools/pypic.py --port ' + device_name +' --exit'
+	}
   }
 }
 
@@ -135,16 +118,16 @@ def get_version() {
 
 def get_firmware_name(short_name) {
   node {
-    def node_info = sh (script: 'cat ${JENKINS_HOME}/pycom-ic.conf || exit 0', returnStdout: true).trim()
-    def matcher = node_info =~ short_name + ':(.+):.*'
+	def node_info = sh (script: 'cat ${JENKINS_HOME}/pycom-ic.conf || exit 0', returnStdout: true).trim()
+	def matcher = node_info =~ short_name + ':(.+):.*'
     matcher ? matcher[0][1] : "WIPY"
   }
 }
 
 def get_remote_name(short_name) {
   node {
-    def node_info = sh (script: 'cat ${JENKINS_HOME}/pycom-ic.conf || exit 0', returnStdout: true).trim()
-    def matcher = node_info =~ short_name + ':.*:(.+)'
+	def node_info = sh (script: 'cat ${JENKINS_HOME}/pycom-ic.conf || exit 0', returnStdout: true).trim()
+	def matcher = node_info =~ short_name + ':.*:(.+)'
     matcher ? matcher[0][1] : "RPI3"
   }
 }

README.md

@@ -30,20 +30,13 @@ The following components are actively maintained by Pycom:
 - tests/ -- test framework and test scripts.
 
 Additional components:
-- stmhal/ -- a version of MicroPython that runs on the PyBoard and similar
-  STM32 boards (using ST's Cube HAL drivers).
-- minimal/ -- a minimal MicroPython port. Start with this if you want
-  to port MicroPython to another microcontroller.
-- bare-arm/ -- a bare minimum version of MicroPython for ARM MCUs. Used
-  mostly to control code size.
-- teensy/ -- a version of MicroPython that runs on the Teensy 3.1
-  (preliminary but functional).
-- pic16bit/ -- a version of MicroPython for 16-bit PIC microcontrollers.
-- cc3200/ -- a version of MicroPython that runs on the CC3200 from TI.
-- esp8266/ -- an experimental port for ESP8266 WiFi modules.
+- ports/ -- versions of MicroPython that runs on other hardware
+- drivers/ -- hardware drivers
 - tools/ -- various tools, including the pyboard.py module.
 - examples/ -- a few example Python scripts.
 - docs/ -- user documentation in Sphinx reStructuredText format.
+- mpy-cross/ -- micropython cross-compiler
+- extmod/ -- external micropython modules
 
 The subdirectories above may include READMEs with additional info.
 
@@ -81,9 +74,9 @@ Then when you need the toolchain you can type ``get_esp32`` on the command line
 You also need the ESP IDF along side this repository in order to build the ESP32 port.
 To get it:
 
-    $ git clone https://github.com/pycom/pycom-esp-idf.git
+    $ git clone --recursive -b idf_dev https://github.com/pycom/pycom-esp-idf.git
 
-After cloning, make sure to checkout all the submodules:
+After cloning, if you did not specify the --recursive option, make sure to checkout all the submodules:
 
     $ cd pycom-esp-idf
     $ git submodule update --init
@@ -92,12 +85,32 @@ Finally, before building, export the IDF_PATH variable
 
     $ export IDF_PATH=~/pycom-esp-idf
 
+This repository contains submodules! Either clone using the --recursive option:
+
+    $ git clone --recursive https://github.com/pycom/pycom-micropython-sigfox.git
+    
+Alternative checkout the modules manually:
+
+    $ cd pycom-micropython-sigfox
+    $ git submodule update --init
+
+If you updated the repository from a previous version and/or if switching to the development branch,<br>
+make sure to also update the submodules with the command above as a new submodule has been added<br>
+in the development branch!
+
 Prior to building the main firmware, you need to build mpy-cross
 
 	$ cd mpy-cross && make clean && make && cd ..
 
 By default the firmware is built for the WIPY2:
 
+    $ cd esp32
+    $ make clean
+    $ make
+    $ make flash
+
+By default, both bootloader and application are built. To build them separately:
+
     $ cd esp32
     $ make clean
     $ make TARGET=boot
@@ -108,15 +121,21 @@ You can change the board type by using the BOARD variable:
 
     $ cd esp32
     $ make BOARD=GPY clean
-    $ make BOARD=GPY TARGET=boot
-    $ make BOARD=GPY TARGET=app
+    $ make BOARD=GPY
     $ make BOARD=GPY flash
 
 We currently support the following BOARD types:
 
 	WIPY LOPY SIPY GPY FIPY LOPY4
+	
+For OEM modules, please use the following BOARD type:
 
-For LoRa, you may need to specify the `LORA_BAND` as explained below.
+``` text
+W01: WIPY
+L01: LOPY
+L04: LOPY4
+G01: GPY
+```
 
 To specify a serial port other than /dev/ttyUSB0, use ESPPORT variable:
 
@@ -125,26 +144,40 @@ To specify a serial port other than /dev/ttyUSB0, use ESPPORT variable:
     $ # On Windows
     $ make ESPPORT=COM3 flash
     $ # On linux
-    $ # make ESPPORT=/dev/ttyUSB1 flash
+    $ make ESPPORT=/dev/ttyUSB1 flash
 
 To flash at full speed, use ESPSPEED variable:
 
 	$ make ESPSPEED=921600 flash
 
-To build and flash a LoPy:
+Make sure that your board is placed into <b>programming mode</b>, otherwise <b>flashing will fail</b>.<br>
+All boards except Expansion Board 2.0 will automatically switch into programming mode<br><br>
+Expansion Board 2.0 users, please connect ``P2`` to ``GND`` and then reset the board.
+
+
+To create a release package that can be flashed with the Pycom firmware tool:
+
+    $ cd esp32
+    $ make clean
+    $ make release
+    
+To create a release package for all currently supported Pycom boards:
 
     $ cd esp32
-    $ make BOARD=LOPY clean
-    $ make BOARD=LOPY TARGET=boot
-    $ make BOARD=LOPY TARGET=app
-    $ make BOARD=LOPY flash
+    $ for BOARD in WIPY LOPY SIPY GPY FIPY LOPY4; do make BOARD=$BOARD clean && make BOARD=$BOARD release; done
+
+To specify a directory other than the default build/ directory:
+
+    $ cd esp32
+    $ make clean
+    $ make RELEASE_DIR=~/pycom-packages release
+    
+To create a release package for all currently supported Pycom boards in a directory other than the default build/ directory:
+
+    $ cd esp32
+    $ for BOARD in WIPY LOPY SIPY GPY FIPY LOPY4; do make BOARD=$BOARD clean && make BOARD=$BOARD RELEASE_DIR=~/pycom-packages release; done
 
-The above also applies to the FiPy and LoPy4
 
-Make sure that your board is placed into programming mode, otherwise flashing will fail.<br>
-PyTrack and PySense boards will automatically switch into programming mode<br>
-(currently supported on MacOS and Linux only!)<br><br>
-Expansion Board 2.0 users, please connect ``P2`` to ``GND`` and then reset the board.
 
 ## Steps for using Secure Boot and Flash Encryption
 
@@ -157,7 +190,7 @@ Expansion Board 2.0 users, please connect ``P2`` to ``GND`` and then reset the b
 
 ### Prerequisites
 
-    $ export $IDF_PATH=<pycom-esp-idf_PATH>
+    $ export IDF_PATH=<pycom-esp-idf_PATH>
     $ cd esp32
 
 Hold valid keys for Flash Encryption and Secure Boot; they can be generated randomly with the following commands:
@@ -191,7 +224,7 @@ Flash keys (`flash_encryption_key.bin` and `secure-bootloader-key.bin`) into the
 
 ### Makefile options:
 
-    make BOARD=GPY SECURE=on SECURE_KEY=secure_boot_signing_key.pem ENCRYPT_KEY=flash_encryption_key.bin TARGET=[boot|app]
+    make BOARD=GPY SECURE=on SECURE_KEY=secure_boot_signing_key.pem ENCRYPT_KEY=flash_encryption_key.bin
 
 - `SECURE=on` is the main flag; it's not optional
 - if `SECURE=on` by default:
@@ -210,8 +243,7 @@ For flashing the bootloader-reflash-digest.bin has to be written at address 0x0,
 Build is done using `SECURE=on` option; additionally, all the binaries are pre-encrypted.
 
     make BOARD=GPY clean
-    make BOARD=GPY SECURE=on TARGET=boot
-    make BOARD=GPY SECURE=on TARGET=app
+    make BOARD=GPY SECURE=on
     make BOARD=GPY SECURE=on flash
 
 Manual flash command: