| 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 |
**/ |
| 36 |
|
| 37 |
#include "collectd.h" |
| 38 |
|
| 39 |
#include "plugin.h" |
| 40 |
#include "utils/common/common.h" |
| 41 |
|
| 42 |
#if HAVE_TERMIOS_H && HAVE_SYS_IOCTL_H |
| 43 |
#include <sys/ioctl.h> |
| 44 |
#include <termios.h> |
| 45 |
#else |
| 46 |
#error "No applicable input method." |
| 47 |
#endif |
| 48 |
|
| 49 |
#define EXPECTED_PACKAGE_LENGTH 278 |
| 50 |
#define ESCAPE 0x10 |
| 51 |
#define PKT_BEGIN 0x04 |
| 52 |
#define PKT_END 0x03 |
| 53 |
|
| 54 |
#define DEFAULT_DEVICE "/dev/ttyUSB0" |
| 55 |
|
| 56 |
static char *conf_device; |
| 57 |
static int conf_retries; |
| 58 |
|
| 59 |
static int fd = -1; |
| 60 |
|
| 61 |
static const char *config_keys[] = {"Device", "Retries"}; |
| 62 |
static int config_keys_num = STATIC_ARRAY_SIZE(config_keys); |
| 63 |
|
| 64 |
static int ted_read_value(double *ret_power, double *ret_voltage) { |
| 65 |
unsigned char receive_buffer[300]; |
| 66 |
unsigned char package_buffer[300]; |
| 67 |
unsigned char pkt_request[1] = {0xAA}; |
| 68 |
int package_buffer_pos; |
| 69 |
|
| 70 |
fd_set input; |
| 71 |
|
| 72 |
/* Initialize timeout structure, set to 2 seconds */ |
| 73 |
struct timeval timeout = {.tv_sec = 2}; |
| 74 |
|
| 75 |
int end_flag; |
| 76 |
int escape_flag; |
| 77 |
|
| 78 |
int status; |
| 79 |
|
| 80 |
assert(fd >= 0); |
| 81 |
|
| 82 |
/* Initialize the input set*/ |
| 83 |
FD_ZERO(&input); |
| 84 |
FD_SET(fd, &input); |
| 85 |
|
| 86 |
/* clear out anything in the buffer */ |
| 87 |
tcflush(fd, TCIFLUSH); |
| 88 |
|
| 89 |
status = write(fd, pkt_request, sizeof(pkt_request)); |
| 90 |
if (status <= 0) { |
| 91 |
ERROR("ted plugin: write failed."); |
| 92 |
return -1; |
| 93 |
} |
| 94 |
|
| 95 |
/* Loop until we find the end of the package */ |
| 96 |
end_flag = 0; |
| 97 |
package_buffer_pos = 0; |
| 98 |
while (end_flag == 0) { |
| 99 |
ssize_t receive_buffer_length; |
| 100 |
|
| 101 |
/* check for timeout or input error*/ |
| 102 |
status = select(fd + 1, &input, NULL, NULL, &timeout); |
| 103 |
if (status == 0) /* Timeout */ |
| 104 |
{ |
| 105 |
WARNING("ted plugin: Timeout while waiting for file descriptor " |
| 106 |
"to become ready."); |
| 107 |
return -1; |
| 108 |
} else if ((status < 0) && ((errno == EAGAIN) || (errno == EINTR))) { |
| 109 |
/* Some signal or something. Start over.. */ |
| 110 |
continue; |
| 111 |
} else if (status < 0) { |
| 112 |
ERROR("ted plugin: select failed: %s", STRERRNO); |
| 113 |
return -1; |
| 114 |
} |
| 115 |
|
| 116 |
receive_buffer_length = read(fd, receive_buffer, sizeof(receive_buffer)); |
| 117 |
if (receive_buffer_length < 0) { |
| 118 |
if ((errno == EAGAIN) || (errno == EINTR)) |
| 119 |
continue; |
| 120 |
ERROR("ted plugin: read(2) failed: %s", STRERRNO); |
| 121 |
return -1; |
| 122 |
} else if (receive_buffer_length == 0) { |
| 123 |
/* Should we close the FD in this case? */ |
| 124 |
WARNING("ted plugin: Received EOF from file descriptor."); |
| 125 |
return -1; |
| 126 |
} else if (((size_t)receive_buffer_length) > sizeof(receive_buffer)) { |
| 127 |
ERROR("ted plugin: read(2) returned invalid value %zi.", |
| 128 |
receive_buffer_length); |
| 129 |
return -1; |
| 130 |
} |
| 131 |
|
| 132 |
/* |
| 133 |
* packet filter loop |
| 134 |
* |
| 135 |
* Handle escape sequences in `receive_buffer' and put the |
| 136 |
* result in `package_buffer'. |
| 137 |
*/ |
| 138 |
/* We need to see the begin sequence first. When we receive `ESCAPE |
| 139 |
* PKT_BEGIN', we set `package_buffer_pos' to zero to signal that |
| 140 |
* the beginning of the package has been found. */ |
| 141 |
|
| 142 |
escape_flag = 0; |
| 143 |
for (ssize_t i = 0; i < receive_buffer_length; i++) { |
| 144 |
/* Check if previous byte was the escape byte. */ |
| 145 |
if (escape_flag == 1) { |
| 146 |
escape_flag = 0; |
| 147 |
/* escape escape = single escape */ |
| 148 |
if ((receive_buffer[i] == ESCAPE) && (package_buffer_pos >= 0)) { |
| 149 |
package_buffer[package_buffer_pos] = ESCAPE; |
| 150 |
package_buffer_pos++; |
| 151 |
} else if (receive_buffer[i] == PKT_BEGIN) { |
| 152 |
package_buffer_pos = 0; |
| 153 |
} else if (receive_buffer[i] == PKT_END) { |
| 154 |
end_flag = 1; |
| 155 |
break; |
| 156 |
} else { |
| 157 |
DEBUG("ted plugin: Unknown escaped byte: %#x", |
| 158 |
(unsigned int)receive_buffer[i]); |
| 159 |
} |
| 160 |
} else if (receive_buffer[i] == ESCAPE) { |
| 161 |
escape_flag = 1; |
| 162 |
} |
| 163 |
/* if we are in a package add byte to buffer |
| 164 |
* otherwise throw away */ |
| 165 |
else if (package_buffer_pos >= 0) { |
| 166 |
package_buffer[package_buffer_pos] = receive_buffer[i]; |
| 167 |
package_buffer_pos++; |
| 168 |
} |
| 169 |
} /* for (i = 0; i < receive_buffer_length; i++) */ |
| 170 |
} /* while (end_flag == 0) */ |
| 171 |
|
| 172 |
/* Check for errors inside the loop. */ |
| 173 |
if ((end_flag == 0) || (package_buffer_pos != EXPECTED_PACKAGE_LENGTH)) |
| 174 |
return -1; |
| 175 |
|
| 176 |
/* |
| 177 |
* Power is at positions 247 and 248 (LSB first) in [10kW]. |
| 178 |
* Voltage is at positions 251 and 252 (LSB first) in [.1V]. |
| 179 |
* |
| 180 |
* Power is in 10 Watt steps |
| 181 |
* Voltage is in volts |
| 182 |
*/ |
| 183 |
*ret_power = 10.0 * (double)((((int)package_buffer[248]) * 256) + |
| 184 |
((int)package_buffer[247])); |
| 185 |
*ret_voltage = 0.1 * (double)((((int)package_buffer[252]) * 256) + |
| 186 |
((int)package_buffer[251])); |
| 187 |
|
| 188 |
/* success */ |
| 189 |
return 0; |
| 190 |
} /* int ted_read_value */ |
| 191 |
|
| 192 |
static int ted_open_device(void) { |
| 193 |
const char *dev; |
| 194 |
struct termios options; |
| 195 |
|
| 196 |
if (fd >= 0) |
| 197 |
return 0; |
| 198 |
|
| 199 |
dev = DEFAULT_DEVICE; |
| 200 |
if (conf_device != NULL) |
| 201 |
dev = conf_device; |
| 202 |
|
| 203 |
fd = open(dev, O_RDWR | O_NOCTTY | O_NDELAY | O_NONBLOCK); |
| 204 |
if (fd < 0) { |
| 205 |
ERROR("ted plugin: Unable to open device %s.", dev); |
| 206 |
return -1; |
| 207 |
} |
| 208 |
|
| 209 |
/* Get the current options for the port... */ |
| 210 |
tcgetattr(fd, &options); |
| 211 |
options.c_cflag = B19200 | CS8 | CSTOPB | CREAD | CLOCAL; |
| 212 |
options.c_iflag = IGNBRK | IGNPAR; |
| 213 |
options.c_oflag = 0; |
| 214 |
options.c_lflag = 0; |
| 215 |
options.c_cc[VTIME] = 20; |
| 216 |
options.c_cc[VMIN] = 250; |
| 217 |
|
| 218 |
/* Set the new options for the port... */ |
| 219 |
tcflush(fd, TCIFLUSH); |
| 220 |
tcsetattr(fd, TCSANOW, &options); |
| 221 |
|
| 222 |
INFO("ted plugin: Successfully opened %s.", dev); |
| 223 |
return 0; |
| 224 |
} /* int ted_open_device */ |
| 225 |
|
| 226 |
static void ted_submit(const char *type, double value) { |
| 227 |
value_list_t vl = VALUE_LIST_INIT; |
| 228 |
|
| 229 |
vl.values = &(value_t){.gauge = value}; |
| 230 |
vl.values_len = 1; |
| 231 |
sstrncpy(vl.plugin, "ted", sizeof(vl.plugin)); |
| 232 |
sstrncpy(vl.type, type, sizeof(vl.type)); |
| 233 |
|
| 234 |
plugin_dispatch_values(&vl); |
| 235 |
} |
| 236 |
|
| 237 |
static int ted_config(const char *key, const char *value) { |
| 238 |
if (strcasecmp("Device", key) == 0) { |
| 239 |
sfree(conf_device); |
| 240 |
conf_device = sstrdup(value); |
| 241 |
} else if (strcasecmp("Retries", key) == 0) { |
| 242 |
int tmp; |
| 243 |
|
| 244 |
tmp = atoi(value); |
| 245 |
if (tmp < 0) { |
| 246 |
ERROR("ted plugin: Invalid retry count: %i", tmp); |
| 247 |
return 1; |
| 248 |
} |
| 249 |
conf_retries = tmp; |
| 250 |
} else { |
| 251 |
ERROR("ted plugin: Unknown config option: %s", key); |
| 252 |
return -1; |
| 253 |
} |
| 254 |
|
| 255 |
return 0; |
| 256 |
} /* int ted_config */ |
| 257 |
|
| 258 |
static int ted_read(void) { |
| 259 |
double power; |
| 260 |
double voltage; |
| 261 |
int status; |
| 262 |
|
| 263 |
status = ted_open_device(); |
| 264 |
if (status != 0) |
| 265 |
return -1; |
| 266 |
|
| 267 |
power = NAN; |
| 268 |
voltage = NAN; |
| 269 |
for (int i = 0; i <= conf_retries; i++) { |
| 270 |
status = ted_read_value(&power, &voltage); |
| 271 |
if (status == 0) |
| 272 |
break; |
| 273 |
} |
| 274 |
|
| 275 |
if (status != 0) |
| 276 |
return -1; |
| 277 |
|
| 278 |
ted_submit("power", power); |
| 279 |
ted_submit("voltage", voltage); |
| 280 |
|
| 281 |
return 0; |
| 282 |
} /* int ted_read */ |
| 283 |
|
| 284 |
static int ted_shutdown(void) { |
| 285 |
if (fd >= 0) { |
| 286 |
close(fd); |
| 287 |
fd = -1; |
| 288 |
} |
| 289 |
|
| 290 |
return 0; |
| 291 |
} /* int ted_shutdown */ |
| 292 |
|
| 293 |
void module_register(void) { |
| 294 |
plugin_register_config("ted", ted_config, config_keys, config_keys_num); |
| 295 |
plugin_register_read("ted", ted_read); |
| 296 |
plugin_register_shutdown("ted", ted_shutdown); |
| 297 |
} /* void module_register */ |