├── .gitignore ├── LICENSE ├── README.md ├── config.js ├── index.js ├── package.json └── topicCharacteristic.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | MQTT2BLE 2 | ---------- 3 | 4 | A way to bridge MQTT topics to BLE Gatt characteristics 5 | 6 | run: 7 | node index.js -c config.js 8 | 9 | Where config.js looks like this: 10 | 11 | module.exports = { 12 | broker: "mqtt://localhost", 13 | topic: "some/topic" 14 | } 15 | 16 | 17 | The primary serivce UUID is 18 | 19 | ba42561bb1d2440a8d040cefb43faece 20 | 21 | and the topic charactristic is 22 | 23 | 6bcb06e2747542a9a62a54a1f3ce11e6 24 | 25 | Background 26 | ----------- 27 | 28 | There is a blog post that describes how I built this code here: 29 | http://www.hardill.me.uk/wordpress/2015/07/28/building-bluetooth-le-devices/ 30 | 31 | And another post about building a simple Android App to work with it here: 32 | http://www.hardill.me.uk/wordpress/2015/08/11/mqtt2ble-android-test-app/ 33 | 34 | 35 | Known issues 36 | ------------- 37 | 38 | You have to be careful that the payload fits in the MTU 39 | 40 | #### Running without root/sudo 41 | 42 | Run the following command in the directory you ran ```npm install``` from: 43 | 44 | ```sh 45 | find -path '*bleno*Release/hci-ble' -exec sudo setcap cap_net_raw+eip '{}' \; 46 | ``` 47 | 48 | This grants bleno's ```hci-ble``` binary ```cap_net_raw``` privileges, so it can start/stop BLE advertising. 49 | 50 | __Note:__ The above command requires ```setcap``` to be installed, it can be installed using the following: 51 | 52 | * apt: ```sudo apt-get install libcap2-bin``` 53 | * yum: ```su -c \'yum install libcap2-bin\'``` 54 | -------------------------------------------------------------------------------- /config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | broker: 'mqtt://localhost', 3 | topic: 'ble' 4 | } -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var util = require('util'); 2 | var bleno = require('bleno'); 3 | var path = require('path'); 4 | var mqtt = require('mqtt'); 5 | 6 | var BlenoPrimarySerivce = bleno.PrimaryService; 7 | 8 | var TopicCharacteristic = require('./topicCharacteristic'); 9 | 10 | var config; 11 | var cwd = process.cwd(); 12 | 13 | var args = process.argv; 14 | 15 | if (args) { 16 | if (args[0] == '-c') { 17 | if (args[1].indexOf('/') === 0) { 18 | config = require(args[1]); 19 | } else { 20 | config = require(path.join(cwd, args[1])); 21 | } 22 | } else { 23 | config = require(path.join(cwd, 'config.js')); 24 | } 25 | } 26 | 27 | if (!config) { 28 | console.log("Must provide a config.js"); 29 | process.exit(); 30 | } 31 | 32 | var client = mqtt.connect(config.broker); 33 | 34 | var topicCharacteristic = new TopicCharacteristic(config); 35 | 36 | client.on('connect', function(){ 37 | client.subscribe(config.topic); 38 | }); 39 | 40 | client.on('message',function(topic, message){ 41 | console.log(message.toString()); 42 | topicCharacteristic.update(message); 43 | }); 44 | 45 | bleno.on('stateChange', function(state){ 46 | if (state === 'poweredOn') { 47 | bleno.startAdvertising('mqtt', ['ba42561bb1d2440a8d040cefb43faece']); 48 | } else { 49 | bleno.stopAdvertising(); 50 | } 51 | }); 52 | 53 | bleno.on('advertisingStart', function(error){ 54 | if(!error) { 55 | bleno.setServices([ 56 | new BlenoPrimarySerivce({ 57 | uuid: 'ba42561bb1d2440a8d040cefb43faece', 58 | characteristics: [ 59 | topicCharacteristic 60 | ] 61 | }) 62 | ]); 63 | } 64 | }); -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "mqtt2ble", 3 | "version": "0.0.2", 4 | "description": "Bridge a MQTT topic to BLE Gatt Service", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "echo \"Error: no test specified\" && exit 1" 8 | }, 9 | "keywords": [ 10 | "BLE", 11 | "MQTT" 12 | ], 13 | "contributors": [ 14 | { 15 | "name": "Benjamin Hardill", 16 | "email": "hardillb@gmail.com", 17 | "url": "http://www.hardill.me.uk/wordpress/" 18 | } 19 | ], 20 | "license": "APACHE-2.0", 21 | "dependencies": { 22 | "bleno": "~0.1.14", 23 | "mqtt": "~1.3.5" 24 | }, 25 | "repository": "https://github.com/hardillb/mqtt2ble", 26 | "bin": { 27 | "mqtt2ble": "index.js" 28 | } 29 | } 30 | -------------------------------------------------------------------------------- /topicCharacteristic.js: -------------------------------------------------------------------------------- 1 | var util = require('util'); 2 | var bleno = require('bleno'); 3 | 4 | function TopicCharacteristic(config, client) { 5 | bleno.Characteristic.call(this, { 6 | uuid: '6bcb06e2747542a9a62a54a1f3ce11e6', 7 | properties: ['read', 'write', 'notify'], 8 | descriptors: [ 9 | new bleno.Descriptor({ 10 | uuid: '2901', 11 | value: 'Topic: ' + config.topic 12 | }) 13 | ] 14 | }); 15 | 16 | this._value = new Buffer(0); 17 | this._updateValueCallback = null; 18 | this._client = client; 19 | this._topic = config.topic; 20 | } 21 | 22 | util.inherits(TopicCharacteristic, bleno.Characteristic); 23 | 24 | TopicCharacteristic.prototype.onWriteRequest = function(data, offset, withoutResponse, callback) { 25 | this._value = data; 26 | 27 | this._client.publish(this._topic, data); 28 | 29 | callback(this.RESULT_SUCCESS); 30 | } 31 | 32 | 33 | TopicCharacteristic.prototype.onReadRequest = function(offset, callback) { 34 | console.log("READING: " + this._value.toString()); 35 | console.log("OFFSET: " + offset); 36 | callback(this.RESULT_SUCCESS, this._value); 37 | } 38 | 39 | TopicCharacteristic.prototype.onSubscribe = function(maxValueSize, updateValueCallback) { 40 | this._updateValueCallback = updateValueCallback; 41 | } 42 | 43 | TopicCharacteristic.prototype.onUnsubscribe = function () { 44 | this._updateValueCallback = null; 45 | } 46 | 47 | TopicCharacteristic.prototype.update = function(value) { 48 | this._value = value; 49 | console.log(this._value.toString()); 50 | if (this._updateValueCallback) { 51 | this._updateValueCallback(this._value); 52 | } 53 | } 54 | 55 | module.exports = TopicCharacteristic; 56 | --------------------------------------------------------------------------------