Merge pull request #336 from openxc/next

dependency updates & typos

.gitmodules

@@ -22,7 +22,7 @@
 	url = https://github.com/openxc/AT-commander
 [submodule "src/libs/nanopb"]
 	path = src/libs/nanopb
-	url = https://code.google.com/p/nanopb/
+	url = https://github.com/nanopb/nanopb.git
 [submodule "src/libs/openxc-message-format"]
 	path = src/libs/openxc-message-format
 	url = https://github.com/openxc/openxc-message-format

CHANGELOG.mkd

@@ -1,5 +1,12 @@
 # OpenXC Vehicle Interface Firmware Changelog
 
+## v7.1.1
+
+* Fix: Update nanpb repo location to Git.
+* Fix: Keep same setuptools version.
+* Fix: Update ChipKIT digitlent URL (requires disable SSL cert checks).
+* Fix: Minor doc updates.
+
 ## v7.1.0
 
 * Feature: Add support for new CrossChasm C5 Cellular platform.

README.rst

@@ -4,7 +4,7 @@ OpenXC Vehicle Interface Firmware
 
 .. image:: /docs/_static/logo.png
 
-:Version: 7.1.0
+:Version: 7.1.1
 :Web: http://openxcplatform.com
 :Documentation: http://vi-firmware.openxcplatform.com
 :Source: http://github.com/openxc/vi-firmware
@@ -20,7 +20,7 @@ OpenXC Vehicle Interface Firmware
     :target: http://vi-firmware.openxcplatform.com
     :alt: Documentation Status
 
-The OpenXC vehicle interface (VI) firmware runs on an microcontroller connected
+The OpenXC vehicle interface (VI) firmware runs on a microcontroller connected
 to one or more CAN buses. It receives either all CAN messages or a filtered
 subset, performs any unit conversion or factoring required and outputs a generic
 version to a USB interface.
@@ -36,7 +36,7 @@ Installation
 =============
 
 For the full build instructions, see the `documentation
-<http://vi-firmware.openxcplatform.com/en/latest/installation/installation.html>`_.
+<http://vi-firmware.openxcplatform.com>`_.
 
 
 Releasing
@@ -51,6 +51,8 @@ Releasing
 
 - Update the src/libs/openxc-message-format with ``git submodule update --remote``
 
+- Checkout next branch and make edits.
+
 - Bump the version using `semantic versioning`_ in
   - ``CHANGELOG.mkd``
   - ``README.rst``
