Code

Merge branch 'collectd-4.10' into collectd-5.0
[collectd.git] / src / ted.c
1 /**
2  * collectd - src/ted.c
3  * Copyright (C) 2009  Eric Reed
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; either version 2 of the License, or (at your
8  * option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License along
16  * with this program; if not, write to the Free Software Foundation, Inc.,
17  * 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
18  *
19  * Authors:
20  *   Eric Reed <ericr at reedhome.net>
21  *
22  *  This is a collectd module for The Energy Detective: A low-cost whole
23  * house energy monitoring system. For more information on TED, see
24  * http://theenergydetective.com
25  *
26  * This module was not created by Energy, Inc. nor is it supported by
27  * them in any way. It was created using information from two sources:
28  * David Satterfield's TED module for Misterhouse, and Micah Dowty's TED
29  * Python Module.
30  *
31  * This has only tested with the model 1001 RDU, with
32  * firmware version 9.01U. The USB port is uses the very common FTDI
33  * USB-to-serial chip, so the RDU will show up as a serial device on
34  * Windows, Mac OS, or Linux.
35  **/
37 #include "collectd.h"
38 #include "common.h"
39 #include "plugin.h"
40 #include "configfile.h"
42 #if HAVE_TERMIOS_H && HAVE_SYS_IOCTL_H && HAVE_MATH_H
43 # include <termios.h>
44 # include <sys/ioctl.h>
45 # include <math.h>
46 #else
47 # error "No applicable input method."
48 #endif
50 #define EXPECTED_PACKAGE_LENGTH 278
51 #define ESCAPE       0x10
52 #define PKT_BEGIN    0x04
53 #define PKT_END      0x03
55 #define DEFAULT_DEVICE "/dev/ttyUSB0"
57 static char *conf_device = NULL;
58 static int   conf_retries = 0;
60 static int fd = -1;
62 static const char *config_keys[] =
63 {
64     "Device",
65     "Retries"
66 };
67 static int config_keys_num = STATIC_ARRAY_SIZE (config_keys);
69 static int ted_read_value(double *ret_power, double *ret_voltage)
70 {
71     unsigned char receive_buffer[300];
72     unsigned char package_buffer[300];
73     char pkt_request[1] = {0xAA};
74     int package_buffer_pos;
76     fd_set input;
77     struct timeval timeout;
79     int end_flag;
80     int escape_flag;
82     int status;
84     assert (fd >= 0);
86     /* Initialize the input set*/
87     FD_ZERO (&input);
88     FD_SET (fd, &input);
90     /* Initialize timeout structure, set to 2 seconds */
91     memset (&timeout, 0, sizeof (timeout));
92     timeout.tv_sec = 2;
93     timeout.tv_usec = 0;
95     /* clear out anything in the buffer */
96     tcflush (fd, TCIFLUSH);
98     status = write (fd, pkt_request, sizeof(pkt_request));
99     if (status <= 0)
100     {
101         ERROR ("ted plugin: swrite failed.");
102         return (-1);
103     }
105     /* Loop until we find the end of the package */
106     end_flag = 0;
107     escape_flag = 0;
108     package_buffer_pos = 0;
109     while (end_flag == 0)
110     {
111         ssize_t receive_buffer_length;
112         ssize_t i;
114         /* check for timeout or input error*/
115         status = select (fd + 1, &input, NULL, NULL, &timeout);
116         if (status == 0) /* Timeout */
117         {
118             WARNING ("ted plugin: Timeout while waiting for file descriptor "
119                     "to become ready.");
120             return (-1);
121         }
122         else if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR)))
123         {
124             /* Some signal or something. Start over.. */
125             continue;
126         }
127         else if (status < 0)
128         {
129             char errbuf[1024];
130             ERROR ("ted plugin: select failed: %s",
131                     sstrerror (errno, errbuf, sizeof (errbuf)));
132             return (-1);
133         }
135         receive_buffer_length = read (fd, receive_buffer, sizeof (receive_buffer));
136         if (receive_buffer_length < 0)
137         {
138             char errbuf[1024];
139             if ((errno == EAGAIN) || (errno == EINTR))
140                 continue;
141             ERROR ("ted plugin: read(2) failed: %s",
142                     sstrerror (errno, errbuf, sizeof (errbuf)));
143             return (-1);
144         }
145         else if (receive_buffer_length == 0)
146         {
147             /* Should we close the FD in this case? */
148             WARNING ("ted plugin: Received EOF from file descriptor.");
149             return (-1);
150         }
151         else if (receive_buffer_length > sizeof (receive_buffer))
152         {
153             ERROR ("ted plugin: read(2) returned invalid value %zi.",
154                     receive_buffer_length);
155             return (-1);
156         }
158         /*
159          * packet filter loop
160          *
161          * Handle escape sequences in `receive_buffer' and put the
162          * result in `package_buffer'.
163          */
164         /* We need to see the begin sequence first. When we receive `ESCAPE
165          * PKT_BEGIN', we set `package_buffer_pos' to zero to signal that
166          * the beginning of the package has been found. */
168         escape_flag = 0;
169         for (i = 0; i < receive_buffer_length; i++)
170         {
171             /* Check if previous byte was the escape byte. */
172             if (escape_flag == 1)
173             {
174                 escape_flag = 0;
175                 /* escape escape = single escape */
176                 if ((receive_buffer[i] == ESCAPE)
177                         && (package_buffer_pos >= 0))
178                 {
179                     package_buffer[package_buffer_pos] = ESCAPE;
180                     package_buffer_pos++;
181                 }
182                 else if (receive_buffer[i] == PKT_BEGIN)
183                 {
184                     package_buffer_pos = 0;
185                 }
186                 else if  (receive_buffer[i] == PKT_END)
187                 {
188                     end_flag = 1;
189                     break;
190                 }
191                 else
192                 {
193                     DEBUG ("ted plugin: Unknown escaped byte: %#x",
194                             (unsigned int) receive_buffer[i]);
195                 }
196             }
197             else if (receive_buffer[i] == ESCAPE)
198             {
199                 escape_flag = 1;
200             }
201             /* if we are in a package add byte to buffer
202              * otherwise throw away */
203             else if (package_buffer_pos >= 0)
204             {
205                 package_buffer[package_buffer_pos] = receive_buffer[i];
206                 package_buffer_pos++;
207             }
208         } /* for (i = 0; i < receive_buffer_length; i++) */
209     } /* while (end_flag == 0) */
211     /* Check for errors inside the loop. */
212     if ((end_flag == 0) || (package_buffer_pos != EXPECTED_PACKAGE_LENGTH))
213         return (-1);
215     /*
216      * Power is at positions 247 and 248 (LSB first) in [10kW].
217      * Voltage is at positions 251 and 252 (LSB first) in [.1V].
218      *
219      * Power is in 10 Watt steps
220      * Voltage is in volts
221      */
222     *ret_power = 10.0 * (double) ((((int) package_buffer[248]) * 256)
223             + ((int) package_buffer[247]));
224     *ret_voltage = 0.1 * (double) ((((int) package_buffer[252]) * 256)
225             + ((int) package_buffer[251]));
227     /* success */
228     return (0);
229 } /* int ted_read_value */
231 static int ted_open_device (void)
233     const char *dev;
234     struct termios options;
236     if (fd >= 0)
237         return (0);
239     dev = DEFAULT_DEVICE;
240     if (conf_device != NULL)
241         dev = conf_device;
243     fd = open (dev, O_RDWR | O_NOCTTY | O_NDELAY | O_NONBLOCK);
244     if (fd < 0)
245     {
246         ERROR ("ted plugin: Unable to open device %s.", dev);
247         return (-1);
248     }
250     /* Get the current options for the port... */
251     tcgetattr(fd, &options);
252     options.c_cflag = B19200 | CS8 | CSTOPB | CREAD | CLOCAL;
253     options.c_iflag = IGNBRK | IGNPAR;
254     options.c_oflag = 0;
255     options.c_lflag = 0;
256     options.c_cc[VTIME] = 20;
257     options.c_cc[VMIN]  = 250;
259     /* Set the new options for the port... */
260     tcflush(fd, TCIFLUSH);
261     tcsetattr(fd, TCSANOW, &options);
263     INFO ("ted plugin: Successfully opened %s.", dev);
264     return (0);
265 } /* int ted_open_device */
267 static void ted_submit (char *type, double value)
269     value_t values[1];
270     value_list_t vl = VALUE_LIST_INIT;
272     values[0].gauge = value;
274     vl.values = values;
275     vl.values_len = 1;
276     sstrncpy (vl.host, hostname_g, sizeof (vl.host));
277     sstrncpy (vl.plugin, "ted", sizeof (vl.plugin));
278     sstrncpy (vl.type, type, sizeof (vl.type));
280     plugin_dispatch_values (&vl);
283 static int ted_config (const char *key, const char *value)
285     if (strcasecmp ("Device", key) == 0)
286     {
287         sfree (conf_device);
288         conf_device = sstrdup (value);
289     }
290     else if (strcasecmp ("Retries", key) == 0)
291     {
292         int tmp;
294         tmp = atoi (value);
295         if (tmp < 0)
296         {
297             WARNING ("ted plugin: Invalid retry count: %i", tmp);
298             return (1);
299         }
300         conf_retries = tmp;
301     }
302     else
303     {
304         ERROR ("ted plugin: Unknown config option: %s", key);
305         return (-1);
306     }
308     return (0);
309 } /* int ted_config */
311 static int ted_read (void)
313     double power;
314     double voltage;
315     int status;
316     int i;
318     status = ted_open_device ();
319     if (status != 0)
320         return (-1);
322     power = NAN;
323     voltage = NAN;
324     for (i = 0; i <= conf_retries; i++)
325     {
326         status = ted_read_value (&power, &voltage);
327         if (status == 0)
328             break;
329     }
331     if (status != 0)
332         return (-1);
334     ted_submit ("power", power);
335     ted_submit ("voltage", voltage);
337     return (0);
338 } /* int ted_read */
340 static int ted_shutdown (void)
342     if (fd >= 0)
343     {
344         close (fd);
345         fd = -1;
346     }
348     return (0);
349 } /* int ted_shutdown */
351 void module_register (void)
353     plugin_register_config ("ted", ted_config,
354             config_keys, config_keys_num);
355     plugin_register_read ("ted", ted_read);
356     plugin_register_shutdown ("ted", ted_shutdown);
357 } /* void module_register */
359 /* vim: set sw=4 et : */