arexxd.c

   1 /*
   2  *      Linux Interfece for Arexx Data Loggers
   3  *
   4  *      (c) 2011 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 <pwd.h>
  18 #include <grp.h>
  19 #include <sys/stat.h>
  20 #include <libusb-1.0/libusb.h>
  21 #include <rrd.h>
  22
  23 #define LOG_PATH "/var/log/arexxd"
  24
  25 typedef unsigned char byte;
  26 static libusb_context *usb_ctxt;
  27 static libusb_device_handle *devh;
  28
  29 static int use_syslog;
  30 static int debug_mode;
  31 static int debug_packets;
  32 static int debug_raw_data;
  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 SLOT_SIZE 10                                    // 10 seconds per averaging slot
  87 #define MAX_ARGS 20
  88 #define MAX_ARG_SIZE 1024
  89
  90 static int arg_cnt;
  91 static char *arg_ptr[MAX_ARGS+1];
  92 static char arg_buf[MAX_ARG_SIZE];
  93 static int arg_pos;
  94
  95 static void arg_new(void)
  96 {
  97         arg_cnt = 1;
  98         arg_pos = 0;
  99         arg_ptr[0] = "rrdtool";
 100 }
 101
 102 static void arg_push(const char *fmt, ...)
 103 {
 104         if (arg_cnt >= MAX_ARGS)
 105                 die("MAX_ARGS exceeded");
 106         va_list va;
 107         va_start(va, fmt);
 108         int len = 1 + vsnprintf(arg_buf + arg_pos, MAX_ARG_SIZE - arg_pos, fmt, va);
 109         if (arg_pos + len > MAX_ARG_SIZE)
 110                 die("MAX_ARG_SIZE exceeded");
 111         arg_ptr[arg_cnt++] = arg_buf + arg_pos;
 112         arg_ptr[arg_cnt] = NULL;
 113         arg_pos += len;
 114 }
 115
 116 static void rrd_point(time_t t, int id, double val)
 117 {
 118         char rr_name[256];
 119         snprintf(rr_name, sizeof(rr_name), "sensor-%d.rrd", id);
 120
 121         struct stat st;
 122         if (stat(rr_name, &st) < 0 || !st.st_size) {
 123                 // We have to create the RRD
 124                 log_info("Creating %s", rr_name);
 125                 arg_new();
 126                 arg_push(rr_name);
 127                 arg_push("--start");
 128                 arg_push("%d", (int) time(NULL) - 28*86400);
 129                 arg_push("--step");
 130                 arg_push("60");
 131                 arg_push("DS:temp:GAUGE:300:0:10000");          // Anything over 10 kW is considered a ghost
 132                 arg_push("RRA:AVERAGE:0.25:1:20160");           // Last 14 days with full resolution
 133                 arg_push("RRA:AVERAGE:0.25:60:88800");          // Last 10 years with 1h resolution
 134                 rrd_create(arg_cnt, arg_ptr);
 135                 if (rrd_test_error()) {
 136                         log_error("rrd_create on %s failed: %s", rr_name, rrd_get_error());
 137                         return;
 138                 }
 139         }
 140
 141         arg_new();
 142         arg_push(rr_name);
 143         arg_push("%d:%f", t, val);
 144         rrd_update(arg_cnt, arg_ptr);
 145         if (rrd_test_error())
 146                 log_error("rrd_update on %s failed: %s", rr_name, rrd_get_error());
 147 }
 148
 149 /*** Transforms ***/
 150
 151 #define TIME_OFFSET 946681200           // Timestamp of 2000-01-01 00:00:00
 152
 153 static void cooked_point(time_t t, int id, double val, char *unit, int q)
 154 {
 155         struct tm tm;
 156         localtime_r(&t, &tm);
 157
 158         char tbuf[64];
 159         strftime(tbuf, sizeof(tbuf), "%Y-%m-%d %H:%M:%S", &tm);
 160
 161         if (debug_raw_data)
 162                 printf("== %s id=%d val=%.3f unit=%s q=%d\n", tbuf, id, val, unit, q);
 163
 164         rrd_point(t, id, val);
 165 }
 166
 167 static void raw_point(int t, int id, int raw, int q)
 168 {
 169         /*
 170          *  The binary blob provided by Arexx contains an embedded XML fragment
 171          *  with descriptions of all known sensor types. If you want to see it,
 172          *  grep the blob for "<deviceinfo>". The meanings of the parameters are
 173          *  as follows:
 174          *
 175          *      m1, m2          Device type matches if (raw_sensor_id & m1) == m2
 176          *      type            Unit measured by the sensor (1=Celsius, 2=RH%, 3=CO2 ppm)
 177          *      dm              User-visible sensor ID = raw_sensor_id & dm
 178          *      i               1 if the raw value is signed
 179          *      p[]             Coefficients of transformation polynomial (x^0 first)
 180          *      vLo, vUp        Upper and lower bound on the final value
 181          *      scale           Scaling function:
 182          *                              0 = identity (default)
 183          *                              1 = 10^x
 184          *                              2 = exp(x)
 185          *                              3 = (x < 0) ? 0 : log10(x)
 186          *                              4 = (x < 0) ? 0 : log(x)
 187          *
 188          *  The raw values are transformed this way:
 189          *      - sign-extend if signed
 190          *      - apply the transformation polynomial
 191          *      - apply the scaling function
 192          *      - drop if outside the interval [vLo,vUp]
 193          *
 194          *  This function applies the necessary transform for sensors we've
 195          *  seen in the wild. We deliberately ignore the "dm" parameter as we want
 196          *  to report different channels of a single sensor as multiple sensors.
 197          */
 198
 199         double z = raw;
 200         double hi, lo;
 201         char *unit;
 202         int idhi = id & 0xf000;
 203
 204         if (idhi == 0x1000) {
 205                 z = 0.02*z - 273.15;
 206                 lo = -200;
 207                 hi = 600;
 208                 unit = "C";
 209         } else if (idhi == 0x2000) {
 210                 if (raw >= 0x8000)
 211                         z -= 0x10000;
 212                 z /= 128;
 213                 lo = -60;
 214                 hi = 125;
 215                 unit = "C";
 216         } else if (idhi == 0x4000) {
 217                 if (!(id & 1)) {
 218                         z = z/100 - 39.6;
 219                         lo = -60;
 220                         hi = 125;
 221                         unit = "C";
 222                 } else {
 223                         z = -2.8e-6*z*z + 0.0405*z - 4;
 224                         lo = 0;
 225                         hi = 100.1;
 226                         unit = "%RH";
 227                 }
 228         } else if (idhi == 0x6000) {
 229                 if (!(id & 1)) {
 230                         if (raw >= 0x8000)
 231                                 z -= 0x10000;
 232                         z /= 128;
 233                         lo = -60;
 234                         hi = 125;
 235                         unit = "C";
 236                 } else {
 237                         z = -3.8123e-11*z;
 238                         z = (z + 1.9184e-7) * z;
 239                         z = (z - 1.0998e-3) * z;
 240                         z += 6.56;
 241                         z = pow(10, z);
 242                         lo = 0;
 243                         hi = 1e6;
 244                         unit = "ppm";
 245                 }
 246         } else {
 247                 log_error("Unknown sensor type 0x%04x", id);
 248                 return;
 249         }
 250
 251         if (z < lo || z > hi) {
 252                 log_error("Sensor %d: value %f out of range", id, z);
 253                 return;
 254         }
 255
 256         cooked_point(t + TIME_OFFSET, id, z, unit, q);
 257 }
 258
 259 /*** USB interface ***/
 260
 261 static int find_device(void)
 262 {
 263         libusb_device **devlist;
 264         ssize_t devn = libusb_get_device_list(usb_ctxt, &devlist);
 265         if (devn < 0) {
 266                 log_error("Cannot enumerate USB devices: error %d", (int) devn);
 267                 return 0;
 268         }
 269
 270         for (ssize_t i=0; i<devn; i++) {
 271                 struct libusb_device_descriptor desc;
 272                 libusb_device *dev = devlist[i];
 273                 if (!libusb_get_device_descriptor(dev, &desc)) {
 274                         if (desc.idVendor == 0x0451 && desc.idProduct == 0x3211) {
 275                                 log_info("Arexx USB receiver found at usb%d.%d", libusb_get_bus_number(dev), libusb_get_device_address(dev));
 276                                 int err;
 277                                 if (err = libusb_open(dev, &devh)) {
 278                                         log_error("libusb_open() failed: error %d", err);
 279                                         goto failed;
 280                                 }
 281                                 if (err = libusb_claim_interface(devh, 0)) {
 282                                         log_error("libusb_claim_interface() failed: error %d", err);
 283                                         libusb_close(devh);
 284                                         goto failed;
 285                                 }
 286                                 libusb_free_device_list(devlist, 1);
 287                                 return 1;
 288                         }
 289                 }
 290         }
 291
 292 failed:
 293         libusb_free_device_list(devlist, 1);
 294         return 0;
 295 }
 296
 297 static void release_device(void)
 298 {
 299         libusb_close(devh);
 300         devh = NULL;
 301 }
 302
 303 static void dump_packet(byte *pkt)
 304 {
 305         for (int i=0; i<64; i++) {
 306                 if (!(i % 16))
 307                         log_pkt("\t%02x:", i);
 308                 log_pkt(" %02x", pkt[i]);
 309                 if (i % 16 == 15)
 310                         log_pkt("\n");
 311         }
 312 }
 313
 314 static int send_and_receive(byte *req, byte *reply)
 315 {
 316         int err, transferred;
 317         if (err = libusb_bulk_transfer(devh, 0x01, req, 64, &transferred, 200)) {
 318                 if (err == LIBUSB_ERROR_TIMEOUT) {
 319                         log_pkt(">> xmit timed out\n");
 320                         return 0;
 321                 }
 322                 log_error("Transmit error: %d", err);
 323                 return err;
 324         }
 325         if (debug_packets) {
 326                 log_pkt(">> xmit %d bytes\n", transferred);
 327                 dump_packet(req);
 328         }
 329         if (err = libusb_bulk_transfer(devh, 0x81, reply, 64, &transferred, 200)) {
 330                 if (err == LIBUSB_ERROR_TIMEOUT) {
 331                         log_pkt(">> recv timed out\n");
 332                         return 0;
 333                 }
 334                 log_error("Receive error: %d", err);
 335                 return err;
 336         }
 337         if (debug_packets)
 338                 log_pkt("<< recv %d bytes\n", transferred);
 339         while (transferred < 64)
 340                 reply[transferred++] = 0xff;
 341         if (debug_packets)
 342                 dump_packet(reply);
 343         return 1;
 344 }
 345
 346 static unsigned int get_be16(byte *p)
 347 {
 348         return p[1] | (p[0] << 8);
 349 }
 350
 351 static unsigned int get_le16(byte *p)
 352 {
 353         return p[0] | (p[1] << 8);
 354 }
 355
 356 static unsigned int get_le32(byte *p)
 357 {
 358         return get_le16(p) | (get_le16(p+2) << 16);
 359 }
 360
 361 static void put_le16(byte *p, unsigned int x)
 362 {
 363         p[0] = x;
 364         p[1] = x >> 8;
 365 }
 366
 367 static void put_le32(byte *p, unsigned int x)
 368 {
 369         put_le16(p, x);
 370         put_le16(p+2, x>>16);
 371 }
 372
 373 static int parse_packet(byte *reply)
 374 {
 375         if (reply[0]) {
 376                 log_error("Unknown packet type %02x", reply[0]);
 377                 return 0;
 378         }
 379
 380         int pos = 1;
 381         int points = 0;
 382         while (pos < 64) {
 383                 byte *p = reply + pos;
 384                 int len = p[0];
 385                 if (!len || len == 0xff)
 386                         break;
 387                 if (len < 9 || len > 10) {
 388                         log_error("Unknown tuple length %02x", len);
 389                         break;
 390                 }
 391                 if (pos + len > 64) {
 392                         log_error("Tuple truncated");
 393                         break;
 394                 }
 395                 int id = get_le16(p+1);
 396                 int raw = get_be16(p+3);
 397                 int t = get_le32(p+5);
 398                 int q = (len > 9) ? p[9] : -1;
 399                 if (debug_raw_data) {
 400                         printf("... %02x: id=%d raw=%d t=%d", len, id, raw, t);
 401                         if (len > 9)
 402                                 printf(" q=%d", q);
 403                         printf("\n");
 404                 }
 405                 raw_point(t, id, raw, q);
 406                 pos += len;
 407                 points++;
 408         }
 409
 410         return points;
 411 }
 412
 413 static void set_clock(void)
 414 {
 415         log_info("Synchronizing receiver time");
 416
 417         byte req[64], reply[64];
 418         memset(req, 0, 64);
 419         req[0] = 4;
 420         time_t t = time(NULL);
 421         put_le32(req+1, t-TIME_OFFSET);
 422         send_and_receive(req, reply);
 423
 424 #if 0
 425         /*
 426          *  Original software also sends a packet with type 3 and the timestamp,
 427          *  but it does not make any sense, especially as they ignore the sensor
 428          *  readings in the answer.
 429          */
 430         req[0] = 3;
 431         send_and_receive(req, reply);
 432         parse_packet(reply);
 433 #endif
 434 }
 435
 436 /*** Main ***/
 437
 438 static const struct option long_options[] = {
 439         { "debug",              0, NULL, 'd' },
 440         { "log-packets",        0, NULL, 'p' },
 441         { NULL,                 0, NULL, 0 },
 442 };
 443
 444 static void usage(void)
 445 {
 446         fprintf(stderr, "Usage: arexxd [--debug] [--log-packets]\n");
 447         exit(1);
 448 }
 449
 450 int main(int argc, char **argv)
 451 {
 452         int opt;
 453         while ((opt = getopt_long(argc, argv, "dp", long_options, NULL)) >= 0)
 454                 switch (opt) {
 455                         case 'd':
 456                                 debug_mode++;
 457                                 break;
 458                         case 'p':
 459                                 debug_packets++;
 460                                 debug_raw_data++;
 461                                 break;
 462                         default:
 463                                 usage();
 464                 }
 465         if (optind < argc)
 466                 usage();
 467
 468         int err;
 469         if (err = libusb_init(&usb_ctxt))
 470                 die("Cannot initialize libusb: error %d", err);
 471         // libusb_set_debug(usb_ctxt, 3);
 472
 473         if (!debug_mode) {
 474                 if (chdir(LOG_PATH) < 0)
 475                         die("Cannot change directory to %s: %m", LOG_PATH);
 476                 if (debug_packets || debug_raw_data) {
 477                         close(1);
 478                         if (open("debug", O_WRONLY | O_CREAT | O_APPEND, 0666) < 0)
 479                                 die("Cannot open debug log: %m");
 480                         setlinebuf(stdout);
 481                 }
 482                 openlog("arexxd", LOG_NDELAY, LOG_DAEMON);
 483                 pid_t pid = fork();
 484                 if (pid < 0)
 485                         die("fork() failed: %m");
 486                 if (pid)
 487                         return 0;
 488                 setsid();
 489                 use_syslog = 1;
 490         }
 491
 492         int inited = 0;
 493         for (;;) {
 494                 if (!find_device()) {
 495                         if (!inited) {
 496                                 inited = 1;
 497                                 log_error("Receiver not connected, waiting until it appears");
 498                         }
 499                         sleep(30);
 500                         continue;
 501                 }
 502
 503                 inited = 1;
 504
 505                 int sync_in = 0;
 506                 for (;;) {
 507                         if (!sync_in) {
 508                                 set_clock();
 509                                 sync_in = 100;
 510                         }
 511                         byte req[64], reply[64];
 512                         memset(req, 0, sizeof(req));
 513                         req[0] = 3;
 514                         err = send_and_receive(req, reply);
 515                         if (err < 0)
 516                                 break;
 517                         if (err > 0 && parse_packet(reply))
 518                                 continue;
 519                         sleep(4);
 520                         sync_in--;
 521                 }
 522
 523                 log_info("Disconnecting receiver");
 524                 release_device();
 525         }
 526
 527         return 0;
 528 }