2 * collectd - src/sigrok.c
3 * Copyright (C) 2013 Bert Vermeulen
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see <http://www.gnu.org/licenses/>.
19 * Bert Vermeulen <bert at biot.com>
32 #include <libsigrok/libsigrok.h>
34 /* Minimum interval between dispatches coming from this plugin. The RRD
35 * plugin, at least, complains when written to with sub-second intervals.*/
36 #define DEFAULT_MIN_DISPATCH_INTERVAL TIME_T_TO_CDTIME_T(0)
38 static pthread_t sr_thread;
39 static int sr_thread_running = FALSE;
40 GSList *config_devices;
41 static int num_devices;
42 static int loglevel = SR_LOG_WARN;
43 static struct sr_context *sr_ctx;
45 struct config_device {
50 struct sr_dev_inst *sdi;
51 cdtime_t min_dispatch_interval;
52 cdtime_t last_dispatch;
56 static int sigrok_log_callback(void*cb_data __attribute__((unused)),
57 int msg_loglevel, const char *format, va_list args)
61 if (msg_loglevel <= loglevel) {
62 vsnprintf(s, 512, format, args);
63 plugin_log(LOG_INFO, "sigrok plugin: %s", s);
69 static int sigrok_config_device(oconfig_item_t *ci)
71 struct config_device *cfdev;
74 if (!(cfdev = calloc(1, sizeof(*cfdev)))) {
75 ERROR("sigrok plugin: calloc failed.");
78 if (cf_util_get_string(ci, &cfdev->name)) {
80 WARNING("sigrok plugin: Invalid device name.");
83 cfdev->min_dispatch_interval = DEFAULT_MIN_DISPATCH_INTERVAL;
85 for (i = 0; i < ci->children_num; i++) {
86 oconfig_item_t *item = ci->children + i;
87 if (!strcasecmp(item->key, "driver"))
88 cf_util_get_string(item, &cfdev->driver);
89 else if (!strcasecmp(item->key, "conn"))
90 cf_util_get_string(item, &cfdev->conn);
91 else if (!strcasecmp(item->key, "serialcomm"))
92 cf_util_get_string(item, &cfdev->serialcomm);
93 else if (!strcasecmp(item->key, "minimuminterval"))
94 cf_util_get_cdtime(item, &cfdev->min_dispatch_interval);
96 WARNING("sigrok plugin: Invalid keyword \"%s\".",
100 config_devices = g_slist_append(config_devices, cfdev);
105 static int sigrok_config(oconfig_item_t *ci)
109 for (i = 0; i < ci->children_num; i++) {
110 oconfig_item_t *item = ci->children + i;
111 if (strcasecmp("LogLevel", item->key) == 0) {
115 status = cf_util_get_int (item, &tmp);
118 else if ((tmp < 0) || (tmp > 5)) {
119 ERROR ("sigrok plugin: The \"LogLevel\" "
120 "configuration option expects "
121 "an integer between 0 and 5 "
122 "(inclusive); you provided %i.",
127 } else if (!strcasecmp(item->key, "Device"))
128 sigrok_config_device(item);
130 WARNING("sigrok plugin: Invalid keyword \"%s\".",
137 static const char *sigrok_value_type(const struct sr_datafeed_analog *analog)
141 if (analog->mq == SR_MQ_VOLTAGE)
143 else if (analog->mq == SR_MQ_CURRENT)
145 else if (analog->mq == SR_MQ_FREQUENCY)
147 else if (analog->mq == SR_MQ_POWER)
149 else if (analog->mq == SR_MQ_TEMPERATURE)
151 else if (analog->mq == SR_MQ_RELATIVE_HUMIDITY)
153 else if (analog->mq == SR_MQ_SOUND_PRESSURE_LEVEL)
161 static void sigrok_feed_callback(const struct sr_dev_inst *sdi,
162 const struct sr_datafeed_packet *packet, void *cb_data)
164 const struct sr_datafeed_analog *analog;
165 struct config_device *cfdev;
168 value_list_t vl = VALUE_LIST_INIT;
170 /* Find this device's configuration. */
172 for (l = config_devices; l; l = l->next) {
174 if (cfdev->sdi == sdi) {
182 ERROR("sigrok plugin: Received data from driver \"%s\" but "
183 "can't find a configuration / device matching "
184 "it.", sdi->driver->name);
188 if (packet->type == SR_DF_END) {
189 /* TODO: try to restart acquisition after a delay? */
190 WARNING("sigrok plugin: acquisition for \"%s\" ended.",
195 if (packet->type != SR_DF_ANALOG)
198 if ((cfdev->min_dispatch_interval != 0)
199 && ((cdtime() - cfdev->last_dispatch)
200 < cfdev->min_dispatch_interval))
203 /* Ignore all but the first sample on the first probe. */
204 analog = packet->payload;
205 value.gauge = analog->data[0];
208 sstrncpy(vl.host, hostname_g, sizeof(vl.host));
209 sstrncpy(vl.plugin, "sigrok", sizeof(vl.plugin));
210 ssnprintf(vl.plugin_instance, sizeof(vl.plugin_instance),
212 sstrncpy(vl.type, sigrok_value_type(analog), sizeof(vl.type));
214 plugin_dispatch_values(&vl);
215 cfdev->last_dispatch = cdtime();
218 static void sigrok_free_drvopts(struct sr_config *src)
220 g_variant_unref(src->data);
224 static int sigrok_init_driver(struct config_device *cfdev,
225 struct sr_dev_driver *drv)
227 struct sr_config *src;
228 GSList *devlist, *drvopts;
231 if (sr_driver_init(sr_ctx, drv) != SR_OK)
232 /* Error was logged by libsigrok. */
237 if (!(src = malloc(sizeof(*src))))
239 src->key = SR_CONF_CONN;
240 src->data = g_variant_new_string(cfdev->conn);
241 drvopts = g_slist_append(drvopts, src);
243 if (cfdev->serialcomm) {
244 if (!(src = malloc(sizeof(*src))))
246 src->key = SR_CONF_SERIALCOMM;
247 src->data = g_variant_new_string(cfdev->serialcomm);
248 drvopts = g_slist_append(drvopts, src);
250 devlist = sr_driver_scan(drv, drvopts);
251 g_slist_free_full(drvopts, (GDestroyNotify)sigrok_free_drvopts);
253 /* Not an error, but the user should know about it. */
254 WARNING("sigrok plugin: No device found for \"%s\".",
259 if (g_slist_length(devlist) > 1) {
260 INFO("sigrok plugin: %d sigrok devices for device entry "
261 "\"%s\": must be 1.",
262 g_slist_length(devlist), cfdev->name);
265 cfdev->sdi = devlist->data;
266 g_slist_free(devlist);
267 ssnprintf(hwident, sizeof(hwident), "%s %s %s",
268 cfdev->sdi->vendor ? cfdev->sdi->vendor : "",
269 cfdev->sdi->model ? cfdev->sdi->model : "",
270 cfdev->sdi->version ? cfdev->sdi->version : "");
271 INFO("sigrok plugin: Device \"%s\" is a %s", cfdev->name, hwident);
273 if (sr_dev_open(cfdev->sdi) != SR_OK)
276 if (sr_session_dev_add(cfdev->sdi) != SR_OK)
282 static void *sigrok_read_thread(void *arg __attribute__((unused)))
284 struct sr_dev_driver *drv, **drvlist;
286 struct config_device *cfdev;
289 sr_log_callback_set(sigrok_log_callback, NULL);
290 sr_log_loglevel_set(loglevel);
292 if ((ret = sr_init(&sr_ctx)) != SR_OK) {
293 ERROR("sigrok plugin: Failed to initialize libsigrok: %s.",
298 if (!sr_session_new())
302 drvlist = sr_driver_list();
303 for (l = config_devices; l; l = l->next) {
306 for (i = 0; drvlist[i]; i++) {
307 if (!strcmp(drvlist[i]->name, cfdev->driver)) {
313 ERROR("sigrok plugin: Unknown driver \"%s\".",
318 if ((ret = sigrok_init_driver(cfdev, drv)) < 0)
319 /* Error was already logged. */
325 if (num_devices > 0) {
326 /* Do this only when we're sure there's hardware to talk to. */
327 if (sr_session_datafeed_callback_add(sigrok_feed_callback, NULL)
331 /* Start acquisition on all devices. */
332 if (sr_session_start() != SR_OK)
335 /* Main loop, runs forever. */
339 sr_session_dev_remove_all();
342 sr_session_destroy();
347 sr_thread_running = FALSE;
352 static int sigrok_init(void)
356 if (sr_thread_running) {
357 ERROR("sigrok plugin: Thread already running.");
361 status = plugin_thread_create(&sr_thread, NULL, sigrok_read_thread,
366 ERROR("sigrok plugin: Failed to create thread: %s.",
367 sstrerror (errno, errbuf, sizeof (errbuf)));
370 sr_thread_running = TRUE;
375 static int sigrok_shutdown(void)
377 struct config_device *cfdev;
380 if (sr_thread_running) {
381 pthread_cancel(sr_thread);
382 pthread_join(sr_thread, NULL);
385 for (l = config_devices; l; l = l->next) {
390 free(cfdev->serialcomm);
393 g_slist_free(config_devices);
398 void module_register(void)
400 plugin_register_complex_config("sigrok", sigrok_config);
401 plugin_register_init("sigrok", sigrok_init);
402 plugin_register_shutdown("sigrok", sigrok_shutdown);