├── examples └── get_scale_data.js ├── package.json ├── .gitignore ├── README.md ├── index.js └── LICENSE /examples/get_scale_data.js: -------------------------------------------------------------------------------- 1 | let MiScale = require('../index.js'); 2 | 3 | let miscale = new MiScale(); 4 | 5 | miscale.startScanning(); 6 | 7 | miscale.on('data', function (scale) { 8 | console.log(scale); 9 | }); 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "node-xiaomi-scale", 3 | "version": "0.0.4", 4 | "description": "Node.JS library for Mi scale.", 5 | "main": "index.js", 6 | "scripts": { 7 | "test": "mocha" 8 | }, 9 | "repository": { 10 | "type": "git", 11 | "url": "git+https://github.com/perillamint/node-xiaomi-scale.git" 12 | }, 13 | "keywords": [ 14 | "xiaomi", 15 | "ble", 16 | "scale" 17 | ], 18 | "author": "perillamint", 19 | "license": "LGPL-3.0", 20 | "bugs": { 21 | "url": "https://github.com/perillamint/node-xiaomi-scale/issues" 22 | }, 23 | "homepage": "https://github.com/perillamint/node-xiaomi-scale#readme", 24 | "dependencies": { 25 | "noble": "^1.6.0" 26 | }, 27 | "devDependencies": { 28 | "mocha": "" 29 | } 30 | } 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | 6 | # Runtime data 7 | pids 8 | *.pid 9 | *.seed 10 | 11 | # Directory for instrumented libs generated by jscoverage/JSCover 12 | lib-cov 13 | 14 | # Coverage directory used by tools like istanbul 15 | coverage 16 | 17 | # nyc test coverage 18 | .nyc_output 19 | 20 | # Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) 21 | .grunt 22 | 23 | # node-waf configuration 24 | .lock-wscript 25 | 26 | # Compiled binary addons (http://nodejs.org/api/addons.html) 27 | build/Release 28 | 29 | # Dependency directories 30 | node_modules 31 | jspm_packages 32 | 33 | # Optional npm cache directory 34 | .npm 35 | 36 | # Optional REPL history 37 | .node_repl_history 38 | 39 | # Emacs 40 | ### Emacs ### 41 | # -*- mode: gitignore; -*- 42 | *~ 43 | \#*\# 44 | /.emacs.desktop 45 | /.emacs.desktop.lock 46 | *.elc 47 | auto-save-list 48 | tramp 49 | .\#* 50 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # node-xiaomi-scale 2 | ![Dependencies](https://david-dm.org/perillamint/node-xiaomi-scale.svg) 3 | 4 | ## MiScale class 5 | ### Constructor 6 | constructor optionally accepts mac address string. If string is given, it only emits data from given address. 7 | 8 | ### MiScale.startScanning() 9 | Start BLE scan and search for Mi scale. 10 | 11 | ### MiScale.stopScanning() 12 | Stop BLE scan. 13 | 14 | ### MiScale.on('data', function cb(scale)) 15 | If nearby Mi Scale is scanned and if it met given criteria (matching mac address, not a duplicated entry), it emits its data using 'data' event. 16 | 17 | #### scale.address 18 | Bluetooth address of Mi Scale. 19 | 20 | #### scale.svcUUID 21 | Mi Scale service uuid. 22 | 23 | #### scale.svcData 24 | Raw Mi Scale service data. 25 | 26 | #### scale.manufacturerData 27 | Raw Mi Scale manufacturer data. 28 | 29 | #### scale.isStabilized 30 | If scale reading is stabilized, This flag will set to true. 31 | 32 | #### scale.loadRemoved 33 | If weight on scale is removed, This flag will set to true. 34 | 35 | #### scale.unit 36 | Measurement unit. 37 | 38 | #### scale.sequence 39 | Sequence number. 40 | 41 | ## Thanks to 42 | https://github.com/chaeplin, who built Xiaomi scale protocol parser prototype with Python. (https://github.com/chaeplin/Xiaomi_scale_scan) 43 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const EventEmitter = require('events'); 2 | var noble = require('noble'); 3 | 4 | class MiScale extends EventEmitter { 5 | constructor(macAddr) { 6 | super(); 7 | let self = this; 8 | 9 | this._macAddr = macAddr; 10 | this._scales = new Array(); 11 | 12 | noble.on('discover', function (foo) { 13 | self._nobleDiscoverListener(foo); 14 | }); 15 | }; 16 | 17 | _scaleListener(peripheral) { 18 | let scale = new Object(); 19 | 20 | scale.address = peripheral.address; 21 | 22 | if (peripheral.advertisement.serviceData.length === 0) { 23 | return; 24 | } 25 | 26 | // Assume only single service is available on scale. 27 | scale.svcUUID = peripheral.advertisement.serviceData[0].uuid; 28 | scale.svcData = peripheral.advertisement.serviceData[0].data; 29 | scale.manufacturerData = peripheral.advertisement.manufacturerData; 30 | 31 | //Is it duplicated packet? 32 | if(this._scales[scale.address] && 33 | this._scales[scale.address].svcData.compare(scale.svcData) == 0) { 34 | return; 35 | } 36 | 37 | //Save scale object in duplication lookup table. 38 | this._scales[scale.address] = scale; 39 | 40 | //Parse service data. 41 | let svcData = scale.svcData; 42 | 43 | scale.isStabilized = ((svcData[0] & (1<<5)) !== 0) ? true : false; 44 | scale.loadRemoved = ((svcData[0] & (1<<7)) !== 0) ? true : false; 45 | 46 | if((svcData[0] & (1<<4)) !== 0) { // Chinese Catty 47 | scale.unit = "jin"; 48 | } else if ((svcData[0] & 0x0F) === 0x03) { // Imperial pound 49 | scale.unit = "lbs"; 50 | } else if ((svcData[0] & 0x0F) === 0x02) { // MKS kg 51 | scale.unit = "kg"; 52 | } else { 53 | throw new Error("Invalid data!"); 54 | } 55 | 56 | scale.weight = svcData.readUInt16LE(1) / 100; 57 | scale.sequence = svcData.readUInt16BE(8); 58 | 59 | if(scale.unit === "kg") { //Convert chinese Catty to kg. 60 | scale.weight /= 2; 61 | } 62 | 63 | this.emit('data', scale); 64 | }; 65 | 66 | _nobleDiscoverListener(peripheral) { 67 | if(this._macAddr != undefined) { 68 | if(peripheral.address == this._macAddr && 69 | peripheral.advertisement.localName === "MI_SCALE") { 70 | // Matched! 71 | this._scaleListener(peripheral); 72 | } 73 | } else { 74 | // Match any Xiaomi scale and send event. 75 | if(peripheral.advertisement.localName === "MI_SCALE") { 76 | //Matched! 77 | this._scaleListener(peripheral); 78 | } 79 | } 80 | }; 81 | 82 | startScanning() { 83 | noble.on('stateChange', function(state) { 84 | if (state === 'poweredOn') { 85 | noble.startScanning([], true); 86 | } 87 | }); 88 | }; 89 | 90 | stopScanning() { 91 | noble.stopScanning(); 92 | }; 93 | }; 94 | 95 | module.exports = MiScale; 96 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | --------------------------------------------------------------------------------