src/onewire.c

   1 /**
   2  * collectd - src/owfs.c
   3  * Copyright (C) 2008  Florian octo Forster
   4  *
   5  * This program is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License as published by the
   7  * Free Software Foundation; only version 2 of the License is applicable.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  17  *
  18  * Authors:
  19  *   Florian octo Forster <octo at noris.net>
  20  **/
  21
  22 #include "collectd.h"
  23 #include "common.h"
  24 #include "plugin.h"
  25 #include "utils_ignorelist.h"
  26
  27 #include <owcapi.h>
  28
  29 #define OW_FAMILY_LENGTH 8
  30 #define OW_FAMILY_MAX_FEATURES 2
  31 struct ow_family_features_s
  32 {
  33   char family[OW_FAMILY_LENGTH];
  34   struct
  35   {
  36     char filename[DATA_MAX_NAME_LEN];
  37     char type[DATA_MAX_NAME_LEN];
  38     char type_instance[DATA_MAX_NAME_LEN];
  39   } features[OW_FAMILY_MAX_FEATURES];
  40   size_t features_num;
  41 };
  42 typedef struct ow_family_features_s ow_family_features_t;
  43
  44 /* see http://owfs.sourceforge.net/ow_table.html for a list of families */
  45 static ow_family_features_t ow_family_features[] =
  46 {
  47   {
  48     /* family = */ "10.",
  49     {
  50       {
  51         /* filename = */ "temperature",
  52         /* type = */ "temperature",
  53         /* type_instance = */ ""
  54       }
  55     },
  56     /* features_num = */ 1
  57   }
  58 };
  59 static int ow_family_features_num = STATIC_ARRAY_SIZE (ow_family_features);
  60
  61 static char *device_g = NULL;
  62
  63 static const char *config_keys[] =
  64 {
  65   "Device",
  66   "IgnoreSelected",
  67   "Sensor",
  68 };
  69 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
  70
  71 static ignorelist_t *sensor_list;
  72
  73 static int cow_load_config (const char *key, const char *value)
  74 {
  75   if (sensor_list == NULL)
  76     sensor_list = ignorelist_create (1);
  77
  78   if (strcasecmp (key, "Sensor") == 0)
  79   {
  80     if (ignorelist_add (sensor_list, value))
  81     {
  82       ERROR ("sensors plugin: "
  83           "Cannot add value to ignorelist.");
  84       return (1);
  85     }
  86   }
  87   else if (strcasecmp (key, "IgnoreSelected") == 0)
  88   {
  89     ignorelist_set_invert (sensor_list, 1);
  90     if ((strcasecmp (value, "True") == 0)
  91         || (strcasecmp (value, "Yes") == 0)
  92         || (strcasecmp (value, "On") == 0))
  93       ignorelist_set_invert (sensor_list, 0);
  94   }
  95   else if (strcasecmp (key, "Device") == 0)
  96   {
  97     char *temp;
  98     temp = strdup (value);
  99     if (temp == NULL)
 100     {
 101       ERROR ("onewire plugin: strdup failed.");
 102       return (1);
 103     }
 104     sfree (device_g);
 105     device_g = temp;
 106   }
 107   else
 108   {
 109     return (-1);
 110   }
 111
 112   return (0);
 113 }
 114
 115 static int cow_init (void)
 116 {
 117   int status;
 118
 119   if (device_g == NULL)
 120   {
 121     ERROR ("onewire plugin: cow_init: No device configured.");
 122     return (-1);
 123   }
 124
 125   status = (int) OW_init (device_g);
 126   if (status != 0)
 127   {
 128     ERROR ("onewire plugin: OW_init(%s) failed: %i.", device_g, status);
 129     return (1);
 130   }
 131
 132   return (0);
 133 } /* int cow_init */
 134
 135 static int cow_read_values (const char *path, const char *name,
 136     const ow_family_features_t *family_info)
 137 {
 138   value_t values[1];
 139   value_list_t vl = VALUE_LIST_INIT;
 140   int success = 0;
 141   size_t i;
 142
 143   if (sensor_list != NULL)
 144   {
 145     DEBUG ("onewire plugin: Checking ignorelist for `%s'", name);
 146     if (ignorelist_match (sensor_list, name) != 0)
 147       return 0;
 148   }
 149
 150   vl.values = values;
 151   vl.values_len = 1;
 152   vl.time = time (NULL);
 153
 154   sstrncpy (vl.host, hostname_g, sizeof (vl.host));
 155   sstrncpy (vl.plugin, "onewire", sizeof (vl.plugin));
 156   sstrncpy (vl.plugin_instance, name, sizeof (vl.plugin_instance));
 157
 158   for (i = 0; i < family_info->features_num; i++)
 159   {
 160     char *buffer;
 161     size_t buffer_size;
 162     int status;
 163
 164     char file[4096];
 165     char *endptr;
 166
 167     snprintf (file, sizeof (file), "%s/%s",
 168         path, family_info->features[i].filename);
 169     file[sizeof (file) - 1] = 0;
 170
 171     buffer = NULL;
 172     buffer_size = 0;
 173     status = OW_get (file, &buffer, &buffer_size);
 174     if (status < 0)
 175     {
 176       ERROR ("onewire plugin: OW_get (%s/%s) failed. status = %#x;",
 177           path, family_info->features[i].filename, status);
 178       return (-1);
 179     }
 180
 181     endptr = NULL;
 182     values[0].gauge = strtod (buffer, &endptr);
 183     if (endptr == NULL)
 184     {
 185       ERROR ("onewire plugin: Buffer is not a number: %s", buffer);
 186       status = -1;
 187       continue;
 188     }
 189
 190     sstrncpy (vl.type, family_info->features[i].type, sizeof (vl.type));
 191     sstrncpy (vl.type_instance, family_info->features[i].type_instance,
 192         sizeof (vl.type_instance));
 193
 194     plugin_dispatch_values (&vl);
 195     success++;
 196
 197     free (buffer);
 198   } /* for (i = 0; i < features_num; i++) */
 199
 200   return ((success > 0) ? 0 : -1);
 201 } /* int cow_read_values */
 202
 203 /* Forward declaration so the recursion below works */
 204 static int cow_read_bus (const char *path);
 205
 206 /*
 207  * cow_read_ds2409
 208  *
 209  * Handles:
 210  * - DS2409 - MicroLAN Coupler
 211  */
 212 static int cow_read_ds2409 (const char *path)
 213 {
 214   char subpath[4096];
 215   int status;
 216
 217   status = ssnprintf (subpath, sizeof (subpath), "%s/main", path);
 218   if ((status > 0) && (status < sizeof (subpath)))
 219     cow_read_bus (subpath);
 220
 221   status = ssnprintf (subpath, sizeof (subpath), "%s/aux", path);
 222   if ((status > 0) && (status < sizeof (subpath)))
 223     cow_read_bus (subpath);
 224
 225   return (0);
 226 } /* int cow_read_ds2409 */
 227
 228 static int cow_read_bus (const char *path)
 229 {
 230   char *buffer;
 231   size_t buffer_size;
 232   int status;
 233
 234   char *buffer_ptr;
 235   char *dummy;
 236   char *saveptr;
 237   char subpath[4096];
 238
 239   status = OW_get (path, &buffer, &buffer_size);
 240   if (status < 0)
 241   {
 242     ERROR ("onewire plugin: OW_get (%s) failed. status = %#x;",
 243         path, status);
 244     return (-1);
 245   }
 246   DEBUG ("onewire plugin: OW_get (%s) returned: %s",
 247       path, buffer);
 248
 249   dummy = buffer;
 250   saveptr = NULL;
 251   while ((buffer_ptr = strtok_r (dummy, ",/", &saveptr)) != NULL)
 252   {
 253     int i;
 254
 255     dummy = NULL;
 256
 257     if (strcmp ("/", path) == 0)
 258       status = ssnprintf (subpath, sizeof (subpath), "/%s", buffer_ptr);
 259     else
 260       status = ssnprintf (subpath, sizeof (subpath), "%s/%s",
 261           path, buffer_ptr);
 262     if ((status <= 0) || (status >= sizeof (subpath)))
 263       continue;
 264
 265     for (i = 0; i < ow_family_features_num; i++)
 266     {
 267       if (strncmp (ow_family_features[i].family, buffer_ptr,
 268             strlen (ow_family_features[i].family)) != 0)
 269         continue;
 270
 271       cow_read_values (subpath,
 272           buffer_ptr + strlen (ow_family_features[i].family),
 273           ow_family_features + i);
 274       break;
 275     }
 276     if (i < ow_family_features_num)
 277       continue;
 278
 279     /* DS2409 */
 280     if (strncmp ("1F.", buffer_ptr, strlen ("1F.")) == 0)
 281     {
 282       cow_read_ds2409 (subpath);
 283       continue;
 284     }
 285   } /* while (strtok_r) */
 286
 287   free (buffer);
 288   return (0);
 289 } /* int cow_read_bus */
 290
 291 static int cow_read (void)
 292 {
 293   return (cow_read_bus ("/"));
 294 } /* int cow_read */
 295
 296 static int cow_shutdown (void)
 297 {
 298   OW_finish ();
 299   ignorelist_free (sensor_list);
 300   return (0);
 301 } /* int cow_shutdown */
 302
 303 void module_register (void)
 304 {
 305   plugin_register_init ("onewire", cow_init);
 306   plugin_register_read ("onewire", cow_read);
 307   plugin_register_shutdown ("onewire", cow_shutdown);
 308   plugin_register_config ("onewire", cow_load_config,
 309     config_keys, config_keys_num);
 310 }
 311
 312 /* vim: set sw=2 sts=2 ts=8 et fdm=marker cindent : */