Release notes and procedure for 2012-10-R1

tools/RELEASENOTES

@@ -1,40 +1,42 @@
 Project Ubertooth 2012-10-R1 Release Notes
 
-The Ubertooth host utilities in this release require libbtbb 2012-10-R1 or
+The Ubertooth host utilities in this release require libbtbb-2012.10.R1 or
 greater, it can be found at https://sourceforge.net/projects/libbtbb/files/
 
-These are just the highlights.  For a complete list of changes since a prior
-release, see the git log.
+These are just the highlights.  For a complete list of changes since the
+previous release, see the git log.
 
  - libubertooth
 
    The core Ubertooth functions are now packaged as a library, which allows us
-   to have some independancy between the core ubertooth functions and the tools
+   to have some independence between the core ubertooth functions and the tools
    that use them, such as ubertooth-* and the kismet plugin.  This should also
    help with future binary packaging.
 
  - Firmware flashing
-
-   DFU - faster, stronger, better (only the last of these)
-
- - Ubertooth-follow
 
-   Ubertooth-follow has been added to the set of commandline tools that are
+   The ubertooth-dfu tool now attenpts to identify Ubertooth devices and put
+   them in to firmware upgrade mode.  Multiple arguments can also be passed to
+   ubertooth-dfu and will be executed in the order specified ont he commandline.
+   To flash firmware on to an ubertooth device, use the following command:
+     ubertooth-dfu --write <firmware_image.dfu> --detach
 
  - Bluetooth Low Energy (Experimental)
 
    Bluetooth Low Energy (Bluetooth Smart) sniffing is experimentally supported
-   by the ubertooth-btle tool.  Credit for this excellent achievement goes to
-   Mike Ryan.
+   by the ubertooth-btle tool. The tool can be used to sniff the connection
+   setup procedure between devices; promiscuous sniffing is available but is
+   extremely experimental. Credit for this achievement goes to Mike Ryan.
+
+ - Ubertooth-follow
+
+   Ubertooth-follow has been added to the set of Ubertooth commandline tools.
+   It retrieves the clock value from a local device using libbluetooth (bluez)
+   and uses the Ubertooth to hop in time with the piconet.  To build
+   ubertooth-follow use "make clock_debug=true".
 
  - Git
 
    Since the last release we have moved the source repository from SVN to Git.
    This should not affect the released code, but makes life easier for those of
    us working on the code.
-
- - Compiling Firmware
-
-   The firmware code now compiles with GCC Arm toolchain which is available for
-   download from https://launchpad.net/gcc-arm-embedded toolchain.
-   The Code Sourcery compiler is no longer required or supported.

tools/ubertooth-release.sh

@@ -19,7 +19,7 @@ top="`pwd`/../release"
 releasename="ubertooth-${branch}"
 targetdir="${top}/${releasename}"
 # Previous release, this is laziness to not have to rebuild the hardware files
-originaldir="${top}/ubertooth-${1}"
+originaldir="${top}/ubertooth-r${1}"
 
 mkdir -p ${targetdir}
 git archive --format=tar  HEAD | (cd ${targetdir} && tar xf -)
@@ -36,60 +36,57 @@ make
 # Software
 ############################
 export BOARD=UBERTOOTH_ONE
-mkdir ${dir}/ubertooth-one-firmware-bin
+mkdir ${targetdir}/ubertooth-one-firmware-bin
 cd ${targetdir}/firmware
 make clean
 make bluetooth_rxtx
-cp bluetooth_rxtx.hex ${targetdir}/ubertooth-one-firmware-bin/
-cp bluetooth_rxtx.bin ${targetdir}/ubertooth-one-firmware-bin/
-cp bluetooth_rxtx.dfu ${targetdir}/ubertooth-one-firmware-bin/
-cd ${targetdir}/firmware/bootloader
+cp bluetooth_rxtx/bluetooth_rxtx.hex ${targetdir}/ubertooth-one-firmware-bin/
+cp bluetooth_rxtx/bluetooth_rxtx.bin ${targetdir}/ubertooth-one-firmware-bin/
+cp bluetooth_rxtx/bluetooth_rxtx.dfu ${targetdir}/ubertooth-one-firmware-bin/
 make bootloader
