├── .gitignore ├── Makefile ├── hwaddr.h ├── README.md ├── bbatt.h ├── hwaddr.c ├── hyg.c ├── att-types.h ├── bbatt.c └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .project 2 | .cproject 3 | *.o 4 | hyg 5 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | OBJS = hyg.o bbatt.o hwaddr.o 2 | 3 | CFLAGS += -g 4 | CFLAGS += -O2 5 | 6 | all: hyg 7 | 8 | hyg: $(OBJS) 9 | $(CC) -o $@ $^ 10 | 11 | %.o: %.c 12 | $(CC) -c $(CFLAGS) -o $@ $< 13 | 14 | clean: 15 | rm -fr hyg $(OBJS) 16 | -------------------------------------------------------------------------------- /hwaddr.h: -------------------------------------------------------------------------------- 1 | /* 2 | * MAC address string functions, from wpa_supplicant 3 | * Copyright (c) 2018 Anti Sullin 4 | * 5 | * This program is free software: you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License as published by 7 | * the Free Software Foundation, either version 3 of the License, or 8 | * (at your option) any later version. 9 | * 10 | * This program is distributed in the hope that it will be useful, 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 13 | * GNU General Public License for more details. 14 | * 15 | * You should have received a copy of the GNU General Public License 16 | * along with this program. If not, see . 17 | * 18 | */ 19 | 20 | #ifndef HWADDR_H_ 21 | #define HWADDR_H_ 22 | 23 | #include 24 | 25 | int hwaddr_aton(const char *txt, uint8_t *addr); 26 | int hwaddr_ntoa(const uint8_t *addr, char *str); 27 | 28 | 29 | #endif /* HWADDR_H_ */ 30 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Xiaomi Mijia measurement reading utility 2 | This utility reads the Xiaomi Mijia bluetooth sensors. The result is printed to standard output to be graphed with munin. It is a simple standalone utility and does not depend on any runtime libraries (although header files in libbluetooth-dev are needed during compiling). It keeps the bluetooth traffic to the minimum, handle lookups are hardcoded. 3 | 4 | ## Supported devices: 5 | * LYWSDCGQ/01ZM (thermometer/hygrometer) 6 | * LYWSD02MMC (clock/thermometer/hygrometer) 7 | 8 | ## Features: 9 | * Reading temperature and humidity 10 | * Setting clock (for LYWSD02MMC) 11 | 12 | ## Usage 13 | Find the address of the device: 14 | ``` 15 | $ sudo hcitool lescan 16 | LE Scan ... 17 | 11:22:33:44:55:66 MJ\_HT\_V1 18 | 11:22:33:44:55:67 LYWSD02 19 | ``` 20 | 21 | Read the sensors: 22 | ``` 23 | $ ./hyg 11:22:33:44:55:66 24 | temp.value 24.9 25 | hum.value 26.6 26 | 27 | $ ./hyg -c -t 02\_0042 11:22:33:44:55:67 28 | temp.value 26.5 29 | hum.value 48.0 30 | ``` 31 | 32 | ## Cross compiling 33 | Cross compiling to run on Synology (ARM) 34 | ``` 35 | sudo apt-get install gcc-arm-linux-gnueabi 36 | sudo apt-get install libc6-dev-armel-cross 37 | CC=arm-linux-gnueabi-gcc make 38 | ``` 39 | -------------------------------------------------------------------------------- /bbatt.h: -------------------------------------------------------------------------------- 1 | /** 2 | * 3 | * Very simple "bit-banging" library for the following ATT packet types 4 | * Origin: https://github.com/dlenski/ttblue, GPLv3 5 | * Modified by Anti Sullin 6 | * 7 | * This program is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with this program. If not, see . 19 | */ 20 | 21 | /* use ATT protocol opcodes from bluez/src/shared/att-types.h */ 22 | #include "att-types.h" 23 | #include 24 | 25 | int att_connect(bdaddr_t *dst, int sec); 26 | 27 | int att_read(int fd, uint16_t handle, void *buf, int len); 28 | int att_write(int fd, uint16_t handle, const void *buf, int length); 29 | int att_wrreq(int fd, uint16_t handle, const void *buf, int length); 30 | int att_read_not(int fd, uint16_t *handle, void *buf, int len); 31 | 32 | const char *addr_type_name(int dst_type); 33 | const char *att_ecode2str(uint8_t status); /* copied from bluez/attrib/att.c */ 34 | -------------------------------------------------------------------------------- /hwaddr.c: -------------------------------------------------------------------------------- 1 | /* 2 | * MAC address string functions, from wpa_supplicant 3 | * Copyright (c) 2002-2007, Jouni Malinen 4 | * 5 | * This program is free software; you can redistribute it and/or modify 6 | * it under the terms of the GNU General Public License version 2 as 7 | * published by the Free Software Foundation. 8 | * 9 | * Alternatively, this software may be distributed under the terms of BSD 10 | * license. 11 | * 12 | */ 13 | 14 | #include 15 | #include "hwaddr.h" 16 | 17 | static int hex2num(char c) 18 | { 19 | if (c >= '0' && c <= '9') 20 | return c - '0'; 21 | if (c >= 'a' && c <= 'f') 22 | return c - 'a' + 10; 23 | if (c >= 'A' && c <= 'F') 24 | return c - 'A' + 10; 25 | return -1; 26 | } 27 | /** 28 | * hwaddr_aton - Convert ASCII string to MAC address (colon-delimited format) 29 | * @txt: MAC address as a string (e.g., "00:11:22:33:44:55") 30 | * @addr: Buffer for the MAC address (ETH_ALEN = 6 bytes) 31 | * Returns: 0 on success, -1 on failure (e.g., string not a MAC address) 32 | */ 33 | int hwaddr_aton(const char *txt, uint8_t *addr) 34 | { 35 | int i; 36 | for (i = 0; i < 6; i++) { 37 | int a, b; 38 | a = hex2num(*txt++); 39 | if (a < 0) 40 | return -1; 41 | b = hex2num(*txt++); 42 | if (b < 0) 43 | return -1; 44 | addr[5-i] = (a << 4) | b; 45 | if (i < 5 && *txt++ != ':') 46 | return -1; 47 | } 48 | return 0; 49 | } 50 | 51 | int hwaddr_ntoa(const uint8_t *addr, char *str) { 52 | return sprintf(str, "%02X:%02X:%02X:%02X:%02X:%02X", 53 | addr[5], addr[4], addr[3], addr[2], addr[1], addr[0]); 54 | } 55 | -------------------------------------------------------------------------------- /hyg.c: -------------------------------------------------------------------------------- 1 | /** 2 | * 3 | * Xiaomi MI Bluetooth LE Hygrometer reader application 4 | * (c) Anti Sullin 2018 5 | * 6 | * This program is free software: you can redistribute it and/or modify 7 | * it under the terms of the GNU General Public License as published by 8 | * the Free Software Foundation, either version 3 of the License, or 9 | * (at your option) any later version. 10 | * 11 | * This program is distributed in the hope that it will be useful, 12 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | * GNU General Public License for more details. 15 | * 16 | * You should have received a copy of the GNU General Public License 17 | * along with this program. If not, see . 18 | */ 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | #include 28 | #include 29 | #include 30 | #include "bbatt.h" 31 | #include "hwaddr.h" 32 | 33 | enum sensor_type { 34 | HYG_LYWSDCGQ, 35 | HYG_LYWSD02, // fw pre 1.1.2_0042 36 | HYG_LYWSD02_0042, // fw post 1.1.2_0042 37 | 38 | HYG_NUM_SENSOR_TYPES 39 | }; 40 | 41 | struct lywsd_config { 42 | uint16_t cccd_handle; 43 | uint16_t data_handle; 44 | uint16_t clock_handle; 45 | }; 46 | 47 | static const struct lywsd_config lywsd_configs[HYG_NUM_SENSOR_TYPES] = { 48 | [HYG_LYWSDCGQ] = {0x0010, 0x000E, 0}, 49 | [HYG_LYWSD02] = {0x003D, 0x003C, 0x002F}, 50 | [HYG_LYWSD02_0042] = {0x004C, 0x004B, 0x003E}, 51 | }; 52 | 53 | int usage(const char *app) { 54 | printf("Xiaomi Mijia Hygrometer reader utility.\n"); 55 | printf("Usage: %s [args] \n", app); 56 | printf(" -t CGQ Select LYWSDCGQ sensor (default)\n"); 57 | printf(" -t 02 Select LYWSD002 sensor\n"); 58 | printf(" -t 02_0042 Select LYWSD002 sensor with post 1.1.2_0042 FW\n"); 59 | printf(" -c Set clock on device\n"); 60 | return 1; 61 | } 62 | 63 | int read_notification(int fd, int cccd_handle, int data_handle, uint8_t *buf, int len) { 64 | uint8_t val[2] = {0x01, 0x00}; 65 | int ret = att_wrreq(fd, cccd_handle, val, sizeof(val)); 66 | if (ret < 0) { 67 | fprintf(stderr, "Could not enable notifications\n"); 68 | return -1; 69 | } 70 | 71 | uint16_t handle = 0; 72 | ret = att_read_not(fd, &handle, buf, len); 73 | if (ret < 0) { 74 | fprintf(stderr, "Could not read notification\n"); 75 | return -1; 76 | } 77 | if (handle != data_handle) { 78 | fprintf(stderr, "Invalid response\n"); 79 | return -1; 80 | } 81 | return ret; 82 | } 83 | 84 | bool lywsd_read_data(int fd, enum sensor_type type) { 85 | uint8_t buf[32]; 86 | int ret = read_notification(fd, lywsd_configs[type].cccd_handle, 87 | lywsd_configs[type].data_handle, buf, sizeof(buf)); 88 | 89 | if (ret < 0) return false; 90 | 91 | float t=0, h=0; 92 | switch (type) { 93 | case HYG_LYWSDCGQ: 94 | buf[sizeof(buf)-1] = '\0'; 95 | if (sscanf(buf, "T=%f H=%f", &t, &h) != 2) { 96 | fprintf(stderr, "Malformed response\n"); 97 | return 1; 98 | } 99 | break; 100 | case HYG_LYWSD02: 101 | case HYG_LYWSD02_0042: 102 | if (ret != 3) { 103 | fprintf(stderr, "Malformed response\n"); 104 | return false; 105 | } 106 | t = (buf[0] + buf[1]*256.0)/100.0; 107 | h = buf[2]; 108 | } 109 | 110 | printf("temp.value %.1f\n", t); 111 | printf("hum.value %.1f\n", h); 112 | return true; 113 | } 114 | 115 | bool lywsd_set_time(int fd, enum sensor_type type) { 116 | if (lywsd_configs[type].clock_handle == 0) { 117 | fprintf(stderr, "Setting time not supported\n"); 118 | return false; 119 | } 120 | 121 | time_t t = time(NULL); 122 | struct tm lt = {0}; 123 | localtime_r(&t, <); 124 | 125 | uint8_t buf[5]; 126 | buf[0] = t & 0xFF; 127 | buf[1] = (t >> 8) & 0xFF; 128 | buf[2] = (t >> 16) & 0xFF; 129 | buf[3] = (t >> 24) & 0xFF; 130 | buf[4] = (int8_t)(lt.tm_gmtoff / 3600); 131 | 132 | int ret = att_wrreq(fd, lywsd_configs[type].clock_handle, 133 | buf, sizeof(buf)); 134 | if (ret < 0) { 135 | fprintf(stderr, "Could not set time\n"); 136 | return false; 137 | } 138 | return true; 139 | } 140 | 141 | int main(int argc, char **argv) { 142 | enum sensor_type type = HYG_LYWSDCGQ; 143 | int opt; 144 | bool set_clock = false; 145 | 146 | while ((opt = getopt(argc, argv, "t:c")) != -1) { 147 | switch (opt) { 148 | case 't': 149 | if (strcmp(optarg, "CGQ") == 0) type = HYG_LYWSDCGQ; 150 | else if (strcmp(optarg, "02") == 0) type = HYG_LYWSD02; 151 | else if (strcmp(optarg, "02_0042") == 0) type = HYG_LYWSD02_0042; 152 | else return usage(argv[0]); 153 | break; 154 | case 'c': 155 | set_clock = true; 156 | break; 157 | default: 158 | return usage(argv[0]); 159 | } 160 | } 161 | 162 | if (optind >= argc) { 163 | return usage(argv[0]); 164 | } 165 | 166 | bdaddr_t dst_addr = {0}; 167 | if (hwaddr_aton(argv[optind], dst_addr.b) < 0) { 168 | fprintf(stderr, "Invalid device address\n"); 169 | return 1; 170 | } 171 | 172 | fprintf(stderr, "Connecting...\n"); 173 | int fd = att_connect(&dst_addr, BT_SECURITY_LOW); 174 | if (fd < 0) { 175 | if (errno!=ENOTCONN) 176 | fprintf(stderr, "Failed to connect\n"); 177 | else 178 | fprintf(stderr, "Device is not connectable\n"); 179 | return 1; 180 | } 181 | 182 | bool ret = true; 183 | if (set_clock) { 184 | fprintf(stderr, "Setting time...\n"); 185 | ret &= lywsd_set_time(fd, type); 186 | } 187 | 188 | fprintf(stderr, "Reading data...\n"); 189 | ret &= lywsd_read_data(fd, type); 190 | close(fd); 191 | 192 | return ret?0:1; 193 | } 194 | -------------------------------------------------------------------------------- /att-types.h: -------------------------------------------------------------------------------- 1 | /* 2 | * 3 | * BlueZ - Bluetooth protocol stack for Linux 4 | * 5 | * Copyright (C) 2014 Google Inc. 6 | * 7 | * 8 | * This library is free software; you can redistribute it and/or 9 | * modify it under the terms of the GNU Lesser General Public 10 | * License as published by the Free Software Foundation; either 11 | * version 2.1 of the License, or (at your option) any later version. 12 | * 13 | * This library is distributed in the hope that it will be useful, 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 16 | * Lesser General Public License for more details. 17 | * 18 | * You should have received a copy of the GNU Lesser General Public 19 | * License along with this library; if not, write to the Free Software 20 | * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA 21 | * 22 | */ 23 | 24 | #ifndef __ATT_TYPES_H__ 25 | #define __ATT_TYPES_H__ 26 | 27 | #include 28 | 29 | #ifndef __packed 30 | #define __packed __attribute__((packed)) 31 | #endif 32 | 33 | #define BT_ATT_SECURITY_AUTO 0 34 | #define BT_ATT_SECURITY_LOW 1 35 | #define BT_ATT_SECURITY_MEDIUM 2 36 | #define BT_ATT_SECURITY_HIGH 3 37 | 38 | #define BT_ATT_DEFAULT_LE_MTU 23 39 | #define BT_ATT_MAX_LE_MTU 517 40 | #define BT_ATT_MAX_VALUE_LEN 512 41 | 42 | /* ATT protocol opcodes */ 43 | #define BT_ATT_OP_ERROR_RSP 0x01 44 | #define BT_ATT_OP_MTU_REQ 0x02 45 | #define BT_ATT_OP_MTU_RSP 0x03 46 | #define BT_ATT_OP_FIND_INFO_REQ 0x04 47 | #define BT_ATT_OP_FIND_INFO_RSP 0x05 48 | #define BT_ATT_OP_FIND_BY_TYPE_VAL_REQ 0x06 49 | #define BT_ATT_OP_FIND_BY_TYPE_VAL_RSP 0x07 50 | #define BT_ATT_OP_READ_BY_TYPE_REQ 0x08 51 | #define BT_ATT_OP_READ_BY_TYPE_RSP 0x09 52 | #define BT_ATT_OP_READ_REQ 0x0a 53 | #define BT_ATT_OP_READ_RSP 0x0b 54 | #define BT_ATT_OP_READ_BLOB_REQ 0x0c 55 | #define BT_ATT_OP_READ_BLOB_RSP 0x0d 56 | #define BT_ATT_OP_READ_MULT_REQ 0x0e 57 | #define BT_ATT_OP_READ_MULT_RSP 0x0f 58 | #define BT_ATT_OP_READ_BY_GRP_TYPE_REQ 0x10 59 | #define BT_ATT_OP_READ_BY_GRP_TYPE_RSP 0x11 60 | #define BT_ATT_OP_WRITE_REQ 0x12 61 | #define BT_ATT_OP_WRITE_RSP 0x13 62 | #define BT_ATT_OP_WRITE_CMD 0x52 63 | #define BT_ATT_OP_SIGNED_WRITE_CMD 0xD2 64 | #define BT_ATT_OP_PREP_WRITE_REQ 0x16 65 | #define BT_ATT_OP_PREP_WRITE_RSP 0x17 66 | #define BT_ATT_OP_EXEC_WRITE_REQ 0x18 67 | #define BT_ATT_OP_EXEC_WRITE_RSP 0x19 68 | #define BT_ATT_OP_HANDLE_VAL_NOT 0x1B 69 | #define BT_ATT_OP_HANDLE_VAL_IND 0x1D 70 | #define BT_ATT_OP_HANDLE_VAL_CONF 0x1E 71 | 72 | /* Packed struct definitions for ATT protocol PDUs */ 73 | /* TODO: Complete these definitions for all opcodes */ 74 | struct bt_att_pdu_error_rsp { 75 | uint8_t opcode; 76 | uint16_t handle; 77 | uint8_t ecode; 78 | } __packed; 79 | 80 | /* Special opcode to receive all requests (legacy servers) */ 81 | #define BT_ATT_ALL_REQUESTS 0x00 82 | 83 | /* Error codes for Error response PDU */ 84 | #define BT_ATT_ERROR_INVALID_HANDLE 0x01 85 | #define BT_ATT_ERROR_READ_NOT_PERMITTED 0x02 86 | #define BT_ATT_ERROR_WRITE_NOT_PERMITTED 0x03 87 | #define BT_ATT_ERROR_INVALID_PDU 0x04 88 | #define BT_ATT_ERROR_AUTHENTICATION 0x05 89 | #define BT_ATT_ERROR_REQUEST_NOT_SUPPORTED 0x06 90 | #define BT_ATT_ERROR_INVALID_OFFSET 0x07 91 | #define BT_ATT_ERROR_AUTHORIZATION 0x08 92 | #define BT_ATT_ERROR_PREPARE_QUEUE_FULL 0x09 93 | #define BT_ATT_ERROR_ATTRIBUTE_NOT_FOUND 0x0A 94 | #define BT_ATT_ERROR_ATTRIBUTE_NOT_LONG 0x0B 95 | #define BT_ATT_ERROR_INSUFFICIENT_ENCRYPTION_KEY_SIZE 0x0C 96 | #define BT_ATT_ERROR_INVALID_ATTRIBUTE_VALUE_LEN 0x0D 97 | #define BT_ATT_ERROR_UNLIKELY 0x0E 98 | #define BT_ATT_ERROR_INSUFFICIENT_ENCRYPTION 0x0F 99 | #define BT_ATT_ERROR_UNSUPPORTED_GROUP_TYPE 0x10 100 | #define BT_ATT_ERROR_INSUFFICIENT_RESOURCES 0x11 101 | 102 | /* 103 | * Common Profile and Service Error Code descriptions (see Supplement to the 104 | * Bluetooth Core Specification, sections 1.2 and 2). The error codes within 105 | * 0xE0-0xFC are reserved for future use. The remaining 3 are defined as the 106 | * following: 107 | */ 108 | #define BT_ERROR_CCC_IMPROPERLY_CONFIGURED 0xfd 109 | #define BT_ERROR_ALREADY_IN_PROGRESS 0xfe 110 | #define BT_ERROR_OUT_OF_RANGE 0xff 111 | 112 | /* 113 | * ATT attribute permission bitfield values. Permissions are grouped as 114 | * "Access", "Encryption", "Authentication", and "Authorization". A bitmask of 115 | * permissions is a byte that encodes a combination of these. 116 | */ 117 | #define BT_ATT_PERM_READ 0x01 118 | #define BT_ATT_PERM_WRITE 0x02 119 | #define BT_ATT_PERM_READ_ENCRYPT 0x04 120 | #define BT_ATT_PERM_WRITE_ENCRYPT 0x08 121 | #define BT_ATT_PERM_ENCRYPT (BT_ATT_PERM_READ_ENCRYPT | \ 122 | BT_ATT_PERM_WRITE_ENCRYPT) 123 | #define BT_ATT_PERM_READ_AUTHEN 0x10 124 | #define BT_ATT_PERM_WRITE_AUTHEN 0x20 125 | #define BT_ATT_PERM_AUTHEN (BT_ATT_PERM_READ_AUTHEN | \ 126 | BT_ATT_PERM_WRITE_AUTHEN) 127 | #define BT_ATT_PERM_AUTHOR 0x40 128 | #define BT_ATT_PERM_NONE 0x80 129 | 130 | /* GATT Characteristic Properties Bitfield values */ 131 | #define BT_GATT_CHRC_PROP_BROADCAST 0x01 132 | #define BT_GATT_CHRC_PROP_READ 0x02 133 | #define BT_GATT_CHRC_PROP_WRITE_WITHOUT_RESP 0x04 134 | #define BT_GATT_CHRC_PROP_WRITE 0x08 135 | #define BT_GATT_CHRC_PROP_NOTIFY 0x10 136 | #define BT_GATT_CHRC_PROP_INDICATE 0x20 137 | #define BT_GATT_CHRC_PROP_AUTH 0x40 138 | #define BT_GATT_CHRC_PROP_EXT_PROP 0x80 139 | 140 | /* GATT Characteristic Extended Properties Bitfield values */ 141 | #define BT_GATT_CHRC_EXT_PROP_RELIABLE_WRITE 0x01 142 | #define BT_GATT_CHRC_EXT_PROP_WRITABLE_AUX 0x02 143 | #define BT_GATT_CHRC_EXT_PROP_ENC_READ 0x04 144 | #define BT_GATT_CHRC_EXT_PROP_ENC_WRITE 0x08 145 | #define BT_GATT_CHRC_EXT_PROP_ENC (BT_GATT_CHRC_EXT_PROP_ENC_READ | \ 146 | BT_GATT_CHRC_EXT_PROP_ENC_WRITE) 147 | #define BT_GATT_CHRC_EXT_PROP_AUTH_READ 0x10 148 | #define BT_GATT_CHRC_EXT_PROP_AUTH_WRITE 0x20 149 | #define BT_GATT_CHRC_EXT_PROP_AUTH (BT_GATT_CHRC_EXT_PROP_AUTH_READ | \ 150 | BT_GATT_CHRC_EXT_PROP_AUTH_WRITE) 151 | 152 | #endif /* #ifndef __ATT_TYPES_H__ */ 153 | -------------------------------------------------------------------------------- /bbatt.c: -------------------------------------------------------------------------------- 1 | /** 2 | * 3 | * Very simple "bit-banging" library for the following ATT packet types 4 | * Origin: https://github.com/dlenski/ttblue, GPLv3 5 | * Modified by Anti Sullin 6 | * 7 | * This program is free software: you can redistribute it and/or modify 8 | * it under the terms of the GNU General Public License as published by 9 | * the Free Software Foundation, either version 3 of the License, or 10 | * (at your option) any later version. 11 | * 12 | * This program is distributed in the hope that it will be useful, 13 | * but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15 | * GNU General Public License for more details. 16 | * 17 | * You should have received a copy of the GNU General Public License 18 | * along with this program. If not, see . 19 | * 20 | * 21 | * att_read: send BT_ATT_OP_READ_REQ, await BT_ATT_OP_READ_RSP) 22 | * att_write and att_wrreq: send BT_ADD_OP_WRITE_CMD, 23 | * or send BT_ADD_OP_WRITE_REQ and await BT_ADD_OP_WRITE_RSP 24 | * att_read_not: await BT_ATT_OP_HANDLE_VAL_NOT) 25 | */ 26 | 27 | 28 | #include 29 | #include 30 | #include 31 | #include 32 | #include 33 | #include 34 | #include 35 | #include "bbatt.h" 36 | 37 | #define DEBUG 0 38 | #define debug_print(args ...) if (DEBUG) fprintf(stderr, args) 39 | 40 | 41 | #define ATT_CID 4 42 | int att_connect(bdaddr_t *dst, int sec) 43 | { 44 | int sock; 45 | struct sockaddr_l2 srcaddr, dstaddr; 46 | struct bt_security btsec; 47 | 48 | sock = socket(PF_BLUETOOTH, SOCK_SEQPACKET, BTPROTO_L2CAP); 49 | if (sock < 0) { 50 | fprintf(stderr, "Failed to create L2CAP socket\n"); 51 | return -1; 52 | } 53 | 54 | /* Set up source address */ 55 | memset(&srcaddr, 0, sizeof(srcaddr)); 56 | srcaddr.l2_family = AF_BLUETOOTH; 57 | srcaddr.l2_cid = htobs(ATT_CID); 58 | srcaddr.l2_bdaddr_type = 0; 59 | bacpy(&srcaddr.l2_bdaddr, BDADDR_ANY); 60 | 61 | if (bind(sock, (struct sockaddr *)&srcaddr, sizeof(srcaddr)) < 0) { 62 | fprintf(stderr, "Failed to bind L2CAP socket\n"); 63 | close(sock); 64 | return -1; 65 | } 66 | 67 | /* Set the security level */ 68 | memset(&btsec, 0, sizeof(btsec)); 69 | btsec.level = sec; 70 | if (setsockopt(sock, SOL_BLUETOOTH, BT_SECURITY, &btsec, 71 | sizeof(btsec)) != 0) { 72 | fprintf(stderr, "Failed to set L2CAP security level\n"); 73 | close(sock); 74 | return -1; 75 | } 76 | 77 | /* Set up destination address */ 78 | memset(&dstaddr, 0, sizeof(dstaddr)); 79 | dstaddr.l2_family = AF_BLUETOOTH; 80 | dstaddr.l2_cid = htobs(ATT_CID); 81 | dstaddr.l2_bdaddr_type = BDADDR_LE_PUBLIC; 82 | bacpy(&dstaddr.l2_bdaddr, dst); 83 | 84 | if (connect(sock, (struct sockaddr *) &dstaddr, sizeof(dstaddr)) < 0) { 85 | close(sock); 86 | return -2; 87 | } 88 | 89 | return sock; 90 | } 91 | 92 | int att_read(int fd, uint16_t handle, void *buf, int len) 93 | { 94 | int result; 95 | 96 | struct { uint8_t opcode; uint16_t handle; } __attribute__((packed)) pkt = { BT_ATT_OP_READ_REQ, htobs(handle) }; 97 | result = send(fd, &pkt, sizeof(pkt), 0); 98 | if (result<0) 99 | return result; 100 | 101 | struct { uint8_t opcode; uint8_t buf[BT_ATT_DEFAULT_LE_MTU]; } __attribute__((packed)) rpkt = {0}; 102 | result = recv(fd, &rpkt, sizeof rpkt, 0); 103 | if (result<0) 104 | return result; 105 | else if (rpkt.opcode == BT_ATT_OP_ERROR_RSP && result==1+sizeof(struct bt_att_pdu_error_rsp)) { 106 | struct bt_att_pdu_error_rsp *err = (void *)rpkt.buf; 107 | debug_print("ATT error for opcode 0x%02x, handle 0x%04x: %s\n", err->opcode, btohs(err->handle), att_ecode2str(err->ecode)); 108 | return -2; 109 | } else if (rpkt.opcode != BT_ATT_OP_READ_RSP) { 110 | debug_print("Expect ATT READ response opcode (0x%02x) but received 0x%02x\n", BT_ATT_OP_READ_RSP, rpkt.opcode); 111 | return -2; 112 | } else if (result-1 > len) { 113 | debug_print("Result buffer overflow\n"); 114 | return -2; 115 | } else { 116 | int length = result-1; 117 | memcpy(buf, rpkt.buf, length); 118 | return length; 119 | } 120 | } 121 | 122 | int att_write(int fd, uint16_t handle, const void *buf, int length) 123 | { 124 | struct { uint8_t opcode; uint16_t handle; uint8_t buf[length]; } __attribute__((packed)) pkt; 125 | pkt.opcode = BT_ATT_OP_WRITE_CMD; 126 | pkt.handle = htobs(handle); 127 | 128 | if (sizeof pkt > BT_ATT_DEFAULT_LE_MTU) 129 | return -1; 130 | memcpy(pkt.buf, buf, length); 131 | 132 | int result = send(fd, &pkt, sizeof(pkt), 0); 133 | if (result<0) 134 | return result; 135 | 136 | return length; 137 | } 138 | 139 | int att_wrreq(int fd, uint16_t handle, const void *buf, int length) 140 | { 141 | struct { uint8_t opcode; uint16_t handle; uint8_t buf[length]; } __attribute__((packed)) pkt; 142 | pkt.opcode = BT_ATT_OP_WRITE_REQ; 143 | pkt.handle = htobs(handle); 144 | 145 | if (sizeof pkt > BT_ATT_DEFAULT_LE_MTU) 146 | return -1; 147 | memcpy(pkt.buf, buf, length); 148 | 149 | int result = send(fd, &pkt, sizeof(pkt), 0); 150 | if (result<0) 151 | return result; 152 | 153 | struct { uint8_t opcode; uint8_t buf[BT_ATT_DEFAULT_LE_MTU]; } __attribute__((packed)) rpkt = {0}; 154 | result = recv(fd, &rpkt, sizeof rpkt, 0); 155 | if (result < 0) 156 | return result; 157 | else if (rpkt.opcode == BT_ATT_OP_ERROR_RSP && result==1+sizeof(struct bt_att_pdu_error_rsp)) { 158 | struct bt_att_pdu_error_rsp *err = (void *)rpkt.buf; 159 | debug_print("ATT error for opcode 0x%02x, handle 0x%04x: %s\n", err->opcode, btohs(err->handle), att_ecode2str(err->ecode)); 160 | return -2; 161 | } else if (rpkt.opcode != BT_ATT_OP_WRITE_RSP) { 162 | debug_print("Expected ATT WRITE response opcode (0x%02x) but received 0x%02x\n", BT_ATT_OP_WRITE_RSP, rpkt.opcode); 163 | return -2; 164 | } 165 | 166 | return length; 167 | } 168 | 169 | int att_read_not(int fd, uint16_t *handle, void *buf, int len) 170 | { 171 | struct { uint8_t opcode; uint16_t handle; uint8_t buf[BT_ATT_DEFAULT_LE_MTU]; } __attribute__((packed)) rpkt; 172 | int result = recv(fd, &rpkt, sizeof rpkt, 0); 173 | 174 | if (result<0) 175 | return result; 176 | else if (rpkt.opcode == BT_ATT_OP_ERROR_RSP && result==1+sizeof(struct bt_att_pdu_error_rsp)) { 177 | struct bt_att_pdu_error_rsp *err = (void *)rpkt.buf; 178 | debug_print("ATT error for opcode 0x%02x, handle 0x%04x: %s\n", err->opcode, btohs(err->handle), att_ecode2str(err->ecode)); 179 | return -2; 180 | } else if (rpkt.opcode != BT_ATT_OP_HANDLE_VAL_NOT) { 181 | debug_print("Expect ATT NOTIFY opcode (0x%02x) but received 0x%02x\n", BT_ATT_OP_HANDLE_VAL_NOT, rpkt.opcode); 182 | return -2; 183 | } else if (result-3 > len) { 184 | debug_print("Result buffer overflow\n"); 185 | return -2; 186 | } else { 187 | int length = result-3; 188 | *handle = htobs(rpkt.handle); 189 | memcpy(buf, rpkt.buf, length); 190 | return length; 191 | } 192 | } 193 | 194 | const char * addr_type_name(int dst_type) { 195 | switch (dst_type) { 196 | case BDADDR_BREDR: return "BDADDR_BREDR"; 197 | case BDADDR_LE_PUBLIC: return "BDADDR_LE_PUBLIC"; 198 | case BDADDR_LE_RANDOM: return "BDADDR_LE_RANDOM"; 199 | default: return NULL; 200 | } 201 | } 202 | 203 | /** 204 | * This att_ecode2str function is copied from bluez/attrib/att.c 205 | * 206 | */ 207 | 208 | /* Error codes for Error response PDU */ 209 | #define ATT_ECODE_INVALID_HANDLE 0x01 210 | #define ATT_ECODE_READ_NOT_PERM 0x02 211 | #define ATT_ECODE_WRITE_NOT_PERM 0x03 212 | #define ATT_ECODE_INVALID_PDU 0x04 213 | #define ATT_ECODE_AUTHENTICATION 0x05 214 | #define ATT_ECODE_REQ_NOT_SUPP 0x06 215 | #define ATT_ECODE_INVALID_OFFSET 0x07 216 | #define ATT_ECODE_AUTHORIZATION 0x08 217 | #define ATT_ECODE_PREP_QUEUE_FULL 0x09 218 | #define ATT_ECODE_ATTR_NOT_FOUND 0x0A 219 | #define ATT_ECODE_ATTR_NOT_LONG 0x0B 220 | #define ATT_ECODE_INSUFF_ENCR_KEY_SIZE 0x0C 221 | #define ATT_ECODE_INVAL_ATTR_VALUE_LEN 0x0D 222 | #define ATT_ECODE_UNLIKELY 0x0E 223 | #define ATT_ECODE_INSUFF_ENC 0x0F 224 | #define ATT_ECODE_UNSUPP_GRP_TYPE 0x10 225 | #define ATT_ECODE_INSUFF_RESOURCES 0x11 226 | /* Application error */ 227 | #define ATT_ECODE_IO 0x80 228 | #define ATT_ECODE_TIMEOUT 0x81 229 | #define ATT_ECODE_ABORTED 0x82 230 | 231 | const char *att_ecode2str(uint8_t status) 232 | { 233 | switch (status) { 234 | case ATT_ECODE_INVALID_HANDLE: 235 | return "Invalid handle"; 236 | case ATT_ECODE_READ_NOT_PERM: 237 | return "Attribute can't be read"; 238 | case ATT_ECODE_WRITE_NOT_PERM: 239 | return "Attribute can't be written"; 240 | case ATT_ECODE_INVALID_PDU: 241 | return "Attribute PDU was invalid"; 242 | case ATT_ECODE_AUTHENTICATION: 243 | return "Attribute requires authentication before read/write"; 244 | case ATT_ECODE_REQ_NOT_SUPP: 245 | return "Server doesn't support the request received"; 246 | case ATT_ECODE_INVALID_OFFSET: 247 | return "Offset past the end of the attribute"; 248 | case ATT_ECODE_AUTHORIZATION: 249 | return "Attribute requires authorization before read/write"; 250 | case ATT_ECODE_PREP_QUEUE_FULL: 251 | return "Too many prepare writes have been queued"; 252 | case ATT_ECODE_ATTR_NOT_FOUND: 253 | return "No attribute found within the given range"; 254 | case ATT_ECODE_ATTR_NOT_LONG: 255 | return "Attribute can't be read/written using Read Blob Req"; 256 | case ATT_ECODE_INSUFF_ENCR_KEY_SIZE: 257 | return "Encryption Key Size is insufficient"; 258 | case ATT_ECODE_INVAL_ATTR_VALUE_LEN: 259 | return "Attribute value length is invalid"; 260 | case ATT_ECODE_UNLIKELY: 261 | return "Request attribute has encountered an unlikely error"; 262 | case ATT_ECODE_INSUFF_ENC: 263 | return "Encryption required before read/write"; 264 | case ATT_ECODE_UNSUPP_GRP_TYPE: 265 | return "Attribute type is not a supported grouping attribute"; 266 | case ATT_ECODE_INSUFF_RESOURCES: 267 | return "Insufficient Resources to complete the request"; 268 | case ATT_ECODE_IO: 269 | return "Internal application error: I/O"; 270 | case ATT_ECODE_TIMEOUT: 271 | return "A timeout occured"; 272 | case ATT_ECODE_ABORTED: 273 | return "The operation was aborted"; 274 | default: 275 | return "Unexpected error code"; 276 | } 277 | } 278 | -------------------------------------------------------------------------------- /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 | 635 | Copyright (C) 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 | Copyright (C) 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 | --------------------------------------------------------------------------------