[hmcfgusb] / hmsniff.c

/* HM-sniffer for HM-CFG-USB
 *
 * Copyright (c) 2013-16 Michael Gernoth <michael@gernoth.net>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to
 * deal in the Software without restriction, including without limitation the
 * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
 * sell copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
 * IN THE SOFTWARE.
 */

#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <stdint.h>
#include <string.h>
#include <strings.h>
#include <poll.h>
#include <errno.h>
#include <time.h>
#include <sys/time.h>
#include <libusb-1.0/libusb.h>

#include "version.h"
#include "hexdump.h"
#include "hmcfgusb.h"

static int verbose = 0;

/* See HMConfig.pm */
char *hm_message_types(uint8_t type, uint8_t subtype)
{
	switch(type) {
		case 0x00:
			return "Device Info";
			break;
		case 0x01:
			return "Configuration";
			break;
		case 0x02:
			if (subtype >= 0x80 && subtype <= 0x8f) {
				return "NACK";
			} else if (subtype == 0x01) {
				return "ACKinfo";
			} else if (subtype == 0x04) {
				return "AESrequest";
			}
			return "ACK";
			break;
		case 0x03:
			return "AESreply";
			break;
		case 0x04:
			return "AESkey";
			break;
		case 0x10:
			return "Information";
			break;
		case 0x11:
			return "SET";
			break;
		case 0x12:
			return "HAVE_DATA";
			break;
		case 0x3e:
			return "Switch";
			break;
		case 0x3f:
			return "Timestamp";
			break;
		case 0x40:
			return "Remote";
			break;
		case 0x41:
			return "Sensor";
			break;
		case 0x53:
			return "Water sensor";
			break;
		case 0x58:
			return "Climate event";
			break;
		case 0x5a:
			return "Thermal control";
			break;
		case 0x5e:
			return "Power event";
			break;
		case 0x70:
			return "Weather event";
			break;
		case 0xca:
			return "Firmware";
			break;
		case 0xcb:
			return "Rf configuration";
			break;
		default:
			return "?";
			break;
	}
}

static void dissect_hm(uint8_t *buf, int len)
{
	struct timeval tv;
	struct tm *tmp;
	char ts[32];
	static int count = 0;
	int i;

	gettimeofday(&tv, NULL);
	tmp = localtime(&tv.tv_sec);
	memset(ts, 0, sizeof(ts));
	strftime(ts, sizeof(ts)-1, "%Y-%m-%d %H:%M:%S", tmp);

	if (verbose) {
		printf("%s.%06ld: ", ts, tv.tv_usec);

		for (i = 0; i < len; i++) {
			printf("%02X", buf[i]);
		}
		printf("\n");
		printf("Packet information:\n");
		printf("\tLength: %u\n", buf[0]);
		printf("\tMessage ID: %u\n", buf[1]);
		printf("\tSender: %02x%02x%02x\n", buf[4], buf[5], buf[6]);
		printf("\tReceiver: %02x%02x%02x\n", buf[7], buf[8], buf[9]);
		printf("\tControl Byte: 0x%02x\n", buf[2]);
		printf("\t\tFlags: ");
		if (buf[2] & (1 << 0)) printf("WAKEUP ");
		if (buf[2] & (1 << 1)) printf("WAKEMEUP ");
		if (buf[2] & (1 << 2)) printf("CFG ");
		if (buf[2] & (1 << 3)) printf("? ");
		if (buf[2] & (1 << 4)) printf("BURST ");
		if (buf[2] & (1 << 5)) printf("BIDI ");
		if (buf[2] & (1 << 6)) printf("RPTED ");
		if (buf[2] & (1 << 7)) printf("RPTEN ");
		printf("\n");
		printf("\tMessage type: %s (0x%02x 0x%02x)\n", hm_message_types(buf[3], buf[10]), buf[3], buf[10]);
		printf("\tMessage: ");
		for (i = 10; i < len; i++) {
			printf("%02X", buf[i]);
		}
		printf("\n");

		printf("\n");
	} else {
		if (!(count++ % 20))
			printf("                         LL NR FL CM sender recvr  payload\n");

		printf("%s.%03ld: %02X %02X %02X %02X %02X%02X%02X %02X%02X%02X ",
				ts, tv.tv_usec/1000,
				buf[0], buf[1], buf[2], buf[3],
				buf[4], buf[5], buf[6],
				buf[7], buf[8], buf[9]);

		for (i = 10; i < len; i++) {
			printf("%02X", buf[i]);
		}
		printf("%s(%s)\n", (i>10)?" ":"", hm_message_types(buf[3], buf[10]));
	}
}

