2 * Linux Interfece for Arexx Data Loggers
4 * (c) 2011-2018 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
37 typedef unsigned char byte;
38 typedef unsigned int uint;
39 static libusb_context *usb_ctxt;
40 static libusb_device_handle *devh;
42 static int use_syslog;
43 static int debug_mode;
44 static int debug_packets;
45 static int debug_raw_data;
47 static char *log_dir = DEFAULT_LOG_DIR;
50 #define UNUSED __attribute__((unused))
52 static int data_point_counter; // Since last log message
53 static time_t packet_rx_time;
55 static void die(char *fmt, ...)
60 vsyslog(LOG_CRIT, fmt, args);
62 vfprintf(stderr, fmt, args);
63 fprintf(stderr, "\n");
69 static void log_error(char *fmt, ...)
74 vsyslog(LOG_ERR, fmt, args);
76 vfprintf(stderr, fmt, args);
77 fprintf(stderr, "\n");
82 static void log_info(char *fmt, ...)
87 vsyslog(LOG_INFO, fmt, args);
89 vfprintf(stderr, fmt, args);
90 fprintf(stderr, "\n");
95 static void log_pkt(char *fmt, ...)
105 /*** MQTT interface ***/
107 #include <mosquitto.h>
109 static struct mosquitto *mosq;
111 static void mqtt_publish(const char *topic, const char *fmt, ...)
116 int l = vsnprintf(m, sizeof(m), fmt, args);
117 if (mosquitto_publish(mosq, NULL, topic, l, m, 0, true) != MOSQ_ERR_SUCCESS)
118 log_error("Mosquitto: publish failed");
122 static void mqtt_conn_callback(struct mosquitto *mosq UNUSED, void *obj UNUSED, int status)
125 mqtt_publish("status/arexxd", "ok");
128 static void mqtt_init(void)
130 mosquitto_lib_init();
131 mosq = mosquitto_new("arexxd", 1, NULL);
133 die("Mosquitto: initialization failed");
135 if (mosquitto_will_set(mosq, "status/arexxd", 4, "dead", 0, true) != MOSQ_ERR_SUCCESS)
136 die("Mosquitto: unable to set will");
138 mosquitto_connect_callback_set(mosq, mqtt_conn_callback);
140 if (mosquitto_connect(mosq, "10.32.184.5", 1883, 60) != MOSQ_ERR_SUCCESS)
141 die("Mosquitto: connect failed");
143 if (mosquitto_loop_start(mosq))
144 die("Mosquitto: cannot start service thread");
147 static void mqtt_point(time_t t, const char *name, double val, char *unit UNUSED)
149 // We do not feed past data to MQTT (so MAX_PAST_TIME is stronger for us)
150 if (t < packet_rx_time - 30)
154 snprintf(topic, sizeof(topic), "burrow/temp/%s", name);
155 mqtt_publish(topic, "%.3f %lld", val, (long long) t);
158 /*** RRD interface ***/
163 #define MAX_ARG_SIZE 1024
166 static char *arg_ptr[MAX_ARGS+1];
167 static char arg_buf[MAX_ARG_SIZE];
170 static void arg_new(void)
174 arg_ptr[0] = "rrdtool";
177 static void arg_push(const char *fmt, ...)
179 if (arg_cnt >= MAX_ARGS)
180 die("MAX_ARGS exceeded");
183 int len = 1 + vsnprintf(arg_buf + arg_pos, MAX_ARG_SIZE - arg_pos, fmt, va);
184 if (arg_pos + len > MAX_ARG_SIZE)
185 die("MAX_ARG_SIZE exceeded");
186 arg_ptr[arg_cnt++] = arg_buf + arg_pos;
187 arg_ptr[arg_cnt] = NULL;
191 static void rrd_point(time_t t, const char *name, double val, char *unit)
194 snprintf(rr_name, sizeof(rr_name), "sensor-%s.rrd", name);
197 if (stat(rr_name, &st) < 0 || !st.st_size) {
198 // We have to create the RRD
199 log_info("Creating %s", rr_name);
203 arg_push("%d", (int) time(NULL) - 28*86400);
206 if (!strcmp(unit, "%RH"))
207 arg_push("DS:rh:GAUGE:300:0:100");
208 else if (!strcmp(unit, "ppm"))
209 arg_push("DS:ppm:GAUGE:300:0:1000000");
211 arg_push("DS:temp:GAUGE:300:-200:200");
212 arg_push("RRA:AVERAGE:0.25:1:20160"); // Last 14 days with full resolution
213 arg_push("RRA:AVERAGE:0.25:60:88800"); // Last 10 years with 1h resolution
214 arg_push("RRA:MIN:0.25:60:88800"); // including minima and maxima
215 arg_push("RRA:MAX:0.25:60:88800");
216 rrd_create(arg_cnt, arg_ptr);
217 if (rrd_test_error()) {
218 log_error("rrd_create on %s failed: %s", rr_name, rrd_get_error());
226 arg_push("%d:%f", t, val);
227 rrd_update(arg_cnt, arg_ptr);
228 if (rrd_test_error()) {
229 log_error("rrd_update on %s failed: %s", rr_name, rrd_get_error());
236 #define TIME_OFFSET 946681200 // Timestamp of 2000-01-01 00:00:00
238 static double correct_point(uint id, double val, const char **name)
241 * Manually calculated corrections and renames for my sensors.
242 * Replace with your formulae.
258 *name = "ursarium-rh";
264 #ifdef IGNORE_UNKNOWN_SENSORS
271 static void cooked_point(time_t t, uint id, double val, char *unit, int q)
274 snprintf(namebuf, sizeof(namebuf), "%u", id);
275 const char *name = namebuf;
277 double val2 = correct_point(id, val, &name);
279 if (debug_raw_data) {
281 localtime_r(&t, &tm);
283 strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
284 printf("== %s id=%d name=%s val=%.3f val2=%.3f unit=%s q=%d\n", tbuf, id, name, val, val2, unit, q);
288 log_error("Ignored data from unknown sensor %d", id);
291 if (t < packet_rx_time - MAX_PAST_TIME) {
292 log_error("Data point from sensor %d too far in the past (%d sec)", packet_rx_time - t);
295 if (t > packet_rx_time + MAX_FUTURE_TIME) {
296 log_error("Data point from sensor %d too far in the future (%d sec)", t - packet_rx_time);
300 data_point_counter++;
301 rrd_point(t, name, val2, unit);
302 mqtt_point(t, name, val2, unit);
305 static void raw_point(uint t, uint id, int raw, int q)
308 * The binary blob provided by Arexx contains an embedded XML fragment
309 * with descriptions of all known sensor types. If you want to see it,
310 * grep the blob for "<deviceinfo>". The meanings of the parameters are
313 * m1, m2 Device type matches if (raw_sensor_id & m1) == m2
314 * type Unit measured by the sensor (1=Celsius, 2=RH%, 3=CO2 ppm)
315 * dm User-visible sensor ID = raw_sensor_id & dm
316 * i 1 if the raw value is signed
317 * p[] Coefficients of transformation polynomial (x^0 first)
318 * vLo, vUp Upper and lower bound on the final value
319 * scale Scaling function:
320 * 0 = identity (default)
323 * 3 = (x < 0) ? 0 : log10(x)
324 * 4 = (x < 0) ? 0 : log(x)
326 * The raw values are transformed this way:
327 * - sign-extend if signed
328 * - apply the transformation polynomial
329 * - apply the scaling function
330 * - drop if outside the interval [vLo,vUp]
332 * This function applies the necessary transform for sensors we've
333 * seen in the wild. We deliberately ignore the "dm" parameter as we want
334 * to report different channels of a single sensor as multiple sensors.
340 uint idhi = id & 0xfffff000;
341 uint idext = id & 0xf0000000;
343 if (idhi == 0x1000) {
348 } else if (idhi == 0x2000 || idext == 0x20000000) {
355 } else if (idhi == 0x4000) {
362 z = -2.8e-6*z*z + 0.0405*z - 4;
367 } else if (idhi == 0x6000) {
377 z = (z + 1.9184e-7) * z;
378 z = (z - 1.0998e-3) * z;
386 log_error("Unknown sensor type 0x%08x", id);
390 if (z < lo || z > hi) {
391 log_error("Sensor %d: value %f out of range", id, z);
395 cooked_point(t + TIME_OFFSET, id & 0x0fffffff, z, unit, q);
398 /*** USB interface ***/
400 static int rx_endpoint, tx_endpoint;
402 static int parse_descriptors(libusb_device *dev)
405 struct libusb_config_descriptor *desc;
407 if (err = libusb_get_active_config_descriptor(dev, &desc)) {
408 log_error("libusb_get_config_descriptor failed: error %d", err);
411 if (desc->bNumInterfaces != 1) {
412 log_error("Unexpected number of interfaces: %d", desc->bNumInterfaces);
416 const struct libusb_interface *iface = &desc->interface[0];
417 if (iface->num_altsetting != 1) {
418 log_error("Unexpected number of alternate interface settings: %d", iface->num_altsetting);
422 const struct libusb_interface_descriptor *ifd = &iface->altsetting[0];
423 if (ifd->bNumEndpoints != 2) {
424 log_error("Unexpected number of endpoints: %d", ifd->bNumEndpoints);
428 rx_endpoint = tx_endpoint = -1;
429 for (int i=0; i<2; i++) {
430 const struct libusb_endpoint_descriptor *epd = &ifd->endpoint[i];
431 if (epd->bEndpointAddress & 0x80)
432 rx_endpoint = epd->bEndpointAddress;
434 tx_endpoint = epd->bEndpointAddress;
436 if (rx_endpoint < 0 || tx_endpoint < 0) {
437 log_error("Failed to identify endpoints");
441 log_pkt("Found endpoints: rx==%02x tx=%02x\n", rx_endpoint, tx_endpoint);
442 libusb_free_config_descriptor(desc);
446 libusb_free_config_descriptor(desc);
450 static int find_device(void)
452 libusb_device **devlist;
453 ssize_t devn = libusb_get_device_list(usb_ctxt, &devlist);
455 log_error("Cannot enumerate USB devices: error %d", (int) devn);
459 for (ssize_t i=0; i<devn; i++) {
460 struct libusb_device_descriptor desc;
461 libusb_device *dev = devlist[i];
462 if (!libusb_get_device_descriptor(dev, &desc)) {
463 if (desc.idVendor == 0x0451 && desc.idProduct == 0x3211) {
464 log_info("Arexx data logger found at usb%d.%d", libusb_get_bus_number(dev), libusb_get_device_address(dev));
465 if (!parse_descriptors(dev))
468 if (err = libusb_open(dev, &devh)) {
469 log_error("libusb_open() failed: error %d", err);
472 if (err = libusb_claim_interface(devh, 0)) {
473 log_error("libusb_claim_interface() failed: error %d", err);
477 libusb_free_device_list(devlist, 1);
484 libusb_free_device_list(devlist, 1);
488 static void release_device(void)
490 libusb_release_interface(devh, 0);
491 libusb_reset_device(devh);
496 static void dump_packet(byte *pkt)
498 for (int i=0; i<64; i++) {
500 log_pkt("\t%02x:", i);
501 log_pkt(" %02x", pkt[i]);
507 static void my_msleep(int ms)
509 struct timespec ts = { .tv_sec = ms/1000, .tv_nsec = (ms%1000) * 1000000 };
510 nanosleep(&ts, NULL);
513 static int send_and_receive(byte *req, byte *reply)
516 time_t t = time(NULL);
518 localtime_r(&t, &tm);
521 strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
522 log_pkt("## %s\n", tbuf);
525 int err, transferred;
526 if (err = libusb_bulk_transfer(devh, tx_endpoint, req, 64, &transferred, 200)) {
527 if (err == LIBUSB_ERROR_TIMEOUT) {
528 log_pkt(">> xmit timed out\n");
531 log_pkt(">> xmit error %d\n", err);
532 log_error("Transmit error: %d", err);
536 log_pkt(">> xmit %d bytes\n", transferred);
540 if (err = libusb_bulk_transfer(devh, rx_endpoint, reply, 64, &transferred, 200)) {
541 if (err == LIBUSB_ERROR_TIMEOUT) {
542 log_pkt("<< recv timed out\n");
545 log_pkt("<< recv error %d\n", err);
546 log_error("Receive error: %d", err);
549 packet_rx_time = time(NULL);
551 log_pkt("<< recv %d bytes\n", transferred);
552 while (transferred < 64)
553 reply[transferred++] = 0xff;
559 static unsigned int get_be16(byte *p)
561 return p[1] | (p[0] << 8);
564 static unsigned int get_le16(byte *p)
566 return p[0] | (p[1] << 8);
569 static unsigned int get_le32(byte *p)
571 return get_le16(p) | (get_le16(p+2) << 16);
574 static void put_le16(byte *p, unsigned int x)
580 static void put_le32(byte *p, unsigned int x)
583 put_le16(p+2, x>>16);
586 static int parse_packet(byte *reply)
589 log_error("Unknown packet type %02x", reply[0]);
596 byte *p = reply + pos;
598 if (!len || len == 0xff)
600 if (pos + len > 64) {
601 log_error("Tuple truncated");
613 q = (len > 9) ? p[9] : -1;
622 log_error("Unknown tuple length %02x", len);
626 if (debug_raw_data) {
627 printf("... %02x: id=%08x raw=%d t=%u", len, id, raw, t);
632 raw_point(t, id, raw, q);
641 static void set_clock(void)
643 byte req[64], reply[64];
646 time_t t = time(NULL);
647 put_le32(req+1, t-TIME_OFFSET);
648 send_and_receive(req, reply);
652 * Original software also sends a packet with type 3 and the timestamp,
653 * but it does not make any sense, especially as they ignore the sensor
654 * readings in the answer.
657 send_and_receive(req, reply);
664 static sigset_t term_sigs;
665 static volatile sig_atomic_t want_shutdown;
667 static void sigterm_handler(int sig UNUSED)
672 static void interruptible_msleep(int ms)
674 sigprocmask(SIG_UNBLOCK, &term_sigs, NULL);
676 sigprocmask(SIG_BLOCK, &term_sigs, NULL);
679 static const struct option long_options[] = {
680 { "debug", 0, NULL, 'd' },
681 { "log-dir", 1, NULL, 'l' },
682 { "no-fork", 0, NULL, 'n' },
683 { "debug-packets", 0, NULL, 'p' },
684 { "debug-raw", 0, NULL, 'r' },
685 { "version", 0, NULL, 'V' },
686 { NULL, 0, NULL, 0 },
689 static void usage(void)
692 Usage: arexxd <options>\n\
695 -d, --debug Debug mode (no chdir, no fork, no syslog)\n\
696 -l, --log-dir=<dir> Directory where all received data should be stored\n\
697 -n, --no-fork Do not fork\n\
698 -p, --debug-packets Log all packets sent and received\n\
699 -r, --debug-raw Log conversion from raw values\n\
700 -u, --debug-usb Enable libusb debug messages (to stdout/stderr)\n\
701 -V, --version Show daemon version\n\
706 int main(int argc, char **argv)
709 while ((opt = getopt_long(argc, argv, "dl:npruV", long_options, NULL)) >= 0)
730 printf("arexxd " AREXXD_VERSION "\n");
731 printf("(c) 2011-2018 Martin Mares <mj@ucw.cz>\n");
740 if (err = libusb_init(&usb_ctxt))
741 die("Cannot initialize libusb: error %d", err);
743 libusb_set_debug(usb_ctxt, 3);
746 if (chdir(log_dir) < 0)
747 die("Cannot change directory to %s: %m", log_dir);
748 if (debug_packets || debug_raw_data) {
750 if (open("debug", O_WRONLY | O_CREAT | O_APPEND, 0666) < 0)
751 die("Cannot open debug log: %m");
754 openlog("arexxd", LOG_NDELAY, LOG_DAEMON);
758 die("fork() failed: %m");
768 struct sigaction sa = { .sa_handler = sigterm_handler };
769 sigaction(SIGTERM, &sa, NULL);
770 sigaction(SIGINT, &sa, NULL);
772 sigemptyset(&term_sigs);
773 sigaddset(&term_sigs, SIGTERM);
774 sigaddset(&term_sigs, SIGINT);
775 sigprocmask(SIG_BLOCK, &term_sigs, NULL);
778 while (!want_shutdown) {
779 if (!find_device()) {
782 log_error("Data logger not connected, waiting until it appears");
784 interruptible_msleep(30000);
787 log_info("Listening");
789 time_t last_sync = 0;
790 time_t last_show = 0;
793 data_point_counter = 0;
794 while (!want_shutdown) {
795 time_t now = time(NULL);
796 if (now > last_sync + 900) {
797 log_info("Synchronizing data logger time");
801 if (want_stats && now > last_show + 300) {
802 log_info("Stats: received %d data points", data_point_counter);
803 data_point_counter = 0;
807 byte req[64], reply[64];
808 memset(req, 0, sizeof(req));
810 err = send_and_receive(req, reply);
814 if (err > 0 && parse_packet(reply))
817 interruptible_msleep(4000);
820 interruptible_msleep(5);
823 log_info("Disconnecting data logger");
826 interruptible_msleep(10000);
829 log_info("Terminated");