arexxd.c

   1 /*
   2  *      Linux Interfece for Arexx Data Loggers
   3  *
   4  *      (c) 2011-2012 Martin Mares <mj@ucw.cz>
   5  */
   6
   7 #include <stdio.h>
   8 #include <stdarg.h>
   9 #include <stdlib.h>
  10 #include <string.h>
  11 #include <unistd.h>
  12 #include <fcntl.h>
  13 #include <math.h>
  14 #include <time.h>
  15 #include <getopt.h>
  16 #include <syslog.h>
  17 #include <signal.h>
  18 #include <sys/stat.h>
  19 #include <libusb-1.0/libusb.h>
  20 #include <rrd.h>
  21
  22 #define DEFAULT_LOG_DIR "/var/log/arexxd"
  23
  24 typedef unsigned char byte;
  25 static libusb_context *usb_ctxt;
  26 static libusb_device_handle *devh;
  27
  28 static int use_syslog;
  29 static int debug_mode;
  30 static int debug_packets;
  31 static int debug_raw_data;
  32 static char *log_dir = DEFAULT_LOG_DIR;
  33
  34 static void die(char *fmt, ...)
  35 {
  36         va_list args;
  37         va_start(args, fmt);
  38         if (use_syslog)
  39                 vsyslog(LOG_CRIT, fmt, args);
  40         else {
  41                 vfprintf(stderr, fmt, args);
  42                 fprintf(stderr, "\n");
  43         }
  44         va_end(args);
  45         exit(1);
  46 }
  47
  48 static void log_error(char *fmt, ...)
  49 {
  50         va_list args;
  51         va_start(args, fmt);
  52         if (use_syslog)
  53                 vsyslog(LOG_ERR, fmt, args);
  54         else {
  55                 vfprintf(stderr, fmt, args);
  56                 fprintf(stderr, "\n");
  57         }
  58         va_end(args);
  59 }
  60
  61 static void log_info(char *fmt, ...)
  62 {
  63         va_list args;
  64         va_start(args, fmt);
  65         if (use_syslog)
  66                 vsyslog(LOG_INFO, fmt, args);
  67         else {
  68                 vfprintf(stderr, fmt, args);
  69                 fprintf(stderr, "\n");
  70         }
  71         va_end(args);
  72 }
  73
  74 static void log_pkt(char *fmt, ...)
  75 {
  76         if (!debug_packets)
  77                 return;
  78         va_list args;
  79         va_start(args, fmt);
  80         vprintf(fmt, args);
  81         va_end(args);
  82 }
  83
  84 /*** RRD interface ***/
  85
  86 #define MAX_ARGS 20
  87 #define MAX_ARG_SIZE 1024
  88
  89 static int arg_cnt;
  90 static char *arg_ptr[MAX_ARGS+1];
  91 static char arg_buf[MAX_ARG_SIZE];
  92 static int arg_pos;
  93
  94 static void arg_new(void)
  95 {
  96         arg_cnt = 1;
  97         arg_pos = 0;
  98         arg_ptr[0] = "rrdtool";
  99 }
 100
 101 static void arg_push(const char *fmt, ...)
 102 {
 103         if (arg_cnt >= MAX_ARGS)
 104                 die("MAX_ARGS exceeded");
 105         va_list va;
 106         va_start(va, fmt);
 107         int len = 1 + vsnprintf(arg_buf + arg_pos, MAX_ARG_SIZE - arg_pos, fmt, va);
 108         if (arg_pos + len > MAX_ARG_SIZE)
 109                 die("MAX_ARG_SIZE exceeded");
 110         arg_ptr[arg_cnt++] = arg_buf + arg_pos;
 111         arg_ptr[arg_cnt] = NULL;
 112         arg_pos += len;
 113 }
 114
 115 static void rrd_point(time_t t, const char *name, double val, char *unit)
 116 {
 117         char rr_name[256];
 118         snprintf(rr_name, sizeof(rr_name), "sensor-%s.rrd", name);
 119
 120         struct stat st;
 121         if (stat(rr_name, &st) < 0 || !st.st_size) {
 122                 // We have to create the RRD
 123                 log_info("Creating %s", rr_name);
 124                 arg_new();
 125                 arg_push(rr_name);
 126                 arg_push("--start");
 127                 arg_push("%d", (int) time(NULL) - 28*86400);
 128                 arg_push("--step");
 129                 arg_push("60");
 130                 if (!strcmp(unit, "%RH"))
 131                         arg_push("DS:rh:GAUGE:300:0:100");
 132                 else if (!strcmp(unit, "ppm"))
 133                         arg_push("DS:ppm:GAUGE:300:0:1000000");
 134                 else
 135                         arg_push("DS:temp:GAUGE:300:-200:200");
 136                 arg_push("RRA:AVERAGE:0.25:1:20160");           // Last 14 days with full resolution
 137                 arg_push("RRA:AVERAGE:0.25:60:88800");          // Last 10 years with 1h resolution
 138                 arg_push("RRA:MIN:0.25:60:88800");              // including minima and maxima
 139                 arg_push("RRA:MAX:0.25:60:88800");
 140                 rrd_create(arg_cnt, arg_ptr);
 141                 if (rrd_test_error()) {
 142                         log_error("rrd_create on %s failed: %s", rr_name, rrd_get_error());
 143                         return;
 144                 }
 145         }
 146
 147         arg_new();
 148         arg_push(rr_name);
 149         arg_push("%d:%f", t, val);
 150         rrd_update(arg_cnt, arg_ptr);
 151         if (rrd_test_error())
 152                 log_error("rrd_update on %s failed: %s", rr_name, rrd_get_error());
 153 }
 154
 155 /*** Transforms ***/
 156
 157 #define TIME_OFFSET 946681200           // Timestamp of 2000-01-01 00:00:00
 158
 159 static int data_point_counter;          // Since last log message
 160
 161 static double correct_point(int id, double val, const char **name)
 162 {
 163         /*
 164          *  Manually calculated corrections and renames for my sensors.
 165          *  Replace with your formulae.
 166          */
 167         switch (id) {
 168                 case 10415:
 169                         *name = "ursarium";
 170                         return val - 0.93;
 171                 case 19246:
 172                         *name = "catarium";
 173                         return val + 0.49;
 174                 case 19247:
 175                         *name = "catarium-rh";
 176                         return val;
 177                 case 12133:
 178                         *name = "outside";
 179                         return val + 0.44;
 180                 default:
 181                         return val;
 182         }
 183 }
 184
 185 static void cooked_point(time_t t, int id, double val, char *unit, int q)
 186 {
 187         char namebuf[16];
 188         snprintf(namebuf, sizeof(namebuf), "%d", id);
 189         const char *name = namebuf;
 190
 191         double val2 = correct_point(id, val, &name);
 192
 193         if (debug_raw_data) {
 194                 struct tm tm;
 195                 localtime_r(&t, &tm);
 196                 char tbuf[64];
 197                 strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
 198                 printf("== %s id=%d name=%s val=%.3f val2=%.3f unit=%s q=%d\n", tbuf, id, name, val, val2, unit, q);
 199         }
 200
 201         data_point_counter++;
 202         rrd_point(t, name, val2, unit);
 203 }
 204
 205 static void raw_point(int t, int id, int raw, int q)
 206 {
 207         /*
 208          *  The binary blob provided by Arexx contains an embedded XML fragment
 209          *  with descriptions of all known sensor types. If you want to see it,
 210          *  grep the blob for "<deviceinfo>". The meanings of the parameters are
 211          *  as follows:
 212          *
 213          *      m1, m2          Device type matches if (raw_sensor_id & m1) == m2
 214          *      type            Unit measured by the sensor (1=Celsius, 2=RH%, 3=CO2 ppm)
 215          *      dm              User-visible sensor ID = raw_sensor_id & dm
 216          *      i               1 if the raw value is signed
 217          *      p[]             Coefficients of transformation polynomial (x^0 first)
 218          *      vLo, vUp        Upper and lower bound on the final value
 219          *      scale           Scaling function:
 220          *                              0 = identity (default)
 221          *                              1 = 10^x
 222          *                              2 = exp(x)
 223          *                              3 = (x < 0) ? 0 : log10(x)
 224          *                              4 = (x < 0) ? 0 : log(x)
 225          *
 226          *  The raw values are transformed this way:
 227          *      - sign-extend if signed
 228          *      - apply the transformation polynomial
 229          *      - apply the scaling function
 230          *      - drop if outside the interval [vLo,vUp]
 231          *
 232          *  This function applies the necessary transform for sensors we've
 233          *  seen in the wild. We deliberately ignore the "dm" parameter as we want
 234          *  to report different channels of a single sensor as multiple sensors.
 235          */
 236
 237         double z = raw;
 238         double hi, lo;
 239         char *unit;
 240         int idhi = id & 0xf000;
 241
 242         if (idhi == 0x1000) {
 243                 z = 0.02*z - 273.15;
 244                 lo = -200;
 245                 hi = 600;
 246                 unit = "C";
 247         } else if (idhi == 0x2000) {
 248                 if (raw >= 0x8000)
 249                         z -= 0x10000;
 250                 z /= 128;
 251                 lo = -60;
 252                 hi = 125;
 253                 unit = "C";
 254         } else if (idhi == 0x4000) {
 255                 if (!(id & 1)) {
 256                         z = z/100 - 39.6;
 257                         lo = -60;
 258                         hi = 125;
 259                         unit = "C";
 260                 } else {
 261                         z = -2.8e-6*z*z + 0.0405*z - 4;
 262                         lo = 0;
 263                         hi = 100.1;
 264                         unit = "%RH";
 265                 }
 266         } else if (idhi == 0x6000) {
 267                 if (!(id & 1)) {
 268                         if (raw >= 0x8000)
 269                                 z -= 0x10000;
 270                         z /= 128;
 271                         lo = -60;
 272                         hi = 125;
 273                         unit = "C";
 274                 } else {
 275                         z = -3.8123e-11*z;
 276                         z = (z + 1.9184e-7) * z;
 277                         z = (z - 1.0998e-3) * z;
 278                         z += 6.56;
 279                         z = pow(10, z);
 280                         lo = 0;
 281                         hi = 1e6;
 282                         unit = "ppm";
 283                 }
 284         } else {
 285                 log_error("Unknown sensor type 0x%04x", id);
 286                 return;
 287         }
 288
 289         if (z < lo || z > hi) {
 290                 log_error("Sensor %d: value %f out of range", id, z);
 291                 return;
 292         }
 293
 294         cooked_point(t + TIME_OFFSET, id, z, unit, q);
 295 }
 296
 297 /*** USB interface ***/
 298
 299 static int find_device(void)
 300 {
 301         libusb_device **devlist;
 302         ssize_t devn = libusb_get_device_list(usb_ctxt, &devlist);
 303         if (devn < 0) {
 304                 log_error("Cannot enumerate USB devices: error %d", (int) devn);
 305                 return 0;
 306         }
 307
 308         for (ssize_t i=0; i<devn; i++) {
 309                 struct libusb_device_descriptor desc;
 310                 libusb_device *dev = devlist[i];
 311                 if (!libusb_get_device_descriptor(dev, &desc)) {
 312                         if (desc.idVendor == 0x0451 && desc.idProduct == 0x3211) {
 313                                 log_info("Arexx data logger found at usb%d.%d", libusb_get_bus_number(dev), libusb_get_device_address(dev));
 314                                 int err;
 315                                 if (err = libusb_open(dev, &devh)) {
 316                                         log_error("libusb_open() failed: error %d", err);
 317                                         goto failed;
 318                                 }
 319                                 if (err = libusb_claim_interface(devh, 0)) {
 320                                         log_error("libusb_claim_interface() failed: error %d", err);
 321                                         libusb_close(devh);
 322                                         goto failed;
 323                                 }
 324                                 libusb_free_device_list(devlist, 1);
 325                                 return 1;
 326                         }
 327                 }
 328         }
 329
 330 failed:
 331         libusb_free_device_list(devlist, 1);
 332         return 0;
 333 }
 334
 335 static void release_device(void)
 336 {
 337         libusb_close(devh);
 338         devh = NULL;
 339 }
 340
 341 static void dump_packet(byte *pkt)
 342 {
 343         for (int i=0; i<64; i++) {
 344                 if (!(i % 16))
 345                         log_pkt("\t%02x:", i);
 346                 log_pkt(" %02x", pkt[i]);
 347                 if (i % 16 == 15)
 348                         log_pkt("\n");
 349         }
 350 }
 351
 352 static int send_and_receive(byte *req, byte *reply)
 353 {
 354         if (debug_packets) {
 355                 time_t t = time(NULL);
 356                 struct tm tm;
 357                 localtime_r(&t, &tm);
 358
 359                 char tbuf[64];
 360                 strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
 361                 log_pkt("## %s\n", tbuf);
 362         }
 363
 364         int err, transferred;
 365         if (err = libusb_bulk_transfer(devh, 0x01, req, 64, &transferred, 200)) {
 366                 if (err == LIBUSB_ERROR_TIMEOUT) {
 367                         log_pkt(">> xmit timed out\n");
 368                         return 0;
 369                 }
 370                 log_pkt(">> xmit error %d\n", err);
 371                 log_error("Transmit error: %d", err);
 372                 return err;
 373         }
 374         if (debug_packets) {
 375                 log_pkt(">> xmit %d bytes\n", transferred);
 376                 dump_packet(req);
 377         }
 378         if (err = libusb_bulk_transfer(devh, 0x81, reply, 64, &transferred, 200)) {
 379                 if (err == LIBUSB_ERROR_TIMEOUT) {
 380                         log_pkt("<< recv timed out\n");
 381                         return 0;
 382                 }
 383                 log_pkt("<< recv error %d\n", err);
 384                 log_error("Receive error: %d", err);
 385                 return err;
 386         }
 387         if (debug_packets)
 388                 log_pkt("<< recv %d bytes\n", transferred);
 389         while (transferred < 64)
 390                 reply[transferred++] = 0xff;
 391         if (debug_packets)
 392                 dump_packet(reply);
 393         return 1;
 394 }
 395
 396 static unsigned int get_be16(byte *p)
 397 {
 398         return p[1] | (p[0] << 8);
 399 }
 400
 401 static unsigned int get_le16(byte *p)
 402 {
 403         return p[0] | (p[1] << 8);
 404 }
 405
 406 static unsigned int get_le32(byte *p)
 407 {
 408         return get_le16(p) | (get_le16(p+2) << 16);
 409 }
 410
 411 static void put_le16(byte *p, unsigned int x)
 412 {
 413         p[0] = x;
 414         p[1] = x >> 8;
 415 }
 416
 417 static void put_le32(byte *p, unsigned int x)
 418 {
 419         put_le16(p, x);
 420         put_le16(p+2, x>>16);
 421 }
 422
 423 static int parse_packet(byte *reply)
 424 {
 425         if (reply[0]) {
 426                 log_error("Unknown packet type %02x", reply[0]);
 427                 return 0;
 428         }
 429
 430         int pos = 1;
 431         int points = 0;
 432         while (pos < 64) {
 433                 byte *p = reply + pos;
 434                 int len = p[0];
 435                 if (!len || len == 0xff)
 436                         break;
 437                 if (len < 9 || len > 10) {
 438                         log_error("Unknown tuple length %02x", len);
 439                         break;
 440                 }
 441                 if (pos + len > 64) {
 442                         log_error("Tuple truncated");
 443                         break;
 444                 }
 445                 int id = get_le16(p+1);
 446                 int raw = get_be16(p+3);
 447                 int t = get_le32(p+5);
 448                 int q = (len > 9) ? p[9] : -1;
 449                 if (debug_raw_data) {
 450                         printf("... %02x: id=%d raw=%d t=%d", len, id, raw, t);
 451                         if (len > 9)
 452                                 printf(" q=%d", q);
 453                         printf("\n");
 454                 }
 455                 raw_point(t, id, raw, q);
 456                 pos += len;
 457                 points++;
 458         }
 459
 460         return points;
 461 }
 462
 463 static void set_clock(void)
 464 {
 465         byte req[64], reply[64];
 466         memset(req, 0, 64);
 467         req[0] = 4;
 468         time_t t = time(NULL);
 469         put_le32(req+1, t-TIME_OFFSET);
 470         send_and_receive(req, reply);
 471
 472 #if 0
 473         /*
 474          *  Original software also sends a packet with type 3 and the timestamp,
 475          *  but it does not make any sense, especially as they ignore the sensor
 476          *  readings in the answer.
 477          */
 478         req[0] = 3;
 479         send_and_receive(req, reply);
 480         parse_packet(reply);
 481 #endif
 482 }
 483
 484 /*** Main ***/
 485
 486 static volatile sig_atomic_t want_shutdown;
 487
 488 static void sigterm_handler(int sig __attribute__((unused)))
 489 {
 490         want_shutdown = 1;
 491 }
 492
 493 static const struct option long_options[] = {
 494         { "debug",              0, NULL, 'd' },
 495         { "log-dir",            1, NULL, 'l' },
 496         { "debug-packets",      0, NULL, 'p' },
 497         { "debug-raw",          0, NULL, 'r' },
 498         { NULL,                 0, NULL, 0 },
 499 };
 500
 501 static void usage(void)
 502 {
 503         fprintf(stderr, "\n\
 504 Usage: arexxd <options>\n\
 505 \n\
 506 Options:\n\
 507 -d, --debug             Debug mode (no chdir, no fork, no syslog)\n\
 508 -l, --log-dir=<dir>     Directory where all received data should be stored\n\
 509 -p, --debug-packets     Log all packets sent and received\n\
 510 -r, --debug-raw         Log conversion from raw values\n\
 511 ");
 512         exit(1);
 513 }
 514
 515 int main(int argc, char **argv)
 516 {
 517         int opt;
 518         while ((opt = getopt_long(argc, argv, "dl:pr", long_options, NULL)) >= 0)
 519                 switch (opt) {
 520                         case 'd':
 521                                 debug_mode++;
 522                                 break;
 523                         case 'l':
 524                                 log_dir = optarg;
 525                                 break;
 526                         case 'p':
 527                                 debug_packets++;
 528                                 break;
 529                         case 'r':
 530                                 debug_raw_data++;
 531                                 break;
 532                         default:
 533                                 usage();
 534                 }
 535         if (optind < argc)
 536                 usage();
 537
 538         int err;
 539         if (err = libusb_init(&usb_ctxt))
 540                 die("Cannot initialize libusb: error %d", err);
 541         // libusb_set_debug(usb_ctxt, 3);
 542
 543         if (!debug_mode) {
 544                 if (chdir(log_dir) < 0)
 545                         die("Cannot change directory to %s: %m", log_dir);
 546                 if (debug_packets || debug_raw_data) {
 547                         close(1);
 548                         if (open("debug", O_WRONLY | O_CREAT | O_APPEND, 0666) < 0)
 549                                 die("Cannot open debug log: %m");
 550                         setlinebuf(stdout);
 551                 }
 552                 openlog("arexxd", LOG_NDELAY, LOG_DAEMON);
 553                 pid_t pid = fork();
 554                 if (pid < 0)
 555                         die("fork() failed: %m");
 556                 if (pid)
 557                         return 0;
 558                 setsid();
 559                 use_syslog = 1;
 560         }
 561
 562         struct sigaction sa = { .sa_handler = sigterm_handler };
 563         sigaction(SIGTERM, &sa, NULL);
 564         sigaction(SIGINT, &sa, NULL);
 565
 566         sigset_t term_sigs;
 567         sigemptyset(&term_sigs);
 568         sigaddset(&term_sigs, SIGTERM);
 569         sigaddset(&term_sigs, SIGINT);
 570         sigprocmask(SIG_BLOCK, &term_sigs, NULL);
 571
 572         int inited = 0;
 573         while (!want_shutdown) {
 574                 if (!find_device()) {
 575                         if (!inited) {
 576                                 inited = 1;
 577                                 log_error("Data logger not connected, waiting until it appears");
 578                         }
 579                         sleep(30);
 580                         continue;
 581                 }
 582                 log_info("Listening");
 583
 584                 time_t last_sync = 0;
 585                 time_t last_show = 0;
 586                 int want_stats = 0;
 587                 int want_sleep = 0;
 588                 data_point_counter = 0;
 589                 while (!want_shutdown) {
 590                         time_t now = time(NULL);
 591                         if (now > last_sync + 900) {
 592                                 log_info("Synchronizing data logger time");
 593                                 set_clock();
 594                                 last_sync = now;
 595                         }
 596                         if (want_stats && now > last_show + 300) {
 597                                 log_info("Stats: received %d data points", data_point_counter);
 598                                 data_point_counter = 0;
 599                                 last_show = now;
 600                         }
 601
 602                         byte req[64], reply[64];
 603                         memset(req, 0, sizeof(req));
 604                         req[0] = 3;
 605                         err = send_and_receive(req, reply);
 606                         if (err < 0)
 607                                 break;
 608                         want_sleep = 1;
 609                         if (err > 0 && parse_packet(reply))
 610                                 want_sleep = 0;
 611                         sigprocmask(SIG_UNBLOCK, &term_sigs, NULL);
 612                         if (want_sleep) {
 613                                 sleep(4);
 614                                 want_stats = 1;
 615                         }
 616                         sigprocmask(SIG_BLOCK, &term_sigs, NULL);
 617                 }
 618
 619                 log_info("Disconnecting data logger");
 620                 release_device();
 621                 inited = 0;
 622         }
 623
 624         log_info("Terminated");
 625         return 0;
 626 }