struct recv_data {
	int wrong_hmid;
};

static int parse_hmcfgusb(uint8_t *buf, int buf_len, void *data)
{
	struct recv_data *rdata = data;

	if (buf_len < 1)
		return 1;

	switch(buf[0]) {
		case 'E':
			dissect_hm(buf + 13, buf[13] + 1);
			break;
		case 'H':
			if ((buf[27] != 0x00) ||
			    (buf[28] != 0x00) ||
			    (buf[29] != 0x00)) {
				printf("hmId is currently set to: %02x%02x%02x\n", buf[27], buf[28], buf[29]);
				rdata->wrong_hmid = 1;
			}
			break;
		case 'R':
		case 'I':
		case 'G':
			break;
		default:
			hexdump(buf, buf_len, "Unknown> ");
			break;
	}

	return 1;
}

void hmsniff_syntax(char *prog)
{
	fprintf(stderr, "Syntax: %s options\n\n", prog);
	fprintf(stderr, "Possible options:\n");
	fprintf(stderr, "\t-f\t\tfast (100k/firmware update) mode\n");
	fprintf(stderr, "\t-S serial\tuse HM-CFG-USB with given serial\n");
	fprintf(stderr, "\t-v\t\tverbose mode\n");
	fprintf(stderr, "\t-V\t\tshow version (" VERSION ")\n");

}

int main(int argc, char **argv)
{
	struct hmcfgusb_dev *dev;
	struct recv_data rdata;
	char *serial = NULL;
	int quit = 0;
	int speed = 10;
	uint8_t speed_buf[2];
	int opt;

	while((opt = getopt(argc, argv, "fS:vV")) != -1) {
		switch (opt) {
			case 'f':
				speed = 100;
				break;
			case 'S':
				serial = optarg;
				break;
			case 'v':
				verbose = 1;
				break;
			case 'V':
				printf("hmsniff " VERSION "\n");
				printf("Copyright (c) 2013-16 Michael Gernoth\n\n");
				exit(EXIT_SUCCESS);
			case 'h':
			case ':':
			case '?':
			default:
				hmsniff_syntax(argv[0]);
				exit(EXIT_FAILURE);
				break;
		}
	}

	hmcfgusb_set_debug(0);

	do {
		memset(&rdata, 0, sizeof(rdata));
		rdata.wrong_hmid = 0;

		dev = hmcfgusb_init(parse_hmcfgusb, &rdata, serial);
		if (!dev) {
			fprintf(stderr, "Can't initialize HM-CFG-USB, retrying in 1s...\n");
			sleep(1);
			continue;
		}
		printf("HM-CFG-USB opened!\n");

		hmcfgusb_send_null_frame(dev, 1);
		hmcfgusb_send(dev, (unsigned char*)"K", 1, 1);

		hmcfgusb_send_null_frame(dev, 1);
		speed_buf[0] = 'G';
		speed_buf[1] = speed;
		hmcfgusb_send(dev, speed_buf, 2, 1);

		while(!quit) {
			int fd;

			if (rdata.wrong_hmid) {
				printf("changing hmId to 000000, this might reboot the device!\n");
				hmcfgusb_send(dev, (unsigned char*)"A\00\00\00", 4, 1);
				rdata.wrong_hmid = 0;
				hmcfgusb_send(dev, (unsigned char*)"K", 1, 1);
			}
			fd = hmcfgusb_poll(dev, 1000);
			if (fd >= 0) {
				fprintf(stderr, "activity on unknown fd %d!\n", fd);
				continue;
			} else if (fd == -1) {
				if (errno) {
					if (errno != ETIMEDOUT) {
						perror("hmcfgusb_poll");
						break;
					} else {
						/* periodically wakeup the device */
						hmcfgusb_send_null_frame(dev, 1);
					}
				}
			}
		}

		hmcfgusb_close(dev);
	} while (!quit);

	hmcfgusb_exit();

	return EXIT_SUCCESS;
}
Commit	Line	Data
d57fdaf6 MG	1	/* HM-sniffer for HM-CFG-USB
d57fdaf6 MG	2	*
7ba4ea19	3	* Copyright (c) 2013-16 Michael Gernoth <michael@gernoth.net>
d57fdaf6 MG	4	*
	5	* Permission is hereby granted, free of charge, to any person obtaining a copy
	6	* of this software and associated documentation files (the "Software"), to
	7	* deal in the Software without restriction, including without limitation the
	8	* rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
	9	* sell copies of the Software, and to permit persons to whom the Software is
	10	* furnished to do so, subject to the following conditions:
	11	*
	12	* The above copyright notice and this permission notice shall be included in
	13	* all copies or substantial portions of the Software.
	14	*
	15	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	16	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	17	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	18	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	19	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
	20	* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
	21	* IN THE SOFTWARE.
	22	*/
	23
	24	#include <stdio.h>
	25	#include <stdlib.h>
	26	#include <unistd.h>
	27	#include <stdint.h>
	28	#include <string.h>
	29	#include <strings.h>
	30	#include <poll.h>
	31	#include <errno.h>