-cp bootloader.hex ${targetdir}/ubertooth-one-firmware-bin/
-cp bootloader.bin ${targetdir}/ubertooth-one-firmware-bin/
-cd ${targetdir}/firmware/assembly_test
+cp bootloader/bootloader.hex ${targetdir}/ubertooth-one-firmware-bin/
+cp bootloader/bootloader.bin ${targetdir}/ubertooth-one-firmware-bin/
 make assembly_test
-cp assembly_test.hex ${targetdir}/ubertooth-one-firmware-bin/
-cp assembly_test.bin ${targetdir}/ubertooth-one-firmware-bin/
+cp assembly_test/assembly_test.hex ${targetdir}/ubertooth-one-firmware-bin/
+cp assembly_test/assembly_test.bin ${targetdir}/ubertooth-one-firmware-bin/
 make clean
 
 export BOARD=UBERTOOTH_ZERO
 mkdir ${targetdir}/ubertooth-zero-firmware-bin
-cd ${targetdir}/firmware/bluetooth_rxtx
+cd ${targetdir}/firmware/
 make bluetooth_rxtx
-cp bluetooth_rxtx.hex ${targetdir}/ubertooth-zero-firmware-bin/
-cp bluetooth_rxtx.bin ${targetdir}/ubertooth-zero-firmware-bin/
-cp bluetooth_rxtx.dfu ${targetdir}/ubertooth-zero-firmware-bin/
-cd ${targetdir}/firmware/bootloader
+cp bluetooth_rxtx/bluetooth_rxtx.hex ${targetdir}/ubertooth-zero-firmware-bin/
+cp bluetooth_rxtx/bluetooth_rxtx.bin ${targetdir}/ubertooth-zero-firmware-bin/
+cp bluetooth_rxtx/bluetooth_rxtx.dfu ${targetdir}/ubertooth-zero-firmware-bin/
 make bootloader
-cp bootloader.hex ${targetdir}/ubertooth-zero-firmware-bin/
-cp bootloader.bin ${targetdir}/ubertooth-zero-firmware-bin/
+cp bootloader/bootloader.hex ${targetdir}/ubertooth-zero-firmware-bin/
+cp bootloader/bootloader.bin ${targetdir}/ubertooth-zero-firmware-bin/
 make clean
 
 ############################
-# HArdware
+# Hardware
 ############################
