├── .gitignore ├── README.md ├── mi_band_1a.py └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | env/ 12 | build/ 13 | develop-eggs/ 14 | dist/ 15 | downloads/ 16 | eggs/ 17 | .eggs/ 18 | lib/ 19 | lib64/ 20 | parts/ 21 | sdist/ 22 | var/ 23 | wheels/ 24 | *.egg-info/ 25 | .installed.cfg 26 | *.egg 27 | 28 | # PyInstaller 29 | # Usually these files are written by a python script from a template 30 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 31 | *.manifest 32 | *.spec 33 | 34 | # Installer logs 35 | pip-log.txt 36 | pip-delete-this-directory.txt 37 | 38 | # Unit test / coverage reports 39 | htmlcov/ 40 | .tox/ 41 | .coverage 42 | .coverage.* 43 | .cache 44 | nosetests.xml 45 | coverage.xml 46 | *.cover 47 | .hypothesis/ 48 | 49 | # Translations 50 | *.mo 51 | *.pot 52 | 53 | # Django stuff: 54 | *.log 55 | local_settings.py 56 | 57 | # Flask stuff: 58 | instance/ 59 | .webassets-cache 60 | 61 | # Scrapy stuff: 62 | .scrapy 63 | 64 | # Sphinx documentation 65 | docs/_build/ 66 | 67 | # PyBuilder 68 | target/ 69 | 70 | # Jupyter Notebook 71 | .ipynb_checkpoints 72 | 73 | # pyenv 74 | .python-version 75 | 76 | # celery beat schedule file 77 | celerybeat-schedule 78 | 79 | # SageMath parsed files 80 | *.sage.py 81 | 82 | # dotenv 83 | .env 84 | 85 | # virtualenv 86 | .venv 87 | venv/ 88 | ENV/ 89 | 90 | # Spyder project settings 91 | .spyderproject 92 | .spyproject 93 | 94 | # Rope project settings 95 | .ropeproject 96 | 97 | # mkdocs documentation 98 | /site 99 | 100 | # mypy 101 | .mypy_cache/ 102 | 103 | # Generated CSV files 104 | *.csv 105 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # pymb1a 2 | Python class to communicate with Xiaomi Mi band 1A fitness tracker. 3 | Should works on Python 3.4 under Linux OS (Ubuntu and Raspian). 4 | 5 | I mainly use : 6 | - Bluetooth sniffing with Wireshark 7 | - [Gadgetbridge](https://github.com/Freeyourgadget/Gadgetbridge) logs file, source code and community. 8 | - [bluepy](https://github.com/IanHarvey/bluepy) as a Bluetooth Low Energy library 9 | 10 | Thanks to all. 11 | 12 | 13 | ## Requirements 14 | You have to install [bluepy](https://github.com/IanHarvey/bluepy). 15 | ``` 16 | pip3 install bluepy 17 | ``` 18 | 19 | 20 | ## Installation 21 | Download the main class file and add it to your project 22 | 23 | 24 | ## Usage 25 | Import the class 26 | ```python 27 | import mi_band_1a 28 | ``` 29 | 30 | Instanciate object with user informations 31 | ```python 32 | mb1a = MiBand1A(gender=2, age=25, height=175, weight=70, alias="jbegood", which_hand=0, keep_data=True) 33 | ``` 34 | 35 | Scan with a 5s timeout all good device close enought with a -80 dBm RSSI threshold 36 | ```python 37 | if mb1a.scan_and_connect(5.0, ["c8:0f:10:01:02:03", "c8:0f:10:04:05:06"], -80) == True: 38 | # do the rest (get characteristics, subscribe notifications, read/write informations, authenticate, activity/sensor data...) 39 | ``` 40 | 41 | Get useful services and characteristics 42 | ```python 43 | mb1a.get_services_and_characteristics() 44 | ``` 45 | 46 | Subscribe to useful notifications 47 | ```python 48 | mb1a.subscribe_to_notifications() 49 | ``` 50 | 51 | Read some public informations 52 | ```python 53 | print(" + device_info : ", mb1a.read_device_info() ) 54 | print(" + date_time : ", mb1a.read_date_time() ) 55 | print(" + battery : ", mb1a.read_battery() ) 56 | print(" + realtime_steps : ", mb1a.read_realtime_steps() ) 57 | ``` 58 | 59 | Vibrate during 0.5s 60 | ```python 61 | mb1a.vibrate(0.5) 62 | ``` 63 | 64 | Flash leds" 65 | ```python 66 | mb1a.flash_leds() 67 | ``` 68 | 69 | Authenticate in order to read private informations (activity data and sensor data) 70 | ```python 71 | print(" + authenticate success : ", mb1a.authenticate() ) 72 | ``` 73 | 74 | Fetch activity data, decode it to read the steps recorded inside 75 | ```python 76 | print(" + activity data steps recorded : ", mb1a.fetch_activity_data("dump_activity_data.csv") ) 77 | ``` 78 | 79 | Read and record about 300 sensor data samples in a CSV file (a little bit more actually) 80 | ```python 81 | mb1a.record_sensor_data("dump_sensor_data.csv", 300) 82 | ``` 83 | 84 | Finally disconnect to the device 85 | ```python 86 | mb1a.disconnect() 87 | ``` 88 | 89 | 90 | ## To do list 91 | Basic informations roadmap : 92 | - read basic informations 93 | - ~~battery~~ 94 | - ~~realtime steps~~ 95 | - date time 96 | - device informations 97 | - device name 98 | - goal 99 | - write basic informations 100 | - date time 101 | - device name 102 | - goal 103 | - ~~vibrate the wrist~~ 104 | - ~~light on/off leds~~ 105 | 106 | Security informations roadmap : 107 | - ~~handle pairing (for now you have to pair the device manually before using this class using bluetooth manager)~~ 108 | - ~~authenticate to access private data (activity data and sensor data)~~ 109 | 110 | Sensor data roadmap : 111 | - ~~read sensor data (accelerometer raw value)~~ 112 | - ~~analyse and record sensor data (accelerometer raw value) in a CSV file~~ 113 | 114 | Activity data roadmap : 115 | - ~~read activity data (steps, sleep) recorded in the device~~ 116 | - ~~analyse and count steps contained in activity data~~ 117 | - analyse sleep informations contained in activity data 118 | - ~~analyse and record sensor data (accelerometer raw value) in a CSV file~~ 119 | 120 | Other roadmap 121 | - create a pip package 122 | - write documentation 123 | 124 | 125 | ## Changelog 126 | Release 0.1.0 127 | - first release 128 | - read basic informations like battery, realtime steps 129 | - can read and record in a CSV file raw value from accelerometer 130 | - can read and count steps done in activity data recorded in the device 131 | -------------------------------------------------------------------------------- /mi_band_1a.py: -------------------------------------------------------------------------------- 1 | """ 2 | @brief Python class to communicate with the Xiaomi Mi Band 1A 3 | @author David SALLE 4 | @date 10/05/2017 5 | @version 0.1.0 6 | @licence GPLv3 7 | """ 8 | 9 | # Standard librairies 10 | import time 11 | import math 12 | import datetime 13 | 14 | # Other library (need a custom installation: pip3 install bluepy) 15 | import bluepy 16 | 17 | 18 | class MiBand1A(bluepy.btle.DefaultDelegate): 19 | """MiBand1A class 20 | """ 21 | def __init__(self, gender, age, height, weight, alias, which_hand, keep_data): 22 | """Constructor method to initialise everything useful 23 | @param {MiBand1A} self 24 | @param {integer} gender (0=female, 1=man, 2=other) 25 | @param {integer} age 26 | @param {integer} height in cm (e.g.: 175) 27 | @param {integer} weight in kg (e.g.: 75) 28 | @param {string} alias user name (ex: "jbegood") 29 | @param {integer} which_hand (left=0, right=1) 30 | @param {boolean} keep_data inside the MiBand ? 31 | @return None 32 | """ 33 | # Call the super class constructor 34 | bluepy.btle.DefaultDelegate.__init__(self) 35 | 36 | # Some initializations 37 | self.gender = gender 38 | self.age = age 39 | self.height = height 40 | self.weight = weight 41 | self.alias = alias 42 | self.which_hand = which_hand 43 | self.keep_data = keep_data 44 | 45 | self.bluetooth_address = None 46 | self.device = None 47 | self.sensor_data_csv_file = None 48 | self.activity_data_csv_file = None 49 | self.sensor_data = None 50 | self.gravity = 9.81 51 | self.scale_factor = 1000 52 | self.authentication_ended = False 53 | self.authentication_ok = False 54 | self.upload_in_progress = False 55 | self.activity_data = [] 56 | self.ack_messages = [] 57 | self.data_block_datak_counter = 0 58 | 59 | 60 | def handleDiscovery(self, dev, is_new_dev, is_new_data): 61 | """Method to handle discovery of new BLE devices 62 | @param {MiBand1A} self 63 | @param {ScanEntry} dev 64 | @param {boolean} is_new_dev 65 | @param {boolean} isNewData 66 | @return None 67 | """ 68 | if is_new_dev: 69 | print(" + Discovered device : address=%s rssi=%d dBm" % (dev.addr, dev.rssi) ) 70 | elif is_new_data: 71 | print(" + Received new data from", dev.addr) 72 | 73 | 74 | def scan_and_connect(self, timeout, bluetooth_addresses, rssi_threshold): 75 | """Method to scan and connect to a chosen and close BLE device 76 | @param {MiBand1A} self 77 | @param {float} timeout 78 | @param {string list} white liste bluetooth_addresses 79 | @param {integer} rssi_threshold 80 | @return {string} bluetooth_address of the connected device or None 81 | """ 82 | # Start scanning for devices to connect to 83 | self.scanner = bluepy.btle.Scanner().withDelegate(self) 84 | devices = self.scanner.scan(timeout) 85 | 86 | # Is a Mi Band inside the ScanEntry list after scanning 87 | for dev in devices: 88 | for bluetooth_address in bluetooth_addresses: 89 | if dev.addr == bluetooth_address and dev.rssi > rssi_threshold: 90 | print(" + Found a Mi Band 1A in the wish list, try to connect to", dev.addr) 91 | self.bluetooth_address = dev.addr 92 | 93 | # Connect to the device 94 | self.device = bluepy.btle.Peripheral(self.bluetooth_address) 95 | 96 | # Lower security level to bypass pairing 97 | self.device.setSecurityLevel("medium") 98 | 99 | # Record us as a delegate to handle notifications 100 | self.device.setDelegate( self ) 101 | return True 102 | return False 103 | 104 | 105 | def disconnect(self): 106 | """Method to disconnect the device 107 | @param {MiBand1A} self 108 | @return None 109 | """ 110 | # Disconect the device (if already connected) 111 | if self.device is not None: 112 | self.device.disconnect() 113 | 114 | 115 | def get_services_and_characteristics(self): 116 | """Method to get services and charactestics needed to play with the Mi Band 117 | @param {MiBand1A} self 118 | @return None 119 | """ 120 | # Get useful services 121 | self.mili_service = self.device.getServiceByUUID("0000fee0-0000-1000-8000-00805f9b34fb") 122 | self.alert_service = self.device.getServiceByUUID("00001802-0000-1000-8000-00805f9b34fb") 123 | 124 | # Get useful characteristics 125 | self.device_info_characteristic = self.mili_service.getCharacteristics("0000ff01-0000-1000-8000-00805f9b34fb")[0] 126 | self.device_name_characteristic = self.mili_service.getCharacteristics("0000ff02-0000-1000-8000-00805f9b34fb")[0] 127 | self.notification_characteristic = self.mili_service.getCharacteristics("0000ff03-0000-1000-8000-00805f9b34fb")[0] 128 | self.user_info_characteristic = self.mili_service.getCharacteristics("0000ff04-0000-1000-8000-00805f9b34fb")[0] 129 | self.control_point_characteristic = self.mili_service.getCharacteristics("0000ff05-0000-1000-8000-00805f9b34fb")[0] 130 | self.realtime_steps_characteristic = self.mili_service.getCharacteristics("0000ff06-0000-1000-8000-00805f9b34fb")[0] 131 | self.activity_data_characteristic = self.mili_service.getCharacteristics("0000ff07-0000-1000-8000-00805f9b34fb")[0] 132 | self.firmware_data_characteristic = self.mili_service.getCharacteristics("0000ff08-0000-1000-8000-00805f9b34fb")[0] 133 | self.le_params_characteristic = self.mili_service.getCharacteristics("0000ff09-0000-1000-8000-00805f9b34fb")[0] 134 | self.date_time_characteristic = self.mili_service.getCharacteristics("0000ff0a-0000-1000-8000-00805f9b34fb")[0] 135 | self.statistics_characteristic = self.mili_service.getCharacteristics("0000ff0b-0000-1000-8000-00805f9b34fb")[0] 136 | self.battery_characteristic = self.mili_service.getCharacteristics("0000ff0c-0000-1000-8000-00805f9b34fb")[0] 137 | self.test_characteristic = self.mili_service.getCharacteristics("0000ff0d-0000-1000-8000-00805f9b34fb")[0] 138 | self.sensor_data_characteristic = self.mili_service.getCharacteristics("0000ff0e-0000-1000-8000-00805f9b34fb")[0] 139 | self.pair_characteristic = self.mili_service.getCharacteristics("0000ff0f-0000-1000-8000-00805f9b34fb")[0] 140 | self.vibrate_characteristic = self.alert_service.getCharacteristics("00002a06-0000-1000-8000-00805f9b34fb")[0] 141 | 142 | 143 | def subscribe_to_notifications(self): 144 | """Method to subscribe to all interesting notification characteristics 145 | @param {MiBand1A} self 146 | @return None 147 | """ 148 | subscribe_command = bytes([0x01, 0x00]) 149 | 150 | notification_handle = self.notification_characteristic.getHandle() + 1 151 | self.device.writeCharacteristic(notification_handle, subscribe_command, withResponse=True) 152 | 153 | activity_data_handle = self.activity_data_characteristic.getHandle() + 1 154 | self.device.writeCharacteristic(activity_data_handle, subscribe_command, withResponse=True) 155 | 156 | sensor_data_handle = self.sensor_data_characteristic.getHandle() + 1 157 | self.device.writeCharacteristic(sensor_data_handle, subscribe_command, withResponse=True) 158 | 159 | 160 | def authenticate(self): 161 | """Method to authenticate user 162 | @param {MiBand1A} self 163 | @return {boolean} success or fail 164 | """ 165 | #data = bytes([0x27, 0x4e, 0x92, 0x06, 0x02, 0x19, 0xaf, 0x46, 0x00, 0x05, 0x00, 0x74, 0x65, 0x73, 0x74, 0x79, 0x00, 0x00, 0x00, 0x16]) 166 | data = self.generate_user_info(self.bluetooth_address, self.gender, self.age, self.height, self.weight, self.alias, self.which_hand, 5, 0) 167 | self.user_info_characteristic.write(data, True) 168 | timeout_counter = 0 169 | while self.authentication_ended == False and timeout_counter < 100: 170 | self.wait_for_notifications(0.1) 171 | timeout_counter += 1 172 | 173 | if timeout_counter < 100 and self.authentication_ok == True: 174 | return True 175 | else: 176 | return False 177 | 178 | 179 | def pair(self): 180 | """Method to manually pair device 181 | @param {MiBand1A} self 182 | @return {boolean} success or fail 183 | """ 184 | data = bytes([0x02]) 185 | self.pair_characteristic.write(data, True) 186 | return True 187 | 188 | 189 | def read_device_info(self): 190 | """Method to read the device information 191 | @param {MiBand1A} self 192 | @return {dict} device_information 193 | """ 194 | # TODO: decode data 195 | device_information = {} 196 | data = self.device_info_characteristic.read() 197 | return device_information 198 | 199 | 200 | def read_date_time(self): 201 | """Method to read date time in the wrist 202 | @param {MiBand1A} self 203 | @return {dict} date_time 204 | """ 205 | # Read date time characteristics as bytes 206 | data = self.date_time_characteristic.read() 207 | #print("DEBUG => ", data) 208 | 209 | # Analyse and decode bytes 210 | date_time = {} 211 | if len(data) == 7: 212 | year = data[1] + 2000 213 | month = data[2] + 1 214 | day = data[3] 215 | hour = data[4] 216 | minute = data[5] 217 | second = data[6] 218 | 219 | # Package all as a dictionary 220 | date_time = {"year":year, "month": month, "day": day, "hour": hour, "minute": minute, "second":second} 221 | return date_time 222 | 223 | 224 | def read_battery(self): 225 | """Method to read battery informations 226 | @param {MiBand1A} self 227 | @return {dict} battery_informations 228 | """ 229 | # Read date time characteristics as bytes 230 | data = self.battery_characteristic.read() 231 | #print("DEBUG => ", data) 232 | 233 | # Analyse and decode bytes 234 | battery_informations = {} 235 | if len(data) == 10: 236 | level = data[0] 237 | year = data[1] + 2000 238 | month = data[2] + 1 239 | day = data[3] 240 | hour = data[4] 241 | minute = data[5] 242 | second = data[6] 243 | cycles = 0xffff & (0xff & data[7] | (0xff & data[8]) << 8) 244 | status = data[9] 245 | 246 | # Package all as a dictionary 247 | battery_informations = {"level": level, "year":year, "month": month, "day": day, "hour": hour, "minute": minute, "second":second, "cycles": cycles, "status": status} 248 | 249 | return battery_informations 250 | 251 | 252 | def read_realtime_steps(self): 253 | """Method to read the realtime steps. Warning, Mi Band delete value everyday 254 | @param {MiBand1A} self 255 | @return {integer} realtime steps 256 | """ 257 | data = self.realtime_steps_characteristic.read() 258 | return int.from_bytes(data, byteorder='little') 259 | 260 | 261 | def enable_sensor_data(self): 262 | """Method to enable live sensor data from accelerometer 263 | @param {MiBand1A} self 264 | @return Nothing 265 | """ 266 | # Enable live sensor data 267 | on_command = bytes([0x12, 0x01]) 268 | self.control_point_characteristic.write(on_command, True) 269 | 270 | 271 | def disable_sensor_data(self): 272 | """Method to disable live sensor data from accelerometer 273 | @param {MiBand1A} self 274 | @return Nothing 275 | """ 276 | # Disable live sensor data 277 | off_command = bytes([0x12, 0x00]) 278 | self.control_point_characteristic.write(off_command, True) 279 | 280 | 281 | def read_sensor_data(self, timeout=1.0): 282 | """Method to read some raw sensor datafrom accelerometer 283 | @param {MiBand1A} self 284 | @param {float} timeout 285 | @return {byte list} Raw sensor data 286 | 287 | Sensor data means raw x-axis, y-axis and z-axis values 288 | """ 289 | # Waiting for sensor data 290 | self.wait_for_notifications(timeout) 291 | 292 | raw_data = [] 293 | for b in self.sensor_data: 294 | raw_data.append(b) 295 | return raw_data 296 | 297 | 298 | def record_sensor_data(self, csv_file_name, samples): 299 | """Method to read and record some sensor data in a CSV file 300 | @param {MiBand1A} self 301 | @param {string} csv_file_name where to record accelerometer data 302 | @param {int} samples number to record 303 | @return None 304 | 305 | Sensor data means raw x-axis, y-axis and z-axis values 306 | """ 307 | # Open CSV file 308 | self.sensor_data_csv_file = open(csv_file_name, "w") 309 | self.sensor_data_csv_file.write("x-axis;y-axis;z-axis\n") 310 | 311 | # Enable live sensor data 312 | on_command = bytes([0x12, 0x01]) 313 | self.control_point_characteristic.write(on_command, True) 314 | 315 | # Loop waiting for sensor data 316 | for i in range(0, samples): 317 | self.wait_for_notifications(1.0) 318 | 319 | # Disable live sensor data 320 | off_command = bytes([0x12, 0x00]) 321 | self.control_point_characteristic.write(off_command, True) 322 | 323 | # Close CSV file 324 | self.sensor_data_csv_file.close() 325 | 326 | 327 | def fetch_activity_data(self, csv_file_name=None): 328 | """Method to fetch activity data recorded in the Mi Band 329 | @param {MiBand1A} self 330 | @return {integer} steps done 331 | """ 332 | # Don't know what it is 333 | magic_command = bytes([0x01, 0x00]) 334 | magic_handle = self.realtime_steps_characteristic.getHandle() + 1 335 | self.device.writeCharacteristic(magic_handle, magic_command, withResponse=True) 336 | 337 | # Send the FETCH command 338 | fetch_command = bytes([0x06]) 339 | self.control_point_characteristic.write(fetch_command, True) 340 | 341 | # Wait for notification 342 | self.upload_in_progress = True 343 | while self.upload_in_progress == True: 344 | self.wait_for_notifications(1.0) 345 | 346 | # Analyse activity data and return steps done 347 | return self.analyse_activity_data(csv_file_name) 348 | 349 | 350 | def wait_for_notifications(self, timeout): 351 | """Method to wait for notifications to come 352 | @param {MiBand1A} self 353 | @param {float} timeout to wait in seconds 354 | @return None 355 | """ 356 | return self.device.waitForNotifications(timeout) 357 | 358 | 359 | def prepare_ack_message(self, data): 360 | """Method to prepare ack messages to delete or keep data in the Mi Band 361 | @param {MiBand1A} self 362 | @param {bytes} header data 363 | @return None 364 | """ 365 | # Prepare ack message 366 | self.data_block_datak_counter += 1 367 | year = data[1] 368 | month = data[2] 369 | day = data[3] 370 | hour = data[4] 371 | minute = data[5] 372 | second = data[6] 373 | bytes_transferred = ((data[10] * 256) + data[9]) * 3 374 | if self.keep_data == True: 375 | checksum_msb = (~bytes_transferred) & 0xff # Checksum formula if we do not want to delete data on wrist 376 | checksum_lsb = 0xff & (~bytes_transferred >> 8) 377 | else: 378 | checksum_msb = bytes_transferred & 0xff # Checksum if we want to delete data on wrist 379 | checksum_lsb = 0xff & (bytes_transferred >> 8) 380 | ack_message = bytes([0x0a, year, month, day, hour, minute, second, checksum_msb, checksum_lsb]) 381 | 382 | if self.data_block_datak_counter > 1: 383 | self.ack_messages.append(ack_message) 384 | 385 | 386 | def analyse_activity_data(self, csv_file_name): 387 | """Method to analyse and decode activity data. 388 | @param {MiBand1A} self 389 | @param {string} csv_file_name 390 | @return {integer} steps done 391 | """ 392 | global_cursor = 0 393 | local_cursor = 0 394 | next_header = 0 395 | temp_header_data = [] 396 | temp_block_data = [] 397 | steps_counter = 0 398 | minutes_counter = 0 399 | end_of_analyse = False 400 | start_timestamp = 0 401 | 402 | # Open CSV file 403 | if csv_file_name is not None: 404 | activity_data_csv_file = open(csv_file_name, "w") 405 | activity_data_csv_file.write("timestamp;activity_type;intensity;steps\n") 406 | 407 | while end_of_analyse == False: 408 | # Analyse header block 409 | temp_header_data = self.activity_data[global_cursor:global_cursor+11] 410 | year = temp_header_data[1] + 2000 411 | month = temp_header_data[2] + 1 412 | day = temp_header_data[3] 413 | hour = temp_header_data[4] 414 | minute = temp_header_data[5] 415 | second = temp_header_data[6] 416 | start_date = datetime.datetime(year, month, day, hour, minute, second) 417 | start_timestamp = int((time.mktime(start_date.timetuple()) + start_date.microsecond/1000000.0)*1000) 418 | data_until_next_header = ((temp_header_data[10] * 256) + temp_header_data[9]) * 3 419 | global_cursor += 11 420 | 421 | if data_until_next_header == 0: 422 | end_of_analyse = True 423 | 424 | # Analyse data block 425 | local_cursor = 0 426 | while local_cursor < data_until_next_header: 427 | # Slice in 3 bytes blocks 428 | temp_block_data = self.activity_data[global_cursor:global_cursor+3] 429 | global_cursor += 3 430 | local_cursor += 3 431 | minutes_counter += 1 432 | if csv_file_name is not None: 433 | activity_data_csv_file.write("%d;%d;%d;%d\n" % (start_timestamp + (minutes_counter * 60), temp_block_data[0], temp_block_data[1], temp_block_data[2]) ) 434 | #print("%d | %d | %d | %d" % (start_timestamp + (minutes_counter * 60), temp_block_data[0], temp_block_data[1], temp_block_data[2]) ) 435 | if temp_block_data[2] > 0: 436 | steps_counter += temp_block_data[2] 437 | 438 | # Close CSV file if open before 439 | if csv_file_name is not None: 440 | activity_data_csv_file.close() 441 | 442 | return steps_counter 443 | 444 | 445 | def analyse_sensor_data(self, data): 446 | """Method to analyse and decode raw data from accelerometer (sensor data) 447 | @param {MiBand1A} self 448 | @param {bytes} data 449 | @return {float} acceleration in m^s-2 450 | """ 451 | # Memorize data in order to read_sensor_data to return it 452 | self.sensor_data = data 453 | 454 | # Analyse data 455 | counter = (data[1] * 256) + data[0] 456 | for idx in range(0, (len(data)-2) // 6): 457 | step = idx * 6 458 | x_raw_value = ((data[step+3] * 256) + data[step+2]) & 0x0fff 459 | x_sign = (data[step+3] & 0x30) >> 4 460 | x_type = (data[step+3] & 0xc0) >> 6 461 | if x_sign == 0: 462 | x_acc_value = x_raw_value 463 | else: 464 | x_acc_value = x_raw_value - 4096 465 | x_acc_value = (x_acc_value / self.scale_factor) * self.gravity 466 | #print("x_type=%d x_sign=%d x_raw_value=%d x_acc_value=%f" % (x_type, x_sign, x_raw_value, x_acc_value)) 467 | 468 | y_raw_value = ((data[step+5] * 256) + data[step+4]) & 0x0fff 469 | y_sign = (data[step+5] & 0x30) >> 4 470 | y_type = (data[step+5] & 0xc0) >> 6 471 | if y_sign == 0: 472 | y_acc_value = y_raw_value 473 | else: 474 | y_acc_value = y_raw_value - 4096 475 | y_acc_value = (y_acc_value / self.scale_factor) * self.gravity 476 | #print("y_type=%d y_sign=%d y_raw_value=%d y_acc_value=%f" % (y_type, y_sign, y_raw_value, y_acc_value)) 477 | 478 | z_raw_value = ((data[step+7] * 256) + data[step+6]) & 0x0fff 479 | z_sign = (data[step+7] & 0x30) >> 4 480 | z_type = (data[step+7] & 0xc0) >> 6 481 | if z_sign == 0: 482 | z_acc_value = z_raw_value 483 | else: 484 | z_acc_value = z_raw_value - 4096 485 | z_acc_value = (z_acc_value / self.scale_factor) * self.gravity 486 | #print("z_type=%d z_sign=%d z_raw_value=%d z_acc_value=%f" % (z_type, z_sign, z_raw_value, z_acc_value)) 487 | 488 | #millis = int(round(time.time() * 1000)) 489 | #print("%f | %f | %f " % (x_acc_value, y_acc_value, z_acc_value)) 490 | if self.sensor_data_csv_file is not None: 491 | self.sensor_data_csv_file.write("%f;%f;%f\n" % (x_acc_value, y_acc_value, z_acc_value)) 492 | 493 | 494 | def vibrate(self, duration=0.5): 495 | """Method to put device in vibration mode for a specified duration 496 | @param {MiBand1A} self 497 | @param {float} duration 498 | @return None 499 | """ 500 | # Start vibration 501 | start_command = bytes([0x01]) 502 | self.vibrate_characteristic.write(start_command, False) 503 | #start_command = bytes([0x08, 0x01]) 504 | #self.control_point_characteristic.write(start_command, True) 505 | 506 | # Wait 507 | time.sleep(duration) 508 | 509 | # Stop vibration 510 | stop_command = bytes([0x00]) 511 | self.vibrate_characteristic.write(stop_command, False) 512 | #stop_command = bytes([0x13]) 513 | #self.control_point_characteristic.write(stop_command, True) 514 | 515 | 516 | def flash_leds(self): 517 | """Method to flash the leds 518 | @param {MiBand1A} self 519 | @param {float} duration 520 | @return None 521 | """ 522 | # Start vibration 523 | led_on_command = bytes([0x0e, 0xff, 0xff, 0xff, 0x01]) 524 | self.control_point_characteristic.write(led_on_command, True) 525 | 526 | # Wait 527 | time.sleep(1.0) 528 | 529 | # Stop vibration 530 | led_off_command = bytes([0x0e, 0xff, 0xff, 0xff, 0x00]) 531 | self.control_point_characteristic.write(led_off_command, True) 532 | 533 | 534 | def compute_uid(self, alias): 535 | """Method to compute uid number from alias 536 | @param {MiBand1A} self 537 | @param {string} alias 538 | @return {integer} uid 539 | """ 540 | # Try to convert string to integer 541 | uid = None 542 | try: 543 | uid = int(alias) 544 | except ValueError: 545 | uid = self.compute_hash_code(alias) 546 | 547 | return uid 548 | 549 | 550 | def compute_hash_code(self, some_string): 551 | """Clone of the Java hashCode() function 552 | @param {MiBand1A} self 553 | @param {string} some_string 554 | @return {integer} hash 555 | """ 556 | hash = 0 557 | 558 | if (len(some_string) == 0): 559 | return hash; 560 | 561 | for i in range(0, len(some_string)): 562 | char = ord(some_string[i]) 563 | hash = ((hash << 5) - hash) + char 564 | hash = hash & hash # Convert to 32bit integer 565 | 566 | return hash 567 | 568 | 569 | def normalize(self, alias): 570 | """Normalize alias = max length of 8 char + fill empty byte with 0x00 571 | @param {MiBand1A} self 572 | @param {string} alias (maximum length=8) 573 | @return {byte list} normalized_alias 574 | """ 575 | # Prepare response by filling with 0x00 576 | normalized_alias = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00] 577 | 578 | # Limit 579 | limit = len(alias) 580 | if (limit > 8): 581 | limit = 8 582 | 583 | # Copy of alias in normalized_alias 584 | for i in range(0, limit): 585 | normalized_alias[i] = ord(alias[i]) 586 | 587 | # Return 588 | return normalized_alias 589 | 590 | 591 | def compute_crc8(self, sequence): 592 | """Compute CRC8 of a sequence of bytes (Maxim/Dallas formula) 593 | @param {MiBand1A} self 594 | @param {byte list} sequence 595 | @return {integer} crc8 596 | @see https://gist.github.com/eaydin/768a200c5d68b9bc66e7 597 | """ 598 | crc_table = ( 599 | 0, 94, 188, 226, 97, 63, 221, 131, 194, 156, 126, 32, 163, 253, 31, 65, 600 | 157, 195, 33, 127, 252, 162, 64, 30, 95, 1, 227, 189, 62, 96, 130, 220, 601 | 35, 125, 159, 193, 66, 28, 254, 160, 225, 191, 93, 3, 128, 222, 60, 98, 602 | 190, 224, 2, 92, 223, 129, 99, 61, 124, 34, 192, 158, 29, 67, 161, 255, 603 | 70, 24, 250, 164, 39, 121, 155, 197, 132, 218, 56, 102, 229, 187, 89, 7, 604 | 219, 133, 103, 57, 186, 228, 6, 88, 25, 71, 165, 251, 120, 38, 196, 154, 605 | 101, 59, 217, 135, 4, 90, 184, 230, 167, 249, 27, 69, 198, 152, 122, 36, 606 | 248, 166, 68, 26, 153, 199, 37, 123, 58, 100, 134, 216, 91, 5, 231, 185, 607 | 140, 210, 48, 110, 237, 179, 81, 15, 78, 16, 242, 172, 47, 113, 147, 205, 608 | 17, 79, 173, 243, 112, 46, 204, 146, 211, 141, 111, 49, 178, 236, 14, 80, 609 | 175, 241, 19, 77, 206, 144, 114, 44, 109, 51, 209, 143, 12, 82, 176, 238, 610 | 50, 108, 142, 208, 83, 13, 239, 177, 240, 174, 76, 18, 145, 207, 45, 115, 611 | 202, 148, 118, 40, 171, 245, 23, 73, 8, 86, 180, 234, 105, 55, 213, 139, 612 | 87, 9, 235, 181, 54, 104, 138, 212, 149, 203, 41, 119, 244, 170, 72, 22, 613 | 233, 183, 85, 11, 136, 214, 52, 106, 43, 117, 151, 201, 74, 20, 246, 168, 614 | 116, 42, 200, 150, 21, 75, 169, 247, 182, 232, 10, 84, 215, 137, 107, 53 615 | ) 616 | crc8 = 0x00 617 | 618 | for c in sequence: 619 | crc8 = crc_table[c ^ crc8] 620 | 621 | return crc8 622 | 623 | 624 | def generate_user_info(self, bluetooth_address, gender, age, height, weight, alias, which_hand, feature=5, appearance=0): 625 | """Generate a 20 bytes sequence from user informations to authenticate against the Mi Band 1A 626 | @param {MiBand1A} self 627 | @param {string} bluetooth_address 628 | @param {integer} gender 629 | @param {integer} age 630 | @param {integer} height 631 | @param {integer} weight 632 | @param {string} alias 633 | @param {integer} which_hand 634 | @param {integer} feature (MiBand_1A=5, MiBand_1S=4) 635 | @param {integer} appearance (noire=0) 636 | @return {Buffer} magic sequence that allow us to authenticate against Mi Band 637 | @see https://github.com/Freeyourgadget/Gadgetbridge/blob/e392fbfd800dc326aee2ac49e122a41ab223ab05/app/src/main/java/nodomain/freeyourgadget/gadgetbridge/devices/miband/UserInfo.java 638 | @see https://github.com/betomaluje/Mi-Band/blob/6542e34ec5f5b2190262558898ab72810f1b880f/MiBand/app/src/main/java/com/betomaluje/miband/model/UserInfo.java 639 | """ 640 | 641 | # Initialize response 642 | user_info = bytearray([0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00]) 643 | 644 | # Prepare UID section 645 | uid = self.compute_uid(alias); 646 | user_info[0] = (uid >> 0) & 0x000000ff # user ID 647 | user_info[1] = (uid >> 8) & 0x000000ff # user ID 648 | user_info[2] = (uid >> 16) & 0x000000ff # user ID 649 | user_info[3] = (uid >> 24) & 0x000000ff # user ID 650 | 651 | # Prepare user data section 652 | user_info[4] = gender # gender 653 | user_info[5] = age # age 654 | user_info[6] = height # height 655 | user_info[7] = weight # weight 656 | user_info[8] = which_hand # which hand 657 | user_info[9] = feature # feature 658 | user_info[10] = appearance # appearance 659 | 660 | # Prepare alias section 661 | alias_normalise = self.normalize(alias) 662 | for i in range(0, len(alias_normalise)): 663 | user_info[11+i] = alias_normalise[i] 664 | 665 | # Prepare CRC8 data 666 | temp_buffer = [0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00] 667 | for i in range(0, len(temp_buffer)): 668 | temp_buffer[i] = user_info[i] 669 | 670 | # Compute CRC8 671 | crc8_alias = self.compute_crc8(temp_buffer) 672 | 673 | # Grab the last byte of bluetooth address 674 | bluetooth_address_end = int(bluetooth_address[-2:], 16) 675 | 676 | # Compute the magic 677 | magic_crc = (crc8_alias ^ bluetooth_address_end) & 0x000000ff 678 | 679 | # Add magic CRC to the end 680 | user_info[19] = magic_crc 681 | 682 | # Return the authentication bytes 683 | return user_info 684 | 685 | 686 | 687 | def handleNotification(self, handle, data): 688 | """Method overloaded from mother class to handle notifications 689 | @param {MiBand1A} self 690 | @param {integer} BLE handle of the notification characteristic 691 | @param {bytes} data 692 | @return None 693 | """ 694 | """ 695 | # DEBUG 696 | print(handle, end=" : ") 697 | for b in data: 698 | print(b, end=" ") 699 | print("") 700 | """ 701 | 702 | # Handling notifications 703 | if handle == 0x16: 704 | if data[0] == 0x05: 705 | print(" + Authentication ok") 706 | self.authentication_ended = True 707 | self.authentication_ok = True 708 | elif data[0] == 0x06: 709 | print(" + Authentication failed") 710 | self.authentication_ended = True 711 | self.authentication_ok = False 712 | elif data[0] == 0x1d: 713 | print(" + Vibrate ok") 714 | else: 715 | print(" + Unknown notification") 716 | 717 | 718 | # Handling activity data 719 | if handle == 0x20: 720 | for b in data: 721 | self.activity_data.append(b) 722 | 723 | if len(data) == 11 and data[0] == 0x01 and data[1] == 0x11: # It is an header 724 | 725 | # Compute data to transfer 726 | bytes_transferred = ((data[10] * 256) + data[9]) * 3 727 | 728 | # Prepare ack message to delete or keep data in the device 729 | self.prepare_ack_message(data) 730 | 731 | # If it is the last header, it means that all data were transfered 732 | if bytes_transferred == 0: 733 | for an_ack_message in self.ack_messages: 734 | self.control_point_characteristic.write(an_ack_message, True) 735 | #print(self.activity_data) 736 | self.upload_in_progress = False 737 | 738 | 739 | # Handling sensor data 740 | if handle == 0x31: 741 | self.analyse_sensor_data(data) 742 | 743 | 744 | 745 | if __name__ == "__main__": 746 | 747 | # Header message 748 | print("\n***********************") 749 | print("*** MiBand1A v0.1.0 ***") 750 | print("***********************\n") 751 | 752 | 753 | try: 754 | print(" => Instanciate object") 755 | #mb1a = MiBand1A(gender=0, age=0, height=175, weight=70, alias="1550050550", which_hand=0, keep_data=True) # default user 756 | mb1a = MiBand1A(gender=2, age=25, height=175, weight=70, alias="testy", which_hand=0, keep_data=True) 757 | 758 | print(" => Scan for 5 and try to connect to a Xiaomi Mi Band 1A") 759 | if mb1a.scan_and_connect(5.0, ["c8:0f:10:76:8f:85", "c8:0f:10:76:be:e7"], -80) == True: 760 | 761 | print(" => Get services and characteristics") 762 | mb1a.get_services_and_characteristics() 763 | 764 | print(" => Subscribe to notifications") 765 | mb1a.subscribe_to_notifications() 766 | 767 | 768 | """ 769 | print(" => Read device info") 770 | print(" + device_info : ", mb1a.read_device_info() ) 771 | 772 | print(" => Read date time") 773 | print(" + date_time : ", mb1a.read_date_time() ) 774 | 775 | print(" => Read battery") 776 | print(" + battery : ", mb1a.read_battery() ) 777 | 778 | print(" => Read realtime steps") 779 | print(" + realtime_steps : ", mb1a.read_realtime_steps() ) 780 | 781 | print(" => Vibrate") 782 | mb1a.vibrate(0.5) 783 | 784 | print(" => Flash leds") 785 | mb1a.flash_leds() 786 | """ 787 | print(" => Authenticate") 788 | if mb1a.authenticate() == True: 789 | 790 | print(" => Read live sensor data") 791 | mb1a.enable_sensor_data() 792 | for i in range(0, 30): 793 | print( mb1a.read_sensor_data(0.1) ) 794 | mb1a.disable_sensor_data() 795 | 796 | #print(" => Fetch activity data") 797 | #print(" + activity data steps recorded : ", mb1a.fetch_activity_data("dump_activity_data.csv") ) 798 | 799 | #print(" => Record sensor data") 800 | #mb1a.record_sensor_data("dump_sensor_data.csv", 300) 801 | 802 | 803 | finally: 804 | print(" => Disconnect") 805 | mb1a.disconnect() 806 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU 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 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | {one line to give the program's name and a brief idea of what it does.} 635 | Copyright (C) {year} {name of author} 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | {project} Copyright (C) {year} {fullname} 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------