cd45e4af	32	#include <time.h>
e2776af8	33	#include <sys/time.h>
d57fdaf6 MG	34	#include <libusb-1.0/libusb.h>
d57fdaf6 MG	35
c44f15b8	36	#include "version.h"
d57fdaf6 MG	37	#include "hexdump.h"
	38	#include "hmcfgusb.h"
	39
cd45e4af MG	40	static int verbose = 0;
cd45e4af MG	41
d57fdaf6	42	/* See HMConfig.pm */
cd45e4af	43	char *hm_message_types(uint8_t type, uint8_t subtype)
d57fdaf6 MG	44	{
	45	switch(type) {
	46	case 0x00:
	47	return "Device Info";
	48	break;
	49	case 0x01:
	50	return "Configuration";
	51	break;
	52	case 0x02:
cd45e4af MG	53	if (subtype >= 0x80 && subtype <= 0x8f) {
	54	return "NACK";
	55	} else if (subtype == 0x01) {
	56	return "ACKinfo";
	57	} else if (subtype == 0x04) {
	58	return "AESrequest";
	59	}
	60	return "ACK";
d57fdaf6 MG	61	break;
d57fdaf6 MG	62	case 0x03:
cd45e4af	63	return "AESreply";
d57fdaf6 MG	64	break;
d57fdaf6 MG	65	case 0x04:
cd45e4af	66	return "AESkey";
d57fdaf6 MG	67	break;
	68	case 0x10:
	69	return "Information";
	70	break;
	71	case 0x11:
	72	return "SET";
	73	break;
	74	case 0x12:
	75	return "HAVE_DATA";
	76	break;
	77	case 0x3e:
	78	return "Switch";
	79	break;
	80	case 0x3f:
	81	return "Timestamp";
	82	break;
	83	case 0x40:
	84	return "Remote";
	85	break;
	86	case 0x41:
	87	return "Sensor";
	88	break;
	89	case 0x53:
	90	return "Water sensor";
	91	break;
	92	case 0x58:
	93	return "Climate event";
	94	break;
cd45e4af MG	95	case 0x5a:
	96	return "Thermal control";
	97	break;
920d34e0 MG	98	case 0x5e:
	99	return "Power event";
	100	break;
d57fdaf6 MG	101	case 0x70:
	102	return "Weather event";
	103	break;
84daa92b MG	104	case 0xca:
	105	return "Firmware";
	106	break;
	107	case 0xcb:
	108	return "Rf configuration";
	109	break;
d57fdaf6 MG	110	default:
	111	return "?";
	112	break;
	113	}
	114	}
	115
	116	static void dissect_hm(uint8_t *buf, int len)
	117	{
e2776af8 MG	118	struct timeval tv;
	119	struct tm *tmp;
	120	char ts[32];
cd45e4af	121	static int count = 0;
d57fdaf6 MG	122	int i;
d57fdaf6 MG	123
e2776af8 MG	124	gettimeofday(&tv, NULL);
	125	tmp = localtime(&tv.tv_sec);
	126	memset(ts, 0, sizeof(ts));
	127	strftime(ts, sizeof(ts)-1, "%Y-%m-%d %H:%M:%S", tmp);
e2776af8	128
cd45e4af MG	129	if (verbose) {
	130	printf("%s.%06ld: ", ts, tv.tv_usec);
	131
	132	for (i = 0; i < len; i++) {
	133	printf("%02X", buf[i]);
	134	}
	135	printf("\n");
	136	printf("Packet information:\n");
	137	printf("\tLength: %u\n", buf[0]);
	138	printf("\tMessage ID: %u\n", buf[1]);
	139	printf("\tSender: %02x%02x%02x\n", buf[4], buf[5], buf[6]);
	140	printf("\tReceiver: %02x%02x%02x\n", buf[7], buf[8], buf[9]);
	141	printf("\tControl Byte: 0x%02x\n", buf[2]);
	142	printf("\t\tFlags: ");
	143	if (buf[2] & (1 << 0)) printf("WAKEUP ");
	144	if (buf[2] & (1 << 1)) printf("WAKEMEUP ");
	145	if (buf[2] & (1 << 2)) printf("CFG ");
	146	if (buf[2] & (1 << 3)) printf("? ");
	147	if (buf[2] & (1 << 4)) printf("BURST ");
	148	if (buf[2] & (1 << 5)) printf("BIDI ");
	149	if (buf[2] & (1 << 6)) printf("RPTED ");
	150	if (buf[2] & (1 << 7)) printf("RPTEN ");
	151	printf("\n");
	152	printf("\tMessage type: %s (0x%02x 0x%02x)\n", hm_message_types(buf[3], buf[10]), buf[3], buf[10]);
	153	printf("\tMessage: ");
	154	for (i = 10; i < len; i++) {
	155	printf("%02X", buf[i]);
	156	}
	157	printf("\n");
	158
	159	printf("\n");
	160	} else {
	161	if (!(count++ % 20))
	162	printf(" LL NR FL CM sender recvr payload\n");
920d34e0	163
cd45e4af MG	164	printf("%s.%03ld: %02X %02X %02X %02X %02X%02X%02X %02X%02X%02X ",
	165	ts, tv.tv_usec/1000,
	166	buf[0], buf[1], buf[2], buf[3],
	167	buf[4], buf[5], buf[6],
	168	buf[7], buf[8], buf[9]);
	169
	170	for (i = 10; i < len; i++) {
	171	printf("%02X", buf[i]);
	172	}
	173	printf("%s(%s)\n", (i>10)?" ":"", hm_message_types(buf[3], buf[10]));
d57fdaf6	174	}
d57fdaf6 MG	175	}
d57fdaf6 MG	176
885a84e3 MG	177	struct recv_data {
	178	int wrong_hmid;
	179	};
	180
