2 * Linux Interfece for Arexx Data Loggers
4 * (c) 2011-2020 Martin Mares <mj@ucw.cz>
19 #include <libusb-1.0/libusb.h>
21 #define DEFAULT_LOG_DIR "/var/log/arexxd"
24 * Data points received from the logger are sometimes corrupted by noise.
25 * This effects not only the measured values, but also sensor IDs and timestamps.
26 * Since rrdtool cannot skip back in time, a random timestamp in the future can
27 * cause all further measurements to be dropped. To minimize impact of these
28 * problems, we drop data points which are too far in the past or in the future.
30 * Furthermore, you can ignore data from unrecognized sensors, i.e., those
31 * which are not handled by correct_point().
33 #define MAX_PAST_TIME 30*86400
34 #define MAX_FUTURE_TIME 300
35 #define IGNORE_UNKNOWN_SENSORS
40 typedef unsigned char byte;
41 typedef unsigned int uint;
42 static libusb_context *usb_ctxt;
43 static libusb_device_handle *devh;
45 static int use_syslog;
46 static int debug_mode;
47 static int debug_packets;
48 static int debug_raw_data;
49 static char *log_dir = DEFAULT_LOG_DIR;
52 #define UNUSED __attribute__((unused))
54 static int data_point_counter; // Since last log message
55 static time_t packet_rx_time;
57 static void die(char *fmt, ...)
62 vsyslog(LOG_CRIT, fmt, args);
64 vfprintf(stderr, fmt, args);
65 fprintf(stderr, "\n");
71 static void log_error(char *fmt, ...)
76 vsyslog(LOG_ERR, fmt, args);
78 vfprintf(stderr, fmt, args);
79 fprintf(stderr, "\n");
84 static void log_info(char *fmt, ...)
89 vsyslog(LOG_INFO, fmt, args);
91 vfprintf(stderr, fmt, args);
92 fprintf(stderr, "\n");
97 static void log_pkt(char *fmt, ...)
107 /*** MQTT interface ***/
111 #include <mosquitto.h>
113 static struct mosquitto *mosq;
115 static void mqtt_publish(const char *topic, const char *fmt, ...)
120 int l = vsnprintf(m, sizeof(m), fmt, args);
121 if (mosquitto_publish(mosq, NULL, topic, l, m, 0, true) != MOSQ_ERR_SUCCESS)
122 log_error("Mosquitto: publish failed");
126 static void mqtt_conn_callback(struct mosquitto *mosq UNUSED, void *obj UNUSED, int status)
129 mqtt_publish("status/arexxd", "ok");
132 static void mqtt_init(void)
134 mosquitto_lib_init();
135 mosq = mosquitto_new("arexxd", 1, NULL);
137 die("Mosquitto: initialization failed");
139 if (mosquitto_will_set(mosq, "status/arexxd", 4, "dead", 0, true) != MOSQ_ERR_SUCCESS)
140 die("Mosquitto: unable to set will");
142 mosquitto_connect_callback_set(mosq, mqtt_conn_callback);
144 if (mosquitto_connect(mosq, "10.32.184.5", 1883, 60) != MOSQ_ERR_SUCCESS)
145 die("Mosquitto: connect failed");
147 if (mosquitto_loop_start(mosq))
148 die("Mosquitto: cannot start service thread");
151 static void mqtt_point(time_t t, const char *name, double val, char *unit UNUSED)
153 // We do not feed past data to MQTT (so MAX_PAST_TIME is stronger for us)
154 if (t < packet_rx_time - 30)
158 snprintf(topic, sizeof(topic), "burrow/temp/%s", name);
159 mqtt_publish(topic, "%.3f %lld", val, (long long) t);
164 /*** RRD interface ***/
171 #define MAX_ARG_SIZE 1024
174 static char *arg_ptr[MAX_ARGS+1];
175 static char arg_buf[MAX_ARG_SIZE];
178 static void arg_new(void)
182 arg_ptr[0] = "rrdtool";
185 static void arg_push(const char *fmt, ...)
187 if (arg_cnt >= MAX_ARGS)
188 die("MAX_ARGS exceeded");
191 int len = 1 + vsnprintf(arg_buf + arg_pos, MAX_ARG_SIZE - arg_pos, fmt, va);
192 if (arg_pos + len > MAX_ARG_SIZE)
193 die("MAX_ARG_SIZE exceeded");
194 arg_ptr[arg_cnt++] = arg_buf + arg_pos;
195 arg_ptr[arg_cnt] = NULL;
199 static void rrd_point(time_t t, const char *name, double val, char *unit)
202 snprintf(rr_name, sizeof(rr_name), "sensor-%s.rrd", name);
205 if (stat(rr_name, &st) < 0 || !st.st_size) {
206 // We have to create the RRD
207 log_info("Creating %s", rr_name);
211 arg_push("%d", (int) time(NULL) - 28*86400);
214 if (!strcmp(unit, "%RH"))
215 arg_push("DS:rh:GAUGE:300:0:100");
216 else if (!strcmp(unit, "ppm"))
217 arg_push("DS:ppm:GAUGE:300:0:1000000");
219 arg_push("DS:temp:GAUGE:300:-200:200");
220 arg_push("RRA:AVERAGE:0.25:1:20160"); // Last 14 days with full resolution
221 arg_push("RRA:AVERAGE:0.25:60:88800"); // Last 10 years with 1h resolution
222 arg_push("RRA:MIN:0.25:60:88800"); // including minima and maxima
223 arg_push("RRA:MAX:0.25:60:88800");
224 rrd_create(arg_cnt, arg_ptr);
225 if (rrd_test_error()) {
226 log_error("rrd_create on %s failed: %s", rr_name, rrd_get_error());
234 arg_push("%d:%f", t, val);
235 rrd_update(arg_cnt, arg_ptr);
236 if (rrd_test_error()) {
237 log_error("rrd_update on %s failed: %s", rr_name, rrd_get_error());
246 #define TIME_OFFSET 946681200 // Timestamp of 2000-01-01 00:00:00
248 static double correct_point(uint id, double val, const char **name)
251 * Manually calculated corrections and renames for my sensors.
252 * Replace with your formulae.
268 *name = "ursarium-rh";
274 #ifdef IGNORE_UNKNOWN_SENSORS
281 static void cooked_point(time_t t, uint id, double val, char *unit, int q)
284 snprintf(namebuf, sizeof(namebuf), "%u", id);
285 const char *name = namebuf;
287 double val2 = correct_point(id, val, &name);
289 if (debug_raw_data) {
291 localtime_r(&t, &tm);
293 strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
294 printf("== %s id=%d name=%s val=%.3f val2=%.3f unit=%s q=%d\n", tbuf, id, name, val, val2, unit, q);
298 log_error("Ignored data from unknown sensor %d", id);
301 if (t < packet_rx_time - MAX_PAST_TIME) {
302 log_error("Data point from sensor %d too far in the past (%d sec)", packet_rx_time - t);
305 if (t > packet_rx_time + MAX_FUTURE_TIME) {
306 log_error("Data point from sensor %d too far in the future (%d sec)", t - packet_rx_time);
310 data_point_counter++;
312 rrd_point(t, name, val2, unit);
315 mqtt_point(t, name, val2, unit);
319 static void raw_point(uint t, uint id, int raw, int q)
322 * The binary blob provided by Arexx contains an embedded XML fragment
323 * with descriptions of all known sensor types. If you want to see it,
324 * grep the blob for "<deviceinfo>". The meanings of the parameters are
327 * m1, m2 Device type matches if (raw_sensor_id & m1) == m2
328 * type Unit measured by the sensor (1=Celsius, 2=RH%, 3=CO2 ppm)
329 * dm User-visible sensor ID = raw_sensor_id & dm
330 * i 1 if the raw value is signed
331 * p[] Coefficients of transformation polynomial (x^0 first)
332 * vLo, vUp Upper and lower bound on the final value
333 * scale Scaling function:
334 * 0 = identity (default)
337 * 3 = (x < 0) ? 0 : log10(x)
338 * 4 = (x < 0) ? 0 : log(x)
340 * The raw values are transformed this way:
341 * - sign-extend if signed
342 * - apply the transformation polynomial
343 * - apply the scaling function
344 * - drop if outside the interval [vLo,vUp]
346 * This function applies the necessary transform for sensors we've
347 * seen in the wild. We deliberately ignore the "dm" parameter as we want
348 * to report different channels of a single sensor as multiple sensors.
354 uint idhi = id & 0xfffff000;
355 uint idext = id & 0xf0000000;
357 if (idhi == 0x1000) {
362 } else if (idhi == 0x2000 || idext == 0x20000000) {
369 } else if (idhi == 0x4000) {
376 z = -2.8e-6*z*z + 0.0405*z - 4;
381 } else if (idhi == 0x6000) {
391 z = (z + 1.9184e-7) * z;
392 z = (z - 1.0998e-3) * z;
400 log_error("Unknown sensor type 0x%08x", id);
404 if (z < lo || z > hi) {
405 log_error("Sensor %d: value %f out of range", id, z);
409 cooked_point(t + TIME_OFFSET, id & 0x0fffffff, z, unit, q);
412 /*** USB interface ***/
414 static int rx_endpoint, tx_endpoint;
416 static int parse_descriptors(libusb_device *dev)
419 struct libusb_config_descriptor *desc;
421 if (err = libusb_get_active_config_descriptor(dev, &desc)) {
422 log_error("libusb_get_config_descriptor failed: error %d", err);
425 if (desc->bNumInterfaces != 1) {
426 log_error("Unexpected number of interfaces: %d", desc->bNumInterfaces);
430 const struct libusb_interface *iface = &desc->interface[0];
431 if (iface->num_altsetting != 1) {
432 log_error("Unexpected number of alternate interface settings: %d", iface->num_altsetting);
436 const struct libusb_interface_descriptor *ifd = &iface->altsetting[0];
437 if (ifd->bNumEndpoints != 2) {
438 log_error("Unexpected number of endpoints: %d", ifd->bNumEndpoints);
442 rx_endpoint = tx_endpoint = -1;
443 for (int i=0; i<2; i++) {
444 const struct libusb_endpoint_descriptor *epd = &ifd->endpoint[i];
445 if (epd->bEndpointAddress & 0x80)
446 rx_endpoint = epd->bEndpointAddress;
448 tx_endpoint = epd->bEndpointAddress;
450 if (rx_endpoint < 0 || tx_endpoint < 0) {
451 log_error("Failed to identify endpoints");
455 log_pkt("Found endpoints: rx==%02x tx=%02x\n", rx_endpoint, tx_endpoint);
456 libusb_free_config_descriptor(desc);
460 libusb_free_config_descriptor(desc);
464 static int find_device(void)
466 libusb_device **devlist;
467 ssize_t devn = libusb_get_device_list(usb_ctxt, &devlist);
469 log_error("Cannot enumerate USB devices: error %d", (int) devn);
473 for (ssize_t i=0; i<devn; i++) {
474 struct libusb_device_descriptor desc;
475 libusb_device *dev = devlist[i];
476 if (!libusb_get_device_descriptor(dev, &desc)) {
477 if (desc.idVendor == 0x0451 && desc.idProduct == 0x3211) {
478 log_info("Arexx data logger found at usb%d.%d", libusb_get_bus_number(dev), libusb_get_device_address(dev));
479 if (!parse_descriptors(dev))
482 if (err = libusb_open(dev, &devh)) {
483 log_error("libusb_open() failed: error %d", err);
486 if (err = libusb_claim_interface(devh, 0)) {
487 log_error("libusb_claim_interface() failed: error %d", err);
491 libusb_free_device_list(devlist, 1);
498 libusb_free_device_list(devlist, 1);
502 static void release_device(void)
504 libusb_release_interface(devh, 0);
505 libusb_reset_device(devh);
510 static void dump_packet(byte *pkt)
512 for (int i=0; i<64; i++) {
514 log_pkt("\t%02x:", i);
515 log_pkt(" %02x", pkt[i]);
521 static void my_msleep(int ms)
523 struct timespec ts = { .tv_sec = ms/1000, .tv_nsec = (ms%1000) * 1000000 };
524 nanosleep(&ts, NULL);
527 static int send_and_receive(byte *req, byte *reply)
530 time_t t = time(NULL);
532 localtime_r(&t, &tm);
535 strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
536 log_pkt("## %s\n", tbuf);
539 int err, transferred;
540 if (err = libusb_bulk_transfer(devh, tx_endpoint, req, 64, &transferred, 200)) {
541 if (err == LIBUSB_ERROR_TIMEOUT) {
542 log_pkt(">> xmit timed out\n");
545 log_pkt(">> xmit error %d\n", err);
546 log_error("Transmit error: %d", err);
550 log_pkt(">> xmit %d bytes\n", transferred);
554 if (err = libusb_bulk_transfer(devh, rx_endpoint, reply, 64, &transferred, 200)) {
555 if (err == LIBUSB_ERROR_TIMEOUT) {
556 log_pkt("<< recv timed out\n");
559 log_pkt("<< recv error %d\n", err);
560 log_error("Receive error: %d", err);
563 packet_rx_time = time(NULL);
565 log_pkt("<< recv %d bytes\n", transferred);
566 while (transferred < 64)
567 reply[transferred++] = 0xff;
573 static unsigned int get_be16(byte *p)
575 return p[1] | (p[0] << 8);
578 static unsigned int get_le16(byte *p)
580 return p[0] | (p[1] << 8);
583 static unsigned int get_le32(byte *p)
585 return get_le16(p) | (get_le16(p+2) << 16);
588 static void put_le16(byte *p, unsigned int x)
594 static void put_le32(byte *p, unsigned int x)
597 put_le16(p+2, x>>16);
600 static int parse_packet(byte *reply)
603 log_error("Unknown packet type %02x", reply[0]);
610 byte *p = reply + pos;
612 if (!len || len == 0xff)
614 if (pos + len > 64) {
615 log_error("Tuple truncated");
627 q = (len > 9) ? p[9] : -1;
636 log_error("Unknown tuple length %02x", len);
640 if (debug_raw_data) {
641 printf("... %02x: id=%08x raw=%d t=%u", len, id, raw, t);
646 raw_point(t, id, raw, q);
655 static void set_clock(void)
657 byte req[64], reply[64];
660 time_t t = time(NULL);
661 put_le32(req+1, t-TIME_OFFSET);
662 send_and_receive(req, reply);
666 * Original software also sends a packet with type 3 and the timestamp,
667 * but it does not make any sense, especially as they ignore the sensor
668 * readings in the answer.
671 send_and_receive(req, reply);
678 static sigset_t term_sigs;
679 static volatile sig_atomic_t want_shutdown;
681 static void sigterm_handler(int sig UNUSED)
686 static void interruptible_msleep(int ms)
688 sigprocmask(SIG_UNBLOCK, &term_sigs, NULL);
690 sigprocmask(SIG_BLOCK, &term_sigs, NULL);
693 static const struct option long_options[] = {
694 { "debug", 0, NULL, 'd' },
695 { "log-dir", 1, NULL, 'l' },
696 { "no-fork", 0, NULL, 'n' },
697 { "debug-packets", 0, NULL, 'p' },
698 { "debug-raw", 0, NULL, 'r' },
699 { "version", 0, NULL, 'V' },
700 { NULL, 0, NULL, 0 },
703 static void usage(void)
706 Usage: arexxd <options>\n\
709 -d, --debug Debug mode (no chdir, no fork, no syslog)\n\
710 -l, --log-dir=<dir> Directory where all received data should be stored\n\
711 -n, --no-fork Do not fork\n\
712 -p, --debug-packets Log all packets sent and received\n\
713 -r, --debug-raw Log conversion from raw values\n\
714 -V, --version Show daemon version\n\
719 int main(int argc, char **argv)
722 while ((opt = getopt_long(argc, argv, "dl:nprV", long_options, NULL)) >= 0)
740 printf("arexxd " AREXXD_VERSION "\n");
741 printf("(c) 2011-2018 Martin Mares <mj@ucw.cz>\n");
750 if (err = libusb_init(&usb_ctxt))
751 die("Cannot initialize libusb: error %d", err);
754 if (chdir(log_dir) < 0)
755 die("Cannot change directory to %s: %m", log_dir);
756 if (debug_packets || debug_raw_data) {
758 if (open("debug", O_WRONLY | O_CREAT | O_APPEND, 0666) < 0)
759 die("Cannot open debug log: %m");
762 openlog("arexxd", LOG_NDELAY, LOG_DAEMON);
766 die("fork() failed: %m");
778 struct sigaction sa = { .sa_handler = sigterm_handler };
779 sigaction(SIGTERM, &sa, NULL);
780 sigaction(SIGINT, &sa, NULL);
782 sigemptyset(&term_sigs);
783 sigaddset(&term_sigs, SIGTERM);
784 sigaddset(&term_sigs, SIGINT);
785 sigprocmask(SIG_BLOCK, &term_sigs, NULL);
788 while (!want_shutdown) {
789 if (!find_device()) {
792 log_error("Data logger not connected, waiting until it appears");
794 interruptible_msleep(30000);
797 log_info("Listening");
799 time_t last_sync = 0;
800 time_t last_show = 0;
803 data_point_counter = 0;
804 while (!want_shutdown) {
805 time_t now = time(NULL);
806 if (now > last_sync + 900) {
807 log_info("Synchronizing data logger time");
811 if (want_stats && now > last_show + 300) {
812 log_info("Stats: received %d data points", data_point_counter);
813 data_point_counter = 0;
817 byte req[64], reply[64];
818 memset(req, 0, sizeof(req));
820 err = send_and_receive(req, reply);
824 if (err > 0 && parse_packet(reply))
827 interruptible_msleep(4000);
830 interruptible_msleep(5);
833 log_info("Disconnecting data logger");
836 interruptible_msleep(10000);
839 log_info("Terminated");