src/hardware/teleinfo/api.c

   1 /*
   2  * This file is part of the libsigrok project.
   3  *
   4  * Copyright (C) 2013 Aurelien Jacobs <aurel@gnuage.org>
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 #include <config.h>
  21 #include <stdlib.h>
  22 #include <glib.h>
  23 #include <libsigrok/libsigrok.h>
  24 #include "libsigrok-internal.h"
  25 #include "protocol.h"
  26
  27 static const uint32_t scanopts[] = {
  28         SR_CONF_CONN,
  29         SR_CONF_SERIALCOMM,
  30 };
  31
  32 static const uint32_t drvopts[] = {
  33         SR_CONF_ENERGYMETER,
  34 };
  35
  36 static const uint32_t devopts[] = {
  37         SR_CONF_CONTINUOUS,
  38         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  39         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  40 };
  41
  42 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  43 {
  44         struct dev_context *devc;
  45         struct sr_serial_dev_inst *serial;
  46         struct sr_dev_inst *sdi;
  47         GSList *devices = NULL, *l;
  48         const char *conn = NULL, *serialcomm = NULL;
  49         uint8_t buf[292];
  50         size_t len;
  51         struct sr_config *src;
  52
  53         len = sizeof(buf);
  54
  55         for (l = options; l; l = l->next) {
  56                 src = l->data;
  57                 switch (src->key) {
  58                 case SR_CONF_CONN:
  59                         conn = g_variant_get_string(src->data, NULL);
  60                         break;
  61                 case SR_CONF_SERIALCOMM:
  62                         serialcomm = g_variant_get_string(src->data, NULL);
  63                         break;
  64                 }
  65         }
  66         if (!conn)
  67                 return NULL;
  68         if (!serialcomm)
  69                 serialcomm = "1200/7e1";
  70
  71         serial = sr_serial_dev_inst_new(conn, serialcomm);
  72
  73         if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
  74                 return NULL;
  75
  76         sr_info("Probing serial port %s.", conn);
  77
  78         serial_flush(serial);
  79
  80         /* Let's get a bit of data and see if we can find a packet. */
  81         if (serial_stream_detect(serial, buf, &len, len,
  82                                  teleinfo_packet_valid, 3000, 1200) != SR_OK)
  83                 goto scan_cleanup;
  84
  85         sr_info("Found device on port %s.", conn);
  86
  87         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  88         sdi->status = SR_ST_INACTIVE;
  89         sdi->vendor = g_strdup("EDF");
  90         sdi->model = g_strdup("Teleinfo");
  91         devc = g_malloc0(sizeof(struct dev_context));
  92         devc->optarif = teleinfo_get_optarif(buf);
  93         sdi->inst_type = SR_INST_SERIAL;
  94         sdi->conn = serial;
  95         sdi->priv = devc;
  96
  97         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P");
  98
  99         if (devc->optarif == OPTARIF_BASE) {
 100                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "BASE");
 101         } else if (devc->optarif == OPTARIF_HC) {
 102                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HP");
 103                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HC");
 104         } else if (devc->optarif == OPTARIF_EJP) {
 105                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HN");
 106                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPM");
 107         } else if (devc->optarif == OPTARIF_BBR) {
 108                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJB");
 109                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJW");
 110                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJR");
 111                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJB");
 112                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJW");
 113                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJR");
 114         }
 115
 116         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "IINST");
 117         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "PAPP");
 118
 119         devices = g_slist_append(devices, sdi);
 120
 121 scan_cleanup:
 122         serial_close(serial);
 123
 124         return std_scan_complete(di, devices);
 125 }
 126
 127 static int config_set(uint32_t key, GVariant *data,
 128         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 129 {
 130         struct dev_context *devc;
 131
 132         (void)cg;
 133
 134         devc = sdi->priv;
 135
 136         return sr_sw_limits_config_set(&devc->sw_limits, key, data);
 137 }
 138
 139 static int config_list(uint32_t key, GVariant **data,
 140         const struct sr_dev_inst *sdi, const struct sr_channel_group *cg)
 141 {
 142         return STD_CONFIG_LIST(key, data, sdi, cg, scanopts, drvopts, devopts);
 143 }
 144
 145 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 146 {
 147         struct sr_serial_dev_inst *serial = sdi->conn;
 148         struct dev_context *devc;
 149
 150         devc = sdi->priv;
 151
 152         sr_sw_limits_acquisition_start(&devc->sw_limits);
 153
 154         std_session_send_df_header(sdi);
 155
 156         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 157                         teleinfo_receive_data, (void *)sdi);
 158
 159         return SR_OK;
 160 }
 161
 162 static struct sr_dev_driver teleinfo_driver_info = {
 163         .name = "teleinfo",
 164         .longname = "Teleinfo",
 165         .api_version = 1,
 166         .init = std_init,
 167         .cleanup = std_cleanup,
 168         .scan = scan,
 169         .dev_list = std_dev_list,
 170         .dev_clear = std_dev_clear,
 171         .config_get = NULL,
 172         .config_set = config_set,
 173         .config_list = config_list,
 174         .dev_open = std_serial_dev_open,
 175         .dev_close = std_serial_dev_close,
 176         .dev_acquisition_start = dev_acquisition_start,
 177         .dev_acquisition_stop = std_serial_dev_acquisition_stop,
 178         .context = NULL,
 179 };
 180 SR_REGISTER_DEV_DRIVER(teleinfo_driver_info);