4371275b	181	static int parse_hmcfgusb(uint8_t buf, int buf_len, void data)
d57fdaf6	182	{
885a84e3 MG	183	struct recv_data *rdata = data;
885a84e3 MG	184
d57fdaf6	185	if (buf_len < 1)
4371275b	186	return 1;
d57fdaf6 MG	187
	188	switch(buf[0]) {
	189	case 'E':
	190	dissect_hm(buf + 13, buf[13] + 1);
	191	break;
	192	case 'H':
885a84e3 MG	193	if ((buf[27] != 0x00) \|\|
	194	(buf[28] != 0x00) \|\|
	195	(buf[29] != 0x00)) {
	196	printf("hmId is currently set to: %02x%02x%02x\n", buf[27], buf[28], buf[29]);
	197	rdata->wrong_hmid = 1;
	198	}
	199	break;
d57fdaf6 MG	200	case 'R':
d57fdaf6 MG	201	case 'I':
84daa92b	202	case 'G':
d57fdaf6 MG	203	break;
	204	default:
	205	hexdump(buf, buf_len, "Unknown> ");
	206	break;
	207	}
4371275b MG	208
4371275b MG	209	return 1;
d57fdaf6 MG	210	}
d57fdaf6 MG	211
cd45e4af MG	212	void hmsniff_syntax(char *prog)
	213	{
	214	fprintf(stderr, "Syntax: %s options\n\n", prog);
	215	fprintf(stderr, "Possible options:\n");
84daa92b	216	fprintf(stderr, "\t-f\t\tfast (100k/firmware update) mode\n");
f51714be	217	fprintf(stderr, "\t-S serial\tuse HM-CFG-USB with given serial\n");
cd45e4af MG	218	fprintf(stderr, "\t-v\t\tverbose mode\n");
	219	fprintf(stderr, "\t-V\t\tshow version (" VERSION ")\n");
	220
	221	}
	222