@@ -68,7 +70,7 @@ Releasing
   next development release (one patch release up with the ``-dev`` suffix, e.g.
   ``v0.9.2-dev``
 
-- Also change ``script/pip-requirements.txt`` back to using the development
+- Also change ``script/bootstrap/pip-requirements.txt`` back to using the development
   version from Git: ``-e git+https://github.com/openxc/openxc-python.git@next#egg=openxc``
 
 - Go to https://github.com/openxc/vi-firmware/releases and promote the tag you

docs/compile/dependencies.rst

@@ -96,30 +96,19 @@ in all terminals (and you probably do), you need to add these
 Digilent / Microchip Libraries
 ------------------------------
 
-It also requires some libraries from Microchip that we are unfortunately unable
-to include or link to as a submodule from the source because of licensing
-issues:
-
--  Microchip USB device library (download DSD-0000318 from the bottom of
-   the `Network Shield
-   page <http://digilentinc.com/Products/Detail.cfm?NavPath=2,719,943&Prod=CHIPKIT-NETWORK-SHIELD>`_)
--  Microchip CAN library (included in the same DSD-0000318 package as
-   the USB device library)
-
-You can read and accept Microchip's license and download both libraries on the
-`Digilent download page
-<http://digilentinc.com/Agreement.cfm?DocID=DSD-0000318>`_.
-
-Once you've downloaded the .zip file, extract it into the ``libs``
-directory in this project. It should look like this:
+We also require some libraries from Microchip that are available from the bottom of the `Network Shield page <https://reference.digilentinc.com/chipkit_shield_network:chipkit_shield_network>`_. You can read and accept Microchip's license and download the libraries on the `Digilent download page <https://reference.digilentinc.com/agreement>`_. The bootstrap script does the above and then the ``libs`` directory should look like this:
 
 .. code-block:: sh
 
     - /Users/me/projects/vi-firmware/
-    ---- libs/
-    -------- chipKITUSBDevice/
-             chipKitCAN/
-            ... other libraries
+    -- src/
+    --- libs/
+    ---- 
+        ... other libraries
+       chipKitCAN/
+       chipKITEthernet/
+       chipKITUSBDevice/
+        ... other libraries
 
 .. _ftdi:
 

docs/conf.py

@@ -49,9 +49,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '7.1.0'
+version = '7.1.1'
 # The full version, including alpha/beta/rc tags.
-release = '7.1.0'
+release = '7.1.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/index.rst

@@ -4,7 +4,7 @@ OpenXC Vehicle Interface Firmware
 
 .. image:: /_static/logo.png
 
-:Version: 7.1.0
+:Version: 7.1.1
 :Web: http://openxcplatform.com
 :Documentation: http://vi-firmware.openxcplatform.com
 :Source: http://github.com/openxc/vi-firmware

script/bootstrap.sh

@@ -27,3 +27,5 @@ else
     source $SCRIPTS_DIR/bootstrap/pic32.sh
     source $SCRIPTS_DIR/bootstrap/devel.sh;
 fi
+
+echo "Bootstrap complete"

script/bootstrap/common.sh

@@ -113,7 +113,16 @@ if [ -z $COMMON_SOURCED ]; then
     download() {
         url=$1
         filename=$2
-        curl $url -L -o $filename
+
+        #if 3rd arg exists, run curl and disable SSL cert checking. Added
+        #for digilent - see pic32.sh
+        if [ ! -z $3 ]; then 
+            k_opt="-k"
+        else
+            k_opt=""
+        fi
+        echo "download() running 'curl $k_opt $url -L -o $filename'"
+        curl $k_opt $url -L -o $filename
     }
 
     if [ `id -u` == 0 ]; then
@@ -231,12 +240,12 @@ pre-configured Vagrant environment. See the docs for more information."
         echo "Installing Python..."
         _install "python"
     fi
-    
+
     if [ $OS != "cygwin" ]; then
         echo "Installing Python development headers..."
         _install "python-dev"
     fi
-    
+
     if ! command -v pip >/dev/null 2>&1; then
         echo "Installing Pip..."
         if ! command -v easy_install >/dev/null 2>&1; then
@@ -256,10 +265,9 @@ pre-configured Vagrant environment. See the docs for more information."
         PIP_SUDO_CMD=$SUDO_CMD
     fi
 
-    $PIP_SUDO_CMD pip install --upgrade setuptools
-    $PIP_SUDO_CMD pip install --src dependencies --pre -Ur $BOOTSTRAP_DIR/ci-requirements.txt
+    $PIP_SUDO_CMD pip install --src dependencies --pre -r $BOOTSTRAP_DIR/ci-requirements.txt
     if [ -z $CI ]; then
-        $PIP_SUDO_CMD pip install --src dependencies --pre -Ur $BOOTSTRAP_DIR/pip-requirements.txt
+        $PIP_SUDO_CMD pip install --src dependencies --pre -r $BOOTSTRAP_DIR/pip-requirements.txt
     fi
 
     COMMON_SOURCED=1

script/bootstrap/pic32.sh

@@ -8,9 +8,16 @@ source $BOOTSTRAP_DIR/flashing_chipkit.sh
 
 ## chipKIT libraries for USB, CAN and Network
 
-CHIPKIT_LIBRARY_AGREEMENT_URL="http://www.digilentinc.com/Agreement.cfm?DocID=DSD-0000318"
-CHIPKIT_LIBRARY_DOWNLOAD_URL="http://www.digilentinc.com/Data/Documents/Product%20Documentation/chipKIT%20Network%20and%20USB%20Libs-20130724a.zip"
-CHIPKIT_ZIP_FILE="chipkit-libraries-2013-07-24.zip"
+CHIPKIT_LIBRARY_AGREEMENT_URL="https://reference.digilentinc.com/agreement"
+
+# Disabling SSL cert checking (-k), which while strong discouraged, is
+# used here because some dependency hosts CA bundle files are messed up,
+# and this software doesn't store any secure data. If Digilent fixes
+# their SSL certificate bundle we can remove it.
+NOT_SECURE="true"
+CHIPKIT_LIBRARY_DOWNLOAD_URL="https://reference.digilentinc.com/_media/chipkit_network_and_usb_libs-20150115.zip"
+
+CHIPKIT_ZIP_FILE="chipkit_network_and_usb_libs-20150115.zip"
 
 _pushd $DEPENDENCIES_FOLDER
 if ! test -e $CHIPKIT_ZIP_FILE
@@ -21,7 +28,7 @@ then
         echo "Press Enter to verify you have read the license agreement."
         read
     fi
-    download $CHIPKIT_LIBRARY_DOWNLOAD_URL $CHIPKIT_ZIP_FILE
+    download $CHIPKIT_LIBRARY_DOWNLOAD_URL $CHIPKIT_ZIP_FILE $NOT_SECURE
     unzip $CHIPKIT_ZIP_FILE
 fi
 _popd

src/config.cpp

@@ -88,7 +88,7 @@ openxc::telitHE910::TelitDevice telitDevice = {
 openxc::config::Configuration* openxc::config::getConfiguration() {
     static openxc::config::Configuration CONFIG = {
         messageSetIndex: 0,
-        version: "7.1.0",
+        version: "7.1.1",
         payloadFormat: PayloadFormat::DEFAULT_OUTPUT_FORMAT,
         recurringObd2Requests: DEFAULT_RECURRING_OBD2_REQUESTS_STATUS,
         obd2BusAddress: DEFAULT_OBD2_BUS,