microbit-web-bluetooth - npm Package Compare versions

Comparing version 0.6.1-next.ebc782c.0 to 0.6.1-next.f1ed1d3.0

documentation.md

@@ -23,36 +23,38 @@ # micro:bit Web Bluetooth
 
-|Service|[no-magnet-no-io](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-no-magnet-no-io.hex)|[no-magnet-no-uart](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-no-magnet-no-uart.hex)|[no-event-no-uart-no-dfu](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-no-event-no-uart-no-dfu.hex)|[no-event-no-io-no-temp-no-acc](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-no-event-no-io-no-temp-no-acc.hex)|
-|---|---|---|---|---|
-|Device Info|✓|✓|✓|✓|
-|Button|✓|✓|✓|✓|
-|LED|✓|✓|✓|✓|
-|Temperature|✓|✓|✓|-|
-|Accelerometer|✓|✓|✓|-|
-|Event|✓|✓|-|-|
-|DFU|✓|✓|-|✓|
-|UART|✓|-|-|✓|
-|Magnetometer|-|-|✓|✓|
-|IO Pin|-|✓|✓|-|
+The first image targets the new micro:bit v2 while older micro:bit v1 versions exist for backwards compatibility:
 
-The source for a sample program to do this is [available here](https://github.com/lancaster-university/microbit-samples/tree/master/source/examples/bluetooth-services).
+|Service|[microbit-universal](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-microbit-universal.hex)|[no-magnet-no-io](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-no-magnet-no-io.hex)|[no-magnet-no-uart](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-no-magnet-no-uart.hex)|[no-event-no-uart-no-dfu](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-no-event-no-uart-no-dfu.hex)|[no-event-no-io-no-temp-no-acc](https://github.com/thegecko/microbit-web-bluetooth/blob/master/hex/ble-open-no-event-no-io-no-temp-no-acc.hex)|
+|---|---|---|---|---|---|
+|Device Info|✓|✓|✓|✓|✓|
+|Button|✓|✓|✓|✓|✓|
+|LED|✓|✓|✓|✓|✓|
+|Temperature|✓|✓|✓|✓|-|
+|Accelerometer|✓|✓|✓|✓|-|
+|Event|✓|✓|✓|-|-|
+|DFU|✓|✓|✓|-|✓|
+|UART|✓|✓|-|-|✓|
+|Magnetometer|✓|-|-|✓|✓|
+|IO Pin|✓|-|✓|✓|-|
 
-__Note:__ The configuration must mark `bluetooth` as being `open` in order for Web Bluetooth to work. e.g.:
+The source for these sample programs is based on the [codal example](https://github.com/lancaster-university/microbit-v2-samples/) with the [main.cpp](https://github.com/thegecko/microbit-web-bluetooth/blob/master/examples/main.cpp) file as [outlined in the examples](https://github.com/thegecko/microbit-web-bluetooth/blob/master/examples).
 
+__Note:__ The `codal.json` configuration must mark `bluetooth` as being `open` in order for Web Bluetooth to work. e.g.:
+
 ```json
 {
-    "microbit-dal": {
-        "bluetooth": {
-            "enabled": 1,
-            "pairing_mode": 1,
-            "private_addressing": 0,
-            "open": 1,
-            "whitelist": 1,
-            "advertising_timeout": 0,
-            "tx_power": 0,
-            "dfu_service": 0,
-            "event_service": 1,
-            "device_info_service": 1,
-            "security_level": "SECURITY_MODE_ENCRYPTION_NO_MITM"
-        },
-        "gatt_table_size": "0x700"
+    "target": {
+        "name": "codal-microbit",
+        "url": "https://github.com/microbit-foundation/codal-microbit",
+        "branch": "master",
+        "type": "git",
+        "test_ignore": true,
+        "dev": true
+    } ,
+    "config":{
+        "DEVICE_BLE": 1,
+        "MICROBIT_BLE_ENABLED" : 1,
+        "MICROBIT_BLE_OPEN" : 1,
+        "MICROBIT_BLE_DFU_SERVICE": 1,
+        "MICROBIT_BLE_EVENT_SERVICE" : 1,
+        "MICROBIT_BLE_DEVICE_INFORMATION_SERVICE": 1
     }
@@ -59,0 +61,0 @@ }

package.json

 {
   "name": "microbit-web-bluetooth",
-  "version": "0.6.1-next.ebc782c.0",
+  "version": "0.6.1-next.f1ed1d3.0",
   "description": "Web Bluetooth library for micro:bit",
@@ -5,0 +5,0 @@ "homepage": "https://github.com/thegecko/microbit-web-bluetooth",

README.md

@@ -9,2 +9,4 @@ # micro:bit Web Bluetooth
 
+See the [microbit-web-components library](https://github.com/thegecko/microbit-web-components) for some ready-to-use web components which use this library.
+
 ## Prerequisites
@@ -11,0 +13,0 @@

No alert changes

Improved metrics

Total package byte prevSize

1328921

increased by0.26%

Number of package files

76

increased by1.33%

Number of lines in readme file

81

increased by2.53%

No dependency changes