-mkdir ${targetdir}/pogoprog-hardware
-mkdir ${targetdir}/pogoprog-hardware/gerbers
-cp ${originaldir}/hardware/pogoprog/pogoprog-schematic.pdf ${targetdir}/pogoprog-hardware
-cp ${originaldir}/hardware/pogoprog/pogoprog-assembly.pdf ${targetdir}/pogoprog-hardware
-cp ${originaldir}/hardware/pogoprog/pogoprog-*.g* ${tagetdir}/pogoprog-hardware/gerbers
-cp ${originaldir}/hardware/pogoprog/pogoprog.drl ${targetdir}/pogoprog-hardware/gerbers
-cp ${originaldir}/hardware/pogoprog/pogoprog.csv ${targetdir}/pogoprog-hardware/pogoprog-bom.csv
-mkdir ${targetdir}/ubertooth-one-hardware
-mkdir ${targetdir}/ubertooth-one-hardware/gerbers
-cp ${originaldir}/hardware/ubertooth-one/ubertooth-one-schematic.pdf ${targetdir}/ubertooth-one-hardware
-cp ${originaldir}/hardware/ubertooth-one/ubertooth-one-assembly.pdf ${targetdir}/ubertooth-one-hardware
-cp ${originaldir}/hardware/ubertooth-one/ubertooth-one-*.g* ${targetdir}/ubertooth-one-hardware/gerbers
-cp ${originaldir}/hardware/ubertooth-one/ubertooth-one.drl ${targetdir}/ubertooth-one-hardware/gerbers
-cp ${originaldir}/hardware/ubertooth-one/ubertooth-one.csv ${targetdir}/ubertooth-one-hardware/ubertooth-one-bom.csv
-mkdir ${targetdir}/tc13badge-hardware
-mkdir ${targetdir}/tc13badge-hardware/gerbers
-cp ${originaldir}/hardware/tc13badge/tc13badge-schematic.pdf ${targetdir}/tc13badge-hardware
-cp ${originaldir}/hardware/tc13badge/tc13badge-assembly.pdf ${targetdir}/tc13badge-hardware
-cp ${originaldir}/hardware/tc13badge/tc13badge-*.g* ${targetdir}/tc13badge-hardware/gerbers
-cp ${originaldir}/hardware/tc13badge/tc13badge.drl ${targetdir}/tc13badge-hardware/gerbers
-cp ${originaldir}/hardware/tc13badge/tc13badge.csv ${targetdir}/tc13badge-hardware/tc13badge-bom.csv
+#mkdir ${targetdir}/pogoprog-hardware
+#mkdir ${targetdir}/pogoprog-hardware/gerbers
+cp ${originaldir}/hardware/pogoprog/pogoprog-schematic.pdf ${targetdir}/hardware/pogoprog
+cp ${originaldir}/hardware/pogoprog/pogoprog-assembly.pdf ${targetdir}/hardware/pogoprog
+#cp ${originaldir}/hardware/pogoprog/pogoprog-*.g* ${tagetdir}/hardware/pogoprog/gerbers
+#cp ${originaldir}/hardware/pogoprog/pogoprog.drl ${targetdir}/hardware/pogoprog/gerbers
+cp ${originaldir}/hardware/pogoprog/pogoprog-bom.csv ${targetdir}/hardware/pogoprog/pogoprog-bom.csv
+#mkdir ${targetdir}/ubertooth-one-hardware
+#mkdir ${targetdir}/ubertooth-one-hardware/gerbers
+cp ${originaldir}/hardware/ubertooth-one/ubertooth-one-schematic.pdf ${targetdir}/hardware/ubertooth-one
+cp ${originaldir}/hardware/ubertooth-one/ubertooth-one-assembly.pdf ${targetdir}/hardware/ubertooth-one
+#cp ${originaldir}/hardware/ubertooth-one/ubertooth-one-*.g* ${targetdir}/hardware/ubertooth-one/gerbers
+#cp ${originaldir}/hardware/ubertooth-one/ubertooth-one.drl ${targetdir}/hardware/ubertooth-one/gerbers
+cp ${originaldir}/hardware/ubertooth-one/ubertooth-one-bom.csv ${targetdir}/hardware/ubertooth-one/ubertooth-one-bom.csv
+#mkdir ${targetdir}/tc13badge-hardware
+#mkdir ${targetdir}/tc13badge-hardware/gerbers
+cp ${originaldir}/hardware/tc13badge/tc13badge-schematic.pdf ${targetdir}/hardware/tc13badge/
+cp ${originaldir}/hardware/tc13badge/tc13badge-assembly.pdf ${targetdir}/hardware/tc13badge/
+#cp ${originaldir}/hardware/tc13badge/tc13badge-*.g* ${targetdir}/hardware/tc13badge/gerbers
+#cp ${originaldir}/hardware/tc13badge/tc13badge.drl ${targetdir}/hardware/tc13badge/gerbers
+cp ${originaldir}/hardware/tc13badge/tc13badge-bom.csv ${targetdir}/hardware/tc13badge/tc13badge-bom.csv
 
 ############################
 # Clean up
@@ -102,4 +99,4 @@ rm ${targetdir}/.gitignore
 # Archive
 ############################
 cd ${top}
-tar -zcf ${releasename}.tgz ${releasename}/
+tar -zcf ${releasename}.tar.gz ${releasename}/

tools/ubertooth-release.txt

@@ -1,6 +1,7 @@
 release procedure:
 
-manual procedure from git HEAD:
+manual procedure from git HEAD (can be copied from previous release if there
+have been no hardware changes):
 - make ubertooth one gerbers
 - make ubertooth one assembly diagram (print svg with frame ref)
 	open in inkscape, save as ubertooth-one-assembly.pdf
@@ -22,10 +23,9 @@ manual procedure from git HEAD:
 - make tc13badge schematic pdf (tc13badge-schematic.pdf)
 - make tc13badge bom (tc13badge.csv)
 
-The above stuff should all end up under ${originaldir} for release.sh to copy.
 
 scripted (release.sh):
-- svn export
+- git archive
 - nanoc compile
 - make ubertooth one binaries
 - make ubertooth zero binaries