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>
33 #include <libsigrok/libsigrok.h>
35 /* Minimum interval between dispatches coming from this plugin. The RRD
36 * plugin, at least, complains when written to with sub-second intervals.*/
37 #define DEFAULT_MIN_DISPATCH_INTERVAL TIME_T_TO_CDTIME_T(0)
39 static pthread_t sr_thread;
40 static int sr_thread_running = FALSE;
41 GSList *config_devices;
42 static int num_devices;
43 static int loglevel = SR_LOG_WARN;
44 static struct sr_context *sr_ctx;
46 struct config_device {
51 struct sr_dev_inst *sdi;
52 cdtime_t min_dispatch_interval;
53 cdtime_t last_dispatch;
57 static int sigrok_log_callback(void*cb_data __attribute__((unused)),
58 int msg_loglevel, const char *format, va_list args)
62 if (msg_loglevel <= loglevel) {
63 vsnprintf(s, 512, format, args);
64 plugin_log(LOG_INFO, "sigrok plugin: %s", s);
70 static int sigrok_config_device(oconfig_item_t *ci)
72 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 (int 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)
107 for (int i = 0; i < ci->children_num; i++) {
108 oconfig_item_t *item = ci->children + i;
109 if (strcasecmp("LogLevel", item->key) == 0) {
113 status = cf_util_get_int (item, &tmp);
116 else if ((tmp < 0) || (tmp > 5)) {
117 ERROR ("sigrok plugin: The \"LogLevel\" "
118 "configuration option expects "
119 "an integer between 0 and 5 "
120 "(inclusive); you provided %i.",
125 } else if (!strcasecmp(item->key, "Device"))
126 sigrok_config_device(item);
128 WARNING("sigrok plugin: Invalid keyword \"%s\".",
135 static const char *sigrok_value_type(const struct sr_datafeed_analog *analog)
139 if (analog->mq == SR_MQ_VOLTAGE)
141 else if (analog->mq == SR_MQ_CURRENT)
143 else if (analog->mq == SR_MQ_FREQUENCY)
145 else if (analog->mq == SR_MQ_POWER)
147 else if (analog->mq == SR_MQ_TEMPERATURE)
149 else if (analog->mq == SR_MQ_RELATIVE_HUMIDITY)
151 else if (analog->mq == SR_MQ_SOUND_PRESSURE_LEVEL)
159 static void sigrok_feed_callback(const struct sr_dev_inst *sdi,
160 const struct sr_datafeed_packet *packet, void *cb_data)
162 const struct sr_datafeed_analog *analog;
163 struct config_device *cfdev;
164 value_list_t vl = VALUE_LIST_INIT;
166 /* Find this device's configuration. */
168 for (GSList *l = config_devices; l; l = l->next) {
170 if (cfdev->sdi == sdi) {
178 ERROR("sigrok plugin: Received data from driver \"%s\" but "
179 "can't find a configuration / device matching "
180 "it.", sdi->driver->name);
184 if (packet->type == SR_DF_END) {
185 /* TODO: try to restart acquisition after a delay? */
186 WARNING("sigrok plugin: acquisition for \"%s\" ended.",
191 if (packet->type != SR_DF_ANALOG)
194 if ((cfdev->min_dispatch_interval != 0)
195 && ((cdtime() - cfdev->last_dispatch)
196 < cfdev->min_dispatch_interval))
199 /* Ignore all but the first sample on the first probe. */
200 analog = packet->payload;
201 vl.values = &(value_t) { .gauge = analog->data[0] };
203 sstrncpy(vl.plugin, "sigrok", sizeof(vl.plugin));
204 sstrncpy(vl.plugin_instance, cfdev->name, sizeof(vl.plugin_instance));
205 sstrncpy(vl.type, sigrok_value_type(analog), sizeof(vl.type));
207 plugin_dispatch_values(&vl);
208 cfdev->last_dispatch = cdtime();
211 static void sigrok_free_drvopts(struct sr_config *src)
213 g_variant_unref(src->data);
217 static int sigrok_init_driver(struct config_device *cfdev,
218 struct sr_dev_driver *drv)
220 struct sr_config *src;
221 GSList *devlist, *drvopts;
224 if (sr_driver_init(sr_ctx, drv) != SR_OK)
225 /* Error was logged by libsigrok. */
230 if (!(src = malloc(sizeof(*src))))
232 src->key = SR_CONF_CONN;
233 src->data = g_variant_new_string(cfdev->conn);
234 drvopts = g_slist_append(drvopts, src);
236 if (cfdev->serialcomm) {
237 if (!(src = malloc(sizeof(*src))))
239 src->key = SR_CONF_SERIALCOMM;
240 src->data = g_variant_new_string(cfdev->serialcomm);
241 drvopts = g_slist_append(drvopts, src);
243 devlist = sr_driver_scan(drv, drvopts);
244 g_slist_free_full(drvopts, (GDestroyNotify)sigrok_free_drvopts);
246 /* Not an error, but the user should know about it. */
247 WARNING("sigrok plugin: No device found for \"%s\".",
252 if (g_slist_length(devlist) > 1) {
253 INFO("sigrok plugin: %d sigrok devices for device entry "
254 "\"%s\": must be 1.",
255 g_slist_length(devlist), cfdev->name);
258 cfdev->sdi = devlist->data;
259 g_slist_free(devlist);
260 ssnprintf(hwident, sizeof(hwident), "%s %s %s",
261 cfdev->sdi->vendor ? cfdev->sdi->vendor : "",
262 cfdev->sdi->model ? cfdev->sdi->model : "",
263 cfdev->sdi->version ? cfdev->sdi->version : "");
264 INFO("sigrok plugin: Device \"%s\" is a %s", cfdev->name, hwident);
266 if (sr_dev_open(cfdev->sdi) != SR_OK)
269 if (sr_session_dev_add(cfdev->sdi) != SR_OK)
275 static void *sigrok_read_thread(void *arg __attribute__((unused)))
277 struct sr_dev_driver *drv, **drvlist;
279 struct config_device *cfdev;
282 sr_log_callback_set(sigrok_log_callback, NULL);
283 sr_log_loglevel_set(loglevel);
285 if ((ret = sr_init(&sr_ctx)) != SR_OK) {
286 ERROR("sigrok plugin: Failed to initialize libsigrok: %s.",
291 if (!sr_session_new())
295 drvlist = sr_driver_list();
296 for (l = config_devices; l; l = l->next) {
299 for (i = 0; drvlist[i]; i++) {
300 if (!strcmp(drvlist[i]->name, cfdev->driver)) {
306 ERROR("sigrok plugin: Unknown driver \"%s\".",
311 if ((ret = sigrok_init_driver(cfdev, drv)) < 0)
312 /* Error was already logged. */
318 if (num_devices > 0) {
319 /* Do this only when we're sure there's hardware to talk to. */
320 if (sr_session_datafeed_callback_add(sigrok_feed_callback, NULL)
324 /* Start acquisition on all devices. */
325 if (sr_session_start() != SR_OK)
328 /* Main loop, runs forever. */
332 sr_session_dev_remove_all();
335 sr_session_destroy();
340 sr_thread_running = FALSE;
345 static int sigrok_init(void)
349 if (sr_thread_running) {
350 ERROR("sigrok plugin: Thread already running.");
354 status = plugin_thread_create(&sr_thread, NULL, sigrok_read_thread,
359 ERROR("sigrok plugin: Failed to create thread: %s.",
360 sstrerror (errno, errbuf, sizeof (errbuf)));
363 sr_thread_running = TRUE;
368 static int sigrok_shutdown(void)
370 struct config_device *cfdev;
373 if (sr_thread_running) {
374 pthread_cancel(sr_thread);
375 pthread_join(sr_thread, NULL);
378 for (l = config_devices; l; l = l->next) {
383 free(cfdev->serialcomm);
386 g_slist_free(config_devices);
391 void module_register(void)
393 plugin_register_complex_config("sigrok", sigrok_config);
394 plugin_register_init("sigrok", sigrok_init);
395 plugin_register_shutdown("sigrok", sigrok_shutdown);