├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── laurel └── __init__.py └── setup.py /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 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Python control of C by GE Bluetooth lightbulbs 2 | ============================================== 3 | 4 | A simple Python API for controlling [C by GE](https://www.cbyge.com/) lighting devices. 5 | 6 | Example use 7 | ----------- 8 | 9 | Retrieve authentication data from the remote API and automatically create devices: 10 | 11 | ``` 12 | import laurel 13 | 14 | connection = laurel.laurel("username", "password") 15 | devices = connection.devices 16 | 17 | # Connect to the mesh - if you have multiple devices in a network you can 18 | # connect to any of them 19 | 20 | devices[0].network.connect() 21 | ``` 22 | 23 | Show device information: 24 | 25 | ``` 26 | print(devices[0].name) 27 | print(devices[0].id) 28 | print(devices[0].type) 29 | print(devices[0].brightness) 30 | print(devices[0].temperature) 31 | print(devices[0].red) 32 | print(devices[0].green) 33 | print(devices[0].blue) 34 | ``` 35 | 36 | Set the device brightness to 50%: 37 | 38 | ``` 39 | if devices[0].supports_dimming() == True: 40 | devices[0].set_brightness(50) 41 | ``` 42 | 43 | If the device supports colour temperature setting: 44 | 45 | ``` 46 | if devices[0].supports_temperature() == True: 47 | devices[0].set_temperature(50) 48 | ``` 49 | 50 | If the device supports RGB: 51 | 52 | ``` 53 | if devices[0].supports_rgb() == True: 54 | devices[0].set_rgb(128, 255, 0) 55 | ``` 56 | 57 | Turn the device off: 58 | 59 | ``` 60 | devices[0].set_power(False) 61 | ``` 62 | 63 | Force an update of the device state (note that this is asynchronous): 64 | 65 | ``` 66 | devices[0].update_status() 67 | ``` 68 | -------------------------------------------------------------------------------- /laurel/__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 | import dimond 16 | import requests 17 | 18 | 19 | API_TIMEOUT = 5 20 | 21 | class LaurelException(Exception): 22 | pass 23 | 24 | def authenticate(username, password): 25 | """Authenticate with the API and get a token.""" 26 | API_AUTH = "https://api2.xlink.cn/v2/user_auth" 27 | auth_data = {'corp_id': "1007d2ad150c4000", 'email': username, 28 | 'password': password} 29 | r = requests.post(API_AUTH, json=auth_data, timeout=API_TIMEOUT) 30 | try: 31 | return (r.json()['access_token'], r.json()['user_id']) 32 | except KeyError: 33 | raise(LaurelException('API authentication failed')) 34 | 35 | 36 | def get_devices(auth_token, user): 37 | """Get a list of devices for a particular user.""" 38 | API_DEVICES = "https://api2.xlink.cn/v2/user/{user}/subscribe/devices" 39 | headers = {'Access-Token': auth_token} 40 | r = requests.get(API_DEVICES.format(user=user), headers=headers, 41 | timeout=API_TIMEOUT) 42 | return r.json() 43 | 44 | def get_properties(auth_token, product_id, device_id): 45 | """Get properties for a single device.""" 46 | API_DEVICE_INFO = "https://api2.xlink.cn/v2/product/{product_id}/device/{device_id}/property" 47 | headers = {'Access-Token': auth_token} 48 | r = requests.get(API_DEVICE_INFO.format(product_id=product_id, device_id=device_id), headers=headers, timeout=API_TIMEOUT) 49 | return r.json() 50 | 51 | def _get_user(auth_token, user): 52 | """Get information about the user.""" 53 | API_USER = "https://api2.xlink.cn/v2/user/{user}" 54 | headers = {'Access-Token': auth_token} 55 | r = requests.get(API_USER.format(user=user), headers=headers, timeout=API_TIMEOUT) 56 | return r.json() 57 | 58 | 59 | (auth_token, user) = _authenticate(username, password) 60 | user_info = _get_user(auth_token, user) 61 | devices = _get_devices(auth_token, user) 62 | for device in devices: 63 | product_id = device['product_id'] 64 | device_id = device['id'] 65 | device_info = _get_device(auth_token, product_id, device_id) 66 | 67 | def callback(link, data): 68 | if data[7] != 0xdc: 69 | return 70 | responses = data[10:18] 71 | for i in (0, 4): 72 | response = responses[i:i+4] 73 | for device in link.devices: 74 | if device.id == response[0]: 75 | device.brightness = response[2] 76 | if device.brightness >= 128: 77 | device.brightness = device.brightness - 128 78 | device.red = int(((response[3] & 0xe0) >> 5) * 255 / 7) 79 | device.green = int(((response[3] & 0x1c) >> 2) * 255 / 7) 80 | device.blue = int((response[3] & 0x3) * 255 / 3) 81 | device.rgb = True 82 | else: 83 | device.temperature = response[3] 84 | device.rgb = False 85 | if device.callback is not None: 86 | device.callback(device.cbargs) 87 | 88 | class laurel: 89 | def __init__(self, user, password): 90 | (self.auth, self.userid) = authenticate(user, password) 91 | self.devices = [] 92 | self.networks = [] 93 | mesh_networks = get_devices(self.auth, self.userid) 94 | for mesh in mesh_networks: 95 | network = None 96 | devices = [] 97 | properties = get_properties(self.auth, mesh['product_id'], 98 | mesh['id']) 99 | if properties.get('error') is not None: 100 | continue 101 | for bulb in properties['bulbsArray']: 102 | try: 103 | id = int(bulb['deviceID'][-3:]) 104 | mac = [bulb['mac'][i:i+2] for i in range(0, 12, 2)] 105 | mac = "%s:%s:%s:%s:%s:%s" % (mac[5], mac[4], mac[3], mac[2], mac[1], mac[0]) 106 | if network is None: 107 | network = laurel_mesh(mesh['mac'], mesh['access_key']) 108 | device = laurel_device(network, {'name': bulb['displayName'], 'mac': mac, 'id': id, 'type': bulb['deviceType'], 'load': bulb['loadSelection']}) 109 | network.devices.append(device) 110 | self.devices.append(device) 111 | except KeyError: 112 | continue 113 | 114 | self.networks.append(network) 115 | 116 | class laurel_mesh: 117 | def __init__(self, address, password): 118 | self.address = str(address) 119 | self.password = str(password) 120 | self.devices = [] 121 | self.link = None 122 | 123 | def connect(self): 124 | if self.link != None: 125 | return 126 | 127 | for device in self.devices: 128 | # Try each device in turn - we only need to connect to one to be 129 | # on the mesh 130 | try: 131 | self.link = dimond.dimond(0x0211, device.mac, self.address, self.password, self, callback) 132 | self.link.connect() 133 | break 134 | except Exception as e: 135 | print("Failed to connect to %s" % device.mac, e) 136 | self.link = None 137 | pass 138 | if self.link is None: 139 | raise(LaurelException("Unable to connect to mesh %s" % self.address)) 140 | 141 | def send_packet(self, id, command, params): 142 | self.link.send_packet(id, command, params) 143 | 144 | def update_status(self): 145 | self.send_packet(0xffff, 0xda, []) 146 | 147 | 148 | class laurel_device: 149 | def __init__ (self, network, device): 150 | self.network = network 151 | self.name = device['name'] 152 | self.id = device['id'] 153 | self.mac = device['mac'] 154 | self.type = device['type'] 155 | self.load = device['load'] 156 | self.callback = None 157 | self.brightness = 0 158 | self.temperature = 0 159 | self.red = 0 160 | self.green = 0 161 | self.blue = 0 162 | self.rgb = False 163 | 164 | def set_callback(self, callback, cbargs): 165 | self.callback = callback 166 | self.cbargs = cbargs 167 | 168 | def set_temperature(self, temperature): 169 | self.network.send_packet(self.id, 0xe2, [0x05, temperature]) 170 | self.temperature = temperature 171 | 172 | def set_rgb(self, red, green, blue): 173 | self.network.send_packet(self.id, 0xe2, [0x04, red, green, blue]) 174 | self.red = red 175 | self.green = green 176 | self.blue = blue 177 | 178 | def set_brightness(self, brightness): 179 | self.network.send_packet(self.id, 0xd2, [brightness]) 180 | self.brightness = brightness 181 | 182 | def set_power(self, power): 183 | self.network.send_packet(self.id, 0xd0, [int(power)]) 184 | 185 | def update_status(self): 186 | self.network.send_packet(self.id, 0xda, []) 187 | 188 | def supports_dimming(self): 189 | if self.supports_temperature() or \ 190 | self.type == 1 or \ 191 | self.type == 9 or \ 192 | self.type == 17 or \ 193 | self.type == 18 or \ 194 | self.type == 24 or \ 195 | self.type == 81: 196 | return True 197 | 198 | if self.type == 48 or \ 199 | self.type == 55 or \ 200 | self.type == 56: 201 | # Switch, depends on load type 202 | if self.load == 4 or\ 203 | self.load == 5: 204 | return False 205 | return True 206 | 207 | return False 208 | 209 | def supports_temperature(self): 210 | if self.supports_rgb() or \ 211 | self.type == 5 or \ 212 | self.type == 14 or \ 213 | self.type == 15 or \ 214 | self.type == 19 or \ 215 | self.type == 20 or \ 216 | self.type == 28 or \ 217 | self.type == 29 or \ 218 | self.type == 80 or \ 219 | self.type == 83 or \ 220 | self.type == 85 or \ 221 | self.type == 129: 222 | return True 223 | return False 224 | 225 | def supports_rgb(self): 226 | if self.type == 6 or \ 227 | self.type == 7 or \ 228 | self.type == 8 or \ 229 | self.type == 21 or \ 230 | self.type == 22 or \ 231 | self.type == 23 or \ 232 | self.type == 30 or \ 233 | self.type == 31 or \ 234 | self.type == 32 or \ 235 | self.type == 33 or \ 236 | self.type == 34 or \ 237 | self.type == 35 or \ 238 | self.type == 131 or \ 239 | self.type == 132 or \ 240 | self.type == 133: 241 | return True 242 | return False 243 | -------------------------------------------------------------------------------- /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.5" 26 | 27 | setup( 28 | name='laurel', 29 | version=version, 30 | author='Matthew Garrett', 31 | author_email='mjg59@srcf.ucam.org', 32 | url='http://github.com/mjg59/python-laurel', 33 | packages=find_packages(), 34 | scripts=[], 35 | description='Python control of C by GE Bluetooth lightbulbs', 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 | "dimond>=0.3", 45 | "requests", 46 | ], 47 | include_package_data=True, 48 | zip_safe=False, 49 | ) 50 | --------------------------------------------------------------------------------