Merge pull request #2 from electricimp/develop

Bump to 2.0.0: support imp006

Author: ElectricImpSampleCode

Diff for: README.md

@@ -1,10 +1,10 @@
-# BTLEBlinkUp 1.0.0 #
+# BTLEBlinkUp 2.0.0 #
 
-This library provides a foundation for activating end-user devices via Bluetooth LE on imp modules that support this wireless technology (currently imp004m only) using BlinkUp™.
+This library provides a foundation for activating end-user devices via Bluetooth LE on imp modules that support this wireless technology (currently imp004m and imp006 only) using BlinkUp™.
 
 The BTLEBlinkUp library is intended for Electric Imp customers **only**. It contains device-side Squirrel code which enables BlinkUp device activation using enrollment and WiFi credentials transmitted by a companion app running on a mobile device. The companion app must contain the [Electric Imp BlinkUp SDK](https://developer.electricimp.com/manufacturing/sdkdocs), use of which is authorized by API key. Only Electric Imp customers can be provided with a suitable BlinkUp API key. Code for the companion app is not part of this library, but iOS example code is [available separately](https://github.com/electricimp/BluetoothBlinkUp).
 
-**To include this library in your project, add** `#require "bt_firmware.lib.nut:1.0.0"` **and** `#require "btleblinkup.device.lib.nut:1.0.0"` **at the top of your device code**.
+**To include this library in your project, add** `#require "bt_firmware.lib.nut:1.0.0"` **and** `#require "btleblinkup.device.lib.nut:2.0.0"` **at the top of your device code**.
 
 ## Example Code ##
 
@@ -26,15 +26,21 @@ This library requires the separate library [Bluetooth Firmware](https://github.c
 
 ```squirrel
 #require "bt_firmware.lib.nut:1.0.0"
-#require "btleblinkup.device.lib.nut:1.0.0"
+#require "btleblinkup.device.lib.nut:2.0.0"
 ```
 
 One of the firmware versions included in [Bluetooth Firmware](https://github.com/electricimp/BluetoothFirmware) should then be included in your BTLEBlinkUp instantiation call:
 
 ```squirrel
+// For imp004m
 local bt = BTLEBlinkUp(serviceUUIDs, BT_FIRMWARE.CYW_43438);
 ```
 
+```squirrel
+// For imp006
+local bt = BTLEBlinkUp(serviceUUIDs, BT_FIRMWARE.CYW_43455);
+```
+
 ### Constructor: BTLEBlinkUp(*uuids, firmware[, lpoPin][, regonPin][, uart]*) ###
 
 #### Parameters ####
@@ -47,6 +53,8 @@ local bt = BTLEBlinkUp(serviceUUIDs, BT_FIRMWARE.CYW_43438);
 | *regonPin* | imp **pin** object | No | The imp GPIO pin connected to the Bluetooth LE radio’s BT_REG_ON pin. Default: **hardware.pinJ** |
 | *uart* | imp **uart** object | No | The imp UART on which the imp’s Bluetooth radio is connected. Default: **hardware.uartFGJH** |
 
+**Note** The last three parameters are required only on the imp004m. imp006-based applications should not supply arguments to these parameters; indeed, they will be ignored if you do.
+
 #### BLE Service UUIDs ####
 
 The constructor's *uuids* parameter is used to set UUIDs for the BlinkUp services delivered by the library. The UUIDs are supplied as a table which must contain the following keys:
@@ -262,8 +270,10 @@ Nothing.
 
 ## Release Notes ##
 
+- 2.0.0
+    - Support imp006.
 - 1.0.0
-    - Initial public release
+    - Initial public release.
 
 ## License ##
 

Diff for: btleblinkup.device.lib.nut

@@ -44,7 +44,7 @@ class BTLEBlinkUp {
      * @property {string} VERSION - The library version.
      *
     */
-    static VERSION = "1.0.0";
+    static VERSION = "2.0.0";
 
     /**
      * @property {imp::bluetooth} ble - The imp API hardware.bluetooth instance.
@@ -69,9 +69,11 @@ class BTLEBlinkUp {
     _uart = null;
     _blinking = false;
     _scanning = false;
+    _impType = null;
 
     /**
      * Instantiate the BLE BlinkUp Class.
+     * NOTE lpoPin, regonPin and uart only required by imp004m.
      *
      * @constructor
      *
@@ -93,11 +95,18 @@ class BTLEBlinkUp {
         if (!_checkUUIDs(uuids)) throw "BTLEBlinkUp() requires the service UUID table to contain specific key names";
         _uuids = uuids;
 
-        // Set the BLE radio pins, either to the passed in values, or the defaults
-        // Defaults to the imp004m Breakout Board
-        _pin_LPO_IN = lpoPin != null ? lpoPin : hardware.pinE;
-        _pin_BT_REG_ON = regonPin != null ? regonPin : hardware.pinJ;
-        _uart = uart != null ? uart : hardware.uartFGJH;
+        _impType = imp.info().type;
+        if (_impType == "imp004m") {
+            // Set the BLE radio pins, either to the passed in values, or the defaults
+            // Defaults to the imp004m Breakout Board
+            _pin_LPO_IN = lpoPin != null ? lpoPin : hardware.pinE;
+            _pin_BT_REG_ON = regonPin != null ? regonPin : hardware.pinJ;
+            _uart = uart != null ? uart : hardware.uartFGJH;
+        } else {
+            _pin_LPO_IN = null;
+            _pin_BT_REG_ON = null;
+            _uart = null;
+        }
 
         // Initialize the radio
         _init(firmware);
@@ -470,9 +479,12 @@ class BTLEBlinkUp {
      *
      */
     function _init(firmware) {
-        // NOTE These require a suitably connected module - we can't check for that here
-        _pin_LPO_IN.configure(DIGITAL_OUT, 0);
-        _pin_BT_REG_ON.configure(DIGITAL_OUT, 1);
+        // FROM 2.0.0, support imp006 by partitioning imp004m-specific settings
+        if (_impType == "imp004m") {
+            // NOTE These require a suitably connected module - we can't check for that here
+            _pin_LPO_IN.configure(DIGITAL_OUT, 0);
+            _pin_BT_REG_ON.configure(DIGITAL_OUT, 1);
+        }
 
         // Scan for WiFi networks around the device
         local now = hardware.millis();
@@ -533,7 +545,8 @@ class BTLEBlinkUp {
 
         try {
             // Instantiate Bluetooth LE
-            ble = hardware.bluetooth.open(_uart, firmware);
+            // FROM 2.0.0 - use separate calls for imp004m and imp006
+            ble = _impType == "imp004m" ? hardware.bluetooth.open(_uart, firmware) : hardware.bluetooth.open(firmware);
         } catch (err) {
             throw "BLE failed to initialize (error: " + err + ")";
         }

Diff for: tests/ble_setup.device.test.nut

@@ -0,0 +1,63 @@
+/**
+ * BLEBlinkUp Library test cases
+ * Configuration with enable pin
+ */
+
+@include "github:electricimp/BluetoothFirmware/bt_firmware.lib.nut"
+@include "github:electricimp/BTLEBlinkUp/btleblinkup.device.lib.nut@develop"
+
+class BLESetupTestCase extends ImpTestCase {
+
+    _ble = null;
+    _iType = null;
+    _isCompatible = false;
+
+    /**
+     * Get the imp Type (impp04m or imp006)
+     */
+    function setUp() {
+
+        // Get the test imp’s type and report
+        _iType = imp.info().type;
+        this.info("Test running on an " + _iType);
+
+        // Check that the imp is compatible
+        _isCompatible = (_iType == "imp006" || _iType == "imp004m");
+        this.assertTrue(_isCompatible, "Test run on an incompatible imp");
+        return "Test running on a compatible imp";
+    }
+
+    /**
+     * Test sensor readout in async mode
+     */
+    function testBLEInitReadout() {
+
+        // Instantiate Bluetooth on a compatible device
+        if (_isCompatible) {
+            _ble = BTLEBlinkUp(_initUUIDs(), (this._iType == "imp004m" ? BT_FIRMWARE.CYW_43438 : BT_FIRMWARE.CYW_43455));
+
+            local result = (_ble != null);
+            this.assertTrue(result, "BLEBlinkUp NOT running on " + this._iType);
+            return "BLEBlinkUp running";
+        }
+
+        this.assertTrue(_isCompatible, "Test run on an incompatible imp");
+        return;
+    }
+
+    // Auxilliary funtion to set the GATT service UUIDs we wil use
+    // NOTE Take from the Bluetooth BlinkUp sample code
+    function _initUUIDs() {
+        local uuids = {};
+        uuids.blinkup_service_uuid    <- "FADA47BEC45548C9A5F2AF7CF368D719";
+        uuids.ssid_setter_uuid        <- "5EBA195632D347C681A6A7E59F18DAC0";
+        uuids.password_setter_uuid    <- "ED694AB947564528AA3A799A4FD11117";
+        uuids.planid_setter_uuid      <- "A90AB0DC7B5C439A9AB52107E0BD816E";
+        uuids.token_setter_uuid       <- "BD107D3E48784F6DAF3DDA3B234FF584";
+        uuids.blinkup_trigger_uuid    <- "F299C3428A8A4544AC4208C841737B1B";
+        uuids.wifi_getter_uuid        <- "57A9ED95ADD54913849457759B79A46C";
+        uuids.wifi_clear_trigger_uuid <- "2BE5DDBA32864D09A652F24FAA514AF5";
+        return uuids;
+    }
+
+}