d57fdaf6 MG	223	int main(int argc, char **argv)
	224	{
	225	struct hmcfgusb_dev *dev;
885a84e3	226	struct recv_data rdata;
f51714be	227	char *serial = NULL;
d57fdaf6	228	int quit = 0;
84daa92b MG	229	int speed = 10;
84daa92b MG	230	uint8_t speed_buf[2];
cd45e4af MG	231	int opt;
cd45e4af MG	232
f51714be	233	while((opt = getopt(argc, argv, "fS:vV")) != -1) {
cd45e4af	234	switch (opt) {
84daa92b MG	235	case 'f':
	236	speed = 100;
	237	break;
f51714be MG	238	case 'S':
	239	serial = optarg;
	240	break;
cd45e4af MG	241	case 'v':
	242	verbose = 1;
	243	break;
	244	case 'V':
	245	printf("hmsniff " VERSION "\n");
7ba4ea19	246	printf("Copyright (c) 2013-16 Michael Gernoth\n\n");
cd45e4af MG	247	exit(EXIT_SUCCESS);
	248	case 'h':
	249	case ':':
	250	case '?':
	251	default:
	252	hmsniff_syntax(argv[0]);
	253	exit(EXIT_FAILURE);
	254	break;
	255	}
	256	}
d57fdaf6 MG	257
	258	hmcfgusb_set_debug(0);
	259
885a84e3 MG	260	do {
	261	memset(&rdata, 0, sizeof(rdata));
	262	rdata.wrong_hmid = 0;
d57fdaf6	263
f51714be	264	dev = hmcfgusb_init(parse_hmcfgusb, &rdata, serial);
885a84e3 MG	265	if (!dev) {
	266	fprintf(stderr, "Can't initialize HM-CFG-USB, retrying in 1s...\n");
	267	sleep(1);
	268	continue;
	269	}
	270	printf("HM-CFG-USB opened!\n");
d57fdaf6	271
6262005e	272	hmcfgusb_send_null_frame(dev, 1);
885a84e3	273	hmcfgusb_send(dev, (unsigned char*)"K", 1, 1);
d57fdaf6	274
84daa92b MG	275	hmcfgusb_send_null_frame(dev, 1);
	276	speed_buf[0] = 'G';
	277	speed_buf[1] = speed;
	278	hmcfgusb_send(dev, speed_buf, 2, 1);
	279
885a84e3 MG	280	while(!quit) {
	281	int fd;
	282
	283	if (rdata.wrong_hmid) {
	284	printf("changing hmId to 000000, this might reboot the device!\n");
	285	hmcfgusb_send(dev, (unsigned char*)"A\00\00\00", 4, 1);
	286	rdata.wrong_hmid = 0;
	287	hmcfgusb_send(dev, (unsigned char*)"K", 1, 1);
	288	}
3b35a8c1	289	fd = hmcfgusb_poll(dev, 1000);
885a84e3 MG	290	if (fd >= 0) {
	291	fprintf(stderr, "activity on unknown fd %d!\n", fd);
	292	continue;
	293	} else if (fd == -1) {
	294	if (errno) {
1e79d00a MG	295	if (errno != ETIMEDOUT) {
	296	perror("hmcfgusb_poll");
	297	break;
	298	} else {
	299	/* periodically wakeup the device */
	300	hmcfgusb_send_null_frame(dev, 1);
	301	}
885a84e3	302	}
d57fdaf6 MG	303	}
d57fdaf6 MG	304	}
d57fdaf6	305
885a84e3 MG	306	hmcfgusb_close(dev);
	307	} while (!quit);
	308
018f85fa MG	309	hmcfgusb_exit();
018f85fa MG	310
d57fdaf6 MG	311	return EXIT_SUCCESS;
d57fdaf6 MG	312	}