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_tls_set(mosq, "/etc/burrow-mqtt/ca.crt", NULL, "/etc/burrow-mqtt/client.crt", "/etc/burrow-mqtt/client.key", NULL) != MOSQ_ERR_SUCCESS)
140 die("Mosquitto: unable to set TLS parameters");
142 if (mosquitto_will_set(mosq, "status/arexxd", 4, "dead", 0, true) != MOSQ_ERR_SUCCESS)
143 die("Mosquitto: unable to set will");
145 mosquitto_connect_callback_set(mosq, mqtt_conn_callback);
147 if (mosquitto_connect(mosq, "burrow-mqtt", 8883, 60) != MOSQ_ERR_SUCCESS)
148 die("Mosquitto: connect failed");
150 if (mosquitto_loop_start(mosq))
151 die("Mosquitto: cannot start service thread");
154 static void mqtt_point(time_t t, const char *name, double val, char *unit UNUSED)
156 // We do not feed past data to MQTT (so MAX_PAST_TIME is stronger for us)
157 if (t < packet_rx_time - 30)
161 snprintf(topic, sizeof(topic), "burrow/temp/%s", name);
162 mqtt_publish(topic, "%.3f %lld", val, (long long) t);
167 /*** RRD interface ***/
174 #define MAX_ARG_SIZE 1024
177 static char *arg_ptr[MAX_ARGS+1];
178 static char arg_buf[MAX_ARG_SIZE];
181 static void arg_new(void)
185 arg_ptr[0] = "rrdtool";
188 static void arg_push(const char *fmt, ...)
190 if (arg_cnt >= MAX_ARGS)
191 die("MAX_ARGS exceeded");
194 int len = 1 + vsnprintf(arg_buf + arg_pos, MAX_ARG_SIZE - arg_pos, fmt, va);
195 if (arg_pos + len > MAX_ARG_SIZE)
196 die("MAX_ARG_SIZE exceeded");
197 arg_ptr[arg_cnt++] = arg_buf + arg_pos;
198 arg_ptr[arg_cnt] = NULL;
202 static void rrd_point(time_t t, const char *name, double val, char *unit)
205 snprintf(rr_name, sizeof(rr_name), "sensor-%s.rrd", name);
208 if (stat(rr_name, &st) < 0 || !st.st_size) {
209 // We have to create the RRD
210 log_info("Creating %s", rr_name);
214 arg_push("%d", (int) time(NULL) - 28*86400);
217 if (!strcmp(unit, "%RH"))
218 arg_push("DS:rh:GAUGE:300:0:100");
219 else if (!strcmp(unit, "ppm"))
220 arg_push("DS:ppm:GAUGE:300:0:1000000");
222 arg_push("DS:temp:GAUGE:300:-200:200");
223 arg_push("RRA:AVERAGE:0.25:1:20160"); // Last 14 days with full resolution
224 arg_push("RRA:AVERAGE:0.25:60:88800"); // Last 10 years with 1h resolution
225 arg_push("RRA:MIN:0.25:60:88800"); // including minima and maxima
226 arg_push("RRA:MAX:0.25:60:88800");
227 rrd_create(arg_cnt, arg_ptr);
228 if (rrd_test_error()) {
229 log_error("rrd_create on %s failed: %s", rr_name, rrd_get_error());
237 arg_push("%d:%f", t, val);
238 rrd_update(arg_cnt, arg_ptr);
239 if (rrd_test_error()) {
240 log_error("rrd_update on %s failed: %s", rr_name, rrd_get_error());
249 #define TIME_OFFSET 946681200 // Timestamp of 2000-01-01 00:00:00
251 static double correct_point(uint id, double val, const char **name)
254 * Manually calculated corrections and renames for my sensors.
255 * Replace with your formulae.
271 *name = "ursarium-rh";
277 #ifdef IGNORE_UNKNOWN_SENSORS
284 static void cooked_point(time_t t, uint id, double val, char *unit, int q)
287 snprintf(namebuf, sizeof(namebuf), "%u", id);
288 const char *name = namebuf;
290 double val2 = correct_point(id, val, &name);
292 if (debug_raw_data) {
294 localtime_r(&t, &tm);
296 strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
297 printf("== %s id=%d name=%s val=%.3f val2=%.3f unit=%s q=%d\n", tbuf, id, name, val, val2, unit, q);
301 log_error("Ignored data from unknown sensor %d", id);
304 if (t < packet_rx_time - MAX_PAST_TIME) {
305 log_error("Data point from sensor %d too far in the past (%d sec)", packet_rx_time - t);
308 if (t > packet_rx_time + MAX_FUTURE_TIME) {
309 log_error("Data point from sensor %d too far in the future (%d sec)", t - packet_rx_time);
313 data_point_counter++;
315 rrd_point(t, name, val2, unit);
318 mqtt_point(t, name, val2, unit);
322 static void raw_point(uint t, uint id, int raw, int q)
325 * The binary blob provided by Arexx contains an embedded XML fragment
326 * with descriptions of all known sensor types. If you want to see it,
327 * grep the blob for "<deviceinfo>". The meanings of the parameters are
330 * m1, m2 Device type matches if (raw_sensor_id & m1) == m2
331 * type Unit measured by the sensor (1=Celsius, 2=RH%, 3=CO2 ppm)
332 * dm User-visible sensor ID = raw_sensor_id & dm
333 * i 1 if the raw value is signed
334 * p[] Coefficients of transformation polynomial (x^0 first)
335 * vLo, vUp Upper and lower bound on the final value
336 * scale Scaling function:
337 * 0 = identity (default)
340 * 3 = (x < 0) ? 0 : log10(x)
341 * 4 = (x < 0) ? 0 : log(x)
343 * The raw values are transformed this way:
344 * - sign-extend if signed
345 * - apply the transformation polynomial
346 * - apply the scaling function
347 * - drop if outside the interval [vLo,vUp]
349 * This function applies the necessary transform for sensors we've
350 * seen in the wild. We deliberately ignore the "dm" parameter as we want
351 * to report different channels of a single sensor as multiple sensors.
357 uint idhi = id & 0xfffff000;
358 uint idext = id & 0xf0000000;
360 if (idhi == 0x1000) {
365 } else if (idhi == 0x2000 || idext == 0x20000000) {
372 } else if (idhi == 0x4000) {
379 z = -2.8e-6*z*z + 0.0405*z - 4;
384 } else if (idhi == 0x6000) {
394 z = (z + 1.9184e-7) * z;
395 z = (z - 1.0998e-3) * z;
403 log_error("Unknown sensor type 0x%08x", id);
407 if (z < lo || z > hi) {
408 log_error("Sensor %d: value %f out of range", id, z);
412 cooked_point(t + TIME_OFFSET, id & 0x0fffffff, z, unit, q);
415 /*** USB interface ***/
417 static int rx_endpoint, tx_endpoint;
419 static int parse_descriptors(libusb_device *dev)
422 struct libusb_config_descriptor *desc;
424 if (err = libusb_get_active_config_descriptor(dev, &desc)) {
425 log_error("libusb_get_config_descriptor failed: error %d", err);
428 if (desc->bNumInterfaces != 1) {
429 log_error("Unexpected number of interfaces: %d", desc->bNumInterfaces);
433 const struct libusb_interface *iface = &desc->interface[0];
434 if (iface->num_altsetting != 1) {
435 log_error("Unexpected number of alternate interface settings: %d", iface->num_altsetting);
439 const struct libusb_interface_descriptor *ifd = &iface->altsetting[0];
440 if (ifd->bNumEndpoints != 2) {
441 log_error("Unexpected number of endpoints: %d", ifd->bNumEndpoints);
445 rx_endpoint = tx_endpoint = -1;
446 for (int i=0; i<2; i++) {
447 const struct libusb_endpoint_descriptor *epd = &ifd->endpoint[i];
448 if (epd->bEndpointAddress & 0x80)
449 rx_endpoint = epd->bEndpointAddress;
451 tx_endpoint = epd->bEndpointAddress;
453 if (rx_endpoint < 0 || tx_endpoint < 0) {
454 log_error("Failed to identify endpoints");
458 log_pkt("Found endpoints: rx==%02x tx=%02x\n", rx_endpoint, tx_endpoint);
459 libusb_free_config_descriptor(desc);
463 libusb_free_config_descriptor(desc);
467 static int find_device(void)
469 libusb_device **devlist;
470 ssize_t devn = libusb_get_device_list(usb_ctxt, &devlist);
472 log_error("Cannot enumerate USB devices: error %d", (int) devn);
476 for (ssize_t i=0; i<devn; i++) {
477 struct libusb_device_descriptor desc;
478 libusb_device *dev = devlist[i];
479 if (!libusb_get_device_descriptor(dev, &desc)) {
480 if (desc.idVendor == 0x0451 && desc.idProduct == 0x3211) {
481 log_info("Arexx data logger found at usb%d.%d", libusb_get_bus_number(dev), libusb_get_device_address(dev));
482 if (!parse_descriptors(dev))
485 if (err = libusb_open(dev, &devh)) {
486 log_error("libusb_open() failed: error %d", err);
489 if (err = libusb_claim_interface(devh, 0)) {
490 log_error("libusb_claim_interface() failed: error %d", err);
494 libusb_free_device_list(devlist, 1);
501 libusb_free_device_list(devlist, 1);
505 static void release_device(void)
507 libusb_release_interface(devh, 0);
508 libusb_reset_device(devh);
513 static void dump_packet(byte *pkt)
515 for (int i=0; i<64; i++) {
517 log_pkt("\t%02x:", i);
518 log_pkt(" %02x", pkt[i]);
524 static void my_msleep(int ms)
526 struct timespec ts = { .tv_sec = ms/1000, .tv_nsec = (ms%1000) * 1000000 };
527 nanosleep(&ts, NULL);
530 static int send_and_receive(byte *req, byte *reply)
533 time_t t = time(NULL);
535 localtime_r(&t, &tm);
538 strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
539 log_pkt("## %s\n", tbuf);
542 int err, transferred;
543 if (err = libusb_bulk_transfer(devh, tx_endpoint, req, 64, &transferred, 200)) {
544 if (err == LIBUSB_ERROR_TIMEOUT) {
545 log_pkt(">> xmit timed out\n");
548 log_pkt(">> xmit error %d\n", err);
549 log_error("Transmit error: %d", err);
553 log_pkt(">> xmit %d bytes\n", transferred);
557 if (err = libusb_bulk_transfer(devh, rx_endpoint, reply, 64, &transferred, 200)) {
558 if (err == LIBUSB_ERROR_TIMEOUT) {
559 log_pkt("<< recv timed out\n");
562 log_pkt("<< recv error %d\n", err);
563 log_error("Receive error: %d", err);
566 packet_rx_time = time(NULL);
568 log_pkt("<< recv %d bytes\n", transferred);
569 while (transferred < 64)
570 reply[transferred++] = 0xff;
576 static unsigned int get_be16(byte *p)
578 return p[1] | (p[0] << 8);
581 static unsigned int get_le16(byte *p)
583 return p[0] | (p[1] << 8);
586 static unsigned int get_le32(byte *p)
588 return get_le16(p) | (get_le16(p+2) << 16);
591 static void put_le16(byte *p, unsigned int x)
597 static void put_le32(byte *p, unsigned int x)
600 put_le16(p+2, x>>16);
603 static int parse_packet(byte *reply)
606 log_error("Unknown packet type %02x", reply[0]);
613 byte *p = reply + pos;
615 if (!len || len == 0xff)
617 if (pos + len > 64) {
618 log_error("Tuple truncated");
630 q = (len > 9) ? p[9] : -1;
639 log_error("Unknown tuple length %02x", len);
643 if (debug_raw_data) {
644 printf("... %02x: id=%08x raw=%d t=%u", len, id, raw, t);
649 raw_point(t, id, raw, q);
658 static void set_clock(void)
660 byte req[64], reply[64];
663 time_t t = time(NULL);
664 put_le32(req+1, t-TIME_OFFSET);
665 send_and_receive(req, reply);
669 * Original software also sends a packet with type 3 and the timestamp,
670 * but it does not make any sense, especially as they ignore the sensor
671 * readings in the answer.
674 send_and_receive(req, reply);
681 static sigset_t term_sigs;
682 static volatile sig_atomic_t want_shutdown;
684 static void sigterm_handler(int sig UNUSED)
689 static void interruptible_msleep(int ms)
691 sigprocmask(SIG_UNBLOCK, &term_sigs, NULL);
693 sigprocmask(SIG_BLOCK, &term_sigs, NULL);
696 static const struct option long_options[] = {
697 { "debug", 0, NULL, 'd' },
698 { "log-dir", 1, NULL, 'l' },
699 { "no-fork", 0, NULL, 'n' },
700 { "debug-packets", 0, NULL, 'p' },
701 { "debug-raw", 0, NULL, 'r' },
702 { "version", 0, NULL, 'V' },
703 { NULL, 0, NULL, 0 },
706 static void usage(void)
709 Usage: arexxd <options>\n\
712 -d, --debug Debug mode (no chdir, no fork, no syslog)\n\
713 -l, --log-dir=<dir> Directory where all received data should be stored\n\
714 -n, --no-fork Do not fork\n\
715 -p, --debug-packets Log all packets sent and received\n\
716 -r, --debug-raw Log conversion from raw values\n\
717 -V, --version Show daemon version\n\
722 int main(int argc, char **argv)
725 while ((opt = getopt_long(argc, argv, "dl:nprV", long_options, NULL)) >= 0)
743 printf("arexxd " AREXXD_VERSION "\n");
744 printf("(c) 2011-2018 Martin Mares <mj@ucw.cz>\n");
753 if (err = libusb_init(&usb_ctxt))
754 die("Cannot initialize libusb: error %d", err);
757 if (chdir(log_dir) < 0)
758 die("Cannot change directory to %s: %m", log_dir);
759 if (debug_packets || debug_raw_data) {
761 if (open("debug", O_WRONLY | O_CREAT | O_APPEND, 0666) < 0)
762 die("Cannot open debug log: %m");
765 openlog("arexxd", LOG_NDELAY, LOG_DAEMON);
769 die("fork() failed: %m");
781 struct sigaction sa = { .sa_handler = sigterm_handler };
782 sigaction(SIGTERM, &sa, NULL);
783 sigaction(SIGINT, &sa, NULL);
785 sigemptyset(&term_sigs);
786 sigaddset(&term_sigs, SIGTERM);
787 sigaddset(&term_sigs, SIGINT);
788 sigprocmask(SIG_BLOCK, &term_sigs, NULL);
791 while (!want_shutdown) {
792 if (!find_device()) {
795 log_error("Data logger not connected, waiting until it appears");
797 interruptible_msleep(30000);
800 log_info("Listening");
802 time_t last_sync = 0;
803 time_t last_show = 0;
806 data_point_counter = 0;
807 while (!want_shutdown) {
808 time_t now = time(NULL);
809 if (now > last_sync + 900) {
810 log_info("Synchronizing data logger time");
814 if (want_stats && now > last_show + 300) {
815 log_info("Stats: received %d data points", data_point_counter);
816 data_point_counter = 0;
820 byte req[64], reply[64];
821 memset(req, 0, sizeof(req));
823 err = send_and_receive(req, reply);
827 if (err > 0 && parse_packet(reply))
830 interruptible_msleep(4000);
833 interruptible_msleep(5);
836 log_info("Disconnecting data logger");
839 interruptible_msleep(10000);
842 log_info("Terminated");