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 devopts[] = {
  33         SR_CONF_ENERGYMETER,
  34         SR_CONF_CONTINUOUS,
  35         SR_CONF_LIMIT_SAMPLES | SR_CONF_SET,
  36         SR_CONF_LIMIT_MSEC | SR_CONF_SET,
  37 };
  38
  39 static GSList *scan(struct sr_dev_driver *di, GSList *options)
  40 {
  41         struct dev_context *devc;
  42         struct sr_serial_dev_inst *serial;
  43         struct sr_dev_inst *sdi;
  44         GSList *devices = NULL, *l;
  45         const char *conn = NULL, *serialcomm = NULL;
  46         uint8_t buf[292];
  47         size_t len;
  48         struct sr_config *src;
  49
  50         len = sizeof(buf);
  51
  52         for (l = options; l; l = l->next) {
  53                 src = l->data;
  54                 switch (src->key) {
  55                 case SR_CONF_CONN:
  56                         conn = g_variant_get_string(src->data, NULL);
  57                         break;
  58                 case SR_CONF_SERIALCOMM:
  59                         serialcomm = g_variant_get_string(src->data, NULL);
  60                         break;
  61                 }
  62         }
  63         if (!conn)
  64                 return NULL;
  65         if (!serialcomm)
  66                 serialcomm = "1200/7e1";
  67
  68         serial = sr_serial_dev_inst_new(conn, serialcomm);
  69
  70         if (serial_open(serial, SERIAL_RDONLY) != SR_OK)
  71                 return NULL;
  72
  73         sr_info("Probing serial port %s.", conn);
  74
  75         serial_flush(serial);
  76
  77         /* Let's get a bit of data and see if we can find a packet. */
  78         if (serial_stream_detect(serial, buf, &len, len,
  79                                  teleinfo_packet_valid, 3000, 1200) != SR_OK)
  80                 goto scan_cleanup;
  81
  82         sr_info("Found device on port %s.", conn);
  83
  84         sdi = g_malloc0(sizeof(struct sr_dev_inst));
  85         sdi->status = SR_ST_INACTIVE;
  86         sdi->vendor = g_strdup("EDF");
  87         sdi->model = g_strdup("Teleinfo");
  88         devc = g_malloc0(sizeof(struct dev_context));
  89         devc->optarif = teleinfo_get_optarif(buf);
  90         sdi->inst_type = SR_INST_SERIAL;
  91         sdi->conn = serial;
  92         sdi->priv = devc;
  93
  94         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "P");
  95
  96         if (devc->optarif == OPTARIF_BASE) {
  97                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "BASE");
  98         } else if (devc->optarif == OPTARIF_HC) {
  99                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HP");
 100                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HC");
 101         } else if (devc->optarif == OPTARIF_EJP) {
 102                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HN");
 103                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPM");
 104         } else if (devc->optarif == OPTARIF_BBR) {
 105                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJB");
 106                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJW");
 107                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HPJR");
 108                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJB");
 109                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJW");
 110                 sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "HCJR");
 111         }
 112
 113         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "IINST");
 114         sr_channel_new(sdi, 0, SR_CHANNEL_ANALOG, TRUE, "PAPP");
 115
 116         devices = g_slist_append(devices, sdi);
 117
 118 scan_cleanup:
 119         serial_close(serial);
 120
 121         return std_scan_complete(di, devices);
 122 }
 123
 124 static int config_set(uint32_t key, GVariant *data, const struct sr_dev_inst *sdi,
 125                 const struct sr_channel_group *cg)
 126 {
 127         struct dev_context *devc;
 128
 129         (void)cg;
 130
 131         if (sdi->status != SR_ST_ACTIVE)
 132                 return SR_ERR_DEV_CLOSED;
 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, const struct sr_dev_inst *sdi,
 140                 const struct sr_channel_group *cg)
 141 {
 142         (void)sdi;
 143         (void)cg;
 144
 145         switch (key) {
 146         case SR_CONF_SCAN_OPTIONS:
 147                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 148                                 scanopts, ARRAY_SIZE(scanopts), sizeof(uint32_t));
 149                 break;
 150         case SR_CONF_DEVICE_OPTIONS:
 151                 *data = g_variant_new_fixed_array(G_VARIANT_TYPE_UINT32,
 152                                 devopts, ARRAY_SIZE(devopts), sizeof(uint32_t));
 153                 break;
 154         default:
 155                 return SR_ERR_NA;
 156         }
 157
 158         return SR_OK;
 159 }
 160
 161 static int dev_acquisition_start(const struct sr_dev_inst *sdi)
 162 {
 163         struct sr_serial_dev_inst *serial = sdi->conn;
 164         struct dev_context *devc;
 165
 166         if (sdi->status != SR_ST_ACTIVE)
 167                 return SR_ERR_DEV_CLOSED;
 168
 169         devc = sdi->priv;
 170
 171         sr_sw_limits_acquisition_start(&devc->sw_limits);
 172
 173         std_session_send_df_header(sdi);
 174
 175         /* Poll every 50ms, or whenever some data comes in. */
 176         serial_source_add(sdi->session, serial, G_IO_IN, 50,
 177                         teleinfo_receive_data, (void *)sdi);
 178
 179         return SR_OK;
 180 }
 181
 182 static int dev_acquisition_stop(struct sr_dev_inst *sdi)
 183 {
 184         return std_serial_dev_acquisition_stop(sdi,
 185                         std_serial_dev_close);
 186 }
 187
 188 static struct sr_dev_driver teleinfo_driver_info = {
 189         .name = "teleinfo",
 190         .longname = "Teleinfo",
 191         .api_version = 1,
 192         .init = std_init,
 193         .cleanup = std_cleanup,
 194         .scan = scan,
 195         .dev_list = std_dev_list,
 196         .dev_clear = NULL,
 197         .config_get = NULL,
 198         .config_set = config_set,
 199         .config_list = config_list,
 200         .dev_open = std_serial_dev_open,
 201         .dev_close = std_serial_dev_close,
 202         .dev_acquisition_start = dev_acquisition_start,
 203         .dev_acquisition_stop = dev_acquisition_stop,
 204         .context = NULL,
 205 };
 206 SR_REGISTER_DEV_DRIVER(teleinfo_driver_info);