├── CONTRIBUTING.md ├── README.md ├── setup.py ├── dimond └── __init__.py └── LICENSE /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # How to Contribute 2 | 3 | We'd love to accept your patches and contributions to this project. There are 4 | just a few small guidelines you need to follow. 5 | 6 | ## Contributor License Agreement 7 | 8 | Contributions to this project must be accompanied by a Contributor License 9 | Agreement. You (or your employer) retain the copyright to your contribution; 10 | this simply gives us permission to use and redistribute your contributions as 11 | part of the project. Head over to to see 12 | your current agreements on file or to sign a new one. 13 | 14 | You generally only need to submit a CLA once, so if you've already submitted one 15 | (even if it was for a different project), you probably don't need to do it 16 | again. 17 | 18 | ## Code reviews 19 | 20 | All submissions, including submissions by project members, require review. We 21 | use GitHub pull requests for this purpose. Consult 22 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more 23 | information on using pull requests. 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Python implementation of Telink Bluetooth mesh protocol 2 | ======================================================= 3 | 4 | A simple Python API for controlling devices based on the Bluetooth LE mesh protocol from [Telink](http://www.telink-semi.com). 5 | 6 | This is not an officially supported Google product. 7 | 8 | Example use 9 | ----------- 10 | 11 | All mesh networks have a name and a password, and devices have an associated vendor ID. To connect to the mesh: 12 | 13 | ``` 14 | import dimond 15 | 16 | network = dimond.dimond(0x0211, "00:11:22:33:44:55", "Meshname", "Meshpass", callback=callback) 17 | network.connect() 18 | ``` 19 | 20 | The target address should be any device making up the mesh. Callback is an optional argument for a callback that will be executed whenever the mesh delivers a notification. To send a packet, call: 21 | 22 | ``` 23 | network.send_packet(target, command, data) 24 | ``` 25 | 26 | where target is the target device (0 for the device that has been connected to, 0xffff for all devices on the mesh, anything in between for a specific device on the mesh), command is an integer describing the desired command and data is a list of integers providing data to the command. 27 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env python 2 | # -*- coding: utf-8 -*- 3 | 4 | # Copyright 2018 Google LLC 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | 18 | import re 19 | from setuptools import setup, find_packages 20 | import sys 21 | import warnings 22 | 23 | dynamic_requires = [] 24 | 25 | version = "0.2" 26 | 27 | setup( 28 | name='dimond', 29 | version=version, 30 | author='Matthew Garrett', 31 | author_email='mjg59@google.com', 32 | url='http://github.com/google/python-dimond', 33 | packages=find_packages(), 34 | scripts=[], 35 | description='Python implementation of Telink Bluetooth mesh network', 36 | classifiers=[ 37 | 'Development Status :: 4 - Beta', 38 | 'Intended Audience :: Developers', 39 | 'License :: OSI Approved :: Apache Software License', 40 | 'Operating System :: OS Independent', 41 | 'Programming Language :: Python', 42 | ], 43 | install_requires=[ 44 | "bluepy", 45 | "pycryptodome", 46 | ], 47 | include_package_data=True, 48 | zip_safe=False, 49 | ) 50 | -------------------------------------------------------------------------------- /dimond/__init__.py: -------------------------------------------------------------------------------- 1 | # Copyright 2018 Google LLC 2 | # 3 | # Licensed under the Apache License, Version 2.0 (the "License"); 4 | # you may not use this file except in compliance with the License. 5 | # You may obtain a copy of the License at 6 | # 7 | # https://www.apache.org/licenses/LICENSE-2.0 8 | # 9 | # Unless required by applicable law or agreed to in writing, software 10 | # distributed under the License is distributed on an "AS IS" BASIS, 11 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 | # See the License for the specific language governing permissions and 13 | # limitations under the License. 14 | # 15 | # Contains code derived from python-tikteck, 16 | # Copyright 2016 Matthew Garrett 17 | 18 | import random 19 | import threading 20 | import time 21 | 22 | from bluepy import btle 23 | from Crypto.Cipher import AES 24 | from Crypto.Random import get_random_bytes 25 | 26 | def hex_to_str(hex_str): 27 | return str(bytearray([int(n, 16) for n in hex_str])) 28 | 29 | def encrypt(key, data): 30 | k = AES.new(bytes(reversed(key)), AES.MODE_ECB) 31 | data = reversed(list(k.encrypt(bytes(reversed(data))))) 32 | rev = [] 33 | for d in data: 34 | rev.append(d) 35 | return rev 36 | 37 | def generate_sk(name, password, data1, data2): 38 | name = name.ljust(16, chr(0)) 39 | password = password.ljust(16, chr(0)) 40 | key = [ord(a) ^ ord(b) for a,b in zip(name,password)] 41 | data = data1[0:8] 42 | data += data2[0:8] 43 | return encrypt(key, data) 44 | 45 | def key_encrypt(name, password, key): 46 | name = name.ljust(16, chr(0)) 47 | password = password.ljust(16, chr(0)) 48 | data = [ord(a) ^ ord(b) for a,b in zip(name,password)] 49 | return encrypt(key, data) 50 | 51 | def encrypt_packet(sk, address, packet): 52 | auth_nonce = [address[0], address[1], address[2], address[3], 0x01, 53 | packet[0], packet[1], packet[2], 15, 0, 0, 0, 0, 0, 0, 0] 54 | 55 | authenticator = encrypt(sk, auth_nonce) 56 | 57 | for i in range(15): 58 | authenticator[i] = authenticator[i] ^ packet[i+5] 59 | 60 | mac = encrypt(sk, authenticator) 61 | 62 | for i in range(2): 63 | packet[i+3] = mac[i] 64 | 65 | iv = [0, address[0], address[1], address[2], address[3], 0x01, packet[0], 66 | packet[1], packet[2], 0, 0, 0, 0, 0, 0, 0] 67 | 68 | temp_buffer = encrypt(sk, iv) 69 | for i in range(15): 70 | packet[i+5] ^= temp_buffer[i] 71 | 72 | return packet 73 | 74 | def decrypt_packet(sk, address, packet): 75 | iv = [address[0], address[1], address[2], packet[0], packet[1], packet[2], 76 | packet[3], packet[4], 0, 0, 0, 0, 0, 0, 0, 0] 77 | plaintext = [0] + iv[0:15] 78 | 79 | result = encrypt(sk, plaintext) 80 | 81 | for i in range(len(packet)-7): 82 | packet[i+7] ^= result[i] 83 | 84 | return packet 85 | 86 | class Notification(btle.DefaultDelegate): 87 | def __init__(self, link, callback): 88 | btle.DefaultDelegate.__init__(self) 89 | self.link = link 90 | self.callback = callback 91 | 92 | def handleNotification(self, cHandle, data): 93 | data = list(data) 94 | decrypted = decrypt_packet(self.link.sk, self.link.macdata, data) 95 | self.callback(self.link.mesh, decrypted) 96 | 97 | class dimond: 98 | def __init__(self, vendor, mac, name, password, mesh=None, callback=None): 99 | self.vendor = vendor 100 | self.mac = mac 101 | self.macarray = mac.split(':') 102 | self.name = name 103 | self.password = password 104 | self.callback = callback 105 | self.mesh = mesh 106 | self.packet_count = random.randrange(0xffff) 107 | self.macdata = [int(self.macarray[5], 16), int(self.macarray[4], 16), int(self.macarray[3], 16), int(self.macarray[2], 16), int(self.macarray[1], 16), int(self.macarray[0], 16)] 108 | 109 | def set_sk(self, sk): 110 | self.sk = sk 111 | 112 | def connect(self): 113 | self.device = btle.Peripheral(self.mac, addrType=btle.ADDR_TYPE_PUBLIC) 114 | self.notification = self.device.getCharacteristics(uuid="00010203-0405-0607-0809-0a0b0c0d1911")[0] 115 | self.control = self.device.getCharacteristics(uuid="00010203-0405-0607-0809-0a0b0c0d1912")[0] 116 | self.pairing = self.device.getCharacteristics(uuid="00010203-0405-0607-0809-0a0b0c0d1914")[0] 117 | 118 | data = [0] * 16 119 | random_data = get_random_bytes(8) 120 | for i in range(8): 121 | data[i] = random_data[i] 122 | enc_data = key_encrypt(self.name, self.password, data) 123 | packet = [0x0c] 124 | packet += data[0:8] 125 | packet += enc_data[0:8] 126 | try: 127 | self.pairing.write(bytes(packet), withResponse=True) 128 | time.sleep(0.3) 129 | data2 = self.pairing.read() 130 | except: 131 | raise Exception("Unable to connect") 132 | 133 | self.sk = generate_sk(self.name, self.password, data[0:8], data2[1:9]) 134 | 135 | if self.callback is not None: 136 | self.device.setDelegate(Notification(self, self.callback)) 137 | self.notification.write(bytes([0x1]), withResponse=True) 138 | thread = threading.Thread(target=self.wait_for_notifications) 139 | thread.daemon = True 140 | thread.start() 141 | 142 | def wait_for_notifications(self): 143 | while True: 144 | try: 145 | self.device.waitForNotifications(-1) 146 | except btle.BTLEInternalError: 147 | # If we get the response to a write then we'll break 148 | pass 149 | 150 | def send_packet(self, target, command, data): 151 | packet = [0] * 20 152 | packet[0] = self.packet_count & 0xff 153 | packet[1] = self.packet_count >> 8 & 0xff 154 | packet[5] = target & 0xff 155 | packet[6] = (target >> 8) & 0xff 156 | packet[7] = command 157 | packet[8] = self.vendor & 0xff 158 | packet[9] = (self.vendor >> 8) & 0xff 159 | for i in range(len(data)): 160 | packet[10 + i] = data[i] 161 | enc_packet = encrypt_packet(self.sk, self.macdata, packet) 162 | self.packet_count += 1 163 | if self.packet_count > 65535: 164 | self.packet_count = 1 165 | 166 | # BLE connections may not be stable. Spend up to 10 seconds trying to 167 | # reconnect before giving up. 168 | initial = time.time() 169 | while True: 170 | if time.time() - initial >= 10: 171 | raise Exception("Unable to connect") 172 | try: 173 | response = self.control.write(bytes(enc_packet)) 174 | break 175 | except: 176 | self.connect() 177 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | --------------------------------------------------------------------------------